update docs

Author: SteveBronder

doxygen/doxygen.cfg

@@ -2743,7 +2743,7 @@ MSCGEN_TOOL            =
 MSCFILE_DIRS           =
 
 ALIASES += laplace_options="\
-@param[in] ops Options for controlling Laplace approximation. The following options are available: \
+\param[in] ops Options for controlling Laplace approximation. The following options are available: \
   - theta_0 the initial guess for the Laplace approximation. \
   - tolerance controls the convergence criterion when finding the mode in the Laplace approximation. \
   - max_num_steps maximum number of steps before the Newton solver breaks and returns an error. \
@@ -2753,6 +2753,7 @@ ALIASES += laplace_options="\
     2. computes square-root of covariance matrix. \
     3. computes no square-root and uses LU decomposition. \
   - max_steps_line_search Number of steps after which the algorithm gives up on doing a line search. If 0, no linesearch. \
+  - allow_fallthrough If true, if solver 1 fails then solver 2 is tried, and if that fails solver 3 is tried. \
 "
 
 ALIASES += laplace_common_template_args="\
@@ -2762,7 +2763,7 @@ ALIASES += laplace_common_template_args="\
  should be a type inheriting from `Eigen::EigenBase` with dynamic sized \
  rows and columns. \
  \tparam CovarArgs A tuple of types to passed as the first arguments of `CovarFun::operator()`\
- \tparam OpsTuple A tuple of laplace_options types
+ \tparam OpsTuple A tuple of laplace_options types \
 "
 
 ALIASES += laplace_common_args="\

stan/math/mix/functor/laplace_marginal_density_estimator.hpp

@@ -1083,12 +1083,13 @@ inline auto run_newton_loop(SolverPolicy& solver, NewtonStateT& state,
 
 /**
  * @brief Log a solver fallback event to the provided stream.
- * @param msgs Output stream (may be nullptr)
- * @param context Context string for the log
- * @param iter Current iteration number
- * @param failed_solver Name of the solver that failed
- * @param next_solver Name of the solver being attempted next
- * @param e Exception that caused the fallback
+ * @param[in] allow_fallthrough If false, throw instead of logging
+ * @param[in,out] msgs Output stream (may be nullptr)
+ * @param[in] context Context string for the log
+ * @param[in] iter Current iteration number
+ * @param[in] failed_solver Name of the solver that failed
+ * @param[in] next_solver Name of the solver being attempted next
+ * @param[in] e Exception that caused the fallback
  */
 inline void log_solver_fallback(const bool allow_fallthrough,
                                 std::ostream* msgs, std::string_view context,

stan/math/mix/functor/wolfe_line_search.hpp

@@ -551,20 +551,22 @@ struct WolfeInfo {
  *
  * @tparam Update Callable that performs one evaluation step. Must accept 4
  * arguments.
+ * @tparam Proposal Proposed step type passed to `update`.
  * @tparam Curr Current state type passed to `update`.
  * @tparam Prev Previous state type passed to `update`.
  * @tparam Eval Evaluation record containing alpha/obj/dir.
  * @tparam P Search direction type passed to `update`.
  * @tparam Backoff Callable that shrinks `eval.alpha()` and returns a bool.
- * @tparam IsValid Callable that returns true when the evaluation is valid.
+ * @tparam IsValid Callable that returns true when the evaluation is valid. When `Update` is non-void, must accept 2 arguments whereh the second argument is the return of `Update`.
  *
- * @param update Evaluator invoked as `update(curr, prev, eval, p)`.
- * @param curr Current state forwarded to `update`.
- * @param prev Previous state forwarded to `update`.
- * @param eval Evaluation record, updated in-place by `update`.
- * @param p Search direction forwarded to `update`.
- * @param backoff Shrinks alpha and returns whether another retry should occur.
- * @param is_valid Checks whether the evaluation is valid.
+ * @param[in] update Evaluator invoked as `update(curr, prev, eval, p)`.
+ * @param[in,out] proposal Proposed step forwarded to `update`.
+ * @param[in] curr Current state forwarded to `update`.
+ * @param[in] prev Previous state forwarded to `update`.
+ * @param[in,out] eval Evaluation record, updated in-place by `update`.
+ * @param[in] p Search direction forwarded to `update`.
+ * @param[in] backoff Shrinks alpha and returns whether another retry should occur.
+ * @param[in] is_valid Checks whether the evaluation is valid.
  *
  * @return For void updates, returns void. Otherwise returns the value from the
  *         first valid evaluation.