diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-06-26 05:40:22 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-06-26 05:44:22 +0300 |
commit | 545610d3aae0c64ad98abb4fcb19d8958018bd76 (patch) | |
tree | 4f9d256e3e58b08faa08fb41ba28840c0fae7490 /source/blender/blenkernel | |
parent | abaf6b106d3a34512f1061dc23277f3924da7fc6 (diff) |
Cleanup: un-wrap lines in headers, use doxy comments
Diffstat (limited to 'source/blender/blenkernel')
-rw-r--r-- | source/blender/blenkernel/BKE_DerivedMesh.h | 4 | ||||
-rw-r--r-- | source/blender/blenkernel/BKE_cloth.h | 26 | ||||
-rw-r--r-- | source/blender/blenkernel/BKE_editmesh_bvh.h | 13 | ||||
-rw-r--r-- | source/blender/blenkernel/BKE_library.h | 21 | ||||
-rw-r--r-- | source/blender/blenkernel/BKE_mesh_iterators.h | 4 |
5 files changed, 40 insertions, 28 deletions
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index b1ebd2903ec..d215f214a6d 100644 --- a/source/blender/blenkernel/BKE_DerivedMesh.h +++ b/source/blender/blenkernel/BKE_DerivedMesh.h @@ -105,8 +105,8 @@ typedef enum DerivedMeshType { typedef enum DMForeachFlag { DM_FOREACH_NOP = 0, - DM_FOREACH_USE_NORMAL = - (1 << 0), /* foreachMappedVert, foreachMappedLoop, foreachMappedFaceCenter */ + /* foreachMappedVert, foreachMappedLoop, foreachMappedFaceCenter */ + DM_FOREACH_USE_NORMAL = (1 << 0), } DMForeachFlag; typedef enum DMDirtyFlag { diff --git a/source/blender/blenkernel/BKE_cloth.h b/source/blender/blenkernel/BKE_cloth.h index a5d1472727a..43df78c33e4 100644 --- a/source/blender/blenkernel/BKE_cloth.h +++ b/source/blender/blenkernel/BKE_cloth.h @@ -187,16 +187,22 @@ typedef struct ClothSpring { /* SIMULATION FLAGS: goal flags,.. */ /* These are the bits used in SimSettings.flags. */ typedef enum { - CLOTH_SIMSETTINGS_FLAG_COLLOBJ = - (1 << 2), // object is only collision object, no cloth simulation is done - CLOTH_SIMSETTINGS_FLAG_GOAL = (1 << 3), /* DEPRECATED, for versioning only. */ - CLOTH_SIMSETTINGS_FLAG_TEARING = (1 << 4), // true if tearing is enabled - CLOTH_SIMSETTINGS_FLAG_SCALING = (1 << 8), /* DEPRECATED, for versioning only. */ - CLOTH_SIMSETTINGS_FLAG_CCACHE_EDIT = (1 << 12), /* edit cache in editmode */ - CLOTH_SIMSETTINGS_FLAG_RESIST_SPRING_COMPRESS = (1 << 13), /* don't allow spring compression */ - CLOTH_SIMSETTINGS_FLAG_SEW = (1 << 14), /* pull ends of loose edges together */ - CLOTH_SIMSETTINGS_FLAG_DYNAMIC_BASEMESH = - (1 << 15), /* make simulation respect deformations in the base object */ + /** Object is only collision object, no cloth simulation is done. */ + CLOTH_SIMSETTINGS_FLAG_COLLOBJ = (1 << 2), + /** DEPRECATED, for versioning only. */ + CLOTH_SIMSETTINGS_FLAG_GOAL = (1 << 3), + /** True if tearing is enabled. */ + CLOTH_SIMSETTINGS_FLAG_TEARING = (1 << 4), + /** DEPRECATED, for versioning only. */ + CLOTH_SIMSETTINGS_FLAG_SCALING = (1 << 8), + /** Edit cache in edit-mode. */ + CLOTH_SIMSETTINGS_FLAG_CCACHE_EDIT = (1 << 12), + /** Don't allow spring compression. */ + CLOTH_SIMSETTINGS_FLAG_RESIST_SPRING_COMPRESS = (1 << 13), + /** Pull ends of loose edges together. */ + CLOTH_SIMSETTINGS_FLAG_SEW = (1 << 14), + /** Make simulation respect deformations in the base object. */ + CLOTH_SIMSETTINGS_FLAG_DYNAMIC_BASEMESH = (1 << 15), } CLOTH_SIMSETTINGS_FLAGS; /* ClothSimSettings.bending_model. */ diff --git a/source/blender/blenkernel/BKE_editmesh_bvh.h b/source/blender/blenkernel/BKE_editmesh_bvh.h index 6eb8260513f..e86408076cd 100644 --- a/source/blender/blenkernel/BKE_editmesh_bvh.h +++ b/source/blender/blenkernel/BKE_editmesh_bvh.h @@ -87,13 +87,14 @@ struct BVHTreeOverlap *BKE_bmbvh_overlap(const BMBVHTree *bmtree_a, const BMBVHTree *bmtree_b, unsigned int *r_overlap_tot); -/* BKE_bmbvh_new flag parameter */ +/** #BKE_bmbvh_new flag parameter. */ enum { - BMBVH_RETURN_ORIG = - (1 << 0), /* use with 'cos_cage', returns hits in relation to original geometry */ - BMBVH_RESPECT_SELECT = - (1 << 1), /* restrict to hidden geometry (overrides BMBVH_RESPECT_HIDDEN) */ - BMBVH_RESPECT_HIDDEN = (1 << 2), /* omit hidden geometry */ + /** Use with 'cos_cage', returns hits in relation to original geometry. */ + BMBVH_RETURN_ORIG = (1 << 0), + /** Restrict to hidden geometry (overrides BMBVH_RESPECT_HIDDEN). */ + BMBVH_RESPECT_SELECT = (1 << 1), + /** Omit hidden geometry. */ + BMBVH_RESPECT_HIDDEN = (1 << 2), }; #endif /* __BKE_EDITMESH_BVH_H__ */ diff --git a/source/blender/blenkernel/BKE_library.h b/source/blender/blenkernel/BKE_library.h index 818fbce4f9a..6f4dc3aff3b 100644 --- a/source/blender/blenkernel/BKE_library.h +++ b/source/blender/blenkernel/BKE_library.h @@ -139,19 +139,24 @@ struct ID *BKE_libblock_find_name(struct Main *bmain, */ enum { /* *** Generic options (should be handled by all ID types freeing). *** */ - /* Do not try to remove freed ID from given Main (passed Main may be NULL). */ + /** Do not try to remove freed ID from given Main (passed Main may be NULL). */ LIB_ID_FREE_NO_MAIN = 1 << 0, - /* Do not affect user refcount of datablocks used by freed one. - * Implies LIB_ID_FREE_NO_MAIN. */ + /** + * Do not affect user refcount of datablocks used by freed one. + * Implies LIB_ID_FREE_NO_MAIN. + */ LIB_ID_FREE_NO_USER_REFCOUNT = 1 << 1, - /* Assume freed ID datablock memory is managed elsewhere, do not free it + /** + * Assume freed ID datablock memory is managed elsewhere, do not free it * (still calls relevant ID type's freeing function though) - USE WITH CAUTION! - * Implies LIB_ID_FREE_NO_MAIN. */ + * Implies LIB_ID_FREE_NO_MAIN. + */ LIB_ID_FREE_NOT_ALLOCATED = 1 << 2, - LIB_ID_FREE_NO_DEG_TAG = 1 << 8, /* Do not tag freed ID for update in depsgraph. */ - LIB_ID_FREE_NO_UI_USER = - 1 << 9, /* Do not attempt to remove freed ID from UI data/notifiers/... */ + /** Do not tag freed ID for update in depsgraph. */ + LIB_ID_FREE_NO_DEG_TAG = 1 << 8, + /** Do not attempt to remove freed ID from UI data/notifiers/... */ + LIB_ID_FREE_NO_UI_USER = 1 << 9, }; void BKE_libblock_free_datablock(struct ID *id, const int flag) ATTR_NONNULL(); diff --git a/source/blender/blenkernel/BKE_mesh_iterators.h b/source/blender/blenkernel/BKE_mesh_iterators.h index fff957e90aa..7bbd64c0bac 100644 --- a/source/blender/blenkernel/BKE_mesh_iterators.h +++ b/source/blender/blenkernel/BKE_mesh_iterators.h @@ -30,8 +30,8 @@ struct Mesh; typedef enum MeshForeachFlag { MESH_FOREACH_NOP = 0, - MESH_FOREACH_USE_NORMAL = - (1 << 0), /* foreachMappedVert, foreachMappedLoop, foreachMappedFaceCenter */ + /* foreachMappedVert, foreachMappedLoop, foreachMappedFaceCenter */ + MESH_FOREACH_USE_NORMAL = (1 << 0), } MeshForeachFlag; void BKE_mesh_foreach_mapped_vert(struct Mesh *mesh, |