Remove all documentation from user manual

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

Former-commit-id: ef6f0dd7622590ae3d550162174120c2e0406cb7

3 files changed, 37 insertions, 73 deletions

diff --git a/src/Toplex_map/include/gudhi/Filtered_toplex_map.h b/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
index ed65e36f..9a35b8b7 100644
--- a/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
+++ b/src/Toplex_map/include/gudhi/Filtered_toplex_map.h
@@ -8,44 +8,35 @@
 namespace Gudhi {
 
 /** A Filtered_toplex_map represents the simplicial complex with a filtration.
- * A "toplex" is a critical simplex.
- * \ingroup toplex_map   */
+ * A "toplex" is a critical simplex. */
 class Filtered_toplex_map {
 
 public:
-    /** Vertex is the type of vertices.
-     * \ingroup toplex_map   */
+    /** Vertex is the type of vertices. */
     typedef Toplex_map::Vertex Vertex;
 
-    /** Simplex is the type of simplices.
-     * \ingroup toplex_map   */
+    /** Simplex is the type of simplices. */
     typedef Toplex_map::Simplex Simplex;
 
-    /** The type of the pointers to maximal simplices.
-     * \ingroup toplex_map   */
+    /** The type of the pointers to maximal simplices. */
     typedef Toplex_map::Simplex_ptr Simplex_ptr;
 
-    /** The type of the sets of Simplex_ptr.
-     * \ingroup toplex_map   */
+    /** The type of the sets of Simplex_ptr. */
     typedef Toplex_map::Simplex_ptr_set Simplex_ptr_set;
 
-    /** The type of the filtration values.
-     * \ingroup toplex_map   */
+    /** The type of the filtration values. */
     typedef double Filtration_value;
 
     /** Add a simplex and its subfaces with the given filtration value
-     * in the Filtered_toplex_map.
-     * \ingroup toplex_map   */
+     * in the Filtered_toplex_map. */
     template <typename Input_vertex_range>
     std::pair<Simplex, bool> insert_simplex_and_subfaces(const Input_vertex_range &vertex_range, Filtration_value f = std::numeric_limits<double>::quiet_NaN());
 
-    /** Gives the filtration of the input simplex.
-     * \ingroup toplex_map   */
+    /** Gives the filtration of the input simplex. */
     template <typename Input_vertex_range>
     Filtration_value filtration(const Input_vertex_range &vertex_range) const;
 
-    /** Is the input simplex member of the complex ?
-     * \ingroup toplex_map   */
+    /** Is the input simplex member of the complex ? */
     template <typename Input_vertex_range>
     bool membership(const Input_vertex_range &vertex_range) const;
 
diff --git a/src/Toplex_map/include/gudhi/Lazy_Toplex_map.h b/src/Toplex_map/include/gudhi/Lazy_Toplex_map.h
index 0cae967e..9aa163f9 100644
--- a/src/Toplex_map/include/gudhi/Lazy_Toplex_map.h
+++ b/src/Toplex_map/include/gudhi/Lazy_Toplex_map.h
@@ -13,59 +13,48 @@ class Lazy_Toplex_map {
 
 public:
 
-    /** Vertex is the type of vertices.
-     * \ingroup toplex_map   */
+    /** Vertex is the type of vertices. */
     typedef Toplex_map::Vertex Vertex;
 
-    /** Simplex is the type of simplices.
-     * \ingroup toplex_map   */
+    /** Simplex is the type of simplices. */
     typedef Toplex_map::Simplex Simplex;
 
-    /** The type of the pointers to maximal simplices.
-     * \ingroup toplex_map   */
+    /** The type of the pointers to maximal simplices. */
     typedef Toplex_map::Simplex_ptr Simplex_ptr;
 
-    /** The type of the sets of Simplex_ptr.
-     * \ingroup toplex_map   */
+    /** The type of the sets of Simplex_ptr. */
     typedef Toplex_map::Simplex_ptr_set Simplex_ptr_set;
 
     /** Adds the given simplex to the complex.
-     * The simplex must not have maximal coface in the complex.
-     * \ingroup toplex_map   */
+     * The simplex must not have maximal coface in the complex. */
     template <typename Input_vertex_range>
     void insert_independent_simplex(const Input_vertex_range &vertex_range);
 
     /** \brief Adds the given simplex to the complex.
-     * Nothing happens if the simplex has a coface in the complex.
-     * \ingroup toplex_map   */
+     * Nothing happens if the simplex has a coface in the complex. */
     template <typename Input_vertex_range>
     bool insert_simplex(const Input_vertex_range &vertex_range);
 
     /** \brief Removes the given simplex and its cofaces from the complex.
-     * Its faces are kept inside.
-     * \ingroup toplex_map   */
+     * Its faces are kept inside. */
     template <typename Input_vertex_range>
     void remove_simplex(const Input_vertex_range &vertex_range);
 
-    /** Does a simplex belong to the complex ?
-     * \ingroup toplex_map   */
+    /** Does a simplex belong to the complex ? */
     template <typename Input_vertex_range>
     bool membership(const Input_vertex_range &vertex_range);
 
 
-    /** Do all the facets of a simplex belong to the complex ?
-     * \ingroup toplex_map   */
+    /** Do all the facets of a simplex belong to the complex ? */
     template <typename Input_vertex_range>
     bool all_facets_inside(const Input_vertex_range &vertex_range);
 
     /** Contracts one edge in the complex.
      * The edge has to verify the link condition if you want to preserve topology.
-     * Returns the remaining vertex.
-     * \ingroup toplex_map   */
+     * Returns the remaining vertex. */
     Vertex contraction(const Vertex x, const Vertex y);
 
-    /** \brief Number of maximal simplices.
-     * \ingroup toplex_map   */
+    /** \brief Number of maximal simplices. */
     std::size_t num_maximal_simplices() const;
 
     std::unordered_map<Vertex, std::size_t> gamma0_lbounds;
diff --git a/src/Toplex_map/include/gudhi/Toplex_map.h b/src/Toplex_map/include/gudhi/Toplex_map.h
index 5a6c7dbf..271d0970 100644
--- a/src/Toplex_map/include/gudhi/Toplex_map.h
+++ b/src/Toplex_map/include/gudhi/Toplex_map.h
@@ -14,92 +14,76 @@ namespace Gudhi {
 
 /** A Toplex_map represents the simplicial complex.
  * A "toplex" is a maximal simplex.
- * \ingroup toplex_map   */
+ * \ingroup toplex_map */
 class Toplex_map {
 
 public:
 
-    /** Vertex is the type of vertices.
-     * \ingroup toplex_map   */
+    /** Vertex is the type of vertices. */
     typedef std::size_t Vertex;
 
-    /** Simplex is the type of simplices.
-     * \ingroup toplex_map   */
+    /** Simplex is the type of simplices. */
     typedef std::set<Toplex_map::Vertex> Simplex;
 
-    /** The type of the pointers to maximal simplices.
-     * \ingroup toplex_map   */
+    /** The type of the pointers to maximal simplices. */
     typedef std::shared_ptr<Toplex_map::Simplex> Simplex_ptr;
 
     struct Sptr_hash{ std::size_t operator()(const Toplex_map::Simplex_ptr& s) const; };
     struct Sptr_equal{ std::size_t operator()(const Toplex_map::Simplex_ptr& a, const Toplex_map::Simplex_ptr& b) const; };
-    /** The type of the sets of Toplex_map::Simplex_ptr.
-     * \ingroup toplex_map   */
+    /** The type of the sets of Toplex_map::Simplex_ptr. */
     typedef std::unordered_set<Toplex_map::Simplex_ptr, Sptr_hash, Sptr_equal> Simplex_ptr_set;
 
     /** \brief Adds the given simplex to the complex.
-     * Nothing happens if the simplex has a coface in the complex.
-     * \ingroup toplex_map   */
+     * Nothing happens if the simplex has a coface in the complex. */
     template <typename Input_vertex_range>
     void insert_simplex(const Input_vertex_range &vertex_range);
 
     /** \brief Removes the given simplex and its cofaces from the complex.
-     * Its faces are kept inside.
-     * \ingroup toplex_map   */
+     * Its faces are kept inside. */
     template <typename Input_vertex_range>
     void remove_simplex(const Input_vertex_range &vertex_range);
 
-    /** Does a simplex belong to the complex ?
-     * \ingroup toplex_map   */
+    /** Does a simplex belong to the complex ? */
     template <typename Input_vertex_range>
     bool membership(const Input_vertex_range &vertex_range) const;
 
-    /** Does a simplex is a toplex ?
-     * \ingroup toplex_map   */
+    /** Does a simplex is a toplex ? */
     template <typename Input_vertex_range>
     bool maximality(const Input_vertex_range &vertex_range) const;
 
     /** Gives a set of pointers to the maximal cofaces of a simplex.
      * Gives all the toplices if given the empty simplex.
-     * Gives not more than max_number maximal cofaces if max_number is strictly positive.
-     * \ingroup toplex_map   */
+     * Gives not more than max_number maximal cofaces if max_number is strictly positive. */
     template <typename Input_vertex_range>
     Toplex_map::Simplex_ptr_set maximal_cofaces(const Input_vertex_range &vertex_range, const std::size_t max_number = 0) const;
 
     /** Contracts one edge in the complex.
      * The edge has to verify the link condition if you want to preserve topology.
-     * Returns the remaining vertex.
-     * \ingroup toplex_map   */
+     * Returns the remaining vertex. */
     Toplex_map::Vertex contraction(const Toplex_map::Vertex x, const Toplex_map::Vertex y);
 
     /** Adds the given simplex to the complex.
-     * The simplex must not have neither maximal face nor coface in the complex.
-     * \ingroup toplex_map   */
+     * The simplex must not have neither maximal face nor coface in the complex. */
     template <typename Input_vertex_range>
     void insert_independent_simplex(const Input_vertex_range &vertex_range);
 
-    /** \internal Removes a toplex without adding facets after.
-     * \ingroup toplex_map   */
+    /** \internal Removes a toplex without adding facets after. */
     void erase_maximal(const Toplex_map::Simplex_ptr& sptr);
 
-    /** Removes a vertex from any simplex containing it.
-     * \ingroup toplex_map   */
+    /** Removes a vertex from any simplex containing it. */
     void remove_vertex(const Toplex_map::Vertex x);
 
-    /** \brief Number of maximal simplices.
-      * \ingroup toplex_map   */
+    /** \brief Number of maximal simplices. */
     std::size_t num_maximal_simplices() const;
 
     std::set<Toplex_map::Vertex> unitary_collapse(const Toplex_map::Vertex k, const Toplex_map::Vertex d);
 
 protected:
-    /** \internal Gives an index in order to look for a simplex quickly.
-     * \ingroup toplex_map   */
+    /** \internal Gives an index in order to look for a simplex quickly. */
     template <typename Input_vertex_range>
     Toplex_map::Vertex best_index(const Input_vertex_range &vertex_range) const;
     
-    /** \internal The map from vertices to toplices
-     * \ingroup toplex_map   */
+    /** \internal The map from vertices to toplices */
     std::unordered_map<Toplex_map::Vertex, Toplex_map::Simplex_ptr_set> t0;
 };