From 479bcccbaede8aa59ae28c8cd9b15de08053a817 Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Thu, 5 Oct 2017 18:03:24 +0000 Subject: Doc review : automatic_dimension_set return documentation was not clear git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_automatic_dimension_set@2761 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 04b4dee9d228923f36062001529476251eac4ef0 --- src/Simplex_tree/include/gudhi/Simplex_tree.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h index 6494aa5d..8a827086 100644 --- a/src/Simplex_tree/include/gudhi/Simplex_tree.h +++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h @@ -1196,7 +1196,7 @@ class Simplex_tree { public: /** \brief Deep search simplex tree dimension reset. - * @return The dimension modification information. + * @return True if the dimension was modified, false otherwise. * \pre Be sure the simplex tree has not a too low dimension value as the deep search stops when the former dimension * has been reached (cf. `dimension()` and `set_dimension()` methods). */ -- cgit v1.2.3