From 26a94ab6bbff54eaccc86f158004f8c96fb1e0d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20M=C3=B6ller?= Date: Thu, 24 Nov 2011 10:44:23 +0000 Subject: [PATCH] Small documentation corrections --- Kernel_23/doc_tex/Kernel_23/kernel_toc.tex | 1 - Kernel_23/doc_tex/Kernel_23_ref/intersection.tex | 6 +++--- Kernel_d/doc_tex/Kernel_d/kernel_d_toc.tex | 1 - .../doc_tex/Kernel_d_ref/Kernel_Intersect_d.tex | 2 +- Kernel_d/doc_tex/Kernel_d_ref/intersection.tex | 15 ++++++++++----- 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/Kernel_23/doc_tex/Kernel_23/kernel_toc.tex b/Kernel_23/doc_tex/Kernel_23/kernel_toc.tex index ef5f47330d3..dbb38ce5ba4 100644 --- a/Kernel_23/doc_tex/Kernel_23/kernel_toc.tex +++ b/Kernel_23/doc_tex/Kernel_23/kernel_toc.tex @@ -91,7 +91,6 @@ \ccRefIdfierPage{CGAL::do_intersect} \\ \ccRefIdfierPage{CGAL::intersection} \\ -\ccRefIdfierPage{CGAL::Intersection_traits, B} \\ \ccRefIdfierPage{CGAL::squared_distance} \\ \subsubsection*{Predicates and Constructions} diff --git a/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex b/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex index bdf80466068..a5c1d6a1fc4 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/intersection.tex @@ -31,10 +31,11 @@ points \ccStyle{p} that are part of both \ccStyle{obj1} and \ccStyle{obj2}. Note that for objects like triangles and polygons that enclose a bounded region, this region is considered part of the object. If a segment lies completely inside a triangle, then those two objects -intersect and the \ccHtmlNoLinksFrom{intersection} region is the complete segment. +intersect and the \ccHtmlNoLinksFrom{intersection} region is the complete segment. +Here, \ccStyle{Intersect_23} means either \ccStyle{Intersect_2} or \ccStyle{Intersect_3}, respectively. }} -The same functionality is also available through the functors \ccc{Kernel::Intersect_2} and \ccc{Kernel::Intersect_2}. +The same functionality is also available through the functors \ccc{Kernel::Intersect_2} and \ccc{Kernel::Intersect_3}. The possible values for types \ccStyle{Type1} and \ccStyle{Type2} and the value for T\ldots in \ccStyle{boost::optional< boost::variant< @@ -124,7 +125,6 @@ type A & type B & \parbox{4 cm}{\vspace{1 mm}{return type}} \\ \ccStyle{Point_2} \\ \ccStyle{Segment_2} \\ \ccStyle{Triangle_2} - \\ \ccStyle{_2} \vspace{1 mm}} \\ \hline \ccStyle{Iso_rectangle_2} & \ccStyle{Iso_rectangle_2} & \parbox{4 cm}{\vspace{1 mm} diff --git a/Kernel_d/doc_tex/Kernel_d/kernel_d_toc.tex b/Kernel_d/doc_tex/Kernel_d/kernel_d_toc.tex index 43775a2064b..8874a003693 100644 --- a/Kernel_d/doc_tex/Kernel_d/kernel_d_toc.tex +++ b/Kernel_d/doc_tex/Kernel_d/kernel_d_toc.tex @@ -45,5 +45,4 @@ \ccRefIdfierPage{CGAL::do_intersect}\\ \ccRefIdfierPage{CGAL::intersection}\\ -\ccRefIdfierPage{CGAL::Intersection_traits} diff --git a/Kernel_d/doc_tex/Kernel_d_ref/Kernel_Intersect_d.tex b/Kernel_d/doc_tex/Kernel_d_ref/Kernel_Intersect_d.tex index ae94dbdb902..3f51071787a 100644 --- a/Kernel_d/doc_tex/Kernel_d_ref/Kernel_Intersect_d.tex +++ b/Kernel_d/doc_tex/Kernel_d_ref/Kernel_Intersect_d.tex @@ -4,7 +4,7 @@ A model for this must provide: \ccCreationVariable{fo} \ccMemberFunction{ - Intersection_traits, Type2 >::result_type + Kernel::Intersect_d::Result, Type2 >::Type operator()(const Type1& p, const Type2& q);} {returns the result of the intersection of $p$ and $q$ in form of a polymorphic object. \ccc{Kernel_object} may be any of diff --git a/Kernel_d/doc_tex/Kernel_d_ref/intersection.tex b/Kernel_d/doc_tex/Kernel_d_ref/intersection.tex index 3891d389725..13e9799c9c6 100644 --- a/Kernel_d/doc_tex/Kernel_d_ref/intersection.tex +++ b/Kernel_d/doc_tex/Kernel_d_ref/intersection.tex @@ -1,7 +1,7 @@ \begin{ccRefFunction}{intersection} \ccInclude{CGAL/intersections_d.h} -\ccFunction{Intersection_traits, Type2 >::result_type +\ccFunction{Kernel::Intersect_d::Result, Type2 >::Type intersection(Type1 f1, Type2 f2);} { returns the intersection result of $f1$ and $f2$. \ccPrecond The objects are of the same dimension.} @@ -162,15 +162,20 @@ struct Intersection_visitor { template void foo(Segment_d seg, Line_d lin) { - ITd< R, Segment_d, Line_d >::result_type result = intersection(seg, lin); + R::Intersect_d::template Result< Segment_d, Line_d > + result = intersection(seg, lin); if(result) { boost::apply_visitor(Intersection_visitor(), *result); } else { /* no intersection */ } } \end{verbatim}% \ccHtmlLinksOn% -\ccSeeAlso \ccc{do_intersect}, \ccc{Kernel::Intersect_d} , -\ccc{Kernel::Do_intersect_d}, \ccAnchor{www.boost.org/doc/libs/release/libs/optional/index.html}{boost::optional}, -\ccAnchor{www.boost.org/doc/html/variant.html}{boost::variant} +\ccSeeAlso +\ccc{do_intersect}, \\ +\ccc{Kernel::Intersect_d}, \\ +\ccc{Kernel::Do_intersect_d}, \\ +\ccAnchor{http://www.boost.org/doc/libs/release/libs/optional/index.html}{boost::optional}, \\ +\ccAnchor{http://www.boost.org/doc/html/variant.html}{boost::variant} \\ \end{ccRefFunction} +