mirror of https://github.com/CGAL/cgal
replace markdown subsections by \cgalHeading
This commit is contained in:
Sébastien Loriot
parent
52dd5f6244
commit
a5576cd3fb
|
|
@ -43,8 +43,7 @@ vertices as a source and target. It is possible to filter border edges
|
|||
using `boost::filtered_graph` as shown in example
|
||||
\ref BGL_surface_mesh/surface_mesh_dual.cpp
|
||||
|
||||
Property forwarding
|
||||
-------------------
|
||||
\cgalHeading{Property Forwarding}
|
||||
\cgalAdvancedBegin
|
||||
Edge properties of the underlying graph are forwarded directly. For
|
||||
faces and vertices only the `face_index` and `vertex_index` properties
|
||||
|
|
|
|||
|
|
@ -118,8 +118,7 @@ The class `Graph_with_descriptor_with_graph` wraps a graph into another graph in
|
|||
For example, calling `source(edge, graph)` will trigger an assertion if `edge` does not belong to `graph`.
|
||||
It is mainly used for debugging purposes.
|
||||
|
||||
Property forwarding
|
||||
-------------------
|
||||
\cgalHeading{Property Forwarding}
|
||||
All internal properties of the underlying graph are forwarded.
|
||||
|
||||
Property maps can be wrapped with `Graph_with_descriptor_with_graph_property_map`.
|
||||
|
|
|
|||
|
|
@ -236,7 +236,7 @@ bool is_convex_2(ForwardIterator first,
|
|||
/// - `orientation_2_object()`
|
||||
/// \tparam ForwardIterator must have `PolygonTraits::Point_2` as value type.
|
||||
///
|
||||
/// ### Implementation##
|
||||
/// \cgalHeading{Implementation}
|
||||
///
|
||||
/// The simplicity test is implemented by means of a plane sweep algorithm.
|
||||
/// The algorithm is quite robust when used with inexact number types.
|
||||
|
|
@ -299,7 +299,7 @@ Oriented_side oriented_side_2(ForwardIterator first,
|
|||
/// - `orientation_2_object()`
|
||||
/// \tparam ForwardIterator must have `Traits::Point_2` as value type.
|
||||
///
|
||||
/// ### Implementation ###
|
||||
/// \cgalHeading{Implementation}
|
||||
///
|
||||
/// The running time is linear in the number of vertices of the polygon.
|
||||
/// A horizontal ray is taken to count the number of intersections.
|
||||
|
|
|
|||
|
|
@ -8,10 +8,6 @@ whether a vertex can be removed, and the cost of the removal.
|
|||
|
||||
\cgalRefines `TriangulationVertexBase_2`
|
||||
|
||||
### Types ###
|
||||
|
||||
Defines the same types as the `TriangulationVertexBase_2` concept
|
||||
|
||||
\cgalHasModel `CGAL::Polyline_simplification_2::Vertex_base_2<Vb>`
|
||||
|
||||
\sa `TriangulationFaceBase_2`
|
||||
|
|
|
|||
|
|
@ -86,8 +86,7 @@ The class `Eigen_solver_traits` provides an interface to the sparse solvers of \
|
|||
\sa `CGAL::Eigen_vector<T>`
|
||||
\sa http://eigen.tuxfamily.org
|
||||
|
||||
Example
|
||||
--------------
|
||||
\cgalHeading{Instantiation Example}
|
||||
|
||||
The instantiation of this class assumes an \ref thirdpartyEigen "Eigen" sparse solver is provided. Here are few examples:
|
||||
|
||||
|
|
|
|||
|
|
@ -8,8 +8,7 @@ of mesh, `TriangleMesh`, which must be a model of the `FaceGraph` concept.
|
|||
Border parameterizers are also models of this concept but they only parameterize
|
||||
the border of a given mesh.
|
||||
|
||||
Creation
|
||||
--------------
|
||||
\cgalHeading{Creation}
|
||||
|
||||
Construction and destruction are undefined.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,8 +37,7 @@ The triangulation deduces its maximal dimension from the type
|
|||
the dimension returned by
|
||||
`TriangulationDataStructure_::maximal_dimension()`.
|
||||
|
||||
Input/Output
|
||||
--------------
|
||||
\cgalHeading{Input/Output}
|
||||
|
||||
The information in the `iostream` is: the current dimension, the number of
|
||||
finite vertices, the non-combinatorial information about vertices (point,
|
||||
|
|
|
|||
|
|
@ -43,8 +43,7 @@ See the user manual for how to choose the second option.
|
|||
|
||||
\cgalModels `TriangulationDSFullCell`
|
||||
|
||||
Rebind mechanism
|
||||
--------------
|
||||
\cgalHeading{Rebind mechanism}
|
||||
|
||||
In case of derivation from that class, the nested class
|
||||
`Rebind_TDS` need to be provided in the derived class.
|
||||
|
|
|
|||
|
|
@ -23,8 +23,7 @@ example).
|
|||
|
||||
\cgalModels `TriangulationDSVertex`
|
||||
|
||||
Rebind Mechanism
|
||||
--------------
|
||||
\cgalHeading{Rebind mechanism}
|
||||
|
||||
In case of derivation from that class, the nested class
|
||||
`Rebind_TDS` need to be provided in the derived class.
|
||||
|
|
|
|||
|
|
@ -47,8 +47,7 @@ We call a \f$ 0\f$-simplex a <I>vertex</I>, a \f$ (d-1)\f$-simplex a <I>facet</I
|
|||
Two full cells are <I>neighbors</I> if they share a facet. Two faces are
|
||||
<I>incident</I> if one is included in the other.
|
||||
|
||||
Input/Output
|
||||
--------------
|
||||
\cgalHeading{Input/Output}
|
||||
|
||||
The information stored in the `iostream` is:
|
||||
|
||||
|
|
|
|||
|
|
@ -14,8 +14,7 @@ an association of the vertex with a geometric point.
|
|||
|
||||
\cgalHasModel `CGAL::Triangulation_vertex<TriangulationTraits_, Data, TriangulationDSVertex_>`
|
||||
|
||||
Input/Output
|
||||
--------------
|
||||
\cgalHeading{Input/Output}
|
||||
|
||||
These operators can be used directly and are called by the I/O
|
||||
operator of class `Triangulation`.
|
||||
|
|
|
|||
Loading…
Reference in New Issue