Skip to content

Commit

Permalink
Various doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
MaelRL committed Jan 13, 2025
1 parent e6a984e commit 65fd3fe
Showing 1 changed file with 9 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,8 @@ average_edge_length(const PolygonMesh& pmesh,
/**
* \ingroup PMP_measure_grp
*
* returns the shortest and longest edges of a range of edges of a given polygon mesh.
* returns the shortest and longest edges of a range of edges of a given polygon mesh,
* as well as their respective edge lengths.
*
* @tparam EdgeRange a model of `Range` whose iterator type is `InputIterator` with value type
* `boost::graph_traits<PolygonMesh>::edge_descriptor`.
Expand Down Expand Up @@ -280,6 +281,8 @@ average_edge_length(const PolygonMesh& pmesh,
*
* @return the shortest and longest edge in `pmesh`, along with their respective lengths.
*
* @warning This function involves a square root computation.
*
* @sa `edge_length()`
* @sa `squared_edge_length()`
*/
Expand Down Expand Up @@ -343,8 +346,9 @@ minmax_edge_length(const EdgeRange& edge_range,

/*!
* \ingroup PMP_measure_grp
* returns the shortest and longest edges of a given polygon mesh.
* Equivalent to `remove_almost_degenerate_faces(faces(tmesh), tmesh, np)`
* \brief returns the shortest and longest edges of a given polygon mesh,
* as well as their respective edge lengths.
* Equivalent to `minmax_edge_length(edges(pmesh), pmesh, np)`
*/
template<typename PolygonMesh,
typename CGAL_NP_TEMPLATE_PARAMETERS>
Expand Down Expand Up @@ -1343,8 +1347,8 @@ minmax_dihedral_angle(const EdgeRange& edge_range,

/*!
* \ingroup PMP_measure_grp
* computes the minimum and maximum dihedral angles of a given polygon mesh.
* Equivalent to `remove_almost_degenerate_faces(faces(tmesh), tmesh, np)`
* computes the minimum and maximum dihedral angles of a given triangle mesh.
* Equivalent to `minmax_dihedral_angle(edges(tmesh), tmesh, np)`
*/
template<typename TriangleMesh,
typename CGAL_NP_TEMPLATE_PARAMETERS>
Expand Down

0 comments on commit 65fd3fe

Please sign in to comment.