[doc][doxygen] some fixes

frackit/common/promotedtype.hh

@@ -40,7 +40,11 @@ struct PromotionTraits
     using PromotedType = decltype(std::declval<T1>()+std::declval<T2>());
 };
 
-// Specialization for the case of two equal types
+/*!
+ * \ingroup Common
+ * \brief Specialization of the PromotionTraits
+ *        for the case of two equal types.
+ */
 template<class T1>
 struct PromotionTraits<T1,T1> { typedef T1 PromotedType; };
 

frackit/entitynetwork/constraints.hh

@@ -265,7 +265,7 @@ public:
      *        pointer to its original geometry type.
      * \tparam T either a entity type or an entity set
      * \param entityOrSet An entity or an entity set
-     * \param geo2 Pointer to a generic geometry type
+     * \param geo2Ptr Pointer to a generic geometry type
      * \returns True if all constraints are fulfilled, false otherwise
      */
     template<class T>
@@ -281,7 +281,7 @@ public:
      *        to a generic geometry. Unfortunately, this requires
      *        parsing the pointer to its original geometry type.
      * \tparam T either a entity type or an entity set
-     * \param geo1 Pointer to a generic geometry type
+     * \param geo1Ptr Pointer to a generic geometry type
      * \param entityOrSet An entity or an entity set
      * \returns True if all constraints are fulfilled, false otherwise
      */

frackit/entitynetwork/containedentitynetwork.hh

@@ -54,11 +54,11 @@ public:
     /*!
      * \brief Constructor.
      * \param entityDim Dimension of the network entities
-     * \param fragmentList List containing all entity fragments
-     * \param fragmentIndexMap Map containing the fragments
-     *                         of a network, where each fragment
-     *                         is mapped to the index of the primary
-     *                         entity of the network.
+     * \param sdFragments The sub-domains, split into fragments by the entities
+     * \param entityFragments Contains the entity fragments of each sub-domain
+     * \param entityFragmentMaps Map containing the fragments of the sub-domains,
+     *                           where each fragment is mapped to the index of the
+     *                           primary entity of the network from which is was created.
      */
     ContainedEntityNetwork(int entityDim,
                            int domainDim,
@@ -83,21 +83,21 @@ public:
 
     /*!
      * \brief Returns the fragments of a sub-domain
-     * \param subDomainIdx The index of the sub-domain
+     * \param subDomainId The id of the sub-domain
      */
     const TopTools_ListOfShape& subDomainFragments(Id subDomainId) const override
     { return subDomainFragments_.at(subDomainId.get()); }
 
     /*!
      * \brief Returns the entity fragments of the network defined for a sub-domain
-     * \param subDomainIdx The index of the sub-domain
+     * \param subDomainId The id of the sub-domain
      */
     const TopTools_ListOfShape& subDomainEntityFragments(Id subDomainId) const override
     { return subDomainEntityFragments_.at(subDomainId.get()); }
 
     /*!
      * \brief Returns the map which maps each fragment the network of a sub-domain to its primary entity index.
-     * \param subDomainIdx The index of the sub-domain
+     * \param subDomainId The id of the sub-domain
      */
     const TopTools_DataMapOfShapeInteger& subDomainEntityFragmentsIndexMap(Id subDomainId) const override
     { return subDomainEntityFragmentIndexMap_.at(subDomainId.get()); }

frackit/entitynetwork/containedentitynetworkinterface.hh

@@ -75,19 +75,19 @@ public:
 
     /*!
      * \brief Returns the fragments of a sub-domain
-     * \param subDomainIdx The index of the sub-domain
+     * \param subDomainId The id of the sub-domain
      */
     virtual const TopTools_ListOfShape& subDomainFragments(Id subDomainId) const = 0;
 
     /*!
      * \brief Returns the entity fragments of the network defined for a sub-domain
-     * \param subDomainIdx The index of the sub-domain
+     * \param subDomainId The id of the sub-domain
      */
     virtual const TopTools_ListOfShape& subDomainEntityFragments(Id subDomainId) const = 0;
 
     /*!
      * \brief Returns the map which maps each fragment the network of a sub-domain to its primary entity index.
-     * \param subDomainIdx The index of the sub-domain
+     * \param subDomainId The id of the sub-domain
      */
     virtual const TopTools_DataMapOfShapeInteger& subDomainEntityFragmentsIndexMap(Id subDomainId) const = 0;
 

frackit/entitynetwork/multigeometryentityset.hh

@@ -62,7 +62,7 @@ public:
     /*!
      * \brief Adds an entity to the set with the given id.
      * \param entity The entity to be added.
-     * \param if The id of the entity set.
+     * \param id The id of the entity set.
      */
     template<class Entity>
     void addEntity(const Entity& entity, const Id& id)
@@ -103,7 +103,7 @@ public:
     /*!
      * \brief Adds an entity to the set with the given id.
      * \param entity Pointer to the abstract geometry base class
-     * \param if The id of the entity set.
+     * \param id The id of the entity set.
      */
     void addEntity(std::shared_ptr<Geometry> entity, const Id& id)
     {

frackit/geometry/circle.hh

@@ -73,6 +73,7 @@ public:
      * \param center The center point of the circle
      * \param normal The normal direction of the plane
      *               the circle is embedded in
+     * \param radius The radius of the circle
      */
     Circle(const Point& center,
            const Direction& normal,

frackit/geometry/direction.hh

@@ -217,7 +217,7 @@ private:
  * \relates Direction
  *
  * \param s std::ostream to write to
- * \param v Direction to write
+ * \param d Direction to write
  *
  * \returns the output stream (s)
  */
@@ -234,7 +234,7 @@ std::ostream& operator<< (std::ostream& s, const Direction<CT, 1>& d)
  * \relates Direction
  *
  * \param s std::ostream to write to
- * \param v Direction to write
+ * \param d Direction to write
  *
  * \returns the output stream (s)
  */

frackit/sampling/quadrilateralsampler.hh

@@ -104,7 +104,7 @@ public:
      * \param strikeDistro The distribution used for the strike angle
      * \param dipDistro The distribution used for the dip angle
      * \param edgeDistro The distribution used for the edge length
-     * \minEdgeLength Minimum allowed edge length
+     * \param minEdgeLength Minimum allowed edge length
      * \note The edge distribution is sampled until an admissible value
      *       above the minimum allowed edge length is obtained. Thus,
      *       if you choose a high minimum length, depending on the chosen