From 7e62f6ffd18c8e94b725e6a40f828f02d0fa9e1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Wed, 10 Jan 2018 14:30:37 +0100 Subject: [PATCH] Various doc fixes --- BGL/doc/BGL/BGL.txt | 3 ++- BGL/doc/BGL/NamedParameters.txt | 7 ++++--- BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h | 4 ++-- BGL/include/CGAL/boost/graph/METIS/partition_graph.h | 4 ++-- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/BGL/doc/BGL/BGL.txt b/BGL/doc/BGL/BGL.txt index 852450907d7..e32d165f7d1 100644 --- a/BGL/doc/BGL/BGL.txt +++ b/BGL/doc/BGL/BGL.txt @@ -385,7 +385,8 @@ accordingly: The previous sections introduced partial specializations and free functions so that several \cgal data structures are adapted as models of some of the \sc{Bgl} graph concepts. -In this section, we introduce new functiona +In this section, we introduce new concepts, iterators, and property maps inspired +by the functionalities of the BGL. \subsection BGLExtensionsGraphConcepts Graph concepts diff --git a/BGL/doc/BGL/NamedParameters.txt b/BGL/doc/BGL/NamedParameters.txt index cc3c200055e..2ad59092bc9 100644 --- a/BGL/doc/BGL/NamedParameters.txt +++ b/BGL/doc/BGL/NamedParameters.txt @@ -82,9 +82,10 @@ being marked or not.\n \cgalNPEnd \cgalNPBegin{METIS_options} \anchor BGL_METIS_options -is a parameter used in `partition()` to pass options to the METIS mesh -partitioner. The many options of METIS are not described here. Instead, users -should refer to METIS' documentation.\n +is a parameter used in `partition_graph()` and `partition_dual_graph()` +to pass options to the METIS graph partitioner. The many options of METIS +are not described here. Instead, users should refer to METIS' +documentation.\n Type: an array of size `METIS_NOPTIONS` with value type `idx_t` (an integer type defined by METIS). \n Default: an array of size `METIS_NOPTIONS` with value type `idx_t`, diff --git a/BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h b/BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h index 76ed1382aa3..09d6e01cf16 100644 --- a/BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h +++ b/BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h @@ -131,8 +131,8 @@ void partition_dual_graph(const TriangleMesh& tm, int nparts, /// \ingroup PkgBGLPartition /// -/// Computes a partition of the input triangulat mesh into `nparts` parts, -/// based on the mesh's dual graph. The resulting partition is stored in the vertex and face +/// Computes a partition of the input triangular mesh into `nparts` parts, +/// based on the mesh's dual graph. The resulting partition is stored in the vertex and/or face /// property maps that are passed as parameters using \ref bgl_namedparameters "Named Parameters". /// /// Property map for `CGAL::vertex_index_t` should be either available diff --git a/BGL/include/CGAL/boost/graph/METIS/partition_graph.h b/BGL/include/CGAL/boost/graph/METIS/partition_graph.h index 6faa49537a9..8619f4dd184 100644 --- a/BGL/include/CGAL/boost/graph/METIS/partition_graph.h +++ b/BGL/include/CGAL/boost/graph/METIS/partition_graph.h @@ -164,8 +164,8 @@ void partition_graph(const TriangleMesh& tm, int nparts, /// \ingroup PkgBGLPartition /// -/// Computes a partition of the input mesh into `nparts` parts, based on the -/// mesh's nodal graph. The resulting partition is stored in the vertex and face +/// Computes a partition of the input triangular mesh into `nparts` parts, based on the +/// mesh's nodal graph. The resulting partition is stored in the vertex and/or face /// property maps that are passed as parameters using \ref bgl_namedparameters "Named Parameters". /// /// Property map for `CGAL::vertex_index_t` should be either available