mirror of https://github.com/CGAL/cgal
Merge branch 'Doc-fix_warnings'
Merge documentation warning detected by recent doxygen version Locally tested
This commit is contained in:
Sébastien Loriot
commit
2d360a3abd
|
|
@ -368,7 +368,7 @@ ideas that was brought to them throughout the last years. In particular,
|
|||
they want to thank Menelaos Karavelas and Elias Tsigaridas for their
|
||||
initial contributions.
|
||||
|
||||
The two generic models where initially developed as part of the <span class="textsc">Exacus</span> \cgalCite{beh}+-eeeafcs-05 project.
|
||||
The two generic models where initially developed as part of the <span class="textsc">Exacus</span> \cgalCite{beh-eeeafcs-05} project.
|
||||
However, the models are now fully integrated into the \cgal library,
|
||||
since also the relevant layers of <span class="textsc">Exacus</span> are now part of \cgal.
|
||||
The main authors for `Algebraic_kernel_d_1<Coeff>` and `Algebraic_kernel_d_2<Coeff>` are
|
||||
|
|
|
|||
|
|
@ -961,7 +961,7 @@ The trapezoidal map RIC algorithm has expected logarithmic query time,
|
|||
while the query time for the landmark strategy may be as large as
|
||||
linear. In practice however, the query times of both strategies are
|
||||
competitive. For a detailed experimental comparison
|
||||
see \cgalCite{hh-eplca-05}
|
||||
see \cgalCite{cgal:hh-eplca-05}.
|
||||
|
||||
Updating the auxiliary data structures of the trapezoidal map RIC
|
||||
algorithm is done very efficiently. On the other hand, updating the
|
||||
|
|
|
|||
|
|
@ -809,7 +809,7 @@ range of all the darts of the orbit
|
|||
\f$ i_k\f$, each \f$ i_j\f$\f$ \in\f${0, ...,
|
||||
<I>d</I>}. These integers must satisfy: \f$ i_1\f$\f$ <\f$\f$
|
||||
i_2\f$\f$ <\f$...\f$ <\f$\f$ i_k\f$, and (\f$ i_1\f$\f$
|
||||
\neq\f$ 0 or \f$ i_2\f$\f$ \neq\f$1) (for example
|
||||
\neq\f$ 0 or \f$ i_2\f$\f$ \neq\f$ 1) (for example
|
||||
\link CombinatorialMap::Dart_of_orbit_range `Dart_of_orbit_range<1,2>`\endlink
|
||||
for the orbit \f$ \langle{}\f$\f$
|
||||
\beta_1\f$,\f$ \beta_2\f$\f$ \rangle{}\f$(<I>d0</I>));
|
||||
|
|
|
|||
|
|
@ -101,14 +101,12 @@ Returns true iff the dart is <I>i</I>-free.
|
|||
|
||||
bool is_free(unsigned int i) const;
|
||||
|
||||
/*
|
||||
\deprecated This function is removed since \cgal 4.4. Use \ref CombinatorialMap::highest_nonfree_dimension "cmap.highest_nonfree_dimension(dh)" instead.
|
||||
Returns the highest dimension <I>i</I> such that the dart is not <I>i</I>-free.
|
||||
-1 if `d0` is free for any dimension.
|
||||
|
||||
int highest_nonfree_dimension() const;
|
||||
|
||||
/*
|
||||
\deprecated This function is removed since \cgal 4.4. Use \ref CombinatorialMap::opposite "cmap.opposite(dh)" instead.
|
||||
Returns a handle to a dart belonging to the same edge
|
||||
than this dart, and not to the same vertex.
|
||||
|
|
@ -116,7 +114,6 @@ than this dart, and not to the same vertex.
|
|||
|
||||
Dart_handle opposite();
|
||||
|
||||
/*
|
||||
\deprecated This function is removed since \cgal 4.4. Use \ref CombinatorialMap::opposite "cmap.opposite(dh)" instead.
|
||||
Returns a const handle to a dart belonging to the same edge
|
||||
than this dart, and not to the same vertex, when the dart is const.
|
||||
|
|
@ -124,7 +121,6 @@ than this dart, and not to the same vertex, when the dart is const.
|
|||
|
||||
Dart_const_handle opposite() const;
|
||||
|
||||
/*
|
||||
\deprecated This function is removed since \cgal 4.4. Use \ref CombinatorialMap::other_extremity "cmap.other_extremity(dh)" instead.
|
||||
Returns a handle to a dart belonging to the other vertex of
|
||||
the edge containing this dart (but contrary to `opposite()` not
|
||||
|
|
@ -132,7 +128,6 @@ necessarily to the same edge). `NULL` if such a dart does not exist.
|
|||
|
||||
Dart_handle other_extremity();
|
||||
|
||||
/*
|
||||
\deprecated This function is removed since \cgal 4.4. Use \ref CombinatorialMap::other_extremity "cmap.other_extremity(dh)" instead.
|
||||
Returns a const handle to a dart belonging to the other vertex of
|
||||
the edge containing this dart, when the dart is const (but contrary to
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ projects 21957 (CGAL) and 28155 (GALIA).
|
|||
|
||||
\section secdesign_goals Primary design goals
|
||||
|
||||
The primary design goals of \cgal are described in \cgalCite{fgkss-dccga-00:}
|
||||
The primary design goals of \cgal are described in \cgalCite{fgkss-dccga-00}
|
||||
|
||||
\subsection Developer_manualCorrectness Correctness
|
||||
|
||||
|
|
|
|||
|
|
@ -2350,6 +2350,7 @@ ADDRESS = "Saarbr{\"u}cken, Germany"
|
|||
author = "J. Abbott",
|
||||
title = "Quadratic Interval Refinement for Real Roots",
|
||||
URL = "http://www.dima.unige.it/~abbott/",
|
||||
year= "2006",
|
||||
note = "Poster presented at the 2006 Int.\ Symp.\ on Symb.\
|
||||
and Alg.\ Comp.\ (ISSAC 2006)"}
|
||||
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ the lines that form the lower envelope of \f$ {\cal P}^{*}\f$ are dual to the
|
|||
points along the <I>upper</I> part of \f$ {\cal P}\f$'s convex hull, and the
|
||||
lines that form the upper envelope of \f$ {\cal P}^{*}\f$ are dual to the
|
||||
points along the <I>lower</I> part of the convex hull; see,
|
||||
e.g., [\cgalCite{Section} 11.4 for more details.
|
||||
e.g., \cgalCite{bkos-cgaa-97}, Section 11.4 for more details.
|
||||
Note that the leftmost edge of the minimization diagram is associated
|
||||
with the same line as the rightmost edge of the maximization diagram,
|
||||
and vice-verse. We can therefore skip the rightmost edges of both
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ typedef unspecified_type NT;
|
|||
/// @{
|
||||
|
||||
/*!
|
||||
This constructs a bounding box with the dimensions specified by the last 4 arguments. They are optional and will take the values \f$ \pm\f$10 if omitted.
|
||||
This constructs a bounding box with the dimensions specified by the last 4 arguments. They are optional and will take the values \f$ \pm\f$ 10 if omitted.
|
||||
*/
|
||||
Enclosing_box_2(Traits, NT xmin, NT xmax, NT ymin, NT ymax);
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ typedef unspecified_type NT;
|
|||
/// @{
|
||||
|
||||
/*!
|
||||
This constructs a bounding box with the dimensions specified by the last 6 arguments. They are optional and will take the values \f$ \pm\f$10 if omitted.
|
||||
This constructs a bounding box with the dimensions specified by the last 6 arguments. They are optional and will take the values \f$ \pm\f$ 10 if omitted.
|
||||
*/
|
||||
Enclosing_box_3(Traits, NT xmin, NT xmax, NT ymin, NT ymax, NT zmin, NT zmax);
|
||||
|
||||
|
|
|
|||
|
|
@ -385,5 +385,5 @@ double to_double(Simulator::Time);
|
|||
*/
|
||||
std::pair<double, double> to_interval(Simulator::Time);
|
||||
|
||||
} /*end namespace Kinetic
|
||||
} /* end namespace Kinetic */
|
||||
|
||||
|
|
|
|||
|
|
@ -287,7 +287,7 @@ template<unsigned int i> Point barycenter(Dart_const_handle dh) const;
|
|||
/*!
|
||||
Inserts a point, copy of `p`, in the <I>i</I>-cell containing `dh`.
|
||||
Returns a handle on one dart of this cell.
|
||||
\pre <I>i</I>\f$ \leq\f$\ref CombinatorialMap::dimension "dimension"\f$ \leq\f$2 and `*dh`\f$ \in\f$\ref CombinatorialMap::darts "darts()".
|
||||
\pre <I>i</I>\f$ \leq\f$\ref CombinatorialMap::dimension "dimension"\f$ \leq\f$ 2 and `*dh`\f$ \in\f$\ref CombinatorialMap::darts "darts()".
|
||||
|
||||
If \link CombinatorialMap::are_attributes_automatically_managed `are_attributes_automatically_managed()`\endlink`==true`,
|
||||
if <I>i</I>-attributes are non void,
|
||||
|
|
@ -306,7 +306,7 @@ template <unsigned int i> Dart_handle insert_point_in_cell(Dart_handle dh, Point
|
|||
/*!
|
||||
Inserts a point in the barycenter of the <I>i</I>-cell containing `dh`.
|
||||
Returns a handle on one dart of this cell.
|
||||
\pre <I>i</I>\f$ \leq\f$\ref CombinatorialMap::dimension "dimension"\f$ \leq\f$2 and `*dh`\f$ \in\f$\ref CombinatorialMap::darts "darts()".
|
||||
\pre <I>i</I>\f$ \leq\f$\ref CombinatorialMap::dimension "dimension"\f$ \leq\f$ 2 and `*dh`\f$ \in\f$\ref CombinatorialMap::darts "darts()".
|
||||
|
||||
If \link CombinatorialMap::are_attributes_automatically_managed `are_attributes_automatically_managed()`\endlink`==true`,
|
||||
if <I>i</I>-attributes are non void,
|
||||
|
|
|
|||
|
|
@ -241,8 +241,6 @@ typedef unspecified_type Periodic_point_iterator;
|
|||
/// @{
|
||||
|
||||
/*!
|
||||
\ingroup PkgPeriodic3Triangulation3Enums
|
||||
|
||||
The enum `Locate_type` is defined by `Periodic_3_triangulation_3` to
|
||||
specify which case occurs when locating a point in the
|
||||
triangulation. If the triangulation does not contain any points
|
||||
|
|
@ -254,8 +252,6 @@ triangulation. If the triangulation does not contain any points
|
|||
enum Locate_type {VERTEX=0, EDGE, FACET, CELL, EMPTY};
|
||||
|
||||
/*!
|
||||
\ingroup PkgPeriodic3Triangulation3Enums
|
||||
|
||||
The enum `Iterator_type` is defined by `Periodic_3_triangulation_3` to
|
||||
specify the behavior of geometric iterators.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@
|
|||
/// \defgroup PkgPeriodic3Triangulation3TraitsClasses Traits Classes
|
||||
/// \ingroup PkgPeriodic3Triangulation3
|
||||
|
||||
/// \defgroup PkgPeriodic3Triangulation3Enums Enums
|
||||
/// \ingroup PkgPeriodic3Triangulation3
|
||||
/*!
|
||||
\addtogroup PkgPeriodic3Triangulation3
|
||||
\todo check generated documentation
|
||||
|
|
|
|||
|
|
@ -1056,7 +1056,7 @@ she also wrote the traits classes for regular triangulations.
|
|||
|
||||
In 2000, Sylvain Pion started working on these packages. He improved
|
||||
the efficiency of triangulations in \cgal 2.3 and 2.4 in several ways
|
||||
\cgalCite{cgal:bdpty-tc-02:} he implemented the Delaunay hierarchy
|
||||
\cgalCite{cgal:bdpty-tc-02} he implemented the Delaunay hierarchy
|
||||
\cgalCite{cgal:d-dh-02} in 2.3, he improved the memory footprint in 2.4
|
||||
and 3.0, he also performed work on arithmetic filters
|
||||
\cgalCite{cgal:dp-eegpd-03} (see `Filtered_kernel`) to improve
|
||||
|
|
|
|||
Loading…
Reference in New Issue