blender
/
blender
134
400
Fork 583
Code Issues 6.3k Pull Requests 757 Projects 19 Wiki Activity

Cleanup: use doxy comments

This commit is contained in:
Campbell Barton 2019-09-05 03:16:22 +10:00
parent c7b9ae310b
commit 933725ab46
1 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
source/blender/makesdna/DNA_userdef_types.h
View File

@ -64,7 +64,7 @@ typedef struct uiFont {
char _pad0[2];
} uiFont;
/* this state defines appearance of text */
/** This state defines appearance of text. */
typedef struct uiFontStyle {
/** Saved in file, 0 is default. */
short uifont_id;
@ -430,15 +430,22 @@ typedef enum eWireColor_Flags {
TH_WIRECOLOR_TEXTCOLS = (1 << 1),
} eWireColor_Flags;
/* A theme */
/**
* A theme.
*
* \note Currently only a single theme is ever used at once.
* Different theme presets are stored as external files now.
*/
typedef struct bTheme {
struct bTheme *next, *prev;
char name[32];
ThemeUI tui;
/* Individual Spacetypes */
/* note: ensure UI_THEMESPACE_END is updated when adding */
/**
* Individual Spacetypes:
* \note Ensure #UI_THEMESPACE_END is updated when adding.
*/
ThemeSpace space_properties;
ThemeSpace space_view3d;
ThemeSpace space_file;
@ -494,7 +501,7 @@ typedef struct bUserMenu {
ListBase items;
} bUserMenu;
/* May be part of bUserMenu or other list. */
/** May be part of #bUserMenu or other list. */
typedef struct bUserMenuItem {
struct bUserMenuItem *next, *prev;
char ui_name[64];
@ -556,7 +563,7 @@ typedef struct UserDef_Runtime {
} UserDef_Runtime;
typedef struct UserDef {
/* UserDef has separate do-version handling, and can be read from other files */
/** UserDef has separate do-version handling, and can be read from other files. */
int versionfile, subversionfile;
/** #eUserPref_Flag. */
@ -640,7 +647,7 @@ typedef struct UserDef {
short transopts;
short menuthreshold1, menuthreshold2;
/* startup template */
/** Startup application template. */
char app_template[64];
struct ListBase themes;
@ -835,7 +842,7 @@ typedef enum eUserPref_Section {
USER_SECTION_FILE_PATHS = 15,
} eUserPref_Section;
/* UserDef.userpref_flag (State of the user preferences UI). */
/** UserDef.userpref_flag (State of the user preferences UI). */
typedef enum eUserPref_SectionFlag {
/* Hide/expand keymap preferences. */
USER_SECTION_INPUT_HIDE_UI_KEYCONFIG = (1 << 0),
@ -1091,26 +1098,23 @@ typedef enum eColorPicker_Types {
/** Timecode display styles
* #UserDef.timecode_style */
typedef enum eTimecodeStyles {
/* as little info as is necessary to show relevant info
* with '+' to denote the frames
* i.e. HH:MM:SS+FF, MM:SS+FF, SS+FF, or MM:SS
/**
* As little info as is necessary to show relevant info with '+' to denote the frames
* i.e. HH:MM:SS+FF, MM:SS+FF, SS+FF, or MM:SS.
*/
USER_TIMECODE_MINIMAL = 0,
/* reduced SMPTE - (HH:)MM:SS:FF */
/** Reduced SMPTE - (HH:)MM:SS:FF */
USER_TIMECODE_SMPTE_MSF = 1,
/* full SMPTE - HH:MM:SS:FF */
/** Full SMPTE - HH:MM:SS:FF */
USER_TIMECODE_SMPTE_FULL = 2,
/* milliseconds for sub-frames - HH:MM:SS.sss */
/** Milliseconds for sub-frames - HH:MM:SS.sss. */
USER_TIMECODE_MILLISECONDS = 3,
/* seconds only */
/** Seconds only. */
USER_TIMECODE_SECONDS_ONLY = 4,
/* Private (not exposed as generic choices) options. */
/* milliseconds for sub-frames , SubRip format- HH:MM:SS,sss */
/**
* Private (not exposed as generic choices) options.
* milliseconds for sub-frames , SubRip format- HH:MM:SS,sss.
*/
USER_TIMECODE_SUBRIP = 100,
} eTimecodeStyles;
@ -1120,15 +1124,14 @@ typedef enum eNdof_Flag {
NDOF_FLY_HELICOPTER = (1 << 1),
NDOF_LOCK_HORIZON = (1 << 2),
/* the following might not need to be saved between sessions,
* but they do need to live somewhere accessible... */
/* The following might not need to be saved between sessions,
* but they do need to live somewhere accessible. */
NDOF_SHOULD_PAN = (1 << 3),
NDOF_SHOULD_ZOOM = (1 << 4),
NDOF_SHOULD_ROTATE = (1 << 5),
/* orbit navigation modes */
/* Orbit navigation modes. */
/* exposed as Orbit|Explore in the UI */
NDOF_MODE_ORBIT = (1 << 6),
/* actually... users probably don't care about what the mode