T2,T3,Mesh_2: backticks, lowercase, capitalize

This commit is contained in:
Andreas Fabri 2019-03-04 11:03:44 +01:00
parent bd2b055f1e
commit 6f836b5827
4 changed files with 9 additions and 9 deletions

View File

@ -32,7 +32,7 @@ typedef std::pair<DelaunayMeshFaceBase_2, int> Edge;
/// @{
/*!
returns true if this face is in the domain to be refined.
returns `true` if this face is in the domain to be refined.
*/
bool is_in_domain() const;
/*!
@ -42,7 +42,7 @@ void set_in_domain(const bool b);
/*!
return true if this face has its circumcenter hidden
returns `true` if this face has its circumcenter hidden
by a constrained edge. It does not "see" it,
following the Constrained Delaunay triangulation visibility criterion.
*/
@ -56,13 +56,13 @@ void set_blind(const bool b);
If this face is blind, this function returns
the first constrained edge that prevents it from "seeing"
its circumcenter.
\pre is_blind() returns true
\pre is_blind() returns `true`
*/
Edge blinding_constraint() const;
/*!
sets the edge that makes this face blind.
\pre is_blind() returns true
\pre is_blind() returns `true`
\pre e is a constrained edge
*/
void set_blinding_constraint(const Egde& e);

View File

@ -34,7 +34,7 @@ public:
/// @{
/*!
returns true if the edge between the face and its neighbor
returns `true` if the edge between the face and its neighbor
`neighbor(i)` is constrained.
\pre \f$ 0\leq i \leq2\f$.
*/

View File

@ -29,13 +29,13 @@ typedef unspecified_type Info;
/// @{
/*!
Returns a const reference to the object of type `Info` stored in the
returns a const reference to the object of type `Info` stored in the
vertex.
*/
const Info& info() const;
/*!
Returns a reference to the object of type `Info` stored in the vertex.
returns a reference to the object of type `Info` stored in the vertex.
*/
Info& info();

View File

@ -54,7 +54,7 @@ defined by the geometric traits class of the triangulation.
typedef unspecified_type Point;
/*!
Iterator of value type Point
Iterator of value type `Point`
*/
typedef unspecified_type Point_iterator;
@ -86,7 +86,7 @@ void hide_point(const Point & p);
/// @}
/// \name Access functions
/// \name Access Functions
/// @{
/*!
Returns the weighted circumcenter of the cell, with no weight.