diff --git a/Kernel_23/doc/Kernel_23/CGAL/global_functions.h b/Kernel_23/doc/Kernel_23/CGAL/global_functions.h index 4567ef71049..d224af4f10e 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/global_functions.h +++ b/Kernel_23/doc/Kernel_23/CGAL/global_functions.h @@ -615,7 +615,7 @@ const Point_3& r); -/// \addtogroup compare_lexicographically compare_lexicographically +/// \addtogroup compare_lexicographically_linear compare_lexicographically /// \ingroup PkgKernel23 /// @{ @@ -826,7 +826,7 @@ described below. /// @{ /*! -\name With the basic 2D and 3D Kernel +\addtogroup compare_x_linear With the 2D and 3D linear kernel. \anchor figcompare_x \image html compare1.gif */ @@ -874,7 +874,7 @@ Comparison_result compare_x(const Line_2 &l1, /// @} /*! -\name With the 2D Circular Kernel +\addtogroup compare_x_circular With the 2D Circular Kernel See Chapter \ref chaptercircularkernel. @@ -903,7 +903,7 @@ Comparison_result /// @} /*! -\name compare_x with the 3D Spherical Kernel +\addtogroup compare_y_spherical With the 3D Spherical Kernel See Chapter \ref chaptersphericalkernel. @@ -949,24 +949,25 @@ global function are available. This is described below. \sa `CGAL::compare_y_at_x` \sa `CGAL::compare_z` -With the basic 2D and 3D Kernel (see Chapter \ref chapterkernel23) +*/ +/// @{ + +/*! +\addtogroup compare_xy_linear With the 2D and 3D linear kernel. */ /// @{ /*! - Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ xy\f$ order: first \f$ x\f$-coordinates are compared, if they are equal, \f$ y\f$-coordinates are compared. - */ Comparison_result compare_xy(const Point_2& p, const Point_2& q); /*! - Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ xy\f$ order: first \f$ x\f$-coordinates are compared, if they are equal, \f$ y\f$-coordinates are compared. @@ -975,8 +976,11 @@ compared, if they are equal, \f$ y\f$-coordinates are compared. Comparison_result compare_xy(const Point_3& p, const Point_3& q); +/// @} + /*! -\name With the 2D Circular Kernel +\addtogroup compare_xy_circular With the 3D Circular Kernel + See Chapter \ref chaptercircularkernel. \code @@ -1008,7 +1012,7 @@ compare_xy(const Circular_arc_point_2 &p, /// @} /*! -\name With the 3D Spherical Kernel +\addtogroup compare_xy_spherical With the 3D Spherical Kernel See Chapter \ref chaptersphericalkernel. \code @@ -1361,6 +1365,11 @@ global function are available. This is described below. */ /// @{ +/*! +\addtogroup compare_xyz_linear With the 2D and 3D linear kernel. +*/ +/// @{ + /*! Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ xyz\f$ order: first @@ -1371,8 +1380,10 @@ are compared, and if both \f$ x\f$- and \f$ y\f$- coordinate are equal, Comparison_result compare_xyz(const Point_3& p, const Point_3& q); +/// @} + /*! -\name With the 3D Spherical Kernel +\addtogroup compare_xyz_spherical with the 3D Spherical Kernel See Chapter \ref chaptersphericalkernel \code diff --git a/Kernel_23/doc/Kernel_23/CGAL/intersections.h b/Kernel_23/doc/Kernel_23/CGAL/intersections.h index 8bc3d824b82..8a50ddadd72 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/intersections.h +++ b/Kernel_23/doc/Kernel_23/CGAL/intersections.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\addtogroup do_intersect do_intersect +\addtogroup do_intersect_linear do_intersect \ingroup PkgKernel23 Depending on which \cgal kernel is used, different versions of this @@ -45,7 +45,7 @@ Also, `Type1` and `Type2` can be respectively of types - `Plane_3` and `Sphere_3` (or the contrary) - `Sphere_3` and `Sphere_3`. -## With the 2D Circular Kernel ## +## With the 2D Circular %Kernel ## See Chapter \ref chaptercircularkernel @@ -128,6 +128,22 @@ bool do_intersect(Type1 obj1, Type2 obj2, Type3 obj3); Depending on which \cgal kernel is used, different versions of this global function are available. +/// @{ + +/*! +\addtogroup intersection_linear With the 2D and 3D linear kernel. + + + +\sa `CGAL::do_intersect` +\sa `CGAL::Object` + + +## With the 2D and 3D Linear %Kernel ## +See Chapter \ref chapterkernel23 +*/ +/// @{ + Example -------------- @@ -156,13 +172,6 @@ Circular %Kernel and the 3D Spherical %Kernel are presented respectively in Chapters \ref chaptercircularkernel and \ref chaptersphericalkernel. -\sa `CGAL::do_intersect` -\sa `CGAL::Object` - -## With the 2D and 3D Linear %Kernel ## -See Chapter \ref chapterkernel23 -*/ -/// @{ /*! Two objects `obj1` and `obj2` intersect if there is a point `p` that @@ -365,9 +374,10 @@ Object intersection(const Plane_3& pl1, const Plane_3& pl2, const Plane_3& pl3); +/// @} /*! -\name With the 2D Circular Kernel +\addtogroup intersection_circular With the 2D Circular %Kernel See Chapter \ref chaptercircularkernel @@ -421,7 +431,7 @@ intersection(const Type1 &obj1, const Type2 &obj2, /// @} /*! -\name With the 3D Circular Kernel +\addtogroup intersection_spherical With the 3D Spherical %Kernel See Chapter \ref chaptersphericalkernel @@ -510,4 +520,6 @@ intersection(const Type1 &obj1, const Type2 &obj2, const Type3 &obj3, /// @} + +/// @} } diff --git a/Kernel_23/doc/Kernel_23/Kernel_23.txt b/Kernel_23/doc/Kernel_23/Kernel_23.txt index 7cd032d99f5..c536f35b0b6 100644 --- a/Kernel_23/doc/Kernel_23/Kernel_23.txt +++ b/Kernel_23/doc/Kernel_23/Kernel_23.txt @@ -75,7 +75,7 @@ and storage space. See the dedicated chapter for more details on number types and their capabilities and performance. -# %Kernel Representations # {#kernel_rep} +# Kernel Representations # {#kernel_rep} Our object of study is the \f$ d\f$-dimensional affine Euclidean space. Here we are mainly concerned with cases \f$ d=2\f$ and \f$ d=3\f$. @@ -145,7 +145,7 @@ weaker. This type must fulfill the requirements on what is called a defined with semantics (approximately) corresponding to those of a ring in a mathematical sense. -## %Cartesian %Kernels ## +## %Cartesian Kernels ## With `Cartesian` you can choose a %Cartesian representation of coordinates. When you @@ -355,7 +355,7 @@ q = p_1 + (p_2 - p_1) / 2.0; Note that these constructions do not involve any performance overhead for the conversion with the currently available representation classes. -## Kernel Objects ## +## %Kernel Objects ## Besides points (`Point_2`, `Point_3`, `Point_d`), vectors (`Vector_2`, `Vector_3`), and