Clarify some details in the concept FilteredComplex.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/trunk@1058 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 825978488684e4dcf5b4fc491e6c4467332dbd20

1 files changed, 7 insertions, 6 deletions

diff --git a/src/Persistent_cohomology/concept/FilteredComplex.h b/src/Persistent_cohomology/concept/FilteredComplex.h
index e124d524..e47babe4 100644
--- a/src/Persistent_cohomology/concept/FilteredComplex.h
+++ b/src/Persistent_cohomology/concept/FilteredComplex.h
@@ -43,7 +43,7 @@ struct FilteredComplex
   * is model of IndexingTag. */
   typedef unspecified      Indexing_tag;
 
-/** Returns a Simplex_hanlde that is different from all simplex handles 
+/** Returns a Simplex_handle that is different from all simplex handles 
   * of the simplices. */
   Simplex_handle           null_simplex();
 /** \brief Returns the number of simplices in the complex.
@@ -61,12 +61,13 @@ struct FilteredComplex
 /** \brief Returns a key that is different from the keys associated 
   * to the simplices. */
   Simplex_key              null_key ();
-/** \brief Returns the key associated to a simplex. */  
+/** \brief Returns the key associated to a simplex.
+ *
+ * This is never called on null_simplex(). */
   Simplex_key              key      ( Simplex_handle sh );
-/** \brief Returns the simplex associated to a key.
-  *
-  * If key is different from null_key(), returns the simplex that
-  * has index idx in the filtration. */
+/** \brief Returns the simplex that has index idx in the filtration.
+ *
+ * This is never called on null_key(). */
   Simplex_handle           simplex  ( Simplex_key idx );
 /** \brief Assign a key to a simplex. */
   void                     assign_key(Simplex_handle sh, Simplex_key key);