[Bf-blender-cvs] [a1d73d03eb9] master: Cleanup: move comments above definitions
Campbell Barton
noreply at git.blender.org
Mon Jan 14 06:21:03 CET 2019
Commit: a1d73d03eb91be72b0f10ff4a9c6eb00f04b97c6
Author: Campbell Barton
Date: Mon Jan 14 16:15:33 2019 +1100
Branches: master
https://developer.blender.org/rBa1d73d03eb91be72b0f10ff4a9c6eb00f04b97c6
Cleanup: move comments above definitions
For clang-format not to wrap definitions.
===================================================================
M source/blender/blenkernel/BKE_constraint.h
M source/blender/editors/space_file/fsmenu.c
M source/blender/imbuf/IMB_imbuf_types.h
M source/blender/imbuf/intern/thumbs.c
M source/blender/makesdna/DNA_modifier_types.h
M source/blender/windowmanager/intern/wm_files.c
===================================================================
diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h
index bfcdcb68c4a..9e723b49b63 100644
--- a/source/blender/blenkernel/BKE_constraint.h
+++ b/source/blender/blenkernel/BKE_constraint.h
@@ -49,16 +49,24 @@ extern "C" {
/* special struct for use in constraint evaluation */
typedef struct bConstraintOb {
- struct Depsgraph *depsgraph;/* to get evaluated armature. */
- struct Scene *scene; /* for system time, part of deglobalization, code nicer later with local time (ton) */
- struct Object *ob; /* if pchan, then armature that it comes from, otherwise constraint owner */
- struct bPoseChannel *pchan; /* pose channel that owns the constraints being evaluated */
-
- float matrix[4][4]; /* matrix where constraints are accumulated + solved */
- float startmat[4][4]; /* original matrix (before constraint solving) */
-
- short type; /* type of owner */
- short rotOrder; /* rotation order for constraint owner (as defined in eEulerRotationOrders in BLI_math.h) */
+ /** to get evaluated armature. */
+ struct Depsgraph *depsgraph;
+ /** for system time, part of deglobalization, code nicer later with local time (ton) */
+ struct Scene *scene;
+ /** if pchan, then armature that it comes from, otherwise constraint owner */
+ struct Object *ob;
+ /** pose channel that owns the constraints being evaluated */
+ struct bPoseChannel *pchan;
+
+ /** matrix where constraints are accumulated + solved */
+ float matrix[4][4];
+ /** original matrix (before constraint solving) */
+ float startmat[4][4];
+
+ /** type of owner */
+ short type;
+ /** rotation order for constraint owner (as defined in eEulerRotationOrders in BLI_math.h) */
+ short rotOrder;
} bConstraintOb;
/* ---------------------------------------------------------------------------- */
@@ -83,31 +91,35 @@ typedef void (*ConstraintIDFunc)(struct bConstraint *con, struct ID **idpoin, bo
*/
typedef struct bConstraintTypeInfo {
/* admin/ident */
- short type; /* CONSTRAINT_TYPE_### */
- short size; /* size in bytes of the struct */
- char name[32]; /* name of constraint in interface */
- char structName[32]; /* name of struct for SDNA */
+ /** CONSTRAINT_TYPE_### */
+ short type;
+ /** size in bytes of the struct */
+ short size;
+ /** name of constraint in interface */
+ char name[32];
+ /** name of struct for SDNA */
+ char structName[32];
/* data management function pointers - special handling */
- /* free any data that is allocated separately (optional) */
+ /** free any data that is allocated separately (optional) */
void (*free_data)(struct bConstraint *con);
- /* run the provided callback function on all the ID-blocks linked to the constraint */
+ /** run the provided callback function on all the ID-blocks linked to the constraint */
void (*id_looper)(struct bConstraint *con, ConstraintIDFunc func, void *userdata);
- /* copy any special data that is allocated separately (optional) */
+ /** copy any special data that is allocated separately (optional) */
void (*copy_data)(struct bConstraint *con, struct bConstraint *src);
- /* set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */
+ /** set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */
void (*new_data)(void *cdata);
/* target handling function pointers */
- /* for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */
+ /** for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */
int (*get_constraint_targets)(struct bConstraint *con, struct ListBase *list);
- /* for single-target constraints only: flush data back to source data, and the free memory used */
+ /** for single-target constraints only: flush data back to source data, and the free memory used */
void (*flush_constraint_targets)(struct bConstraint *con, struct ListBase *list, bool no_copy);
/* evaluation */
- /* set the ct->matrix for the given constraint target (at the given ctime) */
+ /** set the ct->matrix for the given constraint target (at the given ctime) */
void (*get_target_matrix)(struct Depsgraph *depsgraph, struct bConstraint *con, struct bConstraintOb *cob, struct bConstraintTarget *ct, float ctime);
- /* evaluate the constraint for the given time */
+ /** evaluate the constraint for the given time */
void (*evaluate_constraint)(struct bConstraint *con, struct bConstraintOb *cob, struct ListBase *targets);
} bConstraintTypeInfo;
diff --git a/source/blender/editors/space_file/fsmenu.c b/source/blender/editors/space_file/fsmenu.c
index 9b1aae03219..2fa9134165d 100644
--- a/source/blender/editors/space_file/fsmenu.c
+++ b/source/blender/editors/space_file/fsmenu.c
@@ -45,9 +45,11 @@
#include "ED_fileselect.h"
#ifdef WIN32
-# include <windows.h> /* need to include windows.h so _WIN32_IE is defined */
-# include <shlobj.h> /* for SHGetSpecialFolderPath, has to be done before BLI_winstuff
- * because 'near' is disabled through BLI_windstuff */
+ /* Need to include windows.h so _WIN32_IE is defined. */
+# include <windows.h>
+ /* For SHGetSpecialFolderPath, has to be done before BLI_winstuff
+ * because 'near' is disabled through BLI_windstuff. */
+# include <shlobj.h>
# include "BLI_winstuff.h"
#endif
diff --git a/source/blender/imbuf/IMB_imbuf_types.h b/source/blender/imbuf/IMB_imbuf_types.h
index d407845e45d..309c41646ed 100644
--- a/source/blender/imbuf/IMB_imbuf_types.h
+++ b/source/blender/imbuf/IMB_imbuf_types.h
@@ -51,10 +51,14 @@
#define IMB_FILENAME_SIZE 1024
typedef struct DDSData {
- unsigned int fourcc; /* DDS fourcc info */
- unsigned int nummipmaps; /* The number of mipmaps in the dds file */
- unsigned char *data; /* The compressed image data */
- unsigned int size; /* The size of the compressed data */
+ /** DDS fourcc info */
+ unsigned int fourcc;
+ /** The number of mipmaps in the dds file */
+ unsigned int nummipmaps;
+ /** The compressed image data */
+ unsigned char *data;
+ /** The size of the compressed data */
+ unsigned int size;
} DDSData;
/**
@@ -66,9 +70,13 @@ typedef struct DDSData {
*
*/
-/* ibuf->ftype flag, main image types */
-/* Warning: Keep explicit value assignments here, this file is included in areas where not all format defines
- * are set (e.g. intern/dds only get WITH_DDS, even if TIFF, HDR etc are also defined). See T46524. */
+
+/* Warning: Keep explicit value assignments here,
+ * this file is included in areas where not all format defines are set
+ * (e.g. intern/dds only get WITH_DDS, even if TIFF, HDR etc are also defined).
+ * See T46524. */
+
+/** #ImBuf.ftype flag, main image types. */
enum eImbTypes {
IMB_FTYPE_PNG = 1,
IMB_FTYPE_TGA = 2,
@@ -136,24 +144,30 @@ enum eImbTypes {
typedef struct ImbFormatOptions {
short flag;
- char quality; /* quality serves dual purpose as quality number for jpeg or compression amount for png */
+ /** quality serves dual purpose as quality number for jpeg or compression amount for png */
+ char quality;
} ImbFormatOptions;
typedef struct ImBuf {
struct ImBuf *next, *prev; /**< allow lists of ImBufs, for caches or flipbooks */
/* dimensions */
- int x, y; /* width and Height of our image buffer.
- * Should be 'unsigned int' since most formats use this.
- * but this is problematic with texture math in imagetexture.c
- * avoid problems and use int. - campbell */
+ /** Width and Height of our image buffer.
+ * Should be 'unsigned int' since most formats use this.
+ * but this is problematic with texture math in imagetexture.c
+ * avoid problems and use int. - campbell */
+ int x, y;
- unsigned char planes; /* Active amount of bits/bitplanes */
- int channels; /* amount of channels in rect_float (0 = 4 channel default) */
+ /** Active amount of bits/bitplanes */
+ unsigned char planes;
+ /** Number of channels in `rect_float` (0 = 4 channel default) */
+ int channels;
/* flags */
- int flags; /* Controls which components should exist. */
- int mall; /* what is malloced internal, and can be freed */
+ /** Controls which components should exist. */
+ int flags;
+ /** what is malloced internal, and can be freed */
+ int mall;
/* pixels */
@@ -179,42 +193,63 @@ typedef struct ImBuf {
unsigned int **tiles;
/* zbuffer */
- int *zbuf; /* z buffer data, original zbuffer */
- float *zbuf_float; /* z buffer data, camera coordinates */
+ /** z buffer data, original zbuffer */
+ int *zbuf;
+ /** z buffer data, camera coordinates */
+ float *zbuf_float;
/* parameters used by conversion between byte and float */
- float dither; /* random dither value, for conversion from float -> byte rect */
+ /** random dither value, for conversion from float -> byte rect */
+ float dither;
/* mipmapping */
- struct ImBuf *mipmap[IMB_MIPMAP_LEVELS]; /* MipMap levels, a series of halved images */
+ /** MipMap levels, a series of halved images */
+ struct ImBuf *mipmap[IMB_MIPMAP_LEVELS];
int miptot, miplevel;
/* externally used data */
- int index; /* reference index for ImBuf lists */
- int userflags; /* used to set imbuf to dirty and other stuff */
- struct IDProperty *metadata; /* image metadata */
- void *userdata; /* temporary storage */
+ /** reference index for ImBuf lists */
+ int index;
+ /** used to set imbuf to dirty and other stuff */
+ int userflags;
+ /** image metadata */
+ struct IDProperty *metadata;
+ /** temporary storage */
+ void *userdata;
/* file information */
- enum eImbTypes ftype; /* file type we are going to save as */
- ImbFormatOptions foptions; /* file format specific flags */
- char name[IMB_FILENAME_SIZE]; /* filename associated with this image */
- char cachename[IMB_FILENAME_SIZE]; /* full filename used for reading from cache */
+ /** file type we are going to save as */
+ enum eImbTypes ftype;
+ /** file format specific flags */
+ ImbFormatOptions foptions;
+ /** filename associated with this image */
+ cha
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list