diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-03 11:29:35 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-03 12:10:57 +0300 |
commit | c4e041da23b9c45273fcd4874308c536b6a315d1 (patch) | |
tree | 9afdea81b57e801d3a1930988ebf3a2145a408bb /source/blender/bmesh/tools/bmesh_region_match.h | |
parent | 7c4fc5b58d2e7982aefbba093cb8f1dc36b64884 (diff) |
Cleanup: move public doc-strings into headers for 'bmesh'
Some minor improvements to doc-strings too.
Ref T92709
Diffstat (limited to 'source/blender/bmesh/tools/bmesh_region_match.h')
-rw-r--r-- | source/blender/bmesh/tools/bmesh_region_match.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/source/blender/bmesh/tools/bmesh_region_match.h b/source/blender/bmesh/tools/bmesh_region_match.h index 799af938c31..7b7233783ce 100644 --- a/source/blender/bmesh/tools/bmesh_region_match.h +++ b/source/blender/bmesh/tools/bmesh_region_match.h @@ -20,6 +20,12 @@ * \ingroup bmesh */ +/** + * Take a face-region and return a list of matching face-regions. + * + * \param faces_region: A single, contiguous face-region. + * \return A list of matching null-terminated face-region arrays. + */ int BM_mesh_region_match(BMesh *bm, BMFace **faces_region, uint faces_region_len, |