Add doc for draw function, for point set 3 and polygon 2.

This commit is contained in:
Guillaume Damiand 2019-06-19 13:11:04 +02:00
parent 8a3cb666fd
commit af32499a14
3 changed files with 42 additions and 0 deletions

View File

@ -0,0 +1,14 @@
namespace CGAL {
/*!
\ingroup PkgDrawPointSet3D
Open a new window and draw `aps`, an instance of the `CGAL::Point_set_3` class. The 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 PS an instance of the `CGAL::Point_set_3` class.
\param aps the point set to draw.
*/
template<class PS>
void draw(const PS& aps);
} /* namespace CGAL */

View File

@ -0,0 +1,14 @@
namespace CGAL {
/*!
\ingroup PkgDrawPolygon2
Open a new window and draw `ap`, an instance of the `CGAL::Polygon_2` class. The 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 */

View File

@ -0,0 +1,14 @@
namespace CGAL {
/*!
\ingroup PkgDrawPolygonWithHoles2
Open a new window and draw `aph`, an instance of the `CGAL::Polygon_with_holes_2` class. The 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 */