[Bf-blender-cvs] [84a9647f223] master: Cleanup: use doxy sections for space types
Campbell Barton
noreply at git.blender.org
Thu May 31 09:51:24 CEST 2018
Commit: 84a9647f223d46ba6c159f00b3df1cbb41fde9d2
Author: Campbell Barton
Date: Thu May 31 09:49:58 2018 +0200
Branches: master
https://developer.blender.org/rB84a9647f223d46ba6c159f00b3df1cbb41fde9d2
Cleanup: use doxy sections for space types
Also use struct names in enum/define comments.
===================================================================
M source/blender/makesdna/DNA_space_types.h
===================================================================
diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h
index 7de5d6267b6..96f512cab0f 100644
--- a/source/blender/makesdna/DNA_space_types.h
+++ b/source/blender/makesdna/DNA_space_types.h
@@ -67,8 +67,9 @@ struct MovieClipScopes;
struct Mask;
struct BLI_mempool;
-
-/* SpaceLink (Base) ==================================== */
+/* -------------------------------------------------------------------- */
+/** \name SpaceLink (Base)
+ * \{ */
/**
* The base structure all the other spaces
@@ -83,8 +84,9 @@ typedef struct SpaceLink {
short blockhandler[8] DNA_DEPRECATED; /* XXX make deprecated */
} SpaceLink;
-
-/* Space Info ========================================== */
+/* -------------------------------------------------------------------- */
+/** \name Space Info
+ * \{ */
/* Info Header */
typedef struct SpaceInfo {
@@ -93,7 +95,7 @@ typedef struct SpaceInfo {
int spacetype;
float blockscale DNA_DEPRECATED;
short blockhandler[8] DNA_DEPRECATED; /* XXX make deprecated */
-
+
char rpt_mask;
char pad[7];
} SpaceInfo;
@@ -107,8 +109,11 @@ typedef enum eSpaceInfo_RptMask {
INFO_RPT_ERR = (1 << 4),
} eSpaceInfo_RptMask;
+/** \} */
-/* Properties Editor ==================================== */
+/* -------------------------------------------------------------------- */
+/** \name Properties Editor
+ * \{ */
/* Properties Editor */
typedef struct SpaceButs {
@@ -116,18 +121,18 @@ typedef struct SpaceButs {
ListBase regionbase; /* storage of regions for inactive spaces */
int spacetype;
float blockscale DNA_DEPRECATED;
-
+
short blockhandler[8] DNA_DEPRECATED;
View2D v2d DNA_DEPRECATED; /* deprecated, copied to region */
-
+
short mainb, mainbo, mainbuser; /* context tabs */
short re_align, align; /* align for panels */
short preview; /* preview is signal to refresh */
/* texture context selector (material, lamp, particles, world, other) */
short texture_context, texture_context_prev;
char flag, pad[7];
-
+
void *path; /* runtime */
int pathflag, dataicon; /* runtime */
ID *pinid;
@@ -136,18 +141,18 @@ typedef struct SpaceButs {
} SpaceButs;
/* button defines (deprecated) */
-/* warning: the values of these defines are used in sbuts->tabs[8] */
-/* sbuts->mainb new */
+#ifdef DNA_DEPRECATED_ALLOW
+/* warning: the values of these defines are used in SpaceButs.tabs[8] */
+/* SpaceButs.mainb new */
#define CONTEXT_SCENE 0
#define CONTEXT_OBJECT 1
-#define CONTEXT_TYPES 2
+// #define CONTEXT_TYPES 2
#define CONTEXT_SHADING 3
#define CONTEXT_EDITING 4
-#define CONTEXT_SCRIPT 5
+// #define CONTEXT_SCRIPT 5
#define CONTEXT_LOGIC 6
-/* sbuts->mainb old (deprecated) */
-#ifdef DNA_DEPRECATED_ALLOW
+/* SpaceButs.mainb old (deprecated) */
// #define BUTS_VIEW 0
#define BUTS_LAMP 1
#define BUTS_MAT 2
@@ -163,9 +168,9 @@ typedef struct SpaceButs {
// #define BUTS_SOUND 12
#define BUTS_CONSTRAINT 13
// #define BUTS_EFFECTS 14
-#endif
+#endif /* DNA_DEPRECATED_ALLOW */
-/* buts->mainb new */
+/* SpaceButs.mainb new */
typedef enum eSpaceButtons_Context {
BCONTEXT_RENDER = 0,
BCONTEXT_SCENE = 1,
@@ -181,12 +186,12 @@ typedef enum eSpaceButtons_Context {
BCONTEXT_CONSTRAINT = 11,
BCONTEXT_BONE_CONSTRAINT = 12,
BCONTEXT_RENDER_LAYER = 13,
-
+
/* always as last... */
BCONTEXT_TOT
} eSpaceButtons_Context;
-/* sbuts->flag */
+/* SpaceButs.flag */
typedef enum eSpaceButtons_Flag {
SB_PRV_OSA = (1 << 0),
SB_PIN_CONTEXT = (1 << 1),
@@ -196,7 +201,7 @@ typedef enum eSpaceButtons_Flag {
SB_SHADING_CONTEXT = (1 << 4),
} eSpaceButtons_Flag;
-/* sbuts->texture_context */
+/* SpaceButs.texture_context */
typedef enum eSpaceButtons_Texture_Context {
SB_TEXC_MATERIAL = 0,
SB_TEXC_WORLD = 1,
@@ -206,7 +211,7 @@ typedef enum eSpaceButtons_Texture_Context {
SB_TEXC_LINESTYLE = 5,
} eSpaceButtons_Texture_Context;
-/* sbuts->align */
+/* SpaceButs.align */
typedef enum eSpaceButtons_Align {
BUT_FREE = 0,
BUT_HORIZONTAL = 1,
@@ -214,7 +219,7 @@ typedef enum eSpaceButtons_Align {
BUT_AUTO = 3,
} eSpaceButtons_Align;
-/* sbuts->scaflag */
+/* SpaceButs.scaflag */
#define BUTS_SENS_SEL 1
#define BUTS_SENS_ACT 2
#define BUTS_SENS_LINK 4
@@ -229,7 +234,11 @@ typedef enum eSpaceButtons_Align {
#define BUTS_CONT_INIT_STATE 2048
-/* Outliner =============================================== */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Outliner
+ * \{ */
/* Outliner */
typedef struct SpaceOops {
@@ -240,9 +249,9 @@ typedef struct SpaceOops {
short blockhandler[8] DNA_DEPRECATED;
View2D v2d DNA_DEPRECATED; /* deprecated, copied to region */
-
+
ListBase tree;
-
+
/* treestore is an ordered list of TreeStoreElem's from outliner tree;
* Note that treestore may contain duplicate elements if element
* is used multiple times in outliner tree (e. g. linked objects)
@@ -250,19 +259,19 @@ typedef struct SpaceOops {
* therefore readfile.c/writefile.c linearize treestore into TreeStore structure
*/
struct BLI_mempool *treestore;
-
+
/* search stuff */
char search_string[64];
struct TreeStoreElem search_tse;
short flag, outlinevis, storeflag, search_flags;
-
+
/* pointers to treestore elements, grouped by (id, type, nr) in hashtable for faster searching */
void *treehash;
} SpaceOops;
-/* SpaceOops->flag */
+/* SpaceOops.flag */
typedef enum eSpaceOutliner_Flag {
SO_TESTBLOCKS = (1 << 0),
SO_NEWSELECTED = (1 << 1),
@@ -271,7 +280,7 @@ typedef enum eSpaceOutliner_Flag {
SO_SKIP_SORT_ALPHA = (1 << 4),
} eSpaceOutliner_Flag;
-/* SpaceOops->outlinevis */
+/* SpaceOops.outlinevis */
typedef enum eSpaceOutliner_Mode {
SO_ALL_SCENES = 0,
SO_CUR_SCENE = 1,
@@ -290,7 +299,7 @@ typedef enum eSpaceOutliner_Mode {
SO_ID_ORPHANS = 14,
} eSpaceOutliner_Mode;
-/* SpaceOops->storeflag */
+/* SpaceOops.storeflag */
typedef enum eSpaceOutliner_StoreFlag {
/* cleanup tree */
SO_TREESTORE_CLEANUP = (1 << 0),
@@ -301,15 +310,18 @@ typedef enum eSpaceOutliner_StoreFlag {
SO_TREESTORE_REBUILD = (1 << 2),
} eSpaceOutliner_StoreFlag;
-/* outliner search flags (SpaceOops->search_flags) */
+/* outliner search flags (SpaceOops.search_flags) */
typedef enum eSpaceOutliner_Search_Flags {
SO_FIND_CASE_SENSITIVE = (1 << 0),
SO_FIND_COMPLETE = (1 << 1),
SO_SEARCH_RECURSIVE = (1 << 2),
} eSpaceOutliner_Search_Flags;
+/** \} */
-/* Graph Editor ========================================= */
+/* -------------------------------------------------------------------- */
+/** \name Graph Editor
+ * \{ */
/* 'Graph' Editor (formerly known as the IPO Editor) */
typedef struct SpaceIpo {
@@ -318,17 +330,17 @@ typedef struct SpaceIpo {
int spacetype;
float blockscale DNA_DEPRECATED;
short blockhandler[8] DNA_DEPRECATED;
-
+
View2D v2d DNA_DEPRECATED; /* deprecated, copied to region */
-
+
struct bDopeSheet *ads; /* settings for filtering animation data (NOTE: we use a pointer due to code-linking issues) */
-
+
ListBase ghostCurves; /* sampled snapshots of F-Curves used as in-session guides */
-
+
short mode; /* mode for the Graph editor (eGraphEdit_Mode) */
short autosnap; /* time-transform autosnapping settings for Graph editor (eAnimEdit_AutoSnap in DNA_action_types.h) */
int flag; /* settings for Graph editor (eGraphEdit_Flag) */
-
+
float cursorTime; /* time value for cursor (when in drivers mode; animation uses current frame) */
float cursorVal; /* cursor value (y-value, x-value is current frame) */
int around; /* pivot point for transforms */
@@ -336,11 +348,11 @@ typedef struct SpaceIpo {
} SpaceIpo;
-/* SpaceIpo->flag (Graph Editor Settings) */
+/* SpaceIpo.flag (Graph Editor Settings) */
typedef enum eGraphEdit_Flag {
/* OLD DEPRECEATED SETTING */
/* SIPO_LOCK_VIEW = (1 << 0), */
-
+
/* don't merge keyframes on the same frame after a transform */
SIPO_NOTRANSKEYCULL = (1 << 1),
/* don't show any keyframe handles at all */
@@ -373,7 +385,7 @@ typedef enum eGraphEdit_Flag {
SIPO_NORMALIZE_FREEZE = (1 << 15),
} eGraphEdit_Flag;
-/* SpaceIpo->mode (Graph Editor Mode) */
+/* SpaceIpo.mode (Graph Editor Mode) */
typedef enum eGraphEdit_Mode {
/* all animation curves (from all over Blender) */
SIPO_MODE_ANIMATION = 0,
@@ -381,8 +393,11 @@ typedef enum eGraphEdit_Mode {
SIPO_MODE_DRIVERS = 1,
} eGraphEdit_Mode;
+/** \} */
-/* NLA Editor ============================================= */
+/* -------------------------------------------------------------------- */
+/** \name NLA Editor
+ * \{ */
/* NLA Editor */
typedef struct SpaceNla {
@@ -395,12 +410,12 @@ typedef struct SpaceNla {
short autosnap; /* this uses the same settings as autosnap for Action Editor */
short flag;
int pad;
-
+
struct bDopeSheet *ads;
View2D v2d DNA_DEPRECATED; /* deprecated, copied to region */
} SpaceNla;
-/* nla->flag */
+/* SpaceNla.flag */
typedef enum eSpaceNla_Flag {
/* flags (1<<0), (1<<1), and (1<<3) are deprecated flags from old verisons */
@@ -416,8 +431,11 @@ typedef enum eSpaceNla_Flag {
SNLA_NOLOCALMARKERS = (1 << 7),
} eSpaceNla_Flag;
+/** \} */
-/* Timeline =============================================== */
+/* -------------------------------------------------------------------- */
+/** \name Timeline
+ * \{ */
/* Pointcache drawing data */
# /* Only store the data array in the cache to avoid constant reallocation. */
@@ -433,7 +451,7 @@ typedef struct SpaceTime {
ListBase regionbase; /* storage of regions for inactive spaces */
int spacetype;
float blockscale DNA_DEPRECATED;
-
+
View2D v2d DNA_DEPRECATED; /* deprecated, copied to region */
ListBase caches;
@@ -443,7 +461,7 @@ typedef struct SpaceTime {
} SpaceTime;
-/* time->flag */
+/* SpaceTime.flag */
typedef enum eTimeline_Flag {
/*
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list