diff --git a/Documentation/doc/resources/1.8.13/BaseDoxyfile.in b/Documentation/doc/resources/1.8.13/BaseDoxyfile.in index e3f372bcf3da..2aef4eda2d7a 100644 --- a/Documentation/doc/resources/1.8.13/BaseDoxyfile.in +++ b/Documentation/doc/resources/1.8.13/BaseDoxyfile.in @@ -266,6 +266,8 @@ ALIASES = "sc{1}=\1 \endhtmlonly" \ "cgalAdvancedFunction=This is an advanced function." \ "cgalAdvancedClass=This is an advanced class." \ + "cgalAdvancedType=This is an advanced type." \ + "cgalAdvancedConcept=This is an advanced concept." \ "cgalRequiresCPP11=\warning This function requires a C++11 compiler." \ "cgalPkgPicture{1}=
\n \image html \1 \n
" \ "cgalPkgSummaryBegin=
" \ diff --git a/Documentation/doc/resources/1.8.14/BaseDoxyfile.in b/Documentation/doc/resources/1.8.14/BaseDoxyfile.in index a9141040bc63..cec57978eb7e 100644 --- a/Documentation/doc/resources/1.8.14/BaseDoxyfile.in +++ b/Documentation/doc/resources/1.8.14/BaseDoxyfile.in @@ -267,6 +267,8 @@ ALIASES = "sc{1}=\1 \endhtmlonly" \ "cgalAdvancedFunction=This is an advanced function." \ "cgalAdvancedClass=This is an advanced class." \ + "cgalAdvancedType=This is an advanced type." \ + "cgalAdvancedConcept=This is an advanced concept." \ "cgalRequiresCPP11=\warning This function requires a C++11 compiler." \ "cgalPkgPicture{1}=
^^ \image html \1 ^^
" \ "cgalPkgSummaryBegin=
" \ diff --git a/Documentation/doc/resources/1.8.4/BaseDoxyfile.in b/Documentation/doc/resources/1.8.4/BaseDoxyfile.in index 4a3fea1307b4..7977a0a29289 100644 --- a/Documentation/doc/resources/1.8.4/BaseDoxyfile.in +++ b/Documentation/doc/resources/1.8.4/BaseDoxyfile.in @@ -251,6 +251,8 @@ ALIASES += "cgalAdvancedBegin=\htmlonly
Advanc ALIASES += "cgalAdvancedEnd=\htmlonly
\endhtmlonly" ALIASES += "cgalAdvancedFunction=This is an advanced function." ALIASES += "cgalAdvancedClass=This is an advanced class." +ALIASES += "cgalAdvancedType=This is an advanced type." +ALIASES += "cgalAdvancedConcept=This is an advanced concept." ALIASES += "cgalRequiresCPP11=\warning This function requires a C++11 compiler." diff --git a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h index 1b00927f86c4..b1be56d11bb5 100644 --- a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h @@ -3,6 +3,7 @@ \ingroup PkgInscribedAreasConcepts \cgalConcept +\cgalAdvancedConcept \cgalAdvancedBegin The concept `ExtremalPolygonTraits_2` provides the types and operations needed to compute a maximal \f$ k\f$-gon that can be diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h index ec9a0f141157..07ef62e2f6f7 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_Delaunay_triangulation_2.h @@ -305,6 +305,7 @@ class Periodic_2_Delaunay_triangulation_2 : public Periodic_2_triangulation_2 using Property_back_inserter = unspecified_type; + /// \cgalAdvancedType /// \cgalAdvancedBegin /// Model of `WritablePropertyMap` based on `Property` and that /// is allowed to push new items to the point set if needed. @@ -1025,26 +1027,30 @@ class Point_set_3 }; /// \endcond + /// \cgalAdvancedType /// \cgalAdvancedBegin /// Back inserter on indices /// \cgalAdvancedEnd typedef Property_back_inserter Index_back_inserter; + /// \cgalAdvancedType /// \cgalAdvancedBegin /// Back inserter on points /// \cgalAdvancedEnd typedef Property_back_inserter Point_back_inserter; + /// \cgalAdvancedType /// \cgalAdvancedBegin /// Property map for pushing new points /// \cgalAdvancedEnd typedef Push_property_map Point_push_map; + /// \cgalAdvancedType /// \cgalAdvancedBegin /// Property map for pushing new vectors /// \cgalAdvancedEnd typedef Push_property_map Vector_push_map; /*! - \cgalAdvancedBegin \cgalAdvancedFunction + \cgalAdvancedBegin \brief Returns the push property map of the given property. \tparam T type of the property. @@ -1063,8 +1069,8 @@ class Point_set_3 return Push_property_map > (this, &prop, size()); } /*! - \cgalAdvancedBegin \cgalAdvancedFunction + \cgalAdvancedBegin \brief Returns the push property map of the point property. \cgalAdvancedEnd */ @@ -1073,8 +1079,8 @@ class Point_set_3 return Point_push_map (this, &m_points, size()); } /*! - \cgalAdvancedBegin \cgalAdvancedFunction + \cgalAdvancedBegin \brief Returns the push property map of the normal property. \note The normal property must have been added to the point set @@ -1086,8 +1092,8 @@ class Point_set_3 return Vector_push_map (this, &m_normals, size()); } /*! - \cgalAdvancedBegin \cgalAdvancedFunction + \cgalAdvancedBegin \brief Returns the back inserter on the index property. \cgalAdvancedEnd */ @@ -1096,8 +1102,8 @@ class Point_set_3 return Index_back_inserter (this, &m_indices, size()); } /*! - \cgalAdvancedBegin \cgalAdvancedFunction + \cgalAdvancedBegin \brief Returns the back inserter on the point property. \cgalAdvancedEnd */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h b/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h index 234bf5bfa34a..f992348ba99f 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h @@ -2,6 +2,7 @@ \ingroup PkgSpatialSearchingDConcepts \cgalConcept +\cgalAdvancedConcept \cgalAdvancedBegin The concept `Splitter` defines the requirements for a function object class implementing a splitting rule. \cgalAdvancedEnd diff --git a/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h b/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h index 9e1da64c8f38..97317bca685a 100644 --- a/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h +++ b/Surface_mesh_skeletonization/include/CGAL/Mean_curvature_flow_skeletonization.h @@ -461,6 +461,7 @@ std::size_t collapse_short_edges(); /// \name Vertex Motion Parameters /// @{ + /// \cgalAdvancedFunction /// \cgalAdvancedBegin /// Controls the velocity of movement and approximation quality: /// decreasing this value makes the mean curvature flow based contraction converge @@ -480,7 +481,8 @@ std::size_t collapse_short_edges(); { return m_is_medially_centered; } - + + /// \cgalAdvancedFunction /// \cgalAdvancedBegin /// Controls the smoothness of the medial approximation: /// increasing this value results in a (less smooth) skeleton closer diff --git a/TDS_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h b/TDS_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h index c24fa7463de0..ee82122c9d96 100644 --- a/TDS_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h +++ b/TDS_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h @@ -118,6 +118,7 @@ Can be `CGAL::Sequential_tag` or `CGAL::Parallel_tag`. If it is typedef unspecified_type Concurrency_tag; /*! +\cgalAdvancedType \cgalAdvancedBegin This template class allows to get the type of a triangulation data structure that only changes the vertex type. It has to define a type @@ -130,6 +131,7 @@ template using Rebind_vertex = unspecified_type; /*! +\cgalAdvancedType \cgalAdvancedBegin This template class allows to get the type of a triangulation data structure that only changes the cell type. It has to define a type diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation.h b/Triangulation/doc/Triangulation/CGAL/Triangulation.h index bf01cfdce748..44bf5a43713c 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation.h @@ -254,6 +254,7 @@ Returns a const reference to the underlying triangulation data structure. const Triangulation_ds & tds() const; /*! +\cgalAdvancedFunction \cgalAdvancedBegin Returns a non-const reference to the underlying triangulation data structure. diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h b/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h index bc2459e2dbfa..0542353ebb18 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation_data_structure.h @@ -74,6 +74,7 @@ bool is_valid(bool verbose = true) const; /// @{ /*! +\cgalAdvancedType \cgalAdvancedBegin This template class allows to get the type of a triangulation data structure that only changes the vertex type. It has to define a type @@ -103,6 +104,7 @@ using Rebind_full_cell = unspecified_type; /// @{ /*! +\cgalAdvancedFunction \cgalAdvancedBegin A set `C` of full cells satisfying the same condition as in method `Triangulation_data_structure::insert_in_hole()` is assumed to be marked. This diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h index fccb180dfe4d..fc1b15a3ab76 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_full_cell.h @@ -60,7 +60,8 @@ class Triangulation_ds_full_cell { /// \name Validity Check /// @{ -/*! +/*! +\cgalAdvancedFunction \cgalAdvancedBegin Implements the validity checks required by the concept `TriangulationDSFullCell`. diff --git a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h index 6053146b13b7..787afe5ff166 100644 --- a/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h +++ b/Triangulation/doc/Triangulation/CGAL/Triangulation_ds_vertex.h @@ -41,6 +41,7 @@ class Triangulation_ds_vertex { /// @{ /*! +\cgalAdvancedFunction \cgalAdvancedBegin Implements the validity checks required by the concept `TriangulationDSVertex`. Does not implement additional checks. diff --git a/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h b/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h index 3b1b98c991ce..d5559c99a14c 100644 --- a/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h +++ b/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h @@ -432,6 +432,7 @@ Inserts a vertex in the triangulation data structure by subdividing the Vertex_handle insert_in_facet(const Facet & ft); /*! +\cgalAdvancedFunction \cgalAdvancedBegin Removes the full cells in the range \f$ C=\f$`[s, e)`, inserts a vertex at position `p` and fills the hole by connecting diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h index 7394806f2751..fc74ede4668e 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h @@ -406,7 +406,7 @@ The simplification algorithm uses the following types and functions. /*! \cgalAdvancedBegin -An iterator on the points of the of the original constraint +An iterator on the points of the original constraint before simplification steps are applied. The value type of this iterator is `Point`. A \link Constrained_triangulation_plus_2::Vertices_in_constraint_iterator `Vertices_in_constraint_iterator`\endlink can be converted into a `Points_in_constraint_iterator`, but not the other way around. @@ -416,6 +416,7 @@ typedef unspecified_type Points_in_constraint_iterator; /*! +\cgalAdvancedFunction \cgalAdvancedBegin Returns an iterator to the first point on the constraint before any simplification step. \cgalAdvancedEnd @@ -423,6 +424,7 @@ Returns an iterator to the first point on the constraint before any simplificati Points_in_constraint_iterator points_in_constraint_begin(Constraint_id cid) const; /*! +\cgalAdvancedFunction \cgalAdvancedBegin Returns an iterator past the last point on the constraint before any simplification step. \cgalAdvancedEnd @@ -430,6 +432,7 @@ Returns an iterator past the last point on the constraint before any simplificat Points_in_constraint_iterator points_in_constraint_end(Constraint_id cid) const ; /*! +\cgalAdvancedFunction \cgalAdvancedBegin Removes the vertex at `vicq` from the constraint and the triangulation. The point of that vertex remains stored in the sequence of original points @@ -452,6 +455,7 @@ void simplify(Vertices_in_constraint_iterator vicq); /*! +\cgalAdvancedFunction \cgalAdvancedBegin Removes the original points that correspond to vertices in the constraint `cid` which have been removed by the `simplify()` function. @@ -462,6 +466,7 @@ remove_points_without_corresponding_vertex(Constraint_id cid); /*! +\cgalAdvancedFunction \cgalAdvancedBegin Removes all original points that correspond to vertices in the constraints which have been removed by the `simplify()` function.