diff options
author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2021-04-21 14:25:24 +0200 |
---|---|---|
committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2021-04-21 14:25:24 +0200 |
commit | af94bf9de8a4c08fe4d9a0c8719ae696b501169f (patch) | |
tree | 484ecc4b346c6e7ae088b4628f09056abe919a76 | |
parent | 130c3057bfef7c4c1e0ee0b1940c34bc2f9d6c33 (diff) |
doc review: build_mesh_from_cell_complex and output_meshes_to_medit was not documented
4 files changed, 13 insertions, 6 deletions
diff --git a/src/Coxeter_triangulation/include/gudhi/Cell_complex.h b/src/Coxeter_triangulation/include/gudhi/Cell_complex.h index 219f525b..60c83522 100644 --- a/src/Coxeter_triangulation/include/gudhi/Cell_complex.h +++ b/src/Coxeter_triangulation/include/gudhi/Cell_complex.h @@ -315,7 +315,7 @@ class Cell_complex { const Cell_point_map& cell_point_map() const { return cell_point_map_; } /** - * \brief Conxtructor for the class Cell_complex. + * \brief Constructor for the class Cell_complex. * * \param[in] intrinsic_dimension The dimension of the cell complex. */ diff --git a/src/Coxeter_triangulation/include/gudhi/IO/Mesh_medit.h b/src/Coxeter_triangulation/include/gudhi/IO/Mesh_medit.h index 203ed6c5..ca08f629 100644 --- a/src/Coxeter_triangulation/include/gudhi/IO/Mesh_medit.h +++ b/src/Coxeter_triangulation/include/gudhi/IO/Mesh_medit.h @@ -20,11 +20,11 @@ namespace Gudhi { namespace coxeter_triangulation { -/* \class Mesh_medit - * \brief Structure to store a mesh that can be output in Medit .mesh file format - * using the output_meshes_to_medit method. +/** \class Mesh_medit + * \brief Structure to store a mesh that can be output in Medit .mesh file format + * using the output_meshes_to_medit method. * - * \ingroup coxeter_triangulation + * \ingroup coxeter_triangulation */ struct Mesh_medit { /** \brief Type of a range of vertices. */ diff --git a/src/Coxeter_triangulation/include/gudhi/IO/build_mesh_from_cell_complex.h b/src/Coxeter_triangulation/include/gudhi/IO/build_mesh_from_cell_complex.h index c794cfa4..ecb59bfc 100644 --- a/src/Coxeter_triangulation/include/gudhi/IO/build_mesh_from_cell_complex.h +++ b/src/Coxeter_triangulation/include/gudhi/IO/build_mesh_from_cell_complex.h @@ -114,6 +114,10 @@ void populate_mesh(Mesh_medit& output, Simplex_cell_map& sc_map, Configuration c } } +/** @brief Builds a Gudhi::coxeter_triangulation::Mesh_medit from a Gudhi::coxeter_triangulation::Cell_complex + * + * @ingroup coxeter_triangulation + */ template <class Cell_complex> Mesh_medit build_mesh_from_cell_complex(const Cell_complex& cell_complex, Configuration i_configuration = Configuration(), diff --git a/src/Coxeter_triangulation/include/gudhi/IO/output_meshes_to_medit.h b/src/Coxeter_triangulation/include/gudhi/IO/output_meshes_to_medit.h index 4b454373..0a87a310 100644 --- a/src/Coxeter_triangulation/include/gudhi/IO/output_meshes_to_medit.h +++ b/src/Coxeter_triangulation/include/gudhi/IO/output_meshes_to_medit.h @@ -68,11 +68,14 @@ typename std::enable_if<I != sizeof...(Meshes), void>::type fill_meshes(Vertex_p tetrahedra_scalar_range, index + mesh.vertex_points.size(), meshes...); } -/** \brief Outputs a text file with specified meshes that can be visualized in Medit. +/** \brief Outputs a text file with specified meshes that can be visualized in + * <a target="_blank" href="https://www.ljll.math.upmc.fr/frey/software.html">Medit</a>. * * @param[in] amb_d Ambient dimension. Can be 2 or 3. * @param[in] file_name The name of the output file. * @param[in] meshes A pack of meshes to be specified separated by commas. + * + * @ingroup coxeter_triangulation */ template <typename... Meshes> void output_meshes_to_medit(std::size_t amb_d, std::string file_name, const Meshes&... meshes) { |