From 26bed354555e0f0fc18c6adc6a4b0fe27379a4a6 Mon Sep 17 00:00:00 2001
From: vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Wed, 3 Feb 2016 11:37:33 +0000
Subject: Mentionning Delaunay complex in Alpha complex documentation (user and
 reference) Specifying Alpha complex Kernel must be an Epick_d dD kernel (user
 and reference)

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

Former-commit-id: b1a7a0cadd236bbfa6c529f2979ad2096414e207
---
 src/Alpha_complex/doc/Intro_alpha_complex.h     | 4 +++-
 src/Alpha_complex/include/gudhi/Alpha_complex.h | 6 ++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h
index 8eea6ba7..b109956d 100644
--- a/src/Alpha_complex/doc/Intro_alpha_complex.h
+++ b/src/Alpha_complex/doc/Intro_alpha_complex.h
@@ -52,10 +52,12 @@ namespace alphacomplex {
  * \cite cgal:hdj-t-15b from <a target="_blank" href="http://www.cgal.org/">CGAL</a> (the Computational Geometry
  * Algorithms Library \cite cgal:eb-15b).
  * 
- * The complex is a template class requiring a <a target="_blank"
+ * The complex is a template class requiring an Epick_d <a target="_blank"
  * href="http://doc.cgal.org/latest/Kernel_d/index.html#Chapter_dD_Geometry_Kernel">dD Geometry Kernel</a>
  * \cite cgal:s-gkd-15b from CGAL as template.
  * 
+ * \remark When Alpha_complex is constructed with an infinite value of alpha, the complex is a Delaunay complex.
+ * 
  * \section pointsexample Example from points
  * 
  * This example builds the Delaunay triangulation from the given points in a 2D static kernel, and initializes the
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h
index 962ed8dc..0898c6cd 100644
--- a/src/Alpha_complex/include/gudhi/Alpha_complex.h
+++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h
@@ -57,6 +57,12 @@ namespace alphacomplex {
  * 
  * Please refer to \ref alpha_complex for examples.
  *
+ * The complex is a template class requiring an Epick_d <a target="_blank"
+ * href="http://doc.cgal.org/latest/Kernel_d/index.html#Chapter_dD_Geometry_Kernel">dD Geometry Kernel</a>
+ * \cite cgal:s-gkd-15b from CGAL as template.
+ * 
+ * \remark When Alpha_complex is constructed with an infinite value of alpha, the complex is a Delaunay complex.
+ * 
  */
 template<class Kernel>
 class Alpha_complex : public Simplex_tree<> {
-- 
cgit v1.2.3