diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-02-14 12:58:04 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-02-14 12:58:04 +0300 |
commit | 67c8d97db36b285303abc5dce83b1bc8dc209651 (patch) | |
tree | bf1cf63fb1f9ade7205d4e6b73800b79a4f3a3b7 /source/blender/makesdna | |
parent | 07c6a57507e81fe68a7fb3ee23c951fc80f3a042 (diff) |
Cleanup: spelling
Diffstat (limited to 'source/blender/makesdna')
-rw-r--r-- | source/blender/makesdna/DNA_anim_types.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_boid_types.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_cloth_types.h | 19 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_gpencil_modifier_defaults.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_gpencil_types.h | 24 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_lightprobe_types.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_mask_types.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_modifier_types.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_object_force_types.h | 2 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_rigidbody_types.h | 4 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_scene_types.h | 184 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_windowmanager_types.h | 2 |
12 files changed, 128 insertions, 119 deletions
diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h index c66618c0acd..4e37a6652a5 100644 --- a/source/blender/makesdna/DNA_anim_types.h +++ b/source/blender/makesdna/DNA_anim_types.h @@ -82,7 +82,7 @@ typedef enum eFModifier_Types { FMODIFIER_TYPE_ENVELOPE = 3, FMODIFIER_TYPE_CYCLES = 4, FMODIFIER_TYPE_NOISE = 5, - /** Unimplemented - for applying: fft, high/low pass filters, etc. */ + /** Unimplemented - for applying: FFT, high/low pass filters, etc. */ FMODIFIER_TYPE_FILTER = 6, FMODIFIER_TYPE_PYTHON = 7, FMODIFIER_TYPE_LIMITS = 8, diff --git a/source/blender/makesdna/DNA_boid_types.h b/source/blender/makesdna/DNA_boid_types.h index 7e010f27ce6..882d4eb1b3b 100644 --- a/source/blender/makesdna/DNA_boid_types.h +++ b/source/blender/makesdna/DNA_boid_types.h @@ -35,7 +35,7 @@ typedef enum eBoidRuleType { eBoidRuleType_Goal = 1, /** get away from assigned object or loudest assigned signal source */ eBoidRuleType_Avoid = 2, - /** manoeuver to avoid collisions with other boids and deflector object in near future */ + /** Maneuver to avoid collisions with other boids and deflector object in near future. */ eBoidRuleType_AvoidCollision = 3, /** keep from going through other boids */ eBoidRuleType_Separate = 4, diff --git a/source/blender/makesdna/DNA_cloth_types.h b/source/blender/makesdna/DNA_cloth_types.h index 386590ad26c..aae29e5fddc 100644 --- a/source/blender/makesdna/DNA_cloth_types.h +++ b/source/blender/makesdna/DNA_cloth_types.h @@ -104,16 +104,19 @@ typedef struct ClothSimSettings { float shrink_max; /* Air pressure */ - /* The uniform pressure that is constanty applied to the mesh. Can be negative */ + /** The uniform pressure that is constantly applied to the mesh. Can be negative. */ float uniform_pressure_force; - /* User set volume. This is the volume the mesh wants to expand to (the equilibrium volume). */ + /** User set volume. This is the volume the mesh wants to expand to (the equilibrium volume). */ float target_volume; - /* The scaling factor to apply to the actual pressure. - * pressure=( (current_volume/target_volume) - 1 + uniform_pressure_force) * - * pressure_factor */ + /** + * The scaling factor to apply to the actual pressure. + * `pressure = ((current_volume/target_volume) - 1 + uniform_pressure_force) * pressure_factor` + */ float pressure_factor; - /* Density of the fluid inside or outside the object for use in the hydrostatic pressure - * gradient. */ + /** + * Density of the fluid inside or outside the object + * for use in the hydro-static pressure gradient. + */ float fluid_density; short vgroup_pressure; char _pad7[6]; @@ -168,7 +171,7 @@ typedef struct ClothSimSettings { /** The maximum length an internal spring can have during creation. */ float internal_spring_max_length; - /** How much the interal spring can diverge from the vertex normal during creation. */ + /** How much the internal spring can diverge from the vertex normal during creation. */ float internal_spring_max_diversion; /** Vertex group for scaling structural stiffness. */ short vgroup_intern; diff --git a/source/blender/makesdna/DNA_gpencil_modifier_defaults.h b/source/blender/makesdna/DNA_gpencil_modifier_defaults.h index 399bf6f0a6d..11d4ee1b2cd 100644 --- a/source/blender/makesdna/DNA_gpencil_modifier_defaults.h +++ b/source/blender/makesdna/DNA_gpencil_modifier_defaults.h @@ -20,7 +20,7 @@ #pragma once -/* Note that some struct members for colormapping and colorbands are not initialized here. */ +/* Note that some struct members for color-mapping and color-bands are not initialized here. */ /* Struct members on own line. */ /* clang-format off */ diff --git a/source/blender/makesdna/DNA_gpencil_types.h b/source/blender/makesdna/DNA_gpencil_types.h index e02757c1249..835761bf6e9 100644 --- a/source/blender/makesdna/DNA_gpencil_types.h +++ b/source/blender/makesdna/DNA_gpencil_types.h @@ -102,7 +102,7 @@ typedef struct bGPDspoint { bGPDspoint_Runtime runtime; } bGPDspoint; -/* bGPDspoint->flag */ +/** #bGPDspoint.flag */ typedef enum eGPDspoint_Flag { /* stroke point is selected (for editing) */ GP_SPOINT_SELECT = (1 << 0), @@ -144,7 +144,7 @@ typedef struct bGPDpalettecolor { char _pad[6]; } bGPDpalettecolor; -/* bGPDpalettecolor->flag */ +/** #bGPDpalettecolor.flag */ typedef enum eGPDpalettecolor_Flag { /* color is active */ /* PC_COLOR_ACTIVE = (1 << 0), */ /* UNUSED */ @@ -171,7 +171,7 @@ typedef struct bGPDpalette { char _pad[6]; } bGPDpalette; -/* bGPDpalette->flag */ +/** #bGPDpalette.flag */ typedef enum eGPDpalette_Flag { /* palette is active */ PL_PALETTE_ACTIVE = (1 << 0), @@ -319,7 +319,7 @@ typedef struct bGPDstroke { bGPDstroke_Runtime runtime; } bGPDstroke; -/* bGPDstroke->flag */ +/** #bGPDstroke.flag */ typedef enum eGPDstroke_Flag { /* stroke is in 3d-space */ GP_STROKE_3DSPACE = (1 << 0), @@ -347,19 +347,19 @@ typedef enum eGPDstroke_Flag { GP_STROKE_ERASER = (1 << 15), } eGPDstroke_Flag; -/* bGPDstroke->caps */ +/** #bGPDstroke.caps */ typedef enum eGPDstroke_Caps { /* type of extreme */ GP_STROKE_CAP_ROUND = 0, GP_STROKE_CAP_FLAT = 1, - /* Keeo last. */ + /* Keep last. */ GP_STROKE_CAP_MAX, } GPDstroke_Caps; /* Arrows ----------------------- */ -/* bGPDataRuntime.arrowstyle */ +/** #bGPDataRuntime.arrowstyle */ typedef enum eGPDstroke_Arrowstyle { GP_STROKE_ARROWSTYLE_NONE = 0, GP_STROKE_ARROWSTYLE_SEGMENT = 2, @@ -553,13 +553,13 @@ typedef enum eGPDlayer_Flag { GP_LAYER_IS_RULER = (1 << 14), } eGPDlayer_Flag; -/* bGPDlayer->onion_flag */ +/** #bGPDlayer.onion_flag */ typedef enum eGPDlayer_OnionFlag { /* do onion skinning */ GP_LAYER_ONIONSKIN = (1 << 0), } eGPDlayer_OnionFlag; -/* layer blend_mode */ +/** #bGPDlayer.blend_mode */ typedef enum eGPLayerBlendModes { eGplBlendMode_Regular = 0, eGplBlendMode_HardLight = 1, @@ -706,8 +706,10 @@ typedef struct bGPdata { bGPdata_Runtime runtime; } bGPdata; -/* bGPdata->flag */ -/* NOTE: A few flags have been deprecated since early 2.5, +/** + * #bGPdata.flag + * + * NOTE: A few flags have been deprecated since early 2.5, * since they have been made redundant by interaction * changes made during the porting process. */ diff --git a/source/blender/makesdna/DNA_lightprobe_types.h b/source/blender/makesdna/DNA_lightprobe_types.h index 4fdce6d5f45..48e3c44e2c9 100644 --- a/source/blender/makesdna/DNA_lightprobe_types.h +++ b/source/blender/makesdna/DNA_lightprobe_types.h @@ -141,7 +141,7 @@ typedef struct LightGridCache { float visibility_bias, visibility_bleed, visibility_range, _pad5; } LightGridCache; -/* These are used as ubo data. They need to be aligned to size of vec4. */ +/* These are used as UBO data. They need to be aligned to size of vec4. */ BLI_STATIC_ASSERT_ALIGN(LightProbeCache, 16) BLI_STATIC_ASSERT_ALIGN(LightGridCache, 16) diff --git a/source/blender/makesdna/DNA_mask_types.h b/source/blender/makesdna/DNA_mask_types.h index 79ac655300e..8868ac1ea12 100644 --- a/source/blender/makesdna/DNA_mask_types.h +++ b/source/blender/makesdna/DNA_mask_types.h @@ -131,7 +131,7 @@ typedef struct MaskLayerShape { /** U coordinate along spline segment and weight of this point. */ float *data; - /** To ensure no buffer overruns's: alloc size is (tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE). */ + /** To ensure no buffer overrun's: alloc size is `(tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE)`. */ int tot_vert; /** Different flags of this point. */ int frame; diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index 6e1c00bfca8..dbcb6ce45ea 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -1721,7 +1721,7 @@ typedef enum eRemeshModifierMode { typedef struct RemeshModifierData { ModifierData modifier; - /* floodfill option, controls how small components can be before they are removed */ + /** Flood-fill option, controls how small components can be before they are removed. */ float threshold; /* ratio between size of model and grid */ diff --git a/source/blender/makesdna/DNA_object_force_types.h b/source/blender/makesdna/DNA_object_force_types.h index 7812ff6a4f1..37013f5b4d6 100644 --- a/source/blender/makesdna/DNA_object_force_types.h +++ b/source/blender/makesdna/DNA_object_force_types.h @@ -224,7 +224,7 @@ typedef struct SoftBody { * rather find them by name tag to find it -> jow20090613. * MAX_VGROUP_NAME */ char namedVG_Mass[64]; - /** Softbody amount of gravitaion to apply. */ + /** Softbody amount of gravitation to apply. */ float grav; /** Friction to env. */ float mediafrict; diff --git a/source/blender/makesdna/DNA_rigidbody_types.h b/source/blender/makesdna/DNA_rigidbody_types.h index 9a3b9e7d365..740dc35517a 100644 --- a/source/blender/makesdna/DNA_rigidbody_types.h +++ b/source/blender/makesdna/DNA_rigidbody_types.h @@ -312,7 +312,7 @@ typedef enum eRigidBodyCon_Type { RBC_TYPE_HINGE = 1, /** simulates wheel suspension */ /* RBC_TYPE_HINGE2 = 2, */ /* UNUSED */ - /** restricts movent to a specified axis */ + /** Restricts moment to a specified axis. */ RBC_TYPE_SLIDER = 3, /** lets object rotate within a specified cone */ /* RBC_TYPE_CONE_TWIST = 4, */ /* UNUSED */ @@ -329,7 +329,7 @@ typedef enum eRigidBodyCon_Type { /** Simplified spring constraint with only once axis that's * automatically placed between the connected bodies */ /* RBC_TYPE_SPRING = 10, */ /* UNUSED */ - /** dirves bodies by applying linear and angular forces */ + /** Drives bodies by applying linear and angular forces. */ RBC_TYPE_MOTOR = 11, } eRigidBodyCon_Type; diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index 33d31df4210..2362686cfce 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -231,7 +231,7 @@ typedef struct SceneRenderLayer { struct FreestyleConfig freestyleConfig DNA_DEPRECATED; } SceneRenderLayer; -/* SceneRenderLayer.layflag */ +/** #SceneRenderLayer.layflag */ #define SCE_LAY_SOLID (1 << 0) #define SCE_LAY_ZTRA (1 << 1) #define SCE_LAY_HALO (1 << 2) @@ -249,7 +249,7 @@ typedef struct SceneRenderLayer { #define SCE_LAY_ZMASK (1 << 18) #define SCE_LAY_NEG_ZMASK (1 << 19) -/* SceneRenderLayer.passflag */ +/** #SceneRenderLayer.passflag */ typedef enum eScenePassType { SCE_PASS_COMBINED = (1 << 0), SCE_PASS_Z = (1 << 1), @@ -334,16 +334,16 @@ typedef struct SceneRenderView { } SceneRenderView; -/* SceneRenderView.viewflag */ +/** #SceneRenderView.viewflag */ #define SCE_VIEW_DISABLE (1 << 0) -/* RenderData.views_format */ +/** #RenderData.views_format */ enum { SCE_VIEWS_FORMAT_STEREO_3D = 0, SCE_VIEWS_FORMAT_MULTIVIEW = 1, }; -/* ImageFormatData.views_format (also used for Sequence.views_format) */ +/** #ImageFormatData.views_format (also used for #Sequence.views_format) */ enum { R_IMF_VIEWS_INDIVIDUAL = 0, R_IMF_VIEWS_STEREO_3D = 1, @@ -361,7 +361,7 @@ typedef struct Stereo3dFormat { char _pad[3]; } Stereo3dFormat; -/* Stereo3dFormat.display_mode */ +/** #Stereo3dFormat.display_mode */ typedef enum eStereoDisplayMode { S3D_DISPLAY_ANAGLYPH = 0, S3D_DISPLAY_INTERLACE = 1, @@ -370,21 +370,21 @@ typedef enum eStereoDisplayMode { S3D_DISPLAY_TOPBOTTOM = 4, } eStereoDisplayMode; -/* Stereo3dFormat.flag */ +/** #Stereo3dFormat.flag */ typedef enum eStereo3dFlag { S3D_INTERLACE_SWAP = (1 << 0), S3D_SIDEBYSIDE_CROSSEYED = (1 << 1), S3D_SQUEEZED_FRAME = (1 << 2), } eStereo3dFlag; -/* Stereo3dFormat.anaglyph_type */ +/** #Stereo3dFormat.anaglyph_type */ typedef enum eStereo3dAnaglyphType { S3D_ANAGLYPH_REDCYAN = 0, S3D_ANAGLYPH_GREENMAGENTA = 1, S3D_ANAGLYPH_YELLOWBLUE = 2, } eStereo3dAnaglyphType; -/* Stereo3dFormat.interlace_type */ +/** #Stereo3dFormat.interlace_type */ typedef enum eStereo3dInterlaceType { S3D_INTERLACE_ROW = 0, S3D_INTERLACE_COLUMN = 1, @@ -449,26 +449,26 @@ typedef struct ImageFormatData { ColorManagedDisplaySettings display_settings; } ImageFormatData; -/* ImageFormatData.imtype */ +/** #ImageFormatData.imtype */ #define R_IMF_IMTYPE_TARGA 0 #define R_IMF_IMTYPE_IRIS 1 -/* #define R_HAMX 2 */ /* hamx is nomore */ -/* #define R_FTYPE 3 */ /* ftype is nomore */ +/* #define R_HAMX 2 */ /* DEPRECATED */ +/* #define R_FTYPE 3 */ /* DEPRECATED */ #define R_IMF_IMTYPE_JPEG90 4 -/* #define R_MOVIE 5 */ /* movie is nomore */ +/* #define R_MOVIE 5 */ /* DEPRECATED */ #define R_IMF_IMTYPE_IRIZ 7 #define R_IMF_IMTYPE_RAWTGA 14 #define R_IMF_IMTYPE_AVIRAW 15 #define R_IMF_IMTYPE_AVIJPEG 16 #define R_IMF_IMTYPE_PNG 17 -/* #define R_IMF_IMTYPE_AVICODEC 18 */ /* avicodec is nomore */ -/* #define R_IMF_IMTYPE_QUICKTIME 19 */ /* quicktime is nomore */ +/* #define R_IMF_IMTYPE_AVICODEC 18 */ /* DEPRECATED */ +/* #define R_IMF_IMTYPE_QUICKTIME 19 */ /* DEPRECATED */ #define R_IMF_IMTYPE_BMP 20 #define R_IMF_IMTYPE_RADHDR 21 #define R_IMF_IMTYPE_TIFF 22 #define R_IMF_IMTYPE_OPENEXR 23 #define R_IMF_IMTYPE_FFMPEG 24 -/* #define R_IMF_IMTYPE_FRAMESERVER 25 */ /* frame server is nomore */ +/* #define R_IMF_IMTYPE_FRAMESERVER 25 */ /* DEPRECATED */ #define R_IMF_IMTYPE_CINEON 26 #define R_IMF_IMTYPE_DPX 27 #define R_IMF_IMTYPE_MULTILAYER 28 @@ -481,12 +481,12 @@ typedef struct ImageFormatData { #define R_IMF_IMTYPE_INVALID 255 -/* ImageFormatData.flag */ +/** #ImageFormatData.flag */ #define R_IMF_FLAG_ZBUF (1 << 0) /* was R_OPENEXR_ZBUF */ #define R_IMF_FLAG_PREVIEW_JPG (1 << 1) /* was R_PREVIEW_JPG */ -/* return values from BKE_imtype_valid_depths, note this is depts per channel */ -/* ImageFormatData.depth */ +/* Return values from #BKE_imtype_valid_depths, note this is depths per channel. */ +/** #ImageFormatData.depth */ typedef enum eImageFormatDepth { /* 1bits (unused) */ R_IMF_CHAN_DEPTH_1 = (1 << 0), @@ -504,12 +504,12 @@ typedef enum eImageFormatDepth { R_IMF_CHAN_DEPTH_32 = (1 << 6), } eImageFormatDepth; -/* ImageFormatData.planes */ +/** #ImageFormatData.planes */ #define R_IMF_PLANES_RGB 24 #define R_IMF_PLANES_RGBA 32 #define R_IMF_PLANES_BW 8 -/* ImageFormatData.exr_codec */ +/** #ImageFormatData.exr_codec */ #define R_IMF_EXR_CODEC_NONE 0 #define R_IMF_EXR_CODEC_PXR24 1 #define R_IMF_EXR_CODEC_ZIP 2 @@ -522,19 +522,19 @@ typedef enum eImageFormatDepth { #define R_IMF_EXR_CODEC_DWAB 9 #define R_IMF_EXR_CODEC_MAX 10 -/* ImageFormatData.jp2_flag */ +/** #ImageFormatData.jp2_flag */ #define R_IMF_JP2_FLAG_YCC (1 << 0) /* when disabled use RGB */ /* was R_JPEG2K_YCC */ #define R_IMF_JP2_FLAG_CINE_PRESET (1 << 1) /* was R_JPEG2K_CINE_PRESET */ #define R_IMF_JP2_FLAG_CINE_48 (1 << 2) /* was R_JPEG2K_CINE_48FPS */ -/* ImageFormatData.jp2_codec */ +/** #ImageFormatData.jp2_codec */ #define R_IMF_JP2_CODEC_JP2 0 #define R_IMF_JP2_CODEC_J2K 1 -/* ImageFormatData.cineon_flag */ +/** #ImageFormatData.cineon_flag */ #define R_IMF_CINEON_FLAG_LOG (1 << 0) /* was R_CINEON_LOG */ -/* ImageFormatData.tiff_codec */ +/** #ImageFormatData.tiff_codec */ enum { R_IMF_TIFF_CODEC_DEFLATE = 0, R_IMF_TIFF_CODEC_LZW = 1, @@ -565,7 +565,7 @@ typedef struct BakeData { struct Object *cage_object; } BakeData; -/* BakeData.normal_swizzle (char) */ +/** #BakeData.normal_swizzle (char) */ typedef enum eBakeNormalSwizzle { R_BAKE_POSX = 0, R_BAKE_POSY = 1, @@ -575,19 +575,19 @@ typedef enum eBakeNormalSwizzle { R_BAKE_NEGZ = 5, } eBakeNormalSwizzle; -/* BakeData.target (char) */ +/** #BakeData.target (char) */ typedef enum eBakeTarget { R_BAKE_TARGET_IMAGE_TEXTURES = 0, R_BAKE_TARGET_VERTEX_COLORS = 1, } eBakeTarget; -/* BakeData.save_mode (char) */ +/** #BakeData.save_mode (char) */ typedef enum eBakeSaveMode { R_BAKE_SAVE_INTERNAL = 0, R_BAKE_SAVE_EXTERNAL = 1, } eBakeSaveMode; -/* BakeData.pass_filter */ +/** #BakeData.pass_filter */ typedef enum eBakePassFilter { R_BAKE_PASS_FILTER_NONE = 0, R_BAKE_PASS_FILTER_AO = (1 << 0), @@ -794,7 +794,7 @@ typedef enum eHairType { } eHairType; /* *************************************************************** */ -/* Render Conversion/Simplfication Settings */ +/* Render Conversion/Simplification Settings */ /* control render convert and shading engine */ typedef struct RenderProfile { @@ -812,11 +812,11 @@ typedef struct RenderProfile { } RenderProfile; /* UV Paint */ -/* ToolSettings.uv_sculpt_settings */ +/** #ToolSettings.uv_sculpt_settings */ #define UV_SCULPT_LOCK_BORDERS 1 #define UV_SCULPT_ALL_ISLANDS 2 -/* ToolSettings.uv_relax_method */ +/** #ToolSettings.uv_relax_method */ #define UV_SCULPT_TOOL_RELAX_LAPLACIAN 1 #define UV_SCULPT_TOOL_RELAX_HC 2 @@ -1010,7 +1010,7 @@ typedef struct GpPaint { int mode; } GpPaint; -/* GpPaint.flag */ +/** #GpPaint.flag */ enum { GPPAINT_FLAG_USE_MATERIAL = 0, GPPAINT_FLAG_USE_VERTEXCOLOR = 1, @@ -1049,7 +1049,7 @@ typedef struct VPaint { int radial_symm[3]; } VPaint; -/* VPaint.flag */ +/** #VPaint.flag */ enum { /* weight paint only */ VP_FLAG_VGROUP_RESTRICT = (1 << 7), @@ -1152,7 +1152,7 @@ typedef struct GP_Interpolate_Settings { struct CurveMapping *custom_ipo; } GP_Interpolate_Settings; -/* GP_Interpolate_Settings.flag */ +/** #GP_Interpolate_Settings.flag */ typedef enum eGP_Interpolate_SettingsFlag { /* apply interpolation to all layers */ GP_TOOLFLAG_INTERPOLATE_ALL_LAYERS = (1 << 0), @@ -1160,7 +1160,7 @@ typedef enum eGP_Interpolate_SettingsFlag { GP_TOOLFLAG_INTERPOLATE_ONLY_SELECTED = (1 << 1), } eGP_Interpolate_SettingsFlag; -/* GP_Interpolate_Settings.type */ +/** #GP_Interpolate_Settings.type */ typedef enum eGP_Interpolate_Type { /* Traditional Linear Interpolation */ GP_IPO_LINEAR = 0, @@ -1295,7 +1295,7 @@ typedef struct CurvePaintSettings { float corner_angle; } CurvePaintSettings; -/* CurvePaintSettings.flag */ +/** #CurvePaintSettings.flag */ enum { CURVE_PAINT_FLAG_CORNERS_DETECT = (1 << 0), CURVE_PAINT_FLAG_PRESSURE_RADIUS = (1 << 1), @@ -1303,19 +1303,19 @@ enum { CURVE_PAINT_FLAG_DEPTH_STROKE_OFFSET_ABS = (1 << 3), }; -/* CurvePaintSettings.fit_method */ +/** #CurvePaintSettings.fit_method */ enum { CURVE_PAINT_FIT_METHOD_REFIT = 0, CURVE_PAINT_FIT_METHOD_SPLIT = 1, }; -/* CurvePaintSettings.depth_mode */ +/** #CurvePaintSettings.depth_mode */ enum { CURVE_PAINT_PROJECT_CURSOR = 0, CURVE_PAINT_PROJECT_SURFACE = 1, }; -/* CurvePaintSettings.surface_plane */ +/** #CurvePaintSettings.surface_plane */ enum { CURVE_PAINT_SURFACE_PLANE_NORMAL_VIEW = 0, CURVE_PAINT_SURFACE_PLANE_NORMAL_SURFACE = 1, @@ -1361,7 +1361,7 @@ typedef enum eSeqImageFitMethod { /* *************************************************************** */ /* Tool Settings */ -/* CurvePaintSettings.surface_plane */ +/** #CurvePaintSettings.surface_plane */ enum { AUTO_MERGE = 1 << 0, AUTO_MERGE_AND_SPLIT = 1 << 1, @@ -1938,7 +1938,7 @@ enum { }; /* bake_mode: same as RE_BAKE_xxx defines */ -/* RenderData.bake_flag */ +/** #RenderData.bake_flag */ #define R_BAKE_CLEAR (1 << 0) /* #define R_BAKE_OSA (1 << 1) */ /* deprecated */ #define R_BAKE_TO_ACTIVE (1 << 2) @@ -1951,19 +1951,19 @@ enum { #define R_BAKE_SPLIT_MAT (1 << 9) #define R_BAKE_AUTO_NAME (1 << 10) -/* RenderData.bake_normal_space */ +/** #RenderData.bake_normal_space */ #define R_BAKE_SPACE_CAMERA 0 #define R_BAKE_SPACE_WORLD 1 #define R_BAKE_SPACE_OBJECT 2 #define R_BAKE_SPACE_TANGENT 3 -/* RenderData.line_thickness_mode */ +/** #RenderData.line_thickness_mode */ #define R_LINE_THICKNESS_ABSOLUTE 1 #define R_LINE_THICKNESS_RELATIVE 2 /* sequencer seq_prev_type seq_rend_type */ -/* RenderData.engine (scene.c) */ +/** #RenderData.engine (scene.c) */ extern const char *RE_engine_id_BLENDER_EEVEE; extern const char *RE_engine_id_BLENDER_WORKBENCH; extern const char *RE_engine_id_CYCLES; @@ -2025,25 +2025,25 @@ extern const char *RE_engine_id_CYCLES; /* Base.flag is in DNA_object_types.h */ -/* ToolSettings.transform_flag */ +/** #ToolSettings.transform_flag */ enum { SCE_XFORM_AXIS_ALIGN = (1 << 0), SCE_XFORM_DATA_ORIGIN = (1 << 1), SCE_XFORM_SKIP_CHILDREN = (1 << 2), }; -/* ToolSettings.object_flag */ +/** #ToolSettings.object_flag */ enum { SCE_OBJECT_MODE_LOCK = (1 << 0), }; -/* ToolSettings.workspace_tool_flag */ +/** #ToolSettings.workspace_tool_flag */ enum { SCE_WORKSPACE_TOOL_FALLBACK = 0, SCE_WORKSPACE_TOOL_DEFAULT = 1, }; -/* ToolSettings.snap_flag */ +/** #ToolSettings.snap_flag */ #define SCE_SNAP (1 << 0) #define SCE_SNAP_ROTATE (1 << 1) #define SCE_SNAP_PEEL_OBJECT (1 << 2) @@ -2052,13 +2052,13 @@ enum { #define SCE_SNAP_ABS_GRID (1 << 5) #define SCE_SNAP_BACKFACE_CULLING (1 << 6) -/* ToolSettings.snap_target */ +/** #ToolSettings.snap_target */ #define SCE_SNAP_TARGET_CLOSEST 0 #define SCE_SNAP_TARGET_CENTER 1 #define SCE_SNAP_TARGET_MEDIAN 2 #define SCE_SNAP_TARGET_ACTIVE 3 -/* ToolSettings.snap_mode */ +/** #ToolSettings.snap_mode */ #define SCE_SNAP_MODE_VERTEX (1 << 0) #define SCE_SNAP_MODE_EDGE (1 << 1) #define SCE_SNAP_MODE_FACE (1 << 2) @@ -2067,11 +2067,11 @@ enum { #define SCE_SNAP_MODE_EDGE_MIDPOINT (1 << 5) #define SCE_SNAP_MODE_EDGE_PERPENDICULAR (1 << 6) -/* ToolSettings.snap_node_mode */ +/** #ToolSettings.snap_node_mode */ #define SCE_SNAP_MODE_NODE_X (1 << 5) #define SCE_SNAP_MODE_NODE_Y (1 << 6) -/* ToolSettings.snap_mode and ToolSettings.snap_node_mode */ +/** #ToolSettings.snap_mode and #ToolSettings.snap_node_mode */ #define SCE_SNAP_MODE_GRID (1 << 7) /** #ToolSettings.snap_transform_mode_flag */ @@ -2081,24 +2081,24 @@ enum { SCE_SNAP_TRANSFORM_MODE_SCALE = (1 << 2), }; -/* ToolSettings.selectmode */ +/** #ToolSettings.selectmode */ #define SCE_SELECT_VERTEX (1 << 0) /* for mesh */ #define SCE_SELECT_EDGE (1 << 1) #define SCE_SELECT_FACE (1 << 2) -/* MeshStatVis.type */ +/** #MeshStatVis.type */ #define SCE_STATVIS_OVERHANG 0 #define SCE_STATVIS_THICKNESS 1 #define SCE_STATVIS_INTERSECT 2 #define SCE_STATVIS_DISTORT 3 #define SCE_STATVIS_SHARP 4 -/* ParticleEditSettings.selectmode for particles */ +/** #ParticleEditSettings.selectmode for particles */ #define SCE_SELECT_PATH (1 << 0) #define SCE_SELECT_POINT (1 << 1) #define SCE_SELECT_END (1 << 2) -/* ToolSettings.prop_mode (proportional falloff) */ +/** #ToolSettings.prop_mode (proportional falloff) */ #define PROP_SMOOTH 0 #define PROP_SPHERE 1 #define PROP_ROOT 2 @@ -2116,7 +2116,7 @@ enum { PROP_EDIT_PROJECTED = (1 << 2), }; -/* ToolSettings.weightuser */ +/** #ToolSettings.weightuser */ enum { OB_DRAW_GROUPUSER_NONE = 0, OB_DRAW_GROUPUSER_ACTIVE = 1, @@ -2124,7 +2124,7 @@ enum { }; /* object_vgroup.c */ -/* ToolSettings.vgroupsubset */ +/** #ToolSettings.vgroupsubset */ typedef enum eVGroupSelect { WT_VGROUP_ALL = 0, WT_VGROUP_ACTIVE = 1, @@ -2137,7 +2137,7 @@ typedef enum eVGroupSelect { ((1 << WT_VGROUP_ACTIVE) | (1 << WT_VGROUP_BONE_SELECT) | (1 << WT_VGROUP_BONE_DEFORM) | \ (1 << WT_VGROUP_BONE_DEFORM_OFF) | (1 << WT_VGROUP_ALL)) -/* Scene.flag */ +/** #Scene.flag */ #define SCE_DS_SELECTED (1 << 0) #define SCE_DS_COLLAPSED (1 << 1) #define SCE_NLA_EDIT_ON (1 << 2) @@ -2151,13 +2151,13 @@ typedef enum eVGroupSelect { #define F_SCENE 1 #define F_DUPLI 3 -/* AudioData.flag */ +/** #AudioData.flag */ #define AUDIO_MUTE (1 << 0) #define AUDIO_SYNC (1 << 1) #define AUDIO_SCRUB (1 << 2) #define AUDIO_VOLUME_ANIMATED (1 << 3) -/* FFMpegCodecData.flags */ +/** #FFMpegCodecData.flags */ enum { #ifdef DNA_DEPRECATED_ALLOW FFMPEG_MULTIPLEX_AUDIO = (1 << 0), /* deprecated, you can choose none as audiocodec now */ @@ -2167,7 +2167,7 @@ enum { FFMPEG_USE_MAX_B_FRAMES = (1 << 3), }; -/* Paint.flags */ +/** #Paint.flags */ typedef enum ePaintFlags { PAINT_SHOW_BRUSH = (1 << 0), PAINT_FAST_NAVIGATE = (1 << 1), @@ -2176,8 +2176,10 @@ typedef enum ePaintFlags { PAINT_SCULPT_DELAY_UPDATES = (1 << 4), } ePaintFlags; -/* Paint.symmetry_flags - * (for now just a duplicate of sculpt symmetry flags) */ +/** + * #Paint.symmetry_flags + * (for now just a duplicate of sculpt symmetry flags). + */ typedef enum ePaintSymmetryFlags { PAINT_SYMM_X = (1 << 0), PAINT_SYMM_Y = (1 << 1), @@ -2190,8 +2192,10 @@ typedef enum ePaintSymmetryFlags { #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z) -/* Sculpt.flags */ -/* These can eventually be moved to paint flags? */ +/** + * #Sculpt.flags + * These can eventually be moved to paint flags? + */ typedef enum eSculptFlags { SCULPT_FLAG_UNUSED_0 = (1 << 0), /* cleared */ SCULPT_FLAG_UNUSED_1 = (1 << 1), /* cleared */ @@ -2228,25 +2232,25 @@ typedef enum eSculptFlags { SCULPT_HIDE_FACE_SETS = (1 << 17), } eSculptFlags; -/* ImagePaintSettings.mode */ +/** #ImagePaintSettings.mode */ typedef enum eImagePaintMode { IMAGEPAINT_MODE_MATERIAL = 0, /* detect texture paint slots from the material */ IMAGEPAINT_MODE_IMAGE = 1, /* select texture paint image directly */ } eImagePaintMode; -/* ImagePaintSettings.interp */ +/** #ImagePaintSettings.interp */ enum { IMAGEPAINT_INTERP_LINEAR = 0, IMAGEPAINT_INTERP_CLOSEST = 1, }; -/* ImagePaintSettings.flag */ +/** #ImagePaintSettings.flag */ #define IMAGEPAINT_DRAWING (1 << 0) // #define IMAGEPAINT_DRAW_TOOL (1 << 1) /* deprecated */ // #define IMAGEPAINT_DRAW_TOOL_DRAWING (1 << 2) /* deprecated */ /* projection painting only */ -/* ImagePaintSettings.flag */ +/** #ImagePaintSettings.flag */ #define IMAGEPAINT_PROJECT_XRAY (1 << 4) #define IMAGEPAINT_PROJECT_BACKFACE (1 << 5) #define IMAGEPAINT_PROJECT_FLAT (1 << 6) @@ -2254,13 +2258,13 @@ enum { #define IMAGEPAINT_PROJECT_LAYER_STENCIL (1 << 8) #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV (1 << 9) -/* ImagePaintSettings.missing_data */ +/** #ImagePaintSettings.missing_data */ #define IMAGEPAINT_MISSING_UVS (1 << 0) #define IMAGEPAINT_MISSING_MATERIAL (1 << 1) #define IMAGEPAINT_MISSING_TEX (1 << 2) #define IMAGEPAINT_MISSING_STENCIL (1 << 3) -/* ToolSettings.uvcalc_flag */ +/** #ToolSettings.uvcalc_flag */ #define UVCALC_FILLHOLES (1 << 0) /** would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */ #define UVCALC_NO_ASPECT_CORRECT (1 << 1) @@ -2273,17 +2277,17 @@ enum { /** Keep equal values merged while correcting custom-data. */ #define UVCALC_TRANSFORM_CORRECT_KEEP_CONNECTED (1 << 5) -/* ToolSettings.uv_flag */ +/** #ToolSettings.uv_flag */ #define UV_SYNC_SELECTION 1 #define UV_SHOW_SAME_IMAGE 2 -/* ToolSettings.uv_selectmode */ +/** #ToolSettings.uv_selectmode */ #define UV_SELECT_VERTEX 1 #define UV_SELECT_EDGE 2 #define UV_SELECT_FACE 4 #define UV_SELECT_ISLAND 8 -/* ToolSettings.gpencil_flags */ +/** #ToolSettings.gpencil_flags */ typedef enum eGPencil_Flags { /* When creating new frames, the last frame gets used as the basis for the new one */ GP_TOOL_FLAG_RETAIN_LAST = (1 << 1), @@ -2297,7 +2301,7 @@ typedef enum eGPencil_Flags { GP_TOOL_FLAG_AUTOMERGE_STROKE = (1 << 5), } eGPencil_Flags; -/* scene->r.simplify_gpencil */ +/** #Scene.r.simplify_gpencil */ typedef enum eGPencil_SimplifyFlags { /* Simplify */ SIMPLIFY_GPENCIL_ENABLE = (1 << 0), @@ -2315,7 +2319,7 @@ typedef enum eGPencil_SimplifyFlags { SIMPLIFY_GPENCIL_AA = (1 << 8), } eGPencil_SimplifyFlags; -/* ToolSettings.gpencil_*_align - Stroke Placement mode flags */ +/** `ToolSettings.gpencil_*_align` - Stroke Placement mode flags */ typedef enum eGPencil_Placement_Flags { /* New strokes are added in viewport/data space (i.e. not screen space) */ GP_PROJECT_VIEWSPACE = (1 << 0), @@ -2333,14 +2337,14 @@ typedef enum eGPencil_Placement_Flags { GP_PROJECT_DEPTH_STROKE_FIRST = (1 << 6), } eGPencil_Placement_Flags; -/* ToolSettings.gpencil_selectmode */ +/** #ToolSettings.gpencil_selectmode */ typedef enum eGPencil_Selectmode_types { GP_SELECTMODE_POINT = 0, GP_SELECTMODE_STROKE = 1, GP_SELECTMODE_SEGMENT = 2, } eGPencil_Selectmode_types; -/* ToolSettings.gpencil_guide_types */ +/** #ToolSettings.gpencil_guide_types */ typedef enum eGPencil_GuideTypes { GP_GUIDE_CIRCULAR = 0, GP_GUIDE_RADIAL = 1, @@ -2349,14 +2353,14 @@ typedef enum eGPencil_GuideTypes { GP_GUIDE_ISO = 4, } eGPencil_GuideTypes; -/* ToolSettings.gpencil_guide_references */ +/** #ToolSettings.gpencil_guide_references */ typedef enum eGPencil_Guide_Reference { GP_GUIDE_REF_CURSOR = 0, GP_GUIDE_REF_CUSTOM = 1, GP_GUIDE_REF_OBJECT = 2, } eGPencil_Guide_Reference; -/* ToolSettings.particle flag */ +/** #ToolSettings.particle flag */ #define PE_KEEP_LENGTHS (1 << 0) #define PE_LOCK_FIRST (1 << 1) #define PE_DEFLECT_EMITTER (1 << 2) @@ -2366,7 +2370,7 @@ typedef enum eGPencil_Guide_Reference { #define PE_FADE_TIME (1 << 7) #define PE_AUTO_VELOCITY (1 << 8) -/* ParticleEditSettings.brushtype */ +/** #ParticleEditSettings.brushtype */ #define PE_BRUSH_NONE -1 #define PE_BRUSH_COMB 0 #define PE_BRUSH_CUT 1 @@ -2376,15 +2380,15 @@ typedef enum eGPencil_Guide_Reference { #define PE_BRUSH_SMOOTH 5 #define PE_BRUSH_WEIGHT 6 -/* ParticleBrushData.flag */ +/** #ParticleBrushData.flag */ #define PE_BRUSH_DATA_PUFF_VOLUME 1 -/* ParticleBrushData.edittype */ +/** #ParticleBrushData.edittype */ #define PE_TYPE_PARTICLES 0 #define PE_TYPE_SOFTBODY 1 #define PE_TYPE_CLOTH 2 -/* PhysicsSettings.flag */ +/** #PhysicsSettings.flag */ #define PHYS_GLOBAL_GRAVITY 1 /* UnitSettings */ @@ -2398,7 +2402,7 @@ typedef enum eGPencil_Guide_Reference { #define USER_UNIT_OPT_SPLIT 1 #define USER_UNIT_ROT_RADIANS 2 -/* SceneEEVEE->flag */ +/** #SceneEEVEE.flag */ enum { // SCE_EEVEE_VOLUMETRIC_ENABLED = (1 << 0), /* Unused */ SCE_EEVEE_VOLUMETRIC_LIGHTS = (1 << 1), @@ -2426,21 +2430,21 @@ enum { SCE_EEVEE_DOF_JITTER = (1 << 23), }; -/* SceneEEVEE->shadow_method */ +/** #SceneEEVEE.shadow_method */ enum { SHADOW_ESM = 1, /* SHADOW_VSM = 2, */ /* UNUSED */ /* SHADOW_METHOD_MAX = 3, */ /* UNUSED */ }; -/* SceneEEVEE->motion_blur_position */ +/** #SceneEEVEE.motion_blur_position */ enum { SCE_EEVEE_MB_CENTER = 0, SCE_EEVEE_MB_START = 1, SCE_EEVEE_MB_END = 2, }; -/* SceneDisplay->render_aa, SceneDisplay->viewport_aa */ +/** #SceneDisplay->render_aa and #SceneDisplay->viewport_aa */ enum { SCE_DISPLAY_AA_OFF = 0, SCE_DISPLAY_AA_FXAA = 1, diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h index a3aaf3ee937..1635aa7646b 100644 --- a/source/blender/makesdna/DNA_windowmanager_types.h +++ b/source/blender/makesdna/DNA_windowmanager_types.h @@ -472,7 +472,7 @@ typedef struct wmKeyConfig { /** Unique name. */ char idname[64]; - /** Idname of configuration this is derives from, "" if none. */ + /** ID-name of configuration this is derives from, "" if none. */ char basename[64]; ListBase keymaps; |