Fixed runtime config solver docs

PrincetonUniversity · Oct 10, 2024 · d4939e6 · d4939e6
1 parent cf02d4b
commit d4939e6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/api/setup_parameters/solver/index.rst b/docs/api/setup_parameters/solver/index.rst
@@ -4,5 +4,5 @@ Solver API
 
 Methods to read solver information from the configuration file and instantiate a solver.
 
-.. doxygenclass:: specfem::runtime_configuration::solver:solver
+.. doxygenclass:: specfem::runtime_configuration::solver::solver
     :members:
diff --git a/include/parameter_parser/solver/solver.hpp b/include/parameter_parser/solver/solver.hpp
@@ -48,6 +48,11 @@ class solver {
               std::shared_ptr<specfem::time_scheme::time_scheme> time_scheme,
               const qp_type &quadrature) const;
 
+  /**
+   * @brief Get the type of the simulation (forward or combined)
+   *
+   * @return specfem::simulation::type Type of the simulation
+   */
   inline specfem::simulation::type get_simulation_type() const {
     if (this->simulation_type == "forward") {
       return specfem::simulation::type::forward;