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

Doc clean-up: remove \cgalModifXXX

This commit is contained in:
Clement Jamin 2014-12-16 17:05:24 +01:00
parent b8c6aa87ad
commit f6971fbed3
4 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Triangulation/doc/Triangulation/Concepts/TriangulationDSFullCell.h
View File

@ -3,7 +3,6 @@
\ingroup PkgTriangulationsConcepts \ingroup PkgTriangulationsConcepts
\cgalConcept \cgalConcept
\cgalModifBegin
The concept `TriangulationDSFullCell` describes the requirements for the The concept `TriangulationDSFullCell` describes the requirements for the
full cell class of a `CGAL::Triangulation_data_structure`. It refines full cell class of a `CGAL::Triangulation_data_structure`. It refines
the concept `TriangulationDataStructure::FullCell`. the concept `TriangulationDataStructure::FullCell`.
@ -34,7 +33,6 @@ This <I>rebound</I> base class is the class
that the `CGAL::Triangulation_data_structure` that the `CGAL::Triangulation_data_structure`
actually uses as a base class for the class actually uses as a base class for the class
of `CGAL::Triangulation_data_structure::Vertex`. of `CGAL::Triangulation_data_structure::Vertex`.
\cgalModifEnd
\cgalRefines `TriangulationDataStructure::FullCell` \cgalRefines `TriangulationDataStructure::FullCell`
@ -54,11 +52,9 @@ public:
/// @{ /// @{
/*! /*!
\cgalModifBegin
The `Triangulation_data_structure` in which the `TriangulationDSFullCell` is The `Triangulation_data_structure` in which the `TriangulationDSFullCell` is
defined/used. defined/used.
Must be a model of the `TriangulationDataStructure` concept. Must be a model of the `TriangulationDataStructure` concept.
\cgalModifEnd
*/ */
typedef unspecified_type Triangulation_data_structure; typedef unspecified_type Triangulation_data_structure;

4
Triangulation/doc/Triangulation/Concepts/TriangulationDSVertex.h
View File

@ -3,7 +3,6 @@
\ingroup PkgTriangulationsConcepts \ingroup PkgTriangulationsConcepts
\cgalConcept \cgalConcept
\cgalModifBegin
The concept `TriangulationDSVertex` describes the requirements for the The concept `TriangulationDSVertex` describes the requirements for the
vertex base class of a `CGAL::Triangulation_data_structure`. It refines vertex base class of a `CGAL::Triangulation_data_structure`. It refines
the concept `TriangulationDataStructure::Vertex`. the concept `TriangulationDataStructure::Vertex`.
@ -34,7 +33,6 @@ This <I>rebound</I> base class is the class
that the `CGAL::Triangulation_data_structure` that the `CGAL::Triangulation_data_structure`
actually uses as a base class for the class actually uses as a base class for the class
of `CGAL::Triangulation_data_structure::Vertex`. of `CGAL::Triangulation_data_structure::Vertex`.
\cgalModifEnd
\cgalRefines `TriangulationDataStructure::Vertex` \cgalRefines `TriangulationDataStructure::Vertex`
@ -55,11 +53,9 @@ public:
/*! /*!
\cgalModifBegin
The `Triangulation_data_structure` in which the vertex is The `Triangulation_data_structure` in which the vertex is
defined/used. defined/used.
Must be a model of the `TriangulationDataStructure` concept. Must be a model of the `TriangulationDataStructure` concept.
\cgalModifEnd
*/ */
typedef unspecified_type Triangulation_data_structure; typedef unspecified_type Triangulation_data_structure;

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

@ -653,14 +653,12 @@ std::ostream & operator<<(std::ostream & os, const TriangulationDataStructure
\ingroup PkgTriangulationsConcepts \ingroup PkgTriangulationsConcepts
\cgalConcept \cgalConcept
\cgalModifBegin
The concept `TriangulationDataStructure::Vertex` describes the type used by a The concept `TriangulationDataStructure::Vertex` describes the type used by a
`TriangulationDataStructure` to store the vertices. `TriangulationDataStructure` to store the vertices.
It sets requirements of combinatorial nature It sets requirements of combinatorial nature
only, as geometry is not concerned here. In particular, we only require that only, as geometry is not concerned here. In particular, we only require that
the vertex holds a handle to a full cell incident to it in the triangulation. the vertex holds a handle to a full cell incident to it in the triangulation.
\cgalModifEnd
\cgalHasModel `CGAL::Triangulation_ds_vertex<TriangulationDataStructure>` \cgalHasModel `CGAL::Triangulation_ds_vertex<TriangulationDataStructure>`
\cgalHasModel `CGAL::Triangulation_vertex<TriangulationTraits, Data, TriangulationDSVertex>` \cgalHasModel `CGAL::Triangulation_vertex<TriangulationTraits, Data, TriangulationDSVertex>`
@ -751,7 +749,6 @@ std::istream& operator>>(std::istream & is, Triangulation_ds_vertex<Triangulatio
\ingroup PkgTriangulationsConcepts \ingroup PkgTriangulationsConcepts
\cgalConcept \cgalConcept
\cgalModifBegin
The concept `TriangulationDataStructure::FullCell` describes the type used by a The concept `TriangulationDataStructure::FullCell` describes the type used by a
`TriangulationDataStructure` to store the full cells. `TriangulationDataStructure` to store the full cells.
@ -766,7 +763,6 @@ storing handles to the vertices of the
full cell as well as handles to the adjacent full cells. Two full cells full cell as well as handles to the adjacent full cells. Two full cells
are said to be adjacent when they share a facet. Adjacent full cells are are said to be adjacent when they share a facet. Adjacent full cells are
called hereafter neighbors. called hereafter neighbors.
\cgalModifEnd
\cgalHasModel `CGAL::Triangulation_ds_full_cell<TriangulationDataStructure,DSFullCellStoragePolicy>` \cgalHasModel `CGAL::Triangulation_ds_full_cell<TriangulationDataStructure,DSFullCellStoragePolicy>`
\cgalHasModel `CGAL::Triangulation_full_cell<TriangulationTraits, Data, TriangulationDSFullCell>` \cgalHasModel `CGAL::Triangulation_full_cell<TriangulationTraits, Data, TriangulationDSFullCell>`

2
Triangulation/doc/Triangulation/Triangulation.txt
View File

@ -67,7 +67,6 @@ class are not embedded in Euclidean space but are only of combinatorial
nature. It deals with simplicial complexes nature. It deals with simplicial complexes
which are pure, connected and without boundaries nor singularities. which are pure, connected and without boundaries nor singularities.
\cgalModifBegin
The class `CGAL::Triangulation<TriangulationTraits, TriangulationDataStructure>` The class `CGAL::Triangulation<TriangulationTraits, TriangulationDataStructure>`
describes an embedded triangulation that has as vertices a given set of points. describes an embedded triangulation that has as vertices a given set of points.
Methods are provided for the insertion of points in the triangulation, the Methods are provided for the insertion of points in the triangulation, the
@ -300,7 +299,6 @@ simplices incident to boundary faces of the convex hull.
Each infinite \f$ i\f$-simplex is Each infinite \f$ i\f$-simplex is
incident to the infinite vertex and to an \f$ (i-1)\f$-simplex of the incident to the infinite vertex and to an \f$ (i-1)\f$-simplex of the
convex hull boundary. convex hull boundary.
\cgalModifEnd
See Chapters \ref Chapter_2D_Triangulations "2D Triangulations" and See Chapters \ref Chapter_2D_Triangulations "2D Triangulations" and
\ref Chapter_3D_Triangulations "3D Triangulations" for more details \ref Chapter_3D_Triangulations "3D Triangulations" for more details