From 2abfcebb0eb7989e3d1e7d03f37ecf5c088210af Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 10 Oct 2020 18:19:55 +1100 Subject: Cleanup: use C comments for descriptive text Follow our code style guide by using C-comments for text descriptions. --- source/blender/makesdna/DNA_action_types.h | 4 ++-- source/blender/makesdna/DNA_anim_types.h | 10 +++++----- source/blender/makesdna/DNA_node_types.h | 2 +- source/blender/makesdna/DNA_object_types.h | 14 +++++++------- source/blender/makesdna/DNA_particle_types.h | 2 +- source/blender/makesdna/DNA_scene_types.h | 12 ++++++------ source/blender/makesdna/DNA_sequence_types.h | 24 ++++++++++++------------ source/blender/makesdna/DNA_texture_types.h | 5 ++--- source/blender/makesdna/DNA_userdef_types.h | 8 ++++---- source/blender/makesdna/intern/dna_genfile.c | 4 ++-- 10 files changed, 42 insertions(+), 43 deletions(-) (limited to 'source/blender/makesdna') diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h index 6e590001aff..9da5c302290 100644 --- a/source/blender/makesdna/DNA_action_types.h +++ b/source/blender/makesdna/DNA_action_types.h @@ -697,7 +697,7 @@ typedef enum eAction_Flags { typedef struct bDopeSheet { /** Currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil). */ ID *source; - /** Cache for channels (only initialized when pinned). */ // XXX not used! + /** Cache for channels (only initialized when pinned). */ /* XXX not used! */ ListBase chanbase; /** Object group for option to only include objects that belong to this Collection. */ @@ -847,7 +847,7 @@ typedef enum eSAction_Flag { /* draw time in seconds instead of time in frames */ SACTION_DRAWTIME = (1 << 2), /* don't filter action channels according to visibility */ - // SACTION_NOHIDE = (1 << 3), // XXX deprecated... old animation system + // SACTION_NOHIDE = (1 << 3), /* XXX deprecated... old animation systems. */ /* don't kill overlapping keyframes after transform */ SACTION_NOTRANSKEYCULL = (1 << 4), /* don't include keyframes that are out of view */ diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h index a13ed0b2924..f17d8b84790 100644 --- a/source/blender/makesdna/DNA_anim_types.h +++ b/source/blender/makesdna/DNA_anim_types.h @@ -506,7 +506,7 @@ typedef struct ChannelDriver { /** Result of previous evaluation. */ float curval; - // XXX to be implemented... this is like the constraint influence setting + /* XXX to be implemented... this is like the constraint influence setting. */ /** Influence of driver on result. */ float influence; @@ -537,7 +537,7 @@ typedef enum eDriver_Flags { DRIVER_FLAG_INVALID = (1 << 0), DRIVER_FLAG_DEPRECATED = (1 << 1), /** Driver does replace value, but overrides (for layering of animation over driver) */ - // TODO: this needs to be implemented at some stage or left out... + /* TODO: this needs to be implemented at some stage or left out... */ // DRIVER_FLAG_LAYERING = (1 << 2), /** Use when the expression needs to be recompiled. */ DRIVER_FLAG_RECOMPILE = (1 << 3), @@ -707,7 +707,7 @@ typedef struct NlaStrip { /** Action that is referenced by this strip (strip is 'user' of the action). */ bAction *act; - /** F-Curves for controlling this strip's influence and timing */ // TODO: move o.ut? + /** F-Curves for controlling this strip's influence and timing */ /* TODO: move out? */ ListBase fcurves; /** F-Curve modifiers to be applied to the entire strip's referenced F-Curves. */ ListBase modifiers; @@ -782,8 +782,8 @@ typedef enum eNlaStrip_Flag { NLASTRIP_FLAG_ACTIVE = (1 << 0), /* NLA strip is selected for editing */ NLASTRIP_FLAG_SELECT = (1 << 1), - // NLASTRIP_FLAG_SELECT_L = (1 << 2), // left handle selected - // NLASTRIP_FLAG_SELECT_R = (1 << 3), // right handle selected + // NLASTRIP_FLAG_SELECT_L = (1 << 2), /* left handle selected. */ + // NLASTRIP_FLAG_SELECT_R = (1 << 3), /* right handle selected. */ /** NLA strip uses the same action that the action being tweaked uses * (not set for the tweaking one though). */ diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index 1d76ebdff2c..33856dc2622 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -1356,7 +1356,7 @@ enum { /* subsurface */ enum { #ifdef DNA_DEPRECATED_ALLOW - SHD_SUBSURFACE_COMPATIBLE = 0, // Deprecated + SHD_SUBSURFACE_COMPATIBLE = 0, /* Deprecated */ #endif SHD_SUBSURFACE_CUBIC = 1, SHD_SUBSURFACE_GAUSSIAN = 2, diff --git a/source/blender/makesdna/DNA_object_types.h b/source/blender/makesdna/DNA_object_types.h index 586c704e0f1..112c8210460 100644 --- a/source/blender/makesdna/DNA_object_types.h +++ b/source/blender/makesdna/DNA_object_types.h @@ -202,7 +202,7 @@ typedef struct Object { /** Old animation system, deprecated for 2.5. */ struct Ipo *ipo DNA_DEPRECATED; /* struct Path *path; */ - struct bAction *action DNA_DEPRECATED; // XXX deprecated... old animation system + struct bAction *action DNA_DEPRECATED; /* XXX deprecated... old animation system */ struct bAction *poselib; /** Pose data, armature objects only. */ struct bPose *pose; @@ -211,7 +211,7 @@ typedef struct Object { /** Grease Pencil data. */ struct bGPdata *gpd - DNA_DEPRECATED; // XXX deprecated... replaced by gpencil object, keep for readfile + DNA_DEPRECATED; /* XXX deprecated... replaced by gpencil object, keep for readfile */ /** Settings for visualization of object-transform animation. */ bAnimVizSettings avs; @@ -219,8 +219,8 @@ typedef struct Object { bMotionPath *mpath; void *_pad0; - ListBase constraintChannels DNA_DEPRECATED; // XXX deprecated... old animation system - ListBase effect DNA_DEPRECATED; // XXX deprecated... keep for readfile + ListBase constraintChannels DNA_DEPRECATED; /* XXX deprecated... old animation system */ + ListBase effect DNA_DEPRECATED; /* XXX deprecated... keep for readfile */ /** List of bDeformGroup (vertex groups) names and flag only. */ ListBase defbase; /** List of ModifierData structures. */ @@ -352,8 +352,8 @@ typedef struct Object { /** Object constraints. */ ListBase constraints; - ListBase nlastrips DNA_DEPRECATED; // XXX deprecated... old animation system - ListBase hooks DNA_DEPRECATED; // XXX deprecated... old animation system + ListBase nlastrips DNA_DEPRECATED; /* XXX deprecated... old animation system */ + ListBase hooks DNA_DEPRECATED; /* XXX deprecated... old animation system */ /** Particle systems. */ ListBase particlesystem; @@ -366,7 +366,7 @@ typedef struct Object { /** If fluidsim enabled, store additional settings. */ struct FluidsimSettings *fluidsimSettings - DNA_DEPRECATED; // XXX deprecated... replaced by mantaflow, keep for readfile + DNA_DEPRECATED; /* XXX deprecated... replaced by mantaflow, keep for readfile */ ListBase pc_ids; diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h index b50c2268b3c..bd19498eba7 100644 --- a/source/blender/makesdna/DNA_particle_types.h +++ b/source/blender/makesdna/DNA_particle_types.h @@ -272,7 +272,7 @@ typedef struct ParticleSettings { struct Collection *instance_collection; struct ListBase instance_weights; - struct Collection *force_group DNA_DEPRECATED; // deprecated + struct Collection *force_group DNA_DEPRECATED; /* deprecated */ struct Object *instance_object; struct Object *bb_ob; /** Old animation system, deprecated for 2.5. */ diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index df9ad358540..b4356ddebb7 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -182,8 +182,8 @@ typedef struct FFMpegCodecData { /* Audio */ typedef struct AudioData { - int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate - float main; // 2.5: now in FFMpegCodecData: audio_volume + int mixrate; /* 2.5: now in FFMpegCodecData: audio_mixrate */ + float main; /* 2.5: now in FFMpegCodecData: audio_volume */ float speed_of_sound; float doppler_factor; int distance_model; @@ -622,7 +622,7 @@ typedef struct RenderData { /** Frames to jump during render/playback. */ int frame_step; - /** Standalone player stereo settings */ // XXX deprecated since .2.5 + /** Standalone player stereo settings */ /* XXX deprecated since .2.5 */ short stereomode DNA_DEPRECATED; /** For the dimensions presets menu. */ @@ -2181,7 +2181,7 @@ typedef enum eSculptFlags { SCULPT_FLAG_UNUSED_7 = (1 << 7), /* cleared */ SCULPT_ONLY_DEFORM = (1 << 8), - // SCULPT_SHOW_DIFFUSE = (1 << 9), // deprecated + // SCULPT_SHOW_DIFFUSE = (1 << 9), /* deprecated */ /* If set, the mesh will be drawn with smooth-shading in * dynamic-topology mode */ @@ -2218,8 +2218,8 @@ enum { /* ImagePaintSettings.flag */ #define IMAGEPAINT_DRAWING (1 << 0) -// #define IMAGEPAINT_DRAW_TOOL (1 << 1) // deprecated -// #define IMAGEPAINT_DRAW_TOOL_DRAWING (1 << 2) // deprecated +// #define IMAGEPAINT_DRAW_TOOL (1 << 1) /* deprecated */ +// #define IMAGEPAINT_DRAW_TOOL_DRAWING (1 << 2) /* deprecated */ /* projection painting only */ /* ImagePaintSettings.flag */ diff --git a/source/blender/makesdna/DNA_sequence_types.h b/source/blender/makesdna/DNA_sequence_types.h index 850b906af39..1d89657faf6 100644 --- a/source/blender/makesdna/DNA_sequence_types.h +++ b/source/blender/makesdna/DNA_sequence_types.h @@ -76,24 +76,24 @@ typedef struct StripColorBalance { float gain[3]; int flag; char _pad[4]; - // float exposure; - // float saturation; + /* float exposure; */ + /* float saturation; */ } StripColorBalance; typedef struct StripProxy { - char dir[768]; // custom directory for index and proxy files - // (defaults to BL_proxy) + char dir[768]; /* custom directory for index and proxy files */ + /* (defaults to BL_proxy) */ - char file[256]; // custom file - struct anim *anim; // custom proxy anim file + char file[256]; /* custom file */ + struct anim *anim; /* custom proxy anim file */ - short tc; // time code in use + short tc; /* time code in use */ - short quality; // proxy build quality - short build_size_flags; // size flags (see below) of all proxies - // to build - short build_tc_flags; // time code flags (see below) of all tc indices - // to build + short quality; /* proxy build quality */ + short build_size_flags; /* size flags (see below) of all proxies */ + /* to build */ + short build_tc_flags; /* time code flags (see below) of all tc indices */ + /* to build */ short build_flags; char storage; char _pad[5]; diff --git a/source/blender/makesdna/DNA_texture_types.h b/source/blender/makesdna/DNA_texture_types.h index 63e5f134c19..5381c524e4d 100644 --- a/source/blender/makesdna/DNA_texture_types.h +++ b/source/blender/makesdna/DNA_texture_types.h @@ -192,7 +192,7 @@ typedef struct Tex { float cropxmin, cropymin, cropxmax, cropymax; int texfilter; - int afmax; // anisotropic filter maximum value, ewa -> max eccentricity, feline -> max probes + int afmax; /* anisotropic filter maximum value, ewa -> max eccentricity, feline -> max probes */ short xrepeat, yrepeat; short extend; @@ -318,8 +318,7 @@ typedef struct ColorMapping { #define TEX_DERIVATIVEMAP (1 << 14) /* texfilter */ -// TXF_BOX -> blender's old texture filtering method -#define TXF_BOX 0 +#define TXF_BOX 0 /* Blender's old texture filtering method. */ #define TXF_EWA 1 #define TXF_FELINE 2 #define TXF_AREA 3 diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index c41a8bb9bc1..a20d939694d 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -322,10 +322,10 @@ typedef struct ThemeSpace { unsigned char grid_levels; /* syntax for textwindow and nodes */ - unsigned char syntaxl[4], syntaxs[4]; // in nodespace used for backdrop matte - unsigned char syntaxb[4], syntaxn[4]; // in nodespace used for color input - unsigned char syntaxv[4], syntaxc[4]; // in nodespace used for converter group - unsigned char syntaxd[4], syntaxr[4]; // in nodespace used for distort + unsigned char syntaxl[4], syntaxs[4]; /* in nodespace used for backdrop matte */ + unsigned char syntaxb[4], syntaxn[4]; /* in nodespace used for color input */ + unsigned char syntaxv[4], syntaxc[4]; /* in nodespace used for converter group */ + unsigned char syntaxd[4], syntaxr[4]; /* in nodespace used for distort */ unsigned char line_numbers[4]; char _pad6[3]; diff --git a/source/blender/makesdna/intern/dna_genfile.c b/source/blender/makesdna/intern/dna_genfile.c index 1a107547450..ac747ab3037 100644 --- a/source/blender/makesdna/intern/dna_genfile.c +++ b/source/blender/makesdna/intern/dna_genfile.c @@ -32,7 +32,7 @@ #include #include -#include "MEM_guardedalloc.h" // for MEM_freeN MEM_mallocN MEM_callocN +#include "MEM_guardedalloc.h" /* for MEM_freeN MEM_mallocN MEM_callocN */ #include "BLI_endian_switch.h" #include "BLI_memarena.h" @@ -42,7 +42,7 @@ #include "BLI_ghash.h" #include "DNA_genfile.h" -#include "DNA_sdna_types.h" // for SDNA ;-) +#include "DNA_sdna_types.h" /* for SDNA ;-) */ /** * \section dna_genfile Overview -- cgit v1.2.3