From a114ccb40558615139eeb23dfc05e3ceeb909d7f Mon Sep 17 00:00:00 2001
From: vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Tue, 31 Jul 2018 15:47:22 +0000
Subject: Fix documentation for CGAL version required by 3d version Remove
 duplicated example (cf. the one in the Simplex tree) Add the example for
 documentation

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

Former-commit-id: 204f77982c61bc30a6ad3218c82b98f8bb49d711
---
 src/common/doc/examples.h     |  1 +
 src/common/doc/installation.h | 10 ++++++++--
 2 files changed, 9 insertions(+), 2 deletions(-)

(limited to 'src/common/doc')

diff --git a/src/common/doc/examples.h b/src/common/doc/examples.h
index 7c2a8f69..c19b3444 100644
--- a/src/common/doc/examples.h
+++ b/src/common/doc/examples.h
@@ -53,6 +53,7 @@
  * @example Spatial_searching/example_spatial_searching.cpp
  * @example Alpha_complex/alpha_complex_3d_persistence.cpp
  * @example Alpha_complex/alpha_complex_persistence.cpp
+ * @example Alpha_complex/Weighted_alpha_complex_3d_from_points.cpp
  * @example Bottleneck_distance/bottleneck_distance.cpp
  * @example Witness_complex/weak_witness_persistence.cpp
  * @example Witness_complex/strong_witness_persistence.cpp
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h
index 8f91e9c1..d36a216f 100644
--- a/src/common/doc/installation.h
+++ b/src/common/doc/installation.h
@@ -56,8 +56,6 @@ make doxygen
  * 
  * The following examples/utilities require the <a target="_blank" href="http://www.cgal.org/">Computational Geometry Algorithms
  * Library</a> (CGAL \cite cgal:eb-15b) and will not be built if CGAL is not installed:
- * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html">
- * Alpha_complex/alpha_complex_3d_persistence.cpp</a>
  * \li <a href="_simplex_tree_2example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html">
  * Simplex_tree/example_alpha_shapes_3_simplex_tree_from_off_file.cpp</a>
  * 
@@ -113,6 +111,12 @@ make doxygen
  * \li <a href="_tangential_complex_2example_with_perturb_8cpp-example.html">
  * Tangential_complex/example_with_perturb.cpp</a>
  *
+ * The following example requires CGAL version &ge; 4.11.0:
+ * \li <a href="_alpha_complex_2_weighted_alpha_complex_3d_from_points_8cpp-example.html">
+ * Alpha_complex/Weighted_alpha_complex_3d_from_points.cpp</a>
+ * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html">
+ * Alpha_complex/alpha_complex_3d_persistence.cpp</a>
+ *
  * \subsection eigen3 Eigen3
  * The \ref alpha_complex data structure and few examples requires
  * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> is a C++ template library for linear algebra:
@@ -128,6 +132,8 @@ make doxygen
  * Alpha_complex/alpha_complex_persistence.cpp</a>
  * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html">
  * Alpha_complex/alpha_complex_3d_persistence.cpp</a>
+ * \li <a href="_alpha_complex_2_weighted_alpha_complex_3d_from_points_8cpp-example.html">
+ * Alpha_complex/Weighted_alpha_complex_3d_from_points.cpp</a>
  * \li <a href="_bottleneck_distance_2alpha_rips_persistence_bottleneck_distance_8cpp-example.html">
  * Bottleneck_distance/alpha_rips_persistence_bottleneck_distance.cpp.cpp</a>
  * \li <a href="_persistent_cohomology_2custom_persistence_sort_8cpp-example.html">
-- 
cgit v1.2.3