diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h index 9e7c7915ac6..cb602b0c4a7 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h @@ -194,9 +194,8 @@ OutputIterator get_alpha_shape_vertices(OutputIterator it, Classification_type t /*! Inserts the fixed alpha shape `A` into the stream `os`. -Defined in `CGAL/IO/io.h` -The insert operator must be defined for `GT::Point`. +An overlaoad of `operator<<` must be available for `GT::Point`. \relates Fixed_alpha_shape_3 */ ostream& operator<<(ostream& os, const Fixed_alpha_shape_3
& A); diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h index d2e14467bfd..c162a00c5aa 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h @@ -213,7 +213,7 @@ than `eps` in general). In any case, the number \f$ 1+\epsilon\f$) can be queried by calling the routine `achieved_epsilon()` discussed below. -@tparam Iterator must be a model for concept `InputIterator` with value type `Point`. +\tparam Iterator must be a model of `InputIterator` with `Point` as value type. \pre The dimension \f$ d\f$ of the input points must be at least \f$ 2\f$, and \f$ \epsilon>0\f$. */ diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h index c24c99ddb12..c7af75cd66f 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h @@ -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`). -@tparam InputIterator has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. \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`. -An implicit conversion from `ET` to `RT` is available. +An implicit conversion from `ET` to `RT` must be 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`. -An implicit conversion from `ET` to `RT` is available. +An implicit conversion from `ET` to `RT` must be 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`. -An implicit conversion from `ET` to `RT` is available. +An implicit conversion from `ET` to `RT` must be available. \pre `min_annulus` is not empty. */ FT squared_outer_radius( ) const; @@ -372,7 +372,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`). -@tparam InputIterator has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. \pre All points have the same dimension. */ template < class InputIterator > @@ -390,7 +390,7 @@ void insert( const Point& p); inserts the points in the range [`first`,`last`) into `min_annulus` and recomputes the smallest enclosing annulus. -@tparam InputIterator has the value type of `Point`. +@tparam InputIterator is a model of `InputIterator` with `Point` as value type. \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 > @@ -438,7 +438,7 @@ const Traits& traits( ) const; /*! writes `min_annulus` to output stream `os`. -The output operator is defined for `Point`. +An overload of `operator<<` must be defined for `Point`. \relates Min_annulus_d */ std::ostream& @@ -448,7 +448,7 @@ const Min_annulus_d& min_annulus); /*! reads `min_annulus` from input stream `is`. -The input operator is defined for `Point`. +An overload of `operator>>` must be defined for `Point`. \relates Min_annulus_d */ std::istream& diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h index 323151423e1..a8726337fa4 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h @@ -123,9 +123,8 @@ advance, using the random numbers generator `random`. 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). -@param first has the value type of `Point`. -@param last has the value type of `Point`. +performance (see example below). +\tparam InputIterator must be a model of `InputIterator` with `Point` as value type. */ template < class InputIterator > Min_circle_2( InputIterator first, @@ -300,8 +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`). -@tparam first has the value type of `Point`. -@tparam last has the value type of `Point`. +\tparam InputIterator must be a model of `InputIterator` with `Point` as value type. */ template < class InputIterator > void insert( InputIterator first, @@ -352,7 +350,7 @@ const Traits& traits( ) const; /*! writes `min_circle` to output stream `os`. -The output operator is defined for `Point` (and for `Circle`, if pretty printing is used). +An overload of `operator<<` must be defined for `Point` (and for `Circle`, if pretty printing is used). \relates Min_circle_2 */ std::ostream& @@ -362,7 +360,7 @@ const Min_circle_2& min_circle); /*! reads `min_circle` from input stream `is`. -The input operator is defined for `Point`. +An overload of `operator>>` must be defined for `Point`. \relates Min_circle_2 */ std::istream& diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h index 91ac33705a7..a8a329c7840 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h @@ -113,8 +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). -@tparam first has the value type of `Point`. -@tparam last has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. */ template < class InputIterator > Min_Ellipse_2( InputIterator first, @@ -313,8 +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`). -@tparam first has the value type of `Point`. -@tparam last has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. */ template < class InputIterator > void insert( InputIterator first, @@ -370,7 +368,7 @@ const Traits& traits( ) const; /*! writes `min_ellipse` to output stream `os`. -The output operator is defined for `Point` (and for `Ellipse`, if pretty printing is used). +An overload of `operator<<` must be defined for `Point` (and for `Ellipse`, if pretty printing is used). \relates Min_ellipse_2 */ std::ostream& @@ -380,7 +378,7 @@ const Min_ellipse_2& min_ellipse); /*! reads `min_ellipse` from input stream `is`. -The input operator is defined for `Point`. +An overload of `operator>>` must be defined for `Point`. \relates Min_ellipse_2 */ std::istream& diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h index 7b88d2007a8..7c93a00b5e1 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h @@ -126,8 +126,7 @@ Min_sphere_d (const Traits& traits = Traits()); creates a variable `min_sphere` of type `Min_sphere_d`. It is initialized to \f$ ms(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). -@tparam first has the value type of `Point`. -@tparam last has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. \pre All points have the same dimension. */ @@ -262,8 +261,7 @@ void clear (); sets `min_sphere` to the \f$ ms(P)\f$, where \f$ P\f$ is the set of points in the range [`first`,`last`). -@tparam first has the value type of `Point`. -@tparam last has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. \pre All points have the same dimension. */ template < class InputIterator > @@ -285,8 +283,7 @@ void insert( const Point& p); inserts the points in the range [`first`,`last`) into `min_sphere` and recomputes the smallest enclosing sphere, by calling `insert` for all points in the range. -@tparam first has the value type of `Point`. -@tparam last has the value type of `Point`. +\tparam InputIterator is a model of `InputIterator` with `Point` as value type. \pre All points have the same dimension. If `min_sphere` is not empty, this dimension must be equal to `ambient_dimension()`. */ template < class InputIterator > @@ -336,7 +333,7 @@ const Traits& traits( ) const; /*! writes `min_sphere` to output stream `os`. -The output operator is defined for `Point`. +An overload of `operator<<` must be defined for `Point`. \relates Min_sphere_d */ std::ostream& operator << ( std::ostream& os, @@ -346,7 +343,7 @@ min_sphere); /*! reads `min_sphere` from input stream `is`. -The input operator is defined for `Point`. +An overload of `operator>>` must be defined for `Point` \relates Min_sphere_d */ std::istream& operator >> ( std::istream& is, diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h index 87063473714..24de9ca7fd8 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h @@ -176,8 +176,7 @@ creates a variable `minsphere` of type `Min_sphere_of_spheres_d` and inserts (cf. `insert()`) the spheres from the range [`first`,`last`). -@tparam first has the value type of `Sphere`. -@tparam last has the value type of `Sphere`. +\tparam InputIterator is a model of `InputIterator` with `Sphere` as value type. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. */ template < typename InputIterator > @@ -267,8 +266,7 @@ void clear (); sets `minsphere` to the \f$ ms(S)\f$, where \f$ S\f$ is the set of spheres in the range [`first`,`last`). -@tparam first has the value type of `Sphere`. -@tparam last has the value type of `Sphere`. +\tparam InputIterator is a model of `InputIterator` with `Sphere` as value type. */ template < class InputIterator > void set( InputIterator first, InputIterator last ); @@ -283,8 +281,7 @@ void insert( const Sphere& s ); inserts the spheres in the range [`first`,`last`) into the set \f$ S\f$ of instance `minsphere`. -@tparam first has the value type of `Sphere`. -@tparam last has the value type of `Sphere`. +\tparam InputIterator is a model of `InputIterator` with `Sphere` as value type. */ template < class InputIterator > void insert( InputIterator first, InputIterator last ); diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h index 044d4741efd..84ce8286486 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h @@ -29,12 +29,12 @@ type from one the \cgal kernels. In this case, a default traits class (`Min_quadrilateral_default_traits_2`) is used.
    -
  1. If `Traits` is specified, it is a model for +
  2. If `Traits` is specified, it must be a model for `MinQuadrilateralTraits_2` and the value type `VT` of `ForwardIterator` is `Traits::Point_2`. Otherwise -`VT` is `CGAL::Point_2` for some kernel +`VT` must be `CGAL::Point_2` for some kernel `K`. -
  3. `OutputIterator` accepts `VT` as value type. +
  4. `OutputIterator` must accept `VT` as value type.
\sa `CGAL::min_rectangle_2()` @@ -100,11 +100,11 @@ type from one the \cgal kernels. In this case, a default traits class (`Min_quadrilateral_default_traits_2`) is used.
    -
  1. If `Traits` is specified, it is a model for +
  2. If `Traits` is specified, it must be a model for `MinQuadrilateralTraits_2` and the value type `VT` of `ForwardIterator` is `Traits::Point_2`. Otherwise `VT` -is `CGAL::Point_2` for some kernel `K`. -
  3. `OutputIterator` accepts `VT` as value type. +must be `CGAL::Point_2` for some kernel `K`. +
  4. `OutputIterator` must accept `VT` as value type.
\sa `CGAL::min_parallelogram_2()` @@ -168,11 +168,11 @@ traits class (`Min_quadrilateral_default_traits_2`) is used.
    -
  1. If `Traits` is specified, it is a model for +
  2. If `Traits` is specified, it must be a model for `MinQuadrilateralTraits_2` and the value type `VT` of `ForwardIterator` is `Traits::Point_2`. Otherwise `VT` -is `CGAL::Point_2` for some kernel `K`. -
  3. `OutputIterator` accepts `Traits::Line_2` as value type. +must be `CGAL::Point_2` for some kernel `K`. +
  4. `OutputIterator` must accept `Traits::Line_2` as value type.
\sa `CGAL::min_rectangle_2()` diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h index b46e2476c7c..debd0c3c8ea 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h @@ -229,12 +229,12 @@ the 2D-Kernel. In this case, a default traits class
  1. Either: (if no traits parameter is given) Value type -of `ForwardIterator` is `CGAL::Point_2` for some -representation class `K` and `FT` is equivalent to +of `ForwardIterator` must be `CGAL::Point_2` for some +representation class `K` and `FT` must be equivalent to `K::FT`,
  2. Or: (if a traits parameter is specified) `Traits` -is a model for `RectangularPCenterTraits_2`. -
  3. `OutputIterator` accepts the value type of +must be a model for `RectangularPCenterTraits_2`. +
  4. `OutputIterator` must accept the value type of `ForwardIterator` as value type.
diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h index 9cb0d223838..70b93bfc1fc 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h @@ -39,7 +39,7 @@ typedef unspecified_type Sphere; /*! is a (exact or inexact) field number type. -@tparam FT must either be `double` or `float`, or an exact field number type. (An exact number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \mathbb{R}\f$.) +\tparam FT must either be `double` or `float`, or an exact field number type. (An exact number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \mathbb{R}\f$.) */ typedef unspecified_type FT; diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h index 8301e024431..aecf017cdbc 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h @@ -97,14 +97,14 @@ intervals to [`lo[i]`,`hi[i]`], \f$ 0 \leq i < D\f$. Box_d(NT lo[D], NT hi[D]); /*! -constructs from `bbox`. -Requires : \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. +constructs from `bbox`. +Requirements: \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. */ Box_d( const Bbox_2& bbox); /*! constructs from `bbox`. -Requires : \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. +Requirements: \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. */ Box_d( const Bbox_3& bbox); @@ -140,7 +140,7 @@ static int dimension(); returns a unique box id, see the `IdPolicy` template parameter above for the different choices. -@tparam `IdPolicy`\f$ \neq\f$`ID_NONE` +\tparam `IdPolicy`\f$ \neq\f$`ID_NONE` */ std::size_t id(); @@ -158,13 +158,13 @@ NT max_coord(int d) const; /*! returns the bounding box -Requires : \f$ D=2\f$ and `NT`\f$ \equiv\f$`double` +Requirements: \f$ D=2\f$ and `NT`\f$ \equiv\f$`double` */ const Bbox_2& bbox() const; /*! returns the bounding box -Requires : \f$ D=3\f$ and `NT`\f$ \equiv\f$`double` +Requirements: \f$ D=3\f$ and `NT`\f$ \equiv\f$`double` */ const Bbox_3& bbox() const; diff --git a/Documentation/BaseDoxyfile.in b/Documentation/BaseDoxyfile.in index 665e24e6af2..1f935929a46 100644 --- a/Documentation/BaseDoxyfile.in +++ b/Documentation/BaseDoxyfile.in @@ -238,7 +238,6 @@ ALIASES += "cgalConcept=\details
\n \brief" ALIASES += "cgalConceptNamespace=\details
\n \brief" ALIASES += "cgalRefines=\xrefitem refines \"Refines\" \"Refinement Relationships\"" -ALIASES += "cgalRequires=\xrefitem requires \"Requires\" \"Type Requirements\"" ALIASES += "cgalModels=\xrefitem models \"Is Model Of\" \"Is Model Relationships\"" ALIASES += "cgalGeneralizes=\xrefitem generalizes \"Generalizes\" \"Generalization Relationships\"" ALIASES += "cgalHasModel=\xrefitem hasModels \"Has Models\" \"Has Model Relationships\"" diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h index d16cff78e92..746362713ac 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h @@ -113,7 +113,7 @@ Halfedge_handle create_segment(); removes the first vertex if vertices are supported. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void vertices_pop_front(); @@ -127,7 +127,7 @@ void vertices_pop_back(); removes the vertex `v` if vertices are supported. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void vertices_erase( Vertex_handle v); @@ -136,7 +136,7 @@ void vertices_erase( Vertex_handle v); removes the range `[first,last)` if vertices are supported. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void vertices_erase( Vertex_handle first, Vertex_handle last); @@ -144,7 +144,7 @@ void vertices_erase( Vertex_handle first, Vertex_handle last); removes the first face if faces are supported. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void faces_pop_front(); @@ -158,7 +158,7 @@ void faces_pop_back(); removes the face `f` if faces are supported. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void faces_erase( Face_handle f); @@ -166,7 +166,7 @@ void faces_erase( Face_handle f); removes the range `[first,last)` if faces are supported. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void faces_erase( Face_handle first, Face_handle last); @@ -179,7 +179,7 @@ creates isolated vertices they get removed as well. See `make_hole()` for a more specialized variant. \pre `h->is_border() == false`. -If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +If faces are supported, `Supports_removal`must be `CGAL::Tag_true`. */ void erase_face( Halfedge_handle h); @@ -187,7 +187,7 @@ void erase_face( Halfedge_handle h); removes the vertices, halfedges, and faces that belong to the connected component of `h`. \pre For all halfedges `g` in the connected component `g.next() != Halfedge_handle()`. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. */ void erase_connected_component( Halfedge_handle h); @@ -196,9 +196,9 @@ Erases the small connected components and the isolated vertices. Keep `nb_components_to_keep` largest connected components. Returns the number of connected components erased (ignoring isolated vertices). -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`, - `Supports_vertex_halfedge` \f$ \equiv\f$ `CGAL::Tag_true` and - `Supports_halfedge_vertex` \f$ \equiv\f$ `CGAL::Tag_true` +`Supports_removal` must be `CGAL::Tag_true`, +`Supports_vertex_halfedge` must be `CGAL::Tag_true` and +`Supports_halfedge_vertex` must be `CGAL::Tag_true`. */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); @@ -211,7 +211,7 @@ unsigned int keep_largest_connected_components(unsigned int nb_components_to_kee removes the face incident to `h` from `hds` and creates a hole. \pre `h != Halfedge_handle()` and `!(h->is_border())`. -If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +If faces are supported, `Supports_removal` must be `CGAL::Tag_true`. */ void make_hole( Halfedge_handle h); @@ -295,7 +295,7 @@ holes. Returns the predecessor of `h` around the face. The invariant the data structure unchanged. The time is proportional to the size of the face removed and the time to compute `h->prev()`. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. \image html euler_face.png \image latex euler_face.png @@ -326,7 +326,7 @@ and keeps the polyhedron unchanged. The time is proportional to the degree of the vertex removed and the time to compute `h->prev()` and `h->opposite()->prev()`. -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. \image html euler_vertex.png \image latex euler_vertex.png @@ -361,7 +361,7 @@ create_center_vertex(h))` holds if `h` is not a border halfedge. The time is proportional to the sum of the size of all incident faces. \pre None of the incident faces of `g->vertex()` is a hole. There are at least two distinct faces incident to the faces that are incident to `g->vertex()`. (This prevents the operation from collapsing a volume into two faces glued together with opposite orientations, such as would happen with any vertex of a tetrahedron.) -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. \image html euler_center.png \image latex euler_center.png @@ -396,7 +396,7 @@ by `g` gets removed. Both faces may be holes. The invariant data structure unchanged. \pre The faces denoted by `h` and `g` are different and have equal degree (i.e., number of edges). -Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +`Supports_removal` must be `CGAL::Tag_true`. \image html euler_loop.png \image latex euler_loop.png diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h index 62d48e4b3db..ebc2093435c 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/extremal_polygon_2.h @@ -146,7 +146,7 @@ where `K` is a model for `Kernel`. \tparam OutputIterator must accepts dereference/assignments of `Traits::Point_2`. -There is a global function `K::FT CGAL::sqrt(K::FT)` +There must be a global function `K::FT CGAL::sqrt(K::FT)` defined that computes the squareroot of a number. \sa `CGAL::maximum_area_inscribed_k_gon_2()` diff --git a/Kernel_d/doc/Kernel_d/CGAL/Epick_d.h b/Kernel_d/doc/Kernel_d/CGAL/Epick_d.h index de836ba632e..9be521a4af1 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Epick_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Epick_d.h @@ -59,7 +59,7 @@ Point_d(double x0, double x1, ...); /*! introduces a point with coordinate set `[first,end)`. \pre If `DimensionTag` is a fixed dimension, it matches `distance(first,end)`. - \tparam `InputIterator` has its value type that is convertible to `double`. + \tparam InputIterator has its value type that is convertible to `double`. */ template Point_d(InputIterator first, InputIterator end); @@ -79,7 +79,7 @@ Cartesian_const_iterator_d cartesian_end()const; struct Construct_circumcenter_d { /*! returns the center of the sphere defined by `A=tuple[first,last)`. The sphere is centered in the affine hull of A and passes through all the points of A. The order of the points of A does not matter. \pre A is affinely independant. - \tparam `ForwardIterator`has `Epick_d::Point_d` as value type. + \tparam ForwardIterator has `Epick_d::Point_d` as value type. */ template Point_d operator()(ForwardIterator first, ForwardIterator last); @@ -87,7 +87,7 @@ Point_d operator()(ForwardIterator first, ForwardIterator last); struct Compute_squared_radius_d { /*! returns the radius of the sphere defined by `A=tuple[first,last)`. The sphere is centered in the affine hull of A and passes through all the points of A. The order of the points of A does not matter. \pre A is affinely independant. - \tparam `ForwardIterator`has `Epick_d::Point_d` as value type. + \tparam ForwardIterator has `Epick_d::Point_d` as value type. */ template Point_d operator()(ForwardIterator first, ForwardIterator last); @@ -97,7 +97,7 @@ Point_d operator()(ForwardIterator first, ForwardIterator last); struct Side_of_bounded_sphere_d { /*! returns the relative position of point p to the sphere defined by `A=tuple[first,last)`. The sphere is centered in the affine hull of A and passes through all the points of A. The order of the points of A does not matter. \pre A is affinely independant. - \tparam `ForwardIterator`has `Epick_d::Point_d` as value type. + \tparam ForwardIterator has `Epick_d::Point_d` as value type. */ template Bounded_side operator()(ForwardIterator first, ForwardIterator last, const Point_d&p); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h index a198f4cea97..ed1b1ccb3aa 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h @@ -73,7 +73,7 @@ Direction_d(Vector_d v); introduces a variable `dir` of type `Direction_d` in dimension `d` with representation tuple `set [first,last)`. \pre `d` is nonnegative, `[first,last)` has `d` elements. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Direction_d(int d, InputIterator first, InputIterator last); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h index bf03ff9ace8..2de29de17ab 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h @@ -65,7 +65,7 @@ introduces a variable `h` of type `Hyperplane_d` initialized to the hyperplane with coefficients `set [first,last)` and `D`. \pre `size [first,last) == d`. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Hyperplane_d(int d, InputIterator first, InputIterator last, RT D); @@ -76,7 +76,7 @@ introduces a variable with coefficients `set [first,last)`. \pre `size [first,last) == d+1`. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Hyperplane_d(int d, InputIterator first, InputIterator last); @@ -88,7 +88,7 @@ some hyperplane that passes through the points in `set [first,last)`. If `side` constructed hyperplane. \pre A hyperplane with the stated properties must exist. -\tparam `ForwardIterator` has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template Hyperplane_d(ForwardIterator first, ForwardIterator last, diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h index 309998b61cf..772363a625b 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h @@ -80,7 +80,7 @@ specifies the homogeneous coordinates where the sign chosen is the sign of \f$ h_d\f$. \pre `d` is nonnegative, `[first,last)` has `d` or `d+1` elements where the last has to be non-zero. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Point_d(int d, InputIterator first, InputIterator last); @@ -94,7 +94,7 @@ initialized to the point with homogeneous coordinates as defined by The sign chosen is the sign of \f$ D\f$. \pre `D` is non-zero, the iterator range defines a \f$ d\f$-tuple of `RT`. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Point_d(int d, InputIterator first, InputIterator last, RT D); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h index 057db46f930..f1ec98e95a8 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h @@ -61,7 +61,7 @@ sphere through the points in `A = tuple [first,last)`. \pre \f$A\f$ consists of \f$d+1\f$ \f$d\f$-dimensional points. -\tparam `ForwardIterator` has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template Sphere_d(int d, ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h index 505cd3391ca..d09974defaa 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h @@ -87,7 +87,7 @@ coordinates `set [first,last)`. If `size [first,last) == p+1` the range specifie sign chosen is the sign of \f$ h_d\f$. \pre `d` is nonnegative, `[first,last)` has `d` or `d+1` elements where the last has to be non-zero. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Vector_d(int d, InputIterator first, InputIterator last); @@ -101,7 +101,7 @@ initialized to the vector with homogeneous coordinates as defined by chosen is the sign of \f$ D\f$. \pre `D` is non-zero, the iterator range defines a \f$ d\f$-tuple of `RT`. -\tparam `InputIterator`has `RT` as value type. +\tparam InputIterator has `RT` as value type. */ template Vector_d(int d, InputIterator first, InputIterator last, RT D); diff --git a/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h b/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h index 890acbf6d18..8f0612ceae1 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/constructions_d.h @@ -9,7 +9,7 @@ namespace CGAL { returns the center of the sphere spanned by the points in `A = tuple[first,last)`. \pre \f$ A\f$ contains \f$ d+1\f$ affinely independent points of dimension \f$ d\f$. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template Point_d center_of_sphere(ForwardIterator first, ForwardIterator last); @@ -34,7 +34,7 @@ it via an iterator range starting in `result`. The returned iterator marks the end of the output. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. -\tparam `ForwardIterator`has `Vector_d` as value type. +\tparam ForwardIterator has `Vector_d` as value type. */ template OutputIterator linear_base(ForwardIterator first, ForwardIterator diff --git a/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h b/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h index 16ebc2cd6dd..89f7889eb67 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/predicates_d.h @@ -10,7 +10,7 @@ returns true iff the points in `A = tuple [first,last)` are affinely independent. \pre The objects are of the same dimension. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template bool affinely_independent(ForwardIterator first, ForwardIterator last); @@ -22,7 +22,7 @@ affinely_independent(ForwardIterator first, ForwardIterator last); computes the affine rank of the points in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template int affine_rank(ForwardIterator first, ForwardIterator last); @@ -49,7 +49,7 @@ determines whether \f$ p\f$ is contained in the affine hull of the points in `A = tuple [first,last)`. \pre The objects in `A` are of the same dimension. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template bool contained_in_affine_hull( ForwardIterator first, ForwardIterator @@ -63,7 +63,7 @@ determines whether \f$ v\f$ is contained in the linear hull of the vectors in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension. -\tparam `ForwardIterator`has `Vector_d` as value type. +\tparam ForwardIterator has `Vector_d` as value type. */ template bool contained_in_linear_hull( ForwardIterator first, ForwardIterator @@ -78,7 +78,7 @@ simplex of the points in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension and affinely independent. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template bool contained_in_simplex( ForwardIterator first, ForwardIterator last, @@ -118,7 +118,7 @@ decides whether the vectors in `A = tuple [first,last)` are linearly independent. \pre The objects in `A` are of the same dimension. -\tparam `ForwardIterator`has `Vector_d` as value type. +\tparam ForwardIterator has `Vector_d` as value type. */ template bool linearly_independent( ForwardIterator first, ForwardIterator @@ -131,7 +131,7 @@ last); computes the linear rank of the vectors in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\tparam `ForwardIterator`has `Vector_d` as value type. +\tparam ForwardIterator has `Vector_d` as value type. */ template int linear_rank(ForwardIterator first, ForwardIterator last); @@ -150,7 +150,7 @@ where `A[i]` denotes the %Cartesian coordinate vector of the \f$ i\f$-th point in \f$ A\f$. \pre `size [first,last) == d+1` and `A[i].dimension() == d` \f$ \forall0 \leq i \leq d\f$. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template Orientation @@ -165,7 +165,7 @@ returns the relative position of point order of the points of \f$ A\f$ does not matter. \pre `orientation(first,last)` is not `ZERO`. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template Bounded_side side_of_bounded_sphere( ForwardIterator first, ForwardIterator last, @@ -182,7 +182,7 @@ constructed sphere. If the points in \f$ A\f$ are positively oriented, the positive side is the bounded interior of the sphere. \pre `A` contains \f$ d+1\f$ points in \f$ d\f$-space. -\tparam `ForwardIterator`has `Point_d` as value type. +\tparam ForwardIterator has `Point_d` as value type. */ template Oriented_side side_of_oriented_sphere( ForwardIterator first, ForwardIterator diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h index d861a327093..91511ae72f6 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h @@ -17,8 +17,7 @@ computes the affine rank of the points in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\cgalRequires The value type of `ForwardIterator` is `Kernel_d::Point_d`. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator is a model of `ForwardIterator` with `Kernel_d::Point_d` as value type. */ template int operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h index 1b97c42ad6a..e21b234cba0 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h @@ -18,7 +18,7 @@ independent. \pre The objects are of the same dimension. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template bool diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h index 26d027db42d..3e77d812631 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h @@ -14,7 +14,7 @@ public: returns the center of the sphere spanned by the points in `A = tuple [first,last)`. \pre \f$A\f$ contains \f$d+1\f$ affinely independent points of dimension \f$d\f$. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template Kernel_d::Point_d operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h index 291e0ed9d5e..41e162b7d60 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h @@ -17,7 +17,7 @@ determines whether \f$ p\f$ is contained in the affine hull of the points in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h index 5d61381b2a2..984148a9e19 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h @@ -16,7 +16,7 @@ public: determines whether \f$ v\f$ is contained in the linear hull of the vectors in `A = tuple [first,last)`. \pre The objects are of the same dimension. -\tparam `ForwardIterator`has `Kernel_d::Vector_d` as value type. +\tparam ForwardIterator has `Kernel_d::Vector_d` as value type. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h index 395d9e2f258..a072edc2c8b 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h @@ -17,7 +17,7 @@ determines whether \f$ p\f$ is contained in the simplex of the points in `A = tuple [first,last)`. \pre The objects in \f$ A\f$ are of the same dimension and affinely independent. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h index d2ba35eff9b..4ee9760f2bf 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h @@ -19,8 +19,8 @@ it via an iterator range starting in `result`. The returned iterator marks the end of the output. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. -\tparam `InputIterator`has `Kernel_d::Vector_d` as value type. -\tparam `OutputIterator`has `Kernel_d::Vector_d` as value type. +\tparam InputIterator has `Kernel_d::Vector_d` as value type. +\tparam OutputIterator accepts objects of type `Kernel_d::Vector_d`. */ template int diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h index 6e305a36860..2889538b7db 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h @@ -17,7 +17,7 @@ computes the linear rank of the vectors in `A = tuple [first,last)`. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. -\tparam `ForwardIterator`has `Kernel_d::Vector_d` as value type. +\tparam ForwardIterator has `Kernel_d::Vector_d` as value type. */ template int operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h index 6dc087af873..bd47de8f319 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h @@ -18,7 +18,7 @@ whether the vectors in `A = tuple [first,last)` are linearly independent. \pre The objects in `A` are of the same dimension. -\tparam `ForwardIterator`has `Kernel_d::Vector_d` as value type. +\tparam ForwardIterator has `Kernel_d::Vector_d` as value type. */ template bool operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h index 7b54e08db34..4a0babf310b 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h @@ -24,7 +24,7 @@ where `A[i]` denotes the %Cartesian coordinate vector of the \f$ i\f$-th point in \f$ A\f$. \pre `size [first,last) == d+1` and `A[i].dimension() == d` \f$ \forall0 \leq i \leq d\f$. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template Orientation operator()(ForwardIterator first, ForwardIterator last); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h index ab16e3c4e78..7f8bce2069e 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h @@ -18,7 +18,7 @@ returns the relative position of point order of the points of \f$ A\f$ does not matter. \pre `orientation(first,last)` is not `ZERO`. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template Bounded_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h index b8c9820ab09..755aaf43c93 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h @@ -20,7 +20,7 @@ sphere. If the points in \f$ A\f$ are positively oriented, the positive side is the bounded interior of the sphere. \pre `A` contains \f$ d+1\f$ points in \f$ d\f$-space. -\tparam `ForwardIterator`has `Kernel_d::Point_d` as value type. +\tparam ForwardIterator has `Kernel_d::Point_d` as value type. */ template Oriented_side operator()( ForwardIterator first, ForwardIterator last, const diff --git a/Kernel_d/doc/Kernel_d/Concepts/Vector.h b/Kernel_d/doc/Kernel_d/Concepts/Vector.h index 3591a27dd69..f9a74174b0c 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Vector.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Vector.h @@ -60,7 +60,7 @@ Vector(int d, NT x); creates an instance `v` of type `Vector`; `v` is initialized to the vector with entries `set [first,last)`. -\tparam `ForwardIterator`has `NT` as value type. +\tparam ForwardIterator has `NT` as value type. */ template Vector(Forward_iterator first, Forward_iterator last); diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index f3aa0a0a6be..4761f703302 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -8,7 +8,7 @@ The class `Dynamic_matrix` is an adaptor for an arbitrary matrix class `M` to provide the dynamic operations needed for monotone matrix search. -\tparam `M` is a model for `BasicMatrix`. +\tparam `M` is a model of `BasicMatrix`. \cgalModels `MonotoneMatrixSearchTraits` \cgalModels `BasicMatrix` diff --git a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h index 7d4a430c541..a62799d1a10 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h @@ -36,8 +36,8 @@ monotone). \pre `t` points to a structure of size at least `m.number_of_rows()` -\tparam `Matrix` is a model for `MonotoneMatrixSearchTraits`. -\tparam `RandomAccessIc`has `int` as value type. +\tparam Matrix is a model of `MonotoneMatrixSearchTraits`. +\tparam RandomAccessIC is a model of `RandomAccessIterator` with `int` as value type. If `compare_strictly` is defined, it is an adaptable binary function: `Matrix::Value` \f$ \times\f$ `Matrix::Value` \f$ \rightarrow\f$ `bool` describing a strict diff --git a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h index 066ddd9a487..f54578520b4 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h @@ -45,8 +45,8 @@ to `Traits::compare_non_strictly`. true. -\tparam `Traits` is a model for `SortedMatrixSearchTraits`. -\tparam `RandomAccessIterator`has `Traits::Matrix` as value type. +\tparam Traits is a model for `SortedMatrixSearchTraits`. +\tparam RandomAccessIterator has `Traits::Matrix` as value type. \cgalHeading{Implementation} diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h index 495895854cb..9486a19f02d 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h @@ -267,11 +267,10 @@ constrained edges of `t`, except for the unbounded component. \tparam CDT must be 2D constrained Delaunay triangulation and its geometric traits class must be a model of `DelaunayMeshTraits_2`. +The face of the constrained Delaunay triangulation must be a model of the concept `DelaunayMeshFaceBase_2`. \tparam Criteria must be a model of the concept `MeshingCriteria_2`. - -The face of the constrained Delaunay triangulation must be a model of the concept `DelaunayMeshFaceBase_2`. -`CDT::Face_handle` must be the same as `Criteria::Face_handle`. +`Criteria::Face_handle` must be the same as `CDT::Face_handle`. */ template void refine_Delaunay_mesh_2 (CDT &t, const Criteria& criteria = Criteria()); @@ -297,12 +296,12 @@ never meshed. \tparam CDT must be 2D constrained Delaunay triangulation and its geometric traits class must be a model of `DelaunayMeshTraits_2`. +The face of the constrained Delaunay triangulation must be a model of the concept `DelaunayMeshFaceBase_2`. \tparam Criteria must be a model of the concept `MeshingCriteria_2`. +`Criteria::Face_handle` must be the same as `CDT::Face_handle`. \tparam InputIterator must be an input iterator with value type `CDT::Geom_traits::Point_2`. -The face of the constrained Delaunay triangulation must be a model of the concept `DelaunayMeshFaceBase_2`. -`CDT::Face_handle` must be the same as `Criteria::Face_handle`. */ template diff --git a/Polygon/include/CGAL/Polygon_2_algorithms.h b/Polygon/include/CGAL/Polygon_2_algorithms.h index e4f35cd423c..52478f0f9d0 100644 --- a/Polygon/include/CGAL/Polygon_2_algorithms.h +++ b/Polygon/include/CGAL/Polygon_2_algorithms.h @@ -49,10 +49,10 @@ namespace CGAL { /// `[first,last)`. In case of a tie, the point /// with the smallest `y`-coordinate is taken. /// -/// \tparam `Traits` is a model of the concept `PolygonTraits_2`. +/// \tparam Traits is a model of the concept `PolygonTraits_2`. /// Only the members `Less_xy_2` and /// `less_xy_2_object()` are used. -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// /// /// \sa `CGAL::right_vertex_2()` @@ -68,11 +68,11 @@ ForwardIterator left_vertex_2(ForwardIterator first, /// `[first,last)`. In case of a tie, the point /// with the largest `y`-coordinate is taken. /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// In fact, only the members `Less_xy_2` and /// `less_xy_2_object()` are used. -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have`Traits::Point_2` as value type. /// /// /// \sa `CGAL::left_vertex_2()` @@ -88,11 +88,11 @@ ForwardIterator right_vertex_2(ForwardIterator first, /// `[first,last)`. In case of a tie, the point /// with the largest `x`-coordinate is taken. /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the members `Less_yx_2` and /// `less_yx_2_object()` are used. -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// /// \sa `CGAL::left_vertex_2()` /// \sa `CGAL::right_vertex_2()` @@ -107,11 +107,11 @@ ForwardIterator top_vertex_2(ForwardIterator first, /// `[first,last)`. In case of a tie, the point /// with the smallest `x`-coordinate is taken. /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the members `Less_yx_2` and /// `less_yx_2_object()` are used. -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// /// \sa `CGAL::left_vertex_2()` /// \sa `CGAL::right_vertex_2()` @@ -130,14 +130,14 @@ ForwardIterator bottom_vertex_2(ForwardIterator first, /// The functionality is also available by the `polygon_area_2()` function, which /// returns the area instead of taking it as a parameter. /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Compute_area_2` : Computes the signed area of the /// oriented triangle defined by 3 `Point_2` passed as arguments. /// - `FT` /// - `compute_area_2_object()` -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// /// \sa `CGAL::polygon_area_2()` /// \sa `PolygonTraits_2` @@ -170,12 +170,12 @@ area_2( ForwardIterator first, ForwardIterator last, /// The sign is positive for counterclockwise polygons, negative for /// clockwise polygons. If the polygon is not simple, the area is not well defined. /// -/// \tparam `Traits` is a model of the concept `PolygonTraits_2`. Only the following members of this traits class are used: +/// \tparam Traits is a model of the concept `PolygonTraits_2`. Only the following members of this traits class are used: /// - `Compute_area_2` : Computes the signed area of the /// oriented triangle defined by 3 `Point_2` passed as arguments. /// - `FT` /// - `compute_area_2_object` -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// /// /// \sa `PolygonTraits_2 ` @@ -205,14 +205,14 @@ polygon_area_2( ForwardIterator first, ForwardIterator last, /// Checks if the polygon is convex. /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Less_xy_2` /// - `Orientation_2` /// - `less_xy_2_object` /// - `orientation_2_object` -/// \tparam `ForwardIterator` must have`PolygonTraits::Point_2` as value type. +/// \tparam ForwardIterator must have `PolygonTraits::Point_2` as value type. /// /// \sa `PolygonTraits_2 ` /// \sa `CGAL::Polygon_2 ` @@ -225,7 +225,7 @@ bool is_convex_2(ForwardIterator first, /// iterator range `[first,last)` is simple, that is, if the edges /// do not intersect, except consecutive edges in their common vertex. /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Point_2` @@ -233,7 +233,7 @@ bool is_convex_2(ForwardIterator first, /// - `Orientation_2` /// - `less_xy_2_object()` /// - `orientation_2_object()` -/// \tparam `ForwardIterator` must have`PolygonTraits::Point_2` as value type. +/// \tparam ForwardIterator must have `PolygonTraits::Point_2` as value type. /// /// ### Implementation## /// @@ -253,7 +253,7 @@ bool is_simple_2(ForwardIterator first, // instead of Point, but this is not allowed by g++ 2.7.2. /// /// Computes on which side of a polygon a point lies. -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Less_xy_2` @@ -264,7 +264,7 @@ bool is_simple_2(ForwardIterator first, /// - `compare_x_2_object()` /// - `compare_y_2_object()` /// - `orientation_2_object()` -/// \tparam `ForwardIterator` must have`PolygonTraits::Point_2` as value type. +/// \tparam ForwardIterator must have `PolygonTraits::Point_2` as value type. /// /// \sa `PolygonTraits_2` /// \sa `CGAL::bounded_side_2()` @@ -287,7 +287,7 @@ Oriented_side oriented_side_2(ForwardIterator first, /// According to the definition points in the bounded region are inside the polygon. /// /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Compare_x_2` @@ -296,7 +296,7 @@ Oriented_side oriented_side_2(ForwardIterator first, /// - `compare_x_2_object()` /// - `compare_y_2_object()` /// - `orientation_2_object()` -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have `Traits::Point_2` as value type. /// /// ### Implementation ### /// @@ -319,13 +319,13 @@ Bounded_side bounded_side_2(ForwardIterator first, /// Computes if a polygon is clockwise or counterclockwise oriented. /// \pre `is_simple_2(first, last, traits);` /// -/// \tparam `Traits` is a model of the concept +/// \tparam Traits is a model of the concept /// `PolygonTraits_2`. /// Only the following members of this traits class are used: /// - `Less_xy_2` /// - `less_xy_2_object()` /// - `orientation_2_object()` -/// \tparam `ForwardIterator` must have`Traits::Point_2` as value type. +/// \tparam ForwardIterator must have`Traits::Point_2` as value type. /// /// /// diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h index ab293e3b39e..ab3e8b97404 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h @@ -1238,7 +1238,7 @@ public: facet removed and the time to compute `h->%prev()`. \pre The degree of both vertices incident to `h` is at least three (no antennas). - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + `Supports_removal` must be `CGAL::Tag_true`. \image html euler_facet.png \image latex euler_facet.png @@ -1284,7 +1284,7 @@ n */ the time to compute `h->%prev()` and `h->%opposite()->%prev()`. \pre The size of both facets incident to `h` is at least four (no multi-edges). - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + `Supports_removal` must be `CGAL::Tag_true`. \image html euler_vertex.png \image latex euler_vertex.png @@ -1338,7 +1338,7 @@ n */ The time is proportional to the sum of the size of all incident facets. \pre None of the incident facets of `g->vertex()` is a hole. There are at least two distinct facets incident to the facets that are incident to `g->vertex()`. (This prevents the operation from collapsing a volume into two facets glued together with opposite orientations, such as would happen with any vertex of a tetrahedron.) - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + `Supports_removal` must be `CGAL::Tag_true`. \image html euler_center.png \image latex euler_center.png @@ -1375,7 +1375,7 @@ n */ polyhedron unchanged. \pre The facets denoted by `h` and `g` are different and have equal degree (i.e., number of edges). - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + `Supports_removal` must be `CGAL::Tag_true`. \image html euler_loop.png \image latex euler_loop.png @@ -1395,7 +1395,7 @@ n */ See `erase_facet(h)` for a more generalized variant. \pre None of the incident halfedges of the facet is a border edge. - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + `Supports_removal` must be `CGAL::Tag_true`. */ Halfedge_handle make_hole( Halfedge_handle h); @@ -1450,7 +1450,7 @@ n */ See `make_hole(h)` for a more specialized variant. \pre `h->is_border() == false`. - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true` + `Supports_removal` must be `CGAL::Tag_true` \image html add_facet1.png \image latex add_facet1.png @@ -1464,7 +1464,7 @@ n */ removes the vertices, halfedges, and facets that belong to the connected component of `h`. - Requires : `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + `Supports_removal` must be `CGAL::Tag_true`. */ void erase_connected_component( Halfedge_handle h); @@ -1473,7 +1473,7 @@ n */ Keep `nb_components_to_keep` largest connected components. Returns the number of connected components erased (ignoring isolated vertices). - Requires : supports vertices, halfedges, and removal operation. + The polyhedron type must support vertices, halfedges, and removal operations. */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h index ddf390f704b..d156904ed69 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h @@ -131,8 +131,8 @@ std::ostream& stream = std::cout); initializes `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ and \f$ Q\f$ being the sets of points in the range [`p_first`,`p_last`) and [`q_first`,`q_last`), respectively. -@tparam `InputIterator1` has `Point` as value type. -@tparam `InputIterator2` has `Point` as value type. +\tparam InputIterator1 has `Point` as value type. +\tparam InputIterator2 has `Point` as value type. \pre All points have the same dimension. \attention If `verbose` is set to \f$ 1\f$, \f$ 2\f$, or @@ -271,7 +271,7 @@ Support_point_index_iterator support_points_q_indices_end( ) const; /*! returns the realizing point of \f$ P\f$. -Requires : An implicit conversion from `ET` to `RT` is available. +An implicit conversion from `ET` to `RT` must be available. \pre \f$ pd(P,Q)\f$ is finite. */ Point realizing_point_p( ) const; @@ -279,7 +279,7 @@ Point realizing_point_p( ) const; /*! returns the realizing point of \f$ Q\f$. -Requires : An implicit conversion from `ET` to `RT` is available. +An implicit conversion from `ET` to `RT` must be available. \pre \f$ pd(P,Q)\f$ is finite. */ Point realizing_point_q( ) const; @@ -287,7 +287,7 @@ Point realizing_point_q( ) const; /*! returns the squared distance of `poly_dist`, i.e.\ \f$ (pd(P,Q))^2\f$. -Requires : An implicit conversion from `ET` to `RT` is available. +An implicit conversion from `ET` to `RT` must be available. \pre \f$ pd(P,Q)\f$ is finite. */ FT squared_distance( ) const; @@ -388,8 +388,8 @@ void clear( ); sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ and \f$ Q\f$ being the sets of points in the ranges [`p_first`,`p_last`) and [`q_first`,`q_last`), respectively. -@tparam `InputIterator1` has `Point` as value type. -@tparam `InputIterator2` has `Point` as value type. +\tparam InputIterator1 has `Point` as value type. +\tparam InputIterator2 has `Point` as value type. \pre All points have the same dimension. */ template < class InputIterator1, class InputIterator2 > @@ -402,7 +402,7 @@ InputIterator2 q_last ); sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ being the set of points in the range [`p_first`,`p_last`) (\f$ Q\f$ remains unchanged). -@tparam `InputIterator` has `Point` as value type. +\tparam InputIterator has `Point` as value type. \pre All points in \f$ P\f$ have dimension `poly_dist``.ambient_dimension()` if \f$ Q\f$ is not empty. */ template < class InputIterator > @@ -413,7 +413,7 @@ InputIterator p_last ); sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ Q\f$ being the set of points in the range [`q_first`,`q_last`) (\f$ P\f$ remains unchanged). -@tparam `InputIterator` has `Point` as value type. +\tparam InputIterator has `Point` as value type. \pre All points in \f$ Q\f$ have dimension `poly_dist``.ambient_dimension()` if \f$ P\f$ is not empty. */ template < class InputIterator > @@ -439,8 +439,8 @@ void insert_q( const Point& q); inserts the points in the range [`p_first`,`p_last`) and [`q_first`,`q_last`) into \f$ P\f$ and \f$ Q\f$, respectively, and recomputes the (squared) distance. -@tparam `InputIterator1` has `Point` as value type. -@tparam `InputIterator2` has `Point` as value type. +\tparam InputIterator1 has `Point` as value type. +\tparam InputIterator2 has `Point` as value type. \pre All points have the same dimension. If `poly_dist` is not \f$ pd(\emptyset, \emptyset)\f$, this dimension must be equal to `poly_dist``.ambient_dimension()`. */ template < class InputIterator1, class InputIterator2 > @@ -453,7 +453,7 @@ InputIterator2 q_last ); inserts the points in the range [`p_first`,`p_last`) into \f$ P\f$ and recomputes the (squared) distance (\f$ Q\f$ remains unchanged). -@tparam `InputIterator` has `Point` as value type. +\tparam InputIterator has `Point` as value type. \pre All points have the same dimension. If `poly_dist` is not empty, this dimension must be equal to `poly_dist``.ambient_dimension()`. */ template < class InputIterator > @@ -464,7 +464,7 @@ InputIterator p_last ); inserts the points in the range [`q_first`,`q_last`) into \f$ Q\f$ and recomputes the (squared) distance (\f$ P\f$ remains unchanged). -@tparam `InputIterator` has `Point` as value type. +\tparam InputIterator has `Point` as value type. \pre All points have the same dimension. If `poly_dist` is not empty, this dimension must be equal to `poly_dist``.ambient_dimension()`. */ template < class InputIterator > @@ -512,7 +512,7 @@ const Traits& traits( ) const; /*! writes `poly_dist` to output stream `os`. -Requires : The output operator is defined for `Point_d`. +An overload of `operator<<` must be defined for `Point_d`. \relates Polytope_distance_d */ std::ostream& @@ -521,7 +521,7 @@ operator << ( std::ostream& os, const Polytope_distance_d& poly_dist); /*! reads `poly_dist` from input stream `is`. -Requires : The input operator is defined for `Point_d`. +An overload of `operator>>` must be defined for `Point_d`. \relates Polytope_distance_d */ std::istream& diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h index 392d553a35e..faf013b2eb8 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h @@ -126,7 +126,7 @@ creates a variable `width` initialized to the width of \f$ \mathcal{S}\f$ - with \f$ \mathcal{S}\f$ being the set of points in the range [`first`,`beyond`). -\tparam `InputIterator` has `Point_3` as value type. +\tparam InputIterator has `Point_3` as value type. */ template < class InputIterator > Width_3( InputIterator first, InputIterator beyond); @@ -137,7 +137,7 @@ the width of the polyhedron \f$ P\f$. Note that the vertex point coordinates are altered! \pre \f$ P\f$ is a convex polyhedron. -`Polyhedron` is a +\tparam Polyhedron is a `CGAL::Polyhedron_3` with facets supporting plane equations where `Polyhedron::Point_3` \f$ \equiv\f$ `Point_3` and `Polyhedron::Plane_3` \f$ \equiv\f$ `Plane_3`. diff --git a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h index 39ad4e0a162..8e45865e4ad 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h +++ b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/barycenter.h @@ -33,7 +33,7 @@ CGAL::Kernel_traits< >::Kernel \endcode -\tparam `InputIterator` must have +\tparam InputIterator must have `std::pair` or `std::pair as value type`. \pre first != beyond, and the sum of the weights is non-zero. @@ -50,7 +50,7 @@ points. \returns `K::Point_2` or `K::Point_3` depending on the dimension of the input values. -\tparam `InputIterator` must have +\tparam InputIterator must have `std::pair` or `std::pair` as value type. \pre first != beyond, and the sum of the weights is non-zero. diff --git a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h index 3ceb6d900f7..b7a18cdbf5f 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h +++ b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h @@ -75,11 +75,11 @@ especially for large and/or complex sequences. second component refers to the maximal element in the range [`first`, `last`). -\tparam `CompareMin` is an adaptable binary +\tparam CompareMin is an adaptable binary function object: `VT` \f$ \times\f$ `VT` \f$ \rightarrow\f$ `bool` where `VT` is the value type of `ForwardIterator`. -\tparam `CompareMax` is an adaptable binary +\tparam CompareMax is an adaptable binary function object: `VT` \f$ \times\f$ `VT` \f$ \rightarrow\f$ `bool` where `VT` is the value type of `ForwardIterator`. */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/iterator.h b/STL_Extension/doc/STL_Extension/CGAL/iterator.h index 7f67876d5e9..579e75de155 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/iterator.h +++ b/STL_Extension/doc/STL_Extension/CGAL/iterator.h @@ -401,7 +401,7 @@ additional argument. \cgalModels `OutputIterator` -\tparam `Container` provides a member function `insert(const Container::const_reference&)`. +\tparam Container provides a member function `insert(const Container::const_reference&)`. */ template< typename Container > diff --git a/STL_Extension/doc/STL_Extension/CGAL/utility.h b/STL_Extension/doc/STL_Extension/CGAL/utility.h index e5570b96067..b8e2d1c5b2a 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/utility.h +++ b/STL_Extension/doc/STL_Extension/CGAL/utility.h @@ -161,7 +161,7 @@ constructs a quadruple such that constructed from `v`, `third` is constructed from `w`, 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`. +Proper conversion operators must exist from `U` to `T1`, `V` to `T2`, `W` to `T3`, and `X` to `T4`. */ template Quadruple(U u, V v, W w, X x); @@ -357,7 +357,7 @@ 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`. -Requires : Proper conversion operators exist from `U` to `T1`, `V` to `T2`, and `W` to `T3`. +Proper conversion operators must exist from `U` to `T1`, `V` to `T2`, and `W` to `T3`. */ template Triple(U u, V v, W w); diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h index 92495017174..a3c2cea1fc0 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h @@ -31,7 +31,7 @@ Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double /*! It sorts the range `[begin, end)`. -Requires : `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined. +`Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` must be defined. */ template void operator() (RandomAccessIterator begin, RandomAccessIterator end) const;