From b020e1aa4df67fddf2d11a626ad24f87d0570a33 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Tue, 6 Feb 2024 08:32:04 +0000 Subject: [PATCH] Point Set Processing: Remove documentation of deprecated functions --- Point_set_3/include/CGAL/Point_set_3/IO/LAS.h | 12 --------- Point_set_3/include/CGAL/Point_set_3/IO/OFF.h | 12 --------- Point_set_3/include/CGAL/Point_set_3/IO/PLY.h | 25 ------------------- Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h | 12 --------- .../PackageDescription.txt | 3 --- .../doc/Point_set_processing_3/dependencies | 1 + .../include/CGAL/IO/read_las_points.h | 9 ------- .../include/CGAL/IO/read_off_points.h | 6 ----- .../include/CGAL/IO/read_ply_points.h | 11 -------- .../include/CGAL/IO/write_las_points.h | 9 ------- .../include/CGAL/IO/write_ply_points.h | 10 -------- .../include/CGAL/IO/write_xyz_points.h | 5 ---- 12 files changed, 1 insertion(+), 114 deletions(-) diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h b/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h index 2a48f9a3a413..1190c31eed48 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/LAS.h @@ -168,12 +168,6 @@ bool read_LAS(const std::string& fname, CGAL::Point_set_3& point_ #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::read_LAS()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool read_las_point_set(std::istream& is, ///< input stream. CGAL::Point_set_3& point_set) ///< point set @@ -404,12 +398,6 @@ bool write_LAS(const std::string& fname, #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::write_LAS()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool write_las_point_set(std::ostream& os, ///< output stream. CGAL::Point_set_3& point_set) ///< point set diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h b/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h index 7fc677cff379..e364ca3b9a71 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/OFF.h @@ -94,12 +94,6 @@ bool read_OFF(const std::string& fname, CGAL::Point_set_3& point_ #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::read_OFF()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool read_off_point_set(std::istream& is, ///< input stream. CGAL::Point_set_3& point_set) ///< point set. @@ -190,12 +184,6 @@ bool write_OFF(const std::string& fname, const CGAL::Point_set_3& #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::write_OFF()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool write_off_point_set(std::ostream& os, ///< output stream. const CGAL::Point_set_3& point_set) ///< point set diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h b/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h index 67aa82e161c9..bbf47ca97319 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/PLY.h @@ -367,25 +367,6 @@ bool read_PLY(const std::string& fname, CGAL::Point_set_3& point_ #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::read_PLY()` \endlink should be used instead. - - \brief reads a point set with properties from an input stream in \ascii or binary PLY format. - - - the operator reads the vertex `point` property; - - if three PLY properties `nx`, `ny` and `nz` with type `float` - or `double` are found, the normal map is added; - - if any other PLY property is found, a "[name]" property map is - added, where `[name]` is the name of the PLY property. - - The `comments` parameter can be omitted. If provided, it will be - used to store the potential comments found in the PLY - header. Each line starting by "comment " in the header is - appended to the `comments` string (without the "comment " word). - */ template CGAL_DEPRECATED bool read_ply_point_set(std::istream& is, ///< input stream. CGAL::Point_set_3& point_set, ///< point set @@ -744,12 +725,6 @@ bool write_PLY(const std::string& fname, const CGAL::Point_set_3& #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::write_PLY()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool write_ply_point_set(std::ostream& os, const CGAL::Point_set_3& point_set, diff --git a/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h b/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h index bdf76f541ebe..965d11ff9604 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h @@ -93,12 +93,6 @@ bool read_XYZ(const std::string& fname, CGAL::Point_set_3& point_ #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::read_XYZ()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool read_xyz_point_set(std::istream& is, CGAL::Point_set_3& point_set) { @@ -187,12 +181,6 @@ bool write_XYZ(const std::string& fname, const CGAL::Point_set_3& #ifndef CGAL_NO_DEPRECATED_CODE -/*! - \ingroup PkgPointSet3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSet3IO `CGAL::IO::write_XYZ()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool write_xyz_point_set(std::ostream& os, const CGAL::Point_set_3& point_set) { diff --git a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt index f9e3c5b663e1..6e01bf6a819c 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt @@ -10,9 +10,6 @@ simplification, etc.). \defgroup PkgPointSetProcessing3IO I/O Functions \ingroup PkgPointSetProcessing3Ref -\defgroup PkgPointSetProcessing3IODeprecated I/O Functions (Deprecated) -\ingroup PkgPointSetProcessing3IO - \defgroup PkgPointSetProcessing3IOOff I/O (OFF Formats) \ingroup PkgPointSetProcessing3Ref diff --git a/Point_set_processing_3/doc/Point_set_processing_3/dependencies b/Point_set_processing_3/doc/Point_set_processing_3/dependencies index a550c93b6607..4ee2cbfeadc9 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/dependencies +++ b/Point_set_processing_3/doc/Point_set_processing_3/dependencies @@ -12,4 +12,5 @@ Jet_fitting_3 Solver_interface Shape_detection Advancing_front_surface_reconstruction +Point_set_3 BGL diff --git a/Point_set_processing_3/include/CGAL/IO/read_las_points.h b/Point_set_processing_3/include/CGAL/IO/read_las_points.h index 0d034a6bcb11..d0511afc8a6d 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_las_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_las_points.h @@ -574,11 +574,7 @@ bool read_las_points(std::istream& is, ///< input stream. /// \endcond -/** - \ingroup PkgPointSetProcessing3IODeprecated - \deprecated This function is deprecated since \cgal 5.3, `CGAL::IO::read_LAS_with_properties()` should be used instead. -*/ template @@ -602,11 +598,6 @@ CGAL_DEPRECATED bool read_las_points_with_properties(std::istream& is, /// \endcond -/** - \ingroup PkgPointSetProcessing3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, `CGAL::IO::read_LAS()` should be used instead. -*/ template diff --git a/Point_set_processing_3/include/CGAL/IO/read_off_points.h b/Point_set_processing_3/include/CGAL/IO/read_off_points.h index 660601cb9857..e193661dffdd 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_off_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_off_points.h @@ -410,12 +410,6 @@ bool read_off_points(std::istream& is, ///< input stream. /// \endcond -/*! - \ingroup PkgPointSetProcessing3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSetProcessing3IOOff `CGAL::IO::read_OFF()` \endlink should be used instead. -*/ template diff --git a/Point_set_processing_3/include/CGAL/IO/read_ply_points.h b/Point_set_processing_3/include/CGAL/IO/read_ply_points.h index 93cf9c91356e..d7ec7d9aa60d 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_ply_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_ply_points.h @@ -434,24 +434,13 @@ bool read_ply_points(std::istream& is, ///< input stream. /// \endcond -/** - \ingroup PkgPointSetProcessing3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSetProcessing3IOPly `CGAL::IO::read_PLY_with_properties()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool read_ply_points_with_properties(std::istream& is, OutputIterator output, PropertyHandler&& ... properties) { return IO::read_PLY_with_properties(is, output, std::forward(properties)...); } -/** - \ingroup PkgPointSetProcessing3IODeprecated - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSetProcessing3IOPly `CGAL::IO::read_PLY()` \endlink should be used instead. - */ template CGAL_DEPRECATED bool read_ply_points(std::istream& is, OutputIterator output, const CGAL_NP_CLASS& np = parameters::default_values()) { diff --git a/Point_set_processing_3/include/CGAL/IO/write_las_points.h b/Point_set_processing_3/include/CGAL/IO/write_las_points.h index c1ccb1596c60..7e27158520e4 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_las_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_las_points.h @@ -378,11 +378,6 @@ bool write_las_points(std::ostream& os, ///< output stream. /// \endcond -/** - \ingroup PkgPointSetProcessing3IODeprecated - - \deprecated This function is deprecated since \cgal 5.3, `CGAL::IO::write_LAS_with_properties()` should be used instead. -*/ template @@ -397,11 +392,7 @@ CGAL_DEPRECATED bool write_las_points_with_properties(std::ostream& os, return IO::write_LAS_with_properties(os, points, point_property, std::forward(properties)...); } -/** - \ingroup PkgPointSetProcessing3IODeprecated - \deprecated This function is deprecated since \cgal 5.3, `CGAL::IO::write_LAS()` should be used instead. -*/ template bool write_las_points(std::ostream& os, const PointRange& points, const CGAL_NP_CLASS& np = parameters::default_values()) { diff --git a/Point_set_processing_3/include/CGAL/IO/write_ply_points.h b/Point_set_processing_3/include/CGAL/IO/write_ply_points.h index 525bc159023e..0ddbb70d6137 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_ply_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_ply_points.h @@ -353,12 +353,7 @@ bool write_ply_points(std::ostream& os, ///< output stream. /// \endcond -/** -\ingroup PkgPointSetProcessing3IODeprecated -\deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSetProcessing3IOPly `CGAL::IO::write_PLY_with_properties()` \endlink should be used instead. -*/ template CGAL_DEPRECATED bool write_ply_points_with_properties(std::ostream& os, ///< output stream. @@ -368,12 +363,7 @@ CGAL_DEPRECATED bool write_ply_points_with_properties(std::ostream& os, ///< out return IO::write_PLY_with_properties(os, points, std::forward(properties)...); } -/** -\ingroup PkgPointSetProcessing3IODeprecated -\deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSetProcessing3IOPly `CGAL::IO::write_PLY()` \endlink should be used instead. -*/ template CGAL_DEPRECATED bool write_ply_points(std::ostream& os, const PointRange& points, const CGAL_NP_CLASS& np = parameters::default_values()) { diff --git a/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h b/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h index 43875b1a5d88..036e060367b9 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_xyz_points.h @@ -280,12 +280,7 @@ bool write_xyz_points(std::ostream& os, ///< output stream. /// \endcond -/** - \ingroup PkgPointSetProcessing3IODeprecated - \deprecated This function is deprecated since \cgal 5.3, - \link PkgPointSetProcessing3IOXyz `CGAL::write_XYZ()` \endlink should be used instead. -*/ template CGAL_DEPRECATED bool write_xyz_points(std::ostream& os, const PointRange& points, const CGAL_NP_CLASS& np = parameters::default_values()) {