Copy the doc from FilteredComplex::simplex to the Simplex_tree.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST-doc-simplex@2920 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 0323c23e4cd46f79439f477475df4273847aafc2

1 files changed, 3 insertions, 3 deletions

diff --git a/src/Simplex_tree/include/gudhi/Simplex_tree.h b/src/Simplex_tree/include/gudhi/Simplex_tree.h
index 7da767cb..836e0612 100644
--- a/src/Simplex_tree/include/gudhi/Simplex_tree.h
+++ b/src/Simplex_tree/include/gudhi/Simplex_tree.h
@@ -391,13 +391,13 @@ class Simplex_tree {
     return sh->second.key();
   }
 
-  /** \brief Returns the simplex associated to a key.
+  /** \brief Returns the simplex that has index idx in the filtration.
    *
    * The filtration must be initialized.
    * \pre SimplexTreeOptions::store_key
    */
-  Simplex_handle simplex(Simplex_key key) const {
-    return filtration_vect_[key];
+  Simplex_handle simplex(Simplex_key idx) const {
+    return filtration_vect_[idx];
   }
 
   /** \brief Returns the filtration value of a simplex.