diff --git a/Polygon/include/CGAL/General_polygon_with_holes_2.h b/Polygon/include/CGAL/General_polygon_with_holes_2.h index 99ebb453956..cf3d666421b 100644 --- a/Polygon/include/CGAL/General_polygon_with_holes_2.h +++ b/Polygon/include/CGAL/General_polygon_with_holes_2.h @@ -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& 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 diff --git a/Polygon/include/CGAL/Polygon_2.h b/Polygon/include/CGAL/Polygon_2.h index f305cad314f..0b37a0131b3 100644 --- a/Polygon/include/CGAL/Polygon_2.h +++ b/Polygon/include/CGAL/Polygon_2.h @@ -577,7 +577,7 @@ operator!=(const Polygon_2 &p1, const Polygon_2 &p2); /// Returns the image of the polygon \c p under the transformation \c t. -/// \memberof Polygon_2 +/// \relates Polygon_2 template Polygon_2 transform(const Transformation& t, const Polygon_2& p); @@ -591,13 +591,13 @@ transform(const Transformation& t, const Polygon_2& 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 std::istream &operator>>(std::istream &is, Polygon_2& 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 std::ostream &operator<<(std::ostream &os, const Polygon_2& p); diff --git a/Polygon/include/CGAL/Polygon_with_holes_2.h b/Polygon/include/CGAL/Polygon_with_holes_2.h index 879ea6050a7..7ec7296a0d8 100644 --- a/Polygon/include/CGAL/Polygon_with_holes_2.h +++ b/Polygon/include/CGAL/Polygon_with_holes_2.h @@ -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,