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

unify np sentence

This commit is contained in:
Sébastien Loriot 2020-04-18 16:27:58 +02:00
parent 716d8011e1
commit c253679b2d
61 changed files with 132 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
BGL/include/CGAL/boost/graph/Face_filtered_graph.h
View File

@ -116,7 +116,7 @@ struct Face_filtered_graph
* \param graph the underlying graph
* \param face_patch_index_map the property_map that assigns a patch index to each face
* \param selected_face_patch_indices a range of the face patch indices to select
* \param np an optional sequence of named parameters among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}
@ -198,7 +198,7 @@ struct Face_filtered_graph
* \param graph the underlying graph.
* \param face_patch_index_map the property_map that assigns a patch index to each face
* \param selected_face_patch_index the index of the face patch selected
* \param np an optional sequence of named parameters among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}
@ -268,7 +268,7 @@ struct Face_filtered_graph
*
* \param graph the graph containing the wanted patch
* \param selected_faces the set of selected faces
* \param np an optional sequence of named parameters among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}

2
BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h
View File

@ -135,7 +135,7 @@ void partition_dual_graph(const TriangleMesh& tm, int nparts,
///
/// \param tm a triangle mesh
/// \param nparts the number of parts in the final partition
/// \param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \tparam TriangleMesh is a model of the `FaceListGraph` concept
/// \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"

2
BGL/include/CGAL/boost/graph/METIS/partition_graph.h
View File

@ -167,7 +167,7 @@ void partition_graph(const TriangleMesh& tm, int nparts,
///
/// \param tm a triangle mesh
/// \param nparts the number of parts in the final partition
/// \param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \tparam TriangleMesh is a model of the `FaceListGraph` concept.
/// \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"

2
BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h
View File

@ -505,7 +505,7 @@ class Alpha_expansion_MaxFlow_impl;
vd)[label_idx]` returns the cost of vertex `vd` to belong to the
label `label_idx`.
\param np optional sequence of named parameters among the ones listed below
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{vertex_index_map}

9
BGL/include/CGAL/boost/graph/io.h
View File

@ -33,6 +33,8 @@ namespace CGAL {
writes the graph `g` in the wrl format (VRML 2.0).
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{vertex_point_map}
\cgalParamDescription{a property map associating points to the vertices of `g`}
@ -125,6 +127,8 @@ bool write_wrl(std::ostream& os,
writes the graph `g` in the OFF format.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{vertex_point_map}
\cgalParamDescription{a property map associating points to the vertices of `g`}
@ -252,6 +256,8 @@ inline std::string next_non_comment(std::istream& is)
reads the graph `g` from data in the OFF format. Ignores comment lines which start with a hash, and lines with whitespace.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{vertex_point_map}
\cgalParamDescription{a property map associating points to the vertices of `g`}
@ -637,8 +643,7 @@ write_polys_points(std::ostream& os,
*
* \param os the stream used for writing.
* \param mesh the triangle mesh to be written.
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the
* ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{use_binary_mode}

3
BGL/include/CGAL/boost/graph/selection.h
View File

@ -464,8 +464,7 @@ reduce_face_selection(
unselects everything so that the length of the border of the
selection is 0)
\param np optional sequence of named parameters among the ones listed below
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{vertex_point_map}

2
Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h
View File

@ -49,7 +49,7 @@ void convex_hull_3(InputIterator first, InputIterator last, PolygonMesh& pm, con
*
* \param g the graph
* \param pm the `PolygonMesh` that will contain the convex hull
* \param np an optional sequence of named parameters among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

4
Optimal_bounding_box/include/CGAL/Optimal_bounding_box/oriented_bounding_box.h
View File

@ -276,7 +276,7 @@ void construct_oriented_bounding_box(const PointRange& points,
///
/// \param points the input range
/// \param out the resulting array of points or affine transformation
/// \param np an optional sequence of \ref obb_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamBegin{point_map}
@ -367,7 +367,7 @@ void oriented_bounding_box(const PointRange& points,
///
/// \param pmesh the input mesh
/// \param out the resulting array of points or affine transformation
/// \param np an optional sequence of \ref obb_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamBegin{vertex_point_map}

2
Point_set_processing_3/include/CGAL/IO/read_las_points.h
View File

@ -428,7 +428,7 @@ bool read_las_points_with_properties (std::istream& stream,
\param stream input stream.
\param output output iterator over points.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/read_off_points.h
View File

@ -45,7 +45,7 @@ namespace CGAL {
\param stream input stream.
\param output output iterator over points.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/read_ply_points.h
View File

@ -201,7 +201,7 @@ bool read_ply_points_with_properties (std::istream& stream,
\param stream input stream.
\param output output iterator over points.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/read_xyz_points.h
View File

@ -44,7 +44,7 @@ namespace CGAL {
\param stream input stream.
\param output output iterator over points.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/write_las_points.h
View File

@ -254,7 +254,7 @@ bool write_las_points_with_properties (std::ostream& stream, ///< output stream
\param stream output stream.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/write_off_points.h
View File

@ -40,7 +40,7 @@ namespace CGAL {
\param stream output stream.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/write_ply_points.h
View File

@ -159,7 +159,7 @@ write_ply_points_with_properties(
\param stream output stream.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/IO/write_xyz_points.h
View File

@ -40,7 +40,7 @@ namespace CGAL {
\param stream output stream.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

4
Point_set_processing_3/include/CGAL/OpenGR/compute_registration_transformation.h
View File

@ -169,7 +169,7 @@ compute_registration_transformation(const PointRange1& range1, const PointRan
\param point_set_1 input point range used as reference.
\param point_set_2 input point range whose registration w.r.t. `point_set_1` will be computed.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -264,7 +264,7 @@ compute_registration_transformation(const PointRange1& range1, const PointRan
\cgalParamNEnd
\cgalNamedParamsEnd
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

4
Point_set_processing_3/include/CGAL/OpenGR/register_point_sets.h
View File

@ -90,7 +90,7 @@ register_point_sets(const PointRange1& range1, PointRange2& range2,
\param point_set_1 input point range used as reference.
\param point_set_2 input point range whose registration w.r.t. `point_set_1` will be computed.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -185,7 +185,7 @@ register_point_sets(const PointRange1& range1, PointRange2& range2,
\cgalParamNEnd
\cgalNamedParamsEnd
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/bilateral_smooth_point_set.h
View File

@ -194,7 +194,7 @@ compute_max_spacing(
\param points input point range.
\param k size of the neighborhood for the implicit surface patch fitting.
The larger the value is, the smoother the result will be.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/compute_average_spacing.h
View File

@ -112,7 +112,7 @@ compute_average_spacing(const typename NeighborQuery::Kernel::Point_3& query, //
\param points input point range.
\param k number of neighbors.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/edge_aware_upsample_point_set.h
View File

@ -291,7 +291,7 @@ update_new_point(
\param points input point range.
\param output iterator where output points and normals are put.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

8
Point_set_processing_3/include/CGAL/estimate_scale.h
View File

@ -452,7 +452,7 @@ public:
\param points input point range.
\param queries range of locations where scale must be estimated
\param output iterator to store the computed scales
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -547,7 +547,7 @@ estimate_local_k_neighbor_scales(
its iterator is the key type of the named parameter `point_map`.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -620,7 +620,7 @@ estimate_global_k_neighbor_scale(const PointRange& points)
\param points input point range.
\param queries range of locations where scale must be estimated
\param output iterator to store the computed scales
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -715,7 +715,7 @@ estimate_local_range_scales(
its iterator is the key type of the named parameter `point_map`.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/grid_simplify_point_set.h
View File

@ -175,7 +175,7 @@ public:
\param points input point range.
\param epsilon tolerance value when merging 3D points.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/hierarchy_simplify_point_set.h
View File

@ -123,7 +123,7 @@ namespace CGAL {
its iterator is the key type of the named parameter `point_map`.
\param points input point range.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/jet_estimate_normals.h
View File

@ -106,7 +106,7 @@ jet_estimate_normal(const typename NeighborQuery::Point_3& query, ///< point to
\param points input point range.
\param k number of neighbors
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/jet_smooth_point_set.h
View File

@ -113,7 +113,7 @@ jet_smooth_point(
\param points input point range.
\param k number of neighbors
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/mst_orient_normals.h
View File

@ -547,7 +547,7 @@ create_mst_graph(
\param points input point range.
\param k number of neighbors.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/pca_estimate_normals.h
View File

@ -98,7 +98,7 @@ pca_estimate_normal(const typename NeighborQuery::Kernel::Point_3& query, ///< p
\param points input point range.
\param k number of neighbors
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

4
Point_set_processing_3/include/CGAL/pointmatcher/compute_registration_transformation.h
View File

@ -369,7 +369,7 @@ compute_registration_transformation(const PointRange1& range1, const PointRange2
\param point_set_1 input point range used as reference.
\param point_set_2 input point range whose registration w.r.t. `point_set_1` will be computed.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -494,7 +494,7 @@ compute_registration_transformation(const PointRange1& range1, const PointRange2
\cgalParamNEnd
\cgalNamedParamsEnd
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

4
Point_set_processing_3/include/CGAL/pointmatcher/register_point_sets.h
View File

@ -49,7 +49,7 @@ namespace pointmatcher {
\param point_set_1 input point range used as reference.
\param point_set_2 input point range whose registration w.r.t. `point_set_1` will be computed.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -174,7 +174,7 @@ namespace pointmatcher {
\cgalParamNEnd
\cgalNamedParamsEnd
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/remove_outliers.h
View File

@ -97,7 +97,7 @@ compute_avg_knn_sq_distance_3(
\param points input point range.
\param k number of neighbors
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

5
Point_set_processing_3/include/CGAL/structure_point_set.h
View File

@ -164,7 +164,7 @@ public:
\param points input point range.
\param planes input plane range.
\param epsilon size parameter.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -1511,7 +1511,7 @@ private:
\param planes input plane range.
\param output output iterator where output points are written
\param epsilon size parameter.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -1603,4 +1603,3 @@ structure_point_set (const PointRange& points, ///< range of points.
#include <CGAL/enable_warnings.h>
#endif // CGAL_STRUCTURE_POINT_SET_3_H

6
Point_set_processing_3/include/CGAL/vcm_estimate_normals.h
View File

@ -235,7 +235,7 @@ vcm_convolve (ForwardIterator first,
\param ccov output range of covariance matrices.
\param offset_radius offset_radius.
\param convolution_radius convolution_radius.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -407,7 +407,7 @@ vcm_estimate_normals_internal (PointRange& points,
\param points input point range.
\param offset_radius offset_radius.
\param convolution_radius convolution_radius.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}
@ -482,7 +482,7 @@ vcm_estimate_normals (PointRange& points,
\param points input point range.
\param offset_radius offset_radius.
\param k number of neighbor points used for convolution.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

2
Point_set_processing_3/include/CGAL/wlop_simplify_and_regularize_point_set.h
View File

@ -355,7 +355,7 @@ compute_density_weight_for_sample_point(
\param points input point range.
\param output iterator where output points are put.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
\param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
\cgalNamedParamsBegin
\cgalParamNBegin{point_map}

10
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/clip.h
View File

@ -421,8 +421,8 @@ void split_along_edges(TriangleMesh& tm,
*
* @param tm input triangulated surface mesh
* @param clipper triangulated surface mesh used to clip `tm`
* @param np_tm optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_c optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_tm an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_c an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
*
* \cgalNamedParamsBegin
@ -613,7 +613,7 @@ bool clip(TriangleMesh& tm,
*
* @param tm input triangulated surface mesh
* @param iso_cuboid iso-cuboid used to clip `tm`.
* @param np optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{visitor}
@ -684,8 +684,8 @@ bool clip(TriangleMesh& tm,
*
* @param tm input triangulated surface mesh
* @param splitter triangulated surface mesh used to split `tm`
* @param np_tm optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_s optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_tm an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_s an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

20
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h
View File

@ -106,7 +106,7 @@ namespace internal {
that contains it
* \param pmesh the polygon mesh
* \param out the output iterator that collects faces from the same connected component as `seed_face`
* \param np an optional \ref bgl_namedparameters "Named Parameters" described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
@ -187,7 +187,7 @@ connected_component(typename boost::graph_traits<PolygonMesh>::face_descriptor s
* \param pmesh the polygon mesh
* \param fcm the property map with indices of components associated to faces in `pmesh`
* \param np an optional \ref bgl_namedparameters "Named Parameters" described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
@ -298,7 +298,7 @@ namespace internal {
// * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
// *
// * \param pmesh the polygon mesh
// * \param np an optional \ref bgl_namedparameters "Named Parameters" described below
// * \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
// *
// * \cgalNamedParamsBegin
// * \cgalParamNBegin{edge_is_constrained_map}
@ -356,7 +356,7 @@ std::size_t number_of_connected_components(const PolygonMesh& pmesh)
* \param pmesh the polygon mesh
* \param nb_components_to_keep the number of components to be kept. If this number is larger than
* the number of components in the mesh, all components are kept.
* \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
@ -508,7 +508,7 @@ std::size_t keep_largest_connected_components(PolygonMesh& pmesh,
*
* \param pmesh the polygon mesh
* \param threshold_value any connected component with a size (strictly) smaller than this value will be discarded
* \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
@ -794,7 +794,7 @@ void keep_or_remove_connected_components(PolygonMesh& pmesh
* \param pmesh the polygon mesh
* \param fcm the property map with indices of components associated to faces in `pmesh`.
* After calling this function, the values of `fcm` are undefined.
* \param np an optional \ref bgl_namedparameters "Named Parameters" described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}
@ -838,7 +838,7 @@ void keep_connected_components(PolygonMesh& pmesh
* \param pmesh the polygon mesh
* \param fcm the property map with indices of components associated to faces in `pmesh`.
* After calling this function, the values of `fcm` are undefined.
* \param np an optional \ref bgl_namedparameters "Named Parameters" described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_index_map}
@ -878,7 +878,7 @@ void remove_connected_components(PolygonMesh& pmesh
*
* \param components_to_remove a face range, including one face or more on each component to be removed
* \param pmesh the polygon mesh
* \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
@ -948,7 +948,7 @@ void remove_connected_components(PolygonMesh& pmesh
*
* \param pmesh the polygon mesh
* \param components_to_keep a face range, including one face or more on each component to be kept
* \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}
@ -1118,7 +1118,7 @@ void split_connected_components_impl(FIMap fim,
*
* \param pmesh the polygon mesh
* \param cc_meshes container that is filled with the extracted connected components.
* \param np an optional sequence of Named Parameters among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{edge_is_constrained_map}

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/corefinement.h
View File

@ -146,7 +146,7 @@ enum Boolean_operation_type {UNION = 0, INTERSECTION=1,
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* @param nps_out a tuple of optional sequences of \ref bgl_namedparameters "Named Parameters" each among the ones listed below
* @param nps_out an optional tuple of sequences of \ref bgl_namedparameters "Named Parameters" each among the ones listed below
* (`tm_out` being used to refer to the output surface mesh in `output` corresponding to a given named parameter sequence)
*
* \cgalNamedParamsBegin
@ -530,7 +530,7 @@ corefine_and_compute_boolean_operations(
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* @param np_out optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_out an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/detect_features.h
View File

@ -246,7 +246,7 @@ template<typename GT,
* \param pmesh the polygon mesh
* \param angle_in_deg the dihedral angle bound
* \param edge_is_feature_map the property map that will contain the sharp-or-not status of each edge of `pmesh`
* \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_feature_degree_map}
@ -393,7 +393,7 @@ namespace internal
* \param angle_in_deg the dihedral angle bound
* \param edge_is_feature_map the property map that will contain the sharp-or-not status of each edge of `pmesh`
* \param patch_id_map the property map that will contain the surface patch ids for the faces of `pmesh`.
* \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_feature_degree_map}

5
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/distance.h
View File

@ -1075,10 +1075,9 @@ double approximate_Hausdorff_distance(
*
* @param tm1 the triangle mesh that will be sampled
* @param tm2 the triangle mesh to compute the distance to
* @param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" for `tm1`,
* forwarded to `sample_triangle_mesh()`.
* @param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" forwarded to `sample_triangle_mesh()`
*
* @param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" for `tm2` among the ones listed below
* @param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

6
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/extrude.h
View File

@ -270,12 +270,12 @@ void extrude_mesh(const InputMesh& input,
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
* \cgalParamDescription{a property map associating points to the vertices of `ouput`}
* \cgalParamDescription{a property map associating points to the vertices of `output`}
* \cgalParamType{a class model of `ReadWritePropertyMap` with `boost::graph_traits<OutputMesh>::%vertex_descriptor`
* as key type and `%Point_3` as value type}
* \cgalParamDefault{`boost::get(CGAL::vertex_point, ouput)`}
* \cgalParamDefault{`boost::get(CGAL::vertex_point, output)`}
* \cgalParamExtra{If this parameter is omitted, an internal property map for `CGAL::vertex_point_t`
* should be available for the vertices of `ouput`.}
* should be available for the vertices of `output`.}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*/

6
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/internal/Snapping/snap.h
View File

@ -936,8 +936,7 @@ std::size_t snap_non_conformal_one_way(const HalfedgeRange& halfedge_range_S,
// \param halfedge_range_B a range of vertices of the second mesh defining a set of vertices (as targets of the halfeges)
// \param tolerance_map_B a tolerance map associating to each vertex of the second range a tolerance value
// \param tm_B the target mesh to which the vertices in `halfedge_range_B` belong
// \param np_A optional \ref bgl_namedparameters "Named Parameters" related to the source mesh,
// amongst those described below:
// \param np_A an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamBegin{vertex_point_map}
@ -950,8 +949,7 @@ std::size_t snap_non_conformal_one_way(const HalfedgeRange& halfedge_range_S,
// \cgalParamEnd
// \cgalNamedParamsEnd
//
// \param np_B optional \ref bgl_namedparameters "Named Parameters" related to the target mesh,
// amongst those described below:
// \param np_B an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamBegin{vertex_point_map}

6
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/internal/Snapping/snap_vertices.h
View File

@ -792,8 +792,7 @@ namespace experimental {
// \param halfedge_range_B a range of vertices of the second mesh defining a set of vertices (as targets of the halfeges)
// \param tolerance_map_B a tolerance map associating to each vertex of the second range a tolerance value
// \param tm_B the target mesh to which the vertices in `halfedge_range_B` belong
// \param np_A optional \ref bgl_namedparameters "Named Parameters" related to the source mesh,
// amongst those described below:
// \param np_A an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamBegin{vertex_point_map}
@ -806,8 +805,7 @@ namespace experimental {
// \cgalParamEnd
// \cgalNamedParamsEnd
//
// \param np_B optional \ref bgl_namedparameters "Named Parameters" related to the target mesh,
// amongst those described below:
// \param np_B an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamBegin{vertex_point_map}

26
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/intersection.h
View File

@ -353,8 +353,8 @@ struct Throw_at_first_output {
* \param tm2 the second triangulated surface mesh.
* \param out output iterator to be filled with all pairs of faces that intersect.
* First and second element in the pairs correspond to faces of `tm1` and `tm2` respectively
* \param np1 an optional sequence of \ref bgl_namedparameters for `tm1`, among the ones listed below
* \param np2 an optional sequence of \ref bgl_namedparameters for `tm2`, among the ones listed below
* \param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* \param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -491,7 +491,7 @@ compute_face_face_intersection(const FaceRange& face_range1,
* \param polyline the polyline to check for intersections.
* \param tm the triangulated surface mesh to check for intersections.
* \param out output iterator to be filled with all pairs of face-segment that intersect
* \param np an optional sequence of \ref bgl_namedparameters for `tm`, among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -620,7 +620,7 @@ compute_face_polyline_intersection( const FaceRange& face_range,
* \param polyline_range the range of polylines to check for intersections.
* \param tm the triangulated surface mesh to check for intersections.
* \param out output iterator to be filled with all pairs of face-segment that intersect
* \param np an optional sequence of \ref bgl_namedparameters for `tm`, among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -940,8 +940,8 @@ compute_polylines_polylines_intersection(const PolylineRange& polylines1,
* \param tm1 the first triangulated surface mesh to check for intersections
* \param tm2 the second triangulated surface mesh to check for intersections
* \param out output iterator to be filled with all pairs of faces that intersect
* \param np1 an optional sequence of \ref bgl_namedparameters for `tm1`, among the ones listed below
* \param np2 an optional sequence of \ref bgl_namedparameters for `tm2`, among the ones listed below
* \param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* \param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -1003,7 +1003,7 @@ compute_face_face_intersection(const TriangleMesh& tm1,
* \param tm the triangulated surface mesh to check for intersections.
* \param polyline the polyline to check for intersections.
* \param out output iterator to be filled with all pairs of face-segment that intersect
* \param np an optional sequence of \ref bgl_namedparameters for `tm`, among the ones listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -1219,8 +1219,8 @@ bool do_intersect(const Polyline& polyline1,
*
* @param tm1 the first triangulated surface mesh to check for intersections
* @param tm2 the second triangulated surface mesh to check for intersections
* @param np1 an optional sequence of \ref bgl_namedparameters for `tm1`, among the ones listed below
* @param np2 an optional sequence of \ref bgl_namedparameters for `tm2`, among the ones listed below
* @param np1 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np2 an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -1322,7 +1322,7 @@ bool do_intersect(const TriangleMesh& tm1,
*
* @param tm the triangulated surface mesh to check for intersections
* @param polylines the range of polylines to check for intersections.
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -1387,7 +1387,7 @@ bool do_intersect(const TriangleMesh& tm,
*
* @param tm the triangulated surface mesh to check for intersections
* @param polyline the polyline to check for intersections.
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -1608,7 +1608,7 @@ struct Mesh_callback
*
* \param range the range of triangulated surface meshes to be checked for intersections.
* \param out output iterator used to collect pairs of intersecting meshes.
* \param np an optional sequence named parameters among the one listed below
* \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{geom_traits}
@ -1626,7 +1626,7 @@ struct Mesh_callback
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* \param nps an optional range of named parameters among the one listed below
* \param nps an optional range of sequences of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

14
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/locate.h
View File

@ -566,7 +566,7 @@ get_descriptor_from_location(const std::pair<typename boost::graph_traits<Triang
///
/// \param loc the location from which a point is constructed
/// \param tm a triangulated surface mesh
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -1078,7 +1078,7 @@ locate_on_halfedge(const typename boost::graph_traits<TriangleMesh>::halfedge_de
/// (either user-provided via named parameters or the internal point map of the mesh `tm`)
/// \param fd a face of `tm`
/// \param tm a triangulated surface mesh
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -1575,7 +1575,7 @@ void build_AABB_tree(const TriangleMesh& tm,
///
/// \param tm a triangulated surface mesh
/// \param outTree output parameter that stores the computed `AABB_tree`
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -1642,7 +1642,7 @@ void build_AABB_tree(const TriangleMesh& tm, AABB_tree<AABBTraits>& outTree)
/// \param p the point to locate on the input triangulated surface mesh
/// \param tree an AABB tree containing the triangular faces of the input surface mesh to perform the point location with
/// \param tm a triangulated surface mesh
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -1746,7 +1746,7 @@ locate_with_AABB_tree(const typename internal::Location_traits<TriangleMesh>::Po
///
/// \param p the point to locate on the input triangulated surface mesh
/// \param tm a triangulated surface mesh
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -1840,7 +1840,7 @@ locate(const typename property_map_value<TriangleMesh, boost::vertex_point_t>::t
/// \param ray a ray to intersect with the input triangulated surface mesh
/// \param tree an AABB tree containing the triangular faces of the input surface mesh to perform the point location with
/// \param tm a triangulated surface mesh
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -1983,7 +1983,7 @@ locate_with_AABB_tree(const typename internal::Location_traits<TriangleMesh>::Ra
///
/// \param ray a ray to intersect with the input triangulated surface mesh
/// \param tm the input triangulated surface mesh
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/manifoldness.h
View File

@ -396,7 +396,7 @@ OutputIterator non_manifold_vertices(const PolygonMesh& pm,
/// @tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
///
/// @param pm the surface mesh to be repaired
/// @param np optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/merge_border_vertices.h
View File

@ -266,7 +266,7 @@ void merge_vertices_in_range(const HalfedgeRange& sorted_hedges,
///
/// @param h a halfedge that belongs to a boundary cycle.
/// @param pm the polygon mesh which contains the boundary cycle.
/// @param np an optional parameter of \ref bgl_namedparameters "Named Parameters" listed below.
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -321,7 +321,7 @@ void merge_duplicated_vertices_in_boundary_cycle(
/// @tparam NamedParameter a sequence of \ref bgl_namedparameters "Named Parameters".
///
/// @param pm the polygon mesh which contains the cycles.
/// @param np an optional parameter of \ref bgl_namedparameters "Named Parameters" listed below.
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orient_polygon_soup_extension.h
View File

@ -95,7 +95,7 @@ duplicate_non_manifold_edges_in_polygon_soup(PointRange& points,
* \param tm_ref the reference triangle_mesh.
* \param points the points of the soup.
* \param triangles the triangles of the soup.
* @param np optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

8
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h
View File

@ -156,7 +156,7 @@ namespace internal{
* @tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
*
* @param tm the closed triangle mesh free from self-intersections to be tested
* @param np optional sequence of \ref pmp_namedparameters "Named Parameters" among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
@ -372,7 +372,7 @@ void reverse_face_orientations(const FaceRange& face_range, PolygonMesh& pmesh)
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
*
* @param tm a closed triangulated surface mesh
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \pre `CGAL::is_closed(tm)`
*
@ -1314,7 +1314,7 @@ std::size_t volume_connected_components(const TriangleMesh& tm, VolumeFaceIndexM
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
*
* @param tm a closed triangulated surface mesh
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* @pre `CGAL::is_closed(tm)`
*
@ -1424,7 +1424,7 @@ void orient_to_bound_a_volume(TriangleMesh& tm)
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
*
* @param pm a surface mesh
* @param np optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

4
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/polygon_soup_to_polygon_mesh.h
View File

@ -224,7 +224,7 @@ bool is_polygon_soup_a_polygon_mesh(const PolygonRange& polygons)
* @param points points of the soup of polygons
* @param polygons each element in the vector describes a polygon using the indices of the points in `points`
* @param out the polygon mesh to be built
* @param np_ps optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_ps an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{point_map}
@ -235,7 +235,7 @@ bool is_polygon_soup_a_polygon_mesh(const PolygonRange& polygons)
* \cgalParamNEnd
* \cgalNamedParamsEnd
*
* @param np_pm optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @param np_pm an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

1
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/random_perturbation.h
View File

@ -244,4 +244,3 @@ void random_perturbation(TriangleMesh& tmesh
#include <CGAL/enable_warnings.h>
#endif //CGAL_POLYGON_MESH_PROCESSING_RANDOM_PERTURBATION_H

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/remesh.h
View File

@ -347,7 +347,7 @@ void isotropic_remeshing(
* @param edges the range of edges to be split if they are longer than given threshold
* @param max_length the edge length above which an edge from `edges` is split
* into to sub-edges
* @param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair.h
View File

@ -81,7 +81,7 @@ std::size_t remove_isolated_vertices(PolygonMesh& pmesh)
/// \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
///
/// \param tmesh the triangulated polygon mesh
/// \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair_degeneracies.h
View File

@ -1517,7 +1517,7 @@ bool remove_degenerate_edges(TriangleMesh& tmesh)
// @tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
//
// @param tmesh the triangulated surface mesh to be repaired
// @param np optional \ref bgl_namedparameters "Named Parameters" described below
// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamNBegin{vertex_point_map}

10
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/repair_polygon_soup.h
View File

@ -174,7 +174,7 @@ bool simplify_polygon(PointRange& points,
// \param points points of the soup of polygons.
// \param polygons a vector of polygons. Each element in the vector describes a polygon
// using the indices of the points in `points`.
// \param np an optional \ref bgl_namedparameters "Named Parameters" described below
// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamNBegin{geom_traits}
@ -228,7 +228,7 @@ std::size_t simplify_polygons_in_polygon_soup(PointRange& points,
// \param points points of the soup of polygons.
// \param polygons a vector of polygons. Each element in the vector describes a polygon
// using the indices of the points in `points`.
// \param np an optional \ref bgl_namedparameters "Named Parameters" described below
// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
//
// \cgalNamedParamsBegin
// \cgalParamNBegin{geom_traits}
@ -495,7 +495,7 @@ std::size_t remove_isolated_points_in_polygon_soup(PointRange& points,
/// \param points points of the soup of polygons.
/// \param polygons a vector of polygons. Each element in the vector describes a polygon
/// using the indices of the points in `points`.
/// \param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{geom_traits}
@ -885,7 +885,7 @@ DuplicateOutputIterator collect_duplicate_polygons(const PointRange& points,
/// \param points points of the soup of polygons.
/// \param polygons a vector of polygons. Each element in the vector describes a polygon
/// using the indices of the points in `points`.
/// \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{geom_traits}
@ -1049,7 +1049,7 @@ std::size_t merge_duplicate_polygons_in_polygon_soup(PointRange& points,
/// \param points points of the soup of polygons.
/// \param polygons a vector of polygons. Each element in the vector describes a polygon
/// using the indices of the points in `points`.
/// \param np an optional \ref bgl_namedparameters "Named Parameters", amongst those described below
/// \param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{geom_traits}

12
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/shape_predicates.h
View File

@ -44,7 +44,7 @@ namespace Polygon_mesh_processing {
///
/// @param e an edge of `pm`
/// @param pm polygon mesh containing `e`
/// @param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -101,7 +101,7 @@ bool is_degenerate_edge(typename boost::graph_traits<PolygonMesh>::edge_descript
/// @param edges a subset of edges of `tm`
/// @param tm a triangle mesh
/// @param out an output iterator in which the degenerate edges are written
/// @param np optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -182,7 +182,7 @@ OutputIterator degenerate_edges(const TriangleMesh& tm, OutputIterator out)
///
/// @param f a triangle face of `tm`
/// @param tm a triangle mesh containing `f`
/// @param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -245,7 +245,7 @@ bool is_degenerate_triangle_face(typename boost::graph_traits<TriangleMesh>::fac
/// @param faces a subset of faces of `tm`
/// @param tm a triangle mesh
/// @param out an output iterator in which the degenerate faces are put
/// @param np optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -329,7 +329,7 @@ OutputIterator degenerate_faces(const TriangleMesh& tm, OutputIterator out)
/// @param f a triangle face of `tm`
/// @param tm triangle mesh containing `f`
/// @param threshold a bound on the ratio of the longest edge length and the shortest edge length
/// @param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}
@ -434,7 +434,7 @@ is_needle_triangle_face(typename boost::graph_traits<TriangleMesh>::face_descrip
/// @param threshold the cosine of a minimum angle such that if `f` has an angle greater than this bound,
/// it is a cap. The threshold is in range `[-1 0]` and corresponds to an angle
/// between `90` and `180` degrees.
/// @param np an optional \ref bgl_namedparameters "Named Parameters" described below
/// @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
///
/// \cgalNamedParamsBegin
/// \cgalParamNBegin{vertex_point_map}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/smooth_mesh.h
View File

@ -56,7 +56,7 @@ namespace Polygon_mesh_processing {
*
* @param tmesh a polygon mesh with triangulated surface patches to be smoothed.
* @param faces the range of triangular faces defining one or several surface patches to be smoothed.
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{number_of_iterations}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/smooth_shape.h
View File

@ -55,7 +55,7 @@ namespace Polygon_mesh_processing {
* @param time a time step that corresponds to the speed by which the surface is smoothed.
* A larger time step results in faster convergence but details may be distorted to have a larger extent
* compared to more iterations with a smaller step. Typical values scale in the interval (1e-6, 1].
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below.
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{number_of_iterations}

2
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/transform.h
View File

@ -30,7 +30,7 @@ namespace Polygon_mesh_processing{
*
* @param transformation the transformation functor to apply to the points of `mesh`.
* @param mesh the `PolygonMesh` to transform.
* @param np an optional sequence of \ref bgl_namedparameters for `mesh`, among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}

1
Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/triangulate_faces.h
View File

@ -406,7 +406,6 @@ public:
* @param pmesh the polygon mesh to which the face to be triangulated belongs
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
*
*
* \cgalNamedParamsBegin
* \cgalParamNBegin{vertex_point_map}
* \cgalParamDescription{a property map associating points to the vertices of `pmesh`}

2
Surface_mesh_approximation/include/CGAL/Surface_mesh_approximation/approximate_triangle_mesh.h
View File

@ -65,7 +65,7 @@ unspecified_type all_default();
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
*
* @param tm triangle surface mesh to be approximated
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @return `true` if the indexed triangles represent a 2-manifold, oriented surface mesh, and `false` otherwise.
*
* \cgalNamedParamsBegin{Approximation Named Parameters}

6
Surface_mesh_approximation/include/CGAL/Variational_shape_approximation.h
View File

@ -297,7 +297,7 @@ public:
* Parameters out of range are ignored.
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @return number of proxies initialized
* \cgalNamedParamsBegin{Seeding Named Parameters}
@ -785,7 +785,7 @@ public:
* @brief extracts the output mesh in the form of an indexed triangle set.
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
*
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* @return `true` if the extracted surface mesh is manifold, and `false` otherwise.
*
* \cgalNamedParamsBegin{Meshing Named Parameters}
@ -868,7 +868,7 @@ public:
* @brief outputs approximation results.
* @tparam NamedParameters a sequence of \ref bgl_namedparameters
* @param np an optional sequence of \ref bgl_namedparameters among the ones listed below
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
* \cgalNamedParamsBegin{Output Named Parameters}
* \cgalParamNBegin{face_proxy_map}