From 37aed3d31a42f417d804ebd2f47d7eff1259f9f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Wed, 28 Aug 2019 09:47:43 +0200 Subject: [PATCH] Fix documentation of functor `ConstructLiftedPoint_3` --- .../Concepts/FunctionObjectConcepts.h | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h index f210a1f8c24..ebdf81c1a44 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h +++ b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h @@ -4701,8 +4701,8 @@ public: \cgalRefines `AdaptableFunctor` (with two arguments) - \sa `CGAL::Plane_3` - + \sa `CGAL::Plane_3` + \sa `ConstructProjectedXYPoint_2` */ class ConstructLiftedPoint_3 { public: @@ -4712,8 +4712,10 @@ public: /// @{ /*! - returns a point `q` on plane `h`, such that the projection of - this point onto the \f$ xy\f$-plane is `p`. + returns the image point of the projection of `p` + under an affine transformation which maps the \f$ xy\f$-plane onto `h`. + This affine transformation must be the inverse of the affine transformation used + in `ConstructProjectedXYPoint_2`. */ Kernel::Point_3 operator()(const Kernel::Plane_3& h, const Kernel::Point_2& p); @@ -5999,8 +6001,8 @@ public: \cgalRefines `AdaptableFunctor` (with two arguments) - \sa `CGAL::Plane_3` - + \sa `CGAL::Plane_3` + \sa `ConstructLiftedPoint_3` */ class ConstructProjectedXYPoint_2 { public: @@ -6012,7 +6014,9 @@ public: /*! returns the image point of the projection of `p` under an affine transformation, which maps `h` onto the \f$ xy\f$-plane, with the - \f$ z\f$-coordinate removed. + \f$ z\f$-coordinate removed. + This affine transformation must be the inverse of the affine transformation used + in `ConstructLiftedPoint_3`. */ Kernel::Point_2 operator()(const Kernel::Plane_3& h, const Kernel::Point_3& p);