From 9e3d0f79234fcc27ee10c4a4f36726775ee262f7 Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Fri, 20 May 2022 17:54:27 +0200 Subject: Fix unbalanced groups and some doxygen typos --- src/Witness_complex/include/gudhi/Active_witness/Active_witness.h | 2 +- .../include/gudhi/Active_witness/Active_witness_iterator.h | 2 +- src/Witness_complex/include/gudhi/Strong_witness_complex.h | 2 +- src/Witness_complex/include/gudhi/Witness_complex.h | 2 +- src/Witness_complex/include/gudhi/Witness_complex/all_faces_in.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) (limited to 'src/Witness_complex/include/gudhi') diff --git a/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h b/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h index 2ae1d6e0..1aebb045 100644 --- a/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h +++ b/src/Witness_complex/include/gudhi/Active_witness/Active_witness.h @@ -18,7 +18,7 @@ namespace Gudhi { namespace witness_complex { - /* \class Active_witness + /** \class Active_witness * \brief Class representing a list of nearest neighbors to a given witness. * \details Every element is a pair of a landmark identifier and the squared distance to it. */ diff --git a/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h b/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h index 4f8fddba..18f19650 100644 --- a/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h +++ b/src/Witness_complex/include/gudhi/Active_witness/Active_witness_iterator.h @@ -18,7 +18,7 @@ namespace Gudhi { namespace witness_complex { -/* \brief Iterator in the nearest landmark list. +/** \brief Iterator in the nearest landmark list. * \details After the iterator reaches the end of the list, * the list is augmented by a (nearest landmark, distance) pair if possible. * If all the landmarks are present in the list, iterator returns the specific end value diff --git a/src/Witness_complex/include/gudhi/Strong_witness_complex.h b/src/Witness_complex/include/gudhi/Strong_witness_complex.h index b3699f77..ddc0da32 100644 --- a/src/Witness_complex/include/gudhi/Strong_witness_complex.h +++ b/src/Witness_complex/include/gudhi/Strong_witness_complex.h @@ -125,7 +125,7 @@ class Strong_witness_complex { //@} private: - /* \brief Adds recursively all the faces of a certain dimension dim-1 witnessed by the same witness. + /** \brief Adds recursively all the faces of a certain dimension dim-1 witnessed by the same witness. * Iterator is needed to know until how far we can take landmarks to form simplexes. * simplex is the prefix of the simplexes to insert. * The landmark pointed by aw_it is added to all formed simplices. diff --git a/src/Witness_complex/include/gudhi/Witness_complex.h b/src/Witness_complex/include/gudhi/Witness_complex.h index d655c7f6..66ae7af2 100644 --- a/src/Witness_complex/include/gudhi/Witness_complex.h +++ b/src/Witness_complex/include/gudhi/Witness_complex.h @@ -127,7 +127,7 @@ class Witness_complex { //@} private: - /* \brief Adds recursively all the faces of a certain dimension dim witnessed by the same witness. + /** \brief Adds recursively all the faces of a certain dimension dim witnessed by the same witness. * Iterator is needed to know until how far we can take landmarks to form simplexes. * simplex is the prefix of the simplexes to insert. * The output value indicates if the witness rests active or not. diff --git a/src/Witness_complex/include/gudhi/Witness_complex/all_faces_in.h b/src/Witness_complex/include/gudhi/Witness_complex/all_faces_in.h index 5845728a..007ab084 100644 --- a/src/Witness_complex/include/gudhi/Witness_complex/all_faces_in.h +++ b/src/Witness_complex/include/gudhi/Witness_complex/all_faces_in.h @@ -11,7 +11,7 @@ #ifndef WITNESS_COMPLEX_ALL_FACES_IN_H_ #define WITNESS_COMPLEX_ALL_FACES_IN_H_ -/* \brief Check if the facets of the k-dimensional simplex witnessed +/** \brief Check if the facets of the k-dimensional simplex witnessed * by witness witness_id are already in the complex. * inserted_vertex is the handle of the (k+1)-th vertex witnessed by witness_id */ -- cgit v1.2.3