Skip to content

Commit 6d4dccd

Browse files
committed
update links
1 parent 0b62da5 commit 6d4dccd

File tree

12 files changed

+24
-24
lines changed

12 files changed

+24
-24
lines changed

Algebraic_foundations/doc/Algebraic_foundations/Algebraic_foundations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ compatibility all functionality is also
8181
accessible through global functions defined within namespace `CGAL`,
8282
e.g., \link sqrt `CGAL::sqrt(x)` \endlink. This is realized via function templates using
8383
the according functor of the traits class. For an overview see
84-
Section \ref PkgAlgebraicFoundationsRef in the reference manual.
84+
\ref PkgAlgebraicFoundationsRef.
8585

8686
\subsection Algebraic_foundationsTagsinAlgebraicStructure Tags in Algebraic Structure Traits
8787

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4196,7 +4196,7 @@ are both parameterized by a geometric kernel and model the concepts
41964196
`AosTraits_2` and `AosLandmarkTraits_2`.
41974197
\cgalFootnote{They also model the refined concept
41984198
\cgalFootnoteCode{AosDirectionalXMonotoneTraits_2}, which enables Boolean set
4199-
operations; see Package \ref PkgBooleanSetOperations2Ref.} The class
4199+
operations; see Package \ref PkgBooleanSetOperations2.} The class
42004200
template `Arr_non_caching_segment_traits_2<Kernel>` derives from the
42014201
instance `Arr_non_caching_segment_basic_traits_2<Kernel>`, which
42024202
models the `AosLandmarkTraits_2` traits concept but not the
@@ -4937,7 +4937,7 @@ template models the concepts `AosTraits_2` and
49374937
`AosOpenBoundaryTraits_2`, but it does not model the
49384938
`AosLandmarkTraits_2` concept. It also models the refined
49394939
concept `AosDirectionalXMonotoneTraits_2`, which enables
4940-
Boolean set operations; see Package \ref PkgBooleanSetOperations2Ref.
4940+
Boolean set operations; see Package \ref PkgBooleanSetOperations2.
49414941
Note that it is not a model of `AosLandmarkTraits_2` concept,
49424942
so it is impossible to use the landmark point-location strategy with
49434943
this traits class.
@@ -5167,7 +5167,7 @@ Every instance of the `Arr_Bezier_curve_traits_2` class templates
51675167
models the concept `AosTraits_2` (but it does not model the
51685168
`AosLandmarkTraits_2` concept). It also models the refined
51695169
concept `AosDirectionalXMonotoneTraits_2`, which enables
5170-
Boolean set operations; see Package \ref PkgBooleanSetOperations2Ref.
5170+
Boolean set operations; see Package \ref PkgBooleanSetOperations2.
51715171

51725172
<!-- ----------------------------------------------------------------------- -->
51735173
\cgalFigureBegin{aos_fig-bezier_curves,bezier_curves.png}

BGL/doc/BGL/BGL.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -698,7 +698,7 @@ using one of the following tags:
698698
- `CGAL::Alpha_expansion_boost_adjacency_list_tag` (default)
699699
- `CGAL::Alpha_expansion_boost_compressed_sparse_raw_tag`
700700
- `CGAL::Alpha_expansion_MaxFlow_tag`, released under GPL
701-
license and provided by the \ref PkgSurfaceMeshSegmentationRef
701+
license and provided by the \ref PkgSurfaceMeshSegmentation
702702
package
703703

704704
All these implementations produce the exact same result but behave

BGL/include/CGAL/boost/graph/alpha_expansion_graphcut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ class Alpha_expansion_MaxFlow_impl;
509509
\cgalParamNEnd
510510
\cgalNamedParamsEnd
511511
512-
\note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentationRef
512+
\note The `MaxFlow` implementation is provided by the \ref PkgSurfaceMeshSegmentation
513513
under GPL license. The header `<CGAL/boost/graph/Alpha_expansion_MaxFlow_tag.h>`
514514
must be included if users want to use this implementation.
515515
*/

Barycentric_coordinates_2/doc/Barycentric_coordinates_2/Barycentric_coordinates_2.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ All analytic barycentric coordinates for polygons can be computed either by inst
5353
or through one of the free functions. Harmonic coordinates can be computed only by
5454
instantiating a class that must be parameterized by a model of the concept `DiscretizedDomain_2`.
5555
Segment and triangle coordinates can be computed only through the free functions.
56-
For more information see the \ref PkgBarycentricCoordinates2Ref "Reference Manual".
56+
For more information see the \ref PkgBarycentricCoordinates2Ref.
5757

5858
Any point in the plane may be taken as a query point. However, we do not recommend using
5959
Wachspress and discrete harmonic coordinates with query points outside the closure

Documentation/doc/Documentation/Third_party.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ The \eigen web site is <A HREF="https://eigen.tuxfamily.org/index.php?title=Main
143143

144144
\opengr is a set C++ libraries for 3D Global Registration released under the terms of the APACHE V2 license.
145145

146-
\cgal provides wrappers for the Super4PCS algorithm of \opengr in the \ref PkgPointSetProcessing3Ref
146+
\cgal provides wrappers for the Super4PCS algorithm of \opengr in the \ref PkgPointSetProcessing3
147147
packages. In order to use \opengr in \cgal programs, the executables should be linked with the CMake imported target `CGAL::OpenGR_support` provided in `CGAL_OpenGR_support.cmake`.
148148

149149
The \opengr web site is <A HREF="https://github.com/STORM-IRIT/OpenGR">`https://github.com/STORM-IRIT/OpenGR`</A>.
@@ -152,7 +152,7 @@ The \opengr web site is <A HREF="https://github.com/STORM-IRIT/OpenGR">`https://
152152

153153
\libpointmatcher is a modular library implementing the Iterative Closest Point (ICP) algorithm for aligning point clouds, released under a permissive BSD license.
154154

155-
\cgal provides wrappers for the ICP algorithm of \libpointmatcher in the \ref PkgPointSetProcessing3Ref
155+
\cgal provides wrappers for the ICP algorithm of \libpointmatcher in the \ref PkgPointSetProcessing3
156156
packages. In order to use \libpointmatcher in \cgal programs, the
157157
executables should be linked with the CMake imported target
158158
`CGAL::pointmatcher_support` provided in
@@ -276,7 +276,7 @@ for instance, on Windows, you can download it from <A HREF="https://www.zlib.net
276276

277277
\ceres is an open source C++ library for modeling and solving large, complicated optimization problems.
278278

279-
In \cgal, \ceres is used by the \ref PkgPolygonMeshProcessingRef package for mesh smoothing, which
279+
In \cgal, \ceres is used by the \ref PkgPolygonMeshProcessing package for mesh smoothing, which
280280
requires solving complex non-linear least squares problems.
281281

282282
Visit the official website of the library at <A HREF="http://ceres-solver.org/index.html">`ceres-solver.org`</A>

Documentation/doc/Documentation/Tutorials/Tutorial_GIS.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -303,14 +303,14 @@ described in this tutorial.
303303

304304
This tutorial is based on the following \cgal packages:
305305

306-
- \ref PkgTriangulation2Ref
307-
- \ref PkgPointSet3Ref
308-
- \ref PkgPointSetProcessing3Ref
306+
- \ref PkgTriangulation2
307+
- \ref PkgPointSet3
308+
- \ref PkgPointSetProcessing3
309309
- \ref PkgSurface_mesh
310-
- \ref PkgBGLRef
311-
- \ref PkgPolygonMeshProcessingRef
312-
- \ref PkgPolylineSimplification2Ref
313-
- \ref PkgClassificationRef
310+
- \ref PkgBGL
311+
- \ref PkgPolygonMeshProcessing
312+
- \ref PkgPolylineSimplification2
313+
- \ref PkgClassification
314314

315315
The data set used throughout this tutorial comes from the
316316
https://www.usgs.gov/ database, licensed under the _US Government

Number_types/doc/Number_types/NumberTypeSupport.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ requirements, such that they can be successfully used in \cgal code.
1616
In general they are expected to be a model of an algebraic structure
1717
concepts and in case they model a subring of the real numbers they are
1818
also a model of `RealEmbeddable`. For an overview of the algebraic
19-
structure concepts see Section \ref PkgAlgebraicFoundationsRef.
19+
structure concepts see Section \ref PkgAlgebraicFoundations.
2020

2121
\section Number_typesBuilt Built-in Number Types
2222

Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/Concepts/Periodic_2TriangulationTraits_2.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ the geometric primitives used in the triangulation and some function
1111
object types for the required predicates on those primitives.
1212
1313
It refines the concept
14-
`TriangulationTraits_2` from the \cgal \ref PkgTriangulation2Ref package. It redefines the
14+
`TriangulationTraits_2` from the \cgal \ref PkgTriangulation2 package. It redefines the
1515
geometric objects, predicates and constructions to work with
1616
point-offset pairs. In most cases the offsets will be (0,0) and the
1717
predicates from `TriangulationTraits_2` can be used

Point_set_3/doc/Point_set_3/PackageDescription.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
/// header or by the LAS standard.
2626
///
2727
/// For a complete documentation of these functions, please refer to the
28-
/// \ref PkgPointSetProcessing3Ref manual.
28+
/// \ref PkgPointSetProcessing3Ref "Point Set Processing Reference Manual".
2929

3030
/// \defgroup PkgPointSet3IOLAS Input/Output (LAS)
3131
/// I/O Functions for the \ref IOStreamLAS

Point_set_processing_3/doc/Point_set_processing_3/Point_set_processing_3.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ CGAL::jet_estimate_normals<Concurrency_tag>
139139
normal_map (CGAL::Second_of_pair_property_map<PointVectorPair>()));
140140
\endcode
141141

142-
Please refer to the [Reference Manual](@ref PkgPointSetProcessing3Ref) for
142+
Please refer to the @ref PkgPointSetProcessing3Ref for
143143
the detailed API of the Point Set Processing functions.
144144

145145

@@ -973,7 +973,7 @@ points that are on sharp edges:
973973

974974
The function `structure_point_set()` generates a structured version of
975975
the input point set assigned to a set of planes. Such an input can be
976-
produced by a shape detection algorithm (see \ref PkgShapeDetectionRef).
976+
produced by a shape detection algorithm (see its \ref PkgShapeDetectionRef).
977977
Point set structuring is based on the article \cgalCite{cgal:la-srpss-13}.
978978

979979
- __Planes__: inliers of each detected plane are replaced by sets of
@@ -1025,7 +1025,7 @@ point set:
10251025

10261026
Several functions of this package provide a callback mechanism that enables the user to track the progress of the algorithms and to interrupt them if needed. A callback, in this package, is an instance of `std::function<bool(double)>` that takes the advancement as a parameter (between 0. when the algorithm begins to 1. when the algorithm is completed) and that returns `true` if the algorithm should carry on, `false` otherwise. It is passed as a named parameter with an empty function as default.
10271027

1028-
Algorithms that support this mechanism are detailed in the [Reference Manual](@ref PkgPointSetProcessing3Ref), along with the effect that an early interruption has on the output.
1028+
Algorithms that support this mechanism are detailed in the @ref PkgPointSetProcessing3Ref, along with the effect that an early interruption has on the output.
10291029

10301030
\subsection Point_set_processing_3Example_callbacks Example
10311031

Polygon_mesh_processing/doc/Polygon_mesh_processing/Polygon_mesh_processing.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ mesh, which includes point location and self intersection tests.
5757
\subsection PMPIO Reading and Writing Polygon Meshes
5858

5959
In all functions of this package, the polygon meshes are required to be models
60-
of the graph concepts defined in the package \ref PkgBGLRef. Using common graph concepts
60+
of the graph concepts defined in the package \ref PkgBGL. Using common graph concepts
6161
enables having common input/output functions for all the models of these concepts.
6262
The page \ref PkgBGLIOFct provides an exhaustive description of the available I/O functions.
6363
In addition, this package offers the function `CGAL::Polygon_mesh_processing::IO::read_polygon_mesh()`,

0 commit comments

Comments
 (0)