Cleanup: use doxygen links to struct members

This commit is contained in:
Campbell Barton 2022-04-05 08:00:20 +10:00
parent b51d6d5068
commit 521fab080b
20 changed files with 61 additions and 61 deletions

View File

@ -21,7 +21,7 @@ struct CustomDataLayer;
struct ID;
struct ReportList;
/* Attribute.domain */
/** #Attribute.domain */
typedef enum AttributeDomain {
ATTR_DOMAIN_AUTO = -1, /* Use for nodes to choose automatically based on other data. */
ATTR_DOMAIN_POINT = 0, /* Mesh, Curve or Point Cloud Point */

View File

@ -20,7 +20,7 @@ struct bGPDlayer;
struct bGPDstroke;
struct bGPdata;
/* GPencilUpdateCache.flag */
/** #GPencilUpdateCache.flag */
typedef enum eGPUpdateCacheNodeFlag {
/* Node is a placeholder (e.g. when only an index is needed). */
GP_UPDATE_NODE_NO_COPY = 0,

View File

@ -73,7 +73,7 @@ typedef struct MainIDRelationsEntry {
uint tags;
} MainIDRelationsEntry;
/* MainIDRelationsEntry.tags */
/** #MainIDRelationsEntry.tags */
typedef enum eMainIDRelationsEntryTags {
/* Generic tag marking the entry as to be processed. */
MAINIDRELATIONS_ENTRY_TAGS_DOIT = 1 << 0,

View File

@ -57,7 +57,7 @@ struct ImBuf;
struct GPUTexture;
struct StudioLight;
/* StudioLight.flag */
/** #StudioLight.flag */
enum StudioLightFlag {
STUDIOLIGHT_SPHERICAL_HARMONICS_COEFFICIENTS_CALCULATED = (1 << 0),
/* STUDIOLIGHT_LIGHT_DIRECTION_CALCULATED = (1 << 1), */

View File

@ -49,19 +49,19 @@ typedef struct ScanFillVertLink {
#define SF_EPSILON 0.00003f
#define SF_EPSILON_SQ (SF_EPSILON * SF_EPSILON)
/* ScanFillVert.status */
/** #ScanFillVert.status */
#define SF_VERT_NEW 0 /* all new verts have this flag set */
#define SF_VERT_AVAILABLE 1 /* available - in an edge */
#define SF_VERT_ZERO_LEN 2
/* ScanFillEdge.status */
/** #ScanFillEdge.status */
/* Optionally set ScanFillEdge f to this to mark original boundary edges.
* Only needed if there are internal diagonal edges passed to BLI_scanfill_calc. */
#define SF_EDGE_NEW 0 /* all new edges have this flag set */
// #define SF_EDGE_BOUNDARY 1 /* UNUSED */
#define SF_EDGE_INTERNAL 2 /* edge is created while scan-filling */
/* PolyFill.status */
/** #PolyFill.status */
#define SF_POLY_NEW 0 /* all polys initialized to this */
#define SF_POLY_VALID 1 /* has at least 3 verts */

View File

@ -354,7 +354,7 @@ static void do_versions_theme(const UserDef *userdef, bTheme *btheme)
#undef USER_VERSION_ATLEAST
}
/* UserDef.flag */
/** #UserDef.flag */
#define USER_LMOUSESELECT (1 << 14) /* deprecated */
static void do_version_select_mouse(UserDef *userdef, wmKeyMapItem *kmi)

View File

@ -43,7 +43,7 @@ typedef struct NumInput {
int str_cur;
} NumInput;
/* NumInput.flag */
/** #NumInput.flag */
enum {
NUM_AFFECT_ALL = (1 << 0),
/* (1 << 9) and above are reserved for internal flags! */

View File

@ -2948,7 +2948,7 @@ uiBlock *UI_region_block_find_mouse_over(const struct ARegion *region,
*/
struct ARegion *UI_region_searchbox_region_get(const struct ARegion *button_region);
/* uiFontStyle.align */
/** #uiFontStyle.align */
typedef enum eFontStyle_Align {
UI_STYLE_TEXT_LEFT = 0,
UI_STYLE_TEXT_CENTER = 1,

View File

@ -329,7 +329,7 @@ typedef struct FileListEntryCache {
int previews_todo_count;
} FileListEntryCache;
/* FileListCache.flags */
/** #FileListCache.flags */
enum {
FLC_IS_INIT = 1 << 0,
FLC_PREVIEWS_ACTIVE = 1 << 1,
@ -359,7 +359,7 @@ typedef struct FileListFilter {
FileAssetCatalogFilterSettingsHandle *asset_catalog_filter;
} FileListFilter;
/* FileListFilter.flags */
/** #FileListFilter.flags */
enum {
FLF_DO_FILTER = 1 << 0,
FLF_HIDE_DOT = 1 << 1,
@ -421,7 +421,7 @@ typedef struct FileList {
short tags; /* FileListTags */
} FileList;
/* FileList.flags */
/** #FileList.flags */
enum {
FL_FORCE_RESET = 1 << 0,
/* Don't do a full reset (unless #FL_FORCE_RESET is also set), only reset files representing main
@ -434,7 +434,7 @@ enum {
FL_SORT_INVERT = 1 << 6,
};
/* FileList.tags */
/** #FileList.tags */
enum FileListTags {
/** The file list has references to main data (IDs) and needs special care. */
FILELIST_TAGS_USES_MAIN_DATA = (1 << 0),

View File

@ -335,7 +335,7 @@ enum {
/* 2 characters for ID code and 64 for actual name */
#define MAX_ID_NAME 66
/* ID_Runtime_Remap.status */
/** #ID_Runtime_Remap.status */
enum {
/** new_id is directly linked in current .blend. */
ID_REMAP_IS_LINKED_DIRECT = 1 << 0,
@ -476,7 +476,7 @@ typedef struct Library {
short versionfile, subversionfile;
} Library;
/* Library.tag */
/** #Library.tag */
enum eLibrary_Tag {
/* Automatic recursive resync was needed when linking/loading data from that library. */
LIBRARY_TAG_RESYNC_REQUIRED = 1 << 0,

View File

@ -277,7 +277,7 @@ typedef enum eBrushSnakeHookDeformType {
BRUSH_SNAKE_HOOK_DEFORM_ELASTIC = 1,
} eBrushSnakeHookDeformType;
/* Gpencilsettings.Vertex_mode */
/** #Gpencilsettings.Vertex_mode */
typedef enum eGp_Vertex_Mode {
/* Affect to Stroke only. */
GPPAINT_MODE_STROKE = 0,
@ -327,7 +327,7 @@ typedef enum ePaintBrush_flag {
BRUSH_PAINT_DENSITY_PRESSURE_INVERT = (1 << 9),
} ePaintBrush_flag;
/* Brush.gradient_source */
/** #Brush.gradient_source */
typedef enum eBrushGradientSourceStroke {
BRUSH_GRADIENT_PRESSURE = 0, /* gradient from pressure */
BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
@ -339,7 +339,7 @@ typedef enum eBrushGradientSourceFill {
BRUSH_GRADIENT_RADIAL = 1, /* gradient from spacing */
} eBrushGradientSourceFill;
/* Brush.flag */
/** #Brush.flag */
typedef enum eBrushFlags {
BRUSH_AIRBRUSH = (1 << 0),
BRUSH_INVERT_TO_SCRAPE_FILL = (1 << 1),
@ -375,12 +375,12 @@ typedef enum eBrushFlags {
BRUSH_CURVE = (1u << 31),
} eBrushFlags;
/* Brush.sampling_flag */
/** #Brush.sampling_flag */
typedef enum eBrushSamplingFlags {
BRUSH_PAINT_ANTIALIASING = (1 << 0),
} eBrushSamplingFlags;
/* Brush.flag2 */
/** #Brush.flag2 */
typedef enum eBrushFlags2 {
BRUSH_MULTIPLANE_SCRAPE_DYNAMIC = (1 << 0),
BRUSH_MULTIPLANE_SCRAPE_PLANES_PREVIEW = (1 << 1),
@ -398,7 +398,7 @@ typedef enum {
BRUSH_MASK_PRESSURE_CUTOFF = (1 << 2),
} BrushMaskPressureFlags;
/* Brush.overlay_flags */
/** #Brush.overlay_flags */
typedef enum eOverlayFlags {
BRUSH_OVERLAY_CURSOR = (1),
BRUSH_OVERLAY_PRIMARY = (1 << 1),
@ -412,7 +412,7 @@ typedef enum eOverlayFlags {
(BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
/* Brush.sculpt_tool */
/** #Brush.sculpt_tool */
typedef enum eBrushSculptTool {
SCULPT_TOOL_DRAW = 1,
SCULPT_TOOL_SMOOTH = 2,
@ -448,7 +448,7 @@ typedef enum eBrushSculptTool {
SCULPT_TOOL_DISPLACEMENT_SMEAR = 32,
} eBrushSculptTool;
/* Brush.uv_sculpt_tool */
/** #Brush.uv_sculpt_tool */
typedef enum eBrushUVSculptTool {
UV_SCULPT_TOOL_GRAB = 0,
UV_SCULPT_TOOL_RELAX = 1,
@ -602,7 +602,7 @@ typedef enum eBlurKernelType {
KERNEL_BOX = 1,
} eBlurKernelType;
/* Brush.falloff_shape */
/** #Brush.falloff_shape */
typedef enum eBrushFalloffShape {
PAINT_FALLOFF_SHAPE_SPHERE = 0,
PAINT_FALLOFF_SHAPE_TUBE = 1,

View File

@ -745,7 +745,7 @@ typedef enum eConstraint_EulerOrder {
/* -------------------------------------- */
/* bRotateLikeConstraint.flag */
/** #bRotateLikeConstraint.flag */
typedef enum eCopyRotation_Flags {
ROTLIKE_X = (1 << 0),
ROTLIKE_Y = (1 << 1),
@ -758,7 +758,7 @@ typedef enum eCopyRotation_Flags {
#endif
} eCopyRotation_Flags;
/* bRotateLikeConstraint.mix_mode */
/** #bRotateLikeConstraint.mix_mode */
typedef enum eCopyRotation_MixMode {
/* Replace rotation channel values. */
ROTLIKE_MIX_REPLACE = 0,
@ -772,7 +772,7 @@ typedef enum eCopyRotation_MixMode {
ROTLIKE_MIX_AFTER = 4,
} eCopyRotation_MixMode;
/* bLocateLikeConstraint.flag */
/** #bLocateLikeConstraint.flag */
typedef enum eCopyLocation_Flags {
LOCLIKE_X = (1 << 0),
LOCLIKE_Y = (1 << 1),
@ -785,7 +785,7 @@ typedef enum eCopyLocation_Flags {
LOCLIKE_OFFSET = (1 << 7),
} eCopyLocation_Flags;
/* bSizeLikeConstraint.flag */
/** #bSizeLikeConstraint.flag */
typedef enum eCopyScale_Flags {
SIZELIKE_X = (1 << 0),
SIZELIKE_Y = (1 << 1),
@ -795,13 +795,13 @@ typedef enum eCopyScale_Flags {
SIZELIKE_UNIFORM = (1 << 5),
} eCopyScale_Flags;
/* bTransLikeConstraint.flag */
/** #bTransLikeConstraint.flag */
typedef enum eCopyTransforms_Flags {
/* Remove shear from the target matrix. */
TRANSLIKE_REMOVE_TARGET_SHEAR = (1 << 0),
} eCopyTransforms_Flags;
/* bTransLikeConstraint.mix_mode */
/** #bTransLikeConstraint.mix_mode */
typedef enum eCopyTransforms_MixMode {
/* Replace rotation channel values. */
TRANSLIKE_MIX_REPLACE = 0,
@ -826,7 +826,7 @@ typedef enum eTransform_ToFrom {
TRANS_SCALE = 2,
} eTransform_ToFrom;
/* bTransformConstraint.mix_mode_loc */
/** #bTransformConstraint.mix_mode_loc */
typedef enum eTransform_MixModeLoc {
/* Add component values together (default). */
TRANS_MIXLOC_ADD = 0,
@ -834,7 +834,7 @@ typedef enum eTransform_MixModeLoc {
TRANS_MIXLOC_REPLACE = 1,
} eTransform_MixModeLoc;
/* bTransformConstraint.mix_mode_rot */
/** #bTransformConstraint.mix_mode_rot */
typedef enum eTransform_MixModeRot {
/* Add component values together (default). */
TRANS_MIXROT_ADD = 0,
@ -846,7 +846,7 @@ typedef enum eTransform_MixModeRot {
TRANS_MIXROT_AFTER = 3,
} eTransform_MixModeRot;
/* bTransformConstraint.mix_mode_scale */
/** #bTransformConstraint.mix_mode_scale */
typedef enum eTransform_MixModeScale {
/* Replace component values (default). */
TRANS_MIXSCALE_REPLACE = 0,
@ -854,14 +854,14 @@ typedef enum eTransform_MixModeScale {
TRANS_MIXSCALE_MULTIPLY = 1,
} eTransform_MixModeScale;
/* bSameVolumeConstraint.free_axis */
/** #bSameVolumeConstraint.free_axis */
typedef enum eSameVolume_Axis {
SAMEVOL_X = 0,
SAMEVOL_Y = 1,
SAMEVOL_Z = 2,
} eSameVolume_Axis;
/* bSameVolumeConstraint.mode */
/** #bSameVolumeConstraint.mode */
typedef enum eSameVolume_Mode {
/* Strictly maintain the volume, overriding non-free axis scale. */
SAMEVOL_STRICT = 0,
@ -871,7 +871,7 @@ typedef enum eSameVolume_Mode {
SAMEVOL_SINGLE_AXIS = 2,
} eSameVolume_Mode;
/* bActionConstraint.flag */
/** #bActionConstraint.flag */
typedef enum eActionConstraint_Flags {
/* Bones use "object" part of target action, instead of "same bone name" part */
ACTCON_BONE_USE_OBJECT_ACTION = (1 << 0),
@ -879,7 +879,7 @@ typedef enum eActionConstraint_Flags {
ACTCON_USE_EVAL_TIME = (1 << 1),
} eActionConstraint_Flags;
/* bActionConstraint.mix_mode */
/** #bActionConstraint.mix_mode */
typedef enum eActionConstraint_MixMode {
/* Multiply the action transformation on the right. */
ACTCON_MIX_AFTER_FULL = 0,

View File

@ -300,13 +300,13 @@ typedef struct Curve {
/* **************** CURVE ********************* */
/* Curve.texflag */
/** #Curve.texflag */
enum {
CU_AUTOSPACE = 1,
CU_AUTOSPACE_EVALUATED = 2,
};
/* Curve.flag */
/** #Curve.flag */
enum {
CU_3D = 1 << 0,
CU_FRONT = 1 << 1,
@ -329,7 +329,7 @@ enum {
CU_MAP_TAPER = 1 << 15,
};
/* Curve.twist_mode */
/** #Curve.twist_mode */
enum {
CU_TWIST_Z_UP = 0,
/* CU_TWIST_Y_UP = 1, */ /* not used yet */
@ -345,7 +345,7 @@ enum {
CU_BEVFAC_MAP_SPLINE = 2,
};
/* Curve.spacemode */
/** #Curve.spacemode */
enum {
CU_ALIGN_X_LEFT = 0,
CU_ALIGN_X_MIDDLE = 1,
@ -354,7 +354,7 @@ enum {
CU_ALIGN_X_FLUSH = 4,
};
/* Curve.align_y */
/** #Curve.align_y */
enum {
CU_ALIGN_Y_TOP_BASELINE = 0,
CU_ALIGN_Y_TOP = 1,
@ -363,7 +363,7 @@ enum {
CU_ALIGN_Y_BOTTOM = 4,
};
/* Curve.bevel_mode */
/** #Curve.bevel_mode */
enum {
CU_BEV_MODE_ROUND = 0,
CU_BEV_MODE_OBJECT = 1,
@ -387,12 +387,12 @@ enum {
CU_OVERFLOW_TRUNCATE = 2,
};
/* Nurb.flag */
/** #Nurb.flag */
enum {
CU_SMOOTH = 1 << 0,
};
/* Nurb.type */
/** #Nurb.type */
enum {
CU_POLY = 0,
CU_BEZIER = 1,
@ -573,7 +573,7 @@ typedef enum eBezTriple_KeyframeType {
/* *************** CHARINFO **************** */
/* CharInfo.flag */
/** #CharInfo.flag */
enum {
/* NOTE: CU_CHINFO_WRAP, CU_CHINFO_SMALLCAPS_TEST and CU_CHINFO_TRUNCATE are set dynamically. */
CU_CHINFO_BOLD = 1 << 0,

View File

@ -139,7 +139,7 @@ typedef struct Curves {
void *batch_cache;
} Curves;
/* Curves.flag */
/** #Curves.flag */
enum {
HA_DS_EXPAND = (1 << 0),
};

View File

@ -80,7 +80,7 @@ typedef struct CustomData {
CustomDataExternal *external;
} CustomData;
/* CustomData.type */
/** #CustomData.type */
typedef enum CustomDataType {
/* Used by GLSL attributes in the cases when we need a delayed CD type
* assignment (in the cases when we don't know in advance which layer
@ -235,7 +235,7 @@ typedef struct CustomData_MeshMasks {
uint64_t lmask;
} CustomData_MeshMasks;
/* CustomData.flag */
/** #CustomData.flag */
enum {
/* Indicates layer should not be copied by CustomData_from_template or CustomData_copy_data */
CD_FLAG_NOCOPY = (1 << 0),

View File

@ -212,7 +212,7 @@ typedef struct Image {
/* **************** IMAGE ********************* */
/* Image.flag */
/** #Image.flag */
enum {
IMA_HIGH_BITDEPTH = (1 << 0),
IMA_FLAG_UNUSED_1 = (1 << 1), /* cleared */
@ -235,7 +235,7 @@ enum {
IMA_FLAG_UNUSED_16 = (1 << 16), /* cleared */
};
/* Image.gpuflag */
/** #Image.gpuflag */
enum {
/** All mipmap levels in OpenGL texture set? */
IMA_GPU_MIPMAP_COMPLETE = (1 << 0),
@ -268,7 +268,7 @@ typedef enum eImageType {
IMA_TYPE_COMPOSITE = 5,
} eImageType;
/* Image.gen_type */
/** #Image.gen_type */
enum {
IMA_GENTYPE_BLANK = 0,
IMA_GENTYPE_GRID = 1,
@ -278,12 +278,12 @@ enum {
/* render */
#define IMA_MAX_RENDER_TEXT (1 << 9)
/* Image.gen_flag */
/** #Image.gen_flag */
enum {
IMA_GEN_FLOAT = 1,
};
/* Image.alpha_mode */
/** #Image.alpha_mode */
enum {
IMA_ALPHA_STRAIGHT = 0,
IMA_ALPHA_PREMUL = 1,

View File

@ -2447,11 +2447,11 @@ typedef enum eGPencil_Guide_Reference {
/* UnitSettings */
#define USER_UNIT_ADAPTIVE 0xFF
/* UnitSettings.system */
/** #UnitSettings.system */
#define USER_UNIT_NONE 0
#define USER_UNIT_METRIC 1
#define USER_UNIT_IMPERIAL 2
/* UnitSettings.flag */
/** #UnitSettings.flag */
#define USER_UNIT_OPT_SPLIT 1
#define USER_UNIT_ROT_RADIANS 2

View File

@ -38,7 +38,7 @@ extern "C" {
/* External Engine */
/* RenderEngineType.flag */
/** #RenderEngineType.flag */
#define RE_INTERNAL 1
/* #define RE_FLAG_DEPRECATED 2 */
#define RE_USE_PREVIEW 4
@ -53,7 +53,7 @@ extern "C" {
#define RE_USE_NO_IMAGE_SAVE 2048
#define RE_USE_ALEMBIC_PROCEDURAL 4096
/* RenderEngine.flag */
/** #RenderEngine.flag */
#define RE_ENGINE_ANIMATION 1
#define RE_ENGINE_PREVIEW 2
#define RE_ENGINE_DO_DRAW 4

View File

@ -128,7 +128,7 @@ struct Render {
/* **************** defines ********************* */
/* R.flag */
/** #R.flag */
#define R_ANIMATION 1
#ifdef __cplusplus

View File

@ -15,7 +15,7 @@ struct ListBase;
struct Scene;
struct Sequence;
/* SeqLoadData.flags */
/** #SeqLoadData.flags */
typedef enum eSeqLoadFlags {
SEQ_LOAD_SOUND_CACHE = (1 << 1),
SEQ_LOAD_SOUND_MONO = (1 << 2),