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

Various doc fixes

This commit is contained in:
Mael Rouxel-Labbé 2018-01-10 14:30:37 +01:00
parent 4e3d91becf
commit 7e62f6ffd1
4 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
BGL/doc/BGL/BGL.txt
View File

@ -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

7
BGL/doc/BGL/NamedParameters.txt
View File

@ -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' <a href="http://glaros.dtc.umn.edu/gkhome/fetch/sw/metis/manual.pdf">documentation</a>.\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'
<a href="http://glaros.dtc.umn.edu/gkhome/fetch/sw/metis/manual.pdf">documentation</a>.\n
<b>Type:</b> an array of size `METIS_NOPTIONS` with value type `idx_t`
(an integer type defined by METIS). \n
<b>Default:</b> an array of size `METIS_NOPTIONS` with value type `idx_t`,

4
BGL/include/CGAL/boost/graph/METIS/partition_dual_graph.h
View File

@ -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

4
BGL/include/CGAL/boost/graph/METIS/partition_graph.h
View File

@ -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