From 14a59deda6e559017b3b08668a8b16225ad8d6c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Fri, 28 Jun 2019 10:03:10 +0200 Subject: [PATCH] lazy doc fix --- Polygon/doc/Polygon/CGAL/draw_polygon_2.h | 14 -------------- .../Polygon/CGAL/draw_polygon_with_holes_2.h | 14 -------------- Polygon/doc/Polygon/Doxyfile.in | 1 - Polygon/include/CGAL/draw_polygon_2.h | 18 ++++++++++++++++++ .../include/CGAL/draw_polygon_with_holes_2.h | 17 +++++++++++++++++ 5 files changed, 35 insertions(+), 29 deletions(-) delete mode 100644 Polygon/doc/Polygon/CGAL/draw_polygon_2.h delete mode 100644 Polygon/doc/Polygon/CGAL/draw_polygon_with_holes_2.h diff --git a/Polygon/doc/Polygon/CGAL/draw_polygon_2.h b/Polygon/doc/Polygon/CGAL/draw_polygon_2.h deleted file mode 100644 index 16c902af6a7..00000000000 --- a/Polygon/doc/Polygon/CGAL/draw_polygon_2.h +++ /dev/null @@ -1,14 +0,0 @@ -namespace CGAL { - -/*! -\ingroup PkgDrawPolygon2 - -opens a new window and draws `ap`, an instance of the `CGAL::Polygon_2` class. A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires CGAL_Qt5, and is only available if the flag CGAL_USE_BASIC_VIEWER is defined at compile time. -\tparam P an instance of the `CGAL::Polygon_2` class. -\param ap the polygon to draw. - -*/ -template -void draw(const P& ap); - -} /* namespace CGAL */ diff --git a/Polygon/doc/Polygon/CGAL/draw_polygon_with_holes_2.h b/Polygon/doc/Polygon/CGAL/draw_polygon_with_holes_2.h deleted file mode 100644 index 2433bee3315..00000000000 --- a/Polygon/doc/Polygon/CGAL/draw_polygon_with_holes_2.h +++ /dev/null @@ -1,14 +0,0 @@ -namespace CGAL { - -/*! -\ingroup PkgDrawPolygonWithHoles2 - -opens a new window and draws `aph`, an instance of the `CGAL::Polygon_with_holes_2` class. A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires CGAL_Qt5, and is only available if the flag CGAL_USE_BASIC_VIEWER is defined at compile time. -\tparam PH an instance of the `CGAL::Polygon_with_holes_2` class. -\param aph the polygon with holes to draw. - -*/ -template -void draw(const PH& aph); - -} /* namespace CGAL */ diff --git a/Polygon/doc/Polygon/Doxyfile.in b/Polygon/doc/Polygon/Doxyfile.in index d45135738c6..8cfb32b528f 100644 --- a/Polygon/doc/Polygon/Doxyfile.in +++ b/Polygon/doc/Polygon/Doxyfile.in @@ -3,7 +3,6 @@ PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 2D Polygons" EXAMPLE_PATH = ${CGAL_PACKAGE_DIR}/examples \ ${CGAL_Stream_support_EXAMPLE_DIR} -INPUT += ${CGAL_PACKAGE_INCLUDE_DIR} EXTRACT_ALL = false HIDE_UNDOC_MEMBERS = true diff --git a/Polygon/include/CGAL/draw_polygon_2.h b/Polygon/include/CGAL/draw_polygon_2.h index 349a213c380..8b7bdd296a6 100644 --- a/Polygon/include/CGAL/draw_polygon_2.h +++ b/Polygon/include/CGAL/draw_polygon_2.h @@ -28,6 +28,24 @@ #include +#ifdef DOXYGEN_RUNNING +namespace CGAL { + +/*! +\ingroup PkgDrawPolygon2 + +opens a new window and draws `ap`, an instance of the `CGAL::Polygon_2` class. A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires CGAL_Qt5, and is only available if the flag CGAL_USE_BASIC_VIEWER is defined at compile time. +\tparam P an instance of the `CGAL::Polygon_2` class. +\param ap the polygon to draw. + +*/ +template +void draw(const P& ap); + +} /* namespace CGAL */ + +#endif + #ifdef CGAL_USE_BASIC_VIEWER #include diff --git a/Polygon/include/CGAL/draw_polygon_with_holes_2.h b/Polygon/include/CGAL/draw_polygon_with_holes_2.h index 4b4c1bfd93f..33806eb1b38 100644 --- a/Polygon/include/CGAL/draw_polygon_with_holes_2.h +++ b/Polygon/include/CGAL/draw_polygon_with_holes_2.h @@ -28,6 +28,23 @@ #include +#ifdef DOXYGEN_RUNNING +namespace CGAL { + +/*! +\ingroup PkgDrawPolygonWithHoles2 + +opens a new window and draws `aph`, an instance of the `CGAL::Polygon_with_holes_2` class. A call to this function is blocking, that is the program continues as soon as the user closes the window. This function requires CGAL_Qt5, and is only available if the flag CGAL_USE_BASIC_VIEWER is defined at compile time. +\tparam PH an instance of the `CGAL::Polygon_with_holes_2` class. +\param aph the polygon with holes to draw. + +*/ +template +void draw(const PH& aph); + +} /* namespace CGAL */ +#endif + #ifdef CGAL_USE_BASIC_VIEWER #include