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

Remove the last remnants of \require and turn them into \requires

This commit is contained in:
Philipp Möller 2012-10-01 14:56:32 +00:00
parent b240d7e8d5
commit 33cd9af6cd
17 changed files with 42 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h
View File

@ -86,7 +86,7 @@ Builds an alpha shape data structure
for the points in the range
\f$ \left[\right.\f$`first`, `last`\f$ \left.\right)\f$ and
set the alpha value to `alpha`.
\require The `value_type` of `first` and `last` is `Point` (the type point of the underlying triangulation.)
\requires The `value_type` of `first` and `last` is `Point` (the type point of the underlying triangulation.)
*/
template < class InputIterator >
Alpha_shape_3(
@ -204,7 +204,7 @@ Inserts the alpha shape `A` into the stream `os`.
Defined in \ref CGAL/IO/io.h
\require The insert operator must be defined for `GT::Point`.
\requires The insert operator must be defined for `GT::Point`.
\relates Fixed_alpha_shape_3
*/
ostream& operator<<(ostream& os, const Fixed_alpha_shape_3<Dt>& A);

7
Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h
View File

@ -211,8 +211,11 @@ worse approximation ratio (and \f$ \epsilon\f$ can thus be larger
than `eps` in general). In any case, the number
\f$ \epsilon\f$ (and with this, the achived approximation
\f$ 1+\epsilon\f$) can be queried by calling the routine
`achieved_epsilon()` discussed below. \require `Iterator` must be a model for concept `InputIterator`
with value type `Point`. \pre The dimension \f$ d\f$ of the input points must be at least \f$ 2\f$, and \f$ \epsilon>0\f$.
`achieved_epsilon()` discussed below.
\requires `Iterator` must be a model for concept `InputIterator` with value type `Point`.
\pre The dimension \f$ d\f$ of the input points must be at least \f$ 2\f$, and \f$ \epsilon>0\f$.
*/
template < class Iterator >
Approximate_min_ellipsoid_d(double eps,

16
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h
View File

@ -135,7 +135,7 @@ std::ostream& stream = std::cout);
initializes `min_annulus` to \f$ ma(P)\f$ with \f$ P\f$ being the set of points
in the range [`first`,`last`).
\require The value type of `InputIterator` is `Point`.
\requires The value type of `InputIterator` is `Point`.
\pre All points have the same dimension.
*/
template < class InputIterator >
@ -242,7 +242,7 @@ outer_support_points_end( ) const;
/*!
returns the center of `min_annulus`.
\require An implicit conversion from `ET` to `RT` is available.
\requires An implicit conversion from `ET` to `RT` is available.
\pre `min_annulus` is not empty.
*/
Point center( ) const;
@ -250,7 +250,7 @@ Point center( ) const;
/*!
returns the squared inner radius of `min_annulus`.
\require An implicit conversion from `ET` to `RT` is available.
\requires An implicit conversion from `ET` to `RT` is available.
\pre `min_annulus` is not empty.
*/
FT squared_inner_radius( ) const;
@ -258,7 +258,7 @@ FT squared_inner_radius( ) const;
/*!
returns the squared outer radius of `min_annulus`.
\require An implicit conversion from `ET` to `RT` is available.
\requires An implicit conversion from `ET` to `RT` is available.
\pre `min_annulus` is not empty.
*/
FT squared_outer_radius( ) const;
@ -373,7 +373,7 @@ void clear( );
sets `min_annulus` to \f$ ma(P)\f$, where \f$ P\f$ is the set of points in
the range [`first`,`last`).
\require The value type of `InputIterator` is `Point`.
\requires The value type of `InputIterator` is `Point`.
\pre All points have the same dimension.
*/
template < class InputIterator >
@ -391,7 +391,7 @@ void insert( const Point& p);
inserts the points in the range [`first`,`last`) into
`min_annulus` and recomputes the smallest enclosing annulus.
\require The value type of `InputIterator` is `Point`.
\requires The value type of `InputIterator` is `Point`.
\pre All points have the same dimension. If `min_annulus` is not empty, this dimension must be equal to `min_annulus.ambient_dimension()`.
*/
template < class InputIterator >
@ -439,7 +439,7 @@ const Traits& traits( ) const;
/*!
writes `min_annulus` to output stream `os`.
\require The output operator is defined for `Point`.
\requires The output operator is defined for `Point`.
\relates Min_annulus_d
*/
std::ostream&
@ -449,7 +449,7 @@ const Min_annulus_d<Traits>& min_annulus);
/*!
reads `min_annulus` from input stream `is`.
\require The input operator is defined for `Point`.
\requires The input operator is defined for `Point`.
\relates Min_annulus_d
*/
std::istream&

8
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h
View File

@ -124,7 +124,7 @@ Usually, this will not be necessary, however, the algorithm's
efficiency depends on the order in which the points are
processed, and a bad order might lead to extremely poor
performance (see example below).
\require The value type of `first` and `last` is `Point`.
\requires The value type of `first` and `last` is `Point`.
*/
template < class InputIterator >
Min_circle_2( InputIterator first,
@ -299,7 +299,7 @@ inserts the points in the range [`first`,`last`)
into `min_circle` and recomputes the smallest enclosing circle by
calling `insert(p)` for each point `p` in
[`first`,`last`).
\require The value type of `first` and `last` is `Point`.
\requires The value type of `first` and `last` is `Point`.
*/
template < class InputIterator >
void insert( InputIterator first,
@ -350,7 +350,7 @@ const Traits& traits( ) const;
/*!
writes `min_circle` to output stream `os`.
\require The output operator is defined for `Point` (and for `Circle`, if pretty printing is used).
\requires The output operator is defined for `Point` (and for `Circle`, if pretty printing is used).
\relates Min_circle_2
*/
std::ostream&
@ -360,7 +360,7 @@ const Min_circle_2<Traits>& min_circle);
/*!
reads `min_circle` from input stream `is`.
\require The input operator is defined for `Point`.
\requires The input operator is defined for `Point`.
\relates Min_circle_2
*/
std::istream&

8
Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h
View File

@ -113,7 +113,7 @@ Usually, this will not be necessary, however, the algorithm's
efficiency depends on the order in which the points are
processed, and a bad order might lead to extremely poor
performance (see example below).
\require The value type of `first` and `last` is `Point`.
\requires The value type of `first` and `last` is `Point`.
*/
template < class InputIterator >
Min_Ellipse_2( InputIterator first,
@ -312,7 +312,7 @@ inserts the points in the range [`first`,`last`)
into `min_ellipse` and recomputes the smallest enclosing ellipse by
calling `insert(p)` for each point `p` in
[`first`,`last`).
\require The value type of `first` and `last` is `Point`.
\requires The value type of `first` and `last` is `Point`.
*/
template < class InputIterator >
void insert( InputIterator first,
@ -368,7 +368,7 @@ const Traits& traits( ) const;
/*!
writes `min_ellipse` to output stream `os`.
\require The output operator is defined for `Point` (and for `Ellipse`, if pretty printing is used).
\requires The output operator is defined for `Point` (and for `Ellipse`, if pretty printing is used).
\relates Min_ellipse_2
*/
std::ostream&
@ -378,7 +378,7 @@ const Min_ellipse_2<Traits>& min_ellipse);
/*!
reads `min_ellipse` from input stream `is`.
\require The input operator is defined for `Point`.
\requires The input operator is defined for `Point`.
\relates Min_ellipse_2
*/
std::istream&

6
Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h
View File

@ -28,7 +28,7 @@ omitted, if `ForwardIterator` refers to a two-dimensional point
type from one the \cgal kernels. In this case, a default traits class
(`Min_quadrilateral_default_traits_2<K>`) is used.
\require <OL>
\requires <OL>
<LI>If `Traits` is specified, it is a model for
`MinQuadrilateralTraits_2` and the value type `VT` of
`ForwardIterator` is `Traits::Point_2`. Otherwise
@ -99,7 +99,7 @@ omitted, if `ForwardIterator` refers to a two-dimensional point
type from one the \cgal kernels. In this case, a default traits class
(`Min_quadrilateral_default_traits_2<K>`) is used.
\require <OL>
\requires <OL>
<LI>If `Traits` is specified, it is a model for
`MinQuadrilateralTraits_2` and the value type `VT` of
`ForwardIterator` is `Traits::Point_2`. Otherwise `VT`
@ -167,7 +167,7 @@ point type from one the \cgal kernels. In this case, a default
traits class (`Min_quadrilateral_default_traits_2<K>`) is
used.
\require <OL>
\requires <OL>
<LI>If `Traits` is specified, it is a model for
`MinQuadrilateralTraits_2` and the value type `VT` of
`ForwardIterator` is `Traits::Point_2`. Otherwise `VT`

2
Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h
View File

@ -227,7 +227,7 @@ can be omitted if `ForwardIterator` refers to a point type from
the 2D-Kernel. In this case, a default traits class
(`Rectangular_p_center_default_traits_2<K>`) is used.
\require <OL>
\requires <OL>
<LI><I>Either: (if no traits parameter is given)</I> Value type
of `ForwardIterator` is `CGAL::Point_2<K>` for some
representation class `K` and `FT` is equivalent to

3
Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h
View File

@ -38,7 +38,8 @@ typedef Hidden_type Sphere;
/*!
is a (exact or inexact) field number type.
\require Currently, `FT` must either be `double` or `float`, or an exact field number type. (An <I>exact</I> number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \R\f$.)
\requires Currently, `FT` must either be `double` or `float`, or an exact field number type. (An <I>exact</I> number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \R\f$.)
*/
typedef Hidden_type FT;

4
STL_Extension/doc/STL_Extension/CGAL/Sixtuple.h
View File

@ -13,9 +13,7 @@ iterators) for accessing the elements of a container.
\deprecated This class is deprecated, and will be removed in some future \cgal release.
Please use CGAL::cpp11::array instead.
\require `T` must be `Assignable`.
\tparam `T` must be `Assignable`.
*/
template< typename T >
class Sixtuple {

2
STL_Extension/doc/STL_Extension/CGAL/algorithm.h
View File

@ -85,7 +85,7 @@ maximal element of the sequence \f$ (3,\,6,\,5)\f$. Hence the output is
second component refers to the maximal element in the range
[`first`, `last`).
\require `CompareMin` and `CompareMax` are adaptable binary
\requires `CompareMin` and `CompareMax` are adaptable binary
function objects: `VT` \f$ \times\f$ `VT` \f$ \rightarrow\f$ `bool` where `VT`
is the value type of `ForwardIterator`.
*/

2
STL_Extension/doc/STL_Extension/CGAL/iterator.h
View File

@ -401,7 +401,7 @@ additional argument.
\models ::OutputIterator
\require `Container` provides a member function `insert(const Container::const_reference&)`.
\requires `Container` provides a member function `insert(const Container::const_reference&)`.
*/
template< typename Container >

7
STL_Extension/doc/STL_Extension/CGAL/utility.h
View File

@ -159,7 +159,9 @@ Quadruple(T1 x, T2 y, T3 z, T4 w);
constructs a quadruple such that
`first` is constructed from `u`, `second` is
constructed from `v`, `third` is constructed from `w`,
and `fourth` is constructed from `x`. \require Proper conversion operators exist from `U` to `T1`, `V` to `T2`, `W` to `T3`, and `X` to `T4`.
and `fourth` is constructed from `x`.
\requires Proper conversion operators exist from `U` to `T1`, `V` to `T2`, `W` to `T3`, and `X` to `T4`.
*/
template <class U, class V, class W, class X>
Quadruple(U u, V v, W w, X x);
@ -354,7 +356,8 @@ Triple(T1 x, T2 y, T3 z);
/*!
constructs a triple such that `first` is constructed
from `u`, `second` is constructed from `v`, and
`third` is constructed from `w`. \require Proper conversion operators exist from `U` to `T1`, `V` to `T2`, and `W` to `T3`.
`third` is constructed from `w`.
\requires Proper conversion operators exist from `U` to `T1`, `V` to `T2`, and `W` to `T3`.
*/
template <class U, class V, class W> Triple(U u, V v,
W w);

2
STL_Extension/doc/STL_Extension/STL_Extension.txt
View File

@ -4,7 +4,7 @@ namespace CGAL {
\mainpage STL Extensions for %CGAL
\anchor Chapter_STL_Extensions_for_CGAL
\anchor chapterStlExtensions
\autotoc
\authors Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Ron Wein

2
Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h
View File

@ -32,7 +32,7 @@ Hilbert_sort_2(const Traits &traits = Traits());
/*!
sorts the range [`begin`, `end`).
\require `RandomAccessIterator::value_type` equals to `Traits::Point_2`.
\requires `RandomAccessIterator::value_type` equals to `Traits::Point_2`.
*/
template <class RandomAccessIterator> void operator() (RandomAccessIterator begin, RandomAccessIterator end) const;

2
Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h
View File

@ -31,7 +31,7 @@ Hilbert_sort_3(const Traits &traits = Traits());
/*!
sorts the range [`begin`, `end`).
\require `RandomAccessIterator::value_type` equals to `Traits::Point_3`.
\requires `RandomAccessIterator::value_type` equals to `Traits::Point_3`.
*/
template <class RandomAccessIterator> void operator() (RandomAccessIterator begin, RandomAccessIterator end) const;

2
Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h
View File

@ -31,7 +31,7 @@ Hilbert_sort_d(const Traits &traits = Traits());
/*!
sorts the range [`begin`, `end`).
\require `RandomAccessIterator::value_type` equals to `Traits::Point_d`.
\requires `RandomAccessIterator::value_type` equals to `Traits::Point_d`.
*/
template <class RandomAccessIterator> void operator() (RandomAccessIterator begin, RandomAccessIterator end) const;

2
Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h
View File

@ -31,7 +31,7 @@ Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double
/*!
sorts the range [`begin`, `end`).
\require `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined.
\requires `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined.
*/
template <class RandomAccessIterator> void operator() (RandomAccessIterator begin, RandomAccessIterator end) const;