From 73c78729c0282d4262e0d2b8731ecb29d83ea03d Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Tue, 2 Dec 2025 13:41:52 +0000 Subject: [PATCH] Add a doxygen group for IO classes --- HDVF/doc/HDVF/PackageDescription.txt | 3 +++ HDVF/include/CGAL/HDVF/Cub_object_io.h | 2 +- HDVF/include/CGAL/HDVF/Surface_mesh_io.h | 2 +- HDVF/include/CGAL/HDVF/Triangulation_3_io.h | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/HDVF/doc/HDVF/PackageDescription.txt b/HDVF/doc/HDVF/PackageDescription.txt index 4379c79e4e2..54060394da9 100644 --- a/HDVF/doc/HDVF/PackageDescription.txt +++ b/HDVF/doc/HDVF/PackageDescription.txt @@ -10,6 +10,9 @@ /// \defgroup PkgHDVFTraitsClasses Traits Classes /// \ingroup PkgHDVFRef +/// \defgroup PkgHDVFIOClasses IO Classes +/// \ingroup PkgHDVFRef + /*! \cgalPkgDescriptionBegin{HDVF,PkgHDVF} diff --git a/HDVF/include/CGAL/HDVF/Cub_object_io.h b/HDVF/include/CGAL/HDVF/Cub_object_io.h index 57740928e3b..79d0ab29973 100644 --- a/HDVF/include/CGAL/HDVF/Cub_object_io.h +++ b/HDVF/include/CGAL/HDVF/Cub_object_io.h @@ -32,7 +32,7 @@ typedef std::vector IOCubCellType ; typedef std::vector IOCubChainType ; /*! - \ingroup PkgHDVFRef + \ingroup PkgHDVFIOClasses The class `Cub_object_io` is an intermediate %IO class, used to load binary volumes and produce cubical complexes. */ diff --git a/HDVF/include/CGAL/HDVF/Surface_mesh_io.h b/HDVF/include/CGAL/HDVF/Surface_mesh_io.h index 1675f34e455..179b63b178e 100644 --- a/HDVF/include/CGAL/HDVF/Surface_mesh_io.h +++ b/HDVF/include/CGAL/HDVF/Surface_mesh_io.h @@ -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. \tparam TriangleMesh a model of `FaceGraph` and `HalfedgeGraph` concepts, e.g., a `CGAL::Surface_mesh`. diff --git a/HDVF/include/CGAL/HDVF/Triangulation_3_io.h b/HDVF/include/CGAL/HDVF/Triangulation_3_io.h index bea2fe1699a..f67fc6f90c6 100644 --- a/HDVF/include/CGAL/HDVF/Triangulation_3_io.h +++ b/HDVF/include/CGAL/HDVF/Triangulation_3_io.h @@ -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`. \tparam Triangulation3 a model of `CGAL::Triangulation_3`.