From aa613322787066c481665abf990b954e990466b5 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Thu, 29 Nov 2012 17:58:40 +0100 Subject: [PATCH] fix typos and links --- Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h | 4 ++-- .../doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h | 4 ++-- Envelope_2/doc/Envelope_2/Envelope_2.txt | 8 ++++---- .../doc/Point_set_processing_3/Point_set_processing_3.txt | 3 ++- Ridges_3/doc/Ridges_3/Ridges_3.txt | 4 ++-- .../doc/Snap_rounding_2/CGAL/Snap_rounding_2.h | 2 +- 6 files changed, 13 insertions(+), 12 deletions(-) diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h index bbbfc9b6b60..7d5691b9770 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h @@ -70,12 +70,12 @@ returns a representative \f$ x\f$-monotone curve associated with `e`. const X_monotone_curve_2& curve () const; /*! -return an iterator for the first \f$ x\f$-monotone curve associated with `e`. +returns an iterator for the first \f$ x\f$-monotone curve associated with `e`. */ Curve_const_iterator curves_begin () const; /*! -return a past-the-end iterator for the \f$ x\f$-monotone curves associated with `e`. +returns a past-the-end iterator for the \f$ x\f$-monotone curves associated with `e`. */ Curve_const_iterator curves_end () const; diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h index 58e5658a11e..5ee28e59aad 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h @@ -75,12 +75,12 @@ returns the number of \f$ x\f$-monotone curves associated with `v`. Size number_of_curves () const; /*! -return an iterator for the first \f$ x\f$-monotone curve associated with `v`. +returns an iterator for the first \f$ x\f$-monotone curve associated with `v`. */ Curve_const_iterator curves_begin () const; /*! -return a past-the-end iterator for the \f$ x\f$-monotone curves associated with `v`. +returns a past-the-end iterator for the \f$ x\f$-monotone curves associated with `v`. */ Curve_const_iterator curves_end () const; diff --git a/Envelope_2/doc/Envelope_2/Envelope_2.txt b/Envelope_2/doc/Envelope_2/Envelope_2.txt index c14866fa3b7..1064ced91d3 100644 --- a/Envelope_2/doc/Envelope_2/Envelope_2.txt +++ b/Envelope_2/doc/Envelope_2/Envelope_2.txt @@ -76,11 +76,11 @@ traversing both diagrams in parallel. \section env2_secenv_diag The Envelope Diagram The package basically contains two sets of free functions: -`lower_envelope_x_monotone_2 (begin, end, diag)` (similarly -`upper_envelope_x_monotone_2()`) construct the envelope diagram +\link lower_envelope_x_monotone_2() `lower_envelope_x_monotone_2(begin, end, diag)`\endlink +(similarly `upper_envelope_x_monotone_2()`) construct the envelope diagram for a given range of \f$ x\f$-monotone curves, while -`lower_envelope_2 (begin, end, diag)` (similarly -`upper_envelope_2()`) construct the envelope diagram for a +\link lower_envelope_x_monotone_2() `lower_envelope_2(begin, end, diag)`\endlink +(similarly `upper_envelope_2()`) construct the envelope diagram for a range of arbitrary (not necessarily \f$ x\f$-monotone) curves. In this section we explain more on the structure of the envelope diagram these functions output. diff --git a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt index 87bd40453f8..85e088c29c6 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt @@ -57,6 +57,7 @@ from the \cgal 3D point, or as a `std::pair, Vector_3>`, or as a `boost::tuple<..,Point_3, ..., Vector_3 >`. The following classes described in Chapter \ref chapterProperty_map +"CGAL and Boost Property Maps" provide property maps for the implementations of points with normals listed above: @@ -160,7 +161,7 @@ Point set simplification through grid-based clustering. Removed points are depic \section Point_set_processing_3Smoothing Smoothing -Function `jet_smooth_point_set` smooths the input point set by +Function `jet_smooth_point_set()` smooths the input point set by projecting each point onto a smooth parametric surface patch (so-called jet surface) fitted over its `k` nearest neighbors. diff --git a/Ridges_3/doc/Ridges_3/Ridges_3.txt b/Ridges_3/doc/Ridges_3/Ridges_3.txt index 131a781b34b..a955b5d0943 100644 --- a/Ridges_3/doc/Ridges_3/Ridges_3.txt +++ b/Ridges_3/doc/Ridges_3/Ridges_3.txt @@ -115,7 +115,7 @@ by \f$ x\f$ (resp. \f$ y\f$) are: \anchor eqtaylor_along_line \f[ \begin{equation} -k_1(x) = k_1 + b_0x + \frac{P_1}{2(k_1-k_2)}x^2 +\hot , \quad \quad \quad +k_1(x) = k_1 + b_0x + \frac{P_1}{2(k_1-k_2)}x^2 + ... , \quad \quad \quad P_1= 3b_1^2+(k_1-k_2)(c_0-3k_1^3). \end{equation} \f] @@ -123,7 +123,7 @@ P_1= 3b_1^2+(k_1-k_2)(c_0-3k_1^3). \anchor eqtaylor_along_red_line \f[ \begin{equation} -k_2(y) = k_2 + b_3y + \frac{P_2}{2(k_2-k_1)}y^2 +\hot , \quad \quad \quad +k_2(y) = k_2 + b_3y + \frac{P_2}{2(k_2-k_1)}y^2 + ... , \quad \quad \quad P_2= 3b_2^2+(k_2-k_1)(c_4-3k_2^3). \end{equation} \f] diff --git a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h index d9d6a2e8d4b..c9896caf214 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/CGAL/Snap_rounding_2.h @@ -3,7 +3,7 @@ namespace CGAL { /*! \ingroup PkgSnapRounding2 -The first two parameters denote the first and after-the-last iterators +The first two parameters denote the first and past-the-end iterators of the input segments. The third parameter is a reference to a container of the output polylines. Since a polyline is composed of a sequence of points, a polyline is a container itself. The fifth