Use lists in the description of MeshingCriteria_2::Is_bad.

That is infinitely better than with the LaTeX manual tools!
This commit is contained in:
Laurent Rineau 2012-10-03 13:06:50 +00:00
parent 2f573d16cc
commit c5ee6400c1
1 changed files with 18 additions and 11 deletions

View File

@ -64,17 +64,24 @@ typedef Hidden_type Quality;
/*!
Predicate object. Must provide two operators. The
first operator `Mesh_2::Face_badness operator()(Face_handle fh,
Quality& q)` returns CGAL::Mesh_2::NOT_BAD if it satisfies the desired criteria
for mesh triangles, `CGAL::Mesh_2::BAD` if it does not, and `CGAL::Mesh_2::IMPERATIVELY_BAD`
if it does not and should be refined unconditionally. In addition, this
operator assigns to `q` a value measuring the quality of the triangle
pointed by `fh`. The second operator `Mesh_2::Face_badness
operator()(Quality q)` returns `CGAL::Mesh_2::NOT_BAD` if `q` is the quality
of a good triangle, `CGAL::Mesh_2::BAD` if the `q` represents a poor quality,
and `CGAL::Mesh_2::IMPERATIVELY_BAD` if `q` represents the quality of a bad
triangle that should be refined unconditionally.
Predicate object. Must provide two operators.
- The first operator `Mesh_2::Face_badness operator()(Face_handle fh,
Quality& q)` returns
- `CGAL::Mesh_2::NOT_BAD` if it satisfies the desired
criteria for mesh triangles,
- `CGAL::Mesh_2::BAD` if it does not, and
- `CGAL::Mesh_2::IMPERATIVELY_BAD` if it does not and should be refined
unconditionally.
In addition, this operator assigns to `q` a value measuring the quality
of the triangle pointed by `fh`.
- The second operator `Mesh_2::Face_badness operator()(Quality q)` returns
- `CGAL::Mesh_2::NOT_BAD` if `q` is the quality of a good triangle,
- `CGAL::Mesh_2::BAD` if the `q` represents a poor quality, and
- `CGAL::Mesh_2::IMPERATIVELY_BAD` if `q` represents the quality of a bad
triangle that should be refined unconditionally.
*/
typedef Hidden_type Is_bad;