[Docs] Doxygen groups

src/alpaqa.dox

@@ -0,0 +1,25 @@
+/**
+ * @defgroup    grp_ALMSolver Augmented Lagrangian Method solver 
+ * @brief   Augmented Lagrangian Method solver (ALM).
+ */
+
+/**
+ * @defgroup    grp_InnerSolvers Inner solvers
+ * @brief   Solvers for the inner problem, such as PANOC.
+ */
+
+/**
+ * @defgroup    grp_Accelerators Accelerators
+ * @brief   Computing accelerated directions, such as L-BFGS.
+ */
+
+/**
+ * @defgroup    grp_DirectionProviders PANOC direction providers
+ * @brief   Algorithms that provide quasi-Newton steps for the PANOC solver, 
+ *          such as L-BFGS.
+ */
+
+/**
+ * @defgroup    grp_Problems  Problems
+ * @brief   Classes for defining optimization problems.
+ */

src/include/alpaqa/accelerators/lbfgs.hpp

@@ -90,7 +90,7 @@ struct LBFGSStorage {
 };
 
 /// Limited memory Broyden–Fletcher–Goldfarb–Shanno (L-BFGS) algorithm
-/// @ingroup accelerators-grp
+/// @ingroup grp_Accelerators
 template <Config Conf = DefaultConfig>
 class LBFGS {
   public:

src/include/alpaqa/inner/directions/panoc-direction-update.hpp

@@ -5,6 +5,7 @@
 
 namespace alpaqa {
 
+/// @ingroup grp_DirectionProviders
 template <class DirectionProviderT>
 struct PANOCDirection {
     USING_ALPAQA_CONFIG_TEMPLATE(DirectionProviderT::config_t);

src/include/alpaqa/inner/directions/panoc/lbfgs.hpp

@@ -5,6 +5,7 @@
 
 namespace alpaqa {
 
+/// @ingroup grp_DirectionProviders
 template <Config Conf>
 struct PANOCDirection<LBFGS<Conf>> {
     USING_ALPAQA_CONFIG(Conf);

src/include/alpaqa/interop/casadi/CasADiFunctionWrapper.hpp

@@ -11,9 +11,6 @@
 
 namespace alpaqa::casadi_loader {
 
-/// @addtogroup grp_ExternalProblemLoaders
-/// @{
-
 /// Class for evaluating CasADi functions, allocating the necessary workspace
 /// storage in advance for allocation-free evaluations.
 template <Config Conf, size_t N_in, size_t N_out>
@@ -95,6 +92,4 @@ class CasADiFunctionEvaluator {
     mutable std::vector<double> dwork;
 };
 
-/// @}
-
 } // namespace alpaqa::casadi_loader

src/include/alpaqa/interop/casadi/CasADiLoader.hpp

@@ -15,9 +15,8 @@ template <Config>
 struct CasADiFunctionsWithParam;
 } // namespace casadi_loader
 
-/// @addtogroup grp_ExternalProblemLoaders
-/// @{
-
+/// Problem definition for a CasADi problem, loaded from a DLL.
+/// @ingroup grp_Problems
 template <Config Conf = DefaultConfig>
 class CasADiProblem : public Problem<Conf> {
   public:
@@ -77,6 +76,4 @@ class CasADiProblem : public Problem<Conf> {
 CASADI_LOADER_EXPORT_EXTERN_TEMPLATE(class, CasADiProblem, EigenConfigd);
 CASADI_LOADER_EXPORT_EXTERN_TEMPLATE(class, CasADiProblem, DefaultConfig);
 
-/// @}
-
 } // namespace alpaqa

src/include/alpaqa/problem/problem.hpp

@@ -221,6 +221,8 @@ class ProblemBase {
  * sections are optional, by default, they are computed by evaluating the 
  * “Basic functions”, but performance can be improved by providing functions 
  * that directly compute multiple quantities at once.
+ *
+ * @ingroup grp_Problems
  */
 template <Config Conf = DefaultConfig>
 class Problem : public ProblemBase<Conf> {
@@ -306,6 +308,7 @@ class Problem : public ProblemBase<Conf> {
 
 /// @ref Problem class that allows specifying the basic functions as C++
 /// `std::function`s.
+/// @ingroup grp_Problems
 template <Config Conf = DefaultConfig>
 class FunctionalProblem : public Problem<Conf> {
   public: