From 44306e981a8f2d2a0707852fb0ad12cbcb92be98 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 30 Oct 2025 18:11:15 +0100 Subject: [PATCH] doc --- .../File_formats/Supported_file_formats.txt | 8 ++++---- .../doc/Stream_support/PackageDescription.txt | 10 ++++++++++ Stream_support/include/CGAL/IO/LAS.h | 8 ++++---- Stream_support/include/CGAL/IO/LAS/Las_property.h | 1 - Stream_support/include/CGAL/IO/LAS/read_las_points.h | 1 - Stream_support/include/CGAL/IO/XYZ.h | 4 ++-- 6 files changed, 20 insertions(+), 12 deletions(-) diff --git a/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt b/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt index 6bdd298b6bc..03bb6c54905 100644 --- a/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt +++ b/Stream_support/doc/Stream_support/File_formats/Supported_file_formats.txt @@ -17,7 +17,7 @@ each specific format. - \ref IOStreamGocad - \ref IOStream3MF - \ref IOStreamWRL -- \ref IOStreamPkgStreamSupportIoFuncsLas +- \ref IOStreamLAS - \ref IOStreamAvizo - \ref IOStreamMedit - \ref IOStreamTetgen @@ -298,7 +298,7 @@ A precise specification of those formats is available Any point range - \link PkgStreamSupportIoFuncsLas CGAL::IO::read_LAS(const std::string&, PointRange&)\endlink + \link PkgStreamSupportIoFuncsLAS CGAL::IO::read_LAS(const std::string&, PointRange&)\endlink Output @@ -331,7 +331,7 @@ of its coordinates and other properties. Only coordinates and normals are curren Any point range - \link PkgStreamSupportIoFuncsIOXyz CGAL::IO::read_XYZ(const std::string&, PointRange&)\endlink + \link PkgStreamSupportIoFuncsIoXYZ CGAL::IO::read_XYZ(const std::string&, PointRange&)\endlink Output @@ -341,7 +341,7 @@ of its coordinates and other properties. Only coordinates and normals are curren Any point range - \link PkgStreamSupportIoFuncsIOXyz CGAL::IO::write_XYZ(const std::string&, const PointRange&)\endlink + \link PkgStreamSupportIoFuncsIOX CGAL::IO::write_XYZ(const std::string&, const PointRange&)\endlink diff --git a/Stream_support/doc/Stream_support/PackageDescription.txt b/Stream_support/doc/Stream_support/PackageDescription.txt index 2d97d36e3c1..de2dfbc7439 100644 --- a/Stream_support/doc/Stream_support/PackageDescription.txt +++ b/Stream_support/doc/Stream_support/PackageDescription.txt @@ -36,6 +36,14 @@ /// I/O Functions for the \ref IOStream3MF /// \ingroup IOstreamFunctions +/// \defgroup PkgStreamSupportIoFuncsLAS LAS I/O Functions +/// I/O Functions for the \ref IOStreamLAS +/// \ingroup IOstreamFunctions + +/// \defgroup PkgStreamSupportIoFuncsXYZ XYZ I/O Functions +/// I/O Functions for the \ref IOStreamXYZ +/// \ingroup IOstreamFunctions + /// \defgroup PkgStreamSupportEnumRef I/O Enums /// \ingroup PkgStreamSupportRef @@ -99,5 +107,7 @@ the printing mode. - \link PkgStreamSupportIoFuncsVTK I/O for VTK files \endlink - \link PkgStreamSupportIoFuncs3MF I/O for 3MF files \endlink - \link PkgStreamSupportIoFuncsWKT I/O for WKT files \endlink +- \link PkgStreamSupportIoFuncsLAS I/O for LAS files \endlink +- \link PkgStreamSupportIoFuncsXYZ I/O for XYZ files \endlink */ diff --git a/Stream_support/include/CGAL/IO/LAS.h b/Stream_support/include/CGAL/IO/LAS.h index 65fea06a7b1..2c27c196732 100644 --- a/Stream_support/include/CGAL/IO/LAS.h +++ b/Stream_support/include/CGAL/IO/LAS.h @@ -29,7 +29,7 @@ namespace CGAL { namespace IO { /** - \ingroup PkgStreamSupportIoFuncsLas + \ingroup PkgStreamSupportIoFuncsLAS generates a %LAS property handler to read 3D points. Points are constructed from the input the using 3 %LAS properties @@ -48,7 +48,7 @@ make_las_point_reader(PointMap point_map); /** - \ingroup PkgStreamSupportIoFuncsLas + \ingroup PkgStreamSupportIoFuncsLAS \brief reads user-selected points properties from a .las or .laz stream. Potential additional properties are ignored. @@ -118,7 +118,7 @@ bool read_LAS_with_properties(std::istream& is, /** - \ingroup PkgStreamSupportIoFuncsLas + \ingroup PkgStreamSupportIoFuncsLAS \brief reads points (position only) using the \ref IOStreamLAS. @@ -165,7 +165,7 @@ bool read_LAS(std::istream& is, /** - \ingroup PkgStreamSupportIoFuncsLas + \ingroup PkgStreamSupportIoFuncsLAS \brief reads points (position only) using the \ref IOStreamLAS. diff --git a/Stream_support/include/CGAL/IO/LAS/Las_property.h b/Stream_support/include/CGAL/IO/LAS/Las_property.h index 0c0555ce066..58f4eacca78 100644 --- a/Stream_support/include/CGAL/IO/LAS/Las_property.h +++ b/Stream_support/include/CGAL/IO/LAS/Las_property.h @@ -73,7 +73,6 @@ typedef Base G; typedef Base B; typedef Base I; } // namespace LAS_property -/// \endcond // documenation in ../LAS.h template diff --git a/Stream_support/include/CGAL/IO/LAS/read_las_points.h b/Stream_support/include/CGAL/IO/LAS/read_las_points.h index 84f0fbea0e5..19dd476bf3d 100644 --- a/Stream_support/include/CGAL/IO/LAS/read_las_points.h +++ b/Stream_support/include/CGAL/IO/LAS/read_las_points.h @@ -225,7 +225,6 @@ void process_properties (const LASpoint& reader, OutputValueType& new_element, } // namespace LAS } // namespace internal -/// \endcond // documenation in ../LAS.h template