Skip to content

Commit e8975db

Browse files
committed
function documentation fixes
remove the repetition of the name of the function in its brief description add parenthesis for function matching "function\s+`[a-z0-9_]`"
1 parent 04a0d96 commit e8975db

File tree

44 files changed

+123
-123
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+123
-123
lines changed

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ namespace CGAL {
33
/*!
44
\ingroup PkgArrangement2PointLocation
55
6-
The function `locate` performs a batched point-location operation on a
6+
Performs a batched point-location operation on a
77
given arrangement. It accepts a range of query points, and locates each
88
point in the arrangement. The query results are returned through the output
99
iterator. Each query result is given as a pair of the query point and an

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ namespace CGAL {
33
\defgroup PkgArrangement2Read CGAL::read()
44
\ingroup PkgArrangement2IO
55
6-
The function `read` reads a given arrangement from a given input stream
6+
Reads a given arrangement from a given input stream
77
using a specific input format.
88
99
\cgalHeading{Requirements}
@@ -40,7 +40,7 @@ std::istream& read (Arrangement_2<Traits,Dcel>& arr,
4040
\defgroup PkgArrangement2Write CGAL::write()
4141
\ingroup PkgArrangement2IO
4242
43-
The function `write` writes a given arrangement into a given output stream
43+
Writes a given arrangement into a given output stream
4444
using a specific output format.
4545
4646
\cgalHeading{Requirements}

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_overlay_2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace CGAL {
66
the output arrangement `res` to represent the overlaid arrangement.
77
88
\details
9-
The function `overlay` computes the overlay of two input arrangement
9+
Computes the overlay of two input arrangement
1010
objects, and returns the overlaid arrangement. All three arrangements
1111
can be instantiated with different geometric traits classes and different
1212
<span class="textsc">Dcel</span> classes (encapsulated in the various topology-traits classes).
@@ -42,7 +42,7 @@ represent the overlaid arrangement. The function also constructs a
4242
consolidated set of curves that induce `res`.
4343
4444
\details
45-
The function `overlay` computes the overlay of two input arrangement
45+
Computes the overlay of two input arrangement
4646
objects, and returns the overlaid arrangement. All three arrangements
4747
can be instantiated with different geometric traits classes and different
4848
<span class="textsc">Dcel</span> classes (encapsulated in the various topology-traits classes).

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ namespace CGAL {
33
/*!
44
\ingroup PkgArrangement2Funcs
55
6-
The function `decompose` produces the symbolic vertical decomposition of a
6+
Produces the symbolic vertical decomposition of a
77
given arrangement, performing a batched vertical ray-shooting query from
88
all arrangement vertices, such that every vertex is associated with a pair
99
of objects, one corresponds to the arrangement feature that lies below it,

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1045,7 +1045,7 @@ void insert (Arrangement_2<Traits,Dcel>& arr,
10451045
/*!
10461046
\ingroup PkgArrangement2Funcs
10471047
1048-
The function `do_intersect` checks if a given curve or \f$ x\f$-monotone
1048+
Checks if a given curve or \f$ x\f$-monotone
10491049
curve intersects an existing arrangement's edges or vertices.
10501050
10511051
If the give curve is not an \f$ x\f$-monotone curve then the function
@@ -1091,7 +1091,7 @@ bool do_intersect (
10911091
/*!
10921092
\ingroup PkgArrangement2Funcs
10931093
1094-
The function `insert_non_intersecting_curve` inserts a given \f$ x\f$-monotone curve into a given
1094+
Inserts a given \f$ x\f$-monotone curve into a given
10951095
arrangement, where the interior of the given curve is disjoint from all
10961096
existing arrangement vertices and edges. Under this assumption, it is
10971097
possible to locate the endpoints of the given curve in the arrangement,
@@ -1129,7 +1129,7 @@ insert_non_intersecting_curve (Arrangement_2<Traits,Dcel>& arr,
11291129
/*!
11301130
\ingroup PkgArrangement2Funcs
11311131
1132-
The function `insert_non_intersecting_curves` inserts a set of \f$ x\f$-monotone curves in a given
1132+
Inserts a set of \f$ x\f$-monotone curves in a given
11331133
range into a given arrangement. The insertion is performed in an aggregated
11341134
manner, using the sweep-line algorithm. The input curves should be pairwise
11351135
disjoint in their interior and pairwise interior-disjoint from all existing
@@ -1152,7 +1152,7 @@ void insert_non_intersecting_curves(Arrangement_2<Traits,Dcel>& arr,
11521152
/*!
11531153
\ingroup PkgArrangement2Funcs
11541154
1155-
The function `insert_point` inserts a given point into a given arrangement.
1155+
Inserts a given point into a given arrangement.
11561156
It uses a given point-location object to locate the given
11571157
point in the given arrangement. If the point conincides with an existing
11581158
vertex, there is nothing left to do; if it lies on an edge, the edge is
@@ -1190,7 +1190,7 @@ insert_point (Arrangement_2<Traits,Dcel>& arr,
11901190
/*!
11911191
\ingroup PkgArrangement2Funcs
11921192
1193-
The function `is_valid` checks the validity of a given arrangement.
1193+
Checks the validity of a given arrangement.
11941194
11951195
Invokes the member function `arr.is_valid()` to verify the
11961196
topological correctness of the arrangement. Then it performs additional
@@ -1214,7 +1214,7 @@ bool is_valid (const Arrangement_2<Traits, Dcel>& arr);
12141214
/*!
12151215
\ingroup PkgArrangement2Funcs
12161216
1217-
The function `remove_edge` removes an edge given by one of the twin halfedges
1217+
Removes an edge given by one of the twin halfedges
12181218
that forms it, from a given arrangement. Once the edge is removed, if the
12191219
vertices associated with its endpoints become isolated, they are removed as
12201220
well. The call `remove_edge(arr, e)` is equivalent to the call
@@ -1246,7 +1246,7 @@ remove_edge (Arrangement_2<Traits,Dcel>& arr,
12461246
/*!
12471247
\ingroup PkgArrangement2Funcs
12481248
1249-
The function `remove_vertex` attempts to removed a given vertex from a given
1249+
Attempts to removed a given vertex from a given
12501250
arrangement. The vertex can be removed if it is either an isolated vertex,
12511251
(and has no incident edge,) or if it is a <I>redundant</I> vertex. That
12521252
is, it has exactly two incident edges, whose associated curves can be
@@ -1271,7 +1271,7 @@ bool remove_vertex (Arrangement_2<Traits,Dcel>& arr,
12711271
/*!
12721272
\ingroup PkgArrangement2Funcs
12731273
1274-
The function `zone` compute the zone of the given \f$ x\f$-monotone
1274+
Compute the zone of the given \f$ x\f$-monotone
12751275
curve in the existing arrangement. Meaning, it output the
12761276
arrangement's vertices, edges and faces that the \f$ x\f$-monotone curve
12771277
intersects. The order of the objects is the order that they are

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,9 @@ void insert(Arrangement_with_history_2<Traits,Dcel>& arr,
310310
/*!
311311
\ingroup PkgArrangement2Funcs
312312
313-
The function `remove_curve` removes a given curve from a given arrangement.
313+
Removes a given curve from a given arrangement.
314314
315-
`remove_curve` removes a curve, specified by its handle `ch`, from
315+
The curve is specified by its handle `ch`, from
316316
the arrangement `arr`, by deleting all the edges it induces. The
317317
function returns the number of deleted edges.
318318

Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace CGAL {
55
66
The class `Rectangular_p_center_default_traits_2` defines types and operations
77
needed to compute rectilinear \f$ p\f$-centers of a planar point set
8-
using the function `rectangular_p_center_2`.
8+
using the function `rectangular_p_center_2()`.
99
1010
1111
\tparam K must be a model for `Kernel`.
@@ -196,7 +196,7 @@ construct_iso_rectangle_2_above_right_point_2_object() const;
196196
/*!
197197
\ingroup PkgBoundingVolumes
198198
199-
The function `rectangular_p_center_2` computes rectilinear
199+
Computes rectilinear
200200
\f$ p\f$-centers of a planar point set, i.e.\ a set of \f$ p\f$ points such
201201
that the maximum minimal \f$ L_{\infty}\f$-distance between both sets is
202202
minimized.

Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Point type.
2222
typedef unspecified_type Point;
2323

2424
/*!
25-
Distance type. The function `squared_radius` (see below)
25+
Distance type. The function `squared_radius()` (see below)
2626
returns an object of this type.
2727
28-
\note Only needed, if the member function `is_valid`
28+
\note Only needed, if the member function `is_valid()`
2929
of `Min_circle_2` is used.
3030
3131
*/
@@ -128,15 +128,15 @@ bool is_degenerate( ) const;
128128
129129
returns `true`, iff `circle` and `circle2` are equal.
130130
131-
\note Only needed, if the member function `is_valid` of `Min_circle_2` is used.
131+
\note Only needed, if the member function `is_valid()` of `Min_circle_2` is used.
132132
*/
133133
bool operator == ( const Circle& circle2) const;
134134

135135

136136
/*!
137137
returns the center of `circle`.
138138
139-
\note Only needed, if the member function `is_valid` of `Min_circle_2` is used.
139+
\note Only needed, if the member function `is_valid()` of `Min_circle_2` is used.
140140
*/
141141
Point center( ) const;
142142

@@ -145,7 +145,7 @@ Point center( ) const;
145145
146146
returns the squared radius of `circle`.
147147
148-
\note Only needed, if the member function `is_valid` of `Min_circle_2` is used.
148+
\note Only needed, if the member function `is_valid()` of `Min_circle_2` is used.
149149
*/
150150
Distance squared_radius( ) const;
151151

Box_intersection_d/doc/Box_intersection_d/Box_intersection_d.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ CGAL::box_self_intersection_d( ptr.begin(), ptr.end(), report_inters);
259259

260260
\endcode
261261

262-
In addition, the callback function `report_inters` needs to be
262+
In addition, the callback function `report_inters()` needs to be
263263
changed to work with pointers to boxes. The full example program looks
264264
as follows:
265265

@@ -314,7 +314,7 @@ box at the center and the box from the upper-right corner of the grid.
314314
We write a more involved callback function object `Report` that
315315
stores an output iterator and writes the `id`-number of the
316316
box in the first argument to the output iterator. We also provide a
317-
small helper function `report` that simplifies the use of the function
317+
small helper function `report()` that simplifies the use of the function
318318
object.
319319

320320
We call the box intersection algorithm twice; once for the default

Circulator/doc/Circulator/CGAL/circulator.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ circulator category for iterators, i.e.\ one of
315315
316316
\cgalHeading{Example}
317317
318-
A generic function `bar` that distinguishes between a call with a
318+
A generic function `bar()` that distinguishes between a call with a
319319
circulator range and a call with an iterator range:
320320
321321
\code{.cpp}
@@ -545,15 +545,15 @@ In order to write algorithms that work with iterator ranges as well as
545545
with circulator ranges we have to consider the difference of
546546
representing an empty range. For iterators this is the range `[i,i)`,
547547
while for circulators it would be `c == NULL`, the empty sequence test.
548-
The function `is_empty_range` provides the necessary generic test
548+
The function `is_empty_range()` provides the necessary generic test
549549
which accepts an iterator range or a circulator range and says whether
550550
the range is empty or not.
551551
552552
\pre `IC` is either a circulator or an iterator type. The range `[i, j)` is valid.
553553
554554
\cgalHeading{Example}
555555
556-
The following function `process_all` accepts a range `[i, j)` of an iterator or circulator `IC` and processes each
556+
The following function `process_all()` accepts a range `[i, j)` of an iterator or circulator `IC` and processes each
557557
element in this range:
558558
559559
\code{.cpp}
@@ -642,12 +642,12 @@ In order to write algorithms that work with iterator ranges as well as
642642
with circulator ranges we have to consider the difference of
643643
representing an empty range. For iterators this is the range `[i,i)`,
644644
while for circulators it would be `c == NULL`, the empty sequence test.
645-
The function `is_empty_range` provides the necessary generic test
645+
The function `is_empty_range()` provides the necessary generic test
646646
which accepts an iterator range or a circulator range and says whether
647647
the range is empty or not.
648648
649649
A macro `CGAL_For_all( i, j)` simplifies the writing of such simple
650-
loops as the one in the example of the function `is_empty_range`.
650+
loops as the one in the example of the function `is_empty_range()`.
651651
`i` and `j` can be either iterators or circulators. The macro
652652
loops through the range `[i, j)`. It increments `i` until it
653653
reaches `j`. The implementation looks like:

0 commit comments

Comments
 (0)