diff options
| author | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-04-12 17:18:27 +0200 |
|---|---|---|
| committer | Vincent Rouvreau <vincent.rouvreau@inria.fr> | 2022-04-12 17:18:27 +0200 |
| commit | bfd89c0959adb2fafe15fc7d930d4aa3589a0e83 (patch) | |
| tree | d848781960961e1031cc861a8235000cda003b73 | |
| parent | a6393ee6200010f69514875b953936b38e9eaa7f (diff) | |
doc review: accordingly to the review, replace the other places where it was also not well explained
| -rw-r--r-- | src/Simplex_tree/include/gudhi/Simplex_tree.h | 2 | ||||
| -rw-r--r-- | src/Simplex_tree/include/gudhi/Simplex_tree/Simplex_tree_iterators.h | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index 0bd76baa..34bc5ace 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -191,7 +191,7 @@ class Simplex_tree { * * 'value_type' is std::pair<Simplex_handle, Vertex_handle>. */ typedef Simplex_tree_boundary_opposite_vertex_simplex_iterator<Simplex_tree> Boundary_opposite_vertex_simplex_iterator; - /** \brief Range over the simplices of the boundary and its opposite vertex of a simplex. */ + /** \brief Range over the simplices of the boundary of a simplex and their opposite vertices. */ typedef boost::iterator_range<Boundary_opposite_vertex_simplex_iterator> Boundary_opposite_vertex_simplex_range; /** \brief Iterator over the simplices of the simplicial complex. * diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree/Simplex_tree_iterators.h b/src/Simplex_tree/include/gudhi/Simplex_tree/Simplex_tree_iterators.h index 3fd2e07c..394c6ee1 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree/Simplex_tree_iterators.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree/Simplex_tree_iterators.h @@ -181,7 +181,7 @@ class Simplex_tree_boundary_simplex_iterator : public boost::iterator_facade< SimplexTree * st_; // simplex containing the simplicial complex }; -/* \brief Iterator over the simplices of the boundary and opposite vertex of a simplex. +/* \brief Iterator over the simplices of the boundary of a simplex and their opposite vertices. * * Forward iterator, value_type is std::pair<SimplexTree::Simplex_handle, SimplexTree::Vertex_handle>.*/ template<class SimplexTree> |