diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h index 8240f9826a2..65fbed7df73 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h @@ -85,7 +85,7 @@ typedef Hidden_type Algebraic; The `Curve_2` class nested within the Bézier traits class is used to represent a Bézier curve of arbitrary degree, which is defined by a sequence of rational control points. In addition to the methods listed -below, the I/O operators `operator<<` and `operator>>` for +below, the I/O operators \link PkgArrangement2op_left_shift `operator<<` \endlink and \link PkgArrangement2op_right_shift `operator>>` \endlink for standard output-streams are also supported. The copy constructor and assignment operator are supported as well. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h index 96eee76ec72..e9a33ff5bd4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h @@ -1,6 +1,6 @@ namespace CGAL { /*! - \defgroup PkgArrangement2Read read + \defgroup PkgArrangement2Read CGAL::read() \ingroup PkgArrangement2IO The function `read` reads a given arrangement from a given input stream @@ -16,11 +16,11 @@ using a specific input format. -\sa \link write `CGAL::write()` \endlink +\sa `PkgArrangement2Write` -\sa operator<< -\sa operator>> +\sa PkgArrangement2op_left_shift +\sa PkgArrangement2op_right_shift */ /// @{ @@ -37,7 +37,7 @@ std::istream& read (Arrangement_2& arr, /// @} /*! - \defgroup PkgArrangement2Write write + \defgroup PkgArrangement2Write CGAL::write() \ingroup PkgArrangement2IO The function `write` writes a given arrangement into a given output stream @@ -52,9 +52,9 @@ using a specific output format. `ArrangementWithHistoryOutputFormatter` concept. -\sa \link read `CGAL::read()` \endlink -\sa operator<< -\sa operator>> +\sa `PkgArrangement2Read` +\sa PkgArrangement2op_left_shift +\sa PkgArrangement2op_right_shift */ /// @{ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h index af599dc909e..392aa74e30a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h @@ -35,7 +35,7 @@ public: The `Curve_2` (and the `X_monotone_curve_2`) class nested within the linear-traits can represent all types of linear objects. The class supports the copy and default constructor and the assignment operator. - In addition, the `operator<<` and `operator>>` for linear objects + In addition, the \link PkgArrangement2op_left_shift `operator<<` \endlink and \link PkgArrangement2op_right_shift `operator>>` \endlink for linear objects are defined for standard output and input streams. */ class Curve_2 { diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h index 852f0e375a8..3e31c57a573 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h @@ -43,8 +43,8 @@ self-intersecting) and support their construction from any range of points. The copy and default constructor as well as the assignment operator are provided for polyline curves. In addition, -an `operator<<` for the curves is defined for standard output streams, -and an `operator>>` for the curves is defined for standard input streams. +an \link PkgArrangement2op_left_shift `operator<<` \endlink for the curves is defined for standard output streams, +and an \link PkgArrangement2op_right_shift `operator>>` \endlink for the curves is defined for standard input streams. */ class Curve_2 { diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h index 372674b0544..1b00ca6f2e7 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h @@ -973,7 +973,7 @@ namespace CGAL { /*! \ingroup PkgArrangement2Insert insert - The function `insert` inserts one or more curves or \f$ x\f$-monotone curves + The function `%insert` inserts one or more curves or \f$ x\f$-monotone curves into a given arrangement, where no restrictions are imposed on the inserted curves. If an inserted curve is not \f$ x\f$-monotone curve, it is subdivided into \f$ x\f$-monotone subcurves (and perhaps isolated points), which are diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h index 2534c057578..d3dadb9330d 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_text_formatter.h @@ -21,8 +21,8 @@ the `<<` operator and read from an input stream using the `>>` operator. \cgalModels `ArrangementInputFormatter` \cgalModels `ArrangementOutputFormatter` -\sa `read` -\sa `write` +\sa `PkgArrangement2Read` +\sa `PkgArrangement2Write` \sa `Arr_extended_dcel` */ @@ -55,8 +55,8 @@ can all be written to an input stream using the `<<` operator and read from an i \cgalModels `ArrangementInputFormatter` \cgalModels `ArrangementOutputFormatter` -\sa `read` -\sa `write` +\sa `PkgArrangement2Read` +\sa `PkgArrangement2Write` \sa `Arr_face_extended_dcel` */ @@ -88,8 +88,8 @@ operator. \cgalModels `ArrangementInputFormatter` \cgalModels `ArrangementOutputFormatter` -\sa `read` -\sa `write` +\sa `PkgArrangement2Read` +\sa `PkgArrangement2Write` */ template< typename Arrangement > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h index 975135aef9e..3af4fa40bd9 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/IO/Arr_with_history_text_formatter.h @@ -18,8 +18,8 @@ relations between these curves and the edges they induce. \cgalModels `ArrangementWithHistoryInputFormatter` \cgalModels `ArrangementWithHistoryOutputFormatter` -\sa `read` -\sa `write` +\sa `PkgArrangement2Read` +\sa `PkgArrangement2Write` */ template< typename ArrFormatter > diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h index 229d0e2e5b8..12f43259692 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h @@ -5,8 +5,8 @@ The concept `ArrangementTraits_2` allows the construction of arrangement of general planar curves. Models of this concept are used -by the free `insert()` functions of the arrangement package and -by the `Arrangement_with_history_2` class. +by the free \link PkgArrangement2Insert `CGAL::insert()` \endlink functions of the arrangement package and +by the `CGAL::Arrangement_with_history_2` class. A model of this concept must define the nested `Curve_2` type, which represents a general planar curve that is not necessarily \f$ x\f$-monotone diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt index d0c00029b28..d9502218e95 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/PackageDescription.txt @@ -43,7 +43,7 @@ namespace ArrTraits {} /// \defgroup PkgArrangement2Funcs Free Functions /// \ingroup PkgArrangement2 -/// \defgroup PkgArrangement2Insert insert +/// \defgroup PkgArrangement2Insert CGAL::insert() /// \ingroup PkgArrangement2Funcs /// \defgroup PkgArrangement2Tags Tags