diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 10:58:37 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 11:07:10 +0300 |
| commit | 5c63c0a58ca34d12cf70bf0021cf851f4e6192d6 (patch) | |
| tree | f29bc4257f331e23729a6400a318f7aa9bca9ec8 | |
| parent | 528fc35fedcdc7d6e8c3a6f32a7913342d3fb801 (diff) | |
Docs: use doxygen formatting for DNA
Differentiate doc-strings from title/section text.
Also use explicit doxygen references to struct members
so it's not ambiguous which member is being referenced.
Note that these changes aren't complete (some files weren't touched).
25 files changed, 514 insertions, 421 deletions
diff --git a/source/blender/makesdna/DNA_mesh_types.h b/source/blender/makesdna/DNA_mesh_types.h index 77cb553c7c7..c053baf9f7e 100644 --- a/source/blender/makesdna/DNA_mesh_types.h +++ b/source/blender/makesdna/DNA_mesh_types.h @@ -74,7 +74,7 @@ struct MLoopTri_Store { int len_alloc; }; -/* Runtime data, not saved in files. */ +/** Runtime data, not saved in files. */ typedef struct Mesh_Runtime { /* Evaluated mesh for objects which do not have effective modifiers. * This mesh is used as a result of modifier stack evaluation. @@ -359,13 +359,13 @@ typedef enum eMeshWrapperType { /* ME_WRAPPER_TYPE_SUBD = 2, */ /* TODO */ } eMeshWrapperType; -/* texflag */ +/** #Mesh.texflag */ enum { ME_AUTOSPACE = 1, ME_AUTOSPACE_EVALUATED = 2, }; -/* me->editflag */ +/** #Mesh.editflag */ enum { ME_EDIT_MIRROR_VERTEX_GROUPS = 1 << 0, ME_EDIT_MIRROR_Y = 1 << 1, /* unused so far */ @@ -387,7 +387,7 @@ enum { ((_me)->editflag & ME_EDIT_PAINT_VERT_SEL) ? SCE_SELECT_VERTEX : \ 0) -/* me->flag */ +/** #Mesh.flag */ enum { ME_FLAG_UNUSED_0 = 1 << 0, /* cleared */ ME_FLAG_UNUSED_1 = 1 << 1, /* cleared */ @@ -407,26 +407,26 @@ enum { ME_REMESH_REPROJECT_SCULPT_FACE_SETS = 1 << 15, }; -/* me->cd_flag */ +/** #Mesh.cd_flag */ enum { ME_CDFLAG_VERT_BWEIGHT = 1 << 0, ME_CDFLAG_EDGE_BWEIGHT = 1 << 1, ME_CDFLAG_EDGE_CREASE = 1 << 2, }; -/* me->remesh_mode */ +/** #Mesh.remesh_mode */ enum { REMESH_VOXEL = 0, REMESH_QUAD = 1, }; -/* Subsurf Type */ +/** #SubsurfModifierData.subdivType */ enum { ME_CC_SUBSURF = 0, ME_SIMPLE_SUBSURF = 1, }; -/* me->symmetry */ +/** #Mesh.symmetry */ typedef enum eMeshSymmetryType { ME_SYMMETRY_X = 1 << 0, ME_SYMMETRY_Y = 1 << 1, diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index f7a468264c3..85cc1361adf 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -121,28 +121,28 @@ typedef struct ModifierData { int type, mode; char _pad0[4]; short flag; - /* An "expand" bit for each of the modifier's (sub)panels (uiPanelDataExpansion). */ + /** An "expand" bit for each of the modifier's (sub)panels (#uiPanelDataExpansion). */ short ui_expand_flag; /** MAX_NAME. */ char name[64]; char *error; - /* Pointer to a ModifierData in the original domain. */ + /** Pointer to a #ModifierData in the original domain. */ struct ModifierData *orig_modifier_data; - /* Runtime field which contains unique identifier of the modifier. */ + /** Runtime field which contains unique identifier of the modifier. */ SessionUUID session_uuid; - /* Runtime field which contains runtime data which is specific to a modifier type. */ + /** Runtime field which contains runtime data which is specific to a modifier type. */ void *runtime; void *_pad1; } ModifierData; typedef enum { - /* This modifier has been inserted in local override, and hence can be fully edited. */ + /** This modifier has been inserted in local override, and hence can be fully edited. */ eModifierFlag_OverrideLibrary_Local = (1 << 0), - /* This modifier does not own its caches, but instead shares them with another modifier. */ + /** This modifier does not own its caches, but instead shares them with another modifier. */ eModifierFlag_SharedCaches = (1 << 1), /** * This modifier is the object's active modifier. Used for context in the node editor. @@ -151,7 +151,9 @@ typedef enum { eModifierFlag_Active = (1 << 2), } ModifierFlag; -/* not a real modifier */ +/** + * \note Not a real modifier. + */ typedef struct MappingInfoModifierData { ModifierData modifier; @@ -219,7 +221,7 @@ typedef struct LatticeModifierData { void *_pad1; } LatticeModifierData; -/* Lattice modifier flags. */ +/** #LatticeModifierData.flag */ enum { MOD_LATTICE_INVERT_VGROUP = (1 << 0), }; @@ -237,12 +239,12 @@ typedef struct CurveModifierData { void *_pad1; } CurveModifierData; -/* Curve modifier flags */ +/** #CurveModifierData.flag */ enum { MOD_CURVE_INVERT_VGROUP = (1 << 0), }; -/* CurveModifierData->defaxis */ +/** #CurveModifierData.defaxis */ enum { MOD_CURVE_POSX = 1, MOD_CURVE_POSY = 2, @@ -264,7 +266,7 @@ typedef struct BuildModifierData { int seed; } BuildModifierData; -/* Build Modifier -> flag */ +/** #BuildModifierData.flag */ enum { /** order of vertices is randomized */ MOD_BUILD_FLAG_RANDOMIZE = (1 << 0), @@ -272,7 +274,7 @@ enum { MOD_BUILD_FLAG_REVERSE = (1 << 1), }; -/* Mask Modifier */ +/** Mask Modifier. */ typedef struct MaskModifierData { ModifierData modifier; @@ -289,13 +291,13 @@ typedef struct MaskModifierData { void *_pad1; } MaskModifierData; -/* Mask Modifier -> mode */ +/** #MaskModifierData.mode */ enum { MOD_MASK_MODE_VGROUP = 0, MOD_MASK_MODE_ARM = 1, }; -/* Mask Modifier -> flag */ +/** #MaskModifierData.flag */ enum { MOD_MASK_INV = (1 << 0), MOD_MASK_SMOOTH = (1 << 1), @@ -304,63 +306,68 @@ enum { typedef struct ArrayModifierData { ModifierData modifier; - /* the object with which to cap the start of the array. */ + /** The object with which to cap the start of the array. */ struct Object *start_cap; - /* the object with which to cap the end of the array. */ + /** The object with which to cap the end of the array. */ struct Object *end_cap; - /* the curve object to use for MOD_ARR_FITCURVE. */ + /** The curve object to use for #MOD_ARR_FITCURVE. */ struct Object *curve_ob; - /* the object to use for object offset. */ + /** The object to use for object offset. */ struct Object *offset_ob; - /* a constant duplicate offset; - * 1 means the duplicates are 1 unit apart + /** + * A constant duplicate offset; + * 1 means the duplicates are 1 unit apart. */ float offset[3]; - /* a scaled factor for duplicate offsets; - * 1 means the duplicates are 1 object-width apart + /** + * A scaled factor for duplicate offsets; + * 1 means the duplicates are 1 object-width apart. */ float scale[3]; - /* the length over which to distribute the duplicates */ + /** The length over which to distribute the duplicates. */ float length; - /* the limit below which to merge vertices in adjacent duplicates */ + /** The limit below which to merge vertices in adjacent duplicates. */ float merge_dist; - /* determines how duplicate count is calculated; one of: - * - MOD_ARR_FIXEDCOUNT -> fixed - * - MOD_ARR_FITLENGTH -> calculated to fit a set length - * - MOD_ARR_FITCURVE -> calculated to fit the length of a Curve object + /** + * Determines how duplicate count is calculated; one of: + * - #MOD_ARR_FIXEDCOUNT -> fixed. + * - #MOD_ARR_FITLENGTH -> calculated to fit a set length. + * - #MOD_ARR_FITCURVE -> calculated to fit the length of a Curve object. */ int fit_type; - /* flags specifying how total offset is calculated; binary OR of: - * - MOD_ARR_OFF_CONST -> total offset += offset - * - MOD_ARR_OFF_RELATIVE -> total offset += relative * object width - * - MOD_ARR_OFF_OBJ -> total offset += offset_ob's matrix - * total offset is the sum of the individual enabled offsets + /** + * Flags specifying how total offset is calculated; binary OR of: + * - #MOD_ARR_OFF_CONST -> total offset += offset. + * - #MOD_ARR_OFF_RELATIVE -> total offset += relative * object width. + * - #MOD_ARR_OFF_OBJ -> total offset += offset_ob's matrix. + * Total offset is the sum of the individual enabled offsets. */ int offset_type; - /* general flags: - * MOD_ARR_MERGE -> merge vertices in adjacent duplicates + /** + * General flags: + * #MOD_ARR_MERGE -> merge vertices in adjacent duplicates. */ int flags; - /* the number of duplicates to generate for MOD_ARR_FIXEDCOUNT */ + /** The number of duplicates to generate for #MOD_ARR_FIXEDCOUNT. */ int count; float uv_offset[2]; } ArrayModifierData; -/* ArrayModifierData->fit_type */ +/** #ArrayModifierData.fit_type */ enum { MOD_ARR_FIXEDCOUNT = 0, MOD_ARR_FITLENGTH = 1, MOD_ARR_FITCURVE = 2, }; -/* ArrayModifierData->offset_type */ +/** #ArrayModifierData.offset_type */ enum { MOD_ARR_OFF_CONST = (1 << 0), MOD_ARR_OFF_RELATIVE = (1 << 1), MOD_ARR_OFF_OBJ = (1 << 2), }; -/* ArrayModifierData->flags */ +/** #ArrayModifierData.flags */ enum { MOD_ARR_MERGE = (1 << 0), MOD_ARR_MERGEFINAL = (1 << 1), @@ -389,7 +396,7 @@ typedef struct MirrorModifierData { void *_pad1; } MirrorModifierData; -/* MirrorModifierData->flag */ +/** #MirrorModifierData.flag */ enum { MOD_MIR_CLIPPING = (1 << 0), MOD_MIR_MIRROR_U = (1 << 1), @@ -416,7 +423,7 @@ typedef struct EdgeSplitModifierData { int flags; } EdgeSplitModifierData; -/* EdgeSplitModifierData->flags */ +/** #EdgeSplitModifierData.flags */ enum { MOD_EDGESPLIT_FROMANGLE = (1 << 1), MOD_EDGESPLIT_FROMFLAG = (1 << 2), @@ -468,7 +475,7 @@ typedef struct BevelModifierData { void *_pad2; } BevelModifierData; -/* BevelModifierData->flags and BevelModifierData->lim_flags */ +/** #BevelModifierData.flags and BevelModifierData.lim_flags */ enum { #ifdef DNA_DEPRECATED_ALLOW MOD_BEVEL_VERT_DEPRECATED = (1 << 1), @@ -491,7 +498,7 @@ enum { MOD_BEVEL_HARDEN_NORMALS = (1 << 15), }; -/* BevelModifierData->val_flags (not used as flags any more) */ +/** #BevelModifierData.val_flags (not used as flags any more) */ enum { MOD_BEVEL_AMT_OFFSET = 0, MOD_BEVEL_AMT_WIDTH = 1, @@ -500,19 +507,19 @@ enum { MOD_BEVEL_AMT_ABSOLUTE = 4, }; -/* BevelModifierData->profile_type */ +/** #BevelModifierData.profile_type */ enum { MOD_BEVEL_PROFILE_SUPERELLIPSE = 0, MOD_BEVEL_PROFILE_CUSTOM = 1, }; -/* BevelModifierData->edge_flags */ +/** #BevelModifierData.edge_flags */ enum { MOD_BEVEL_MARK_SEAM = (1 << 0), MOD_BEVEL_MARK_SHARP = (1 << 1), }; -/* BevelModifierData->face_str_mode */ +/** #BevelModifierData.face_str_mode */ enum { MOD_BEVEL_FACE_STRENGTH_NONE = 0, MOD_BEVEL_FACE_STRENGTH_NEW = 1, @@ -520,20 +527,20 @@ enum { MOD_BEVEL_FACE_STRENGTH_ALL = 3, }; -/* BevelModifier->miter_inner and ->miter_outer */ +/** #BevelModifier.miter_inner & #BevelModifier.miter_outer */ enum { MOD_BEVEL_MITER_SHARP = 0, MOD_BEVEL_MITER_PATCH = 1, MOD_BEVEL_MITER_ARC = 2, }; -/* BevelModifier->vmesh_method */ +/** #BevelModifier.vmesh_method */ enum { MOD_BEVEL_VMESH_ADJ = 0, MOD_BEVEL_VMESH_CUTOFF = 1, }; -/* BevelModifier->affect_type */ +/** #BevelModifier.affect_type */ enum { MOD_BEVEL_AFFECT_VERTICES = 0, MOD_BEVEL_AFFECT_EDGES = 1, @@ -553,7 +560,7 @@ typedef struct FluidModifierData { void *_pad1; } FluidModifierData; -/* Fluid modifier flags */ +/** #FluidModifierData.type */ enum { MOD_FLUID_TYPE_DOMAIN = (1 << 0), MOD_FLUID_TYPE_FLOW = (1 << 1), @@ -563,7 +570,8 @@ enum { typedef struct DisplaceModifierData { ModifierData modifier; - /* keep in sync with MappingInfoModifierData */ + /* Keep in sync with #MappingInfoModifierData. */ + struct Tex *texture; struct Object *map_object; char map_bone[64]; @@ -583,12 +591,12 @@ typedef struct DisplaceModifierData { char _pad[6]; } DisplaceModifierData; -/* DisplaceModifierData->flag */ +/** #DisplaceModifierData.flag */ enum { MOD_DISP_INVERT_VGROUP = (1 << 0), }; -/* DisplaceModifierData->direction */ +/** #DisplaceModifierData.direction */ enum { MOD_DISP_DIR_X = 0, MOD_DISP_DIR_Y = 1, @@ -598,7 +606,7 @@ enum { MOD_DISP_DIR_CLNOR = 5, }; -/* DisplaceModifierData->texmapping */ +/** #DisplaceModifierData.texmapping */ enum { MOD_DISP_MAP_LOCAL = 0, MOD_DISP_MAP_GLOBAL = 1, @@ -606,7 +614,7 @@ enum { MOD_DISP_MAP_UV = 3, }; -/* DisplaceModifierData->space */ +/** #DisplaceModifierData.space */ enum { MOD_DISP_SPACE_LOCAL = 0, MOD_DISP_SPACE_GLOBAL = 1, @@ -614,9 +622,10 @@ enum { typedef struct UVProjectModifierData { ModifierData modifier; - - /* the objects which do the projecting */ - /** MOD_UVPROJECT_MAXPROJECTORS. */ + /** + * The objects which do the projecting. + * \note 10=MOD_UVPROJECT_MAXPROJECTORS. + */ struct Object *projectors[10]; char _pad2[4]; int num_projectors; @@ -649,7 +658,7 @@ typedef struct DecimateModifierData { float defgrp_factor; short flag, mode; - /* runtime only */ + /** runtime only. */ int face_count; } DecimateModifierData; @@ -678,7 +687,7 @@ typedef struct SmoothModifierData { } SmoothModifierData; -/* Smooth modifier flags */ +/** #SmoothModifierData.flag */ enum { MOD_SMOOTH_INVERT_VGROUP = (1 << 0), MOD_SMOOTH_X = (1 << 1), @@ -695,11 +704,13 @@ typedef struct CastModifierData { float size; /** MAX_VGROUP_NAME. */ char defgrp_name[64]; - short flag, type; + short flag; + /** Cast modifier projection type. */ + short type; void *_pad1; } CastModifierData; -/* Cast modifier flags */ +/** #CastModifierData.flag */ enum { /* And what bout (1 << 0) flag? ;) */ MOD_CAST_INVERT_VGROUP = (1 << 0), @@ -710,7 +721,7 @@ enum { MOD_CAST_SIZE_FROM_RADIUS = (1 << 5), }; -/* Cast modifier projection types */ +/** #CastModifierData.type */ enum { MOD_CAST_TYPE_SPHERE = 0, MOD_CAST_TYPE_CYLINDER = 1, @@ -720,7 +731,8 @@ enum { typedef struct WaveModifierData { ModifierData modifier; - /* keep in sync with MappingInfoModifierData */ + /* Keep in sync with #MappingInfoModifierData. */ + struct Tex *texture; struct Object *map_object; char map_bone[64]; @@ -728,7 +740,7 @@ typedef struct WaveModifierData { char uvlayer_name[64]; int uvlayer_tmp; int texmapping; - /* end MappingInfoModifierData */ + /* End MappingInfoModifierData. */ struct Object *objectcenter; /** MAX_VGROUP_NAME. */ @@ -745,7 +757,7 @@ typedef struct WaveModifierData { void *_pad2; } WaveModifierData; -/* WaveModifierData.flag */ +/** #WaveModifierData.flag */ enum { MOD_WAVE_INVERT_VGROUP = (1 << 0), MOD_WAVE_X = (1 << 1), @@ -775,7 +787,7 @@ enum { MOD_HOOK_INVERT_VGROUP = (1 << 1), }; -/* same as WarpModifierFalloff */ +/** \note same as #WarpModifierFalloff */ typedef enum { eHook_Falloff_None = 0, eHook_Falloff_Curve = 1, @@ -832,15 +844,17 @@ typedef struct ClothModifierData { /** Definition is in DNA_cloth_types.h. */ struct ClothCollSettings *coll_parms; - /* PointCache can be shared with other instances of ClothModifierData. - * Inspect (modifier.flag & eModifierFlag_SharedCaches) to find out. */ + /** + * PointCache can be shared with other instances of #ClothModifierData. + * Inspect `modifier.flag & eModifierFlag_SharedCaches` to find out. + */ /** Definition is in DNA_object_force_types.h. */ struct PointCache *point_cache; struct ListBase ptcaches; - /* XXX nasty hack, remove once hair can be separated from cloth modifier data */ + /** XXX: nasty hack, remove once hair can be separated from cloth modifier data. */ struct ClothHairData *hairdata; - /* grid geometry values of hair continuum */ + /** Grid geometry values of hair continuum. */ float hair_grid_min[3]; float hair_grid_max[3]; int hair_grid_res[3]; @@ -907,20 +921,20 @@ typedef struct BooleanModifierData { char bm_flag; } BooleanModifierData; -/* BooleanModifierData->operation */ +/** #BooleanModifierData.operation */ typedef enum { eBooleanModifierOp_Intersect = 0, eBooleanModifierOp_Union = 1, eBooleanModifierOp_Difference = 2, } BooleanModifierOp; -/* BooleanModifierData->solver */ +/** #BooleanModifierData.solver */ typedef enum { eBooleanModifierSolver_Fast = 0, eBooleanModifierSolver_Exact = 1, } BooleanModifierSolver; -/* BooleanModifierData->flag */ +/** #BooleanModifierData.flag */ enum { eBooleanModifierFlag_Self = (1 << 0), eBooleanModifierFlag_Object = (1 << 1), @@ -928,7 +942,7 @@ enum { eBooleanModifierFlag_HoleTolerant = (1 << 3), }; -/* bm_flag only used when G_DEBUG. */ +/** #BooleanModifierData.bm_flag (only used when #G_DEBUG is set). */ enum { eBooleanModifierBMeshFlag_BMesh_Separate = (1 << 0), eBooleanModifierBMeshFlag_BMesh_NoDissolve = (1 << 1), @@ -1102,7 +1116,7 @@ typedef enum { eMultiresModifierFlag_UseSculptBaseMesh = (1 << 4), } MultiresModifierFlag; -/* DEPRECATED, only used for versioning. */ +/** DEPRECATED: only used for versioning. */ typedef struct FluidsimModifierData { ModifierData modifier; @@ -1111,7 +1125,7 @@ typedef struct FluidsimModifierData { void *_pad1; } FluidsimModifierData; -/* DEPRECATED, only used for versioning. */ +/** DEPRECATED: only used for versioning. */ typedef struct SmokeModifierData { ModifierData modifier; @@ -1150,7 +1164,7 @@ typedef struct ShrinkwrapModifierData { char _pad[2]; } ShrinkwrapModifierData; -/* Shrinkwrap->shrinkType */ +/** #ShrinkwrapModifierData.shrinkType */ enum { MOD_SHRINKWRAP_NEAREST_SURFACE = 0, MOD_SHRINKWRAP_PROJECT = 1, @@ -1158,7 +1172,7 @@ enum { MOD_SHRINKWRAP_TARGET_PROJECT = 3, }; -/* Shrinkwrap->shrinkMode */ +/** #ShrinkwrapModifierData.shrinkMode */ enum { /** Move vertex to the surface of the target object (keepDist towards original position) */ MOD_SHRINKWRAP_ON_SURFACE = 0, @@ -1172,7 +1186,7 @@ enum { MOD_SHRINKWRAP_ABOVE_SURFACE = 4, }; -/* Shrinkwrap->shrinkOpts */ +/** #ShrinkwrapModifierData.shrinkOpts */ enum { /** allow shrinkwrap to move the vertex in the positive direction of axis */ MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR = (1 << 0), @@ -1196,7 +1210,7 @@ enum { #define MOD_SHRINKWRAP_CULL_TARGET_MASK \ (MOD_SHRINKWRAP_CULL_TARGET_FRONTFACE | MOD_SHRINKWRAP_CULL_TARGET_BACKFACE) -/* Shrinkwrap->projAxis */ +/** #ShrinkwrapModifierData.projAxis */ enum { /** projection over normal is used if no axis is selected */ MOD_SHRINKWRAP_PROJECT_OVER_NORMAL = 0, @@ -1228,7 +1242,7 @@ typedef struct SimpleDeformModifierData { void *_pad1; } SimpleDeformModifierData; -/* SimpleDeform->flag */ +/** #SimpleDeformModifierData.flag */ enum { MOD_SIMPLEDEFORM_FLAG_INVERT_VGROUP = (1 << 0), }; @@ -1434,7 +1448,9 @@ enum { typedef struct WarpModifierData { ModifierData modifier; - /* keep in sync with MappingInfoModifierData */ + + /* Keep in sync with #MappingInfoModifierData. */ + struct Tex *texture; struct Object *map_object; char map_bone[64]; @@ -1442,7 +1458,7 @@ typedef struct WarpModifierData { char uvlayer_name[64]; int uvlayer_tmp; int texmapping; - /* end MappingInfoModifierData */ + /* End #MappingInfoModifierData. */ struct Object *object_from; struct Object *object_to; @@ -1462,12 +1478,13 @@ typedef struct WarpModifierData { void *_pad1; } WarpModifierData; -/* WarpModifierData->flag */ +/** #WarpModifierData.flag */ enum { MOD_WARP_VOLUME_PRESERVE = (1 << 0), MOD_WARP_INVERT_VGROUP = (1 << 1), }; +/** \note same as #HookModifierFalloff. */ typedef enum { eWarp_Falloff_None = 0, eWarp_Falloff_Curve = 1, @@ -1508,7 +1525,7 @@ typedef struct WeightVGEditModifierData { char mask_defgrp_name[64]; /* Texture masking. */ - /** Which channel to use as weightf. */ + /** Which channel to use as weight/mask. */ int mask_tex_use_channel; /** The texture. */ struct Tex *mask_texture; @@ -1526,7 +1543,7 @@ typedef struct WeightVGEditModifierData { void *_pad1; } WeightVGEditModifierData; -/* WeightVGEdit flags. */ +/** #WeightVGEdit.edit_flags */ enum { MOD_WVG_EDIT_WEIGHTS_NORMALIZE = (1 << 0), MOD_WVG_INVERT_FALLOFF = (1 << 1), @@ -1581,7 +1598,7 @@ typedef struct WeightVGMixModifierData { char _pad1[3]; } WeightVGMixModifierData; -/* How second vgroup's weights affect first ones. */ +/** #WeightVGMixModifierData.mix_mode (how second vgroup's weights affect first ones). */ enum { /** Second weights replace weights. */ MOD_WVG_MIX_SET = 1, @@ -1599,7 +1616,7 @@ enum { MOD_WVG_MIX_AVG = 7, }; -/* What vertices to affect. */ +/** #WeightVGMixModifierData.mix_set (what vertices to affect). */ enum { /** Affect all vertices. */ MOD_WVG_SET_ALL = 1, @@ -1613,7 +1630,7 @@ enum { MOD_WVG_SET_AND = 5, }; -/* WeightVGMix->flag */ +/** #WeightVGMixModifierData.flag */ enum { MOD_WVG_MIX_INVERT_VGROUP_MASK = (1 << 0), MOD_WVG_MIX_WEIGHTS_NORMALIZE = (1 << 1), @@ -1631,8 +1648,9 @@ typedef struct WeightVGProximityModifierData { /** The custom mapping curve. */ struct CurveMapping *cmap_curve; - /* Proximity modes. */ + /** Modes of proximity weighting. */ int proximity_mode; + /** Options for proximity weighting. */ int proximity_flags; /* Target object from which to calculate vertices distances. */ @@ -1662,20 +1680,21 @@ typedef struct WeightVGProximityModifierData { float min_dist, max_dist; /* Put here to avoid breaking existing struct... */ - /** Using MOD_WVG_MAPPING_* enums. */ + /** + * Mapping modes (using MOD_WVG_MAPPING_* enums). */ short falloff_type; /* Padding... */ char _pad0[2]; } WeightVGProximityModifierData; -/* Modes of proximity weighting. */ +/** #WeightVGProximityModifierData.proximity_mode */ enum { MOD_WVG_PROXIMITY_OBJECT = 1, /* source vertex to other location */ MOD_WVG_PROXIMITY_GEOMETRY = 2, /* source vertex to other geometry */ }; -/* Flags options for proximity weighting. */ +/** #WeightVGProximityModifierData.proximity_flags */ enum { /* Use nearest vertices of target obj, in MOD_WVG_PROXIMITY_GEOMETRY mode. */ MOD_WVG_PROXIMITY_GEOM_VERTS = (1 << 0), @@ -1689,7 +1708,8 @@ enum { }; /* Defines common to all WeightVG modifiers. */ -/* Mapping modes. */ + +/** #WeightVGProximityModifierData.falloff_type */ enum { MOD_WVG_MAPPING_NONE = 0, MOD_WVG_MAPPING_CURVE = 1, @@ -1703,7 +1723,7 @@ enum { MOD_WVG_MAPPING_STEP = 9, /* Median Step. */ }; -/* Tex channel to be used as mask. */ +/** #WeightVGProximityModifierData.mask_tex_use_channel */ enum { MOD_WVG_MASK_TEX_USE_INT = 1, MOD_WVG_MASK_TEX_USE_RED = 2, @@ -1725,13 +1745,13 @@ typedef struct DynamicPaintModifierData { char _pad[4]; } DynamicPaintModifierData; -/* Dynamic paint modifier flags */ +/** #DynamicPaintModifierData.type */ enum { MOD_DYNAMICPAINT_TYPE_CANVAS = (1 << 0), MOD_DYNAMICPAINT_TYPE_BRUSH = (1 << 1), }; -/* Remesh modifier */ +/** Remesh modifier. */ typedef enum eRemeshModifierFlags { MOD_REMESH_FLOOD_FILL = (1 << 0), MOD_REMESH_SMOOTH_SHADING = (1 << 1), @@ -1770,7 +1790,7 @@ typedef struct RemeshModifierData { float adaptivity; } RemeshModifierData; -/* Skin modifier */ +/** Skin modifier. */ typedef struct SkinModifierData { ModifierData modifier; @@ -1783,19 +1803,19 @@ typedef struct SkinModifierData { char _pad[2]; } SkinModifierData; -/* SkinModifierData.symmetry_axes */ +/** #SkinModifierData.symmetry_axes */ enum { MOD_SKIN_SYMM_X = (1 << 0), MOD_SKIN_SYMM_Y = (1 << 1), MOD_SKIN_SYMM_Z = (1 << 2), }; -/* SkinModifierData.flag */ +/** #SkinModifierData.flag */ enum { MOD_SKIN_SMOOTH_SHADING = 1, }; -/* Triangulate modifier */ +/** Triangulate modifier. */ typedef struct TriangulateModifierData { ModifierData modifier; @@ -1805,7 +1825,7 @@ typedef struct TriangulateModifierData { int min_vertices; } TriangulateModifierData; -/* TriangulateModifierData.flag */ +/** #TriangulateModifierData.flag */ enum { #ifdef DNA_DEPRECATED_ALLOW MOD_TRIANGULATE_BEAUTY = (1 << 0), /* deprecated */ @@ -1813,13 +1833,13 @@ enum { MOD_TRIANGULATE_KEEP_CUSTOMLOOP_NORMALS = 1 << 1, }; -/* Triangulate methods - NGons */ +/** #TriangulateModifierData.ngon_method triangulate method (N-gons). */ enum { MOD_TRIANGULATE_NGON_BEAUTY = 0, MOD_TRIANGULATE_NGON_EARCLIP = 1, }; -/* Triangulate methods - Quads */ +/** #TriangulateModifierData.quad_method triangulate method (quads). */ enum { MOD_TRIANGULATE_QUAD_BEAUTY = 0, MOD_TRIANGULATE_QUAD_FIXED = 1, @@ -1837,7 +1857,7 @@ typedef struct LaplacianSmoothModifierData { short flag, repeat; } LaplacianSmoothModifierData; -/* Smooth modifier flags */ +/** #LaplacianSmoothModifierData.flag */ enum { MOD_LAPLACIANSMOOTH_X = (1 << 1), MOD_LAPLACIANSMOOTH_Y = (1 << 2), @@ -1892,7 +1912,7 @@ enum { MOD_CORRECTIVESMOOTH_RESTSOURCE_BIND = 1, }; -/* Corrective Smooth modifier flags */ +/** #CorrectiveSmoothModifierData.flag */ enum { MOD_CORRECTIVESMOOTH_INVERT_VGROUP = (1 << 0), MOD_CORRECTIVESMOOTH_ONLY_SMOOTH = (1 << 1), @@ -1926,12 +1946,12 @@ typedef struct UVWarpModifierData { char uvlayer_name[64]; } UVWarpModifierData; -/* UVWarp modifier flags */ +/** #UVWarpModifierData.flag */ enum { MOD_UVWARP_INVERT_VGROUP = 1 << 0, }; -/* cache modifier */ +/** Mesh cache modifier. */ typedef struct MeshCacheModifierData { ModifierData modifier; @@ -1967,7 +1987,7 @@ typedef struct MeshCacheModifierData { char filepath[1024]; } MeshCacheModifierData; -/* MeshCache modifier flags. */ +/** #MeshCacheModifierData.flag */ enum { MOD_MESHCACHE_INVERT_VERTEX_GROUP = 1 << 0, }; @@ -2012,13 +2032,15 @@ typedef struct LaplacianDeformModifierData { } LaplacianDeformModifierData; -/* Laplacian Deform modifier flags */ +/** #LaplacianDeformModifierData.flag */ enum { MOD_LAPLACIANDEFORM_BIND = 1 << 0, MOD_LAPLACIANDEFORM_INVERT_VGROUP = 1 << 1, }; -/* many of these options match 'solidify' */ +/** + * \note many of these options match 'solidify'. + */ typedef struct WireframeModifierData { ModifierData modifier; /** MAX_VGROUP_NAME. */ @@ -2053,13 +2075,13 @@ typedef struct WeldModifierData { char _pad[2]; } WeldModifierData; -/* WeldModifierData->flag */ +/** #WeldModifierData.flag */ enum { MOD_WELD_INVERT_VGROUP = (1 << 0), MOD_WELD_LOOSE_EDGES = (1 << 1), }; -/* #WeldModifierData.mode */ +/** #WeldModifierData.mode */ enum { MOD_WELD_MODE_ALL = 0, MOD_WELD_MODE_CONNECTED = 1, @@ -2100,7 +2122,7 @@ typedef struct DataTransferModifierData { void *_pad2; } DataTransferModifierData; -/* DataTransferModifierData.flags */ +/** #DataTransferModifierData.flags */ enum { MOD_DATATRANSFER_OBSRC_TRANSFORM = 1 << 0, MOD_DATATRANSFER_MAP_MAXDIST = 1 << 1, @@ -2113,7 +2135,7 @@ enum { MOD_DATATRANSFER_USE_POLY = 1u << 31, }; -/* Set Split Normals modifier */ +/** Set Split Normals modifier. */ typedef struct NormalEditModifierData { ModifierData modifier; /** MAX_VGROUP_NAME. */ @@ -2131,20 +2153,20 @@ typedef struct NormalEditModifierData { void *_pad1; } NormalEditModifierData; -/* NormalEditModifierData.mode */ +/** #NormalEditModifierData.mode */ enum { MOD_NORMALEDIT_MODE_RADIAL = 0, MOD_NORMALEDIT_MODE_DIRECTIONAL = 1, }; -/* NormalEditModifierData.flags */ +/** #NormalEditModifierData.flags */ enum { MOD_NORMALEDIT_INVERT_VGROUP = (1 << 0), MOD_NORMALEDIT_USE_DIRECTION_PARALLEL = (1 << 1), MOD_NORMALEDIT_NO_POLYNORS_FIX = (1 << 2), }; -/* NormalEditModifierData.mix_mode */ +/** #NormalEditModifierData.mix_mode */ enum { MOD_NORMALEDIT_MIX_COPY = 0, MOD_NORMALEDIT_MIX_ADD = 1, @@ -2169,7 +2191,7 @@ typedef struct MeshSeqCacheModifierData { char reader_object_path[1024]; } MeshSeqCacheModifierData; -/* MeshSeqCacheModifierData.read_flag */ +/** #MeshSeqCacheModifierData.read_flag */ enum { MOD_MESHSEQ_READ_VERT = (1 << 0), MOD_MESHSEQ_READ_POLY = (1 << 1), @@ -2214,7 +2236,7 @@ typedef struct SurfaceDeformModifierData { void *_pad1; } SurfaceDeformModifierData; -/* Surface Deform modifier flags */ +/** Surface Deform modifier flags. */ enum { /* This indicates "do bind on next modifier evaluation" as well as "is bound". */ MOD_SDEF_BIND = (1 << 0), @@ -2223,7 +2245,7 @@ enum { MOD_SDEF_SPARSE_BIND = (1 << 2), }; -/* Surface Deform vertex bind modes */ +/** Surface Deform vertex bind modes. */ enum { MOD_SDEF_MODE_LOOPTRI = 0, MOD_SDEF_MODE_NGON = 1, @@ -2243,14 +2265,14 @@ typedef struct WeightedNormalModifierData { /* Name/id of the generic PROP_INT cdlayer storing face weights. */ #define MOD_WEIGHTEDNORMALS_FACEWEIGHT_CDLAYER_ID "__mod_weightednormals_faceweight" -/* WeightedNormalModifierData.mode */ +/** #WeightedNormalModifierData.mode */ enum { MOD_WEIGHTEDNORMAL_MODE_FACE = 0, MOD_WEIGHTEDNORMAL_MODE_ANGLE = 1, MOD_WEIGHTEDNORMAL_MODE_FACE_ANGLE = 2, }; -/* WeightedNormalModifierData.flag */ +/** #WeightedNormalModifierData.flag */ enum { MOD_WEIGHTEDNORMAL_KEEP_SHARP = (1 << 0), MOD_WEIGHTEDNORMAL_INVERT_VGROUP = (1 << 1), @@ -2270,8 +2292,10 @@ typedef struct NodesModifierData { struct bNodeTree *node_group; struct NodesModifierSettings settings; - /* Contains logged information from the last evaluation. This can be used to help the user to - * debug a node tree. */ + /** + * Contains logged information from the last evaluation. + * This can be used to help the user to debug a node tree. + */ void *runtime_eval_log; void *_pad1; } NodesModifierData; @@ -2304,7 +2328,7 @@ typedef struct MeshToVolumeModifierData { void *_pad3; } MeshToVolumeModifierData; -/* MeshToVolumeModifierData->resolution_mode */ +/** #MeshToVolumeModifierData.resolution_mode */ typedef enum MeshToVolumeModifierResolutionMode { MESH_TO_VOLUME_RESOLUTION_MODE_VOXEL_AMOUNT = 0, MESH_TO_VOLUME_RESOLUTION_MODE_VOXEL_SIZE = 1, @@ -2322,7 +2346,7 @@ typedef struct VolumeDisplaceModifierData { float texture_sample_radius; } VolumeDisplaceModifierData; -/* VolumeDisplaceModifierData->texture_map_mode */ +/** #VolumeDisplaceModifierData.texture_map_mode */ enum { MOD_VOLUME_DISPLACE_MAP_LOCAL = 0, MOD_VOLUME_DISPLACE_MAP_GLOBAL = 1, diff --git a/source/blender/makesdna/DNA_movieclip_types.h b/source/blender/makesdna/DNA_movieclip_types.h index 8e01a9e1f1f..08064e6242b 100644 --- a/source/blender/makesdna/DNA_movieclip_types.h +++ b/source/blender/makesdna/DNA_movieclip_types.h @@ -160,7 +160,7 @@ typedef struct MovieClipScopes { float slide_scale[2]; } MovieClipScopes; -/* MovieClipProxy->build_size_flag */ +/** #MovieClipProxy.build_size_flag */ enum { MCLIP_PROXY_SIZE_25 = (1 << 0), MCLIP_PROXY_SIZE_50 = (1 << 1), @@ -172,13 +172,13 @@ enum { MCLIP_PROXY_UNDISTORTED_SIZE_100 = (1 << 7), }; -/* MovieClip->source */ +/** #MovieClip.source */ enum { MCLIP_SRC_SEQUENCE = 1, MCLIP_SRC_MOVIE = 2, }; -/* MovieClip->flag */ +/** #MovieClip.flag */ enum { MCLIP_USE_PROXY = (1 << 0), MCLIP_USE_PROXY_CUSTOM_DIR = (1 << 1), @@ -188,7 +188,7 @@ enum { MCLIP_TIMECODE_FLAGS = (MCLIP_USE_PROXY | MCLIP_USE_PROXY_CUSTOM_DIR), }; -/* MovieClip->render_size */ +/** #MovieClip.render_size */ enum { MCLIP_PROXY_RENDER_SIZE_FULL = 0, MCLIP_PROXY_RENDER_SIZE_25 = 1, @@ -197,7 +197,7 @@ enum { MCLIP_PROXY_RENDER_SIZE_100 = 4, }; -/* MovieClip->render_flag */ +/** #MovieClip.render_flag */ enum { MCLIP_PROXY_RENDER_UNDISTORT = 1, /** Use original, if proxy is not found. */ diff --git a/source/blender/makesdna/DNA_nla_types.h b/source/blender/makesdna/DNA_nla_types.h index 7808dd68384..82edc0e1816 100644 --- a/source/blender/makesdna/DNA_nla_types.h +++ b/source/blender/makesdna/DNA_nla_types.h @@ -33,7 +33,7 @@ struct Ipo; struct Object; struct bAction; -/* simple uniform modifier structure, assumed it can hold all type info */ +/** Simple uniform modifier structure, assumed it can hold all type info. */ typedef struct bActionModifier { struct bActionModifier *next, *prev; short type, flag; @@ -95,7 +95,7 @@ typedef struct bActionStrip { #define ACTSTRIPMODE_BLEND 0 #define ACTSTRIPMODE_ADD 1 -/* strip->flag */ +/** #bActionStrip.flag */ typedef enum eActStrip_Flag { ACTSTRIP_SELECT = (1 << 0), ACTSTRIP_USESTRIDE = (1 << 1), diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index dc5acb9d5b2..f4a1efe84b8 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -174,7 +174,7 @@ typedef struct bNodeSocket { const SocketDeclarationHandle *declaration; } bNodeSocket; -/* sock->type */ +/** #bNodeSocket.type & #bNodeSocketType.type */ typedef enum eNodeSocketDatatype { SOCK_CUSTOM = -1, /* socket has no integer type */ SOCK_FLOAT = 0, @@ -193,7 +193,7 @@ typedef enum eNodeSocketDatatype { SOCK_MATERIAL = 13, } eNodeSocketDatatype; -/* Socket shape. */ +/** Socket shape. */ typedef enum eNodeSocketDisplayShape { SOCK_DISPLAY_SHAPE_CIRCLE = 0, SOCK_DISPLAY_SHAPE_SQUARE = 1, @@ -203,13 +203,13 @@ typedef enum eNodeSocketDisplayShape { SOCK_DISPLAY_SHAPE_DIAMOND_DOT = 5, } eNodeSocketDisplayShape; -/* Socket side (input/output). */ +/** Socket side (input/output). */ typedef enum eNodeSocketInOut { SOCK_IN = 1 << 0, SOCK_OUT = 1 << 1, } eNodeSocketInOut; -/* #bNodeSocket.flag, first bit is selection. */ +/** #bNodeSocket.flag, first bit is selection. */ typedef enum eNodeSocketFlag { /** Hidden is user defined, to hide unused sockets. */ SOCK_HIDDEN = (1 << 1), @@ -239,7 +239,7 @@ typedef enum eNodeSocketFlag { SOCK_HIDE_LABEL = (1 << 12), } eNodeSocketFlag; -/* TODO: Limit data in bNode to what we want to see saved. */ +/** TODO: Limit data in #bNode to what we want to see saved. */ typedef struct bNode { struct bNode *next, *prev, *new_node; @@ -571,7 +571,7 @@ typedef struct bNodeTree { struct PreviewImage *preview; } bNodeTree; -/* ntree->type, index */ +/** #NodeTree.type, index */ #define NTREE_UNDEFINED -2 /* Represents #NodeTreeTypeUndefined type. */ #define NTREE_CUSTOM -1 /* for dynamically registered custom types */ @@ -580,10 +580,10 @@ typedef struct bNodeTree { #define NTREE_TEXTURE 2 #define NTREE_GEOMETRY 3 -/* ntree->init, flag */ +/** #NodeTree.init, flag */ #define NTREE_TYPE_INIT 1 -/* ntree->flag */ +/** #NodeTree.flag */ #define NTREE_DS_EXPAND (1 << 0) /* for animation editors */ #define NTREE_COM_OPENCL (1 << 1) /* use opencl */ #define NTREE_TWO_PASS (1 << 2) /* two pass */ @@ -594,7 +594,7 @@ typedef struct bNodeTree { /* tree is localized copy, free when deleting node groups */ /* #define NTREE_IS_LOCALIZED (1 << 5) */ -/* ntree->update */ +/** #NodeTree.update */ typedef enum eNodeTreeUpdate { NTREE_UPDATE = 0xFFFF, /* generic update flag (includes all others) */ NTREE_UPDATE_LINKS = (1 << 0), /* links have been added or removed */ @@ -608,7 +608,7 @@ typedef enum eNodeTreeUpdate { NTREE_UPDATE_GROUP = (NTREE_UPDATE_GROUP_IN | NTREE_UPDATE_GROUP_OUT), } eNodeTreeUpdate; -/* tree->execution_mode */ +/** #NodeTree.execution_mode */ typedef enum eNodeTreeExecutionMode { NTREE_EXECUTION_MODE_TILED = 0, NTREE_EXECUTION_MODE_FULL_FRAME = 1, @@ -674,7 +674,8 @@ typedef struct bNodeSocketValueMaterial { struct Material *value; } bNodeSocketValueMaterial; -/* Data structs, for node->storage. */ +/* Data structs, for `node->storage`. */ + enum { CMP_NODE_MASKTYPE_ADD = 0, CMP_NODE_MASKTYPE_SUBTRACT = 1, @@ -713,7 +714,7 @@ typedef struct NodeFrame { short label_size; } NodeFrame; -/* This one has been replaced with ImageUser, keep it for do_versions(). */ +/** \note This one has been replaced with #ImageUser, keep it for do_versions(). */ typedef struct NodeImageAnim { int frames DNA_DEPRECATED; int sfra DNA_DEPRECATED; @@ -767,7 +768,7 @@ typedef struct NodeEllipseMask { char _pad[4]; } NodeEllipseMask; -/* Layer info for image node outputs. */ +/** Layer info for image node outputs. */ typedef struct NodeImageLayer { /* index in the Image->layers->passes lists */ int pass_index DNA_DEPRECATED; @@ -805,7 +806,7 @@ typedef struct NodeAntiAliasingData { float corner_rounding; } NodeAntiAliasingData; -/* NOTE: Only for do-version code. */ +/** \note Only for do-version code. */ typedef struct NodeHueSat { float hue, sat, val; } NodeHueSat; @@ -817,7 +818,9 @@ typedef struct NodeImageFile { int sfra, efra; } NodeImageFile; -/* XXX first struct fields should match NodeImageFile to ensure forward compatibility */ +/** + * XXX: first struct fields should match #NodeImageFile to ensure forward compatibility. + */ typedef struct NodeImageMultiFile { /** 1024 = FILE_MAX. */ char base_path[1024]; @@ -1066,7 +1069,7 @@ typedef struct NodeShaderPrincipled { char _pad[3]; } NodeShaderPrincipled; -/* TEX_output */ +/** TEX_output. */ typedef struct TexNodeOutput { char name[64]; } TexNodeOutput; @@ -1632,14 +1635,17 @@ typedef struct NodeFunctionCompare { #define NODE_IES_INTERNAL 0 #define NODE_IES_EXTERNAL 1 -/* frame node flags */ +/* Frame node flags. */ + #define NODE_FRAME_SHRINK 1 /* keep the bounding box minimal */ #define NODE_FRAME_RESIZEABLE 2 /* test flag, if frame can be resized by user */ -/* proxy node flags */ +/* Proxy node flags. */ + #define NODE_PROXY_AUTOTYPE 1 /* automatically change output type based on link */ -/* comp channel matte */ +/* Comp channel matte. */ + #define CMP_NODE_CHANNEL_MATTE_CS_RGB 1 #define CMP_NODE_CHANNEL_MATTE_CS_HSV 2 #define CMP_NODE_CHANNEL_MATTE_CS_YUV 3 @@ -1661,7 +1667,7 @@ typedef struct NodeFunctionCompare { #define SHD_VECT_TRANSFORM_SPACE_OBJECT 1 #define SHD_VECT_TRANSFORM_SPACE_CAMERA 2 -/* attribute */ +/** #NodeShaderAttribute.type */ enum { SHD_ATTRIBUTE_GEOMETRY = 0, SHD_ATTRIBUTE_OBJECT = 1, @@ -1795,7 +1801,7 @@ enum { #define SHD_AO_INSIDE 1 #define SHD_AO_LOCAL 2 -/* Mapping node vector types. */ +/** Mapping node vector types. */ enum { NODE_MAPPING_TYPE_POINT = 0, NODE_MAPPING_TYPE_TEXTURE = 1, @@ -1803,7 +1809,7 @@ enum { NODE_MAPPING_TYPE_NORMAL = 3, }; -/* Rotation node vector types. */ +/** Rotation node vector types. */ enum { NODE_VECTOR_ROTATE_TYPE_AXIS = 0, NODE_VECTOR_ROTATE_TYPE_AXIS_X = 1, @@ -1815,7 +1821,7 @@ enum { /* math node clamp */ #define SHD_MATH_CLAMP 1 -/* Math node operations. */ +/** Math node operations. */ typedef enum NodeMathOperation { NODE_MATH_ADD = 0, NODE_MATH_SUBTRACT = 1, @@ -1859,7 +1865,7 @@ typedef enum NodeMathOperation { NODE_MATH_SMOOTH_MAX = 39, } NodeMathOperation; -/* Vector Math node operations. */ +/** Vector Math node operations. */ typedef enum NodeVectorMathOperation { NODE_VECTOR_MATH_ADD = 0, NODE_VECTOR_MATH_SUBTRACT = 1, @@ -1893,14 +1899,14 @@ typedef enum NodeVectorMathOperation { NODE_VECTOR_MATH_MULTIPLY_ADD = 26, } NodeVectorMathOperation; -/* Boolean math node operations. */ +/** Boolean math node operations. */ enum { NODE_BOOLEAN_MATH_AND = 0, NODE_BOOLEAN_MATH_OR = 1, NODE_BOOLEAN_MATH_NOT = 2, }; -/* Float compare node operations. */ +/** Float compare node operations. */ typedef enum NodeCompareMode { NODE_COMPARE_MODE_ELEMENT = 0, NODE_COMPARE_MODE_LENGTH = 1, @@ -1921,7 +1927,7 @@ typedef enum NodeCompareOperation { } NodeCompareOperation; -/* Float to Int node operations. */ +/** Float to Int node operations. */ typedef enum FloatToIntRoundingMode { FN_NODE_FLOAT_TO_INT_ROUND = 0, FN_NODE_FLOAT_TO_INT_FLOOR = 1, @@ -1929,13 +1935,13 @@ typedef enum FloatToIntRoundingMode { FN_NODE_FLOAT_TO_INT_TRUNCATE = 3, } FloatToIntRoundingMode; -/* Clamp node types. */ +/** Clamp node types. */ enum { NODE_CLAMP_MINMAX = 0, NODE_CLAMP_RANGE = 1, }; -/* Map range node types. */ +/** Map range node types. */ enum { NODE_MAP_RANGE_LINEAR = 0, NODE_MAP_RANGE_STEPPED = 1, @@ -1947,7 +1953,8 @@ enum { #define SHD_MIXRGB_USE_ALPHA 1 #define SHD_MIXRGB_CLAMP 2 -/* subsurface */ +/* Subsurface. */ + enum { #ifdef DNA_DEPRECATED_ALLOW SHD_SUBSURFACE_COMPATIBLE = 0, /* Deprecated */ @@ -1978,25 +1985,29 @@ enum { /* viewer and composite output. */ #define CMP_NODE_OUTPUT_IGNORE_ALPHA 1 -/* Plane track deform node */ +/* Plane track deform node. */ + enum { CMP_NODEFLAG_PLANETRACKDEFORM_MOTION_BLUR = 1, }; -/* Stabilization node */ +/* Stabilization node. */ + enum { CMP_NODEFLAG_STABILIZE_INVERSE = 1, }; /* Set Alpha Node. */ -/* `NodeSetAlpha.mode` */ + +/** #NodeSetAlpha.mode */ typedef enum CMPNodeSetAlphaMode { CMP_NODE_SETALPHA_MODE_APPLY = 0, CMP_NODE_SETALPHA_MODE_REPLACE_ALPHA = 1, } CMPNodeSetAlphaMode; /* Denoise Node. */ -/* `NodeDenoise.prefilter` */ + +/** #NodeDenoise.prefilter */ typedef enum CMPNodeDenoisePrefilter { CMP_NODE_DENOISE_PREFILTER_FAST = 0, CMP_NODE_DENOISE_PREFILTER_NONE = 1, diff --git a/source/blender/makesdna/DNA_object_force_types.h b/source/blender/makesdna/DNA_object_force_types.h index 0aa4a171511..7d0d4c0d460 100644 --- a/source/blender/makesdna/DNA_object_force_types.h +++ b/source/blender/makesdna/DNA_object_force_types.h @@ -32,7 +32,7 @@ extern "C" { struct BodySpring; -/* pd->forcefield: Effector Fields types */ +/** #PartDeflect.forcefield: Effector Fields types. */ typedef enum ePFieldType { /** (this is used for general effector weight). */ PFIELD_NULL = 0, diff --git a/source/blender/makesdna/DNA_object_types.h b/source/blender/makesdna/DNA_object_types.h index 57c8ef200ae..c9345b6a950 100644 --- a/source/blender/makesdna/DNA_object_types.h +++ b/source/blender/makesdna/DNA_object_types.h @@ -57,7 +57,7 @@ struct SculptSession; struct SoftBody; struct bGPdata; -/* Vertex Groups - Name Info */ +/** Vertex Groups - Name Info */ typedef struct bDeformGroup { struct bDeformGroup *next, *prev; /** MAX_VGROUP_NAME. */ @@ -66,7 +66,7 @@ typedef struct bDeformGroup { char flag, _pad0[7]; } bDeformGroup; -/* Face Maps. */ +/** Face Maps. */ typedef struct bFaceMap { struct bFaceMap *next, *prev; /** MAX_VGROUP_NAME. */ @@ -107,7 +107,7 @@ typedef struct BoundBox { char _pad0[4]; } BoundBox; -/* boundbox flag */ +/** #BoundBox.flag */ enum { BOUNDBOX_DISABLED = (1 << 0), BOUNDBOX_DIRTY = (1 << 1), @@ -115,7 +115,7 @@ enum { struct CustomData_MeshMasks; -/* Not saved in file! */ +/** Not saved in file! */ typedef struct Object_Runtime { /** * The custom data layer mask that was last used @@ -246,7 +246,7 @@ typedef struct Object { /** String describing subobject info, MAX_ID_NAME-2. */ char parsubstr[64]; struct Object *parent, *track; - /* if ob->proxy (or proxy_group), this object is proxy for object ob->proxy */ + /* If `ob->proxy` (or proxy_group), this object is proxy for object `ob->proxy`. */ /* proxy_from is set in target back to the proxy. */ struct Object *proxy, *proxy_group, *proxy_from; /** Old animation system, deprecated for 2.5. */ @@ -322,8 +322,7 @@ typedef struct Object { * Inverse matrix of 'obmat' for any other use than rendering! * * \note this isn't assured to be valid as with 'obmat', - * before using this value you should do... - * invert_m4_m4(ob->imat, ob->obmat); + * before using this value you should do: `invert_m4_m4(ob->imat, ob->obmat)` */ float imat[4][4]; @@ -436,7 +435,7 @@ typedef struct Object { Object_Runtime runtime; } Object; -/* Warning, this is not used anymore because hooks are now modifiers */ +/** DEPRECATED: this is not used anymore because hooks are now modifiers. */ typedef struct ObHook { struct ObHook *next, *prev; @@ -466,7 +465,7 @@ typedef struct ObHook { /* used many places, should be specialized. */ #define SELECT 1 -/* type */ +/** #Object.type */ enum { OB_EMPTY = 0, OB_MESH = 1, @@ -544,7 +543,7 @@ enum { case ID_PT: \ case ID_VO -/* partype: first 4 bits: type */ +/** #Object.partype: first 4 bits: type. */ enum { PARTYPE = (1 << 4) - 1, PAROBJECT = 0, @@ -555,7 +554,7 @@ enum { }; -/* (short) transflag */ +/** #Object.transflag (short) */ enum { OB_TRANSFORM_ADJUST_ROOT_PARENT_FOR_VIEW_LOCK = 1 << 0, OB_TRANSFLAG_UNUSED_1 = 1 << 1, /* cleared */ @@ -577,7 +576,7 @@ enum { OB_DUPLI = OB_DUPLIVERTS | OB_DUPLICOLLECTION | OB_DUPLIFACES | OB_DUPLIPARTS, }; -/* (short) trackflag / upflag */ +/** #Object.trackflag / #Object.upflag (short) */ enum { OB_POSX = 0, OB_POSY = 1, @@ -587,7 +586,7 @@ enum { OB_NEGZ = 5, }; -/* dtx: flags (short) */ +/** #Object.dtx draw type extra flags (short) */ enum { OB_DRAWBOUNDOX = 1 << 0, OB_AXIS = 1 << 1, @@ -606,7 +605,7 @@ enum { OB_USE_GPENCIL_LIGHTS = 1 << 10, }; -/* empty_drawtype: no flags */ +/** #Object.empty_drawtype: no flags */ enum { OB_ARROWS = 1, OB_PLAINAXES = 2, @@ -618,7 +617,10 @@ enum { OB_EMPTY_IMAGE = 8, }; -/* gpencil add types */ +/** + * Grease-pencil add types. + * TODO: doesn't need to be DNA, local to `OBJECT_OT_gpencil_add`. + */ enum { GP_EMPTY = 0, GP_STROKE = 1, @@ -628,7 +630,7 @@ enum { GP_LRT_COLLECTION = 5, }; -/* boundtype */ +/** #Object.boundtype */ enum { OB_BOUND_BOX = 0, OB_BOUND_SPHERE = 1, @@ -642,7 +644,7 @@ enum { /* **************** BASE ********************* */ -/* base->flag_legacy */ +/** #Base.flag_legacy */ enum { BA_WAS_SEL = (1 << 1), /* NOTE: BA_HAS_RECALC_DATA can be re-used later if freed in readfile.c. */ @@ -671,7 +673,7 @@ enum { # define OB_FLAG_UNUSED_12 (1 << 12) /* cleared */ #endif -/* ob->visibility_flag */ +/** #Object.visibility_flag */ enum { OB_HIDE_VIEWPORT = 1 << 0, OB_HIDE_SELECT = 1 << 1, @@ -686,7 +688,7 @@ enum { OB_SHADOW_CATCHER = 1 << 10 }; -/* ob->shapeflag */ +/** #Object.shapeflag */ enum { OB_SHAPE_LOCK = 1 << 0, #ifdef DNA_DEPRECATED_ALLOW @@ -695,7 +697,7 @@ enum { OB_SHAPE_EDIT_MODE = 1 << 2, }; -/* ob->nlaflag */ +/** #Object.nlaflag */ enum { OB_ADS_UNUSED_1 = 1 << 0, /* cleared */ OB_ADS_UNUSED_2 = 1 << 1, /* cleared */ @@ -711,7 +713,7 @@ enum { /* OB_ADS_SHOWPARTS = 1 << 14, */ /* UNUSED */ }; -/* ob->protectflag */ +/** #Object.protectflag */ enum { OB_LOCK_LOCX = 1 << 0, OB_LOCK_LOCY = 1 << 1, @@ -729,13 +731,13 @@ enum { OB_LOCK_ROT4D = 1 << 10, }; -/* ob->duplicator_visibility_flag */ +/** #Object.duplicator_visibility_flag */ enum { OB_DUPLI_FLAG_VIEWPORT = 1 << 0, OB_DUPLI_FLAG_RENDER = 1 << 1, }; -/* ob->empty_image_depth */ +/** #Object.empty_image_depth */ #define OB_EMPTY_IMAGE_DEPTH_DEFAULT 0 #define OB_EMPTY_IMAGE_DEPTH_FRONT 1 #define OB_EMPTY_IMAGE_DEPTH_BACK 2 diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h index a51c532dfb3..5add664f624 100644 --- a/source/blender/makesdna/DNA_particle_types.h +++ b/source/blender/makesdna/DNA_particle_types.h @@ -72,7 +72,7 @@ typedef struct ParticleSpring { unsigned int particle_index[2], delete_flag; } ParticleSpring; -/* Child particles are created around or between parent particles */ +/** Child particles are created around or between parent particles. */ typedef struct ChildParticle { /** Face index on the final derived mesh. */ int num; @@ -364,8 +364,7 @@ typedef struct ParticleSystem { int flag, totpart, totunexist, totchild, totcached, totchildcache; /* NOTE: Recalc is one of ID_RECALC_PSYS_ALL flags. * - * TODO(sergey): Use part->id.recalc instead of this duplicated flag - * somehow. */ + * TODO(sergey): Use #ParticleSettings.id.recalc instead of this duplicated flag somehow. */ int recalc; short target_psys, totkeyed, bakespace; char _pad1[6]; @@ -438,9 +437,11 @@ typedef enum eParticleDrawFlag { PART_DRAW_HAIR_GRID = (1 << 18), } eParticleDrawFlag; -/* part->type +/** + * #ParticleSettings.type * Hair is always baked static in object/geometry space. - * Other types (normal particles) are in global space and not static baked. */ + * Other types (normal particles) are in global space and not static baked. + */ enum { PART_EMITTER = 0, /* REACTOR type currently unused */ @@ -458,7 +459,7 @@ enum { PART_FLUID_SPRAYFOAMBUBBLE = 12, }; -/* Mirroring Mantaflow particle types from particle.h (Mantaflow header). */ +/** Mirroring Mantaflow particle types from particle.h (Mantaflow header). */ enum { /* PARTICLE_TYPE_NONE = (0 << 0), */ /* UNUSED */ /* PARTICLE_TYPE_NEW = (1 << 0), */ /* UNUSED */ @@ -470,7 +471,7 @@ enum { /* PARTICLE_TYPE_INVALID = (1 << 30), */ /* UNUSED */ }; -/* part->flag */ +/** #ParticleSettings.flag */ #define PART_REACT_STA_END 1 #define PART_REACT_MULTIPLE 2 @@ -514,26 +515,26 @@ enum { #define PART_SELF_EFFECT (1 << 22) -/* part->from */ +/** #ParticleSettings.from */ #define PART_FROM_VERT 0 #define PART_FROM_FACE 1 #define PART_FROM_VOLUME 2 /* #define PART_FROM_PARTICLE 3 deprecated! */ #define PART_FROM_CHILD 4 -/* part->distr */ +/** #ParticleSettings.distr */ #define PART_DISTR_JIT 0 #define PART_DISTR_RAND 1 #define PART_DISTR_GRID 2 -/* part->phystype */ +/** #ParticleSettings.phystype */ #define PART_PHYS_NO 0 #define PART_PHYS_NEWTON 1 #define PART_PHYS_KEYED 2 #define PART_PHYS_BOIDS 3 #define PART_PHYS_FLUID 4 -/* part->kink */ +/** #ParticleSettings.kink */ typedef enum eParticleKink { PART_KINK_NO = 0, PART_KINK_CURL = 1, @@ -543,7 +544,7 @@ typedef enum eParticleKink { PART_KINK_SPIRAL = 5, } eParticleKink; -/* part->child_flag */ +/** #ParticleSettings.child_flag */ typedef enum eParticleChildFlag { PART_CHILD_USE_CLUMP_NOISE = (1 << 0), PART_CHILD_USE_CLUMP_CURVE = (1 << 1), @@ -551,22 +552,22 @@ typedef enum eParticleChildFlag { PART_CHILD_USE_TWIST_CURVE = (1 << 3), } eParticleChildFlag; -/* part->shape_flag */ +/** #ParticleSettings.shape_flag */ typedef enum eParticleShapeFlag { PART_SHAPE_CLOSE_TIP = (1 << 0), } eParticleShapeFlag; -/* part->draw_col */ +/* #ParticleSettings.draw_col */ #define PART_DRAW_COL_NONE 0 #define PART_DRAW_COL_MAT 1 #define PART_DRAW_COL_VEL 2 #define PART_DRAW_COL_ACC 3 -/* part->time_flag */ +/* #ParticleSettings.time_flag */ #define PART_TIME_AUTOSF 1 /* Automatic subframes */ -/* part->draw_as */ -/* part->ren_as */ +/* #ParticleSettings.draw_as */ +/* #ParticleSettings.ren_as */ #define PART_DRAW_NOT 0 #define PART_DRAW_DOT 1 #define PART_DRAW_HALO 1 @@ -580,13 +581,13 @@ typedef enum eParticleShapeFlag { #define PART_DRAW_BB 9 /* deprecated */ #define PART_DRAW_REND 10 -/* part->integrator */ +/* #ParticleSettings.integrator */ #define PART_INT_EULER 0 #define PART_INT_MIDPOINT 1 #define PART_INT_RK4 2 #define PART_INT_VERLET 3 -/* part->rotmode */ +/* #ParticleSettings.rotmode */ #define PART_ROT_NOR 1 #define PART_ROT_VEL 2 #define PART_ROT_GLOB_X 3 @@ -597,7 +598,7 @@ typedef enum eParticleShapeFlag { #define PART_ROT_OB_Z 8 #define PART_ROT_NOR_TAN 9 -/* part->avemode */ +/* #ParticleSettings.avemode */ #define PART_AVE_VELOCITY 1 #define PART_AVE_RAND 2 #define PART_AVE_HORIZONTAL 3 @@ -606,12 +607,12 @@ typedef enum eParticleShapeFlag { #define PART_AVE_GLOBAL_Y 6 #define PART_AVE_GLOBAL_Z 7 -/* part->reactevent */ +/* #ParticleSettings.reactevent */ #define PART_EVENT_DEATH 0 #define PART_EVENT_COLLIDE 1 #define PART_EVENT_NEAR 2 -/* part->childtype */ +/* #ParticleSettings.childtype */ #define PART_CHILD_PARTICLES 1 #define PART_CHILD_FACES 2 @@ -675,7 +676,7 @@ typedef enum eParticleShapeFlag { #define PTARGET_MODE_FRIEND 1 #define PTARGET_MODE_ENEMY 2 -/* mapto */ +/** #MTex.mapto */ typedef enum eParticleTextureInfluence { /* init */ PAMAP_TIME = (1 << 0), /* emission time */ diff --git a/source/blender/makesdna/DNA_pointcloud_types.h b/source/blender/makesdna/DNA_pointcloud_types.h index 26f1db3324b..53fda29a33a 100644 --- a/source/blender/makesdna/DNA_pointcloud_types.h +++ b/source/blender/makesdna/DNA_pointcloud_types.h @@ -54,7 +54,7 @@ typedef struct PointCloud { void *batch_cache; } PointCloud; -/* PointCloud.flag */ +/** #PointCloud.flag */ enum { PT_DS_EXPAND = (1 << 0), }; diff --git a/source/blender/makesdna/DNA_rigidbody_types.h b/source/blender/makesdna/DNA_rigidbody_types.h index aa11e74e89d..f653905e169 100644 --- a/source/blender/makesdna/DNA_rigidbody_types.h +++ b/source/blender/makesdna/DNA_rigidbody_types.h @@ -38,7 +38,7 @@ struct EffectorWeights; /* ******************************** */ /* RigidBody World */ -/* Container for data shared by original and evaluated copies of RigidBodyWorld */ +/** Container for data shared by original and evaluated copies of #RigidBodyWorld. */ typedef struct RigidBodyWorld_Shared { /* cache */ struct PointCache *pointcache; @@ -90,7 +90,7 @@ typedef struct RigidBodyWorld { float time_scale; } RigidBodyWorld; -/* Flags for RigidBodyWorld */ +/** RigidBodyWorld.flag */ typedef enum eRigidBodyWorld_Flag { /* should sim world be skipped when evaluating (user setting) */ RBW_FLAG_MUTED = (1 << 0), @@ -170,7 +170,7 @@ typedef struct RigidBodyOb { struct RigidBodyOb_Shared *shared; } RigidBodyOb; -/* Participation types for RigidBodyOb */ +/** #RigidBodyOb.type */ typedef enum eRigidBodyOb_Type { /* active geometry participant in simulation. is directly controlled by sim */ RBO_TYPE_ACTIVE = 0, @@ -178,7 +178,7 @@ typedef enum eRigidBodyOb_Type { RBO_TYPE_PASSIVE = 1, } eRigidBodyOb_Type; -/* Flags for RigidBodyOb */ +/** #RigidBodyOb.flag */ typedef enum eRigidBodyOb_Flag { /* rigidbody is kinematic (controlled by the animation system) */ RBO_FLAG_KINEMATIC = (1 << 0), @@ -198,7 +198,7 @@ typedef enum eRigidBodyOb_Flag { RBO_FLAG_USE_DEFORM = (1 << 7), } eRigidBodyOb_Flag; -/* RigidBody Collision Shape */ +/** Rigid Body Collision Shape. */ typedef enum eRigidBody_Shape { /** Simple box (i.e. bounding box). */ RB_SHAPE_BOX = 0, @@ -304,7 +304,7 @@ typedef struct RigidBodyCon { void *physics_constraint; } RigidBodyCon; -/* Participation types for RigidBodyOb */ +/** Participation types for #RigidBodyOb.type */ typedef enum eRigidBodyCon_Type { /** lets bodies rotate around a specified point */ RBC_TYPE_POINT = 0, @@ -333,13 +333,13 @@ typedef enum eRigidBodyCon_Type { RBC_TYPE_MOTOR = 11, } eRigidBodyCon_Type; -/* Spring implementation type for RigidBodyOb */ +/** Spring implementation type for RigidBodyOb. */ typedef enum eRigidBodyCon_SpringType { RBC_SPRING_TYPE1 = 0, /* btGeneric6DofSpringConstraint */ RBC_SPRING_TYPE2 = 1, /* btGeneric6DofSpring2Constraint */ } eRigidBodyCon_SpringType; -/* Flags for RigidBodyCon */ +/** #RigidBodyCon.flag */ typedef enum eRigidBodyCon_Flag { /* constraint influences rigid body motion */ RBC_FLAG_ENABLED = (1 << 0), diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index c66ac3a6211..4607a47a9a8 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -195,7 +195,7 @@ typedef struct AudioData { /* *************************************************************** */ /* Render Layers */ -/* Render Layer */ +/** Render Layer. */ typedef struct SceneRenderLayer { struct SceneRenderLayer *next, *prev; @@ -323,7 +323,7 @@ typedef enum eScenePassType { #define RE_PASSNAME_BLOOM "BloomCol" #define RE_PASSNAME_VOLUME_LIGHT "VolumeDir" -/* View - MultiView */ +/** View - MultiView. */ typedef struct SceneRenderView { struct SceneRenderView *next, *prev; @@ -785,12 +785,12 @@ typedef struct RenderData { struct CurveMapping mblur_shutter_curve; } RenderData; -/* RenderData.quality_flag */ +/** #RenderData.quality_flag */ typedef enum eQualityOption { SCE_PERF_HQ_NORMALS = (1 << 0), } eQualityOption; -/* RenderData.hair_type */ +/** #RenderData.hair_type */ typedef enum eHairType { SCE_HAIR_SHAPE_STRAND = 0, SCE_HAIR_SHAPE_STRIP = 1, @@ -799,7 +799,7 @@ typedef enum eHairType { /* *************************************************************** */ /* Render Conversion/Simplification Settings */ -/* control render convert and shading engine */ +/** Control render convert and shading engine. */ typedef struct RenderProfile { struct RenderProfile *next, *prev; char name[32]; @@ -829,7 +829,7 @@ typedef struct RenderProfile { #define STEREO_RIGHT_SUFFIX "_R" #define STEREO_LEFT_SUFFIX "_L" -/* View3D.stereo3d_camera / View3D.multiview_eye / ImageUser.multiview_eye */ +/** #View3D.stereo3d_camera / #View3D.multiview_eye / #ImageUser.multiview_eye */ typedef enum eStereoViews { STEREO_LEFT_ID = 0, STEREO_RIGHT_ID = 1, @@ -861,12 +861,12 @@ typedef struct Paint_Runtime { char _pad[2]; } Paint_Runtime; -/* We might want to store other things here. */ +/** We might want to store other things here. */ typedef struct PaintToolSlot { struct Brush *brush; } PaintToolSlot; -/* Paint Tool Base */ +/** Paint Tool Base. */ typedef struct Paint { struct Brush *brush; @@ -903,7 +903,7 @@ typedef struct Paint { /* ------------------------------------------- */ /* Image Paint */ -/* Texture/Image Editor */ +/** Texture/Image Editor. */ typedef struct ImagePaintSettings { Paint paint; @@ -934,7 +934,7 @@ typedef struct ImagePaintSettings { /* ------------------------------------------- */ /* Particle Edit */ -/* Settings for a Particle Editing Brush */ +/** Settings for a Particle Editing Brush. */ typedef struct ParticleBrushData { /** Common setting. */ short size; @@ -944,7 +944,7 @@ typedef struct ParticleBrushData { float strength; } ParticleBrushData; -/* Particle Edit Mode Settings */ +/** Particle Edit Mode Settings. */ typedef struct ParticleEditSettings { short flag; short totrekey; @@ -971,7 +971,7 @@ typedef struct ParticleEditSettings { /* ------------------------------------------- */ /* Sculpt */ -/* Sculpt */ +/** Sculpt. */ typedef struct Sculpt { Paint paint; @@ -1006,7 +1006,7 @@ typedef struct UvSculpt { Paint paint; } UvSculpt; -/* grease pencil drawing brushes */ +/** Grease pencil drawing brushes. */ typedef struct GpPaint { Paint paint; int flag; @@ -1020,21 +1020,21 @@ enum { GPPAINT_FLAG_USE_VERTEXCOLOR = 1, }; -/* Grease pencil vertex paint. */ +/** Grease pencil vertex paint. */ typedef struct GpVertexPaint { Paint paint; int flag; char _pad[4]; } GpVertexPaint; -/* Grease pencil sculpt paint. */ +/** Grease pencil sculpt paint. */ typedef struct GpSculptPaint { Paint paint; int flag; char _pad[4]; } GpSculptPaint; -/* Grease pencil weight paint. */ +/** Grease pencil weight paint. */ typedef struct GpWeightPaint { Paint paint; int flag; @@ -1044,7 +1044,7 @@ typedef struct GpWeightPaint { /* ------------------------------------------- */ /* Vertex Paint */ -/* Vertex Paint */ +/** Vertex Paint. */ typedef struct VPaint { Paint paint; char flag; @@ -1062,7 +1062,7 @@ enum { /* ------------------------------------------- */ /* GPencil Stroke Sculpting */ -/* GP_Sculpt_Settings.lock_axis */ +/** #GP_Sculpt_Settings.lock_axis */ typedef enum eGP_Lockaxis_Types { GP_LOCKAXIS_VIEW = 0, GP_LOCKAXIS_X = 1, @@ -1071,7 +1071,7 @@ typedef enum eGP_Lockaxis_Types { GP_LOCKAXIS_CURSOR = 4, } eGP_Lockaxis_Types; -/* Settings for a GPencil Speed Guide */ +/** Settings for a GPencil Speed Guide. */ typedef struct GP_Sculpt_Guide { char use_guide; char use_snapping; @@ -1085,7 +1085,7 @@ typedef struct GP_Sculpt_Guide { struct Object *reference_object; } GP_Sculpt_Guide; -/* GPencil Stroke Sculpting Settings */ +/** GPencil Stroke Sculpting Settings. */ typedef struct GP_Sculpt_Settings { /** Runtime. */ void *paintcursor; @@ -1134,7 +1134,7 @@ typedef enum eGP_vertex_SelectMaskFlag { GP_VERTEX_MASK_SELECTMODE_SEGMENT = (1 << 2), } eGP_Vertex_SelectMaskFlag; -/* Settings for GP Interpolation Operators */ +/** Settings for GP Interpolation Operators. */ typedef struct GP_Interpolate_Settings { /** Custom interpolation curve (for use with GP_IPO_CURVEMAP). */ struct CurveMapping *custom_ipo; @@ -1255,7 +1255,7 @@ typedef struct UnifiedPaintSettings { struct ColorSpace *colorspace; } UnifiedPaintSettings; -/* UnifiedPaintSettings.flag */ +/** #UnifiedPaintSettings.flag */ typedef enum { UNIFIED_PAINT_SIZE = (1 << 0), UNIFIED_PAINT_ALPHA = (1 << 1), @@ -1313,7 +1313,7 @@ enum { /* *************************************************************** */ /* Stats */ -/* Stats for Meshes */ +/** Stats for Meshes. */ typedef struct MeshStatVis { char type; char _pad1[2]; @@ -1570,8 +1570,8 @@ typedef struct PhysicsSettings { char _pad0[4]; } PhysicsSettings; -/* ------------------------------------------- */ -/* Safe Area options used in Camera View & Sequencer +/** + * Safe Area options used in Camera View & Sequencer. */ typedef struct DisplaySafeAreas { /* each value represents the (x,y) margins as a multiplier. @@ -1587,8 +1587,9 @@ typedef struct DisplaySafeAreas { float action_center[2]; } DisplaySafeAreas; -/* ------------------------------------------- */ -/* Scene Display - used for store scene specific display settings for the 3d view */ +/** + * Scene Display - used for store scene specific display settings for the 3d view. + */ typedef struct SceneDisplay { /** Light direction for shadows/highlight. */ float light_direction[3]; diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h index a4c254d6e5a..1a1d7cba7af 100644 --- a/source/blender/makesdna/DNA_screen_types.h +++ b/source/blender/makesdna/DNA_screen_types.h @@ -244,7 +244,7 @@ typedef struct PanelCategoryDyn { rcti rect; } PanelCategoryDyn; -/* region stack of active tabs */ +/** Region stack of active tabs. */ typedef struct PanelCategoryStack { struct PanelCategoryStack *next, *prev; char idname[64]; @@ -654,8 +654,10 @@ enum { #define UILST_FLT_SORT_MASK (((unsigned int)(UILST_FLT_SORT_REVERSE | UILST_FLT_SORT_LOCK)) - 1) -/* regiontype, first two are the default set */ -/* Do NOT change order, append on end. Types are hardcoded needed */ +/** + * regiontype, first two are the default set. + * \warning Do NOT change order, append on end. Types are hard-coded needed. + */ typedef enum eRegion_Type { RGN_TYPE_WINDOW = 0, RGN_TYPE_HEADER = 1, diff --git a/source/blender/makesdna/DNA_sequence_types.h b/source/blender/makesdna/DNA_sequence_types.h index e1bba60396a..5fe67a34dae 100644 --- a/source/blender/makesdna/DNA_sequence_types.h +++ b/source/blender/makesdna/DNA_sequence_types.h @@ -47,6 +47,10 @@ struct SequenceLookup; struct VFont; struct bSound; +/* -------------------------------------------------------------------- */ +/** \name Sequence & Editing Structs + * \{ */ + /* strlens; 256= FILE_MAXFILE, 768= FILE_MAXDIR */ typedef struct StripAnim { @@ -311,7 +315,12 @@ typedef struct Editing { void *_pad1; } Editing; -/* ************* Effect Variable Structs ********* */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Effect Variable Structs + * \{ */ + typedef struct WipeVars { float edgeWidth, angle; short forward, wipetype; @@ -360,7 +369,7 @@ typedef struct SpeedControlVars { float speed_fader_frame_number; } SpeedControlVars; -/* SpeedControlVars.speed_control_type */ +/** #SpeedControlVars.speed_control_type */ enum { SEQ_SPEED_STRETCH = 0, SEQ_SPEED_MULTIPLY = 1, @@ -387,7 +396,7 @@ typedef struct TextVars { char _pad[5]; } TextVars; -/* TextVars.flag */ +/** #TextVars.flag */ enum { SEQ_TEXT_SHADOW = (1 << 0), SEQ_TEXT_BOX = (1 << 1), @@ -395,14 +404,14 @@ enum { SEQ_TEXT_ITALIC = (1 << 3), }; -/* TextVars.align */ +/** #TextVars.align */ enum { SEQ_TEXT_ALIGN_X_LEFT = 0, SEQ_TEXT_ALIGN_X_CENTER = 1, SEQ_TEXT_ALIGN_X_RIGHT = 2, }; -/* TextVars.align_y */ +/** #TextVars.align_y */ enum { SEQ_TEXT_ALIGN_Y_TOP = 0, SEQ_TEXT_ALIGN_Y_CENTER = 1, @@ -418,7 +427,11 @@ typedef struct ColorMixVars { float factor; } ColorMixVars; -/* ***************** Sequence modifiers ****************** */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Sequence Modifiers + * \{ */ typedef struct SequenceModifierData { struct SequenceModifierData *next, *prev; @@ -489,7 +502,11 @@ enum { SEQ_TONEMAP_RD_PHOTORECEPTOR = 1, }; -/* ***************** Scopes ****************** */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Scopes + * \{ */ typedef struct SequencerScopes { struct ImBuf *reference_ibuf; @@ -522,10 +539,15 @@ typedef struct SequencerScopes { #define SEQ_SPEED_UNUSED_3 (1 << 2) /* cleared */ #define SEQ_SPEED_USE_INTERPOLATION (1 << 3) -/* ***************** SEQUENCE ****************** */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Flags & Types + * \{ */ + #define SEQ_NAME_MAXSTR 64 -/* seq->flag */ +/** #Sequence.flag */ enum { /* SELECT */ SEQ_LEFTSEL = (1 << 1), @@ -568,7 +590,7 @@ enum { SEQ_INVALID_EFFECT = (1u << 31), }; -/* StripProxy->storage */ +/** #StripProxy.storage */ enum { SEQ_STORAGE_PROXY_CUSTOM_FILE = (1 << 1), /* store proxy in custom directory */ SEQ_STORAGE_PROXY_CUSTOM_DIR = (1 << 2), /* store proxy in custom file */ @@ -601,18 +623,22 @@ enum { #define SEQ_PROXY_TC_RECORD_RUN_NO_GAPS 8 #define SEQ_PROXY_TC_ALL 15 -/* SeqProxy->build_flags */ +/** SeqProxy.build_flags */ enum { SEQ_PROXY_SKIP_EXISTING = 1, }; -/* seq->alpha_mode */ +/** #Sequence.alpha_mode */ enum { SEQ_ALPHA_STRAIGHT = 0, SEQ_ALPHA_PREMUL = 1, }; -/* seq->type WATCH IT: SEQ_TYPE_EFFECT BIT is used to determine if this is an effect strip!!! */ +/** + * #Sequence.type + * + * \warning #SEQ_TYPE_EFFECT BIT is used to determine if this is an effect strip! + */ enum { SEQ_TYPE_IMAGE = 0, SEQ_TYPE_META = 1, @@ -681,7 +707,7 @@ enum { /* modifiers */ -/* SequenceModifierData->type */ +/** #SequenceModifierData.type */ enum { seqModifierType_ColorBalance = 1, seqModifierType_Curves = 2, @@ -694,7 +720,7 @@ enum { NUM_SEQUENCE_MODIFIER_TYPES, }; -/* SequenceModifierData->flag */ +/** #SequenceModifierData.flag */ enum { SEQUENCE_MODIFIER_MUTE = (1 << 0), SEQUENCE_MODIFIER_EXPANDED = (1 << 1), @@ -712,13 +738,14 @@ enum { SEQUENCE_MASK_TIME_ABSOLUTE = 1, }; -/* Sequence->cache_flag - * SEQ_CACHE_STORE_RAW - * SEQ_CACHE_STORE_PREPROCESSED - * SEQ_CACHE_STORE_COMPOSITE - * FINAL_OUT is ignored +/** + * #Sequence.cache_flag + * - #SEQ_CACHE_STORE_RAW + * - #SEQ_CACHE_STORE_PREPROCESSED + * - #SEQ_CACHE_STORE_COMPOSITE + * - #FINAL_OUT is ignored * - * Editing->cache_flag + * #Editing.cache_flag * all entries */ enum { @@ -745,7 +772,7 @@ enum { SEQ_CACHE_STORE_THUMBNAIL = (1 << 12), }; -/* Sequence->color_tag. */ +/** #Sequence.color_tag. */ typedef enum SequenceColorTag { SEQUENCE_COLOR_NONE = -1, SEQUENCE_COLOR_01, diff --git a/source/blender/makesdna/DNA_shader_fx_types.h b/source/blender/makesdna/DNA_shader_fx_types.h index 01e3b3a5230..be787c1760f 100644 --- a/source/blender/makesdna/DNA_shader_fx_types.h +++ b/source/blender/makesdna/DNA_shader_fx_types.h @@ -77,7 +77,7 @@ typedef struct ShaderFxData { char *error; } ShaderFxData; -/* Runtime temp data */ +/** Runtime temp data. */ typedef struct ShaderFxData_Runtime { float loc[3]; char _pad[4]; diff --git a/source/blender/makesdna/DNA_simulation_types.h b/source/blender/makesdna/DNA_simulation_types.h index a700c9fe2f8..b14301ed32d 100644 --- a/source/blender/makesdna/DNA_simulation_types.h +++ b/source/blender/makesdna/DNA_simulation_types.h @@ -38,7 +38,7 @@ typedef struct Simulation { char _pad[4]; } Simulation; -/* Simulation.flag */ +/** #Simulation.flag */ enum { SIM_DS_EXPAND = (1 << 0), }; diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index a7a19be5b3e..7837409cece 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -61,16 +61,16 @@ struct bNodeTree; struct wmOperator; struct wmTimer; -/* Defined in `buttons_intern.h`. */ +/** Defined in `buttons_intern.h`. */ typedef struct SpaceProperties_Runtime SpaceProperties_Runtime; -/* Defined in `node_intern.hh`. */ +/** Defined in `node_intern.hh`. */ typedef struct SpaceNode_Runtime SpaceNode_Runtime; -/* Defined in `file_intern.h`. */ +/** Defined in `file_intern.h`. */ typedef struct SpaceFile_Runtime SpaceFile_Runtime; -/* Defined in `spreadsheet_intern.hh`. */ +/** Defined in `spreadsheet_intern.hh`. */ typedef struct SpaceSpreadsheet_Runtime SpaceSpreadsheet_Runtime; /* -------------------------------------------------------------------- */ @@ -91,7 +91,7 @@ typedef struct SpaceLink { char _pad0[6]; } SpaceLink; -/* SpaceLink.link_flag */ +/** #SpaceLink.link_flag */ enum { /** * The space is not a regular one opened through the editor menu (for example) but spawned by an @@ -113,7 +113,7 @@ enum { /** \name Space Info * \{ */ -/* Info Header */ +/** Info Header. */ typedef struct SpaceInfo { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -127,7 +127,7 @@ typedef struct SpaceInfo { char _pad[7]; } SpaceInfo; -/* SpaceInfo.rpt_mask */ +/** #SpaceInfo.rpt_mask */ typedef enum eSpaceInfo_RptMask { INFO_RPT_DEBUG = (1 << 0), INFO_RPT_INFO = (1 << 1), @@ -142,7 +142,7 @@ typedef enum eSpaceInfo_RptMask { /** \name Properties Editor * \{ */ -/* Properties Editor */ +/** Properties Editor. */ typedef struct SpaceProperties { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -210,7 +210,7 @@ typedef struct SpaceProperties { // #define BUTS_EFFECTS 14 #endif /* DNA_DEPRECATED_ALLOW */ -/* SpaceProperties.mainb new */ +/** #SpaceProperties.mainb new */ typedef enum eSpaceButtons_Context { BCONTEXT_RENDER = 0, BCONTEXT_SCENE = 1, @@ -235,7 +235,7 @@ typedef enum eSpaceButtons_Context { BCONTEXT_TOT, } eSpaceButtons_Context; -/* SpaceProperties.flag */ +/** #SpaceProperties.flag */ typedef enum eSpaceButtons_Flag { /* SB_PRV_OSA = (1 << 0), */ /* UNUSED */ SB_PIN_CONTEXT = (1 << 1), @@ -246,7 +246,7 @@ typedef enum eSpaceButtons_Flag { SB_SHADING_CONTEXT = (1 << 4), } eSpaceButtons_Flag; -/* SpaceProperties.outliner_sync */ +/** #SpaceProperties.outliner_sync */ typedef enum eSpaceButtons_OutlinerSync { PROPERTIES_SYNC_AUTO = 0, PROPERTIES_SYNC_NEVER = 1, @@ -259,10 +259,10 @@ typedef enum eSpaceButtons_OutlinerSync { /** \name Outliner * \{ */ -/* Defined in `outliner_intern.h`. */ +/** Defined in `outliner_intern.h`. */ typedef struct SpaceOutliner_Runtime SpaceOutliner_Runtime; -/* Outliner */ +/** Outliner */ typedef struct SpaceOutliner { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -303,7 +303,7 @@ typedef struct SpaceOutliner { SpaceOutliner_Runtime *runtime; } SpaceOutliner; -/* SpaceOutliner.flag */ +/** #SpaceOutliner.flag */ typedef enum eSpaceOutliner_Flag { /* SO_TESTBLOCKS = (1 << 0), */ /* UNUSED */ /* SO_NEWSELECTED = (1 << 1), */ /* UNUSED */ @@ -314,7 +314,7 @@ typedef enum eSpaceOutliner_Flag { SO_MODE_COLUMN = (1 << 6), } eSpaceOutliner_Flag; -/* SpaceOutliner.filter */ +/** #SpaceOutliner.filter */ typedef enum eSpaceOutliner_Filter { SO_FILTER_SEARCH = (1 << 0), /* Run-time flag. */ SO_FILTER_CLEARED_1 = (1 << 1), @@ -356,7 +356,7 @@ typedef enum eSpaceOutliner_Filter { (SO_FILTER_NO_OB_CONTENT | SO_FILTER_NO_CHILDREN | SO_FILTER_OB_TYPE | SO_FILTER_OB_STATE | \ SO_FILTER_NO_COLLECTION | SO_FILTER_NO_VIEW_LAYERS | SO_FILTER_NO_LIB_OVERRIDE) -/* SpaceOutliner.filter_state */ +/** #SpaceOutliner.filter_state */ typedef enum eSpaceOutliner_StateFilter { SO_FILTER_OB_ALL = 0, SO_FILTER_OB_VISIBLE = 1, @@ -366,7 +366,7 @@ typedef enum eSpaceOutliner_StateFilter { SO_FILTER_OB_SELECTABLE = 5, } eSpaceOutliner_StateFilter; -/* SpaceOutliner.show_restrict_flags */ +/** #SpaceOutliner.show_restrict_flags */ typedef enum eSpaceOutliner_ShowRestrictFlag { SO_RESTRICT_ENABLE = (1 << 0), SO_RESTRICT_SELECT = (1 << 1), @@ -377,7 +377,7 @@ typedef enum eSpaceOutliner_ShowRestrictFlag { SO_RESTRICT_INDIRECT_ONLY = (1 << 6), } eSpaceOutliner_Restrict; -/* SpaceOutliner.outlinevis */ +/** #SpaceOutliner.outlinevis */ typedef enum eSpaceOutliner_Mode { SO_SCENES = 0, /* SO_CUR_SCENE = 1, */ /* deprecated! */ @@ -398,7 +398,7 @@ typedef enum eSpaceOutliner_Mode { SO_OVERRIDES_LIBRARY = 16, } eSpaceOutliner_Mode; -/* SpaceOutliner.storeflag */ +/** #SpaceOutliner.storeflag */ typedef enum eSpaceOutliner_StoreFlag { /* cleanup tree */ SO_TREESTORE_CLEANUP = (1 << 0), @@ -408,7 +408,7 @@ typedef enum eSpaceOutliner_StoreFlag { SO_TREESTORE_REBUILD = (1 << 2), } eSpaceOutliner_StoreFlag; -/* outliner search flags (SpaceOutliner.search_flags) */ +/** Outliner search flags (#SpaceOutliner.search_flags) */ typedef enum eSpaceOutliner_Search_Flags { SO_FIND_CASE_SENSITIVE = (1 << 0), SO_FIND_COMPLETE = (1 << 1), @@ -429,7 +429,7 @@ typedef struct SpaceGraph_Runtime { ListBase ghost_curves; } SpaceGraph_Runtime; -/* 'Graph' Editor (formerly known as the IPO Editor) */ +/** 'Graph' Editor (formerly known as the IPO Editor). */ typedef struct SpaceGraph { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -467,7 +467,7 @@ typedef struct SpaceGraph { SpaceGraph_Runtime runtime; } SpaceGraph; -/* SpaceGraph.flag (Graph Editor Settings) */ +/** #SpaceGraph.flag (Graph Editor Settings) */ typedef enum eGraphEdit_Flag { /* OLD DEPRECATED SETTING */ /* SIPO_LOCK_VIEW = (1 << 0), */ @@ -504,7 +504,7 @@ typedef enum eGraphEdit_Flag { SIPO_NO_DRAW_EXTRAPOLATION = (1 << 17), } eGraphEdit_Flag; -/* SpaceGraph.mode (Graph Editor Mode) */ +/** #SpaceGraph.mode (Graph Editor Mode) */ typedef enum eGraphEdit_Mode { /* all animation curves (from all over Blender) */ SIPO_MODE_ANIMATION = 0, @@ -532,7 +532,7 @@ typedef enum eGraphEdit_Runtime_Flag { /** \name NLA Editor * \{ */ -/* NLA Editor */ +/** NLA Editor */ typedef struct SpaceNla { struct SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -552,7 +552,7 @@ typedef struct SpaceNla { View2D v2d DNA_DEPRECATED; } SpaceNla; -/* SpaceNla.flag */ +/** #SpaceNla.flag */ typedef enum eSpaceNla_Flag { SNLA_FLAG_UNUSED_0 = (1 << 0), SNLA_FLAG_UNUSED_1 = (1 << 1), @@ -581,7 +581,7 @@ typedef struct SequencerPreviewOverlay { char _pad0[4]; } SequencerPreviewOverlay; -/* SequencerPreviewOverlay.flag */ +/** #SequencerPreviewOverlay.flag */ typedef enum eSpaceSeq_SequencerPreviewOverlay_Flag { SEQ_PREVIEW_SHOW_2D_CURSOR = (1 << 1), SEQ_PREVIEW_SHOW_OUTLINE_SELECTED = (1 << 2), @@ -596,7 +596,7 @@ typedef struct SequencerTimelineOverlay { char _pad0[4]; } SequencerTimelineOverlay; -/* SequencerTimelineOverlay.flag */ +/** #SequencerTimelineOverlay.flag */ typedef enum eSpaceSeq_SequencerTimelineOverlay_Flag { SEQ_TIMELINE_SHOW_STRIP_OFFSETS = (1 << 1), SEQ_TIMELINE_SHOW_THUMBNAILS = (1 << 2), @@ -617,7 +617,7 @@ typedef struct SpaceSeqRuntime { struct GHash *last_displayed_thumbnails; } SpaceSeqRuntime; -/* Sequencer */ +/** Sequencer. */ typedef struct SpaceSeq { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -667,7 +667,7 @@ typedef struct SpaceSeq { SpaceSeqRuntime runtime; } SpaceSeq; -/* SpaceSeq.mainb */ +/** #SpaceSeq.mainb */ typedef enum eSpaceSeq_RegionType { SEQ_DRAW_IMG_IMBUF = 1, SEQ_DRAW_IMG_WAVEFORM = 2, @@ -675,14 +675,14 @@ typedef enum eSpaceSeq_RegionType { SEQ_DRAW_IMG_HISTOGRAM = 4, } eSpaceSeq_RegionType; -/* SpaceSeq.draw_flag */ +/** #SpaceSeq.draw_flag */ typedef enum eSpaceSeq_DrawFlag { SEQ_DRAW_BACKDROP = (1 << 0), SEQ_DRAW_UNUSED_1 = (1 << 1), SEQ_DRAW_TRANSFORM_PREVIEW = (1 << 2), } eSpaceSeq_DrawFlag; -/* SpaceSeq.flag */ +/** #SpaceSeq.flag */ typedef enum eSpaceSeq_Flag { SEQ_DRAWFRAMES = (1 << 0), SEQ_MARKER_TRANS = (1 << 1), @@ -703,14 +703,14 @@ typedef enum eSpaceSeq_Flag { SEQ_SHOW_GRID = (1 << 18), } eSpaceSeq_Flag; -/* SpaceSeq.view */ +/** #SpaceSeq.view */ typedef enum eSpaceSeq_Displays { SEQ_VIEW_SEQUENCE = 1, SEQ_VIEW_PREVIEW = 2, SEQ_VIEW_SEQUENCE_PREVIEW = 3, } eSpaceSeq_Dispays; -/* SpaceSeq.render_size */ +/** #SpaceSeq.render_size */ typedef enum eSpaceSeq_Proxy_RenderSize { SEQ_RENDER_SIZE_NONE = -1, SEQ_RENDER_SIZE_SCENE = 0, @@ -740,7 +740,7 @@ enum { SEQ_GIZMO_HIDE_TOOL = (1 << 3), }; -/* SpaceSeq.mainb */ +/** #SpaceSeq.mainb */ typedef enum eSpaceSeq_OverlayFrameType { SEQ_OVERLAY_FRAME_TYPE_RECT = 0, SEQ_OVERLAY_FRAME_TYPE_REFERENCE = 1, @@ -753,7 +753,7 @@ typedef enum eSpaceSeq_OverlayFrameType { /** \name File Selector * \{ */ -/* Config and Input for File Selector */ +/** Config and Input for File Selector. */ typedef struct FileSelectParams { /** Title, also used for the text of the execute button. */ char title[96]; @@ -857,7 +857,7 @@ typedef struct FileFolderHistory { ListBase folders_next; } FileFolderHistory; -/* File Browser */ +/** File Browser. */ typedef struct SpaceFile { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -921,7 +921,7 @@ typedef struct SpaceFile { SpaceFile_Runtime *runtime; } SpaceFile; -/* SpaceFile.browse_mode (File Space Browsing Mode) */ +/** #SpaceFile.browse_mode (File Space Browsing Mode). */ typedef enum eFileBrowse_Mode { /* Regular Blender File Browser */ FILE_BROWSE_MODE_FILES = 0, @@ -929,7 +929,7 @@ typedef enum eFileBrowse_Mode { FILE_BROWSE_MODE_ASSETS = 1, } eFileBrowse_Mode; -/* FileSelectParams.display */ +/** #FileSelectParams.display */ enum eFileDisplayType { /** Internal (not exposed to users): Keep whatever display type was used during the last File * Browser use, or the default if no such record is found. Use this unless there's a good reason @@ -943,7 +943,7 @@ enum eFileDisplayType { FILE_IMGDISPLAY = 3, }; -/* FileSelectParams.sort */ +/** #FileSelectParams.sort */ enum eFileSortType { /** Internal (not exposed to users): Sort by whatever was sorted by during the last File Browser * use, or the default if no such record is found. Use this unless there's a good reason to set a @@ -958,14 +958,14 @@ enum eFileSortType { FILE_SORT_SIZE = 4, }; -/* SpaceFile.tags */ +/** #SpaceFile.tags */ enum eFileTags { /** Tag the space as having to update files representing or containing main data. Must be set * after file read and undo/redo. */ FILE_TAG_REBUILD_MAIN_FILES = (1 << 0), }; -/* FileSelectParams.details_flags */ +/** #FileSelectParams.details_flags */ enum eFileDetails { FILE_DETAILS_SIZE = (1 << 0), FILE_DETAILS_DATETIME = (1 << 1), @@ -986,7 +986,7 @@ enum eFileDetails { */ #define FILE_SELECT_MAX_RECURSIONS (FILE_MAX_LIBEXTRA / 2) -/* filesel types */ +/** Filesel types. */ typedef enum eFileSelectType { FILE_LOADLIB = 1, FILE_MAIN = 2, @@ -1000,14 +1000,14 @@ typedef enum eFileSelectType { FILE_SPECIAL = 9, } eFileSelectType; -/* filesel op property -> action */ +/** filesel op property -> action. */ typedef enum eFileSel_Action { FILE_OPENFILE = 0, FILE_SAVE = 1, } eFileSel_Action; -/* sfile->params->flag */ /** + * #FileSelectParams.flag / `sfile->params->flag`. * \note short flag, also used as 16 lower bits of flags in link/append code * (WM and BLO code area, see #eBLOLibLinkFlags in BLO_readfile.h). */ @@ -1037,8 +1037,10 @@ typedef enum eFileSel_Params_AssetCatalogVisibility { FILE_SHOW_ASSETS_WITHOUT_CATALOG, } eFileSel_Params_AssetCatalogVisibility; -/* sfile->params->rename_flag */ -/* NOTE: short flag. Defined as bitflags, but currently only used as exclusive status markers... */ +/** + * #FileSelectParams.rename_flag / `sfile->params->rename_flag`. + * \note short flag. Defined as bit-flags, but currently only used as exclusive status markers. + */ typedef enum eFileSel_Params_RenameFlag { /** Used when we only have the name of the entry we want to rename, * but not yet access to its matching file entry. */ @@ -1084,7 +1086,7 @@ typedef enum eFileSel_File_Types { FILE_TYPE_BLENDERLIB = (1u << 31), } eFileSel_File_Types; -/* Selection Flags in filesel: struct direntry, unsigned char selflag */ +/** Selection Flags in filesel: struct direntry, unsigned char selflag. */ typedef enum eDirEntry_SelectFlag { /* FILE_SEL_ACTIVE = (1 << 1), */ /* UNUSED */ FILE_SEL_HIGHLIGHTED = (1 << 2), @@ -1156,7 +1158,7 @@ typedef struct FileDirEntryArr { char root[1024]; } FileDirEntryArr; -/* FileDirEntry.flags */ +/** #FileDirEntry.flags */ enum { /* The preview for this entry could not be generated. */ FILE_ENTRY_INVALID_PREVIEW = 1 << 0, @@ -1243,7 +1245,7 @@ typedef struct SpaceImage { SpaceImageOverlay overlay; } SpaceImage; -/* SpaceImage.dt_uv */ +/** #SpaceImage.dt_uv */ typedef enum eSpaceImage_UVDT { SI_UVDT_OUTLINE = 0, SI_UVDT_DASH = 1, @@ -1251,20 +1253,20 @@ typedef enum eSpaceImage_UVDT { SI_UVDT_WHITE = 3, } eSpaceImage_UVDT; -/* SpaceImage.dt_uvstretch */ +/** #SpaceImage.dt_uvstretch */ typedef enum eSpaceImage_UVDT_Stretch { SI_UVDT_STRETCH_ANGLE = 0, SI_UVDT_STRETCH_AREA = 1, } eSpaceImage_UVDT_Stretch; -/* SpaceImage.pixel_snap_mode */ +/** #SpaceImage.pixel_snap_mode */ typedef enum eSpaceImage_PixelSnapMode { SI_PIXEL_SNAP_DISABLED = 0, SI_PIXEL_SNAP_CENTER = 1, SI_PIXEL_SNAP_CORNER = 2, } eSpaceImage_Snap_Mode; -/* SpaceImage.mode */ +/** #SpaceImage.mode */ typedef enum eSpaceImage_Mode { SI_MODE_VIEW = 0, SI_MODE_PAINT = 1, @@ -1281,7 +1283,7 @@ typedef enum eSpaceImage_Sticky { SI_STICKY_VERTEX = 2, } eSpaceImage_Sticky; -/* SpaceImage.flag */ +/** #SpaceImage.flag */ typedef enum eSpaceImage_Flag { SI_FLAG_UNUSED_0 = (1 << 0), /* cleared */ SI_FLAG_UNUSED_1 = (1 << 1), /* cleared */ @@ -1375,7 +1377,7 @@ typedef struct SpaceText_Runtime { } SpaceText_Runtime; -/* Text Editor */ +/** Text Editor. */ typedef struct SpaceText { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -1425,7 +1427,7 @@ typedef struct SpaceText { SpaceText_Runtime runtime; } SpaceText; -/* SpaceText flags (moved from DNA_text_types.h) */ +/** SpaceText flags (moved from DNA_text_types.h). */ typedef enum eSpaceText_Flags { /* scrollable */ ST_SCROLL_SELECT = (1 << 0), @@ -1449,7 +1451,7 @@ typedef enum eSpaceText_Flags { /** \name Script View (Obsolete) * \{ */ -/* Script Runtime Data - Obsolete (pre 2.5) */ +/** Script Runtime Data - Obsolete (pre 2.5). */ typedef struct Script { ID id; @@ -1474,7 +1476,7 @@ typedef struct Script { _script->py_globaldict = NULL; \ _script->flags = 0 -/* Script View - Obsolete (pre 2.5) */ +/** Script View - Obsolete (pre 2.5). */ typedef struct SpaceScript { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -1584,7 +1586,7 @@ typedef struct SpaceNode { SpaceNode_Runtime *runtime; } SpaceNode; -/* SpaceNode.flag */ +/** #SpaceNode.flag */ typedef enum eSpaceNode_Flag { SNODE_BACKDRAW = (1 << 1), SNODE_SHOW_GPENCIL = (1 << 2), @@ -1602,7 +1604,7 @@ typedef enum eSpaceNode_Flag { SNODE_SKIP_INSOFFSET = (1 << 13), } eSpaceNode_Flag; -/* SpaceNode.texfrom */ +/** #SpaceNode.texfrom */ typedef enum eSpaceNode_TexFrom { /* SNODE_TEX_OBJECT = 0, */ SNODE_TEX_WORLD = 1, @@ -1610,14 +1612,14 @@ typedef enum eSpaceNode_TexFrom { SNODE_TEX_LINESTYLE = 3, } eSpaceNode_TexFrom; -/* SpaceNode.shaderfrom */ +/** #SpaceNode.shaderfrom */ typedef enum eSpaceNode_ShaderFrom { SNODE_SHADER_OBJECT = 0, SNODE_SHADER_WORLD = 1, SNODE_SHADER_LINESTYLE = 2, } eSpaceNode_ShaderFrom; -/* SpaceNode.insert_ofs_dir */ +/** #SpaceNode.insert_ofs_dir */ enum { SNODE_INSERTOFS_DIR_RIGHT = 0, SNODE_INSERTOFS_DIR_LEFT = 1, @@ -1629,7 +1631,7 @@ enum { /** \name Console * \{ */ -/* Console content */ +/** Console content. */ typedef struct ConsoleLine { struct ConsoleLine *next, *prev; @@ -1645,7 +1647,7 @@ typedef struct ConsoleLine { int type; } ConsoleLine; -/* ConsoleLine.type */ +/** #ConsoleLine.type */ typedef enum eConsoleLine_Type { CONSOLE_LINE_OUTPUT = 0, CONSOLE_LINE_INPUT = 1, @@ -1653,7 +1655,7 @@ typedef enum eConsoleLine_Type { CONSOLE_LINE_ERROR = 3, } eConsoleLine_Type; -/* Console View */ +/** Console View. */ typedef struct SpaceConsole { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -1707,7 +1709,7 @@ typedef struct SpaceUserPref { /** \name Motion Tracking * \{ */ -/* Clip Editor */ +/** Clip Editor. */ typedef struct SpaceClip { SpaceLink *next, *prev; /** Storage of regions for inactive spaces. */ @@ -1770,7 +1772,7 @@ typedef struct SpaceClip { MaskSpaceInfo mask_info; } SpaceClip; -/* SpaceClip.flag */ +/** #SpaceClip.flag */ typedef enum eSpaceClip_Flag { SC_SHOW_MARKER_PATTERN = (1 << 0), SC_SHOW_MARKER_SEARCH = (1 << 1), @@ -1797,7 +1799,7 @@ typedef enum eSpaceClip_Flag { SC_SHOW_METADATA = (1 << 22), } eSpaceClip_Flag; -/* SpaceClip.mode */ +/** #SpaceClip.mode */ typedef enum eSpaceClip_Mode { SC_MODE_TRACKING = 0, // SC_MODE_RECONSTRUCTION = 1, /* DEPRECATED */ @@ -1805,14 +1807,14 @@ typedef enum eSpaceClip_Mode { SC_MODE_MASKEDIT = 3, } eSpaceClip_Mode; -/* SpaceClip.view */ +/** #SpaceClip.view */ typedef enum eSpaceClip_View { SC_VIEW_CLIP = 0, SC_VIEW_GRAPH = 1, SC_VIEW_DOPESHEET = 2, } eSpaceClip_View; -/* SpaceClip.gpencil_src */ +/** #SpaceClip.gpencil_src */ typedef enum eSpaceClip_GPencil_Source { SC_GPENCIL_SRC_CLIP = 0, SC_GPENCIL_SRC_TRACK = 1, @@ -2030,8 +2032,10 @@ typedef enum eSpreadsheetColumnValueType { /** \name Space Defines (eSpace_Type) * \{ */ -/* space types, moved from DNA_screen_types.h */ -/* Do NOT change order, append on end. types are hardcoded needed */ +/** + * Space types: #SpaceLink.spacetype & #ScrArea.spacetype. + * \note Do NOT change order, append on end. types are hardcoded needed. + */ typedef enum eSpace_Type { SPACE_EMPTY = 0, SPACE_VIEW3D = 1, diff --git a/source/blender/makesdna/DNA_texture_types.h b/source/blender/makesdna/DNA_texture_types.h index 2c3cd8eab77..cd19825d29f 100644 --- a/source/blender/makesdna/DNA_texture_types.h +++ b/source/blender/makesdna/DNA_texture_types.h @@ -98,8 +98,10 @@ typedef struct CBData { int cur; } CBData; -/* 32 = MAXCOLORBAND */ -/* note that this has to remain a single struct, for UserDef */ +/** + * 32 = #MAXCOLORBAND + * \note that this has to remain a single struct, for UserDef. + */ typedef struct ColorBand { short tot, cur; char ipotype, ipotype_hue; @@ -454,14 +456,14 @@ typedef struct ColorMapping { /* **************** ColorBand ********************* */ -/* colormode */ +/** color-mode. */ enum { COLBAND_BLEND_RGB = 0, COLBAND_BLEND_HSV = 1, COLBAND_BLEND_HSL = 2, }; -/* interpolation */ +/** Interpolation. */ enum { COLBAND_INTERP_LINEAR = 0, COLBAND_INTERP_EASE = 1, @@ -470,7 +472,7 @@ enum { COLBAND_INTERP_CONSTANT = 4, }; -/* color interpolation */ +/** Color interpolation. */ enum { COLBAND_HUE_NEAR = 0, COLBAND_HUE_FAR = 1, @@ -509,7 +511,7 @@ enum { /* #define TEX_PD_NOISE_AGE 2 */ /* Deprecated */ /* #define TEX_PD_NOISE_TIME 3 */ /* Deprecated */ -/* color_source */ +/** color_source. */ enum { TEX_PD_COLOR_CONSTANT = 0, /* color_source: particles */ diff --git a/source/blender/makesdna/DNA_tracking_types.h b/source/blender/makesdna/DNA_tracking_types.h index 0e313183300..815fab59876 100644 --- a/source/blender/makesdna/DNA_tracking_types.h +++ b/source/blender/makesdna/DNA_tracking_types.h @@ -462,7 +462,7 @@ typedef struct MovieTracking { MovieTrackingDopesheet dopesheet; } MovieTracking; -/* MovieTrackingCamera->distortion_model */ +/** #MovieTrackingCamera.distortion_model */ enum { TRACKING_DISTORTION_MODEL_POLYNOMIAL = 0, TRACKING_DISTORTION_MODEL_DIVISION = 1, @@ -470,13 +470,13 @@ enum { TRACKING_DISTORTION_MODEL_BROWN = 3, }; -/* MovieTrackingCamera->units */ +/** #MovieTrackingCamera.units */ enum { CAMERA_UNITS_PX = 0, CAMERA_UNITS_MM = 1, }; -/* MovieTrackingMarker->flag */ +/** #MovieTrackingMarker.flag */ enum { MARKER_DISABLED = (1 << 0), MARKER_TRACKED = (1 << 1), @@ -485,7 +485,7 @@ enum { MARKER_GRAPH_SEL = (MARKER_GRAPH_SEL_X | MARKER_GRAPH_SEL_Y), }; -/* MovieTrackingTrack->flag */ +/** #MovieTrackingTrack.flag */ enum { TRACK_HAS_BUNDLE = (1 << 1), TRACK_DISABLE_RED = (1 << 2), @@ -501,7 +501,7 @@ enum { TRACK_USE_2D_STAB_ROT = (1 << 12), }; -/* MovieTrackingTrack->motion_model */ +/** #MovieTrackingTrack.motion_model */ enum { TRACK_MOTION_MODEL_TRANSLATION = 0, TRACK_MOTION_MODEL_TRANSLATION_ROTATION = 1, @@ -511,27 +511,27 @@ enum { TRACK_MOTION_MODEL_HOMOGRAPHY = 5, }; -/* MovieTrackingTrack->algorithm_flag */ +/** #MovieTrackingTrack.algorithm_flag */ enum { TRACK_ALGORITHM_FLAG_USE_BRUTE = (1 << 0), TRACK_ALGORITHM_FLAG_USE_NORMALIZATION = (1 << 2), TRACK_ALGORITHM_FLAG_USE_MASK = (1 << 3), }; -/* MovieTrackingTrack->pattern_match */ +/** #MovieTrackingTrack.pattern_match */ typedef enum eTrackFrameMatch { TRACK_MATCH_KEYFRAME = 0, TRACK_MATCH_PREVIOS_FRAME = 1, } eTrackFrameMatch; -/* MovieTrackingSettings->motion_flag */ +/** #MovieTrackingSettings.motion_flag */ enum { TRACKING_MOTION_TRIPOD = (1 << 0), TRACKING_MOTION_MODAL = (TRACKING_MOTION_TRIPOD), }; -/* MovieTrackingSettings->speed */ +/** #MovieTrackingSettings.speed */ enum { TRACKING_SPEED_FASTEST = 0, TRACKING_SPEED_REALTIME = 1, @@ -540,13 +540,13 @@ enum { TRACKING_SPEED_DOUBLE = 5, }; -/* MovieTrackingSettings->reconstruction_flag */ +/** #MovieTrackingSettings.reconstruction_flag */ enum { /* TRACKING_USE_FALLBACK_RECONSTRUCTION = (1 << 0), */ /* DEPRECATED */ TRACKING_USE_KEYFRAME_SELECTION = (1 << 1), }; -/* MovieTrackingSettings->refine_camera_intrinsics */ +/** #MovieTrackingSettings.refine_camera_intrinsics */ enum { REFINE_NO_INTRINSICS = (0), @@ -556,7 +556,7 @@ enum { REFINE_TANGENTIAL_DISTORTION = (1 << 3), }; -/* MovieTrackingStabilization->flag */ +/** #MovieTrackingStabilization.flag */ enum { TRACKING_2D_STABILIZATION = (1 << 0), TRACKING_AUTOSCALE = (1 << 1), @@ -565,19 +565,19 @@ enum { TRACKING_SHOW_STAB_TRACKS = (1 << 5), }; -/* MovieTrackingStabilization->filter */ +/** #MovieTrackingStabilization.filter */ enum { TRACKING_FILTER_NEAREST = 0, TRACKING_FILTER_BILINEAR = 1, TRACKING_FILTER_BICUBIC = 2, }; -/* MovieTrackingReconstruction->flag */ +/** #MovieTrackingReconstruction.flag */ enum { TRACKING_RECONSTRUCTED = (1 << 0), }; -/* MovieTrackingObject->flag */ +/** #MovieTrackingObject.flag */ enum { TRACKING_OBJECT_CAMERA = (1 << 0), }; @@ -588,7 +588,7 @@ enum { TRACKING_CLEAN_DELETE_SEGMENT = 2, }; -/* MovieTrackingDopesheet->sort_method */ +/** #MovieTrackingDopesheet.sort_method */ enum { TRACKING_DOPE_SORT_NAME = 0, TRACKING_DOPE_SORT_LONGEST = 1, @@ -598,27 +598,27 @@ enum { TRACKING_DOPE_SORT_END = 5, }; -/* MovieTrackingDopesheet->flag */ +/** #MovieTrackingDopesheet.flag */ enum { TRACKING_DOPE_SORT_INVERSE = (1 << 0), TRACKING_DOPE_SELECTED_ONLY = (1 << 1), TRACKING_DOPE_SHOW_HIDDEN = (1 << 2), }; -/* MovieTrackingDopesheetCoverageSegment->trackness */ +/** #MovieTrackingDopesheetCoverageSegment.trackness */ enum { TRACKING_COVERAGE_BAD = 0, TRACKING_COVERAGE_ACCEPTABLE = 1, TRACKING_COVERAGE_OK = 2, }; -/* MovieTrackingPlaneMarker->flag */ +/** #MovieTrackingPlaneMarker.flag */ enum { PLANE_MARKER_DISABLED = (1 << 0), PLANE_MARKER_TRACKED = (1 << 1), }; -/* MovieTrackingPlaneTrack->flag */ +/** #MovieTrackingPlaneTrack.flag */ enum { PLANE_TRACK_HIDDEN = (1 << 1), PLANE_TRACK_LOCKED = (1 << 2), diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index c8fdac19b61..c99651f0717 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -30,7 +30,8 @@ extern "C" { #endif -/* themes; defines in BIF_resource.h */ +/* Themes; defines in `BIF_resource.h`. */ + struct ColorBand; /* ************************ style definitions ******************** */ @@ -50,8 +51,10 @@ typedef enum eUIFont_ID { /* UIFONT_CUSTOM2 = 3, */ /* UNUSED */ } eUIFont_ID; -/* default fonts to load/initialize */ -/* first font is the default (index 0), others optional */ +/** + * Default fonts to load/initialize. + * First font is the default (index 0), others optional. + */ typedef struct uiFont { struct uiFont *next, *prev; /** 1024 = FILE_MAX. */ @@ -445,7 +448,7 @@ typedef enum eBackgroundGradientTypes { TH_BACKGROUND_GRADIENT_RADIAL = 2, } eBackgroundGradientTypes; -/* set of colors for use as a custom color set for Objects/Bones wire drawing */ +/** Set of colors for use as a custom color set for Objects/Bones wire drawing. */ typedef struct ThemeWireColor { unsigned char solid[4]; unsigned char select[4]; @@ -959,7 +962,7 @@ typedef struct UserDef { UserDef_Runtime runtime; } UserDef; -/* from blenkernel blender.c */ +/** From blenkernel `blender.c`. */ extern UserDef U; /* ***************** USERDEF ****************** */ diff --git a/source/blender/makesdna/DNA_view2d_types.h b/source/blender/makesdna/DNA_view2d_types.h index f8166305fd9..6c03422963d 100644 --- a/source/blender/makesdna/DNA_view2d_types.h +++ b/source/blender/makesdna/DNA_view2d_types.h @@ -31,7 +31,7 @@ extern "C" { /* ---------------------------------- */ -/* View 2D data - stored per region */ +/** View 2D data - stored per region. */ typedef struct View2D { /** Tot - area that data can be drawn in; cur - region of tot that is visible in viewport. */ rctf tot, cur; @@ -83,7 +83,7 @@ typedef struct View2D { /* ---------------------------------- */ -/* view zooming restrictions, per axis (v2d->keepzoom) */ +/** View zooming restrictions, per axis (#View2D.keepzoom) */ enum { /* zoom is clamped to lie within limits set by minzoom and maxzoom */ V2D_LIMITZOOM = (1 << 0), @@ -97,7 +97,7 @@ enum { V2D_LOCKZOOM_Y = (1 << 9), }; -/* view panning restrictions, per axis (v2d->keepofs) */ +/** View panning restrictions, per axis (#View2D.keepofs). */ enum { /* panning on x-axis is not allowed */ V2D_LOCKOFS_X = (1 << 1), @@ -109,7 +109,7 @@ enum { V2D_KEEPOFS_Y = (1 << 4), }; -/* view extent restrictions (v2d->keeptot) */ +/** View extent restrictions (#View2D.keeptot). */ enum { /** 'cur' view can be out of extents of 'tot' */ V2D_KEEPTOT_FREE = 0, @@ -120,7 +120,7 @@ enum { V2D_KEEPTOT_STRICT = 2, }; -/* general refresh settings (v2d->flag) */ +/** General refresh settings (#View2D.flag). */ enum { /* global view2d horizontal locking (for showing same time interval) */ /* TODO: this flag may be set in old files but is not accessible currently, @@ -138,7 +138,7 @@ enum { V2D_IS_INIT = (1 << 10), }; -/* scroller flags for View2D (v2d->scroll) */ +/** Scroller flags for View2D (#View2D.scroll). */ enum { /* left scrollbar */ V2D_SCROLL_LEFT = (1 << 0), @@ -162,13 +162,15 @@ enum { V2D_SCROLL_HORIZONTAL_FULLR = (1 << 10), }; -/* scroll_ui, activate flag for drawing */ +/** scroll_ui, activate flag for drawing. */ enum { V2D_SCROLL_H_ACTIVE = (1 << 0), V2D_SCROLL_V_ACTIVE = (1 << 1), }; -/* alignment flags for totrect, flags use 'shading-out' convention (v2d->align) */ +/** + * Alignment flags for `totrect`, flags use 'shading-out' convention (#View2D.align). + */ enum { /* all quadrants free */ V2D_ALIGN_FREE = 0, diff --git a/source/blender/makesdna/DNA_view3d_types.h b/source/blender/makesdna/DNA_view3d_types.h index 3fd2f1208dd..5f4353b6f3a 100644 --- a/source/blender/makesdna/DNA_view3d_types.h +++ b/source/blender/makesdna/DNA_view3d_types.h @@ -245,7 +245,7 @@ typedef struct View3DOverlay { char _pad[4]; } View3DOverlay; -/* View3DOverlay->handle_display */ +/** #View3DOverlay.handle_display */ typedef enum eHandleDisplay { /* Display only selected points. */ CURVE_HANDLE_SELECTED = 0, diff --git a/source/blender/makesdna/DNA_volume_types.h b/source/blender/makesdna/DNA_volume_types.h index 1344f295ea9..df5a122faaf 100644 --- a/source/blender/makesdna/DNA_volume_types.h +++ b/source/blender/makesdna/DNA_volume_types.h @@ -30,13 +30,13 @@ struct PackedFile; struct VolumeGridVector; typedef struct Volume_Runtime { - /* OpenVDB Grids */ + /** OpenVDB Grids. */ struct VolumeGridVector *grids; - /* Current frame in sequence for evaluated volume */ + /** Current frame in sequence for evaluated volume. */ int frame; - /* Default simplify level for volume grids loaded from files. */ + /** Default simplify level for volume grids loaded from files. */ int default_simplify_level; } Volume_Runtime; @@ -96,12 +96,12 @@ typedef struct Volume { Volume_Runtime runtime; } Volume; -/* Volume.flag */ +/** #Volume.flag */ enum { VO_DS_EXPAND = (1 << 0), }; -/* Volume.sequence_mode */ +/** #Volume.sequence_mode */ typedef enum VolumeSequenceMode { VOLUME_SEQUENCE_CLIP = 0, VOLUME_SEQUENCE_EXTEND = 1, @@ -109,7 +109,7 @@ typedef enum VolumeSequenceMode { VOLUME_SEQUENCE_PING_PONG = 3, } VolumeSequenceMode; -/* VolumeDisplay.wireframe_type */ +/** #VolumeDisplay.wireframe_type */ typedef enum VolumeWireframeType { VOLUME_WIREFRAME_NONE = 0, VOLUME_WIREFRAME_BOUNDS = 1, @@ -117,32 +117,32 @@ typedef enum VolumeWireframeType { VOLUME_WIREFRAME_POINTS = 3, } VolumeWireframeType; -/* VolumeDisplay.wireframe_detail */ +/** #VolumeDisplay.wireframe_detail */ typedef enum VolumeWireframeDetail { VOLUME_WIREFRAME_COARSE = 0, VOLUME_WIREFRAME_FINE = 1, } VolumeWireframeDetail; -/* VolumeRender.space */ +/** #VolumeRender.space */ typedef enum VolumeRenderSpace { VOLUME_SPACE_OBJECT = 0, VOLUME_SPACE_WORLD = 1, } VolumeRenderSpace; -/* VolumeDisplay.interpolation_method */ +/** #VolumeDisplay.interpolation_method */ typedef enum VolumeDisplayInterpMethod { VOLUME_DISPLAY_INTERP_LINEAR = 0, VOLUME_DISPLAY_INTERP_CUBIC = 1, VOLUME_DISPLAY_INTERP_CLOSEST = 2, } VolumeDisplayInterpMethod; -/* VolumeDisplay.axis_slice_method */ +/** #VolumeDisplay.axis_slice_method */ typedef enum AxisAlignedSlicingMethod { VOLUME_AXIS_SLICE_FULL = 0, VOLUME_AXIS_SLICE_SINGLE = 1, } AxisAlignedSlicingMethod; -/* VolumeDisplay.slice_axis */ +/** #VolumeDisplay.slice_axis */ typedef enum SliceAxis { VOLUME_SLICE_AXIS_AUTO = 0, VOLUME_SLICE_AXIS_X = 1, diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h index 841edaf8724..d0e4184d2a5 100644 --- a/source/blender/makesdna/DNA_windowmanager_types.h +++ b/source/blender/makesdna/DNA_windowmanager_types.h @@ -33,7 +33,8 @@ extern "C" { #endif -/* defined here: */ +/* Defined here: */ + struct wmWindow; struct wmWindowManager; @@ -45,7 +46,8 @@ struct wmMsgBus; struct wmOperator; struct wmOperatorType; -/* forwards */ +/* Forward declarations: */ + struct PointerRNA; struct Report; struct ReportList; @@ -58,7 +60,7 @@ struct wmTimer; #define OP_MAX_TYPENAME 64 #define KMAP_MAX_NAME 64 -/* keep in sync with 'rna_enum_wm_report_items' in wm_rna.c */ +/** Keep in sync with 'rna_enum_wm_report_items' in `wm_rna.c`. */ typedef enum eReportType { RPT_DEBUG = (1 << 0), RPT_INFO = (1 << 1), @@ -100,7 +102,9 @@ typedef struct Report { const char *message; } Report; -/* saved in the wm, don't remove */ +/** + * \note Saved in the wm, don't remove. + */ typedef struct ReportList { ListBase list; /** eReportType. */ @@ -133,7 +137,7 @@ typedef struct wmXrData { /* reports need to be before wmWindowManager */ -/* windowmanager is saved, tag WMAN */ +/** Window-manager is saved, tag WMAN. */ typedef struct wmWindowManager { ID id; @@ -204,13 +208,13 @@ typedef struct wmWindowManager { //#endif } wmWindowManager; -/* wmWindowManager.initialized */ +/** #wmWindowManager.initialized */ enum { WM_WINDOW_IS_INIT = (1 << 0), WM_KEYCONFIG_IS_INIT = (1 << 1), }; -/* wmWindowManager.outliner_sync_select_dirty */ +/** #wmWindowManager.outliner_sync_select_dirty */ enum { WM_OUTLINER_SYNC_SELECT_FROM_OBJECT = (1 << 0), WM_OUTLINER_SYNC_SELECT_FROM_EDIT_BONE = (1 << 1), @@ -231,7 +235,9 @@ enum { # endif #endif -/* the saveable part, rest of data is local in ghostwinlay */ +/** + * The saveable part, the rest of the data is local in GHOST. + */ typedef struct wmWindow { struct wmWindow *next, *prev; @@ -352,7 +358,9 @@ typedef struct wmOperatorTypeMacro { struct PointerRNA *ptr; } wmOperatorTypeMacro; -/* Partial copy of the event, for matching by event handler. */ +/** + * Partial copy of the event, for matching by event handler. + */ typedef struct wmKeyMapItem { struct wmKeyMapItem *next, *prev; @@ -436,7 +444,9 @@ enum { KMI_TYPE_NDOF = 5, }; -/* stored in WM, the actively used keymaps */ +/** + * Stored in WM, the actively used key-maps. + */ typedef struct wmKeyMap { struct wmKeyMap *next, *prev; diff --git a/source/blender/makesdna/DNA_workspace_types.h b/source/blender/makesdna/DNA_workspace_types.h index a0856588a58..95530c7b0f7 100644 --- a/source/blender/makesdna/DNA_workspace_types.h +++ b/source/blender/makesdna/DNA_workspace_types.h @@ -60,7 +60,9 @@ typedef struct bToolRef_Runtime { int flag; } bToolRef_Runtime; -/* Stored per mode. */ +/** + * \note Stored per mode. + */ typedef struct bToolRef { struct bToolRef *next, *prev; char idname[64]; diff --git a/source/blender/makesdna/intern/dna_utils.h b/source/blender/makesdna/intern/dna_utils.h index b89c45a7a43..7ba71fb970b 100644 --- a/source/blender/makesdna/intern/dna_utils.h +++ b/source/blender/makesdna/intern/dna_utils.h @@ -60,7 +60,9 @@ char *DNA_elem_id_rename(struct MemArena *mem_arena, const int elem_src_full_len, const uint elem_src_full_offset_len); -/* When requesting version info, support both directions. */ +/** + * When requesting version info, support both directions. + */ enum eDNA_RenameDir { DNA_RENAME_STATIC_FROM_ALIAS = -1, DNA_RENAME_ALIAS_FROM_STATIC = 1, |