fix doc for orientation

This commit is contained in:
Jane Tournois 2015-03-13 14:19:19 +01:00
parent 08d9e53cf2
commit 906f4a33ff
2 changed files with 7 additions and 1 deletions

View File

@ -384,7 +384,8 @@ public:
* (during the re-orientation process), or a point shared by at least two polygons that do not
* share an edge this point is incident to.
* @tparam Point the point type
* @tparam Polygon the polygon type, being a container of indices
* @tparam Polygon a `std::vector<std::size_t>` corresponding to the indices
* of points in `points`
*
* @param[in,out] points points of the soup of polygons. Some points might be pushed back to resolve
* non-manifold or non-orientability issues.

View File

@ -90,10 +90,15 @@ public:
* \ingroup PkgPolygonMeshProcessing
* builds a polygon mesh from a soup of polygons.
* @pre the input polygon soup is consistently oriented.
*
* @tparam PolygonMesh a model of `MutableFaceGraph`
* @tparam Point a point type that has an operator `[]` to access coordinates
* @tparam Polygon a `std::vector<std::size_t>` corresponding to the indices
* of points in `points`
*
* @param points points of the soup of polygons
* @param polygons each element in the vector describes a polygon using the index of the points in `points`.
* @param out the polygon mesh to be built
*/
template<class PolygonMesh, class Point, class Polygon>
void polygon_soup_to_polygon_mesh(