diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-06-26 14:35:18 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-06-26 14:50:48 +0300 |
commit | f1e49038543cf75766f4a220f62cdc6cdbc0e27d (patch) | |
tree | 0cec2c64739a6a4ca246fe26bed6fe629ea315cb /source/blender/makesdna | |
parent | fae5a907d4d1380f087f1226ebbd65d9d0718cc6 (diff) |
Cleanup: full sentences in comments, improve comment formatting
Diffstat (limited to 'source/blender/makesdna')
22 files changed, 45 insertions, 45 deletions
diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h index fadf8ba36b0..c02035be4ac 100644 --- a/source/blender/makesdna/DNA_anim_types.h +++ b/source/blender/makesdna/DNA_anim_types.h @@ -324,7 +324,7 @@ typedef struct DriverTarget { * (for vars where DTAR_FLAG_STRUCT_REF is used) - MAX_ID_NAME-2. */ char pchan_name[64]; - /** Transform channel index (for DVAR_TYPE_TRANSFORM_CHAN.)*/ + /** Transform channel index (for #DVAR_TYPE_TRANSFORM_CHAN). */ short transChan; /** Rotation channel calculation type. */ diff --git a/source/blender/makesdna/DNA_armature_types.h b/source/blender/makesdna/DNA_armature_types.h index 0bb9a0837f1..f397b7f27b4 100644 --- a/source/blender/makesdna/DNA_armature_types.h +++ b/source/blender/makesdna/DNA_armature_types.h @@ -221,7 +221,7 @@ typedef enum eBone_Flag { BONE_TIPSEL = (1 << 2), /** Used instead of BONE_SELECTED during transform (clear before use) */ BONE_TRANSFORM = (1 << 3), - /** when bone has a parent, connect head of bone to parent's tail*/ + /** When bone has a parent, connect head of bone to parent's tail. */ BONE_CONNECTED = (1 << 4), /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */ /** hidden Bones when drawing PoseChannels */ diff --git a/source/blender/makesdna/DNA_boid_types.h b/source/blender/makesdna/DNA_boid_types.h index 540446ccd9d..02a4d87498a 100644 --- a/source/blender/makesdna/DNA_boid_types.h +++ b/source/blender/makesdna/DNA_boid_types.h @@ -43,7 +43,7 @@ typedef enum eBoidRuleType { eBoidRuleType_Flock = 5, /** follow a boid or assigned object */ eBoidRuleType_FollowLeader = 6, - /** maintain speed, flight level or wander*/ + /** Maintain speed, flight level or wander. */ eBoidRuleType_AverageSpeed = 7, /** go to closest enemy and attack when in range */ eBoidRuleType_Fight = 8, diff --git a/source/blender/makesdna/DNA_brush_enums.h b/source/blender/makesdna/DNA_brush_enums.h index 093a1a00ece..6563afd2b4a 100644 --- a/source/blender/makesdna/DNA_brush_enums.h +++ b/source/blender/makesdna/DNA_brush_enums.h @@ -25,7 +25,7 @@ extern "C" { #endif /* BrushGpencilSettings->preset_type. - * Use a range for each group and not continuous values.*/ + * Use a range for each group and not continuous values. */ typedef enum eGPBrush_Presets { GP_BRUSH_PRESET_UNKNOWN = 0, diff --git a/source/blender/makesdna/DNA_effect_types.h b/source/blender/makesdna/DNA_effect_types.h index 307a212a139..3de13169616 100644 --- a/source/blender/makesdna/DNA_effect_types.h +++ b/source/blender/makesdna/DNA_effect_types.h @@ -27,30 +27,30 @@ extern "C" { #endif -/* don't forget, new effects also in writefile.c for dna!!! */ +/* Don't forget, new effects also in writefile.c for DNA! */ #define PAF_MAXMULT 4 -/* paf->flag (keep bit 0 free for compatibility) */ +/* paf->flag (keep bit 0 free for compatibility). */ #define PAF_BSPLINE 2 #define PAF_STATIC 4 #define PAF_FACE 8 #define PAF_ANIMATED 16 -/* show particles before they're emitted*/ +/* show particles before they're emitted. */ #define PAF_UNBORN 32 -/* emit only from faces*/ +/* Emit only from faces. */ #define PAF_OFACE 64 -/* show emitter (don't hide actual mesh)*/ +/* show emitter (don't hide actual mesh). */ #define PAF_SHOWE 128 -/* true random emit from faces (not just ordered jitter)*/ +/* true random emit from faces (not just ordered jitter). */ #define PAF_TRAND 256 -/* even distribution in face emission based on face areas*/ +/* even distribution in face emission based on face areas. */ #define PAF_EDISTR 512 -/*show particles after they've died*/ +/* Show particles after they've died. */ #define PAF_DIED 2048 -/*paf->flag2 for pos/neg paf->flag2neg*/ -#define PAF_TEXTIME 1 /*texture timing*/ +/* `paf->flag2` for pos/neg `paf->flag2neg`. */ +#define PAF_TEXTIME 1 /* Texture timing. */ /* eff->type */ #define EFF_BUILD 0 diff --git a/source/blender/makesdna/DNA_genfile.h b/source/blender/makesdna/DNA_genfile.h index 74d668a1081..57bfe281c8e 100644 --- a/source/blender/makesdna/DNA_genfile.h +++ b/source/blender/makesdna/DNA_genfile.h @@ -90,7 +90,7 @@ struct SDNA *DNA_sdna_from_data(const void *data, const char **r_error_message); void DNA_sdna_free(struct SDNA *sdna); -/* Access for current Blender versions SDNA*/ +/* Access for current Blender versions SDNA. */ void DNA_sdna_current_init(void); /* borrowed reference */ const struct SDNA *DNA_sdna_current_get(void); diff --git a/source/blender/makesdna/DNA_gpencil_types.h b/source/blender/makesdna/DNA_gpencil_types.h index 6bedcb648c6..d0ae50d09ef 100644 --- a/source/blender/makesdna/DNA_gpencil_types.h +++ b/source/blender/makesdna/DNA_gpencil_types.h @@ -557,7 +557,7 @@ typedef enum eGPDlayer_Flag { /* Unlock color */ GP_LAYER_UNLOCK_COLOR = (1 << 12), /* Mask Layer */ - GP_LAYER_USE_MASK = (1 << 13), /*TODO: DEPRECATED */ + GP_LAYER_USE_MASK = (1 << 13), /* TODO: DEPRECATED */ /* Ruler Layer */ GP_LAYER_IS_RULER = (1 << 14), /* Disable masks in viewlayer render */ diff --git a/source/blender/makesdna/DNA_ipo_types.h b/source/blender/makesdna/DNA_ipo_types.h index cc467f36666..0552c449819 100644 --- a/source/blender/makesdna/DNA_ipo_types.h +++ b/source/blender/makesdna/DNA_ipo_types.h @@ -432,10 +432,10 @@ typedef struct Ipo { #define PART_TOTNAM 25 #define PART_EMIT_FREQ 1 -/* #define PART_EMIT_LIFE 2 */ /*UNUSED*/ +// #define PART_EMIT_LIFE 2 /* UNUSED */ #define PART_EMIT_VEL 3 #define PART_EMIT_AVE 4 -/* #define PART_EMIT_SIZE 5 */ /*UNUSED*/ +// #define PART_EMIT_SIZE 5 /* UNUSED */ #define PART_AVE 6 #define PART_SIZE 7 diff --git a/source/blender/makesdna/DNA_lightprobe_types.h b/source/blender/makesdna/DNA_lightprobe_types.h index 48e3c44e2c9..038de8e49cc 100644 --- a/source/blender/makesdna/DNA_lightprobe_types.h +++ b/source/blender/makesdna/DNA_lightprobe_types.h @@ -106,7 +106,7 @@ enum { LIGHTPROBE_DISP_REFLECTIVE = 3, }; -/* Probe->parallax && Probe->attenuation_type*/ +/* Probe->parallax && Probe->attenuation_type. */ enum { LIGHTPROBE_SHAPE_ELIPSOID = 0, LIGHTPROBE_SHAPE_BOX = 1, diff --git a/source/blender/makesdna/DNA_mesh_types.h b/source/blender/makesdna/DNA_mesh_types.h index 566173aac0f..144e4594c98 100644 --- a/source/blender/makesdna/DNA_mesh_types.h +++ b/source/blender/makesdna/DNA_mesh_types.h @@ -141,7 +141,7 @@ typedef struct Mesh { struct MSelect *mselect; /* BMESH ONLY */ - /*new face structures*/ + /* New face structures. */ struct MPoly *mpoly; struct MLoop *mloop; struct MLoopUV *mloopuv; diff --git a/source/blender/makesdna/DNA_meta_types.h b/source/blender/makesdna/DNA_meta_types.h index a991f654b09..d257363b6ef 100644 --- a/source/blender/makesdna/DNA_meta_types.h +++ b/source/blender/makesdna/DNA_meta_types.h @@ -106,7 +106,7 @@ typedef struct MetaBall { float thresh; /* used in editmode */ - /*ListBase edit_elems;*/ + // ListBase edit_elems; MetaElem *lastelem; void *batch_cache; diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index 158b00b9302..dfe49452636 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -217,7 +217,7 @@ typedef struct LatticeModifierData { char _pad[2]; } LatticeModifierData; -/*Lattice modifier flags */ +/* Lattice modifier flags. */ enum { MOD_LATTICE_INVERT_VGROUP = (1 << 0), }; diff --git a/source/blender/makesdna/DNA_object_fluidsim_types.h b/source/blender/makesdna/DNA_object_fluidsim_types.h index b8848ccc458..1198983c898 100644 --- a/source/blender/makesdna/DNA_object_fluidsim_types.h +++ b/source/blender/makesdna/DNA_object_fluidsim_types.h @@ -44,7 +44,7 @@ typedef struct FluidsimSettings { char _pad1[4]; /* domain, fluid or obstacle */ short type; - /* display advanced options in fluid sim tab (on=1, off=0)*/ + /* Display advanced options in fluid sim tab (on=1, off=0). */ short show_advancedoptions; /* domain object settings */ diff --git a/source/blender/makesdna/DNA_object_force_types.h b/source/blender/makesdna/DNA_object_force_types.h index 3d8418fb734..fcaac4ded76 100644 --- a/source/blender/makesdna/DNA_object_force_types.h +++ b/source/blender/makesdna/DNA_object_force_types.h @@ -279,7 +279,7 @@ typedef struct SoftBody { /* ---------------------------------------------------- */ float secondspring; - /* self collision*/ + /* Self collision. */ /** Fixed collision ball size if > 0. */ float colball; /** Cooling down collision response. */ @@ -319,7 +319,7 @@ typedef struct SoftBody { /* pd->flag: various settings */ #define PFIELD_USEMAX (1 << 0) -/*#define PDEFLE_DEFORM (1 << 1)*/ /*UNUSED*/ +// #define PDEFLE_DEFORM (1 << 1) /* UNUSED */ /** TODO: do_versions for below */ #define PFIELD_GUIDE_PATH_ADD (1 << 2) /** used for do_versions */ diff --git a/source/blender/makesdna/DNA_object_types.h b/source/blender/makesdna/DNA_object_types.h index 527b162a76d..8d861647bd2 100644 --- a/source/blender/makesdna/DNA_object_types.h +++ b/source/blender/makesdna/DNA_object_types.h @@ -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. */ @@ -646,9 +646,9 @@ enum { OB_BOUND_SPHERE = 1, OB_BOUND_CYLINDER = 2, OB_BOUND_CONE = 3, - /* OB_BOUND_TRIANGLE_MESH = 4, */ /* UNUSED */ - /* OB_BOUND_CONVEX_HULL = 5, */ /* UNUSED */ - /* OB_BOUND_DYN_MESH = 6, */ /*UNUSED*/ + // OB_BOUND_TRIANGLE_MESH = 4, /* UNUSED */ + // OB_BOUND_CONVEX_HULL = 5, /* UNUSED */ + // OB_BOUND_DYN_MESH = 6, /* UNUSED */ OB_BOUND_CAPSULE = 7, }; diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h index 30b1fbe09d3..0253de9f9d1 100644 --- a/source/blender/makesdna/DNA_particle_types.h +++ b/source/blender/makesdna/DNA_particle_types.h @@ -157,7 +157,7 @@ typedef struct ParticleData { } ParticleData; typedef struct SPHFluidSettings { - /*Particle Fluid*/ + /* Particle Fluid. */ float radius, spring_k, rest_length; float plasticity_constant, yield_ratio; float plasticity_balance, yield_balance; @@ -479,8 +479,8 @@ enum { #define PART_HAIR_REGROW 16 /* regrow hair for each frame */ -#define PART_UNBORN 32 /*show unborn particles*/ -#define PART_DIED 64 /*show died particles*/ +#define PART_UNBORN 32 /* Show unborn particles. */ +#define PART_DIED 64 /* Show died particles. */ #define PART_TRAND 128 #define PART_EDISTR 256 /* particle/face from face areas */ @@ -508,7 +508,7 @@ enum { #define PART_CHILD_EFFECT (1 << 27) #define PART_CHILD_LONG_HAIR (1 << 28) -/* #define PART_CHILD_RENDER (1 << 29) */ /*UNUSED*/ +// #define PART_CHILD_RENDER (1 << 29) /* UNUSED */ #define PART_CHILD_GUIDE (1 << 30) #define PART_SELF_EFFECT (1 << 22) @@ -565,7 +565,7 @@ typedef enum eParticleShapeFlag { #define PART_TIME_AUTOSF 1 /* Automatic subframes */ /* part->draw_as */ -/* part->ren_as*/ +/* part->ren_as */ #define PART_DRAW_NOT 0 #define PART_DRAW_DOT 1 #define PART_DRAW_HALO 1 diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index fad3b2a8475..4da2bbb58c0 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -2258,7 +2258,7 @@ enum { #define UVCALC_NO_ASPECT_CORRECT (1 << 1) /** Adjust UV's while transforming with Vert or Edge Slide. */ #define UVCALC_TRANSFORM_CORRECT_SLIDE (1 << 2) -/** Use mesh data after subsurf to compute UVs*/ +/** Use mesh data after subsurf to compute UV's. */ #define UVCALC_USESUBSURF (1 << 3) /** adjust UV's while transforming to avoid distortion */ #define UVCALC_TRANSFORM_CORRECT (1 << 4) diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h index 8d3ac3a7814..ce25f8e40b7 100644 --- a/source/blender/makesdna/DNA_screen_types.h +++ b/source/blender/makesdna/DNA_screen_types.h @@ -567,8 +567,8 @@ enum { PNL_SELECT = (1 << 0), PNL_UNUSED_1 = (1 << 1), /* Cleared */ PNL_CLOSED = (1 << 2), - /* PNL_TABBED = (1 << 3), */ /*UNUSED*/ - /* PNL_OVERLAP = (1 << 4), */ /*UNUSED*/ + // PNL_TABBED = (1 << 3), /* UNUSED */ + // PNL_OVERLAP = (1 << 4), /* UNUSED */ PNL_PIN = (1 << 5), PNL_POPOVER = (1 << 6), /** The panel has been drag-drop reordered and the instanced panel list needs to be rebuilt. */ diff --git a/source/blender/makesdna/DNA_sequence_types.h b/source/blender/makesdna/DNA_sequence_types.h index 59b153397c1..1bd4c9233e3 100644 --- a/source/blender/makesdna/DNA_sequence_types.h +++ b/source/blender/makesdna/DNA_sequence_types.h @@ -545,8 +545,8 @@ enum { /* convenience define for all selection flags */ #define SEQ_ALLSEL (SELECT + SEQ_LEFTSEL + SEQ_RIGHTSEL) -/* deprecated, don't use a flag anymore*/ -/*#define SEQ_ACTIVE 1048576*/ +/* Deprecated, don't use a flag anymore. */ +// #define SEQ_ACTIVE 1048576 #define SEQ_COLOR_BALANCE_INVERSE_GAIN 1 #define SEQ_COLOR_BALANCE_INVERSE_GAMMA 2 diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index 2b9a4f7ba1d..9a66d16610d 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -1806,8 +1806,8 @@ typedef enum eSpaceClip_Flag { /* SpaceClip.mode */ typedef enum eSpaceClip_Mode { SC_MODE_TRACKING = 0, - /*SC_MODE_RECONSTRUCTION = 1,*/ /* DEPRECATED */ - /*SC_MODE_DISTORTION = 2,*/ /* DEPRECATED */ + // SC_MODE_RECONSTRUCTION = 1, /* DEPRECATED */ + // SC_MODE_DISTORTION = 2, /* DEPRECATED */ SC_MODE_MASKEDIT = 3, } eSpaceClip_Mode; diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index 98261dea232..7abd960c467 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -496,7 +496,7 @@ typedef struct bTheme { /* 20 sets of bone colors for this theme */ ThemeWireColor tarm[20]; - /*ThemeWireColor tobj[20];*/ + // ThemeWireColor tobj[20]; /* See COLLECTION_COLOR_TOT for the number of collection colors. */ ThemeCollectionColor collection_color[8]; diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c index 91c9f3a9204..24cfc1d84f6 100644 --- a/source/blender/makesdna/intern/makesdna.c +++ b/source/blender/makesdna/intern/makesdna.c @@ -506,7 +506,7 @@ static int add_name(const char *str) buf[i + 2] = ')'; buf[i + 3] = 0; } - /* now proceed with buf*/ + /* Now proceed with buf. */ DEBUG_PRINTF(3, "\t\t\t\t\tProposing fp name %s\n", buf); name = buf; } @@ -1212,8 +1212,8 @@ static int make_structDNA(const char *base_directory, add_type("ushort", 2); /* SDNA_TYPE_USHORT */ add_type("int", 4); /* SDNA_TYPE_INT */ - /* note, long isn't supported, - * these are place-holders to maintain alignment with eSDNA_Type*/ + /* NOTE: long isn't supported, + * these are place-holders to maintain alignment with #eSDNA_Type. */ add_type("long", 4); /* SDNA_TYPE_LONG */ add_type("ulong", 4); /* SDNA_TYPE_ULONG */ |