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

Merge pull request #4849 from MaelRL/PMP-No_caps_on_doc-GF 

Use lower case for function documentation starting with a verb (BGL/PMP)

# Conflicts:
#	Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/connected_components.h
This commit is contained in:
Laurent Rineau 2020-07-23 17:15:44 +02:00
parent 1ab4eea551 ebd65c9637
commit a84927d380
13 changed files with 64 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -56,18 +56,18 @@ public:
/*! The underlying primal type. */
typedef Primal_ Primal;
/*! Construct a Dual from a given primal. */
/*! constructs a Dual from a given primal. */
Dual(const Primal& primal)
: primal_(primal) {}
/*! Returns the underlying primal. */
/*! returns the underlying primal. */
const Primal& primal() const
{ return primal_; }
};
/*!
Construct a `Dual` from a given `primal`.
constructs a `Dual` from a given `primal`.
\relates CGAL::Dual
*/
template<typename Primal>

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

@ -129,7 +129,7 @@ void partition_dual_graph(const TriangleMesh& tm, int nparts,
/// \ingroup PkgBGLPartition
///
/// Computes a partition of the input triangular mesh into `nparts` parts,
/// computes a partition of the input triangular mesh into `nparts` parts,
/// based on the mesh's dual graph. The resulting partition is stored in the vertex and/or face
/// property maps that are passed as parameters using \ref bgl_namedparameters "Named Parameters".
///

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

@ -161,7 +161,7 @@ void partition_graph(const TriangleMesh& tm, int nparts,
/// \ingroup PkgBGLPartition
///
/// Computes a partition of the input triangular mesh into `nparts` parts, based on the
/// computes a partition of the input triangular mesh into `nparts` parts, based on the
/// mesh's nodal graph. The resulting partition is stored in the vertex and/or face
/// property maps that are passed as parameters using \ref bgl_namedparameters "Named Parameters".
///

66
BGL/include/CGAL/boost/graph/Seam_mesh.h
View File

@ -168,7 +168,7 @@ private:
mutable vertices_size_type number_of_vertices;
public:
/// Returns the underlying mesh.
/// returns the underlying mesh.
const TM& mesh() const
{
return tm;
@ -543,31 +543,31 @@ public:
/// \name Seam query functions
/// @{
/// Returns `true` if the vertex is on the seam.
/// returns `true` if the vertex is on the seam.
bool has_on_seam(TM_vertex_descriptor vd) const
{
return get(svm, vd);
}
/// Returns `true` if the edge is on the seam.
/// returns `true` if the edge is on the seam.
bool has_on_seam(TM_edge_descriptor ed) const
{
return get(sem, ed);
}
/// Returns `true` if the halfedge is on the seam.
/// returns `true` if the halfedge is on the seam.
bool has_on_seam(TM_halfedge_descriptor tmhd) const
{
return get(sem, CGAL::edge(tmhd, tm));
}
/// Returns `true` if the halfedge is on the seam.
/// returns `true` if the halfedge is on the seam.
bool has_on_seam(const halfedge_descriptor& hd) const
{
return has_on_seam(CGAL::edge(hd, tm));
}
/// Return the number of seam edges in the seam mesh.
/// returns the number of seam edges in the seam mesh.
edges_size_type number_of_seam_edges() const
{
return number_of_seams;
@ -601,7 +601,7 @@ public:
}
/// @endcond
/// Returns the iterator range of the vertices of the mesh.
/// returns the iterator range of the vertices of the mesh.
Iterator_range<vertex_iterator> vertices() const
{
Iterator_range<TM_halfedge_iterator> ir = CGAL::halfedges(tm);
@ -627,7 +627,7 @@ public:
}
/// @endcond
/// Returns the iterator range of the halfedges of the mesh.
/// returns the iterator range of the halfedges of the mesh.
Iterator_range<halfedge_iterator> halfedges() const
{
Iterator_range<TM_halfedge_iterator> ir = CGAL::halfedges(tm);
@ -652,7 +652,7 @@ public:
}
/// @endcond
/// Returns the iterator range of the edges of the mesh.
/// returns the iterator range of the edges of the mesh.
Iterator_range<edge_iterator> edges() const
{
Iterator_range<TM_halfedge_iterator> ir = CGAL::halfedges(tm);
@ -675,7 +675,7 @@ public:
}
/// @endcond
/// Returns the iterator range of the faces of the mesh.
/// returns the iterator range of the faces of the mesh.
Iterator_range<face_iterator> faces() const
{
return CGAL::faces(tm);
@ -686,7 +686,7 @@ public:
/// \name Memory Management
/// @{
/// Returns the number of vertices in the seam mesh.
/// returns the number of vertices in the seam mesh.
vertices_size_type num_vertices() const
{
if(number_of_vertices == static_cast<vertices_size_type>(-1)) {
@ -696,19 +696,19 @@ public:
return number_of_vertices;
}
/// Returns the number of halfedges in the seam mesh.
/// returns the number of halfedges in the seam mesh.
halfedges_size_type num_halfedges() const
{
return CGAL::num_halfedges(tm) + 2 * number_of_seams;
}
/// Returns the number of edges in the seam mesh.
/// returns the number of edges in the seam mesh.
halfedges_size_type num_edges() const
{
return CGAL::num_edges(tm) + number_of_seams;
}
/// Returns the number of faces in the seam mesh.
/// returns the number of faces in the seam mesh.
faces_size_type num_faces() const
{
return CGAL::num_faces(tm);
@ -719,7 +719,7 @@ public:
/// \name Degree Functions
/// @{
/// Returns the number of incident halfedges of vertex `v`.
/// returns the number of incident halfedges of vertex `v`.
degree_size_type degree(vertex_descriptor v) const
{
degree_size_type count(0);
@ -743,13 +743,13 @@ public:
#ifndef DOXYGEN_RUNNING
///@{
/// Returns the edge that contains halfedge `h` as one of its two halfedges.
/// returns the edge that contains halfedge `h` as one of its two halfedges.
edge_descriptor edge(halfedge_descriptor h) const
{
return edge_descriptor(h,this);
}
/// Returns the halfedge corresponding to the edge `e`.
/// returns the halfedge corresponding to the edge `e`.
halfedge_descriptor halfedge(edge_descriptor e) const
{
return e.hd;
@ -758,7 +758,7 @@ public:
///@{
/// Returns an incoming halfedge of vertex `v`.
/// returns an incoming halfedge of vertex `v`.
/// If `v` is a seam vertex, this will be the halfedge whose target is `v` and
/// whose opposite is a virtual border halfedge.
/// Otherwise, the rules of the underlying mesh are followed.
@ -769,7 +769,7 @@ public:
return halfedge_descriptor(h, false /*not on seam*/);
}
/// Finds a halfedge between two vertices. Returns a default constructed
/// finds a halfedge between two vertices. Returns a default constructed
/// `halfedge_descriptor`, if `source` and `target` are not connected.
std::pair<halfedge_descriptor, bool> halfedge(vertex_descriptor u,
vertex_descriptor v) const
@ -800,7 +800,7 @@ public:
return std::make_pair(halfedge_descriptor(), false/*invalid*/);
}
/// Finds an edge between two vertices. Returns a default constructed
/// finds an edge between two vertices. Returns a default constructed
/// `edge`, if `source` and `target` are not connected.
std::pair<edge_descriptor, bool> edge(vertex_descriptor u, vertex_descriptor v) const
{
@ -815,7 +815,7 @@ public:
return halfedge_descriptor(hd, false/*not on seam*/);
}
/// Returns the face incident to halfedge `h`.
/// returns the face incident to halfedge `h`.
face_descriptor face(halfedge_descriptor h) const
{
if(h.seam)
@ -825,7 +825,7 @@ public:
}
public:
/// Returns the next halfedge within the incident face.
/// returns the next halfedge within the incident face.
halfedge_descriptor next(const halfedge_descriptor& hd) const
{
if((!hd.seam) && (!is_border(hd.tmhd, tm)))
@ -840,7 +840,7 @@ public:
!is_border(CGAL::opposite(*hatc, tm), tm));
}
/// Returns the previous halfedge within the incident face.
/// returns the previous halfedge within the incident face.
halfedge_descriptor prev(const halfedge_descriptor& hd) const
{
if((!hd.seam) && (!is_border(hd.tmhd, tm)))
@ -855,7 +855,7 @@ public:
!is_border(CGAL::opposite(*hatc, tm), tm));
}
/// Returns the opposite halfedge of `hd`.
/// returns the opposite halfedge of `hd`.
halfedge_descriptor opposite(const halfedge_descriptor& hd) const
{
if(!hd.seam)
@ -864,7 +864,7 @@ public:
return halfedge_descriptor(CGAL::opposite(hd.tmhd, tm), false /*not on seam*/);
}
/// Returns the vertex the halfedge `h` emanates from.
/// returns the vertex the halfedge `h` emanates from.
vertex_descriptor target(halfedge_descriptor hd) const
{
TM_halfedge_descriptor tmhd(hd);
@ -884,7 +884,7 @@ public:
return vertex_descriptor(halfedge_descriptor(tmhd));
}
/// Returns the vertex the halfedge `h` emanates from.
/// returns the vertex the halfedge `h` emanates from.
vertex_descriptor source(const halfedge_descriptor& hd) const
{
return target(opposite(hd));
@ -922,7 +922,7 @@ public:
/// \name Seam selection
/// @{
/// Mark the edge of the underlying mesh that has extremities the vertices
/// marks the edge of the underlying mesh that has extremities the vertices
/// `tm_vd_s` and `tm_vd_s` as a seam edge.
///
/// \return whether the edge was successfully marked or not.
@ -963,7 +963,7 @@ public:
return true;
}
/// Create new seams.
/// creates new seams.
///
/// The edges to be marked as seams are described by the range [first, last) of
/// vertices of the underlying mesh. Each edge to be marked is described
@ -998,7 +998,7 @@ public:
return tmhd;
}
/// Create new seams.
/// creates new seams.
///
/// A seam edge is described by a pair of integers. The integer index
/// of a vertex of the underlying mesh is given by its position
@ -1024,7 +1024,7 @@ public:
return add_seams(seam_vertices.begin(), seam_vertices.end());
}
/// Create new seams.
/// creates new seams.
///
/// A seam edge is described by a pair of integers. The integer
/// index of a vertex of the underlying mesh is defined as its position when
@ -1041,7 +1041,7 @@ public:
return add_seams(in, tm_vds);
}
/// Create new seams.
/// creates new seams.
///
/// A seam edge is described by a pair of integers. The integer index
/// of a vertex of the underlying mesh is given by its position
@ -1085,7 +1085,7 @@ public:
return add_seams(in, tm_vds);
}
/// Create new seams.
/// creates new seams.
///
/// A seam edge is described by a pair of integers. The integer
/// index of a vertex of the underlying mesh is defined as its position when
@ -1104,7 +1104,7 @@ public:
/// @}
/// Constructs a seam mesh for a triangle mesh and an edge and vertex property map
/// constructs a seam mesh for a triangle mesh and an edge and vertex property map
///
/// \param tm the underlying mesh
/// \param sem the edge property map with value `true` for seam edges

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

@ -286,7 +286,7 @@ struct Regularization_graph
/*!
\ingroup PkgBGLSelectionFct
Augments a selection with faces of `fg` that are adjacent
augments a selection with faces of `fg` that are adjacent
to a face in `selection`. This process is applied `k` times considering
all faces added in the previous steps.
Two faces are said to be adjacent if they share a vertex or an edge.
@ -356,7 +356,7 @@ expand_face_selection(
/*!
\ingroup PkgBGLSelectionFct
Diminishes a selection of faces from faces adjacent to a non-selected face.
diminishes a selection of faces from faces adjacent to a non-selected face.
This process is applied `k` times considering all faces removed in the previous steps.
Two faces are said to be adjacent if they share a vertex or an edge.
Each face removed from the selection is added exactly once in `out`.
@ -749,7 +749,7 @@ select_incident_faces(
/*!
\ingroup PkgBGLSelectionFct
Augments a selection with edges of `fg` that are adjacent
augments a selection with edges of `fg` that are adjacent
to an edge in `selection`. This process is applied `k` times considering
all edges added in the previous steps.
Two edges are said to be adjacent if they are incident to the same face or vertex.
@ -816,7 +816,7 @@ expand_edge_selection(
/*!
\ingroup PkgBGLSelectionFct
Diminishes a selection of edges from edges adjacent to a non-selected edge.
diminishes a selection of edges from edges adjacent to a non-selected edge.
This process is applied `k` times considering all edges removed in the previous steps.
Two edges are said to be adjacent if they are incident to the same face or vertex.
Each edge removed from the selection is added exactly once in `out`.
@ -902,7 +902,7 @@ reduce_edge_selection(
/*!
\ingroup PkgBGLSelectionFct
Augments a selection with vertices of `fg` that are adjacent
augments a selection with vertices of `fg` that are adjacent
to a vertex in `selection`. This process is applied `k` times considering
all vertices added in the previous steps.
Two vertices are said to be adjacent if they are part of the same face.
@ -957,7 +957,7 @@ expand_vertex_selection(
/*!
\ingroup PkgBGLSelectionFct
Diminishes a selection of vertices from vertices adjacent to a non-selected vertex.
diminishes a selection of vertices from vertices adjacent to a non-selected vertex.
This process is applied `k` times considering all vertices removed in the previous steps.
Two vertices are said to be adjacent if they are part of the same face.
Each vertex removed from the selection is added exactly once in `out`.

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

@ -131,7 +131,7 @@ public:
}
}; // end class Less_on_G_copy_vertex_descriptors
// Splits a graph at vertices with degree higher than two and at vertices where `is_terminal` returns `true`
// splits a graph at vertices with degree higher than two and at vertices where `is_terminal` returns `true`
// The vertices are duplicated, and new incident edges created.
// `OrigGraph` must be undirected
template <typename Graph,

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

@ -821,7 +821,7 @@ void keep_connected_components(PolygonMesh& pmesh
/*!
* \ingroup keep_connected_components_grp
* Removes in `pmesh` the connected components designated by theirs ids
* removes in `pmesh` the connected components designated by theirs ids
* in `components_to_remove` as well as all isolated vertices.
* The connected component id of a face is given by `fcm`.
*

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

@ -391,7 +391,7 @@ barycentric_coordinates(const Point& p, const Point& q, const Point& r, const Po
/// \ingroup PMP_locate_grp
///
/// \brief Returns a random point over the halfedge `hd`, as a location.
/// \brief returns a random point over the halfedge `hd`, as a location.
///
/// \details The random point is chosen on the halfedge, meaning that all
/// its barycentric coordinates are positive. It is constructed by uniformly generating
@ -426,7 +426,7 @@ random_location_on_halfedge(typename boost::graph_traits<TriangleMesh>::halfedge
/// \ingroup PMP_locate_grp
///
/// \brief Returns a random point over the face `fd`, as a location.
/// \brief returns a random point over the face `fd`, as a location.
///
/// \details The random point is on the face, meaning that all its barycentric coordinates
/// are positive. It is constructed by uniformly picking a value `u` between `0` and `1`,
@ -459,7 +459,7 @@ random_location_on_face(typename boost::graph_traits<TriangleMesh>::face_descrip
/// \ingroup PMP_locate_grp
///
/// \brief Returns a random point over the mesh `tm`.
/// \brief returns a random point over the mesh `tm`.
///
/// \details The returned location is obtained by choosing a random face of the mesh and
/// a random point on that face. The barycentric coordinates of the point in the face
@ -919,7 +919,7 @@ is_on_mesh_border(const std::pair<typename boost::graph_traits<TriangleMesh>::fa
/// \ingroup PMP_locate_grp
///
/// \brief Returns the location of the given vertex `vd` as a location,
/// \brief returns the location of the given vertex `vd` as a location,
/// that is an ordered pair specifying a face incident to `vd`
/// and the barycentric coordinates of the vertex `vd` in that face.
///
@ -981,7 +981,7 @@ locate_vertex(typename boost::graph_traits<TriangleMesh>::vertex_descriptor vd,
/// \ingroup PMP_locate_grp
///
/// \brief Returns the location of a given vertex as a location in `fd`,
/// \brief returns the location of a given vertex as a location in `fd`,
/// that is an ordered pair composed of `fd` and of the barycentric coordinates
/// of the vertex in `fd`.
///
@ -1828,7 +1828,7 @@ locate(const typename property_map_value<TriangleMesh, boost::vertex_point_t>::t
/// \ingroup PMP_locate_grp
///
/// \brief Returns the face location along `ray` nearest to its source point.
/// \brief returns the face location along `ray` nearest to its source point.
///
/// If the ray does not intersect the mesh, a default constructed location is returned.
///
@ -1969,7 +1969,7 @@ locate_with_AABB_tree(const typename internal::Location_traits<TriangleMesh>::Ra
/// \ingroup PMP_locate_grp
///
/// \brief Returns the face location along `ray` nearest to its source point.
/// \brief returns the face location along `ray` nearest to its source point.
///
/// If the ray does not intersect the mesh, a default constructed location is returned.
///

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

@ -34,7 +34,7 @@ namespace CGAL {
namespace Polygon_mesh_processing {
/// \ingroup PMP_repairing_grp
/// checks whether a vertex of a polygon mesh is non-manifold.
/// returns whether a vertex of a polygon mesh is non-manifold.
///
/// @tparam PolygonMesh a model of `HalfedgeListGraph`
///

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

@ -30,7 +30,7 @@ namespace Polygon_mesh_processing {
/// \ingroup PMP_repairing_grp
///
/// Adds the vertices and faces of a mesh into a (possibly non-empty) polygon soup.
/// adds the vertices and faces of a mesh into a (possibly non-empty) polygon soup.
///
/// \tparam PolygonMesh a model of `FaceListGraph`
/// \tparam PointRange a model of the concepts `RandomAccessContainer` and

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

@ -216,7 +216,7 @@ std::size_t simplify_polygons_in_polygon_soup(PointRange& points,
// \ingroup PMP_repairing_grp
//
// Splits "pinched" polygons, that is polygons for which a point appears more than once,
// splits "pinched" polygons, that is polygons for which a point appears more than once,
// into multiple non-pinched polygons.
//
// \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type.
@ -322,7 +322,7 @@ std::size_t split_pinched_polygons_in_polygon_soup(PointRange& points,
// \ingroup PMP_repairing_grp
//
// Removes polygons with fewer than 2 points from the soup.
// removes polygons with fewer than 2 points from the soup.
//
// \tparam PointRange a model of the concept `Container` whose value type is the point type.
// \tparam PolygonRange a model of the concept `SequenceContainer`
@ -379,7 +379,7 @@ std::size_t remove_degenerate_polygons_in_polygon_soup(PointRange& points,
/// \ingroup PMP_repairing_grp
///
/// Removes the isolated points from a polygon soup.
/// removes the isolated points from a polygon soup.
/// A point is considered <i>isolated</i> if it does not appear in any polygon of the soup.
///
/// \tparam PointRange a model of the concept `SequenceContainer` whose value type is the point type.
@ -481,7 +481,7 @@ std::size_t remove_isolated_points_in_polygon_soup(PointRange& points,
/// \ingroup PMP_repairing_grp
///
/// Merges the duplicate points in a polygon soup.
/// merges the duplicate points in a polygon soup.
/// Note that the index of a point that is merged with another point will thus change
/// in all the polygons that the point appears in.
///
@ -795,7 +795,7 @@ struct Duplicate_collector<ValueType, CGAL::Emptyset_iterator>
// \ingroup PMP_repairing_grp
//
// Collects duplicate polygons in a polygon soup, that is polygons that share the same vertices in the same
// collects duplicate polygons in a polygon soup, that is polygons that share the same vertices in the same
// order.
//
// \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is the point type.
@ -872,7 +872,7 @@ DuplicateOutputIterator collect_duplicate_polygons(const PointRange& points,
/// \ingroup PMP_repairing_grp
///
/// Merges the duplicate polygons in a polygon soup. Two polygons are duplicate if they share the same
/// merges the duplicate polygons in a polygon soup. Two polygons are duplicate if they share the same
/// vertices in the same order. Note that the first vertex of the polygon does not matter, that is
/// the triangle `0,1,2` is a duplicate of the triangle `2,0,1`.
///
@ -1023,7 +1023,7 @@ std::size_t merge_duplicate_polygons_in_polygon_soup(PointRange& points,
/// \ingroup PMP_repairing_grp
///
/// Cleans a given polygon soup through various repairing operations. More precisely, this function
/// cleans a given polygon soup through various repairing operations. More precisely, this function
/// carries out the following tasks, in the same order as they are listed:
/// - merging of duplicate points, using the function
/// `CGAL::Polygon_mesh_processing::merge_duplicate_points_in_polygon_soup()`;

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

@ -36,7 +36,7 @@ namespace Polygon_mesh_processing {
/*!
* \ingroup PMP_meshing_grp
*
* \short smoothes a triangulated region of a polygon mesh.
* \short smooths a triangulated region of a polygon mesh.
*
* This function attempts to make the triangle angle and area distributions as uniform as possible
* by moving (non-constrained) vertices.

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

@ -471,7 +471,7 @@ namespace Polygon_mesh_processing {
/*!
\ingroup hole_filling_grp
same as above but the range of third points is omitted. They are not
Same as above but the range of third points is omitted. They are not
taken into account in the cost computation that leads the hole filling.
*/
template <typename PointRange,