summaryrefslogtreecommitdiff
path: root/src/Alpha_complex/doc/Intro_alpha_complex.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-11-16 14:23:54 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-11-16 14:23:54 +0000
commit9fc5621abbf55da2883a33e53e7d1a18218dc99a (patch)
treed4d1f9feeb24e316848912c4493a2e7f6003859e /src/Alpha_complex/doc/Intro_alpha_complex.h
parent7b64e122ccda2f592a1a20c339318880302a92ed (diff)
Doc review : User version bad description for Alpha complex 3d
Add a comment for alpha complex 3d example creation for templates Code review : SAFE is now the default version git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alpha_complex_3d_module_vincent@3990 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: a283cc630ac78634d6700aefb981d130c9464024
Diffstat (limited to 'src/Alpha_complex/doc/Intro_alpha_complex.h')
-rw-r--r--src/Alpha_complex/doc/Intro_alpha_complex.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h
index 648fb6d6..fddab003 100644
--- a/src/Alpha_complex/doc/Intro_alpha_complex.h
+++ b/src/Alpha_complex/doc/Intro_alpha_complex.h
@@ -168,8 +168,10 @@ namespace alpha_complex {
*
* \section weighted3dexample 3d specific example
*
- * A specific module for Alpha complex is available in 3d (cf. Alpha_complex_3d) and allows to construct default, exact,
- * weighted, periodic or weighted and periodic versions of alpha complexes
+ * A specific module for Alpha complex is available in 3d (cf. Alpha_complex_3d) and allows to construct standard,
+ * weighted, periodic or weighted and periodic versions of alpha complexes. Alpha values computation can be
+ * Gudhi::alpha_complex::complexity::FAST, Gudhi::alpha_complex::complexity::SAFE (default value) or
+ * Gudhi::alpha_complex::complexity::EXACT.
*
* This example builds the CGAL 3d weighted alpha shapes from a small molecule, and initializes the alpha complex with
* it. This example is taken from <a href="https://doc.cgal.org/latest/Alpha_shapes_3/index.html#title13">CGAL 3d