songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

kernel_23 doc typo fixes

This commit is contained in:
Dmitry Anisimov 2020-07-22 14:24:56 +02:00
parent da0635e4b1
commit eb2f7e5b90
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Kernel_23/doc/Kernel_23/CGAL/intersections.h
View File

@ -95,7 +95,7 @@ The following tables give the possible values for `Type1` and `Type2`.
\cgalHeading{2D Intersections} \cgalHeading{2D Intersections}
The return type can be obtained through `CGAL::cpp11::result_of<Kernel::Intersect_2(A, B)>::%type`. The return type can be obtained through `cpp11::result_of<Kernel::Intersect_2(A, B)>::%type`.
It is equivalent to `boost::optional< boost::variant< T... > >`, the last column in the table providing the template parameter pack. It is equivalent to `boost::optional< boost::variant< T... > >`, the last column in the table providing the template parameter pack.
<DIV ALIGN="CENTER"> <DIV ALIGN="CENTER">
@ -191,7 +191,7 @@ intersections existing with the type `Iso_rectangle_2`. Note that the return typ
\cgalHeading{3D Intersections} \cgalHeading{3D Intersections}
The return type can be obtained through `CGAL::cpp11::result_of<Kernel::Intersect_3(A, B)>::%type`. The return type can be obtained through `cpp11::result_of<Kernel::Intersect_3(A, B)>::%type`.
It is equivalent to `boost::optional< boost::variant< T... > >`, the last column in the table providing the template parameter pack. It is equivalent to `boost::optional< boost::variant< T... > >`, the last column in the table providing the template parameter pack.
<DIV ALIGN="CENTER"> <DIV ALIGN="CENTER">
@ -350,7 +350,7 @@ The following examples demonstrate the most common use of
`intersection()` functions with the 2D and 3D Linear %Kernel. `intersection()` functions with the 2D and 3D Linear %Kernel.
In the first two examples we intersect a segment and a line. In the first two examples we intersect a segment and a line.
The result type can be obtained with `CGAL::cpp11::result_of`. It looks simpler The result type can be obtained with `cpp11::result_of`. It looks simpler
if you use a C++ compiler which supports `auto`, if you use a C++ compiler which supports `auto`,
but you must anyways know that the result type is a `boost::optional<boost::variant<..> >`, in order to unpack the point or segment. but you must anyways know that the result type is a `boost::optional<boost::variant<..> >`, in order to unpack the point or segment.

6
Kernel_23/doc/Kernel_23/Kernel_23.txt
View File

@ -498,8 +498,8 @@ in a type-safe way \cgal uses return values of type
`boost::optional< boost::variant< T... > >` were `T...` is a `boost::optional< boost::variant< T... > >` were `T...` is a
list of all possible resulting geometric objects. The exact result list of all possible resulting geometric objects. The exact result
type of an intersection can be determined through the metafunction type of an intersection can be determined through the metafunction
`cpp11::result_of<Kernel::Intersect_2(Type1, Type2)>` or `CGAL::cpp11::result_of<Kernel::Intersect_2(Type1, Type2)>` or
`cpp11::result_of<Kernel::Intersect_3(Type1, Type2)>`, where `CGAL::cpp11::result_of<Kernel::Intersect_3(Type1, Type2)>`, where
`Type1` and `Type2` are the types of the objects used in the `Type1` and `Type2` are the types of the objects used in the
intersection computation. intersection computation.
@ -525,7 +525,7 @@ std::cin >> segment_1 >> segment_2;
// auto v = intersection(segment_1, segment_2); // auto v = intersection(segment_1, segment_2);
/* C++03 */ /* C++03 */
cpp11::result_of<K::Intersect_2(Segment_2, Segment_2)>::type CGAL::cpp11::result_of<K::Intersect_2(Segment_2, Segment_2)>::type
v = intersection(segment_1, segment_2); v = intersection(segment_1, segment_2);
if(v) { if(v) {
/* not empty */ /* not empty */