diff --git a/BGL/include/CGAL/boost/graph/Dual.h b/BGL/include/CGAL/boost/graph/Dual.h index aa8707bd047..fb844fe79b6 100644 --- a/BGL/include/CGAL/boost/graph/Dual.h +++ b/BGL/include/CGAL/boost/graph/Dual.h @@ -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 diff --git a/BGL/include/CGAL/boost/graph/Graph_with_descriptor_with_graph.h b/BGL/include/CGAL/boost/graph/Graph_with_descriptor_with_graph.h index c51b4ebfaf1..7c515e3a608 100644 --- a/BGL/include/CGAL/boost/graph/Graph_with_descriptor_with_graph.h +++ b/BGL/include/CGAL/boost/graph/Graph_with_descriptor_with_graph.h @@ -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`. diff --git a/Polygon/include/CGAL/Polygon_2_algorithms.h b/Polygon/include/CGAL/Polygon_2_algorithms.h index c1bc02de396..dcf2c8c5a8b 100644 --- a/Polygon/include/CGAL/Polygon_2_algorithms.h +++ b/Polygon/include/CGAL/Polygon_2_algorithms.h @@ -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. diff --git a/Polyline_simplification_2/doc/Polyline_simplification_2/Concepts/PolylineSimplificationVertexBase_2.h b/Polyline_simplification_2/doc/Polyline_simplification_2/Concepts/PolylineSimplificationVertexBase_2.h index d25878dbdb6..c26d75cb600 100644 --- a/Polyline_simplification_2/doc/Polyline_simplification_2/Concepts/PolylineSimplificationVertexBase_2.h +++ b/Polyline_simplification_2/doc/Polyline_simplification_2/Concepts/PolylineSimplificationVertexBase_2.h @@ -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` \sa `TriangulationFaceBase_2` diff --git a/Solver_interface/include/CGAL/Eigen_solver_traits.h b/Solver_interface/include/CGAL/Eigen_solver_traits.h index 19cc8b940c7..ac9f2bac22b 100644 --- a/Solver_interface/include/CGAL/Eigen_solver_traits.h +++ b/Solver_interface/include/CGAL/Eigen_solver_traits.h @@ -86,8 +86,7 @@ The class `Eigen_solver_traits` provides an interface to the sparse solvers of \ \sa `CGAL::Eigen_vector` \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: diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/Parameterizer_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/Parameterizer_3.h index 35046b4d110..971466d3773 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/Parameterizer_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/Parameterizer_3.h @@ -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. diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation.h b/Triangulation/doc/Triangulation/CGAL/Triangulation.h index bf01cfdce74..6ac5855e6d9 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation.h @@ -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, diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h index fccb180dfe4..1c9d5120ab1 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h @@ -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. diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h index 6053146b13b..f306645c6c4 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h @@ -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. diff --git a/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h b/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h index 3b1b98c991c..5f6cb260eba 100644 --- a/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h +++ b/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h @@ -47,8 +47,7 @@ We call a \f$ 0\f$-simplex a vertex, a \f$ (d-1)\f$-simplex a facetneighbors if they share a facet. Two faces are incident if one is included in the other. -Input/Output --------------- +\cgalHeading{Input/Output} The information stored in the `iostream` is: diff --git a/Triangulation/doc/Triangulation/Concepts/TriangulationVertex.h b/Triangulation/doc/Triangulation/Concepts/TriangulationVertex.h index dcb8a5d5b55..cd9091bb323 100644 --- a/Triangulation/doc/Triangulation/Concepts/TriangulationVertex.h +++ b/Triangulation/doc/Triangulation/Concepts/TriangulationVertex.h @@ -14,8 +14,7 @@ an association of the vertex with a geometric point. \cgalHasModel `CGAL::Triangulation_vertex` -Input/Output --------------- +\cgalHeading{Input/Output} These operators can be used directly and are called by the I/O operator of class `Triangulation`.