songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix broken link to ref manuals for Heat Method and Surface Mesh Topology

This commit is contained in:
Mael Rouxel-Labbé 2022-10-13 23:57:44 +02:00
parent 5545eee950
commit 1a1eaff65f
4 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Heat_method_3/doc/Heat_method_3/PackageDescription.txt
View File

@ -1,13 +1,12 @@
// The Heat Method
/// \defgroup PkgHeatMethod Heat Method Reference
/// \defgroup PkgHeatMethodRef Heat Method Reference
/// \defgroup PkgHeatMethodConcepts Concepts
/// \ingroup PkgHeatMethod
/// \ingroup PkgHeatMethodRef
/*!
\addtogroup PkgHeatMethod
\addtogroup PkgHeatMethodRef
\cgalPkgDescriptionBegin{The Heat Method,PkgHeatMethod}
\cgalPkgPicture{heat-method-small.png}
@ -17,8 +16,8 @@
\cgalPkgDesc{The package provides an algorithm that solves the single- or
multiple-source shortest path problem by returning an approximation of the geodesic distance
for all vertices of a triangle mesh to the closest vertex in a given set of
source vertices. }
\cgalPkgManuals{Chapter_HeatMethod,PkgHeatMethod}
source vertices.}
\cgalPkgManuals{Chapter_HeatMethod,PkgHeatMethodRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{4.14}

6
Heat_method_3/include/CGAL/Heat_method_3/Surface_mesh_geodesic_distances_3.h
View File

@ -714,7 +714,7 @@ struct Base_helper<TriangleMesh, Traits, Intrinsic_Delaunay, LA, VertexPointMap>
/**
* \ingroup PkgHeatMethod
* \ingroup PkgHeatMethodRef
*
* Class `Surface_mesh_geodesic_distances_3` computes estimated geodesic distances for a set of source vertices where sources can be added and removed.
* The class performs a preprocessing step that only depends on the mesh, so that the distance computation takes less
@ -906,7 +906,7 @@ public:
};
#if defined(DOXYGEN_RUNNING) || defined(CGAL_EIGEN3_ENABLED)
/// \ingroup PkgHeatMethod
/// \ingroup PkgHeatMethodRef
/// computes for each vertex of the triangle mesh `tm` the estimated geodesic distance to a given source vertex.
/// This function is provided only if \ref thirdpartyEigen "Eigen" 3.3 (or greater) is available and `CGAL_EIGEN3_ENABLED` is defined.
/// \tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph` and `HalfedgeListGraph`.
@ -947,7 +947,7 @@ estimate_geodesic_distances(const TriangleMesh& tm,
#endif
/// \ingroup PkgHeatMethod
/// \ingroup PkgHeatMethodRef
/// computes for each vertex of the triangle mesh `tm` the estimated geodesic distance to a given set of source vertices.
/// This function is provided only if \ref thirdpartyEigen "Eigen" 3.3 (or greater) is available and `CGAL_EIGEN3_ENABLED` is defined.
/// \tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph` and `HalfedgeListGraph`

2
Heat_method_3/include/CGAL/Heat_method_3/internal/Intrinsic_Delaunay_triangulation_3.h
View File

@ -132,7 +132,7 @@ struct Intrinsic_Delaunay_triangulation_3_vertex_iterator_functor
};
/**
* \ingroup PkgHeatMethod
* \ingroup PkgHeatMethodRef
*
* Class `Intrinsic_Delaunay_triangulation_3` is a remeshing algorithm to improve the approximation of the `Surface_mesh_geodesic_distances_3`.
* It internally makes a copy of the triangle mesh, performs edge flips, and computes 2D vertex coordinates per face

12
Surface_mesh_topology/doc/Surface_mesh_topology/PackageDescription.txt
View File

@ -1,10 +1,10 @@
/// \defgroup PkgSurfaceMeshTopology Surface Mesh Topology Reference
/// \defgroup PkgSurfaceMeshTopologyRef Surface Mesh Topology Reference
/// \defgroup PkgSurfaceMeshTopologyConcepts Concepts
/// \ingroup PkgSurfaceMeshTopology
/// \ingroup PkgSurfaceMeshTopologyRef
/// \defgroup PkgSurfaceMeshTopologyClasses Classes
/// \ingroup PkgSurfaceMeshTopology
/// \ingroup PkgSurfaceMeshTopologyRef
/*!
\code
@ -12,17 +12,17 @@
\endcode
*/
/// \defgroup PkgDrawFaceGraphWithPaths Draw a Mesh with Paths
/// \ingroup PkgSurfaceMeshTopology
/// \ingroup PkgSurfaceMeshTopologyRef
/*!
\addtogroup PkgSurfaceMeshTopology
\addtogroup PkgSurfaceMeshTopologyRef
\cgalPkgDescriptionBegin{Surface Mesh Topology,PkgSurfaceMeshTopology}
\cgalPkgPicture{surface-mesh-topology-logo.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand, Francis Lazarus}
\cgalPkgDesc{This package provides a toolbox for manipulating curves on a combinatorial surface from the topological point of view. Two main functionalities are proposed. One is the computation of shortest curves that cannot be continuously deformed to a point. This includes the computation of the so-called edge width and face width of the vertex-edge graph of a combinatorial surface. The other functionality is the homotopy test for deciding if two given curves on a combinatorial surface can be continuously deformed one into the other.}
\cgalPkgManuals{Chapter_Surface_Mesh_Topology,PkgSurfaceMeshTopology}
\cgalPkgManuals{Chapter_Surface_Mesh_Topology,PkgSurfaceMeshTopologyRef}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{5.1}