Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correction of (X)HTML warnings in case of Advanced topics #3758

Merged
merged 2 commits into from
Mar 19, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Documentation/doc/resources/1.8.14/BaseDoxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ ALIASES = "sc{1}=<span style=\"font-variant: small-caps;\">\1</sp
"cgalDebugBegin=\htmlonly[block] <div class=\"CGALDebug\"> <div>Debugging Support</div> \endhtmlonly ^^" \
"cgalDebugEnd=\htmlonly[block] </div> \endhtmlonly" \
"cgalDebugFunction=This is a function for debugging purpose." \
"cgalAdvancedBegin=\htmlonly[block] <div class=\"CGALAdvanced\"> <div>Advanced</div> \endhtmlonly ^^" \
"cgalAdvancedBegin=^^ \htmlonly[block] <div class=\"CGALAdvanced\"> <div>Advanced</div> \endhtmlonly ^^" \
sloriot marked this conversation as resolved.
Show resolved Hide resolved
"cgalAdvancedEnd=\htmlonly[block] </div> \endhtmlonly" \
"cgalAdvancedFunction=This is an advanced function." \
"cgalAdvancedClass=This is an advanced class." \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
Converts the current triangulation into the same periodic
triangulation in the 1-sheeted covering space.
\pre `is_triangulation_in_1_sheet()`

\cgalAdvancedEnd
*/
void convert_to_1_sheeted_covering();
Expand Down Expand Up @@ -991,6 +992,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
`f`. Face `f` is modified,
two new faces are created. If the triangulation contains periodic copies, a point is inserted in all periodic copies.
\pre The point in vertex `v` lies inside face `f`.

\cgalAdvancedEnd
*/
Vertex_handle insert_in_face(const Point& p, Face_handle f);
Expand All @@ -1000,6 +1002,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
\cgalAdvancedBegin
Removes a vertex of degree three. Two of the incident faces are
destroyed, the third one is modified. \pre Vertex `v` is a vertex with degree three.

\cgalAdvancedEnd
*/
void remove_degree_3(Vertex_handle v);
Expand All @@ -1023,6 +1026,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
`[edge_begin, edge_end]`. Returns a handle to the new vertex.

\pre The triangulation is a triangulation of 1 sheet

\cgalAdvancedEnd
*/
template<class EdgeIt>
Expand All @@ -1038,6 +1042,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
and create new ones only when the sequence is exhausted.

\pre The triangulation is a triangulation of 1 sheet

\cgalAdvancedEnd
*/
template<class EdgeIt, class FaceIt>
Expand Down
2 changes: 2 additions & 0 deletions Point_set_3/include/CGAL/Point_set_3.h
Original file line number Diff line number Diff line change
Expand Up @@ -1164,6 +1164,7 @@ class Point_set_3
\return Returns a pair containing: the specified property map and a
Boolean set to `true` or an empty property map and a Boolean set
to `false` (if the property was not found).

\cgalAdvancedEnd
*/
template <class T>
Expand All @@ -1189,6 +1190,7 @@ class Point_set_3

\note The normal property must have been added to the point set
before calling this method (see `add_normal_map()`).

\cgalAdvancedEnd
*/
Vector_push_map normal_push_map ()
Expand Down
2 changes: 2 additions & 0 deletions TDS_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ data structure that only changes the vertex type. It has to define a type
`Rebind_vertex<Vb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
one whose `TriangulationDSVertexBase_3` will be `Vb2`.
\note It can be implemented using a nested template class.

\cgalAdvancedEnd
*/
template <typename Vb2>
Expand All @@ -138,6 +139,7 @@ data structure that only changes the cell type. It has to define a type
`Rebind_cell<Cb2>::%Other` which is a <I>rebound</I> triangulation data structure, that is, the
one whose `TriangulationDSCellBase_3` will be `Cb2`.
\note It can be implemented using a nested template class.

\cgalAdvancedEnd
*/
template <typename Cb2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,21 @@ data structure that only changes the vertex type. It has to define a type
`Other` which is a <I>rebound</I> triangulation data structure with `Vb2`
as vertex type.
\note It can be implemented using a nested template class.

\cgalAdvancedEnd
*/
template <typename Vb2>
using Rebind_vertex = unspecified_type;

/*!
\cgalAdvancedType
\cgalAdvancedBegin
This template class allows to get the type of a triangulation
data structure that only changes the full cell type. It has to define a type
`Other` which is a <I>rebound</I> triangulation data structure with `Fcb2`
as full cell type.
\note It can be implemented using a nested template class.

\cgalAdvancedEnd
*/
template <typename Fcb2>
Expand All @@ -113,6 +116,7 @@ The boundary is recognized by checking the mark of the full cells.
This method is used by `Triangulation_data_structure::insert_in_hole()`.
s
\pre same as `TriangulationDataStructure::insert_in_hole()`

\cgalAdvancedEnd

*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,8 @@ All vertices of cells of \f$ C\f$ are on \f$ \partial H\f$.
\cgalFigureBegin{triangulationfiginserthole,insert-in-hole.png}
Insertion in a hole, \f$ d=2\f$
\cgalFigureEnd

\cgalAdvancedEnd
*/
template< class ForwardIterator > Vertex_handle
insert_in_hole(ForwardIterator start, ForwardIterator end, Facet f);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ The simplification algorithm uses the following types and functions.
/// @{

/*!
\cgalAdvancedType
\cgalAdvancedBegin
An iterator on the points of the original constraint
before simplification steps are applied. The value type of this iterator is `Point`.
Expand Down Expand Up @@ -449,6 +450,7 @@ constraints based on a cost and stop function.
\pre The vertex referred by vicq is not contained in any other constraint.
\pre Let `vip` and `vir` be defined as `vip = std::prev(vicq)` and `vir = std::next(vicr)`.
\pre The line segment between `*vicp->point()` and `*vicr->point()` must not intersect any constraint.

\cgalAdvancedEnd
*/
void
Expand Down