From 6f836b5827601f6ee27293d105b4c834668aa9d0 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Mon, 4 Mar 2019 11:03:44 +0100 Subject: [PATCH] T2,T3,Mesh_2: backticks, lowercase, capitalize --- Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h | 8 ++++---- .../Concepts/ConstrainedTriangulationFaceBase_2.h | 2 +- .../Concepts/TriangulationVertexBaseWithInfo_2.h | 4 ++-- .../Concepts/RegularTriangulationCellBase_3.h | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h index 4eea047e120..7522cdad541 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h @@ -32,7 +32,7 @@ typedef std::pair 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); diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h index bb4dbff8886..91a8c4d76a3 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h @@ -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$. */ diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h index 26b4e3976b4..350076d5bc5 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h @@ -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(); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h index 2826558a689..96ffaec568a 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h @@ -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.