diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-02-28 23:10:53 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-02-28 23:10:53 +0400 |
commit | 2a7f1af61ec8e11e73e2c16ca5579baca04bf78a (patch) | |
tree | a9f9c3dd8d0d5d179a4491ca21986f62c4e89854 /source/blender/bmesh/bmesh.h | |
parent | d1d11bbe9bc73f8578dbd138d079dc6488b5920d (diff) |
Code Cleanup:
- apply some rules for function naming conventions, added to main bmesh doc in bmesh.h.
- remove unused function BM_loops_to_corners().
Diffstat (limited to 'source/blender/bmesh/bmesh.h')
-rw-r--r-- | source/blender/bmesh/bmesh.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/source/blender/bmesh/bmesh.h b/source/blender/bmesh/bmesh.h index 3f00c861731..91e45d640ef 100644 --- a/source/blender/bmesh/bmesh.h +++ b/source/blender/bmesh/bmesh.h @@ -179,6 +179,19 @@ * then spit out a new one; this allows operators to be chained together. * * \note Element buffers may have elements of different types within the same buffer (this is supported by the API. + * + * + * \section bm_fname Function Naming Conventions + * + * These conventions should be used throughout the bmesh module. + * + * - BM_xxx() - High level BMesh API function for use anywhere. + * - bmesh_xxx() - Low level API function. + * - bm_xxx() - 'static' functions, not apart of the API at all, but use prefix since they operate on BMesh data. + * - BMO_xxx() - High level operator API function for use anywhere. + * - bmo_xxx() - Low level / internal operator API functions. + * - _bm_xxx() - Functions which are called via macros only. + * */ #ifdef __cplusplus |