Merge of branch rips_doc_fixes

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

Former-commit-id: 62c4af03ee0265364a5a5879df25f350fc323a8a

1 files changed, 11 insertions, 5 deletions

diff --git a/src/Rips_complex/doc/Intro_rips_complex.h b/src/Rips_complex/doc/Intro_rips_complex.h
index 884a4eff..8e374c09 100644
--- a/src/Rips_complex/doc/Intro_rips_complex.h
+++ b/src/Rips_complex/doc/Intro_rips_complex.h
@@ -48,8 +48,10 @@ namespace rips_complex {
  * All edges that have a filtration value strictly greater than a given threshold value are not inserted into
  * the complex.
  * 
- * When creating a simplicial complex from this one skeleton graph, rips inserts the one skeleton graph into the data
+ * When creating a simplicial complex from this one skeleton graph, Rips inserts the one skeleton graph into the data
  * structure, and then expands the simplicial complex when required.
+ *
+ * Vertex name correspond to the index of the point in the given range (aka. the point cloud).
  * 
  * \image html "rips_complex_representation.png" "Rips-complex one skeleton graph representation"
  * 
@@ -57,6 +59,10 @@ namespace rips_complex {
  * value set with \f$max(filtration(4,5), filtration(4,6), filtration(5,6))\f$.
  * And so on for simplex (0,1,2,3).
  * 
+ * If the Rips_complex interfaces are not detailed enough for your need, please refer to
+ * <a href="_persistent_cohomology_2rips_persistence_step_by_step_8cpp-example.html">
+ * rips_persistence_step_by_step.cpp</a> example, where the graph construction over the Simplex_tree is more detailed.
+ *
  * \section ripspointsdistance Point cloud and distance function
  * 
  * \subsection ripspointscloudexample Example from a point cloud and a distance function
@@ -68,7 +74,7 @@ namespace rips_complex {
  * 
  * \include Rips_complex/example_one_skeleton_rips_from_points.cpp
  * 
- * When launching (rips maximal distance between 2 points is 12.0, is expanded until dimension 1 - one skeleton graph
+ * When launching (Rips maximal distance between 2 points is 12.0, is expanded until dimension 1 - one skeleton graph
  * in other words):
  * 
  * \code $> ./oneskeletonripspoints
@@ -85,7 +91,7 @@ namespace rips_complex {
  * Then it creates a `Simplex_tree` with it.
  * 
  * 
- * Then, it is asked to display information about the rips complex.
+ * Then, it is asked to display information about the Rips complex.
  * 
  * \include Rips_complex/example_rips_complex_from_off_file.cpp
  * 
@@ -111,7 +117,7 @@ namespace rips_complex {
  * 
  * \include Rips_complex/example_one_skeleton_rips_from_distance_matrix.cpp
  * 
- * When launching (rips maximal distance between 2 points is 1.0, is expanded until dimension 1 - one skeleton graph
+ * When launching (Rips maximal distance between 2 points is 1.0, is expanded until dimension 1 - one skeleton graph
  * with other words):
  * 
  * \code $> ./oneskeletonripsdistance
@@ -127,7 +133,7 @@ namespace rips_complex {
  * Then it creates a `Simplex_tree` with it.
  * 
  * 
- * Then, it is asked to display information about the rips complex.
+ * Then, it is asked to display information about the Rips complex.
  * 
  * \include Rips_complex/example_rips_complex_from_csv_distance_matrix_file.cpp
  *