[doc][doxygen] introduce entitynetwork&constraints groups

doc/doxygen/modules.txt

@@ -13,3 +13,16 @@
  * \defgroup Distance Distance
  * \brief Functionality related to distance computations between geometrical objects.
  */
+
+/*!
+ * \defgroup EntityNetwork Entity Networks
+ * \brief Classes, functions and concepts related to networks of geometrical entities.
+ */
+
+    /*!
+     * \ingroup EntityNetwork
+     * \defgroup Constraints Constraints
+     * \brief Classes and functions related to the enforcement
+     *        geometric constraints (distance, intersection angle etc)
+     *        between entities in entity networks.
+     */

frackit/entitynetwork/constraints.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Constraints
  * \brief Class that enforces geometric
  *        constraints on networks of entities.
  */
@@ -53,14 +54,16 @@ template<class ST = double,
 class EntityNetworkConstraints;
 
 /*!
- * \brief Convenience function to construct an instance
- *        of the constraints class using the default engines
+ * \ingroup Constraints
+ * \brief Convenience function to construct an instance of
+ *        the constraints class using the default template arguments.
  */
 template<class ST = double>
 EntityNetworkConstraints<ST> makeDefaultConstraints()
 { return EntityNetworkConstraints<ST>(IntersectionAngle<ST>()); }
 
 /*!
+ * \ingroup Constraints
  * \brief Class which defines and checks constraints on
  *        the geometric relationships between entities of
  *        a network. As constraints one can define:

frackit/entitynetwork/constraintsmatrix.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup Constraints
  * \brief Class that allows defining a matrix of constraints.
  *        This is useful in contexts where multiple entity sets
  *        are defined, and where different constraints should be
@@ -38,6 +39,7 @@
 namespace Frackit {
 
 /*!
+* \ingroup Constraints
  * \brief Class that allows defining a matrix of constraints.
  *        For each constraint that is defined, a list of id pairs
  *        is passed that defines between which ids (representing

frackit/entitynetwork/containedentitynetwork.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
  /*!
   * \file
+  * \ingroup EntityNetwork
   * \brief Class representing a network of entities, contained
   *        in (possibly multiple) sub-domains. Sub-networks might
   *        be defined on each sub-domain.
@@ -38,6 +39,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup EntityNetwork
  * \relates ContainedEntityNetworkBuilder
  * \brief Class representing a network of entities, contained
  *        in (possibly multiple) sub-domains. Sub-networks might

frackit/entitynetwork/containedentitynetworkinterface.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup EntityNetwork
  * \brief Interface defining networks of entities contained
  *        in (possibly multiple) sub-domains.
  */
@@ -35,6 +36,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup EntityNetwork
  * \brief Interface defining networks of entities contained
  *        in (possibly multiple) sub-domains.
  */

frackit/entitynetwork/entitynetwork.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup EntityNetwork
  * \brief Class representing a network of entities,
  *        consisting of fragments of primary entities.
  */
@@ -33,6 +34,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup EntityNetwor
  * \relates EntityNetworkBuilder
  * \brief Class representing a network of entities,
  *        consisting of fragments of primary entities.

frackit/entitynetwork/entitynetworkinterface.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup EntityNetwork
  * \brief Interface defining networks of entities.
  */
 #ifndef FRACKIT_ENTITY_NETWORK_INTERFACE_HH
@@ -30,6 +31,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup EntityNetwork
  * \brief Interface defining networks of entities.
  */
 class EntityNetworkInterface

frackit/entitynetwork/multigeometryentityset.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup EntityNetwork
  * \brief Class in which sets of entities of different
  *        geometry types can be stored. Each entity set
  *        receives a unique identifier, which is deduced
@@ -40,6 +41,7 @@
 namespace Frackit {
 
 /*!
+ * \ingroup EntityNetwork
  * \brief Class in which sets of entities of
  *        different geometry types can be stored.
  */

frackit/entitynetwork/networkbuilder.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup EntityNetwork
  * \brief Contains builder classes for entity networks.
  */
 #ifndef FRACKIT_ENTITY_NETWORK_BUILDER_HH
@@ -54,6 +55,7 @@ template<class ctype = double>
 class ContainedEntityNetworkBuilder;
 
 /*!
+ * \ingroup EntityNetwork
  * \brief Base class for builders of entity networks.
  *        Stores data related to the entities and sub-domains.
  */
@@ -490,6 +492,7 @@ protected:
 };
 
 /*!
+ * \ingroup EntityNetwork
  * \brief Builder class for entity networks,
  *        which neglect the sub-domains in which
  *        the network is embedded in and only carries
@@ -590,6 +593,7 @@ private:
 };
 
 /*!
+ * \ingroup EntityNetwork
  * \brief Builder class for entity networks contained
  *        in (possibly multiple) sub-domains.
  */