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

Fix typos in the documentation

This commit is contained in:
Andreas Fabri 2022-05-24 10:11:20 +01:00
parent 7067cec506
commit 01485044b6
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Polygon/include/CGAL/General_polygon_with_holes_2.h
View File

@ -127,10 +127,10 @@ protected:
// operator<<
//-----------------------------------------------------------------------//
/*!
This operator exports a General_polygon_with_holes_2 to the output stream `out`.
This operator exports a `General_polygon_with_holes_2` to the output stream `os`.
An \ascii and a binary format exist. The format can be selected with
the \cgal modifiers for streams, `set_ascii_mode(0` and `set_binary_mode()`
the \cgal modifiers for streams, `set_ascii_mode()` and `set_binary_mode()`,
respectively. The modifier `set_pretty_mode()` can be used to allow for (a
few) structuring comments in the output. Otherwise, the output would
be free of comments. The default for writing is \ascii without comments.
@ -178,9 +178,9 @@ operator<<(std::ostream& os, const General_polygon_with_holes_2<Polygon_>& p) {
//-----------------------------------------------------------------------//
/*!
This operator imports a General_polygon_with_holes_2 from the input stream `in`.
This operator imports a `General_polygon_with_holes_2` from the input stream `is`.
Both ASCII and binary formats are supported, and the format is automatically detected.
Both \ascii and binary formats are supported, and the format is automatically detected.
The format consists of the number of curves of the outer boundary
followed by the curves themselves, followed

6
Polygon/include/CGAL/Polygon_2.h
View File

@ -577,7 +577,7 @@ operator!=(const Polygon_2<Traits_P,Container1_P> &p1,
const Polygon_2<Traits_P,Container2_P> &p2);
/// Returns the image of the polygon \c p under the transformation \c t.
/// \memberof Polygon_2
/// \relates Polygon_2
template <class Transformation, class Traits_P, class Container_P>
Polygon_2<Traits_P,Container_P>
transform(const Transformation& t, const Polygon_2<Traits_P,Container_P>& p);
@ -591,13 +591,13 @@ transform(const Transformation& t, const Polygon_2<Traits_P,Container_P>& p);
/// Reads a polygon from stream `is` and assigns it to `p`.
/// \pre The extract operator must be defined for `Point_2`.
/// \memberof Polygon_2
/// \relates Polygon_2
template <class Traits_P, class Container_P>
std::istream &operator>>(std::istream &is, Polygon_2<Traits_P,Container_P>& p);
/// Inserts the polygon `p` into the stream `os`.
/// \pre The insert operator must be defined for `Point_2`.
/// \memberof Polygon_2
/// \relates Polygon_2
template <class Traits_P, class Container_P>
std::ostream &operator<<(std::ostream &os, const Polygon_2<Traits_P,Container_P>& p);

8
Polygon/include/CGAL/Polygon_with_holes_2.h
View File

@ -91,10 +91,10 @@ public:
//-----------------------------------------------------------------------//
/*!
This operator exports a polygon with holes to the output stream `out`.
This operator exports a polygon with holes to the output stream `os`.
An \ascii and a binary format exist. The format can be selected with
the \cgal modifiers for streams, `set_ascii_mode()` and `set_binary_mode()`
the \cgal modifiers for streams, `set_ascii_mode()` and `set_binary_mode()`,
respectively. The modifier `set_pretty_mode()` can be used to allow for (a
few) structuring comments in the output. Otherwise, the output would
be free of comments. The default for writing is \ascii without comments.
@ -154,9 +154,9 @@ std::ostream& operator<<(std::ostream &os,
//-----------------------------------------------------------------------//
/*!
This operator imports a polygon with holes from the input stream `in`.
This operator imports a polygon with holes from the input stream `is`.
Both ASCII and binary formats are supported, and the format is automatically detected.
Both \ascii and binary formats are supported, and the format is automatically detected.
The format consists of the number of points of the outer boundary followed
by the points themselves in counterclockwise order, followed by the number of holes,