songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

lazy doc fix

This commit is contained in:
Sébastien Loriot 2019-06-28 10:03:10 +02:00
parent 4b1d2c6b05
commit 14a59deda6
5 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Polygon/doc/Polygon/CGAL/draw_polygon_2.h
View File

@ -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<class P>
void draw(const P& ap);
} /* namespace CGAL */

14
Polygon/doc/Polygon/CGAL/draw_polygon_with_holes_2.h
View File

@ -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<class PH>
void draw(const PH& aph);
} /* namespace CGAL */

1
Polygon/doc/Polygon/Doxyfile.in
View File

@ -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

18
Polygon/include/CGAL/draw_polygon_2.h
View File

@ -28,6 +28,24 @@
#include <CGAL/Qt/Basic_viewer_qt.h>
#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<class P>
void draw(const P& ap);
} /* namespace CGAL */
#endif
#ifdef CGAL_USE_BASIC_VIEWER
#include <CGAL/Polygon_2.h>

17
Polygon/include/CGAL/draw_polygon_with_holes_2.h
View File

@ -28,6 +28,23 @@
#include <CGAL/Qt/Basic_viewer_qt.h>
#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<class PH>
void draw(const PH& aph);
} /* namespace CGAL */
#endif
#ifdef CGAL_USE_BASIC_VIEWER
#include <CGAL/Polygon_with_holes_2.h>