From 333cdbb41025db012239e0549a439515880aad9b Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 18 Apr 2019 07:21:26 +0200 Subject: Cleanup: comment blocks --- source/blender/bmesh/bmesh_class.h | 39 +++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) (limited to 'source/blender/bmesh/bmesh_class.h') diff --git a/source/blender/bmesh/bmesh_class.h b/source/blender/bmesh/bmesh_class.h index 220a5b3a5f5..2cc5b1b8097 100644 --- a/source/blender/bmesh/bmesh_class.h +++ b/source/blender/bmesh/bmesh_class.h @@ -58,23 +58,32 @@ struct BLI_mempool; * 4: some elements for internal record keeping. */ typedef struct BMHeader { - void *data; /* customdata layers */ - int index; /* notes: - * - Use BM_elem_index_get/set macros for index - * - Uninitialized to -1 so we can easily tell its not set. - * - Used for edge/vert/face/loop, check BMesh.elem_index_dirty for valid index values, - * this is abused by various tools which set it dirty. - * - For loops this is used for sorting during tessellation. */ - - char htype; /* element geometric type (verts/edges/loops/faces) */ - char hflag; /* this would be a CD layer, see below */ - - /* internal use only! - * note,.we are very picky about not bloating this struct + /** Customdata layers. */ + void *data; + + /** + * \note + * - Use BM_elem_index_get/set macros for index + * - Uninitialized to -1 so we can easily tell its not set. + * - Used for edge/vert/face/loop, check BMesh.elem_index_dirty for valid index values, + * this is abused by various tools which set it dirty. + * - For loops this is used for sorting during tessellation. + */ + int index; + + /** Element geometric type (verts/edges/loops/faces). */ + char htype; + /** This would be a CD layer, see below. */ + char hflag; + + /** + * Internal use only! + * \note We are very picky about not bloating this struct * but in this case its padded up to 16 bytes anyway, - * so adding a flag here gives no increase in size */ + * so adding a flag here gives no increase in size. + */ char api_flag; - // char _pad; + // char _pad; } BMHeader; BLI_STATIC_ASSERT((sizeof(BMHeader) <= 16), "BMHeader size has grown!"); -- cgit v1.2.3