[Bf-blender-cvs] [545610d3aae] master: Cleanup: un-wrap lines in headers, use doxy comments
Campbell Barton
noreply at git.blender.org
Wed Jun 26 04:46:33 CEST 2019
Commit: 545610d3aae0c64ad98abb4fcb19d8958018bd76
Author: Campbell Barton
Date: Wed Jun 26 12:40:22 2019 +1000
Branches: master
https://developer.blender.org/rB545610d3aae0c64ad98abb4fcb19d8958018bd76
Cleanup: un-wrap lines in headers, use doxy comments
===================================================================
M source/blender/blenkernel/BKE_DerivedMesh.h
M source/blender/blenkernel/BKE_cloth.h
M source/blender/blenkernel/BKE_editmesh_bvh.h
M source/blender/blenkernel/BKE_library.h
M source/blender/blenkernel/BKE_mesh_iterators.h
M source/blender/bmesh/intern/bmesh_mods.h
M source/blender/bmesh/intern/bmesh_operator_api.h
M source/blender/makesrna/RNA_access.h
M source/blender/makesrna/RNA_types.h
M source/blender/windowmanager/WM_types.h
M source/blender/windowmanager/wm_event_types.h
===================================================================
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,
diff --git a/source/blender/bmesh/intern/bmesh_mods.h b/source/blender/bmesh/intern/bmesh_mods.h
index 3d4eefbb598..36cb85bc9bc 100644
--- a/source/blender/bmesh/intern/bmesh_mods.h
+++ b/source/blender/bmesh/intern/bmesh_mods.h
@@ -79,15 +79,16 @@ bool BM_edge_rotate_check_degenerate(BMEdge *e, BMLoop *l1, BMLoop *l2);
bool BM_edge_rotate_check_beauty(BMEdge *e, BMLoop *l1, BMLoop *l2);
BMEdge *BM_edge_rotate(BMesh *bm, BMEdge *e, const bool ccw, const short check_flag);
-/* flags for BM_edge_rotate */
+/** Flags for #BM_edge_rotate */
enum {
- BM_EDGEROT_CHECK_EXISTS =
- (1 << 0), /* disallow to rotate when the new edge matches an existing one */
- BM_EDGEROT_CHECK_SPLICE =
- (1 << 1), /* overrides existing check, if the edge already, rotate and merge them */
- BM_EDGEROT_CHECK_DEGENERATE = (1
- << 2), /* disallow creating bow-tie, concave or zero area faces */
- BM_EDGEROT_CHECK_BEAUTY = (1 << 3), /* disallow to rotate into ugly topology */
+ /** Disallow to rotate when the new edge matches an existing one. */
+ BM_EDGEROT_CHECK_EXISTS = (1 << 0),
+ /** Overrides existing check, if the edge already, rotate and merge them. */
+ BM_EDGEROT_CHECK_SPLICE = (1 << 1),
+ /** Disallow creating bow-tie, concave or zero area faces */
+ BM_EDGEROT_CHECK_DEGENERATE = (1 << 2),
+ /** Disallow to rotate into ugly topology. */
+ BM_EDGEROT_CHECK_BEAUTY = (1 << 3),
};
BMVert *BM_face_loop_separate(BMesh *bm, BMLoop *l_sep);
diff --git a/source/blender/bmesh/intern/bmesh_operator_api.h b/source/blender/bmesh/intern/bmesh_operator_api.h
index 3b543835586..f06a5fb8b13 100644
--- a/source/blender/bmesh/intern/bmesh_operator_api.h
+++ b/source/blender/bmesh/intern/bmesh_operator_api.h
@@ -300,8 +300,8 @@ typedef struct BMOpSlot {
/* BMOpDefine->type_flag */
typedef enum {
BMO_OPTYPE_FLAG_NOP = 0,
- BMO_OPTYPE_FLAG_UNTAN_MULTIRES =
- (1 << 0), /* switch from multires tangent space to absolute coordinates */
+ /** Switch from multires tangent space to absolute coordinates. */
+ BMO_OPTYPE_FLAG_UNTAN_MULTIRES = (1 << 0),
BMO_OPTYPE_FLAG_NORMALS_CALC = (1 << 1),
BMO_OPTYPE_FLAG_SELECT_FLUSH = (1 << 2),
BMO_OPTYPE_FLAG_SELECT_VALIDATE = (1 << 3),
diff --git a/source/blender/makesrna/RNA_access.h b/source/blender/makesrna/RNA_access.h
index 5045137fd95..30e24917b83 100644
--- a/source/blender/makesrna/RNA_access.h
+++ b/source/blender/makesrna/RNA_access.h
@@ -1205,7 +1205,7 @@ bool RNA_enum_is_equal(struct bContext *C,
const char *name,
const char *enumname);
-/* lower level functions that don't use a PointerRNA */
+/* Lower level functions that don't use a PointerRNA. */
bool RNA_enum_value_from_id(const EnumPropertyItem *item, const char *identifier, int *r_value);
bool RNA_enum_id_from_value(const EnumPropertyItem *item, int value, const char **r_identifier);
bool RNA_enum_icon_from_value(const EnumPropertyItem *item, int value, int *r_icon);
@@ -1425,14 +1425,19 @@ void _RNA_warning(const char *format, ...) ATTR_PRINTF_FORMAT(1, 2);
/* Equals test. */
-/* Note: In practice, EQ_STRICT and EQ_COMPARE have same behavior currently,
- * and will yield same result. */
+/**
+ * \note In practice, #EQ_STRICT and #EQ_COMPARE have same behavior currently,
+ * and will yield same result.
+ */
typedef enum eRNACompareMode {
/* Only care about equality, not full comparison. */
- RNA_EQ_STRICT, /* set/unset ignored */
- RNA_EQ_UNSET_MATCH_ANY, /* unset property matches anything */
- RNA_EQ_UNSET_MATCH_NONE, /* unset property never matches set property */
- /* Full comparison. */
+ /** Set/unset ignored. */
+ RNA_EQ_STRICT,
+ /** Unset property matches anything. */
+ RNA_EQ_UNSET_MATCH_ANY,
+ /** Unset property never matches set property. */
+ RNA_EQ_UNSET_MATCH_NONE,
+ /** Full comparison. */
RNA_EQ_COMPARE,
} eRNACompareMode;
@@ -1448,33 +1453,38 @@ bool RNA_struct_equals(struct Main *bmain,
/* Override. */
-/* flags for RNA_struct_override_matches. */
+
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list