fix of small doxygen warnings which appear when EXTRACT_PRIVATE=YES

mglisse · Jul 9, 2024 · 4f5be9c · 4f5be9c
1 parent 1c1bbe5
commit 4f5be9c
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 3 deletions.
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -1097,6 +1097,7 @@ class Simplex_tree {
   /** Recursive search of cofaces
    * This function uses DFS
    *\param vertices contains a list of vertices, which represent the vertices of the simplex not found yet.
+   *\param curr_sib pointer to the siblings to iterate over for this iteration of the recursion.
    *\param curr_nbVertices represents the number of vertices of the simplex we reached by going through the tree.
    *\param cofaces contains a list of Simplex_handle, representing all the cofaces asked.
    *\param star true if we need the star of the simplex

diff --git a/src/Skeleton_blocker/include/gudhi/Skeleton_blocker/Skeleton_blocker_sub_complex.h b/src/Skeleton_blocker/include/gudhi/Skeleton_blocker/Skeleton_blocker_sub_complex.h
@@ -64,7 +64,7 @@ class Skeleton_blocker_sub_complex : public ComplexType {
 
  protected:
   /**
-   * @brief Determines whether all proper faces of simplex 'sigma' belong to 'link1' \cup 'link2'
+   * @brief Determines whether all proper faces of simplex 'sigma' belong to 'link1' \f$\cup\f$ 'link2'
    * where 'link1' and 'link2' are subcomplexes of the same complex of type ComplexType
    */
   typedef std::map<Root_vertex_handle, Vertex_handle> IdAddressMap;

diff --git a/src/Skeleton_blocker/include/gudhi/Skeleton_blocker_complex.h b/src/Skeleton_blocker/include/gudhi/Skeleton_blocker_complex.h
@@ -1094,7 +1094,7 @@ class Skeleton_blocker_complex {
  private:
   /**
    * after removing the star of a simplex, blockers sigma that contains this simplex must be removed.
-   * Furthermore, all simplices tau of the form sigma \setminus simplex_to_be_removed must be added
+   * Furthermore, all simplices tau of the form sigma \f$\setminus\f$ simplex_to_be_removed must be added
    * whenever the dimension of tau is at least 2.
    */
   void update_blockers_after_remove_star_of_vertex_or_edge(const Simplex& simplex_to_be_removed);

diff --git a/src/Skeleton_blocker/include/gudhi/Skeleton_blocker_simplifiable_complex.h b/src/Skeleton_blocker/include/gudhi/Skeleton_blocker_simplifiable_complex.h
@@ -129,7 +129,7 @@ void Skeleton_blocker_complex<SkeletonBlockerDS>::remove_star(Vertex_handle v) {
 
 /**
  * after removing the star of a simplex, blockers sigma that contains this simplex must be removed.
- * Furthermore, all simplices tau of the form sigma \setminus simplex_to_be_removed must be added
+ * Furthermore, all simplices tau of the form sigma \f$\setminus\f$ simplex_to_be_removed must be added
  * whenever the dimension of tau is at least 2.
  */
 template<typename SkeletonBlockerDS>