From b08e1e0d8c0ec2ad3404eec5e13f02beebb6e892 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 20 Jul 2020 09:57:47 +0200 Subject: [PATCH] Hide CGAL_DEPRECATED from the doc --- Point_set_3/doc/Point_set_3/Doxyfile.in | 3 ++- Point_set_3/include/CGAL/Point_set_3/IO/LAS.h | 1 + Point_set_3/include/CGAL/Point_set_3/IO/OFF.h | 1 + Point_set_3/include/CGAL/Point_set_3/IO/PLY.h | 1 + Point_set_3/include/CGAL/Point_set_3/IO/XYZ.h | 1 + .../doc/Point_set_processing_3/Doxyfile.in | 3 ++- Point_set_processing_3/include/CGAL/IO/read_las_points.h | 1 + Point_set_processing_3/include/CGAL/IO/read_off_points.h | 1 + Point_set_processing_3/include/CGAL/IO/read_ply_points.h | 1 + Point_set_processing_3/include/CGAL/IO/read_xyz_points.h | 1 + Point_set_processing_3/include/CGAL/IO/write_las_points.h | 1 + Point_set_processing_3/include/CGAL/IO/write_ply_points.h | 1 + Point_set_processing_3/include/CGAL/IO/write_xyz_points.h | 1 + .../doc/Polygon_mesh_processing/Doxyfile.in | 4 +++- .../include/CGAL/Polygon_mesh_processing/bbox.h | 6 +----- Surface_mesh/doc/Surface_mesh/Doxyfile.in | 3 ++- Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h | 4 ++++ Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h | 1 + Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h | 1 + 19 files changed, 27 insertions(+), 9 deletions(-) diff --git a/Point_set_3/doc/Point_set_3/Doxyfile.in b/Point_set_3/doc/Point_set_3/Doxyfile.in index c45d0af2b29..2980feeb5a8 100644 --- a/Point_set_3/doc/Point_set_3/Doxyfile.in +++ b/Point_set_3/doc/Point_set_3/Doxyfile.in @@ -4,4 +4,5 @@ PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 3D Point Set" MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = CGAL_BGL_NP_TEMPLATE_PARAMETERS \ - CGAL_BGL_NP_CLASS + CGAL_BGL_NP_CLASS \ + CGAL_DEPRECATED 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 71e5d7416d9..7da94d0acb7 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 @@ -29,6 +29,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif #if defined(CGAL_LINKED_WITH_LASLIB) || defined(DOXYGEN_RUNNING) 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 63ccc5edb1e..b7dbbcc9661 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 @@ -27,6 +27,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 31a77935a28..c2efbd2bfab 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 @@ -27,6 +27,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 421089bf280..d59d41ad1a9 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 @@ -26,6 +26,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { diff --git a/Point_set_processing_3/doc/Point_set_processing_3/Doxyfile.in b/Point_set_processing_3/doc/Point_set_processing_3/Doxyfile.in index 3750141c9c8..ea5bd5e9ac4 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/Doxyfile.in +++ b/Point_set_processing_3/doc/Point_set_processing_3/Doxyfile.in @@ -6,4 +6,5 @@ EXCLUDE_PATTERNS += property_map.h MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = CGAL_BGL_NP_TEMPLATE_PARAMETERS \ - CGAL_BGL_NP_CLASS + CGAL_BGL_NP_CLASS \ + CGAL_DEPRECATED 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 07ec00da4b1..a7742e75b2f 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 @@ -59,6 +59,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 30f60ae54ae..f782328e52c 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 @@ -35,6 +35,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 45d72436676..b097806400e 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 @@ -38,6 +38,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { diff --git a/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h b/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h index 00274243409..ff20e077ba4 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_xyz_points.h @@ -32,6 +32,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 3dd204994ff..bd2c43a5ffe 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 @@ -61,6 +61,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 e3c9c524213..ed772160ac8 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 @@ -35,6 +35,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { 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 c1f2bf9b3d5..8a798115624 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 @@ -33,6 +33,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { diff --git a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Doxyfile.in b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Doxyfile.in index 7f1aff5a1d1..6d2633d9143 100644 --- a/Polygon_mesh_processing/doc/Polygon_mesh_processing/Doxyfile.in +++ b/Polygon_mesh_processing/doc/Polygon_mesh_processing/Doxyfile.in @@ -16,7 +16,9 @@ EXAMPLE_PATH += ${CGAL_Poisson_surface_reconstruction_3_EXAMPLE_DIR} MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = CGAL_PMP_NP_TEMPLATE_PARAMETERS \ - CGAL_PMP_NP_CLASS + CGAL_PMP_NP_CLASS \ + CGAL_DEPRECATED + EXCLUDE = ${CGAL_PACKAGE_INCLUDE_DIR}/CGAL/Polygon_mesh_processing/internal EXCLUDE_SYMBOLS += experimental diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h index 5dc96c7cdd3..eea98c2d9fe 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/bbox.h @@ -27,11 +27,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_PMP_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_PMP_NP_CLASS NamedParameters -#endif - -#ifdef DOXYGEN_RUNNING -#define CGAL_PMP_NP_TEMPLATE_PARAMETERS NamedParameters -#define CGAL_PMP_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { diff --git a/Surface_mesh/doc/Surface_mesh/Doxyfile.in b/Surface_mesh/doc/Surface_mesh/Doxyfile.in index 2533b1718a6..6ed62a12340 100644 --- a/Surface_mesh/doc/Surface_mesh/Doxyfile.in +++ b/Surface_mesh/doc/Surface_mesh/Doxyfile.in @@ -4,5 +4,6 @@ PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - Surface Mesh" MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = CGAL_BGL_NP_TEMPLATE_PARAMETERS \ - CGAL_BGL_NP_CLASS + CGAL_BGL_NP_CLASS \ + CGAL_DEPRECATED diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h index 0c093db3469..8594c62ceb6 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/3MF.h @@ -24,6 +24,10 @@ #if defined(CGAL_LINKED_WITH_3MF) || defined(DOXYGEN_RUNNING) +#ifdef DOXYGEN_RUNNING +#define CGAL_DEPRECATED +#endif + namespace CGAL { // @todo generalize it to any model of `FaceGraph` and put it in BGL/IO (see read_OFF for the face color map) diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h index c87b3a96dd8..5f2bd1a1120 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/OFF.h @@ -28,6 +28,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL { diff --git a/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h b/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h index 542228f402c..c52a36f5188 100644 --- a/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h +++ b/Surface_mesh/include/CGAL/Surface_mesh/IO/PLY.h @@ -28,6 +28,7 @@ #ifdef DOXYGEN_RUNNING #define CGAL_BGL_NP_TEMPLATE_PARAMETERS NamedParameters #define CGAL_BGL_NP_CLASS NamedParameters +#define CGAL_DEPRECATED #endif namespace CGAL {