From 178b86f53cb16964de4365948ada341b7012c1da Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 1 Apr 2016 07:56:34 +0000 Subject: Rollback of class #include. Done from Doxyfile with STRIP_FROM_INC_PATH. Modified Gudhi banner to fix "Geometric Uderstanding" into "Geometry Uderstanding" git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/Doxygen_for_GUDHI_1.3.0@1090 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: c5830fb6f583118a5078254fde5d4a97210c10b7 --- .../include/gudhi/Bitmap_cubical_complex.h | 3 --- .../include/gudhi/Bitmap_cubical_complex/counter.h | 5 ++--- .../include/gudhi/Bitmap_cubical_complex_base.h | 5 ----- ..._cubical_complex_periodic_boundary_conditions_base.h | 1 - src/Doxyfile | 2 +- .../include/gudhi/Persistent_cohomology.h | 3 +-- .../include/gudhi/Persistent_cohomology/Field_Zp.h | 3 +-- .../include/gudhi/Persistent_cohomology/Multi_field.h | 3 +-- src/common/doc/Gudhi_banner.jpg | Bin 34437 -> 0 bytes src/common/doc/Gudhi_banner.png | Bin 0 -> 34877 bytes src/common/doc/main_page.h | 2 +- 11 files changed, 7 insertions(+), 20 deletions(-) delete mode 100644 src/common/doc/Gudhi_banner.jpg create mode 100644 src/common/doc/Gudhi_banner.png diff --git a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h index c1a3af5c..56fa297c 100644 --- a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h +++ b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex.h @@ -46,7 +46,6 @@ const bool globalDbg = false; template class is_before_in_filtration; /** - * @class Bitmap_cubical_complex Bitmap_cubical_complex.h gudhi/Bitmap_cubical_complex.h * @brief Cubical complex represented as a bitmap. * @ingroup cubical_complex * @details This is a Bitmap_cubical_complex class. It joints a functionalities of Bitmap_cubical_complex_base and @@ -318,7 +317,6 @@ class Bitmap_cubical_complex : public T { }; /** - * @class Filtration_simplex_range Bitmap_cubical_complex.h gudhi/Bitmap_cubical_complex.h * @brief Filtration_simplex_range provides the ranges for Filtration_simplex_iterator. **/ class Filtration_simplex_range { @@ -490,7 +488,6 @@ class Bitmap_cubical_complex : public T { }; /** - * @class Skeleton_simplex_range Bitmap_cubical_complex.h gudhi/Bitmap_cubical_complex.h * @brief Class needed for compatibility with Gudhi. Not useful for other purposes. **/ class Skeleton_simplex_range { diff --git a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex/counter.h b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex/counter.h index bee19344..3a8c3988 100644 --- a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex/counter.h +++ b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex/counter.h @@ -31,9 +31,8 @@ namespace Gudhi { namespace Cubical_complex { /** - * @class counter counter.h gudhi/Bitmap_cubical_complex/counter.h - * This is an implementation of a counter being a vector of integers. - * The constructor of the class takes as an input two vectors W and V. + * @brief This is an implementation of a counter being a vector of integers. + * @details The constructor of the class takes as an input two vectors W and V. * It assumes that W < V coordinatewise. * If the initial counter W is not specified, it is assumed to be vector of zeros. * The class allows to iterate between W and V by using increment() function. diff --git a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_base.h b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_base.h index 7904eb5b..2f74ba9e 100644 --- a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_base.h +++ b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_base.h @@ -39,7 +39,6 @@ namespace Gudhi { namespace Cubical_complex { /** - * @class Bitmap_cubical_complex_base Bitmap_cubical_complex_base.h gudhi/Bitmap_cubical_complex_base.h * @brief Cubical complex represented as a bitmap, class with basic implementation. * @ingroup cubical_complex * @details This is a class implementing a basic bitmap data structure to store cubical complexes. @@ -190,7 +189,6 @@ class Bitmap_cubical_complex_base { // ITERATORS /** - * @class All_cells_iterator Bitmap_cubical_complex_base.h gudhi/Bitmap_cubical_complex_base.h * @brief Iterator through all cells in the complex (in order they appear in the structure -- i.e. * in lexicographical order). **/ @@ -259,7 +257,6 @@ class Bitmap_cubical_complex_base { } /** - * @class All_cells_range Bitmap_cubical_complex_base.h gudhi/Bitmap_cubical_complex_base.h * @brief All_cells_range class provides ranges for All_cells_iterator **/ class All_cells_range { @@ -311,7 +308,6 @@ class Bitmap_cubical_complex_base { } /** - * @class Top_dimensional_cells_iterator Bitmap_cubical_complex_base.h gudhi/Bitmap_cubical_complex_base.h * @brief Iterator through top dimensional cells of the complex. The cells appear in order they are stored * in the structure (i.e. in lexicographical order) **/ @@ -414,7 +410,6 @@ class Bitmap_cubical_complex_base { } /** - * @class Top_dimensional_cells_range Bitmap_cubical_complex_base.h gudhi/Bitmap_cubical_complex_base.h * @brief Top_dimensional_cells_iterator_range class provides ranges for Top_dimensional_cells_iterator_range **/ class Top_dimensional_cells_range { diff --git a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h index 5b7e4115..0d0f2f84 100644 --- a/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h +++ b/src/Bitmap_cubical_complex/include/gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h @@ -39,7 +39,6 @@ namespace Cubical_complex { // the cells on the right / top are not in the Bitmap_cubical_complex_periodic_boundary_conditions_base /** - * @class Bitmap_cubical_complex_periodic_boundary_conditions_base Bitmap_cubical_complex_periodic_boundary_conditions_base.h gudhi/Bitmap_cubical_complex_periodic_boundary_conditions_base.h * @brief Cubical complex with periodic boundary conditions represented as a bitmap. * @ingroup cubical_complex * @details This is a class implementing a bitmap data structure with periodic boundary conditions. Most of the functions are diff --git a/src/Doxyfile b/src/Doxyfile index 63e7145c..abafdf16 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -153,7 +153,7 @@ STRIP_FROM_PATH = # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = include concept # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't diff --git a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h index d77b993e..1b86f1f9 100644 --- a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h +++ b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology.h @@ -174,8 +174,7 @@ different representations. @{ */ -/** \class Persistent_cohomology Persistent_cohomology.h gudhi/Persistent_cohomology.h - * \brief Computes the persistent cohomology of a filtered complex. +/** \brief Computes the persistent cohomology of a filtered complex. * * The computation is implemented with a Compressed Annotation Matrix * (CAM)\cite DBLP:conf/esa/BoissonnatDM13, diff --git a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Field_Zp.h b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Field_Zp.h index 458dff98..6db16e69 100644 --- a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Field_Zp.h +++ b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Field_Zp.h @@ -30,8 +30,7 @@ namespace Gudhi { namespace persistent_cohomology { -/** \class Field_Zp Field_Zp.h gudhi/Persistent_cohomology/Field_Zp.h - * \brief Structure representing the coefficient field \f$\mathbb{Z}/p\mathbb{Z}\f$ +/** \brief Structure representing the coefficient field \f$\mathbb{Z}/p\mathbb{Z}\f$ * * \implements CoefficientField * \ingroup persistent_cohomology diff --git a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Multi_field.h b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Multi_field.h index 5f987545..38bc08d1 100644 --- a/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Multi_field.h +++ b/src/Persistent_cohomology/include/gudhi/Persistent_cohomology/Multi_field.h @@ -32,8 +32,7 @@ namespace Gudhi { namespace persistent_cohomology { -/** \class Multi_field Multi_field.h gudhi/Persistent_cohomology/Multi_field.h - * \brief Structure representing coefficients in a set of finite fields simultaneously +/** \brief Structure representing coefficients in a set of finite fields simultaneously * using the chinese remainder theorem. * * \implements CoefficientField diff --git a/src/common/doc/Gudhi_banner.jpg b/src/common/doc/Gudhi_banner.jpg deleted file mode 100644 index ebd3d8af..00000000 Binary files a/src/common/doc/Gudhi_banner.jpg and /dev/null differ diff --git a/src/common/doc/Gudhi_banner.png b/src/common/doc/Gudhi_banner.png new file mode 100644 index 00000000..18e8a672 Binary files /dev/null and b/src/common/doc/Gudhi_banner.png differ diff --git a/src/common/doc/main_page.h b/src/common/doc/main_page.h index 2f52fd7e..1e0dbcda 100644 --- a/src/common/doc/main_page.h +++ b/src/common/doc/main_page.h @@ -1,6 +1,6 @@ /*! \mainpage * \tableofcontents - * \image html "Gudhi_banner.jpg" "" width=20cm + * \image html "Gudhi_banner.png" "" width=20cm * * \section Introduction Introduction * The Gudhi library (Geometry Understanding in Higher Dimensions) is a generic open source C++ library for -- cgit v1.2.3