improve doc

This commit is contained in:
Sébastien Loriot 2024-01-22 18:02:48 +01:00
parent 11fc1943fb
commit 7431715e96
1 changed files with 2 additions and 1 deletions

View File

@ -106,7 +106,8 @@ private:
@param mesh the polygon mesh whose faces are used for region growing @param mesh the polygon mesh whose faces are used for region growing
@param region_map a property map storing the region index of each face. Values start at `0` up to the value returned minus `1`. @param region_map a property map storing the region index of each face. Values start at `0` up to the value returned minus `1`.
`std::size_t(-1)` is put for faces with no region assigned (can only happen if `minimum_region_size > 1`). `std::size_t(-1)` is put for faces with no region assigned (it can happen if `minimum_region_size > 1` or for a non-triangular
face having a fitting plane not satisfying the maximum distance criterium).
@param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below
@return the number of regions detected @return the number of regions detected