From 837ffddda60d3f389184fe167710f74ad8adf36b Mon Sep 17 00:00:00 2001
From: ROUVREAU Vincent <vincent.rouvreau@inria.fr>
Date: Thu, 17 Sep 2020 09:37:25 +0200
Subject: Some documentation for weighted version

---
 src/Alpha_complex/include/gudhi/Alpha_complex.h                | 7 ++++---
 src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h | 8 ++++++++
 2 files changed, 12 insertions(+), 3 deletions(-)

(limited to 'src/Alpha_complex')

diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h
index b66ec20d..1d395bd8 100644
--- a/src/Alpha_complex/include/gudhi/Alpha_complex.h
+++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h
@@ -132,17 +132,18 @@ class Alpha_complex {
   using Triangulation = typename std::conditional<Weighted, CGAL::Regular_triangulation<Kernel, TDS>,
                                                             CGAL::Delaunay_triangulation<Kernel, TDS>>::type;
 
+  /** \brief CGAL kernel container for computations in function of the weighted or not characteristics.*/
   using A_kernel_d = Alpha_kernel_d<Kernel, Weighted>;
 
   // Numeric type of coordinates in the kernel
   using FT = typename A_kernel_d::FT;
 
-  /** \brief If Weighted, the weighted point is cached (point + weight [= squared radius]),
-   * else a pair of point and squared radius is cached.
+  /** \brief Sphere is a std::pair<Kernel::Point_d, Kernel::FT> (aka. circurmcenter and squared radius).
+   * If Weighted, Sphere is a Kernel::Weighted_point_d (aka. circurmcenter and the weight value is the squared radius).
   */
   using Sphere = typename A_kernel_d::Sphere;
 
-  /** \brief A point in Euclidean space.*/
+  /** \brief A point, or a weighted point in Euclidean space.*/
   using Point_d = typename std::conditional<Weighted, typename A_kernel_d::Weighted_point_d,
                                                       typename A_kernel_d::Point_d>::type;
 
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h b/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
index a4824207..e3567a6d 100644
--- a/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
+++ b/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
@@ -32,6 +32,14 @@ namespace Gudhi {
 
 namespace alpha_complex {
 
+/**
+ * \class Alpha_kernel_d
+ * \brief Alpha complex kernel container.
+ * 
+ * \details
+ * The Alpha complex kernel container stores CGAL Kernel and dispatch basics computations in function of the weighted
+ * or not version of the Alpha complex.
+ */
 template < typename Kernel, bool Weighted = false >
 class Alpha_kernel_d {
 };
-- 
cgit v1.2.3