songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a doxygen group for IO classes

This commit is contained in:
Andreas Fabri 2025-12-02 13:41:52 +00:00
parent d8a7acc52e
commit 73c78729c0
4 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
HDVF/doc/HDVF/PackageDescription.txt
View File

@ -10,6 +10,9 @@
/// \defgroup PkgHDVFTraitsClasses Traits Classes /// \defgroup PkgHDVFTraitsClasses Traits Classes
/// \ingroup PkgHDVFRef /// \ingroup PkgHDVFRef
/// \defgroup PkgHDVFIOClasses IO Classes
/// \ingroup PkgHDVFRef
/*! /*!
\cgalPkgDescriptionBegin{HDVF,PkgHDVF} \cgalPkgDescriptionBegin{HDVF,PkgHDVF}

2
HDVF/include/CGAL/HDVF/Cub_object_io.h
View File

@ -32,7 +32,7 @@ typedef std::vector<size_t> IOCubCellType ;
typedef std::vector<IOCubCellType> IOCubChainType ; typedef std::vector<IOCubCellType> IOCubChainType ;
/*! /*!
\ingroup PkgHDVFRef \ingroup PkgHDVFIOClasses
The class `Cub_object_io` is an intermediate %IO class, used to load binary volumes and produce cubical complexes. The class `Cub_object_io` is an intermediate %IO class, used to load binary volumes and produce cubical complexes.
*/ */

2
HDVF/include/CGAL/HDVF/Surface_mesh_io.h
View File

@ -27,7 +27,7 @@ namespace Homological_discrete_vector_field {
/*! /*!
\ingroup PkgHDVFRef \ingroup PkgHDVFIOClasses
The class `Surface_mesh_io` is an intermediate %IO class, used to load a triangle mesh and produce simplicial complexes. The class `Surface_mesh_io` is an intermediate %IO class, used to load a triangle mesh and produce simplicial complexes.
\tparam TriangleMesh a model of `FaceGraph` and `HalfedgeGraph` concepts, e.g., a `CGAL::Surface_mesh`. \tparam TriangleMesh a model of `FaceGraph` and `HalfedgeGraph` concepts, e.g., a `CGAL::Surface_mesh`.

2
HDVF/include/CGAL/HDVF/Triangulation_3_io.h
View File

@ -27,7 +27,7 @@ namespace Homological_discrete_vector_field {
/*! /*!
\ingroup PkgHDVFRef \ingroup PkgHDVFIOClasses
The class `Triangulation_3_io` is an intermediate %IO class, used to load a `Triangulation_3` and produce simplicial complexes. The class loads the vertices and the cells (ie. tetrahedra) of the `Triangulation_3` into a `Mesh_object_io`. The class `Triangulation_3_io` is an intermediate %IO class, used to load a `Triangulation_3` and produce simplicial complexes. The class loads the vertices and the cells (ie. tetrahedra) of the `Triangulation_3` into a `Mesh_object_io`.
\tparam Triangulation3 a model of `CGAL::Triangulation_3`. \tparam Triangulation3 a model of `CGAL::Triangulation_3`.