songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

replace markdown subsections by \cgalHeading

This commit is contained in:
Sébastien Loriot 2019-02-14 10:53:48 +01:00
parent 52dd5f6244
commit a5576cd3fb
11 changed files with 11 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
BGL/include/CGAL/boost/graph/Dual.h
View File

@ -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 using `boost::filtered_graph` as shown in example
\ref BGL_surface_mesh/surface_mesh_dual.cpp \ref BGL_surface_mesh/surface_mesh_dual.cpp
Property forwarding \cgalHeading{Property Forwarding}
-------------------
\cgalAdvancedBegin \cgalAdvancedBegin
Edge properties of the underlying graph are forwarded directly. For Edge properties of the underlying graph are forwarded directly. For
faces and vertices only the `face_index` and `vertex_index` properties faces and vertices only the `face_index` and `vertex_index` properties

3
BGL/include/CGAL/boost/graph/Graph_with_descriptor_with_graph.h
View File

@ -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`. For example, calling `source(edge, graph)` will trigger an assertion if `edge` does not belong to `graph`.
It is mainly used for debugging purposes. It is mainly used for debugging purposes.
Property forwarding \cgalHeading{Property Forwarding}
-------------------
All internal properties of the underlying graph are forwarded. All internal properties of the underlying graph are forwarded.
Property maps can be wrapped with `Graph_with_descriptor_with_graph_property_map`. Property maps can be wrapped with `Graph_with_descriptor_with_graph_property_map`.

4
Polygon/include/CGAL/Polygon_2_algorithms.h
View File

@ -236,7 +236,7 @@ bool is_convex_2(ForwardIterator first,
/// - `orientation_2_object()` /// - `orientation_2_object()`
/// \tparam ForwardIterator must have `PolygonTraits::Point_2` as value type. /// \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 simplicity test is implemented by means of a plane sweep algorithm.
/// The algorithm is quite robust when used with inexact number types. /// 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()` /// - `orientation_2_object()`
/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// \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. /// The running time is linear in the number of vertices of the polygon.
/// A horizontal ray is taken to count the number of intersections. /// A horizontal ray is taken to count the number of intersections.

4
Polyline_simplification_2/doc/Polyline_simplification_2/Concepts/PolylineSimplificationVertexBase_2.h
View File

@ -8,10 +8,6 @@ whether a vertex can be removed, and the cost of the removal.
\cgalRefines `TriangulationVertexBase_2` \cgalRefines `TriangulationVertexBase_2`
### Types ###
Defines the same types as the `TriangulationVertexBase_2` concept
\cgalHasModel `CGAL::Polyline_simplification_2::Vertex_base_2<Vb>` \cgalHasModel `CGAL::Polyline_simplification_2::Vertex_base_2<Vb>`
\sa `TriangulationFaceBase_2` \sa `TriangulationFaceBase_2`

3
Solver_interface/include/CGAL/Eigen_solver_traits.h
View File

@ -86,8 +86,7 @@ The class `Eigen_solver_traits` provides an interface to the sparse solvers of \
\sa `CGAL::Eigen_vector<T>` \sa `CGAL::Eigen_vector<T>`
\sa http://eigen.tuxfamily.org \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: The instantiation of this class assumes an \ref thirdpartyEigen "Eigen" sparse solver is provided. Here are few examples:

3
Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/Parameterizer_3.h
View File

@ -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 Border parameterizers are also models of this concept but they only parameterize
the border of a given mesh. the border of a given mesh.
Creation \cgalHeading{Creation}
--------------
Construction and destruction are undefined. Construction and destruction are undefined.

3
Triangulation/doc/Triangulation/CGAL/Triangulation.h
View File

@ -37,8 +37,7 @@ The triangulation deduces its maximal dimension from the type
the dimension returned by the dimension returned by
`TriangulationDataStructure_::maximal_dimension()`. `TriangulationDataStructure_::maximal_dimension()`.
Input/Output \cgalHeading{Input/Output}
--------------
The information in the `iostream` is: the current dimension, the number of The information in the `iostream` is: the current dimension, the number of
finite vertices, the non-combinatorial information about vertices (point, finite vertices, the non-combinatorial information about vertices (point,

3
Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h
View File

@ -43,8 +43,7 @@ See the user manual for how to choose the second option.
\cgalModels `TriangulationDSFullCell` \cgalModels `TriangulationDSFullCell`
Rebind mechanism \cgalHeading{Rebind mechanism}
--------------
In case of derivation from that class, the nested class In case of derivation from that class, the nested class
`Rebind_TDS` need to be provided in the derived class. `Rebind_TDS` need to be provided in the derived class.

3
Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h
View File

@ -23,8 +23,7 @@ example).
\cgalModels `TriangulationDSVertex` \cgalModels `TriangulationDSVertex`
Rebind Mechanism \cgalHeading{Rebind mechanism}
--------------
In case of derivation from that class, the nested class In case of derivation from that class, the nested class
`Rebind_TDS` need to be provided in the derived class. `Rebind_TDS` need to be provided in the derived class.

3
Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h
View File

@ -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 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. <I>incident</I> if one is included in the other.
Input/Output \cgalHeading{Input/Output}
--------------
The information stored in the `iostream` is: The information stored in the `iostream` is:

3
Triangulation/doc/Triangulation/Concepts/TriangulationVertex.h
View File

@ -14,8 +14,7 @@ an association of the vertex with a geometric point.
\cgalHasModel `CGAL::Triangulation_vertex<TriangulationTraits_, Data, TriangulationDSVertex_>` \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 These operators can be used directly and are called by the I/O
operator of class `Triangulation`. operator of class `Triangulation`.