From 87a8d7962ea13f11e591462ec5757e9e1747dc07 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Tue, 20 Aug 2019 17:05:13 +0200 Subject: Fix issue #10 and modify main and installation documentations accordingly --- src/common/doc/installation.h | 12 ++++++------ src/common/doc/main_page.md | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) (limited to 'src/common/doc') diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 2629d12c..02d3c73a 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -60,8 +60,8 @@ make doxygen * Having GMP version 4.2 or higher installed is recommended. * * \subsection cgal CGAL - * The \ref alpha_complex data structure, \ref bottleneck_distance, and few examples requires CGAL, which is a C++ - * library which provides easy access to efficient and reliable geometric algorithms. + * Some GUDHI modules (cf. \ref main_page "modules list"), and few examples requires CGAL, a C++ library that provides + * easy access to efficient and reliable geometric algorithms. * * \note There is no need to install CGAL, you can just cmake . && make CGAL (or even * cmake -DCGAL_HEADER_ONLY=ON .), thereafter you will be able to compile @@ -125,13 +125,13 @@ make doxygen * \li * Alpha_complex/alpha_complex_3d_persistence.cpp * - * \subsection eigen3 Eigen3 + * \subsection eigen Eigen * The \ref alpha_complex data structure and few examples requires - * Eigen3 is a C++ template library for linear algebra: + * Eigen is a C++ template library for linear algebra: * matrices, vectors, numerical solvers, and related algorithms. * - * The following examples/utilities require the Eigen3 and will not be - * built if Eigen3 is not installed: + * The following examples/utilities require the Eigen and will not be + * built if Eigen is not installed: * \li * Alpha_complex/Alpha_complex_from_off.cpp * \li diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index ea2474be..d8cbf97f 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -50,7 +50,7 @@ Author: Vincent Rouvreau
Introduced in: GUDHI 1.3.0
Copyright: MIT [(GPL v3)](../../licensing/)
- Requires: \ref eigen3 and \ref cgal ≥ 4.11.0 + Requires: \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 @@ -126,7 +126,7 @@ Author: Siargey Kachanovich
Introduced in: GUDHI 1.3.0
Copyright: MIT ([GPL v3](../../licensing/) for Euclidean version)
- Euclidean version requires: \ref eigen3 and \ref cgal ≥ 4.11.0 + Euclidean version requires: \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 @@ -324,7 +324,7 @@ Author: Clément Jamin
Introduced in: GUDHI 2.0.0
Copyright: MIT [(GPL v3)](../../licensing/)
- Requires: \ref eigen3 and \ref cgal ≥ 4.11.0 + Requires: \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 -- cgit v1.2.3