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/intern/bmesh_mesh_validate.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/intern/bmesh_mesh_validate.h')
| -rw-r--r-- | source/blender/bmesh/intern/bmesh_mesh_validate.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/source/blender/bmesh/intern/bmesh_mesh_validate.h b/source/blender/bmesh/intern/bmesh_mesh_validate.h index 2112e1f3200..203c8a89c55 100644 --- a/source/blender/bmesh/intern/bmesh_mesh_validate.h +++ b/source/blender/bmesh/intern/bmesh_mesh_validate.h @@ -23,4 +23,10 @@ * \ingroup bmesh */ +/** + * Check of this #BMesh is valid, + * this function can be slow since its intended to help with debugging. + * + * \return true when the mesh is valid. + */ bool BM_mesh_validate(BMesh *bm); |