[Bf-blender-cvs] [f91b21f85bd] master: Cleanup: move comments above definitions

Campbell Barton noreply at git.blender.org
Mon Jan 14 06:30:52 CET 2019


Commit: f91b21f85bdc10c3ad31e9b3cacbd912bc6517c2
Author: Campbell Barton
Date:   Mon Jan 14 16:30:43 2019 +1100
Branches: master
https://developer.blender.org/rBf91b21f85bdc10c3ad31e9b3cacbd912bc6517c2

Cleanup: move comments above definitions

For clang-format not to wrap definitions.

===================================================================

M	source/blender/blenkernel/intern/unit.c
M	source/blender/bmesh/tools/bmesh_decimate_collapse.c
M	source/blender/draw/engines/eevee/eevee_lightcache.c
M	source/blender/draw/modes/shaders/edit_curve_overlay_handle_geom.glsl
M	source/blender/editors/space_view3d/view3d_fly.c
M	source/blender/editors/space_view3d/view3d_walk.c
M	source/blender/makesdna/DNA_action_types.h
M	source/blender/makesdna/DNA_image_types.h
M	source/blender/makesdna/DNA_smoke_types.h

===================================================================

diff --git a/source/blender/blenkernel/intern/unit.c b/source/blender/blenkernel/intern/unit.c
index 1d4980283d9..a847a658a04 100644
--- a/source/blender/blenkernel/intern/unit.c
+++ b/source/blender/blenkernel/intern/unit.c
@@ -86,29 +86,42 @@
 /* define a single unit */
 typedef struct bUnitDef {
 	const char *name;
-	const char *name_plural; /* abused a bit for the display name */
-	const char *name_short; /* this is used for display*/
-	const char *name_alt; /* keyboard-friendly ASCII-only version of name_short, can be NULL */
+	/** abused a bit for the display name */
+	const char *name_plural;
+	/** this is used for display*/
+	const char *name_short;
+	/** keyboard-friendly ASCII-only version of name_short, can be NULL */
+	const char *name_alt;
 	/* if name_short has non-ASCII chars, name_alt should be present */
 
-	const char *name_display; /* can be NULL */
-	const char *identifier; /* when NULL, a transformed version of the name will be taken */
+	/** can be NULL */
+	const char *name_display;
+	/** when NULL, a transformed version of the name will be taken */
+	const char *identifier;
 
 	double scalar;
-	double bias; /* not used yet, needed for converting temperature */
+	/** not used yet, needed for converting temperature */
+	double bias;
 	int flag;
 } bUnitDef;
 
-#define B_UNIT_DEF_NONE 0
-#define B_UNIT_DEF_SUPPRESS 1 /* Use for units that are not used enough to be translated into for common use */
-#define B_UNIT_DEF_TENTH 2 /* Display a unit even if its value is 0.1, eg 0.1mm instead of 100um */
+enum {
+	B_UNIT_DEF_NONE = 0,
+	/** Use for units that are not used enough to be translated into for common use */
+	B_UNIT_DEF_SUPPRESS = 1,
+	/** Display a unit even if its value is 0.1, eg 0.1mm instead of 100um */
+	B_UNIT_DEF_TENTH = 2,
+};
 
 /* define a single unit */
 typedef struct bUnitCollection {
 	const struct bUnitDef *units;
-	int base_unit; /* basic unit index (when user doesn't specify unit explicitly) */
-	int flag; /* options for this system */
-	int length; /* to quickly find the last item */
+	/** basic unit index (when user doesn't specify unit explicitly) */
+	int base_unit;
+	/** options for this system */
+	int flag;
+	/** to quickly find the last item */
+	int length;
 } bUnitCollection;
 
 #define UNIT_COLLECTION_LENGTH(def) (sizeof(def) / sizeof(bUnitDef) - 1)
diff --git a/source/blender/bmesh/tools/bmesh_decimate_collapse.c b/source/blender/bmesh/tools/bmesh_decimate_collapse.c
index 47bd018736c..7dc68e0d31f 100644
--- a/source/blender/bmesh/tools/bmesh_decimate_collapse.c
+++ b/source/blender/bmesh/tools/bmesh_decimate_collapse.c
@@ -58,17 +58,18 @@
 /* defines for testing */
 #define USE_CUSTOMDATA
 #define USE_TRIANGULATE
-#define USE_VERT_NORMAL_INTERP  /* has the advantage that flipped faces don't mess up vertex normals */
+/** Has the advantage that flipped faces don't mess up vertex normals. */
+#define USE_VERT_NORMAL_INTERP
 
-/* if the cost from #BLI_quadric_evaluate is 'noise', fallback to topology */
+/** if the cost from #BLI_quadric_evaluate is 'noise', fallback to topology */
 #define USE_TOPOLOGY_FALLBACK
 #ifdef  USE_TOPOLOGY_FALLBACK
-/* cost is calculated with double precision, it's ok to use a very small epsilon, see T48154. */
+/** cost is calculated with double precision, it's ok to use a very small epsilon, see T48154. */
 #  define   TOPOLOGY_FALLBACK_EPS  1e-12f
 #endif
 
 #define BOUNDARY_PRESERVE_WEIGHT 100.0f
-/* Uses double precision, impacts behavior on near-flat surfaces,
+/** Uses double precision, impacts behavior on near-flat surfaces,
  * cane give issues with very small faces. 1e-2 is too big, see: T48154. */
 #define OPTIMIZE_EPS 1e-8
 #define COST_INVALID FLT_MAX
diff --git a/source/blender/draw/engines/eevee/eevee_lightcache.c b/source/blender/draw/engines/eevee/eevee_lightcache.c
index 899db325fc6..38a4552e4d8 100644
--- a/source/blender/draw/engines/eevee/eevee_lightcache.c
+++ b/source/blender/draw/engines/eevee/eevee_lightcache.c
@@ -71,7 +71,8 @@
 #  define IRRADIANCE_FORMAT GPU_RGBA8
 #endif
 
-#define IRRADIANCE_MAX_POOL_LAYER 256 /* OpenGL 3.3 core requirement, can be extended but it's already very big */
+/* OpenGL 3.3 core requirement, can be extended but it's already very big */
+#define IRRADIANCE_MAX_POOL_LAYER 256
 #define IRRADIANCE_MAX_POOL_SIZE 1024
 #define MAX_IRRADIANCE_SAMPLES \
         (IRRADIANCE_MAX_POOL_SIZE / IRRADIANCE_SAMPLE_SIZE_X) * \
diff --git a/source/blender/draw/modes/shaders/edit_curve_overlay_handle_geom.glsl b/source/blender/draw/modes/shaders/edit_curve_overlay_handle_geom.glsl
index 7bc9b381bad..bf253d0121c 100644
--- a/source/blender/draw/modes/shaders/edit_curve_overlay_handle_geom.glsl
+++ b/source/blender/draw/modes/shaders/edit_curve_overlay_handle_geom.glsl
@@ -1,7 +1,8 @@
 
 #define VERTEX_ACTIVE   1 << 0
 #define VERTEX_SELECTED 1 << 1
-#define ACTIVE_NURB     1 << 2 /* Keep the same value of `ACTIVE_NURB` in `draw_cache_imp_curve.c` */
+/* Keep the same value of `ACTIVE_NURB` in `draw_cache_imp_curve.c` */
+#define ACTIVE_NURB     1 << 2
 #define EVEN_U_BIT      1 << 3
 
 layout(lines) in;
diff --git a/source/blender/editors/space_view3d/view3d_fly.c b/source/blender/editors/space_view3d/view3d_fly.c
index de5d5d29e52..b27de9d70c2 100644
--- a/source/blender/editors/space_view3d/view3d_fly.c
+++ b/source/blender/editors/space_view3d/view3d_fly.c
@@ -28,7 +28,8 @@
 
 #ifdef WITH_INPUT_NDOF
 //#  define NDOF_FLY_DEBUG
-//#  define NDOF_FLY_DRAW_TOOMUCH  /* is this needed for ndof? - commented so redraw doesn't thrash - campbell */
+/* is this needed for ndof? - commented so redraw doesn't thrash - campbell */
+//#  define NDOF_FLY_DRAW_TOOMUCH
 #endif /* WITH_INPUT_NDOF */
 
 #include "DNA_object_types.h"
@@ -62,7 +63,8 @@
 
 #include "view3d_intern.h"  /* own include */
 
-/* NOTE: these defines are saved in keymap files, do not change values but just add new ones */
+/* NOTE: these defines are saved in keymap files,
+ * do not change values but just add new ones */
 enum {
 	FLY_MODAL_CANCEL = 1,
 	FLY_MODAL_CONFIRM,
diff --git a/source/blender/editors/space_view3d/view3d_walk.c b/source/blender/editors/space_view3d/view3d_walk.c
index a716264febb..c19a1965a56 100644
--- a/source/blender/editors/space_view3d/view3d_walk.c
+++ b/source/blender/editors/space_view3d/view3d_walk.c
@@ -65,7 +65,8 @@
 
 #ifdef WITH_INPUT_NDOF
 //#  define NDOF_WALK_DEBUG
-//#  define NDOF_WALK_DRAW_TOOMUCH  /* is this needed for ndof? - commented so redraw doesn't thrash - campbell */
+/* is this needed for ndof? - commented so redraw doesn't thrash - campbell */
+//#  define NDOF_WALK_DRAW_TOOMUCH
 #endif
 
 #define USE_TABLET_SUPPORT
@@ -76,7 +77,8 @@
 /* prototypes */
 static float getVelocityZeroTime(const float gravity, const float velocity);
 
-/* NOTE: these defines are saved in keymap files, do not change values but just add new ones */
+/* NOTE: these defines are saved in keymap files,
+ * do not change values but just add new ones */
 enum {
 	WALK_MODAL_CANCEL = 1,
 	WALK_MODAL_CONFIRM,
@@ -1378,7 +1380,8 @@ static int walk_modal(bContext *C, wmOperator *op, const wmEvent *event)
 			WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, walk_object);
 		}
 
-		// puts("redraw!"); // too frequent, commented with NDOF_WALK_DRAW_TOOMUCH for now
+		// too frequent, commented with NDOF_WALK_DRAW_TOOMUCH for now
+		// puts("redraw!");
 		ED_region_tag_redraw(CTX_wm_region(C));
 	}
 
diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h
index b870a027e5c..c328aedecb6 100644
--- a/source/blender/makesdna/DNA_action_types.h
+++ b/source/blender/makesdna/DNA_action_types.h
@@ -464,7 +464,8 @@ typedef enum eRotationModes {
 	/* quaternion rotations (default, and for older Blender versions) */
 	ROT_MODE_QUAT   = 0,
 	/* euler rotations - keep in sync with enum in BLI_math.h */
-	ROT_MODE_EUL = 1,       /* Blender 'default' (classic) - must be as 1 to sync with BLI_math_rotation.h defines */
+	/** Blender 'default' (classic) - must be as 1 to sync with BLI_math_rotation.h defines */
+	ROT_MODE_EUL = 1,
 	ROT_MODE_XYZ = 1,
 	ROT_MODE_XZY = 2,
 	ROT_MODE_YXZ = 3,
diff --git a/source/blender/makesdna/DNA_image_types.h b/source/blender/makesdna/DNA_image_types.h
index e6efe8f25c9..2ca5856796c 100644
--- a/source/blender/makesdna/DNA_image_types.h
+++ b/source/blender/makesdna/DNA_image_types.h
@@ -185,7 +185,8 @@ enum {
 	IMA_OLD_PREMUL          = (1 << 7),
 	IMA_FLAG_DEPRECATED_8   = (1 << 8),  /* cleared */
 	IMA_USED_FOR_RENDER     = (1 << 9),
-	IMA_USER_FRAME_IN_RANGE = (1 << 10), /* for image user, but these flags are mixed */
+	/** For image user, but these flags are mixed. */
+	IMA_USER_FRAME_IN_RANGE = (1 << 10),
 	IMA_VIEW_AS_RENDER      = (1 << 11),
 	IMA_IGNORE_ALPHA        = (1 << 12),
 	IMA_DEINTERLACE         = (1 << 13),
@@ -195,14 +196,18 @@ enum {
 };
 
 /* Image.tpageflag */
-#define IMA_TPAGEFLAG_DEPRECATED_0      (1 << 0)  /* cleared */
-#define IMA_TPAGEFLAG_DEPRECATED_1      (1 << 1)  /* cleared */
-#define IMA_TPAGEFLAG_DEPRECATED_2      (1 << 2)  /* cleared */
-#define IMA_MIPMAP_COMPLETE             (1 << 3)  /* all mipmap levels in OpenGL texture set? */
-#define IMA_TPAGEFLAG_DEPRECATED_4      (1 << 4)  /* cleared */
-#define IMA_TPAGEFLAG_DEPRECATED_5      (1 << 5)  /* cleared */
-#define IMA_TPAGE_REFRESH               (1 << 6)
-#define IMA_GLBIND_IS_DATA              (1 << 7) /* opengl image texture bound as non-color data */
+enum {
+	IMA_TPAGEFLAG_DEPRECATED_0 =      (1 << 0),  /* cleared */
+	IMA_TPAGEFLAG_DEPRECATED_1 =      (1 << 1),  /* cleared */
+	IMA_TPAGEFLAG_DEPRECATED_2 =      (1 << 2),  /* cleared */
+	/** All mipmap levels in OpenGL texture set? */
+	IMA_MIPMAP_COMPLETE =             (1 << 3),
+	IMA_TPAGEFLAG_DEPRECATED_4 =      (1 << 4),  /* cleared */
+	IMA_TPAGEFLAG_DEPRECATED_5 =      (1 << 5),  /* cleared */
+	IMA_TPAGE_REFRESH =               (1 << 6),
+	/** OpenGL image texture bound as non-color data. */
+	IMA_GLBIND_IS_DATA =              (1 << 7),
+};
 
 /* ima->type and ima->source moved to BKE_image.h, for API */
 
diff --git a/source/blender/makesdna/DNA_smoke_types.h b/source/blender/makesdna/DNA_smoke_types.h
index cc29ea3705c..a5bea9113c4 1

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list