Merge pull request #7412 from HoffmannMichael/Kernel23-epic_trivial_c…

…onstructions_doc-mh

Document exactness of constructions in Epick

Documentation/doc/resources/1.10.0/BaseDoxyfile.in

@@ -212,7 +212,8 @@ ALIASES                = "cgal=%CGAL" \
                          "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
                          "cgalBigO{1}=\f$O(\1)\f$" \
                          "cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
-                         "cgalInclude{1}=`#include<\1>`"
+                         "cgalInclude{1}=`#include<\1>`" \
+                         "cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"
 
 # Doxygen selects the parser to use depending on the extension of the files it
 # parses. With this tag you can assign which parser to use for a given

Documentation/doc/resources/1.8.13/BaseDoxyfile.in

@@ -203,7 +203,8 @@ ALIASES                = "cgal=%CGAL" \
                          "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
                          "cgalBigO{1}=\f$O(\1)\f$" \
                          "cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
-                         "cgalInclude{1}=\#`include<\1>`"
+                         "cgalInclude{1}=\#`include<\1>`" \
+                         "cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"
 
 # Doxygen selects the parser to use depending on the extension of the files it
 # parses. With this tag you can assign which parser to use for a given

Documentation/doc/resources/1.9.6/BaseDoxyfile.in

@@ -212,7 +212,8 @@ ALIASES                = "cgal=%CGAL" \
                          "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
                          "cgalBigO{1}=\f$O(\1)\f$" \
                          "cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
-                         "cgalInclude{1}=`#include<\1>`"
+                         "cgalInclude{1}=`#include<\1>`" \
+                         "cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"
 
 # Doxygen selects the parser to use depending on the extension of the files it
 # parses. With this tag you can assign which parser to use for a given

Kernel_23/doc/Kernel_23/CGAL/Circle_2.h

@@ -28,6 +28,8 @@ It is initialized to the circle with center `center`,
 squared radius `squared_radius` and orientation
 `ori`.
 \pre `ori != COLLINEAR` and `squared_radius >= 0`.
+
+\cgalEpicExact
 */
 Circle_2(const Point_2<Kernel> &center,
 const Kernel::FT &squared_radius,
@@ -64,6 +66,8 @@ It is initialized to the circle with center `center`, squared
 radius zero and orientation `ori`.
 \pre `ori != COLLINEAR`.
 \post `c.is_degenerate()` = `true`.
+
+\cgalEpicExact
 */
 Circle_2( const Point_2<Kernel> &center,
           const Orientation &ori = COUNTERCLOCKWISE);
@@ -76,18 +80,21 @@ Circle_2( const Point_2<Kernel> &center,
 /*!
 
 returns the center of `c`.
+\cgalEpicExact
 */
 const Point_2<Kernel> &center( ) const;
 
 /*!
 
 returns the squared radius of `c`.
+\cgalEpicExact
 */
 const Kernel::FT& squared_radius( ) const;
 
 /*!
 
 returns the orientation of `c`.
+\cgalEpicExact
 */
 Orientation orientation( ) const;
 
@@ -171,6 +178,7 @@ bool has_on_unbounded_side(const Point_2<Kernel> &p) const;
 
 returns the circle with the same center and squared radius as
 `c` but with opposite orientation.
+\cgalEpicExact
 */
 Circle_2<Kernel> opposite() const;
 

Kernel_23/doc/Kernel_23/CGAL/Circle_3.h

@@ -22,6 +22,8 @@ introduces a variable `c` of type `Circle_3`.
 It is initialized to the circle of center `center` and
 squared radius `sq_r` in plane `plane`.
 \pre `center` lies in `plane` and `sq_r >= 0`.
+
+\cgalEpicExact
 */
 Circle_3(const Point_3<Kernel> &center,
          const Kernel::FT &sq_r,
@@ -60,7 +62,7 @@ It is initialized to the circle along which the sphere and the
 plane intersect.
 \pre The sphere and the plane intersect along a circle.
 */
-  Circle_3(constSphere_3<Kernel> & sphere,
+  Circle_3(const Sphere_3<Kernel> & sphere,
            const Plane_3<Kernel> & plane);
 
 /*!
@@ -80,24 +82,28 @@ Circle_3(const Plane_3<Kernel> & plane,
 /*!
 
 returns the center of `c`.
+\cgalEpicExact
 */
 const Point_3<Kernel> & center( ) const;
 
 /*!
 
 returns the squared radius of `c`.
+\cgalEpicExact
 */
 const Kernel::FT & squared_radius( ) const;
 
 /*!
 
 returns the supporting plane of `c`.
+\cgalEpicExact
 */
 const Plane_3<Kernel> & supporting_plane( ) const;
 
 /*!
 
 returns the diametral sphere of `c`.
+\cgalEpicExact
 */
 const Sphere_3<Kernel> & diametral_sphere( ) const;
 

Kernel_23/doc/Kernel_23/CGAL/Direction_2.h

@@ -26,6 +26,7 @@ class Direction_2 {
 
 /*!
 introduces the direction `d` of vector `v`.
+\cgalEpicExact
 */
 Direction_2(const Vector_2<Kernel> &v);
 
@@ -47,6 +48,7 @@ Direction_2(const Segment_2<Kernel> &s);
 /*!
 introduces a direction `d` passing through the origin
 and the point with %Cartesian coordinates \f$ (x, y)\f$.
+\cgalEpicExact
 */
 Direction_2(const Kernel::RT &x, const Kernel::RT &y);
 
@@ -61,16 +63,20 @@ Direction_2(const Kernel::RT &x, const Kernel::RT &y);
 /*!
 returns values, such that `d``== Direction_2<Kernel>(delta(0),delta(1))`.
 \pre `0 <= i <= 1`.
+
+\cgalEpicExact
 */
 Kernel::RT delta(int i) const;
 
 /*!
 returns `delta(0)`.
+\cgalEpicExact
 */
 Kernel::RT dx() const;
 
 /*!
 returns `delta(1)`.
+\cgalEpicExact
 */
 Kernel::RT dy() const;
 

Kernel_23/doc/Kernel_23/CGAL/Direction_3.h

@@ -26,6 +26,7 @@ class Direction_3 {
 /*!
 introduces a direction `d` initialized with the
 direction of vector `v`.
+\cgalEpicExact
 */
 Direction_3(const Vector_3<Kernel> &v);
 
@@ -47,6 +48,7 @@ Direction_3(const Segment_3<Kernel> &s);
 /*!
 introduces a direction `d` initialized with the direction
 from the origin to the point with %Cartesian coordinates \f$ (x, y, z)\f$.
+\cgalEpicExact
 */
 Direction_3(const Kernel::RT &x, const Kernel::RT &y, const Kernel::RT &z);
 
@@ -58,21 +60,26 @@ Direction_3(const Kernel::RT &x, const Kernel::RT &y, const Kernel::RT &z);
 /*!
 returns values, such that `d``== Direction_3<Kernel>(delta(0),delta(1),delta(2))`.
 \pre `0 <= i <= 2`.
+
+\cgalEpicExact
 */
 Kernel::RT delta(int i) const;
 
 /*!
 returns `delta(0)`.
+\cgalEpicExact
 */
 Kernel::RT dx() const;
 
 /*!
 returns `delta(1)`.
+\cgalEpicExact
 */
 Kernel::RT dy() const;
 
 /*!
 returns `delta(2)`.
+\cgalEpicExact
 */
 Kernel::RT dz() const;
 
@@ -88,11 +95,13 @@ bool operator!=(const Direction_3<Kernel> &e) const;
 
 /*!
 The direction opposite to `d`.
+\cgalEpicExact
 */
 Direction_3<Kernel> operator-() const;
 
 /*!
 returns a vector that has the same direction as `d`.
+\cgalEpicExact
 */
 Vector_3<Kernel> vector() const;