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

Fix brief of advanced #3734

Merged
merged 1 commit into from
Mar 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
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: 2 additions & 0 deletions Documentation/doc/resources/1.8.13/BaseDoxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,8 @@ ALIASES = "sc{1}=<span style=\"font-variant: small-caps;\">\1</sp
"cgalAdvancedEnd=\htmlonly </div> \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}=<div class=\"PkgImage\"> \n \image html \1 \n</div>" \
"cgalPkgSummaryBegin=<div class=\"PkgSummary\">" \
Expand Down
2 changes: 2 additions & 0 deletions Documentation/doc/resources/1.8.14/BaseDoxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,8 @@ ALIASES = "sc{1}=<span style=\"font-variant: small-caps;\">\1</sp
"cgalAdvancedEnd=\htmlonly </div> \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}=<div class=\"PkgImage\"> ^^ \image html \1 ^^</div>" \
"cgalPkgSummaryBegin=<div class=\"PkgSummary\">" \
Expand Down
2 changes: 2 additions & 0 deletions Documentation/doc/resources/1.8.4/BaseDoxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,8 @@ ALIASES += "cgalAdvancedBegin=\htmlonly <div class=\"CGALAdvanced\"> <div>Advanc
ALIASES += "cgalAdvancedEnd=\htmlonly </div> \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."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,7 @@ class Periodic_2_Delaunay_triangulation_2 : public Periodic_2_triangulation_2<Tr
/// @{

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Checks the combinatorial validity of the triangulation and the
validity of its geometric embedding (see
Expand All @@ -319,6 +320,7 @@ class Periodic_2_Delaunay_triangulation_2 : public Periodic_2_triangulation_2<Tr
is_valid(bool verbose = false) const;

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Checks the combinatorial and geometric validity of the cell (see
Section \ref P2Triangulation2secintro). Also checks that the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
/// @{

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Returns a reference to the triangulation data structure.
\cgalAdvancedEnd
Expand Down Expand Up @@ -473,6 +474,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
/// @{

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
The current triangulation remains a triangulation in the 1-sheeted
covering space even after adding points if this method returns
Expand All @@ -486,6 +488,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
bool is_extensible_triangulation_in_1_sheet_h1() const;

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
The same as `is_extensible_triangulation_in_1_sheet_h1()` but with
a more precise heuristic, i.e. it might answer `true` in cases in which
Expand All @@ -498,6 +501,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
bool is_extensible_triangulation_in_1_sheet_h2() const;

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Returns `true` if the current triangulation would still be a
triangulation in the 1-sheeted covering space, returns `false` otherwise.
Expand All @@ -506,6 +510,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
bool is_triangulation_in_1_sheet() const;

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Converts the current triangulation into the same periodic
triangulation in the 1-sheeted covering space.
Expand All @@ -515,6 +520,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
void convert_to_1_sheeted_covering();

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Converts the current triangulation into the same periodic
triangulation in the 9-sheeted covering space.
Expand Down Expand Up @@ -971,13 +977,15 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
/// @{

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Inserts the first vertex.
\cgalAdvancedEnd
*/
Vertex_handle insert_first(const Point& p);

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Inserts vertex `v` in face
`f`. Face `f` is modified,
Expand All @@ -988,6 +996,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
Vertex_handle insert_in_face(const Point& p, Face_handle f);

/*!
\cgalAdvancedFunction
\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.
Expand All @@ -996,6 +1005,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
void remove_degree_3(Vertex_handle v);

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Removes the unique vertex in the
triangulation.
Expand All @@ -1006,10 +1016,11 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2


/*!
\cgalAdvancedBegin
creates a new vertex `v` and use it to star the hole
whose boundary is described by the sequence of edges
`[edge_begin, edge_end]`. Returns a handle to the new vertex.
\cgalAdvancedFunction
\cgalAdvancedBegin
creates a new vertex `v` and use it to star the hole
whose boundary is described by the sequence of edges
`[edge_begin, edge_end]`. Returns a handle to the new vertex.

\pre The triangulation is a triangulation of 1 sheet
\cgalAdvancedEnd
Expand All @@ -1020,6 +1031,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
EdgeIt edge_end);

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
same as above, except that the algorithm
first recycles faces in the sequence `[face_begin, face_end]`
Expand All @@ -1036,6 +1048,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
FaceIt face_end);

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Changes the domain. Note that this function calls `clear()`,
i.e., it erases the existing triangulation.
Expand Down Expand Up @@ -1084,6 +1097,7 @@ class Periodic_2_triangulation_2 : public Triangulation_cw_ccw_2
/// @{

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Checks the combinatorial validity of the triangulation and
also the validity of its geometric embedding.
Expand Down
16 changes: 11 additions & 5 deletions Point_set_3/include/CGAL/Point_set_3.h
Original file line number Diff line number Diff line change
Expand Up @@ -939,13 +939,15 @@ class Point_set_3


#ifdef DOXYGEN_RUNNING
/// \cgalAdvancedType
/// \cgalAdvancedBegin
/// Model of `OutputIterator` used to insert elements by defining
/// the value of the property `Property`.
/// \cgalAdvancedEnd
template <class Property>
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.
Expand Down Expand Up @@ -1025,26 +1027,30 @@ class Point_set_3
};
/// \endcond

/// \cgalAdvancedType
/// \cgalAdvancedBegin
/// Back inserter on indices
/// \cgalAdvancedEnd
typedef Property_back_inserter<Index_map> Index_back_inserter;
/// \cgalAdvancedType
/// \cgalAdvancedBegin
/// Back inserter on points
/// \cgalAdvancedEnd
typedef Property_back_inserter<Point_map> Point_back_inserter;
/// \cgalAdvancedType
/// \cgalAdvancedBegin
/// Property map for pushing new points
/// \cgalAdvancedEnd
typedef Push_property_map<Point_map> Point_push_map;
/// \cgalAdvancedType
/// \cgalAdvancedBegin
/// Property map for pushing new vectors
/// \cgalAdvancedEnd
typedef Push_property_map<Vector_map> Vector_push_map;

/*!
\cgalAdvancedBegin
\cgalAdvancedFunction
\cgalAdvancedBegin
\brief Returns the push property map of the given property.

\tparam T type of the property.
Expand All @@ -1063,8 +1069,8 @@ class Point_set_3
return Push_property_map<Property_map<T> > (this, &prop, size());
}
/*!
\cgalAdvancedBegin
\cgalAdvancedFunction
\cgalAdvancedBegin
\brief Returns the push property map of the point property.
\cgalAdvancedEnd
*/
Expand All @@ -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
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
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 @@ -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
Expand All @@ -130,6 +131,7 @@ 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 cell type. It has to define a type
Expand Down
1 change: 1 addition & 0 deletions Triangulation/doc/Triangulation/CGAL/Triangulation.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ class Triangulation_ds_full_cell {
/// \name Validity Check
/// @{

/*!
/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Implements the validity checks required by the concept
`TriangulationDSFullCell`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class Triangulation_ds_vertex {
/// @{

/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Implements the validity checks required by the concept
`TriangulationDSVertex`. Does not implement additional checks.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -416,20 +416,23 @@ typedef unspecified_type Points_in_constraint_iterator;


/*!
\cgalAdvancedFunction
\cgalAdvancedBegin
Returns an iterator to the first point on the constraint before any simplification step.
\cgalAdvancedEnd
*/
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
*/
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
Expand All @@ -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.
Expand All @@ -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.
Expand Down