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

Fix doc

This commit is contained in:
Maxime Gimeno 2018-03-26 10:39:41 +02:00
parent a45ac9e470
commit 4c309c4564
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
BGL/include/CGAL/boost/graph/helpers.h
View File

@ -358,12 +358,12 @@ bool is_valid_face_descriptor( typename boost::graph_traits<FaceGraph>::face_des
/*! /*!
\ingroup PkgBGLHelperFct \ingroup PkgBGLHelperFct
* \brief is_valid_face_graph checks the integrity of a `HalfedgeGraph`. * \brief checks the integrity of `g`.
* \param g the `HalfedgeGraph` to test. * \param g the HalfedgeGraph to test.
* \param verb : if `true`, the details of the check will be written in the standard output. * \param verb : if `true`, the details of the check will be written in the standard output.
* *
* \tparam HalfedgeGraph a model of `HalfedgeGraph` * \tparam HalfedgeGraph a model of `HalfedgeListGraph`
* \return `true` if the `FaceGraph` is valid, `false` otherwise. * \return `true` if `g` is valid, `false` otherwise.
* *
*/ */
template<typename HalfedgeGraph> template<typename HalfedgeGraph>
@ -498,12 +498,14 @@ return valid;
/*! /*!
\ingroup PkgBGLHelperFct \ingroup PkgBGLHelperFct
* \brief is_valid_face_graph checks the integrity of a `FaceGraph`. * \brief checks the integrity of `g`.
* \param g the `FaceGraph` to test. *
* calls `is_valid_halfedge_graph()`
* \param g the FaceGraph to test.
* \param verb : if `true`, the details of the check will be written in the standard output. * \param verb : if `true`, the details of the check will be written in the standard output.
* *
* \tparam FaceGraph a model of `FaceGraph` * \tparam FaceGraph a model of `FaceListGraph`
* \return `true` if the `FaceGraph` is valid, `false` otherwise. * \return `true` if `g` is valid, `false` otherwise.
* *
*/ */
template<typename FaceGraph> template<typename FaceGraph>
@ -584,12 +586,15 @@ bool is_valid_face_graph(const FaceGraph& g, bool verb = false)
} }
/*! /*!
\ingroup PkgBGLHelperFct \ingroup PkgBGLHelperFct
* \brief is_valid_polygon_mesh checks the integrity of a `PolygonMesh`. * \brief checks the integrity of `g`.
*
* calls `is_valid_face_graph()`
* \param g the `PolygonMesh` to test. * \param g the `PolygonMesh` to test.
* \param verb : if `true`, the details of the check will be written in the standard output. * \param verb : if `true`, the details of the check will be written in the standard output.
* *
* \tparam PolygonMesh a model of \ref PMPDef "PolygonMesh" * \tparam PolygonMesh a model of `FaceListGraph` and `HalfedgeListGraph`, and follows
* \return `true` if the `PolygonMesh` is valid, `false` otherwise. * the definition of a \ref PMPDef "PolygonMesh"
* \return `true` if `g` is valid, `false` otherwise.
* *
*/ */
template <typename PolygonMesh> template <typename PolygonMesh>