Merge pull request #3769 from sloriot/CGAL-doc_fixes

Various doc fixes
This commit is contained in:
Laurent Rineau 2019-03-19 18:30:36 +01:00
commit 9d40c3e1fc
2 changed files with 4 additions and 13 deletions

View File

@ -1,12 +1,3 @@
/// \ingroup PkgArrangementOnSurface2Macros
/// @{
/*!
* If the macro is set to one, then \f$x\f$-monotone curves are always
* directed from left-to-right.
*/
#define CGAL_ALWAYS_LEFT_TO_RIGHT
/// @}
namespace CGAL {
/*! \ingroup PkgArrangementOnSurface2TraitsClasses
*

View File

@ -886,13 +886,13 @@ public:
/*!
returns the vertex of the \f$ i^{th}\f$ neighbor of `f` that is
opposite to `f`.
\pre $0 \\leqle i \\leqle 2$.
\pre \f$ 0 \leq i \leq 2\f$.
*/
Vertex_handle mirror_vertex(Face_handle f, int i) const;
/*!
returns the index of `f` in its \f$ i^{th}\f$ neighbor.
\pre $0 \\leqle i \\leqle 2$.
\pre \f$0 \leq i \leq 2\f$.
*/
int mirror_index(Face_handle f, int i) const;
@ -1059,12 +1059,12 @@ public:
/// @{
/*!
Returns \f$ i+1\f$ modulo 3.\pre $0 \\leqle i \\leqle 2$.
Returns \f$ i+1\f$ modulo 3.\pre \f$0 \leq i \leq 2\f$.
*/
int ccw(int i) const;
/*!
Returns \f$ i+2\f$ modulo 3.\pre $0 \\leqle i \\leqle 2$.
Returns \f$ i+2\f$ modulo 3.\pre \f$0 \leq i \leq 2\f$.
*/
int cw(int i) const;