Cleanup: move DNA comments before struct members
authorCampbell Barton <ideasman42@gmail.com>
Mon, 7 Jan 2019 11:19:13 +0000 (22:19 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Mon, 7 Jan 2019 13:43:00 +0000 (00:43 +1100)
Needed for clang-format in some cases, see: T53211

63 files changed:
source/blender/makesdna/DNA_ID.h
source/blender/makesdna/DNA_action_types.h
source/blender/makesdna/DNA_anim_types.h
source/blender/makesdna/DNA_armature_types.h
source/blender/makesdna/DNA_brush_types.h
source/blender/makesdna/DNA_cachefile_types.h
source/blender/makesdna/DNA_camera_types.h
source/blender/makesdna/DNA_cloth_types.h
source/blender/makesdna/DNA_collection_types.h
source/blender/makesdna/DNA_color_types.h
source/blender/makesdna/DNA_constraint_types.h
source/blender/makesdna/DNA_curve_types.h
source/blender/makesdna/DNA_customdata_types.h
source/blender/makesdna/DNA_dynamicpaint_types.h
source/blender/makesdna/DNA_effect_types.h
source/blender/makesdna/DNA_fileglobal_types.h
source/blender/makesdna/DNA_freestyle_types.h
source/blender/makesdna/DNA_genfile.h
source/blender/makesdna/DNA_gpencil_modifier_types.h
source/blender/makesdna/DNA_gpencil_types.h
source/blender/makesdna/DNA_gpu_types.h
source/blender/makesdna/DNA_image_types.h
source/blender/makesdna/DNA_ipo_types.h
source/blender/makesdna/DNA_key_types.h
source/blender/makesdna/DNA_lamp_types.h
source/blender/makesdna/DNA_lattice_types.h
source/blender/makesdna/DNA_layer_types.h
source/blender/makesdna/DNA_lightprobe_types.h
source/blender/makesdna/DNA_linestyle_types.h
source/blender/makesdna/DNA_mask_types.h
source/blender/makesdna/DNA_material_types.h
source/blender/makesdna/DNA_mesh_types.h
source/blender/makesdna/DNA_meshdata_types.h
source/blender/makesdna/DNA_meta_types.h
source/blender/makesdna/DNA_modifier_types.h
source/blender/makesdna/DNA_movieclip_types.h
source/blender/makesdna/DNA_nla_types.h
source/blender/makesdna/DNA_node_types.h
source/blender/makesdna/DNA_object_fluidsim_types.h
source/blender/makesdna/DNA_object_force_types.h
source/blender/makesdna/DNA_object_types.h
source/blender/makesdna/DNA_outliner_types.h
source/blender/makesdna/DNA_particle_types.h
source/blender/makesdna/DNA_rigidbody_types.h
source/blender/makesdna/DNA_scene_types.h
source/blender/makesdna/DNA_screen_types.h
source/blender/makesdna/DNA_sdna_types.h
source/blender/makesdna/DNA_sequence_types.h
source/blender/makesdna/DNA_shader_fx_types.h
source/blender/makesdna/DNA_smoke_types.h
source/blender/makesdna/DNA_sound_types.h
source/blender/makesdna/DNA_space_types.h
source/blender/makesdna/DNA_speaker_types.h
source/blender/makesdna/DNA_text_types.h
source/blender/makesdna/DNA_texture_types.h
source/blender/makesdna/DNA_tracking_types.h
source/blender/makesdna/DNA_userdef_types.h
source/blender/makesdna/DNA_vfont_types.h
source/blender/makesdna/DNA_view2d_types.h
source/blender/makesdna/DNA_view3d_types.h
source/blender/makesdna/DNA_windowmanager_types.h
source/blender/makesdna/DNA_workspace_types.h
source/blender/makesdna/DNA_world_types.h

index 28ba5c9..d373a15 100644 (file)
@@ -69,19 +69,22 @@ typedef struct DrawDataList {
 typedef struct IDPropertyData {
        void *pointer;
        ListBase group;
-       int val, val2;  /* note, we actually fit a double into these two ints */
+       /** Note, we actually fit a double into these two ints. */
+       int val, val2;
 } IDPropertyData;
 
 typedef struct IDProperty {
        struct IDProperty *next, *prev;
        char type, subtype;
        short flag;
-       char name[64];  /* MAX_IDPROP_NAME */
+       /** MAX_IDPROP_NAME. */
+       char name[64];
 
        /* saved is used to indicate if this struct has been saved yet.
         * seemed like a good idea as a pad var was needed anyway :) */
        int saved;
-       IDPropertyData data;  /* note, alignment for 64 bits */
+       /** Note, alignment for 64 bits. */
+       IDPropertyData data;
 
        /* array length, also (this is important!) string length + 1.
         * the idea is to be able to reuse array realloc functions on strings.*/
@@ -187,20 +190,26 @@ enum {
        IDOVERRIDESTATIC_FLAG_LOCKED        =   1 << 1,  /* User cannot change that override operation. */
 };
 
-/* A single overridden property, contain all operations on this one. */
+/** A single overridden property, contain all operations on this one. */
 typedef struct IDOverrideStaticProperty {
        struct IDOverrideStaticProperty *next, *prev;
 
-       /* Path from ID to overridden property. *Does not* include indices/names for final arrays/collections items. */
+       /**
+        * Path from ID to overridden property.
+        * *Does not* include indices/names for final arrays/collections items.
+        */
        char *rna_path;
 
-       ListBase operations;  /* List of overriding operations (IDOverridePropertyOperation) applied to this property. */
+       /** List of overriding operations (IDOverridePropertyOperation) applied to this property. */
+       ListBase operations;
 } IDOverrideStaticProperty;
 
 /* Main container for all overriding data info of a data-block. */
 typedef struct IDOverrideStatic {
-       struct ID *reference;  /* Reference linked ID which this one overrides. */
-       ListBase properties;  /* List of IDOverrideProperty structs. */
+       /** Reference linked ID which this one overrides. */
+       struct ID *reference;
+       /** List of IDOverrideProperty structs. */
+       ListBase properties;
 
        short flag;
        short pad[3];
@@ -230,9 +239,11 @@ typedef struct ID {
        void *next, *prev;
        struct ID *newid;
        struct Library *lib;
-       char name[66]; /* MAX_ID_NAME */
+       /** MAX_ID_NAME. */
+       char name[66];
        /**
-        * LIB_... flags report on status of the datablock this ID belongs to (persistent, saved to and read from .blend).
+        * LIB_... flags report on status of the datablock this ID belongs to
+        * (persistent, saved to and read from .blend).
         */
        short flag;
        /**
@@ -245,9 +256,11 @@ typedef struct ID {
        int pad;
        IDProperty *properties;
 
-       IDOverrideStatic *override_static;  /* Reference linked ID which this one overrides. */
+       /** Reference linked ID which this one overrides. */
+       IDOverrideStatic *override_static;
 
-       /* Only set for datablocks which are coming from copy-on-write, points to
+       /**
+        * Only set for datablocks which are coming from copy-on-write, points to
         * the original version of it.
         */
        struct ID *orig_id;
@@ -262,21 +275,27 @@ typedef struct ID {
 typedef struct Library {
        ID id;
        struct FileData *filedata;
-       char name[1024];  /* path name used for reading, can be relative and edited in the outliner */
+       /** Path name used for reading, can be relative and edited in the outliner. */
+       char name[1024];
 
-       /* absolute filepath, this is only for convenience, 'name' is the real path used on file read but in
+       /**
+        * Absolute filepath, this is only for convenience,
+        * 'name' is the real path used on file read but in
         * some cases its useful to access the absolute one.
         * This is set on file read.
-        * Use BKE_library_filepath_set() rather than setting 'name' directly and it will be kept in sync - campbell */
+        * Use BKE_library_filepath_set() rather than setting 'name'
+        * directly and it will be kept in sync - campbell */
        char filepath[1024];
 
-       struct Library *parent; /* set for indirectly linked libs, used in the outliner and while reading */
+       /** Set for indirectly linked libs, used in the outliner and while reading. */
+       struct Library *parent;
 
        struct PackedFile *packedfile;
 
        /* Temp data needed by read/write code. */
        int temp_index;
-       short versionfile, subversionfile;  /* see BLENDER_VERSION, BLENDER_SUBVERSION, needed for do_versions */
+       /** See BLENDER_VERSION, BLENDER_SUBVERSION, needed for do_versions. */
+       short versionfile, subversionfile;
 } Library;
 
 enum eIconSizes {
@@ -309,9 +328,11 @@ typedef struct PreviewImage {
 
        /* Runtime-only data. */
        struct GPUTexture *gputexture[2];
-       int icon_id;  /* Used by previews outside of ID context. */
+       /** Used by previews outside of ID context. */
+       int icon_id;
 
-       short tag;  /* Runtime data. */
+       /** Runtime data. */
+       short tag;
        char pad[2];
 } PreviewImage;
 
index 538604f..d257874 100644 (file)
@@ -54,8 +54,10 @@ struct GHash;
 
 /* Data point for motion path (mpv) */
 typedef struct bMotionPathVert {
-       float co[3];                /* coordinates of point in 3D-space */
-       int flag;                   /* quick settings */
+       /** Coordinates of point in 3D-space. */
+       float co[3];
+       /** Quick settings. */
+       int flag;
 } bMotionPathVert;
 
 /* bMotionPathVert->flag */
@@ -71,15 +73,22 @@ typedef enum eMotionPathVert_Flag {
  * - for elements providing transforms (i.e. Objects or PoseChannels)
  */
 typedef struct bMotionPath {
-       bMotionPathVert *points;    /* path samples */
-       int length;                 /* the number of cached verts */
-
-       int start_frame;            /* for drawing paths, the start frame number */
-       int end_frame;              /* for drawing paths, the end frame number */
-
-       float color[3];             /* optional custom color */
-       int line_thickness;         /* line thickness */
-       int flag;                   /* baking settings - eMotionPath_Flag */
+       /** Path samples. */
+       bMotionPathVert *points;
+       /** The number of cached verts. */
+       int length;
+
+       /** For drawing paths, the start frame number. */
+       int start_frame;
+       /** For drawing paths, the end frame number. */
+       int end_frame;
+
+       /** Optional custom color. */
+       float color[3];
+       /** Line thickness. */
+       int line_thickness;
+       /** Baking settings - eMotionPath_Flag. */
+       int flag;
 
        /* Used for drawing. */
        struct GPUVertBuf *points_vbo;
@@ -106,26 +115,38 @@ typedef enum eMotionPath_Flag {
 /* Animation Visualization Settings (avs) */
 typedef struct bAnimVizSettings {
        /* Onion-Skinning Settings ----------------- */
-       int ghost_sf, ghost_ef;         /* start and end frames of ghost-drawing range (only used for GHOST_TYPE_RANGE) */
-       int ghost_bc, ghost_ac;         /* number of frames before/after current frame to show */
+       /** Start and end frames of ghost-drawing range (only used for GHOST_TYPE_RANGE). */
+       int ghost_sf, ghost_ef;
+       /** Number of frames befo.re/after current frame to show */
+       int ghost_bc, ghost_ac;
 
-       short ghost_type;               /* eOnionSkin_Types */
-       short ghost_step;               /* number of frames between each ghost shown (not for GHOST_TYPE_KEYS) */
+       /** EOnionSkin_Types. */
+       short ghost_type;
+       /** Number of frames between each ghost shown (not for GHOST_TYPE_KEYS). */
+       short ghost_step;
 
-       short ghost_flag;               /* eOnionSkin_Flag */
+       /** EOnionSkin_Flag. */
+       short ghost_flag;
 
        /* General Settings ------------------------ */
-       short recalc;                   /* eAnimViz_RecalcFlags */
+       /** EAnimViz_RecalcFlags. */
+       short recalc;
 
        /* Motion Path Settings ------------------- */
-       short path_type;                /* eMotionPath_Types */
-       short path_step;                /* number of frames between points indicated on the paths */
-
-       short path_viewflag;            /* eMotionPaths_ViewFlag */
-       short path_bakeflag;            /* eMotionPaths_BakeFlag */
-
-       int path_sf, path_ef;           /* start and end frames of path-calculation range */
-       int path_bc, path_ac;           /* number of frames before/after current frame to show */
+       /** EMotionPath_Types. */
+       short path_type;
+       /** Number of frames between points indicated on the paths. */
+       short path_step;
+
+       /** EMotionPaths_ViewFlag. */
+       short path_viewflag;
+       /** EMotionPaths_BakeFlag. */
+       short path_bakeflag;
+
+       /** Start and end frames of path-calculation range. */
+       int path_sf, path_ef;
+       /** Number of frames before/after current frame to show. */
+       int path_bc, path_ac;
 } bAnimVizSettings;
 
 
@@ -228,83 +249,129 @@ typedef struct bPoseChannelRuntime {
 typedef struct bPoseChannel {
        struct bPoseChannel *next, *prev;
 
-       IDProperty          *prop;      /* User-Defined Properties on this PoseChannel */
+       /** User-Defined Properties on this PoseChannel. */
+       IDProperty          *prop;
 
-       ListBase constraints;           /* Constraints that act on this PoseChannel */
-       char name[64];                  /* need to match bone name length: MAXBONENAME */
+       /** Constraints that act on this PoseChannel. */
+       ListBase constraints;
+       /** Need to match bone name length: MAXBONENAME. */
+       char name[64];
 
-       short flag;                     /* dynamic, for detecting transform changes */
-       short ikflag;                   /* settings for IK bones */
-       short protectflag;              /* protect channels from being transformed */
-       short agrp_index;               /* index of action-group this bone belongs to (0 = default/no group) */
-       char constflag;                 /* for quick detecting which constraints affect this channel */
-       char selectflag;                /* copy of bone flag, so you can work with library armatures, not for runtime use */
+       /** Dynamic, for detecting transform changes. */
+       short flag;
+       /** Settings for IK bones. */
+       short ikflag;
+       /** Protect channels from being transformed. */
+       short protectflag;
+       /** Index of action-group this bone belongs to (0 = default/no group). */
+       short agrp_index;
+       /** For quick detecting which constraints affect this channel. */
+       char constflag;
+       /** Copy of bone flag, so you can work with library armatures, not for runtime use. */
+       char selectflag;
        char drawflag;
        char bboneflag DNA_DEPRECATED;
        char pad0[4];
 
-       struct Bone         *bone;      /* set on read file or rebuild pose */
-       struct bPoseChannel *parent;    /* set on read file or rebuild pose */
-       struct bPoseChannel *child;     /* set on read file or rebuild pose, the 'ik' child, for b-bones */
-
-       struct ListBase iktree;         /* "IK trees" - only while evaluating pose */
-       struct ListBase siktree;        /* Spline-IK "trees" - only while evaluating pose */
-
-       bMotionPath *mpath;             /* motion path cache for this bone */
-       struct Object *custom;          /* draws custom object instead of default bone shape */
-       struct bPoseChannel *custom_tx; /* odd feature, display with another bones transform.
-                                        * needed in rare cases for advanced rigs,
-                                        * since the alternative is highly complicated - campbell */
+       /** Set on read file or rebuild pose. */
+       struct Bone         *bone;
+       /** Set on read file or rebuild pose. */
+       struct bPoseChannel *parent;
+       /** Set on read file or rebuild pose, the 'ik' child, for b-bones. */
+       struct bPoseChannel *child;
+
+       /** "IK trees" - only while evaluating pose. */
+       struct ListBase iktree;
+       /** Spline-IK "trees" - only while evaluating pose. */
+       struct ListBase siktree;
+
+       /** Motion path cache for this bone. */
+       bMotionPath *mpath;
+       /** Draws custom object instead of default bone shape. */
+       struct Object *custom;
+       /**
+        * Odd feature, display with another bones transform.
+        * needed in rare cases for advanced rigs,
+        * since the alternative is highly complicated - campbell
+        */
+       struct bPoseChannel *custom_tx;
        float custom_scale;
 
        char pad1[4];
 
-       /* transforms - written in by actions or transform */
+       /** Transforms - written in by actions or transform. */
        float loc[3];
        float size[3];
 
-       /* rotations - written in by actions or transform (but only one representation gets used at any time) */
-       float eul[3];                       /* euler rotation */
-       float quat[4];                      /* quaternion rotation */
-       float rotAxis[3], rotAngle;         /* axis-angle rotation */
-       short rotmode;                      /* eRotationModes - rotation representation to use */
+       /**
+        * Rotations - written in by actions or transform
+        * (but only one representation gets used at any time)
+        */
+       /** Euler rotation. */
+       float eul[3];
+       /** Quaternion rotation. */
+       float quat[4];
+       /** Axis-angle rotation. */
+       float rotAxis[3], rotAngle;
+       /** ERotationModes - rotation representation to use. */
+       short rotmode;
        short pad;
 
-       float chan_mat[4][4];           /* matrix result of loc/quat/size, and where we put deform in, see next line */
-       float pose_mat[4][4];           /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat
-                                        * this matrix is object space */
-       float disp_mat[4][4];           /* for display, pose_mat with bone length applied */
-       float disp_tail_mat[4][4];      /* for display, pose_mat with bone length applied and translated to tail*/
-       float constinv[4][4];           /* inverse result of constraints.
-                                        * doesn't include effect of restposition, parent, and local transform*/
+       /** Matrix result of l.oc/quat/size, and where we put deform in, see next line */
+       float chan_mat[4][4];
+       /**
+        * Constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat
+        * this matrix is object space.
+        */
+       float pose_mat[4][4];
+       /** For display, pose_mat with bone length applied. */
+       float disp_mat[4][4];
+       /** For display, pose_mat with bone length applied and translated to tai.l*/
+       float disp_tail_mat[4][4];
+       /**
+        * Inverse result of constraints.
+        * doesn't include effect of restposition, parent, and local transform.
+        */
+       float constinv[4][4];
 
-       float pose_head[3];             /* actually pose_mat[3] */
-       float pose_tail[3];             /* also used for drawing help lines... */
+       /** Actually pose_mat[3]. */
+       float pose_head[3];
+       /** Also used for drawing help lines. */
+       float pose_tail[3];
 
-       float limitmin[3], limitmax[3]; /* DOF constraint, note! - these are stored in degrees, not radians */
-       float stiffness[3];             /* DOF stiffness */
+       /** DOF constraint, note! - these are stored in degrees, not radians. */
+       float limitmin[3], limitmax[3];
+       /** DOF stiffness. */
+       float stiffness[3];
        float ikstretch;
-       float ikrotweight;              /* weight of joint rotation constraint */
-       float iklinweight;              /* weight of joint stretch constraint */
-
-       /* curved bones settings - these are for animating, and are applied on top of the copies in pchan->bone */
+       /** Weight of joint rotation constraint. */
+       float ikrotweight;
+       /** Weight of joint stretch constraint. */
+       float iklinweight;
+
+       /**
+        * Curved bones settings - these are for animating,
+        * and are applied on top of the copies in pchan->bone
+        */
        float roll1, roll2;
        float curveInX, curveInY;
        float curveOutX, curveOutY;
        float ease1, ease2;
        float scaleIn, scaleOut;
 
-       struct bPoseChannel *bbone_prev; /* B-Bone custom handles; set on read file or rebuild pose based on pchan->bone data */
+       /** B-Bone custom handles; set on read file or rebuild pose based on pchan->bone data. */
+       struct bPoseChannel *bbone_prev;
        struct bPoseChannel *bbone_next;
 
-       void        *temp;              /* use for outliner */
-       /* Runtime data for color and bbone segment matrix. */
+       /** Use for outliner. */
+       void *temp;
+       /** Runtime data for color and bbone segment matrix. */
        bPoseChannelDrawData *draw_data;
 
-       /* Points to an original pose channel. */
+       /** Points to an original pose channel. */
        struct bPoseChannel *orig_pchan;
 
-       /* Runtime data. */
+       /** Runtime data. */
        struct bPoseChannelRuntime runtime;
 } bPoseChannel;
 
@@ -422,8 +489,10 @@ typedef enum eRotationModes {
  * though there is a define for it (hack for the outliner).
  */
 typedef struct bPose {
-       ListBase chanbase;          /* list of pose channels, PoseBones in RNA */
-       struct GHash *chanhash;     /* ghash for quicker string lookups */
+       /** List of pose channels, PoseBones in RNA. */
+       ListBase chanbase;
+       /** Ghash for quicker string lookups. */
+       struct GHash *chanhash;
 
        /* Flat array of pose channels. It references pointers from
         * chanbase. Used for quick pose channel lookup from an index.
@@ -431,23 +500,34 @@ typedef struct bPose {
        bPoseChannel **chan_array;
 
        short flag, pad;
-       unsigned int proxy_layer;   /* proxy layer: copy from armature, gets synced */
+       /** Proxy layer: copy from armature, gets synced. */
+       unsigned int proxy_layer;
        int pad1;
 
-       float ctime;                /* local action time of this pose */
-       float stride_offset[3];     /* applied to object */
-       float cyclic_offset[3];     /* result of match and cycles, applied in BKE_pose_where_is() */
+       /** Local action time of this pose. */
+       float ctime;
+       /** Applied to object. */
+       float stride_offset[3];
+       /** Result of match and cycles, applied in BKE_pose_where_is(). */
+       float cyclic_offset[3];
 
 
-       ListBase agroups;           /* list of bActionGroups */
+       /** List of bActionGroups. */
+       ListBase agroups;
 
-       int active_group;           /* index of active group (starts from 1) */
-       int iksolver;               /* ik solver to use, see ePose_IKSolverType */
-       void *ikdata;               /* temporary IK data, depends on the IK solver. Not saved in file */
-       void *ikparam;              /* IK solver parameters, structure depends on iksolver */
-
-       bAnimVizSettings avs;       /* settings for visualization of bone animation */
-       char proxy_act_bone[64];    /* proxy active bone name, MAXBONENAME */
+       /** Index of active group (starts from 1). */
+       int active_group;
+       /** Ik solver to use, see ePose_IKSolverType. */
+       int iksolver;
+       /** Temporary IK data, depends on the IK solver. Not saved in file. */
+       void *ikdata;
+       /** IK solver parameters, structure depends on iksolver. */
+       void *ikparam;
+
+       /** Settings for visualization of bone animation. */
+       bAnimVizSettings avs;
+       /** Proxy active bone name, MAXBONENAME. */
+       char proxy_act_bone[64];
 } bPose;
 
 
@@ -494,9 +574,12 @@ typedef struct bItasc {
        short solver;
        short flag;
        float feedback;
-       float maxvel;   /* max velocity to SDLS solver */
-       float dampmax;  /* maximum damping for DLS solver */
-       float dampeps;  /* threshold of singular value from which the damping start progressively */
+       /** Max velocity to SDLS solver. */
+       float maxvel;
+       /** Maximum damping for DLS solver. */
+       float dampmax;
+       /** Threshold of singular value from which the damping start progressively. */
+       float dampeps;
 } bItasc;
 
 /* bItasc->flag */
@@ -536,13 +619,24 @@ typedef enum eItasc_Solver {
 typedef struct bActionGroup {
        struct bActionGroup *next, *prev;
 
-       ListBase channels;          /* Note: this must not be touched by standard listbase functions which would clear links to other channels */
+       /**
+        * Note: this must not be touched by standard listbase functions
+        * which would clear links to other channels.
+        */
+       ListBase channels;
 
-       int flag;                   /* settings for this action-group */
-       int customCol;              /* index of custom color set to use when used for bones (0=default - used for all old files, -1=custom set) */
-       char name[64];              /* name of the group */
+       /** Settings for this action-group. */
+       int flag;
+       /**
+        * Index of custom color set to use when used for bones
+        * (0=default - used for all old files, -1=custom set).
+        */
+       int customCol;
+       /** Name of the group. */
+       char name[64];
 
-       ThemeWireColor cs;          /* color set to use when customCol == -1 */
+       /** Color set to use when customCol == -1. */
+       ThemeWireColor cs;
 } bActionGroup;
 
 /* Action Group flags */
@@ -583,17 +677,28 @@ typedef enum eActionGroup_Flag {
  * affects a group of related settings (as defined by the user).
  */
 typedef struct bAction {
-       ID id;              /* ID-serialisation for relinking */
-
-       ListBase curves;    /* function-curves (FCurve) */
-       ListBase chanbase DNA_DEPRECATED;  /* legacy data - Action Channels (bActionChannel) in pre-2.5 animation system */
-       ListBase groups;    /* groups of function-curves (bActionGroup) */
-       ListBase markers;   /* markers local to the Action (used to provide Pose-Libraries) */
-
-       int flag;           /* settings for this action */
-       int active_marker;  /* index of the active marker */
-
-       int idroot;         /* type of ID-blocks that action can be assigned to (if 0, will be set to whatever ID first evaluates it) */
+       /** ID-serialisation for relinking. */
+       ID id;
+
+       /** Function-curves (FCurve). */
+       ListBase curves;
+       /** Legacy data - Action Channels (bActionChannel) in pre-2.5 animation system. */
+       ListBase chanbase DNA_DEPRECATED;
+       /** Groups of function-curves (bActionGroup). */
+       ListBase groups;
+       /** Markers local to the Action (used to provide Pose-Libraries). */
+       ListBase markers;
+
+       /** Settings for this action. */
+       int flag;
+       /** Index of the active marker. */
+       int active_marker;
+
+       /**
+        * Type of ID-blocks that action can be assigned to
+        * (if 0, will be set to whatever ID first evaluates it).
+        */
+       int idroot;
        int pad;
 } bAction;
 
@@ -616,16 +721,23 @@ typedef enum eAction_Flags {
 
 /* Storage for Dopesheet/Grease-Pencil Editor data */
 typedef struct bDopeSheet {
-       ID      *source;            /* currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil) */
-       ListBase chanbase; /* cache for channels (only initialized when pinned) */           // XXX not used!
-
-       struct Collection *filter_grp;   /* object group for option to only include objects that belong to this Collection */
-       char searchstr[64];         /* string to search for in displayed names of F-Curves, or NlaTracks/GP Layers/etc. */
-
-       int filterflag;             /* flags to use for filtering data */
-       int flag;                   /* standard flags */
-
-       int renameIndex;            /* index+1 of channel to rename - only gets set by renaming operator */
+       /** Currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil). */
+       ID      *source;
+       /** 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. */
+       struct Collection *filter_grp;
+       /** String to search for in displayed names of F-Curves, or NlaTracks/GP Layers/etc. */
+       char searchstr[64];
+
+       /** Flags to use for filtering data. */
+       int filterflag;
+       /** Standard flags. */
+       int flag;
+
+       /** Index+1 of channel to rename - only gets set by renaming operator. */
+       int renameIndex;
        int pad;
 } bDopeSheet;
 
@@ -700,26 +812,33 @@ typedef struct SpaceAction_Runtime {
 /* Action Editor Space. This is defined here instead of in DNA_space_types.h */
 typedef struct SpaceAction {
        struct SpaceLink *next, *prev;
-       ListBase regionbase;        /* storage of regions for inactive spaces */
+       /** Storage of regions for inactive spaces. */
+       ListBase regionbase;
        char spacetype;
        char link_flag;
        char _pad0[6];
        /* End 'SpaceLink' header. */
 
-       View2D v2d DNA_DEPRECATED;  /* copied to region */
+       /** Copied to region. */
+       View2D v2d DNA_DEPRECATED;
 
-       bAction     *action;        /* the currently active action */
-       bDopeSheet ads;             /* the currently active context (when not showing action) */
+       /** The currently active action. */
+       bAction     *action;
+       /** The currently active context (when not showing action). */
+       bDopeSheet ads;
 
-       float timeslide;            /* for Time-Slide transform mode drawing - current frame? */
+       /** For Time-Slide transform mode drawing - current frame?. */
+       float timeslide;
 
        short flag;
        /* Editing context */
        char mode;
        /* Storage for sub-space types. */
        char mode_prev;
-       char autosnap;              /* automatic keyframe snapping mode   */
-       char cache_display;         /* (eTimeline_Cache_Flag) */
+       /** Automatic keyframe snapping mode  . */
+       char autosnap;
+       /** (eTimeline_Cache_Flag). */
+       char cache_display;
        char _pad1[6];
 
        SpaceAction_Runtime runtime;
@@ -824,14 +943,20 @@ typedef enum eTimeline_Cache_Flag {
  */
 typedef struct bActionChannel {
        struct bActionChannel   *next, *prev;
-       bActionGroup            *grp;           /* Action Group this Action Channel belongs to */
-
-       struct Ipo              *ipo;           /* IPO block this action channel references */
-       ListBase constraintChannels;            /* Constraint Channels (when Action Channel represents an Object or Bone) */
-
-       int flag;               /* settings accessed via bitmapping */
-       char name[64];          /* channel name, MAX_NAME */
-       int temp;               /* temporary setting - may be used to indicate group that channel belongs to during syncing  */
+       /** Action Group this Action Channel belongs to. */
+       bActionGroup            *grp;
+
+       /** IPO block this action channel references. */
+       struct Ipo              *ipo;
+       /** Constraint Channels (when Action Channel represents an Object or Bone). */
+       ListBase constraintChannels;
+
+       /** Settings accessed via bitmapping. */
+       int flag;
+       /** Channel name, MAX_NAME. */
+       char name[64];
+       /** Temporary setting - may be used to indicate group that channel belongs to during syncing. */
+       int temp;
 } bActionChannel;
 
 /* Action Channel flags (ONLY USED FOR DO_VERSIONS...) */
index 2d1cbdc..13358ce 100644 (file)
@@ -44,7 +44,8 @@ extern "C" {
 
 /* Modifiers -------------------------------------- */
 
-/* F-Curve Modifiers (fcm)
+/**
+ * F-Curve Modifiers (fcm)
  *
  * These alter the way F-Curves behave, by altering the value that is returned
  * when evaluating the curve's data at some time (t).
@@ -52,22 +53,33 @@ extern "C" {
 typedef struct FModifier {
        struct FModifier *next, *prev;
 
-       struct FCurve *curve;  /* containing curve, only used for updates to CYCLES */
-       void *data;                     /* pointer to modifier data */
-
-       char name[64];          /* user-defined description for the modifier - MAX_ID_NAME-2 */
-       short type;                     /* type of f-curve modifier */
-       short flag;                     /* settings for the modifier */
-
-       float influence;        /* the amount that the modifier should influence the value */
-
-       float sfra;                     /* start frame of restricted frame-range */
-       float efra;                     /* end frame of restricted frame-range */
-       float blendin;          /* number of frames from sfra before modifier takes full influence */
-       float blendout;         /* number of frames from efra before modifier fades out */
+       /** Containing curve, only used for updates to CYCLES. */
+       struct FCurve *curve;
+       /** Pointer to modifier data. */
+       void *data;
+
+       /** User-defined description for the modifier - MAX_ID_NAME-2. */
+       char name[64];
+       /** Type of f-curve modifier. */
+       short type;
+       /** Settings for the modifier. */
+       short flag;
+
+       /** The amount that the modifier should influence the value. */
+       float influence;
+
+       /** Start frame of restricted frame-range. */
+       float sfra;
+       /** End frame of restricted frame-range. */
+       float efra;
+       /** Number of frames from sfra before modifier takes full influence. */
+       float blendin;
+       /** Number of frames from efra before modifier fades out. */
+       float blendout;
 } FModifier;
 
-/* Types of F-Curve modifier
+/**
+ * Types of F-Curve modifier
  * WARNING: order here is important!
  */
 typedef enum eFModifier_Types {
@@ -107,14 +119,19 @@ typedef enum eFModifier_Flags {
 /* Generator modifier data */
 typedef struct FMod_Generator {
                /* general generator information */
-       float *coefficients;            /* coefficients array */
-       unsigned int arraysize;         /* size of the coefficients array */
+       /** Coefficients array. */
+       float *coefficients;
+       /** Size of the coefficients array. */
+       unsigned int arraysize;
 
-       int poly_order;                         /* order of polynomial generated (i.e. 1 for linear, 2 for quadratic) */
-       int mode;                                       /* which 'generator' to use eFMod_Generator_Modes */
+       /** Order of polynomial generated (i.e. 1 for linear, 2 for quadratic). */
+       int poly_order;
+       /** Which 'generator' to use eFMod_Generator_Modes. */
+       int mode;
 
                /* settings */
-       int flag;                                       /* settings */
+       /** Settings. */
+       int flag;
 } FMod_Generator;
 
 /* generator modes */
@@ -128,12 +145,13 @@ typedef enum eFMod_Generator_Modes {
  * - shared by Generator and Function Generator
  */
 typedef enum eFMod_Generator_Flags {
-               /* generator works in conjunction with other modifiers (i.e. doesn't replace those before it) */
+       /* generator works in conjunction with other modifiers (i.e. doesn't replace those before it) */
        FCM_GENERATOR_ADDITIVE  = (1<<0)
 } eFMod_Generator_Flags;
 
 
-/* 'Built-In Function' Generator modifier data
+/**
+ * 'Built-In Function' Generator modifier data
  *
  * This uses the general equation for equations:
  * y = amplitude * fn(phase_multiplier*x + phase_offset) + y_offset
@@ -142,15 +160,17 @@ typedef enum eFMod_Generator_Flags {
  * x is the evaluation 'time', and 'y' is the resultant value
  */
 typedef struct FMod_FunctionGenerator {
-               /* coefficients for general equation (as above) */
+       /** Coefficients for general equation (as above). */
        float amplitude;
        float phase_multiplier;
        float phase_offset;
        float value_offset;
 
-               /* flags */
-       int type;                               /* eFMod_Generator_Functions */
-       int flag;                               /* eFMod_Generator_flags */
+       /* flags */
+       /** EFMod_Generator_Functions. */
+       int type;
+       /** EFMod_Generator_flags. */
+       int flag;
 } FMod_FunctionGenerator;
 
 /* 'function' generator types */
@@ -166,30 +186,42 @@ typedef enum eFMod_Generator_Functions {
 
 /* envelope modifier - envelope data */
 typedef struct FCM_EnvelopeData {
-       float min, max;                         /* min/max values for envelope at this point (absolute values)  */
-       float time;                                     /* time for that this sample-point occurs */
-
-       short f1;                                       /* settings for 'min' control point */
-       short f2;                                       /* settings for 'max' control point */
+       /** Min/max values for envelope at this point (absolute values) . */
+       float min, max;
+       /** Time for that this sample-point occurs. */
+       float time;
+
+       /** Settings for 'min' control point. */
+       short f1;
+       /** Settings for 'max' control point. */
+       short f2;
 } FCM_EnvelopeData;
 
 /* envelope-like adjustment to values (for fade in/out) */
 typedef struct FMod_Envelope {
-       FCM_EnvelopeData *data;         /* data-points defining envelope to apply (array)  */
-       int totvert;                            /* number of envelope points */
-
-       float midval;                           /* value that envelope's influence is centered around / based on */
-       float min, max;                         /* distances from 'middle-value' for 1:1 envelope influence */
+       /** Data-points defining envelope to apply (array) . */
+       FCM_EnvelopeData *data;
+       /** Number of envelope points. */
+       int totvert;
+
+       /** Value that envelope's influence is centered around / based on. */
+       float midval;
+       /** Distances from 'middle-value' for 1:1 envelope influence. */
+       float min, max;
 } FMod_Envelope;
 
 
 /* cycling/repetition modifier data */
 // TODO: we can only do complete cycles...
 typedef struct FMod_Cycles {
-       short   before_mode;            /* extrapolation mode to use before first keyframe */
-       short   after_mode;                     /* extrapolation mode to use after last keyframe */
-       short   before_cycles;          /* number of 'cycles' before first keyframe to do */
-       short   after_cycles;           /* number of 'cycles' after last keyframe to do */
+       /** Extrapolation mode to use before first keyframe. */
+       short before_mode;
+       /** Extrapolation mode to use after last keyframe. */
+       short after_mode;
+       /** Number of 'cycles' before first keyframe to do. */
+       short before_cycles;
+       /** Number of 'cycles' after last keyframe to do. */
+       short after_cycles;
 } FMod_Cycles;
 
 /* cycling modes */
@@ -203,15 +235,19 @@ typedef enum eFMod_Cycling_Modes {
 
 /* Python-script modifier data */
 typedef struct FMod_Python {
-       struct Text *script;            /* text buffer containing script to execute */
-       IDProperty *prop;                       /* ID-properties to provide 'custom' settings */
+       /** Text buffer containing script to execute. */
+       struct Text *script;
+       /** ID-properties to provide 'custom' settings. */
+       IDProperty *prop;
 } FMod_Python;
 
 
 /* limits modifier data */
 typedef struct FMod_Limits {
-       rctf rect;                                      /* rect defining the min/max values */
-       int flag;                                       /* settings for limiting */
+       /** Rect defining the min/max values. */
+       rctf rect;
+       /** Settings for limiting. */
+       int flag;
        int pad;
 } FMod_Limits;
 
@@ -246,13 +282,18 @@ typedef enum eFMod_Noise_Modifications {
 
 /* stepped modifier data */
 typedef struct FMod_Stepped {
-       float step_size;                /* Number of frames each interpolated value should be held */
-       float offset;                   /* Reference frame number that stepping starts from */
+       /** Number of frames each interpolated value should be held. */
+       float step_size;
+       /** Reference frame number that stepping starts from. */
+       float offset;
 
-       float start_frame;              /* start frame of the frame range that modifier works in */
-       float end_frame;                /* end frame of the frame range that modifier works in */
+       /** Start frame of the frame range that modifier works in. */
+       float start_frame;
+       /** End frame of the frame range that modifier works in. */
+       float end_frame;
 
-       int flag;                       /* various settings */
+       /** Various settings. */
+       int flag;
 } FMod_Stepped;
 
 /* stepped modifier range flags */
@@ -268,15 +309,27 @@ typedef enum eFMod_Stepped_Flags {
  * Defines how to access a dependency needed for a driver variable.
  */
 typedef struct DriverTarget {
-       ID      *id;                            /* ID-block which owns the target, no user count */
+       /** ID-block which owns the target, no user count. */
+       ID      *id;
 
-       char *rna_path;                 /* RNA path defining the setting to use (for DVAR_TYPE_SINGLE_PROP) */
+       /** RNA path defining the setting to use (for DVAR_TYPE_SINGLE_PROP). */
+       char *rna_path;
 
-       char pchan_name[64];    /* name of the posebone to use (for vars where DTAR_FLAG_STRUCT_REF is used) - MAX_ID_NAME-2 */
-       short transChan;                /* transform channel index (for DVAR_TYPE_TRANSFORM_CHAN)*/
+       /**
+        * Name of the posebone to use
+        * (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.)*/
+       short transChan;
 
-       short flag;                             /* flags for the validity of the target (NOTE: these get reset every time the types change) */
-       int idtype;                             /* type of ID-block that this target can use */
+       /**
+        * Flags for the validity of the target
+        * (NOTE: these get reset every time the types change).
+        */
+       short flag;
+       /** Type of ID-block that this target can use. */
+       int idtype;
 } DriverTarget;
 
 /* Driver Target flags */
@@ -329,15 +382,24 @@ typedef enum eDriverTarget_TransformChannels {
 typedef struct DriverVar {
        struct DriverVar *next, *prev;
 
-       char name[64];              /* name of the variable to use in py-expression (must be valid python identifier) - MAX_ID_NAME-2 */
+       /**
+        * Name of the variable to use in py-expression
+        * (must be valid python identifier) - MAX_ID_NAME-2.
+        */
+       char name[64];
 
-       DriverTarget targets[8];    /* MAX_DRIVER_TARGETS, target slots */
+       /** MAX_DRIVER_TARGETS, target slots. */
+       DriverTarget targets[8];
 
-       char num_targets;           /* number of targets actually used by this variable */
-       char type;                  /* type of driver variable (eDriverVar_Types) */
+       /** Number of targets actually used by this variable. */
+       char num_targets;
+       /** Type of driver variable (eDriverVar_Types). */
+       char type;
 
-       short flag;                 /* validation tags, etc. (eDriverVar_Flags) */
-       float curval;               /* result of previous evaluation */
+       /** Validation tags, etc. (eDriverVar_Flags). */
+       short flag;
+       /** Result of previous evaluation. */
+       float curval;
 } DriverVar;
 
 /* Driver Variable Types */
@@ -407,22 +469,31 @@ typedef enum eDriverVar_Flags {
  * evaluated in. This order is set by the Depsgraph's sorting stuff.
  */
 typedef struct ChannelDriver {
-       ListBase variables;     /* targets for this driver (i.e. list of DriverVar) */
+       /** Targets for this driver (i.e. list of DriverVar). */
+       ListBase variables;
 
        /* python expression to execute (may call functions defined in an accessory file)
         * which relates the target 'variables' in some way to yield a single usable value
         */
-       char expression[256];   /* expression to compile for evaluation */
-       void *expr_comp;                /* PyObject - compiled expression, don't save this */
-
-       struct ExprPyLike_Parsed *expr_simple; /* compiled simple arithmetic expression */
-
-       float curval;           /* result of previous evaluation */
-       float influence;        /* influence of driver on result */ // XXX to be implemented... this is like the constraint influence setting
-
-               /* general settings */
-       int type;                       /* type of driver */
-       int flag;                       /* settings of driver */
+       /** Expression to compile for evaluation. */
+       char expression[256];
+       /** PyObject - compiled expression, don't save this. */
+       void *expr_comp;
+
+       /** Compiled simple arithmetic expression. */
+       struct ExprPyLike_Parsed *expr_simple;
+
+       /** Result of previous evaluation. */
+       float curval;
+       // XXX to be implemented... this is like the constraint influence setting
+       /** Influence of driver on result. */
+       float influence;
+
+       /* general settings */
+       /** Type of driver. */
+       int type;
+       /** Settings of driver. */
+       int flag;
 } ChannelDriver;
 
 /* driver type */
@@ -465,8 +536,10 @@ typedef enum eDriver_Flags {
  * than using BPoints, which contain a lot of other unnecessary data...
  */
 typedef struct FPoint {
-       float vec[2];           /* time + value */
-       int flag;                       /* selection info */
+       /** Time + value. */
+       float vec[2];
+       /** Selection info. */
+       int flag;
        int pad;
 } FPoint;
 
@@ -475,35 +548,49 @@ typedef struct FCurve {
        struct FCurve *next, *prev;
 
                /* group */
-       bActionGroup *grp;              /* group that F-Curve belongs to */
+       /** Group that F-Curve belongs to. */
+       bActionGroup *grp;
 
                /* driver settings */
-       ChannelDriver *driver;  /* only valid for drivers (i.e. stored in AnimData not Actions) */
+       /** Only valid for drivers (i.e. stored in AnimData not Actions). */
+       ChannelDriver *driver;
                /* evaluation settings */
-       ListBase modifiers;             /* FCurve Modifiers */
+       /** FCurve Modifiers. */
+       ListBase modifiers;
 
                /* motion data */
-       BezTriple *bezt;                /* user-editable keyframes (array) */
-       FPoint *fpt;                    /* 'baked/imported' motion samples (array) */
-       unsigned int totvert;   /* total number of points which define the curve (i.e. size of arrays in FPoints) */
+       /** User-editable keyframes (array). */
+       BezTriple *bezt;
+       /** 'baked/imported' motion samples (array). */
+       FPoint *fpt;
+       /** Total number of points which define the curve (i.e. size of arrays in FPoints). */
+       unsigned int totvert;
 
                /* value cache + settings */
-       float curval;                   /* value stored from last time curve was evaluated (not threadsafe, debug display only!) */
+       /** Value stored from last time curve was evaluated (not threadsafe, debug display only!). */
+       float curval;
        /* Value which comes from original DNA ddatablock at a time f-curve was evaluated. */
        float orig_dna_val;
-       short flag;                             /* user-editable settings for this curve */
-       short extend;                   /* value-extending mode for this curve (does not cover  */
-       char auto_smoothing;    /* auto-handle smoothing mode */
+       /** User-editable settings for this curve. */
+       short flag;
+       /** Value-extending mode for this curve (does not cover). */
+       short extend;
+       /** Auto-handle smoothing mode. */
+       char auto_smoothing;
 
        char pad[3];
 
                /* RNA - data link */
-       int array_index;                /* if applicable, the index of the RNA-array item to get */
-       char *rna_path;                 /* RNA-path to resolve data-access */
+       /** If applicable, the index of the RNA-array item to get. */
+       int array_index;
+       /** RNA-path to resolve data-access. */
+       char *rna_path;
 
                /* curve coloring (for editor) */
-       int color_mode;                 /* coloring method to use (eFCurve_Coloring) */
-       float color[3];                 /* the last-color this curve took */
+       /** Coloring method to use (eFCurve_Coloring). */
+       int color_mode;
+       /** The last-color this curve took. */
+       float color[3];
 
        float prev_norm_factor, prev_offset;
 } FCurve;
@@ -578,34 +665,51 @@ typedef enum eFCurve_Smoothing {
 typedef struct NlaStrip {
        struct NlaStrip *next, *prev;
 
-       ListBase strips;            /* 'Child' strips (used for 'meta' strips) */
-       bAction *act;               /* Action that is referenced by this strip (strip is 'user' of the action) */
-
-       ListBase fcurves;           /* F-Curves for controlling this strip's influence and timing */    // TODO: move out?
-       ListBase modifiers;         /* F-Curve modifiers to be applied to the entire strip's referenced F-Curves */
-
-       char name[64];              /* User-Visible Identifier for Strip - MAX_ID_NAME-2 */
-
-       float influence;            /* Influence of strip */
-       float strip_time;           /* Current 'time' within action being used (automatically evaluated, but can be overridden) */
-
-       float start, end;           /* extents of the strip */
-       float actstart, actend;     /* range of the action to use */
-
-       float repeat;               /* The number of times to repeat the action range (only when no F-Curves) */
-       float scale;                /* The amount the action range is scaled by (only when no F-Curves) */
-
-       float blendin, blendout;    /* strip blending length (only used when there are no F-Curves) */
-       short blendmode;            /* strip blending mode (layer-based mixing) */
-
-       short extendmode;           /* strip extrapolation mode (time-based mixing) */
+       /** 'Child' strips (used for 'meta' strips). */
+       ListBase strips;
+       /** 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?
+       ListBase fcurves;
+       /** F-Curve modifiers to be applied to the entire strip's referenced F-Curves. */
+       ListBase modifiers;
+
+       /** User-Visible Identifier for Strip - MAX_ID_NAME-2. */
+       char name[64];
+
+       /** Influence of strip. */
+       float influence;
+       /** Current 'time' within action being used (automatically evaluated, but can be overridden). */
+       float strip_time;
+
+       /** Extents of the strip. */
+       float start, end;
+       /** Range of the action to use. */
+       float actstart, actend;
+
+       /** The number of times to repeat the action range (only when no F-Curves). */
+       float repeat;
+       /** The amount the action range is scaled by (only when no F-Curves). */
+       float scale;
+
+       /** Strip blending length (only used when there are no F-Curves). */
+       float blendin, blendout;
+       /** Strip blending mode (layer-based mixing). */
+       short blendmode;
+
+       /** Strip extrapolation mode (time-based mixing). */
+       short extendmode;
        short pad1;
 
-       short type;                 /* type of NLA strip */
+       /** Type of NLA strip. */
+       short type;
 
-       void *speaker_handle;       /* handle for speaker objects */
+       /** Handle for speaker objects. */
+       void *speaker_handle;
 
-       int flag;                   /* settings */
+       /** Settings. */
+       int flag;
        int pad2;
 } NlaStrip;
 
@@ -689,12 +793,16 @@ typedef enum eNlaStrip_Type {
 typedef struct NlaTrack {
        struct NlaTrack *next, *prev;
 
-       ListBase strips;                /* bActionStrips in this track */
+       /** BActionStrips in this track. */
+       ListBase strips;
 
-       int flag;                               /* settings for this track */
-       int index;                              /* index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!) */
+       /** Settings for this track. */
+       int flag;
+       /** Index of the track in the stack (NOTE: not really useful, but we need a pad var anyways!). */
+       int index;
 
-       char name[64];                  /* short user-description of this track - MAX_ID_NAME-2 */
+       /** Short user-description of this track - MAX_ID_NAME-2. */
+       char name[64];
 } NlaTrack;
 
 /* settings for track */
@@ -729,19 +837,28 @@ typedef enum eNlaTrack_Flag {
 typedef struct KS_Path {
        struct KS_Path *next, *prev;
 
-       ID *id;                                 /* ID block that keyframes are for */
-       char group[64];                 /* name of the group to add to - MAX_ID_NAME-2 */
+       /** ID block that keyframes are for. */
+       ID *id;
+       /** Name of the group to add to - MAX_ID_NAME-2. */
+       char group[64];
 
-       int idtype;                             /* ID-type that path can be used on */
+       /** ID-type that path can be used on. */
+       int idtype;
 
-       short groupmode;                /* group naming (eKSP_Grouping) */
-       short flag;                             /* various settings, etc. */
+       /** Group naming (eKSP_Grouping). */
+       short groupmode;
+       /** Various settings, etc. */
+       short flag;
 
-       char *rna_path;                 /* dynamically (or statically in the case of predefined sets) path */
-       int array_index;                /* index that path affects */
+       /** Dynamically (or statically in the case of predefined sets) path. */
+       char *rna_path;
+       /** Index that path affects. */
+       int array_index;
 
-       short keyingflag;               /* (eInsertKeyFlags) settings to supply insertkey() with */
-       short keyingoverride;   /* (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default */
+       /** (eInsertKeyFlags) settings to supply insertkey() with. */
+       short keyingflag;
+       /** (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default. */
+       short keyingoverride;
 } KS_Path;
 
 /* KS_Path->flag */
@@ -779,19 +896,28 @@ typedef enum eKSP_Grouping {
 typedef struct KeyingSet {
        struct KeyingSet *next, *prev;
 
-       ListBase paths;                 /* (KS_Path) paths to keyframe to */
+       /** (KS_Path) paths to keyframe to. */
+       ListBase paths;
 
-       char idname[64];                /* unique name (for search, etc.) - MAX_ID_NAME-2  */
-       char name[64];                  /* user-viewable name for KeyingSet (for menus, etc.) - MAX_ID_NAME-2 */
-       char description[240];  /* (RNA_DYN_DESCR_MAX) short help text. */
-       char typeinfo[64];              /* name of the typeinfo data used for the relative paths - MAX_ID_NAME-2 */
+       /** Unique name (for search, etc.) - MAX_ID_NAME-2 . */
+       char idname[64];
+       /** User-viewable name for KeyingSet (for menus, etc.) - MAX_ID_NAME-2. */
+       char name[64];
+       /** (RNA_DYN_DESCR_MAX) short help text. */
+       char description[240];
+       /** Name of the typeinfo data used for the relative paths - MAX_ID_NAME-2. */
+       char typeinfo[64];
 
-       int active_path;                /* index of the active path */
+       /** Index of the active path. */
+       int active_path;
 
-       short flag;                             /* settings for KeyingSet */
+       /** Settings for KeyingSet. */
+       short flag;
 
-       short keyingflag;               /* (eInsertKeyFlags) settings to supply insertkey() with */
-       short keyingoverride;   /* (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default */
+       /** (eInsertKeyFlags) settings to supply insertkey() with. */
+       short keyingflag;
+       /** (eInsertKeyFlags) for each flag set, the relevant keyingflag bit overrides the default. */
+       short keyingoverride;
 
        char pad[6];
 } KeyingSet;
@@ -838,10 +964,13 @@ typedef enum eInsertKeyFlags {
 typedef struct AnimOverride {
        struct AnimOverride *next, *prev;
 
-       char *rna_path;                 /* RNA-path to use to resolve data-access */
-       int array_index;                /* if applicable, the index of the RNA-array item to get */
+       /** RNA-path to use to resolve data-access. */
+       char *rna_path;
+       /** If applicable, the index of the RNA-array item to get. */
+       int array_index;
 
-       float value;                    /* value to override setting with */
+       /** Value to override setting with. */
+       float value;
 } AnimOverride;
 
 /* AnimData ------------------------------------- */
@@ -868,27 +997,41 @@ typedef struct AnimData {
 
                /* nla-tracks */
        ListBase    nla_tracks;
-               /* active NLA-track (only set/used during tweaking, so no need to worry about dangling pointers) */
+       /**
+        * Active NLA-track
+        * (only set/used during tweaking, so no need to worry about dangling pointers).
+        */
        NlaTrack        *act_track;
-               /* active NLA-strip (only set/used during tweaking, so no need to worry about dangling pointers) */
+       /**
+        * Active NLA-strip
+        * (only set/used during tweaking, so no need to worry about dangling pointers).
+        */
        NlaStrip    *actstrip;
 
        /* 'drivers' for this ID-block's settings - FCurves, but are completely
         * separate from those for animation data
         */
-       ListBase    drivers;    /* standard user-created Drivers/Expressions (used as part of a rig) */
-       ListBase    overrides;  /* temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed) */
+       /** Standard user-created Drivers/Expressions (used as part of a rig). */
+       ListBase    drivers;
+       /** Temp storage (AnimOverride) of values for settings that are animated (but the value hasn't been keyframed). */
+       ListBase    overrides;
 
-       FCurve **driver_array;  /* runtime data, for depsgraph evaluation */
+       /** Runtime data, for depsgraph evaluation. */
+       FCurve **driver_array;
 
                /* settings for animation evaluation */
-       int flag;               /* user-defined settings */
-       int recalc;             /* depsgraph recalculation flags */
+       /** User-defined settings. */
+       int flag;
+       /** Depsgraph recalculation flags. */
+       int recalc;
 
                /* settings for active action evaluation (based on NLA strip settings) */
-       short act_blendmode;    /* accumulation mode for active action */
-       short act_extendmode;   /* extrapolation mode for active action */
-       float act_influence;    /* influence for active action */
+       /** Accumulation mode for active action. */
+       short act_blendmode;
+       /** Extrapolation mode for active action. */
+       short act_extendmode;
+       /** Influence for active action. */
+       float act_influence;
 } AnimData;
 
 /* Animation Data settings (mostly for NLA) */
index 3e68ddc..6087035 100644 (file)
@@ -46,41 +46,62 @@ struct AnimData;
  */
 
 typedef struct Bone {
-       struct Bone *next, *prev;    /*  Next/prev elements within this list */
-       IDProperty  *prop;           /* User-Defined Properties on this Bone */
-       struct Bone *parent;         /*  Parent (ik parent if appropriate flag is set */
-       ListBase     childbase;      /*  Children    */
-       char         name[64];       /*  Name of the bone - must be unique within the armature, MAXBONENAME */
+       /**  Next/prev elements within this list. */
+       struct Bone *next, *prev;
+       /** User-Defined Properties on this Bone. */
+       IDProperty  *prop;
+       /**  Parent (ik parent if appropriate flag is set. */
+       struct Bone *parent;
+       /**  Children   . */
+       ListBase     childbase;
+       /**  Name of the bone - must be unique within the armature, MAXBONENAME. */
+       char         name[64];
 
-       float        roll;           /*  roll is input for editmode, length calculated */
+       /**  roll is input for editmode, length calculated. */
+       float        roll;
        float        head[3];
-       float        tail[3];        /*  head/tail and roll in Bone Space    */
-       float        bone_mat[3][3]; /*  rotation derived from head/tail/roll */
+       /**  head/tail and roll in Bone Space   . */
+       float        tail[3];
+       /**  rotation derived from head/tail/roll. */
+       float        bone_mat[3][3];
 
        int          flag;
 
        float        arm_head[3];
-       float        arm_tail[3];    /*  head/tail in Armature Space (rest pos) */
-       float        arm_mat[4][4];  /*  matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest pos*/
-       float        arm_roll;       /* roll in Armature Space (rest pos) */
+       /**  head/tail in Armature Space (rest pos). */
+       float        arm_tail[3];
+       /**  matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest po.s*/
+       float        arm_mat[4][4];
+       /** Roll in Armature Space (rest pos). */
+       float        arm_roll;
 
-       float        dist, weight;           /*  dist, weight: for non-deformgroup deforms */
-       float        xwidth, length, zwidth; /*  width: for block bones. keep in this order, transform! */
-       float        rad_head, rad_tail;     /* radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head */
+       /**  dist, weight: for non-deformgroup deforms. */
+       float        dist, weight;
+       /**  width: for block bones. keep in this order, transform!. */
+       float        xwidth, length, zwidth;
+       /** Radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head. */
+       float        rad_head, rad_tail;
 
-       float        roll1, roll2;           /* curved bones settings - these define the "restpose" for a curved bone */
+       /** Curved bones settings - these define the "restpose" for a curved bone. */
+       float        roll1, roll2;
        float            curveInX, curveInY;
        float            curveOutX, curveOutY;
-       float        ease1, ease2;        /* length of bezier handles */
+       /** Length of bezier handles. */
+       float        ease1, ease2;
        float            scaleIn, scaleOut;
 
-       float        size[3];        /*  patch for upward compat, UNUSED! */
-       int          layer;          /* layers that bone appears on */
-       short        segments;       /*  for B-bones */
+       /**  patch for upward compat, UNUSED!. */
+       float        size[3];
+       /** Layers that bone appears on. */
+       int          layer;
+       /**  for B-bones. */
+       short        segments;
 
-       char         bbone_prev_type;   /* Type of next/prev bone handles */
+       /** Type of next/prev bone handles. */
+       char         bbone_prev_type;
        char         bbone_next_type;
-       struct Bone *bbone_prev;        /* Next/prev bones to use as handle references when calculating bbones (optional) */
+       /** Next/prev bones to use as handle references when calculating bbones (optional). */
+       struct Bone *bbone_prev;
        struct Bone *bbone_next;
 } Bone;
 
@@ -90,7 +111,8 @@ typedef struct bArmature {
 
        ListBase    bonebase;
        ListBase    chainbase;
-       ListBase   *edbo;                   /* editbone listbase, we use pointer so we can check state */
+       /** Editbone listbase, we use pointer so we can check state. */
+       ListBase   *edbo;
 
        /* active bones should work like active object where possible
         * - active and selection are unrelated
@@ -98,25 +120,35 @@ typedef struct bArmature {
         * - from the user perspective active == last selected
         * - active should be ignored when not visible (hidden layer) */
 
-       Bone       *act_bone;               /* active bone */
-       struct EditBone *act_edbone;        /* active editbone (in editmode) */
+       /** Active bone. */
+       Bone       *act_bone;
+       /** Active editbone (in editmode). */
+       struct EditBone *act_edbone;
 
        int         flag;
        int         drawtype;
-       int         gevertdeformer;         /* how vertex deformation is handled in the ge */
+       /** How vertex deformation is handled in the ge. */
+       int         gevertdeformer;
        int         pad;
        short       deformflag;
        short       pathflag;
 
-       unsigned int layer_used;             /* for UI, to show which layers are there */
-       unsigned int layer, layer_protected; /* for buttons to work, both variables in this order together */
+       /** For UI, to show which layers are there. */
+       unsigned int layer_used;
+       /** For buttons to work, both variables in this order together. */
+       unsigned int layer, layer_protected;
 
 // XXX deprecated... old animation system (armature only viz) ---
-       short       ghostep, ghostsize;     /* number of frames to ghosts to show, and step between them  */
-       short       ghosttype, pathsize;        /* ghost drawing options and number of frames between points of path */
-       int         ghostsf, ghostef;       /* start and end frames of ghost-drawing range */
-       int         pathsf, pathef;         /* start and end frames of path-calculation range for all bones */
-       int         pathbc, pathac;         /* number of frames before/after current frame of path-calculation for all bones  */
+       /** Number of frames to ghosts to show, and step between them . */
+       short       ghostep, ghostsize;
+       /** Ghost drawing options and number of frames between points of path. */
+       short       ghosttype, pathsize;
+       /** Start and end frames of ghost-drawing range. */
+       int         ghostsf, ghostef;
+       /** Start and end frames of path-calculation range for all bones. */
+       int         pathsf, pathef;
+       /** Number of frames before/after current frame of path-calculation for all bones . */
+       int         pathbc, pathac;
 // XXX end of deprecated code ----------------------------------
 } bArmature;
 
index 398c79e..61306fc 100644 (file)
@@ -47,44 +47,73 @@ struct Image;
 struct Material;
 
 typedef struct BrushClone {
-       struct Image *image;    /* image for clone tool */
-       float offset[2];        /* offset of clone image from canvas */
-       float alpha, pad;       /* transparency for drawing of clone image */
+       /** Image for clone tool. */
+       struct Image *image;
+       /** Offset of clone image from canvas. */
+       float offset[2];
+       /** Transparency for drawing of clone image. */
+       float alpha, pad;
 } BrushClone;
 
 
 typedef struct BrushGpencilSettings {
-       float draw_smoothfac;     /* amount of smoothing to apply to newly created strokes */
-       float draw_sensitivity;   /* amount of sensitivity to apply to newly created strokes */
-       float draw_strength;      /* amount of alpha strength to apply to newly created strokes */
-       float draw_jitter;        /* amount of jitter to apply to newly created strokes */
-       float draw_angle;         /* angle when the brush has full thickness */
-       float draw_angle_factor;  /* factor to apply when angle change (only 90 degrees) */
-       float draw_random_press;  /* factor of randomness for pressure */
-       float draw_random_strength;  /* factor of strength for strength */
-       float draw_random_sub;    /* factor of randomness for subdivision */
-       short draw_smoothlvl;     /* number of times to apply smooth factor to new strokes */
-       short draw_subdivide;     /* number of times to subdivide new strokes */
-       short flag;               /* internal grease pencil drawing flags */
-
-       short thick_smoothlvl; /* number of times to apply thickness smooth factor to new strokes */
-       float thick_smoothfac; /* amount of thickness smoothing to apply to newly created strokes */
-
-       float fill_threshold;  /* factor for transparency */
-       short fill_leak;       /* number of pixel to consider the leak is too small (x 2) */
+       /** Amount of smoothing to apply to newly created strokes. */
+       float draw_smoothfac;
+       /** Amount of sensitivity to apply to newly created strokes. */
+       float draw_sensitivity;
+       /** Amount of alpha strength to apply to newly created strokes. */
+       float draw_strength;
+       /** Amount of jitter to apply to newly created strokes. */
+       float draw_jitter;
+       /** Angle when the brush has full thickness. */
+       float draw_angle;
+       /** Factor to apply when angle change (only 90 degrees). */
+       float draw_angle_factor;
+       /** Factor of randomness for pressure. */
+       float draw_random_press;
+       /** Factor of strength for strength. */
+       float draw_random_strength;
+       /** Factor of randomness for subdivision. */
+       float draw_random_sub;
+       /** Number of times to apply smooth factor to new strokes. */
+       short draw_smoothlvl;
+       /** Number of times to subdivide new strokes. */
+       short draw_subdivide;
+       /** Internal grease pencil drawing flags. */
+       short flag;
+
+       /** Number of times to apply thickness smooth factor to new strokes. */
+       short thick_smoothlvl;
+       /** Amount of thickness smoothing to apply to newly created strokes. */
+       float thick_smoothfac;
+
+       /** Factor for transparency. */
+       float fill_threshold;
+       /** Number of pixel to consider the leak is too small (x 2). */
+       short fill_leak;
        char pad_1[6];
 
-       int   fill_simplylvl;  /* number of simplify steps */
-       int   fill_draw_mode;  /* type of control lines drawing mode */
-       int   icon_id;         /* icon identifier */
-
-       int   input_samples;   /* maximum distance before generate new point for very fast mouse movements */
-       float uv_random;       /* random factor for UV rotation */
-       int   brush_type DNA_DEPRECATED;  /* moved to 'Brush.gpencil_tool' */
-       int   eraser_mode;     /* soft, hard or stroke */
-       float active_smooth;   /* smooth while drawing factor */
-       float era_strength_f;  /* factor to apply to strength for soft eraser */
-       float era_thickness_f; /* factor to apply to thickness for soft eraser */
+       /** Number of simplify steps. */
+       int   fill_simplylvl;
+       /** Type of control lines drawing mode. */
+       int   fill_draw_mode;
+       /** Icon identifier. */
+       int   icon_id;
+
+       /** Maximum distance before generate new point for very fast mouse movements. */
+       int   input_samples;
+       /** Random factor for UV rotation. */
+       float uv_random;
+       /** Moved to 'Brush.gpencil_tool'. */
+       int   brush_type DNA_DEPRECATED;
+       /** Soft, hard or stroke. */
+       int   eraser_mode;
+       /** Smooth while drawing factor. */
+       float active_smooth;
+       /** Factor to apply to strength for soft eraser. */
+       float era_strength_f;
+       /** Factor to apply to thickness for soft eraser. */
+       float era_thickness_f;
        char pad_2[4];
 
        struct CurveMapping *curve_sensitivity;
@@ -92,7 +121,8 @@ typedef struct BrushGpencilSettings {
        struct CurveMapping *curve_jitter;
 
        /* optional link of material to replace default in context */
-       struct Material *material;     /* material */
+       /** Material. */
+       struct Material *material;
 } BrushGpencilSettings;
 
 /* BrushGpencilSettings->gp_flag */
@@ -159,7 +189,8 @@ typedef struct Brush {
        ID id;
 
        struct BrushClone clone;
-       struct CurveMapping *curve; /* falloff curve */
+       /** Falloff curve. */
+       struct CurveMapping *curve;
        struct MTex mtex;
        struct MTex mask_mtex;
 
@@ -167,51 +198,80 @@ typedef struct Brush {
 
        struct ImBuf *icon_imbuf;
        PreviewImage *preview;
-       struct ColorBand *gradient;     /* color gradient */
+       /** Color gradient. */
+       struct ColorBand *gradient;
        struct PaintCurve *paint_curve;
 
-       char icon_filepath[1024]; /* 1024 = FILE_MAX */
+       /** 1024 = FILE_MAX. */
+       char icon_filepath[1024];
 
        float normal_weight;
-       float rake_factor;  /* rake actual data (not texture), used for sculpt */
-
-       short blend;        /* blend mode */
-       short ob_mode;      /* eObjectMode: to see if the brush is compatible, use for display only. */
-       float weight;       /* brush weight */
-       int size;           /* brush diameter */
-       int flag;           /* general purpose flag */
-       int mask_pressure;  /* pressure influence for mask */
-       float jitter;       /* jitter the position of the brush */
-       int jitter_absolute;    /* absolute jitter in pixels */
+       /** Rake actual data (not texture), used for sculpt. */
+       float rake_factor;
+
+       /** Blend mode. */
+       short blend;
+       /** #eObjectMode: to see if the brush is compatible, use for display only. */
+       short ob_mode;
+       /** Brush weight. */
+       float weight;
+       /** Brush diameter. */
+       int size;
+       /** General purpose flag. */
+       int flag;
+       /** Pressure influence for mask. */
+       int mask_pressure;
+       /** Jitter the position of the brush. */
+       float jitter;
+       /** Absolute jitter in pixels. */
+       int jitter_absolute;
        int overlay_flags;
-       int spacing;        /* spacing of paint operations */
-       int smooth_stroke_radius;   /* turning radius (in pixels) for smooth stroke */
-       float smooth_stroke_factor; /* higher values limit fast changes in the stroke direction */
-       float rate;         /* paint operations / second (airbrush) */
-
-       float rgb[3];           /* color */
-       float alpha;            /* opacity */
+       /** Spacing of paint operations. */
+       int spacing;
+       /** Turning radius (in pixels) for smooth stroke. */
+       int smooth_stroke_radius;
+       /** Higher values limit fast changes in the stroke direction. */
+       float smooth_stroke_factor;
+       /** Paint operations / second (airbrush). */
+       float rate;
+
+       /** Color. */
+       float rgb[3];
+       /** Opacity. */
+       float alpha;
 
-       float secondary_rgb[3]; /* background color */
+       /** Background color. */
+       float secondary_rgb[3];
 
-       int sculpt_plane;       /* the direction of movement for sculpt vertices */
+       /** The direction of movement for sculpt vertices. */
+       int sculpt_plane;
 
-       float plane_offset;     /* offset for plane brushes (clay, flatten, fill, scrape) */
+       /** Offset for plane brushes (clay, flatten, fill, scrape). */
+       float plane_offset;
 
        int gradient_spacing;
-       char gradient_stroke_mode; /* source for stroke color gradient application */
-       char gradient_fill_mode;   /* source for fill tool color gradient application */
+       /** Source for stroke color gradient application. */
+       char gradient_stroke_mode;
+       /** Source for fill tool color gradient application. */
+       char gradient_fill_mode;
 
        char pad;
-       char falloff_shape;     /* Projection shape (sphere, circle) */
+       /** Projection shape (sphere, circle). */
+       char falloff_shape;
        float falloff_angle;
 
-       char sculpt_tool;       /* active sculpt tool */
-       char vertexpaint_tool;  /* active vertex paint */
-       char weightpaint_tool;  /* active weight paint */
-       char imagepaint_tool;   /* active image paint tool */
-       char mask_tool;         /* enum eBrushMaskTool, only used if sculpt_tool is SCULPT_TOOL_MASK */
-       char gpencil_tool;      /* Active grease pencil tool. */
+       /** Active sculpt tool. */
+       char sculpt_tool;
+       /** Active vertex paint. */
+       char vertexpaint_tool;
+       /** Active weight paint. */
+       char weightpaint_tool;
+       /** Active image paint tool. */
+       char imagepaint_tool;
+       /** Enum eBrushMaskTool, only used if sculpt_tool is SCULPT_TOOL_MASK. */
+       char mask_tool;
+       /** Active grease pencil tool. */
+       char gpencil_tool;
        char _pad0[6];
 
        float autosmooth_factor;
@@ -219,7 +279,8 @@ typedef struct Brush {
        float crease_pinch_factor;
 
        float plane_trim;
-       float height;           /* affectable height of brush (layer height for layer tool, i.e.) */
+       /** Affectable height of brush (layer height for layer tool, i.e.). */
+       float height;
 
        float texture_sample_bias;
 
@@ -268,15 +329,19 @@ typedef struct Palette {
 } Palette;
 
 typedef struct PaintCurvePoint {
-       BezTriple bez; /* bezier handle */
-       float pressure; /* pressure on that point */
+       /** Bezier handle. */
+       BezTriple bez;
+       /** Pressure on that point. */
+       float pressure;
 } PaintCurvePoint;
 
 typedef struct PaintCurve {
        ID id;
-       PaintCurvePoint *points; /* points of curve */
+       /** Points of curve. */
+       PaintCurvePoint *points;
        int tot_points;
-       int add_index; /* index where next point will be added */
+       /** Index where next point will be added. */
+       int add_index;
 } PaintCurve;
 
 /* Brush.gradient_source */
index c0e662d..8ff1d52 100644 (file)
@@ -62,11 +62,11 @@ typedef struct CacheFile {
        struct AbcArchiveHandle *handle;
        void *handle_mutex;
 
-       /* Paths of the objects inside of the Alembic archive referenced by this
-        * CacheFile. */
+       /** Paths of the objects inside of the Alembic archive referenced by this CacheFile. */
        ListBase object_paths;
 
-       char filepath[1024];  /* 1024 = FILE_MAX */
+       /** 1024 = FILE_MAX. */
+       char filepath[1024];
 
        char is_sequence;
        char forward_axis;
@@ -74,10 +74,13 @@ typedef struct CacheFile {
        char override_frame;
 
        float scale;
-       float frame;  /* The frame/time to lookup in the cache file. */
-       float frame_offset; /* The frame offset to subtract. */
+       /** The frame/time to lookup in the cache file. */
+       float frame;
+       /** The frame offset to subtract. */
+       float frame_offset;
 
-       short flag;  /* Animation flag. */
+       /** Animation flag. */
+       short flag;
        short draw_flag;
 
        char padding[4];
index 17cf945..ab31bb6 100644 (file)
@@ -77,10 +77,13 @@ typedef struct CameraBGImage {
 
 typedef struct Camera {
        ID id;
-       struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
 
-       char type; /* CAM_PERSP, CAM_ORTHO or CAM_PANO */
-       char dtx; /* draw type extra */
+       /** CAM_PERSP, CAM_ORTHO or CAM_PANO. */
+       char type;
+       /** Draw type extra. */
+       char dtx;
        short flag;
        float passepartalpha;
        float clipsta, clipend;
@@ -93,7 +96,8 @@ typedef struct Camera {
         * The name was not changed so that no other files need to be modified */
        float YF_dofdist;
 
-       struct Ipo *ipo  DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo  DNA_DEPRECATED;
 
        struct Object *dof_ob;
        struct GPUDOFSettings gpu_dof;
index 39a110d..1f86368 100644 (file)
  */
 
 typedef struct ClothSimSettings {
-       struct  LinkNode *cache; /* UNUSED atm */
-       float   mingoal;        /* see SB */
-       float   Cdis DNA_DEPRECATED;    /* Mechanical damping of springs. */
-       float   Cvi;            /* Viscous/fluid damping.                       */
-       float   gravity[3];     /* Gravity/external force vector.               */
-       float   dt;             /* This is the duration of our time step, computed.     */
-       float   mass;           /* The mass of the entire cloth.                */
-       float   structural DNA_DEPRECATED;      /* Structural spring stiffness. */
-       float   shear;          /* Shear spring stiffness.                      */
-       float   bending;        /* Flexion spring stiffness.                    */
-       float   max_bend;       /* max bending scaling value, min is "bending" */
-       float   max_struct DNA_DEPRECATED;      /* max structural scaling value, min is "structural" */
-       float   max_shear;      /* max shear scaling value */
-       float   max_sewing;     /* max sewing force */
-       float   avg_spring_len; /* used for normalized springs */
-       float   timescale; /* parameter how fast cloth runs */
-       float   time_scale; /* multiplies cloth speed */
-       float   maxgoal;        /* see SB */
-       float   eff_force_scale;/* Scaling of effector forces (see softbody_calc_forces).*/
-       float   eff_wind_scale; /* Scaling of effector wind (see softbody_calc_forces). */
+       /** UNUSED atm. */
+       struct  LinkNode *cache;
+       /** See SB. */
+       float   mingoal;
+       /** Mechanical damping of springs. */
+       float   Cdis DNA_DEPRECATED;
+       /** Viscous/fluid damping.              .       */
+       float   Cvi;
+       /** Gravity/external force vector.      .       */
+       float   gravity[3];
+       /** This is the duration of our time step, computed..   */
+       float   dt;
+       /** The mass of the entire cloth.       .       */
+       float   mass;
+       /** Structural spring stiffness. */
+       float   structural DNA_DEPRECATED;
+       /** Shear spring stiffness.             .       */
+       float   shear;
+       /** Flexion spring stiffness.           .       */
+       float   bending;
+       /** Max bending scaling value, min is "bending". */
+       float   max_bend;
+       /** Max structural scaling value, min is "structural". */
+       float   max_struct DNA_DEPRECATED;
+       /** Max shear scaling value. */
+       float   max_shear;
+       /** Max sewing force. */
+       float   max_sewing;
+       /** Used for normalized springs. */
+       float   avg_spring_len;
+       /** Parameter how fast cloth runs. */
+       float   timescale;
+       /** Multiplies cloth speed. */
+       float   time_scale;
+       /** See SB. */
+       float   maxgoal;
+       /** Scaling of effector forces (see softbody_calc_forces)..*/
+       float   eff_force_scale;
+       /** Scaling of effector wind (see softbody_calc_forces)..       */
+       float   eff_wind_scale;
        float   sim_time_old;
        float   defgoal;
        float   goalspring;
        float   goalfrict;
-       float   velocity_smooth; /* smoothing of velocities for hair */
-       float   density_target;         /* minimum density for hair */
-       float   density_strength;       /* influence of hair density */
-       float   collider_friction; /* friction with colliders */
-       float   vel_damping DNA_DEPRECATED;     /* damp the velocity to speed up getting to the resting position */
-       float   shrink_min;  /* min amount to shrink cloth by 0.0f (no shrink) - 1.0f (shrink to nothing) */
-       float   shrink_max;  /* max amount to shrink cloth by 0.0f (no shrink) - 1.0f (shrink to nothing) */
+       /** Smoothing of velocities for hair. */
+       float   velocity_smooth;
+       /** Minimum density for hair. */
+       float   density_target;
+       /** Influence of hair density. */
+       float   density_strength;
+       /** Friction with colliders. */
+       float   collider_friction;
+       /** Damp the velocity to speed up getting to the resting position. */
+       float   vel_damping DNA_DEPRECATED;
+       /** Min amount to shrink cloth by 0.0f (no shrink) - 1.0f (shrink to nothing). */
+       float   shrink_min;
+       /** Max amount to shrink cloth by 0.0f (no shrink) - 1.0f (shrink to nothing). */
+       float   shrink_max;
 
        /* XXX various hair stuff
         * should really be separate, this struct is a horrible mess already
         */
-       float   bending_damping;        /* damping of bending springs */
-       float   voxel_cell_size;    /* size of voxel grid cells for continuum dynamics */
+       /** Damping of bending springs. */
+       float   bending_damping;
+       /** Size of voxel grid cells for continuum dynamics. */
+       float   voxel_cell_size;
        int             pad;
 
-       int     stepsPerFrame;  /* Number of time steps per frame.              */
-       int     flags;          /* flags, see CSIMSETT_FLAGS enum above.        */
-       int     preroll  DNA_DEPRECATED;        /* How many frames of simulation to do before we start. */
-       int     maxspringlen;   /* in percent!; if tearing enabled, a spring will get cut */
-       short   solver_type;    /* which solver should be used?         txold   */
-       short   vgroup_bend;    /* vertex group for scaling bending stiffness */
-       short   vgroup_mass;    /* optional vertexgroup name for assigning weight.*/
-       short   vgroup_struct;  /* vertex group for scaling structural stiffness */
-       short   vgroup_shrink;  /* vertex group for shrinking cloth */
-       short   shapekey_rest;  /* vertex group for scaling structural stiffness */
-       short   presets; /* used for presets on GUI */
+       /** Number of time steps per frame.     .       */
+       int     stepsPerFrame;
+       /** Flags, see CSIMSETT_FLAGS enum above..      */
+       int     flags;
+       /** How many frames of simulation to do before we start..       */
+       int     preroll  DNA_DEPRECATED;
+       /** In percent!; if tearing enabled, a spring will get cut. */
+       int     maxspringlen;
+       /** Which solver should be used?                txold.  */
+       short   solver_type;
+       /** Vertex group for scaling bending stiffness. */
+       short   vgroup_bend;
+       /** Optional vertexgroup name for assigning weight..*/
+       short   vgroup_mass;
+       /** Vertex group for scaling structural stiffness. */
+       short   vgroup_struct;
+       /** Vertex group for shrinking cloth. */
+       short   vgroup_shrink;
+       /** Vertex group for scaling structural stiffness. */
+       short   shapekey_rest;
+       /** Used for presets on GUI. */
+       short   presets;
        short   reset;
 
        char pad0[4];
        struct EffectorWeights *effector_weights;
 
        short   bending_model;
-       short   vgroup_shear;           /* Vertex group for scaling structural stiffness. */
+       /** Vertex group for scaling structural stiffness. */
+       short   vgroup_shear;
        float   tension;
        float   compression;
        float   max_tension;
        float   max_compression;
-       float   tension_damp;           /* Mechanical damping of tension springs. */
-       float   compression_damp;       /* Mechanical damping of compression springs. */
-       float   shear_damp;                     /* Mechanical damping of shear springs. */
+       /** Mechanical damping of tension springs. */
+       float   tension_damp;
+       /** Mechanical damping of compression springs. */
+       float   compression_damp;
+       /** Mechanical damping of shear springs. */
+       float   shear_damp;
 } ClothSimSettings;
 
 
 typedef struct ClothCollSettings {
-       struct  LinkNode *collision_list; /* e.g. pointer to temp memory for collisions */
-       float   epsilon;                /* min distance for collisions.         */
-       float   self_friction;          /* Fiction/damping with self contact. */
-       float   friction;               /* Friction/damping applied on contact with other object.*/
-       float   damping;        /* Collision restitution on contact with other object.*/
-       float   selfepsilon;            /* for selfcollision */
+       /** E.g. pointer to temp memory for collisions. */
+       struct  LinkNode *collision_list;
+       /** Min distance for collisions.        .       */
+       float   epsilon;
+       /** Fiction/damping with self contact. */
+       float   self_friction;
+       /** Friction/damping applied on contact with other object..*/
+       float   friction;
+       /** Collision restitution on contact with other object..*/
+       float   damping;
+       /** For selfcollision. */
+       float   selfepsilon;
        float repel_force DNA_DEPRECATED;
        float distance_repel DNA_DEPRECATED;
-       int     flags;                  /* collision flags defined in BKE_cloth.h */
-       short   self_loop_count DNA_DEPRECATED; /* How many iterations for the selfcollision loop */
-       short   loop_count;             /* How many iterations for the collision loop.          */
+       /** Collision flags defined in BKE_cloth.h. */
+       int     flags;
+       /** How many iterations for the selfcollision loop. */
+       short   self_loop_count DNA_DEPRECATED;
+       /** How many iterations for the collision loop. .       */
+       short   loop_count;
        int pad;
-       struct Collection *group;       /* Only use colliders from this group of objects */
-       short   vgroup_selfcol; /* vgroup to paint which vertices are used for self collisions */
+       /** Only use colliders from this group of objects. */
+       struct Collection *group;
+       /** Vgroup to paint which vertices are used for self collisions. */
+       short   vgroup_selfcol;
        short pad2[3];
-       float   clamp;          /* Impulse clamp for object collisions. */
-       float   self_clamp;     /* Impulse clamp for self collisions. */
+       /** Impulse clamp for object collisions. */
+       float   clamp;
+       /** Impulse clamp for self collisions. */
+       float   self_clamp;
 } ClothCollSettings;
 
 
index f08725e..69843f4 100644 (file)
@@ -56,8 +56,10 @@ typedef struct CollectionChild {
 typedef struct Collection {
        ID id;
 
-       ListBase gobject;   /* CollectionObject */
-       ListBase children;  /* CollectionChild */
+       /** CollectionObject. */
+       ListBase gobject;
+       /** CollectionChild. */
+       ListBase children;
 
        struct PreviewImage *preview;
 
index 2c6411a..c9a91a5 100644 (file)
@@ -43,7 +43,8 @@
 
 typedef struct CurveMapPoint {
        float x, y;
-       short flag, shorty;             /* shorty for result lookup */
+       /** Shorty for result lookup. */
+       short flag, shorty;
 } CurveMapPoint;
 
 /* curvepoint->flag */
@@ -56,14 +57,21 @@ enum {
 typedef struct CurveMap {
        short totpoint, flag;
 
-       float range;                                    /* quick multiply value for reading table */
-       float mintable, maxtable;               /* the x-axis range for the table */
-       float ext_in[2], ext_out[2];    /* for extrapolated curves, the direction vector */
-       CurveMapPoint *curve;                   /* actual curve */
-       CurveMapPoint *table;                   /* display and evaluate table */
-
-       CurveMapPoint *premultable;             /* for RGB curves, premulled table */
-       float premul_ext_in[2];                 /* for RGB curves, premulled extrapolation vector */
+       /** Quick multiply value for reading table. */
+       float range;
+       /** The x-axis range for the table. */
+       float mintable, maxtable;
+       /** For extrapolated curves, the direction vector. */
+       float ext_in[2], ext_out[2];
+       /** Actual curve. */
+       CurveMapPoint *curve;
+       /** Display and evaluate table. */
+       CurveMapPoint *table;
+
+       /** For RGB curves, premulled table. */
+       CurveMapPoint *premultable;
+       /** For RGB curves, premulled extrapolation vector. */
+       float premul_ext_in[2];
        float premul_ext_out[2];
 } CurveMap;
 
@@ -71,17 +79,23 @@ typedef struct CurveMap {
 #define CUMA_EXTEND_EXTRAPOLATE        1
 
 typedef struct CurveMapping {
-       int flag, cur;                                  /* cur; for buttons, to show active curve */
+       /** Cur; for buttons, to show active curve. */
+       int flag, cur;
        int preset;
        int changed_timestamp;
 
-       rctf curr, clipr;                               /* current rect, clip rect (is default rect too) */
+       /** Current rect, clip rect (is default rect too). */
+       rctf curr, clipr;
 
-       CurveMap cm[4];                                 /* max 4 builtin curves per mapping struct now */
-       float black[3], white[3];               /* black/white point (black[0] abused for current frame) */
-       float bwmul[3];                                 /* black/white point multiply value, for speed */
+       /** Max 4 builtin curves per mapping struct now. */
+       CurveMap cm[4];
+       /** Black/white point (black[0] abused for current frame). */
+       float black[3], white[3];
+       /** Black/white point multiply value, for speed. */
+       float bwmul[3];
 
-       float sample[3];                                /* sample values, if flag set it draws line and intersection */
+       /** Sample values, if flag set it draws line and intersection. */
+       float sample[3];
 
        short tone;
        short pad[3];
@@ -177,11 +191,16 @@ typedef struct Scopes {
 
 typedef struct ColorManagedViewSettings {
        int flag, pad;
-       char look[64];   /* look which is being applied when displaying buffer on the screen (prior to view transform) */
-       char view_transform[64];   /* view transform which is being applied when displaying buffer on the screen */
-       float exposure;            /* fstop exposure */
-       float gamma;               /* post-display gamma transform */
-       struct CurveMapping *curve_mapping;  /* pre-display RGB curves transform */
+       /** Look which is being applied when displaying buffer on the screen (prior to view transform). */
+       char look[64];
+       /** View transform which is being applied when displaying buffer on the screen. */
+       char view_transform[64];
+       /** Fstop exposure. */
+       float exposure;
+       /** Post-display gamma transform. */
+       float gamma;
+       /** Pre-display RGB curves transform. */
+       struct CurveMapping *curve_mapping;
        void *pad2;
 } ColorManagedViewSettings;
 
@@ -190,7 +209,8 @@ typedef struct ColorManagedDisplaySettings {
 } ColorManagedDisplaySettings;
 
 typedef struct ColorManagedColorspaceSettings {
-       char name[64];    /* MAX_COLORSPACE_NAME */
+       /** MAX_COLORSPACE_NAME. */
+       char name[64];
 } ColorManagedColorspaceSettings;
 
 /* ColorManagedViewSettings->flag */
index b68ba8d..3932d2c 100644 (file)
@@ -54,25 +54,38 @@ typedef struct bConstraintChannel {
 typedef struct bConstraint {
        struct bConstraint *next, *prev;
 
-       void            *data;          /* Constraint data      (a valid constraint type) */
-       short           type;           /* Constraint type      */
-       short           flag;           /* Flag - General Settings      */
+       /** Constraint data     (a valid constraint type). */
+       void            *data;
+       /** Constraint type.    */
+       short           type;
+       /** Flag - General Settings.    */
+       short           flag;
 
-       char            ownspace;       /* Space that owner should be evaluated in */
-       char            tarspace;       /* Space that target should be evaluated in (only used if 1 target) */
+       /** Space that owner should be evaluated in. */
+       char            ownspace;
+       /** Space that target should be evaluated in (only used if 1 target). */
+       char            tarspace;
 
-       char            name[64];       /* Constraint name, MAX_NAME */
+       /** Constraint name, MAX_NAME. */
+       char            name[64];
 
        short           pad;
 
-       float           enforce;        /* Amount of influence exherted by constraint (0.0-1.0) */
-       float           headtail;       /* Point along subtarget bone where the actual target is. 0=head (default for all), 1=tail*/
-
-       struct Ipo *ipo    DNA_DEPRECATED;              /* local influence ipo or driver */  /* old animation system, deprecated for 2.5 */
-
-       /* below are readonly fields that are set at runtime by the solver for use in the GE (only IK atm) */
-       float       lin_error;          /* residual error on constraint expressed in blender unit*/
-       float       rot_error;          /* residual error on constraint expressed in radiant */
+       /** Amount of influence exherted by constraint (0.0-1.0). */
+       float           enforce;
+       /** Point along subtarget bone where the actual target is. 0=head (default for all), 1=tail. */
+       float           headtail;
+
+       /* old animation system, deprecated for 2.5. */
+       /** Local influence ipo or driver */
+       struct Ipo *ipo    DNA_DEPRECATED;
+
+       /* below are readonly fields that are set at runtime
+        * by the solver for use in the GE (only IK atm) */
+       /** Residual error on constraint expressed in blender unit. */
+       float       lin_error;
+       /** Residual error on constraint expressed in radiant. */
+       float       rot_error;
 } bConstraint;
 
 
@@ -85,16 +98,24 @@ typedef struct bConstraint {
 typedef struct bConstraintTarget {
        struct bConstraintTarget *next, *prev;
 
-       struct Object *tar;                     /* object to use as target */
-       char subtarget[64];             /* subtarget - pchan or vgroup name, MAX_ID_NAME-2 */
-
-       float matrix[4][4];             /* matrix used during constraint solving - should be cleared before each use */
-
-       short space;                    /* space that target should be evaluated in (overrides bConstraint->tarspace) */
-       short flag;                             /* runtime settings (for editor, etc.) */
-       short type;                             /* type of target (eConstraintObType) */
-       short rotOrder;                 /* rotation order for target (as defined in BLI_math.h) */
-       float weight;                   /* weight for armature deform */
+       /** Object to use as target. */
+       struct Object *tar;
+       /** Subtarget - pchan or vgroup name, MAX_ID_NAME-2. */
+       char subtarget[64];
+
+       /** Matrix used during constraint solving - should be cleared before each use. */
+       float matrix[4][4];
+
+       /** Space that target should be evaluated in (overrides bConstraint->tarspace). */
+       short space;
+       /** Runtime settings (for editor, etc.). */
+       short flag;
+       /** Type of target (eConstraintObType). */
+       short type;
+       /** Rotation order for target (as defined in BLI_math.h). */
+       short rotOrder;
+       /** Weight for armature deform. */
+       float weight;
        char pad[4];
 } bConstraintTarget;
 
@@ -114,16 +135,29 @@ typedef enum eConstraintObType {
 
 /* Python Script Constraint */
 typedef struct bPythonConstraint {
-       struct Text *text;              /* text-buffer (containing script) to execute */
-       IDProperty *prop;               /* 'id-properties' used to store custom properties for constraint */
-
-       int flag;                               /* general settings/state indicators accessed by bitmapping */
-       int tarnum;                             /* number of targets - usually only 1-3 are needed */
-
-       ListBase targets;               /* a list of targets that this constraint has (bConstraintTarget-s) */
-
-       struct Object *tar;             /* target from previous implementation (version-patch sets this to NULL on file-load) */
-       char subtarget[64];             /* subtarger from previous implementation (version-patch sets this to "" on file-load), MAX_ID_NAME-2 */
+       /** Text-buffer (containing script) to execute. */
+       struct Text *text;
+       /** 'id-properties' used to store custom properties for constraint. */
+       IDProperty *prop;
+
+       /** General settings/state indicators accessed by bitmapping. */
+       int flag;
+       /** Number of targets - usually only 1-3 are needed. */
+       int tarnum;
+
+       /** A list of targets that this constraint has (bConstraintTarget-s). */
+       ListBase targets;
+
+       /**
+        * Target from previous implementation
+        * (version-patch sets this to NULL on file-load).
+        */
+       struct Object *tar;
+       /**
+        * Subtarger from previous implementation
+        * (version-patch sets this to "" on file-load), MAX_ID_NAME-2.
+        */
+       char subtarget[64];
 } bPythonConstraint;
 
 
@@ -134,21 +168,36 @@ typedef struct bPythonConstraint {
  * This is indicated in the comments for each field
  */
 typedef struct bKinematicConstraint {
-       struct Object           *tar;                   /* All: target object in case constraint needs a target */
-       short           iterations;             /* All: Maximum number of iterations to try */
-       short           flag;                   /* All & CopyPose: some options Like CONSTRAINT_IK_TIP */
-       short           rootbone;               /* All: index to rootbone, if zero go all the way to mother bone */
-       short           max_rootbone;   /* CopyPose: for auto-ik, maximum length of chain */
-       char            subtarget[64];  /* All: String to specify sub-object target, MAX_ID_NAME-2 */
-       struct Object           *poletar;                       /* All: Pole vector target */
-       char            polesubtarget[64];      /* All: Pole vector sub-object target, MAX_ID_NAME-2 */
-       float           poleangle;                      /* All: Pole vector rest angle */
-       float           weight;                 /* All: Weight of constraint in IK tree */
-       float           orientweight;   /* CopyPose: Amount of rotation a target applies on chain */
-       float           grabtarget[3];  /* CopyPose: for target-less IK */
-       short           type;                   /* subtype of IK constraint: eConstraint_IK_Type */
-       short           mode;                   /* Distance: how to limit in relation to clamping sphere: LIMITDIST_.. */
-       float           dist;                   /* Distance: distance (radius of clamping sphere) from target */
+       /** All: target object in case constraint needs a target. */
+       struct Object           *tar;
+       /** All: Maximum number of iterations to try. */
+       short           iterations;
+       /** All & CopyPose: some options Like CONSTRAINT_IK_TIP. */
+       short           flag;
+       /** All: index to rootbone, if zero go all the way to mother bone. */
+       short           rootbone;
+       /** CopyPose: for auto-ik, maximum length of chain. */
+       short           max_rootbone;
+       /** All: String to specify sub-object target, MAX_ID_NAME-2. */
+       char            subtarget[64];
+       /** All: Pole vector target. */
+       struct Object           *poletar;
+       /** All: Pole vector sub-object target, MAX_ID_NAME-2. */
+       char            polesubtarget[64];
+       /** All: Pole vector rest angle. */
+       float           poleangle;
+       /** All: Weight of constraint in IK tree. */
+       float           weight;
+       /** CopyPose: Amount of rotation a target applies on chain. */
+       float           orientweight;
+       /** CopyPose: for target-less IK. */
+       float           grabtarget[3];
+       /** Subtype of IK constraint: eConstraint_IK_Type. */
+       short           type;
+       /** Distance: how to limit in relation to clamping sphere: LIMITDIST_... */
+       short           mode;
+       /** Distance: distance (radius of clamping sphere) from target. */
+       float           dist;
 } bKinematicConstraint;
 
 typedef enum eConstraint_IK_Type {
@@ -164,16 +213,25 @@ typedef enum eConstraint_IK_Type {
  */
 typedef struct bSplineIKConstraint {
                /* target(s) */
-       struct Object *tar;             /* curve object (with follow path enabled) which drives the bone chain */
+       /** Curve object (with follow path enabled) which drives the bone chain. */
+       struct Object *tar;
 
                /* binding details */
-       float           *points;        /* array of numpoints items, denoting parametric positions along curve that joints should follow */
-       short           numpoints;      /* number of points to bound in points array */
-       short           chainlen;       /* number of bones ('n') that are in the chain */
+       /**
+        * Array of numpoints items,
+        * denoting parametric positions along curve that joints should follow.
+        */
+       float           *points;
+       /** Number of points to bound in points array. */
+       short           numpoints;
+       /** Number of bones ('n') that are in the chain. */
+       short           chainlen;
 
                /* settings */
-       short flag;                             /* general settings for constraint */
-       short xzScaleMode;              /* method used for determining the x & z scaling of the bones */
+       /** General settings for constraint. */
+       short flag;
+       /** Method used for determining the x & z scaling of the bones. */
+       short xzScaleMode;
 
                /* volume preservation settings */
        float           bulge;
@@ -184,10 +242,12 @@ typedef struct bSplineIKConstraint {
 
 /* Armature Constraint */
 typedef struct bArmatureConstraint {
-       int flag;                       /* general settings/state indicators accessed by bitmapping */
+       /** General settings/state indicators accessed by bitmapping. */
+       int flag;
        char pad[4];
 
-       ListBase targets;               /* a list of targets that this constraint has (bConstraintTarget-s) */
+       /** A list of targets that this constraint has (bConstraintTarget-s). */
+       ListBase targets;
 } bArmatureConstraint;
 
 /* Single-target subobject constraints ---------------------  */
@@ -195,14 +255,18 @@ typedef struct bArmatureConstraint {
 /* Track To Constraint */
 typedef struct bTrackToConstraint {
        struct Object           *tar;
-       int                     reserved1; /* I'll be using reserved1 and reserved2 as Track and Up flags,
-                               * not sure if that's what they were intended for anyway.
-                               * Not sure either if it would create backward incompatibility if I were to rename them.
-                               * - theeth*/
+       /**
+        * I'll be using reserved1 and reserved2 as Track and Up flags,
+        * not sure if that's what they were intended for anyway.
+        * Not sure either if it would create backward incompatibility if I were to rename them.
+        * - theeth
+        */
+       int                     reserved1;
        int                     reserved2;
        int                     flags;
        int                     pad;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bTrackToConstraint;
 
 /* Copy Rotation Constraint */
@@ -210,7 +274,8 @@ typedef struct bRotateLikeConstraint {
        struct Object           *tar;
        int                     flag;
        int                     reserved1;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bRotateLikeConstraint;
 
 /* Copy Location Constraint */
@@ -218,7 +283,8 @@ typedef struct bLocateLikeConstraint {
        struct Object           *tar;
        int                     flag;
        int                     reserved1;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bLocateLikeConstraint;
 
 /* Copy Scale Constraint */
@@ -226,7 +292,8 @@ typedef struct bSizeLikeConstraint {
        struct Object           *tar;
        int                     flag;
        int                     reserved1;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bSizeLikeConstraint;
 
 /* Maintain Volume Constraint */
@@ -238,7 +305,8 @@ typedef struct bSameVolumeConstraint {
 /* Copy Transform Constraint */
 typedef struct bTransLikeConstraint {
        struct Object *tar;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bTransLikeConstraint;
 
 /* Floor Constraint */
@@ -247,23 +315,28 @@ typedef struct bMinMaxConstraint {
        int                     minmaxflag;
        float           offset;
        int                     flag;
-       short           sticky, stuck, pad1, pad2; /* for backward compatibility */
+       /** For backward compatibility. */
+       short           sticky, stuck, pad1, pad2;
        float           cache[3];
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bMinMaxConstraint;
 
 /* Action Constraint */
 typedef struct bActionConstraint {
        struct Object           *tar;
-       short           type;   /* what transform 'channel' drives the result */
-       short           local;  /* was used in versions prior to the Constraints recode */
+       /** What transform 'channel' drives the result. */
+       short           type;
+       /** Was used in versions prior to the Constraints recode. */
+       short           local;
        int                     start;
        int                     end;
        float           min;
        float           max;
        int                     flag;
        struct bAction  *act;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bActionConstraint;
 
 /* Locked Axis Tracking constraint */
@@ -271,7 +344,8 @@ typedef struct bLockTrackConstraint {
        struct Object           *tar;
        int                     trackflag;
        int                     lockflag;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bLockTrackConstraint;
 
 /* Damped Tracking constraint */
@@ -279,15 +353,19 @@ typedef struct bDampTrackConstraint {
        struct Object           *tar;
        int                     trackflag;
        int                     pad;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bDampTrackConstraint;
 
 /* Follow Path constraints */
 typedef struct bFollowPathConstraint {
-       struct Object           *tar;           /* Must be path object */
+       /** Must be path object. */
+       struct Object           *tar;
 
-       float           offset;                 /* Offset in time on the path (in frames), when NOT using 'fixed position' */
-       float           offset_fac;             /* Parametric offset factor defining position along path, when using 'fixed position' */
+       /** Offset in time on the path (in frames), when NOT using 'fixed position'. */
+       float           offset;
+       /** Parametric offset factor defining position along path, when using 'fixed position'. */
+       float           offset_fac;
 
        int                     followflag;
 
@@ -306,7 +384,8 @@ typedef struct bStretchToConstraint {
        float           bulge_min;
        float           bulge_max;
        float           bulge_smooth;
-       char            subtarget[64];  /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bStretchToConstraint;
 
 /* Rigid Body constraint */
@@ -331,42 +410,63 @@ typedef struct bRigidBodyJointConstraint {
 
 /* Clamp-To Constraint */
 typedef struct bClampToConstraint {
-       struct Object           *tar;                   /* 'target' must be a curve */
-       int                     flag;                   /* which axis/plane to compare owner's location on  */
-       int                     flag2;                  /* for legacy reasons, this is flag2. used for any extra settings */
+       /** 'target' must be a curve. */
+       struct Object           *tar;
+       /** Which axis/plane to compare owner's location on . */
+       int                     flag;
+       /** For legacy reasons, this is flag2. used for any extra settings. */
+       int                     flag2;
 } bClampToConstraint;
 
 /* Child Of Constraint */
 typedef struct bChildOfConstraint {
-       struct Object           *tar;                   /* object which will act as parent (or target comes from) */
-       int             flag;                   /* settings */
+       /** Object which will act as parent (or target comes from). */
+       struct Object           *tar;
+       /** Settings. */
+       int             flag;
        int                     pad;
-       float           invmat[4][4];   /* parent-inverse matrix to use */
-       char            subtarget[64];  /* string to specify a subobject target, MAX_ID_NAME-2 */
+       /** Parent-inverse matrix to use. */
+       float           invmat[4][4];
+       /** String to specify a subobject target, MAX_ID_NAME-2. */
+       char            subtarget[64];
 } bChildOfConstraint;
 
 /* Generic Transform->Transform Constraint */
 typedef struct bTransformConstraint {
-       struct Object           *tar;                   /* target (i.e. 'driver' object/bone) */
-       char            subtarget[64];          /* MAX_ID_NAME-2 */
-
-       short           from, to;               /* can be loc(0), rot(1) or size(2) */
-       char            map[3];                 /* defines which target-axis deform is copied by each owner-axis */
-       char            expo;                   /* extrapolate motion? if 0, confine to ranges */
-
-       float           from_min[3];    /* from_min/max defines range of target transform */
-       float           from_max[3];    /* to map on to to_min/max range. */
-       float           to_min[3];              /* range of motion on owner caused by target  */
+       /** Target (i.e. 'driver' object/bone). */
+       struct Object           *tar;
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
+
+       /** Can be loc(0), rot(1) or size(2). */
+       short           from, to;
+       /** Defines which target-axis deform is copied by each owner-axis. */
+       char            map[3];
+       /** Extrapolate motion? if 0, confine to ranges. */
+       char            expo;
+
+       /** From_min/max defines range of target transform. */
+       float           from_min[3];
+       /** To map on to to_min/max range. */
+       float           from_max[3];
+       /** Range of motion on owner caused by target . */
+       float           to_min[3];
        float           to_max[3];
 
-       float           from_min_rot[3];        /* from_min/max defines range of target transform */
-       float           from_max_rot[3];        /* to map on to to_min/max range. */
-       float           to_min_rot[3];          /* range of motion on owner caused by target  */
+       /** From_min/max defines range of target transform. */
+       float           from_min_rot[3];
+       /** To map on to to_min/max range. */
+       float           from_max_rot[3];
+       /** Range of motion on owner caused by target . */
+       float           to_min_rot[3];
        float           to_max_rot[3];
 
-       float           from_min_scale[3];      /* from_min/max defines range of target transform */
-       float           from_max_scale[3];      /* to map on to to_min/max range. */
-       float           to_min_scale[3];        /* range of motion on owner caused by target  */
+       /** From_min/max defines range of target transform. */
+       float           from_min_scale[3];
+       /** To map on to to_min/max range. */
+       float           from_max_scale[3];
+       /** Range of motion on owner caused by target . */
+       float           to_min_scale[3];
        float           to_max_scale[3];
 } bTransformConstraint;
 
@@ -375,17 +475,22 @@ typedef struct bPivotConstraint {
        /* Pivot Point:
         * Either target object + offset, or just offset is used
         */
-       struct Object           *tar;                   /* target object (optional) */
-       char            subtarget[64];          /* subtarget name (optional), MAX_ID_NAME-2 */
-       float           offset[3];              /* offset from the target to use, regardless of whether it exists */
+       /** Target object (optional). */
+       struct Object           *tar;
+       /** Subtarget name (optional), MAX_ID_NAME-2. */
+       char            subtarget[64];
+       /** Offset from the target to use, regardless of whether it exists. */
+       float           offset[3];
 
        /* Rotation-driven activation:
         * This option provides easier one-stop setups for footrolls
         */
-       short           rotAxis;                /* rotation axes to consider for this (ePivotConstraint_Axis) */
+       /** Rotation axes to consider for this (ePivotConstraint_Axis). */
+       short           rotAxis;
 
        /* General flags */
-       short           flag;                   /* ePivotConstraint_Flag */
+       /** EPivotConstraint_Flag. */
+       short           flag;
 } bPivotConstraint;
 
 /* transform limiting constraints - zero target ----------------------------  */
@@ -419,37 +524,52 @@ typedef struct bSizeLimitConstraint {
 /* Limit Distance Constraint */
 typedef struct bDistLimitConstraint {
        struct Object           *tar;
-       char            subtarget[64];          /* MAX_ID_NAME-2 */
+       /** MAX_ID_NAME-2. */
+       char            subtarget[64];
 
-       float           dist;                   /* distance (radius of clamping sphere) from target */
-       float           soft;                   /* distance from clamping-sphere to start applying 'fade' */
+       /** Distance (radius of clamping sphere) from target. */
+       float           dist;
+       /** Distance from clamping-sphere to start applying 'fade'. */
+       float           soft;
 
-       short           flag;                   /* settings */
-       short           mode;                   /* how to limit in relation to clamping sphere */
+       /** Settings. */
+       short           flag;
+       /** How to limit in relation to clamping sphere. */
+       short           mode;
        int             pad;
 } bDistLimitConstraint;
 
 /* ShrinkWrap Constraint */
 typedef struct bShrinkwrapConstraint {
        struct Object           *target;
-       float           dist;                   /* distance to kept from target */
-       short           shrinkType;             /* shrink type (look on MOD shrinkwrap for values) */
-       char            projAxis;               /* axis to project/constrain */
-       char            projAxisSpace;  /* space to project axis in */
-       float           projLimit;              /* distance to search */
-       char            shrinkMode;             /* inside/outside/on surface (see MOD shrinkwrap) */
-       char            flag;                   /* options */
-       char            trackAxis;              /* axis to align to normal */
+       /** Distance to kept from target. */
+       float           dist;
+       /** Shrink type (look on MOD shrinkwrap for values). */
+       short           shrinkType;
+       /** Axis to project/constrain. */
+       char            projAxis;
+       /** Space to project axis in. */
+       char            projAxisSpace;
+       /** Distance to search. */
+       float           projLimit;
+       /** Inside/outside/on surface (see MOD shrinkwrap). */
+       char            shrinkMode;
+       /** Options. */
+       char            flag;
+       /** Axis to align to normal. */
+       char            trackAxis;
        char            pad;
 } bShrinkwrapConstraint;
 
 /* Follow Track constraints */
 typedef struct bFollowTrackConstraint {
        struct MovieClip        *clip;
-       char    track[64];      /* MAX_NAME */
+       /** MAX_NAME. */
+       char    track[64];
        int             flag;
        int             frame_method;
-       char            object[64];     /* MAX_NAME */
+       /** MAX_NAME. */
+       char            object[64];
        struct Object *camera;
        struct Object *depth_ob;
 } bFollowTrackConstraint;
@@ -464,8 +584,10 @@ typedef struct bCameraSolverConstraint {
 typedef struct bObjectSolverConstraint {
        struct MovieClip        *clip;
        int             flag, pad;
-       char            object[64];     /* MAX_NAME */
-       float           invmat[4][4];   /* parent-inverse matrix to use */
+       /** MAX_NAME. */
+       char            object[64];
+       /** Parent-inverse matrix to use. */
+       float           invmat[4][4];
        struct Object *camera;
 } bObjectSolverConstraint;
 
@@ -473,7 +595,8 @@ typedef struct bObjectSolverConstraint {
 typedef struct bTransformCacheConstraint {
        struct CacheFile *cache_file;
        struct CacheReader *reader;
-       char object_path[1024];  /* FILE_MAX */
+       /** FILE_MAX. */
+       char object_path[1024];
 } bTransformCacheConstraint;
 
 /* ------------------------------------------ */
index 0cf60a9..4016332 100644 (file)
@@ -53,7 +53,8 @@ struct GHash;
 #
 #
 typedef struct PathPoint {
-       float vec[4]; /* grr, cant get rid of tilt yet */
+       /** Grr, cant get rid of tilt yet. */
+       float vec[4];
        float quat[4];
        float radius, weight;
 } PathPoint;
@@ -72,8 +73,10 @@ typedef struct Path {
 #
 typedef struct BevPoint {
        float vec[3], alfa, radius, weight, offset;
-       float sina, cosa;                               /* 2D Only */
-       float dir[3], tan[3], quat[4];  /* 3D Only */
+       /** 2D Only. */
+       float sina, cosa;
+       /** 3D Only. */
+       float dir[3], tan[3], quat[4];
        short split_tag, dupe_tag;
 } BevPoint;
 
@@ -109,29 +112,41 @@ typedef struct BevList {
  */
 typedef struct BezTriple {
        float vec[3][3];
-       float alfa, weight, radius;     /* alfa: tilt in 3D View, weight: used for softbody goal weight, radius: for bevel tapering */
+       /** Alfa: tilt in 3D View, weight: used for softbody goal weight, radius: for bevel tapering. */
+       float alfa, weight, radius;
 
-       char ipo;                                       /* ipo: interpolation mode for segment from this BezTriple to the next */
+       /** Ipo: interpolation mode for segment from this BezTriple to the next. */
+       char ipo;
 
-       char h1, h2;                            /* h1, h2: the handle type of the two handles */
-       char f1, f2, f3;                        /* f1, f2, f3: used for selection status */
+       /** H1, h2: the handle type of the two handles. */
+       char h1, h2;
+       /** F1, f2, f3: used for selection status. */
+       char f1, f2, f3;
 
-       char hide;                                      /* hide: used to indicate whether BezTriple is hidden (3D), type of keyframe (eBezTriple_KeyframeType) */
+       /** Hide: used to indicate whether BezTriple is hidden (3D), type of keyframe (eBezTriple_KeyframeType). */
+       char hide;
 
-       char easing;                            /* easing: easing type for interpolation mode (eBezTriple_Easing) */
-       float back;                                     /* BEZT_IPO_BACK */
-       float amplitude, period;        /* BEZT_IPO_ELASTIC */
+       /** Easing: easing type for interpolation mode (eBezTriple_Easing). */
+       char easing;
+       /** BEZT_IPO_BACK. */
+       float back;
+       /** BEZT_IPO_ELASTIC. */
+       float amplitude, period;
 
-       char f5;                                        /* f5: used for auto handle to distinguish between normal handle and exception (extrema) */
+       /** F5: used for auto handle to distinguish between normal handle and exception (extrema). */
+       char f5;
        char  pad[3];
 } BezTriple;
 
 /* note; alfa location in struct is abused by Key system */
 typedef struct BPoint {
        float vec[4];
-       float alfa, weight;             /* alfa: tilt in 3D View, weight: used for softbody goal weight */
-       short f1, hide;                 /* f1: selection status,  hide: is point hidden or not */
-       float radius, pad;              /* user-set radius per point for beveling etc */
+       /** Alfa: tilt in 3D View, weight: used for softbody goal weight. */
+       float alfa, weight;
+       /** F1: selection status,  hide: is point hidden or not. */
+       short f1, hide;
+       /** User-set radius per point for beveling etc. */
+       float radius, pad;
 } BPoint;
 
 /**
@@ -139,13 +154,17 @@ typedef struct BPoint {
  * also, it should be NURBS (Nurb isn't the singular of Nurbs).
  */
 typedef struct Nurb {
-       struct Nurb *next, *prev;       /* multiple nurbs per curve object are allowed */
+       /** Multiple nurbs per curve object are allowed. */
+       struct Nurb *next, *prev;
        short type;
-       short mat_nr;           /* index into material list */
+       /** Index into material list. */
+       short mat_nr;
        short hide, flag;
-       int pntsu, pntsv;               /* number of points in the U or V directions */
+       /** Number of points in the U or V directions. */
+       int pntsu, pntsv;
        short pad[2];
-       short resolu, resolv;   /* tessellation resolution in the U or V directions */
+       /** Tessellation resolution in the U or V directions. */
+       short resolu, resolv;
        short orderu, orderv;
        short flagu, flagv;
 
@@ -153,7 +172,8 @@ typedef struct Nurb {
        BPoint *bp;
        BezTriple *bezt;
 
-       short tilt_interp;      /* KEY_LINEAR, KEY_CARDINAL, KEY_BSPLINE */
+       /** KEY_LINEAR, KEY_CARDINAL, KEY_BSPLINE. */
+       short tilt_interp;
        short radius_interp;
 
        /* only used for dynamically generated Nurbs created from OB_FONT's */
@@ -162,7 +182,8 @@ typedef struct Nurb {
 
 typedef struct CharInfo {
        short kern;
-       short mat_nr; /* index start at 1, unlike mesh & nurbs */
+       /** Index start at 1, unlike mesh & nurbs. */
+       short mat_nr;
        char flag;
        char pad;
        short pad2;
@@ -187,16 +208,20 @@ typedef struct EditNurb {
 
 typedef struct Curve {
        ID id;
-       struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
 
        struct BoundBox *bb;
 
-       ListBase nurb;          /* actual data, called splines in rna */
+       /** Actual data, called splines in rna. */
+       ListBase nurb;
 
-       EditNurb *editnurb;     /* edited data, not in file, use pointer so we can check for it */
+       /** Edited data, not in file, use pointer so we can check for it. */
+       EditNurb *editnurb;
 
        struct Object *bevobj, *taperobj, *textoncurve;
-       struct Ipo *ipo    DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo    DNA_DEPRECATED;
        struct Key *key;
        struct Material **mat;
 
@@ -205,9 +230,11 @@ typedef struct Curve {
        float size[3];
        float rot[3];
 
-       short type;     /* creation-time type of curve datablock */
+       /** Creation-time type of curve datablock. */
+       short type;
 
-       short texflag; /* keep a short because of BKE_object_obdata_texspace_get() */
+       /** Keep a short because of BKE_object_obdata_texspace_get(). */
+       short texflag;
        short drawflag, twist_mode;
        float twist_smooth, smallcaps_scale;
 
@@ -241,8 +268,10 @@ typedef struct Curve {
        int selstart, selend;
 
        /* text data */
-       int len_wchar;  /* number of characters (strinfo) */
-       int len;        /* number of bytes (str - utf8) */
+       /** Number of characters (strinfo). */
+       int len_wchar;
+       /** Number of bytes (str - utf8). */
+       int len;
        char *str;
        struct EditFont *editfont;
 
@@ -260,7 +289,8 @@ typedef struct Curve {
        /* font part end */
 
 
-       float ctime;                    /* current evaltime - for use by Objects parented to curves */
+       /** Current evaltime - for use by Objects parented to curves. */
+       float ctime;
        float bevfac1, bevfac2;
        char bevfac1_mapping, bevfac2_mapping;
 
index 0e0b1d6..7085daf 100644 (file)
@@ -40,37 +40,56 @@ extern "C" {
 
 /** descriptor and storage for a custom data layer */
 typedef struct CustomDataLayer {
-       int type;       /* type of data in layer */
-       int offset;     /* in editmode, offset of layer in block */
-       int flag;       /* general purpose flag */
-       int active;     /* number of the active layer of this type */
-       int active_rnd; /* number of the layer to render*/
-       int active_clone; /* number of the layer to render*/
-       int active_mask; /* number of the layer to render*/
-       int uid;        /* shape keyblock unique id reference*/
-       char name[64];  /* layer name, MAX_CUSTOMDATA_LAYER_NAME */
-       void *data;     /* layer data */
+       /** Type of data in layer. */
+       int type;
+       /** In editmode, offset of layer in block. */
+       int offset;
+       /** General purpose flag. */
+       int flag;
+       /** Number of the active layer of this type. */
+       int active;
+       /** Number of the layer to rende.r*/
+       int active_rnd;
+       /** Number of the layer to rende.r*/
+       int active_clone;
+       /** Number of the layer to rende.r*/
+       int active_mask;
+       /** Shape keyblock unique id referenc.e*/
+       int uid;
+       /** Layer name, MAX_CUSTOMDATA_LAYER_NAME. */
+       char name[64];
+       /** Layer data. */
+       void *data;
 } CustomDataLayer;
 
 #define MAX_CUSTOMDATA_LAYER_NAME 64
 
 typedef struct CustomDataExternal {
-       char filename[1024]; /* FILE_MAX */
+       /** FILE_MAX. */
+       char filename[1024];
 } CustomDataExternal;
 
 /** structure which stores custom element data associated with mesh elements
  * (vertices, edges or faces). The custom data is organized into a series of
  * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
 typedef struct CustomData {
-       CustomDataLayer *layers;      /* CustomDataLayers, ordered by type */
-       int typemap[42];              /* runtime only! - maps types to indices of first layer of that type,
-                                      * MUST be >= CD_NUMTYPES, but we cant use a define here.
-                                      * Correct size is ensured in CustomData_update_typemap assert() */
+       /** CustomDataLayers, ordered by type. */
+       CustomDataLayer *layers;
+       /**
+        * runtime only! - maps types to indices of first layer of that type,
+        * MUST be >= CD_NUMTYPES, but we cant use a define here.
+        * Correct size is ensured in CustomData_update_typemap assert().
+        */
+       int typemap[42];
        int pad_i1;
-       int totlayer, maxlayer;       /* number of layers, size of layers array */
-       int totsize;                  /* in editmode, total size of all data layers */
-       struct BLI_mempool *pool;     /* (BMesh Only): Memory pool for allocation of blocks */
-       CustomDataExternal *external; /* external file storing customdata layers */
+       /** Number of layers, size of layers array. */
+       int totlayer, maxlayer;
+       /** In editmode, total size of all data layers. */
+       int totsize;
+       /** (BMesh Only): Memory pool for allocation of blocks. */
+       struct BLI_mempool *pool;
+       /** External file storing customdata layers. */
+       CustomDataExternal *external;
 } CustomData;
 
 /* CustomData.type */
index 589135e..ddb93de 100644 (file)
@@ -101,7 +101,8 @@ enum {
 typedef struct DynamicPaintSurface {
 
        struct DynamicPaintSurface *next, *prev;
-       struct DynamicPaintCanvasSettings *canvas; /* for fast RNA access */
+       /** For fast RNA access. */
+       struct DynamicPaintCanvasSettings *canvas;
        struct PaintSurfaceData *data;
 
        struct Collection *brush_group;
@@ -116,8 +117,10 @@ typedef struct DynamicPaintSurface {
        char name[64];
        short format, type;
        short disp_type, image_fileformat;
-       short effect_ui;        /* ui selection box */
-       short preview_id;       /* surface output id to preview */
+       /** Ui selection box. */
+       short effect_ui;
+       /** Surface output id to preview. */
+       short preview_id;
        short init_color_type, pad_s;
        int flags, effect;
 
@@ -127,7 +130,8 @@ typedef struct DynamicPaintSurface {
        /* initial color */
        float init_color[4];
        struct Tex *init_texture;
-       char init_layername[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char init_layername[64];
 
        int dry_speed, diss_speed;
        float color_dry_threshold;
@@ -143,10 +147,14 @@ typedef struct DynamicPaintSurface {
        float wave_damping, wave_speed, wave_timescale, wave_spring, wave_smoothness;
        int pad2;
 
-       char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
-       char image_output_path[1024];  /* 1024 = FILE_MAX */
-       char output_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
-       char output_name2[64]; /* MAX_CUSTOMDATA_LAYER_NAME */ /* some surfaces have 2 outputs */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
+       /** 1024 = FILE_MAX. */
+       char image_output_path[1024];
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char output_name[64];
+       /** MAX_CUSTOMDATA_LAYER_NAME */ /* some surfaces have 2 outputs. */
+       char output_name2[64];
 
 } DynamicPaintSurface;
 
@@ -162,14 +170,16 @@ enum {
 
 /* Canvas settings */
 typedef struct DynamicPaintCanvasSettings {
-       struct DynamicPaintModifierData *pmd; /* for fast RNA access */
+       /** For fast RNA access. */
+       struct DynamicPaintModifierData *pmd;
        struct Mesh *mesh;
 
        struct ListBase surfaces;
        short active_sur, flags;
        int pad;
 
-       char error[64];         /* Bake error description */
+       /** Bake error description. */
+       char error[64];
 
 } DynamicPaintCanvasSettings;
 
@@ -228,7 +238,8 @@ enum {
 
 /* Brush settings */
 typedef struct DynamicPaintBrushSettings {
-       struct DynamicPaintModifierData *pmd; /* for fast RNA access */
+       /** For fast RNA access. */
+       struct DynamicPaintModifierData *pmd;
        struct Mesh *mesh;
        struct ParticleSystem *psys;
 
@@ -242,8 +253,10 @@ typedef struct DynamicPaintBrushSettings {
        float paint_distance;
 
        /* color ramps */
-       struct ColorBand *paint_ramp;   /* Proximity paint falloff */
-       struct ColorBand *vel_ramp;             /* Velocity paint ramp */
+       /** Proximity paint falloff. */
+       struct ColorBand *paint_ramp;
+       /** Velocity paint ramp. */
+       struct ColorBand *vel_ramp;
 
        short proximity_falloff;
        short wave_type;
index 373b158..2ad9c5f 100644 (file)
@@ -118,8 +118,10 @@ typedef struct PartEff {
        short staticstep, omat, timetex, speedtex, flag2, flag2neg;
        short disp, vertgroup_v;
 
-       char vgroupname[64], vgroupname_v[64];  /* MAX_VGROUP_NAME */
-       float imat[4][4];       /* inverse matrix of parent Object */
+       /** MAX_VGROUP_NAME. */
+       char vgroupname[64], vgroupname_v[64];
+       /** Inverse matrix of parent Object. */
+       float imat[4][4];
 
        Particle *keys;
        struct Collection *group;
index 24fb1c8..990817b 100644 (file)
@@ -37,7 +37,8 @@
  * the moment of saving, and the file-specific settings.
  */
 typedef struct FileGlobal {
-       char subvstr[4];                /* needs to be here, for human fileformat recognition */
+       /** Needs to be here, for human fileformat recognition. */
+       char subvstr[4];
        short subversion;
        short minversion, minsubversion;
        char pad[6];
@@ -48,10 +49,12 @@ typedef struct FileGlobal {
 
        int fileflags;
        int globalf;
-       uint64_t build_commit_timestamp;  /* commit timestamp from buildinfo */
-       char build_hash[16];  /* hash from buildinfo */
-       /* file path where this was saved, for recover */
-       char filename[1024]; /* 1024 = FILE_MAX */
+       /** Commit timestamp from buildinfo. */
+       uint64_t build_commit_timestamp;
+       /** Hash from buildinfo. */
+       char build_hash[16];
+       /** File path where this was saved, for recover (1024 = FILE_MAX). */
+       char filename[1024];
 } FileGlobal;
 
 
index 36cf151..9d76853 100644 (file)
@@ -116,16 +116,21 @@ enum {
 typedef struct FreestyleLineSet {
        struct FreestyleLineSet *next, *prev;
 
-       char name[64]; /* line set name, MAX_NAME */
+       /** Line set name, MAX_NAME. */
+       char name[64];
        int flags;
 
-       int selection; /* selection criteria */
-       short qi; /* quantitative invisibility */
+       /** Selection criteria. */
+       int selection;
+       /** Quantitative invisibility. */
+       short qi;
        short pad1;
        int qi_start, qi_end;
-       int edge_types, exclude_edge_types; /* feature edge types */
+       /** Feature edge types. */
+       int edge_types, exclude_edge_types;
        int pad2;
-       struct Collection *group; /* group of target objects */
+       /** Group of target objects. */
+       struct Collection *group;
 
        struct FreestyleLineStyle *linestyle;
 } FreestyleLineSet;
@@ -141,12 +146,15 @@ typedef struct FreestyleModuleConfig {
 typedef struct FreestyleConfig {
        ListBase modules;
 
-       int mode; /* scripting, editor */
+       /** Scripting, editor. */
+       int mode;
        int raycasting_algorithm  DNA_DEPRECATED;
-       int flags; /* suggestive contours, ridges/valleys, material boundaries */
+       /** Suggestive contours, ridges/valleys, material boundaries. */
+       int flags;
        float sphere_radius;
        float dkr_epsilon;
-       float crease_angle; /* in radians! */
+       /** In radians!. */
+       float crease_angle;
 
        ListBase linesets;
 } FreestyleConfig;
index 9e9ab97..d43b104 100644 (file)
 
 struct SDNA;
 
-/* DNAstr contains the prebuilt SDNA structure defining the layouts of the types
+/**
+ * DNAstr contains the prebuilt SDNA structure defining the layouts of the types
  * used by this version of Blender. It is defined in a file dna.c, which is
- * generated by the makesdna program during the build process (see makesdna.c). */
+ * generated by the makesdna program during the build process (see makesdna.c).
+ */
 extern const unsigned char DNAstr[];
-extern const int DNAlen; /* length of DNAstr */
+/** Length of DNAstr. */
+extern const int DNAlen;
 
 /**
  * Primitive (non-struct, non-pointer/function/array) types,
index 79ff156..35873ef 100644 (file)
@@ -74,24 +74,35 @@ typedef struct GpencilModifierData {
        int stackindex;
        short flag;
        short _pad;
-       char name[64];  /* MAX_NAME */
+       /** MAX_NAME. */
+       char name[64];
 
        char *error;
 } GpencilModifierData;
 
 typedef struct NoiseGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       char vgname[64];             /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* several flags */
-       float factor;                /* factor of noise */
-       int step;                    /* how many frames before recalculate randoms */
-       int gp_frame;                /* last gp frame used */
-       int scene_frame;             /* last scene frame used */
-       float vrand1, vrand2;        /* random values */
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Several flags. */
+       int flag;
+       /** Factor of noise. */
+       float factor;
+       /** How many frames before recalculate randoms. */
+       int step;
+       /** Last gp frame used. */
+       int gp_frame;
+       /** Last scene frame used. */
+       int scene_frame;
+       /** Random values. */
+       float vrand1, vrand2;
        struct RNG *rng;
-       int layer_pass;              /* custom index for passes */
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad[4];
 } NoiseGpencilModifierData;
 
@@ -111,11 +122,16 @@ typedef enum eNoiseGpencil_Flag {
 
 typedef struct SubdivGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
-       int level;                   /* factor of subdivision */
-       int layer_pass;              /* custom index for passes */
+       /** Layer name. */
+       char layername[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Factor of subdivision. */
+       int level;
+       /** Custom index for passes. */
+       int layer_pass;
 } SubdivGpencilModifierData;
 
 typedef enum eSubdivGpencil_Flag {
@@ -127,12 +143,18 @@ typedef enum eSubdivGpencil_Flag {
 
 typedef struct ThickGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       char vgname[64];             /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
-       int thickness;               /* Thickness change */
-       int layer_pass;              /* custom index for passes */
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Thickness change. */
+       int thickness;
+       /** Custom index for passes. */
+       int layer_pass;
        struct CurveMapping *curve_thickness;
 } ThickGpencilModifierData;
 
@@ -147,13 +169,18 @@ typedef enum eThickGpencil_Flag {
 
 typedef struct TimeGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       int layer_pass;               /* custom index for passes */
-       int flag;                    /* flags */
+       /** Layer name. */
+       char layername[64];
+       /** Custom index for passes. */
+       int layer_pass;
+       /** Flags. */
+       int flag;
        int offset;
-       float frame_scale;           /* animation scale */
+       /** Animation scale. */
+       float frame_scale;
        int mode;
-       int sfra, efra;             /* start and end frame for custom range */
+       /** Start and end frame for custom range. */
+       int sfra, efra;
        char _pad[4];
 } TimeGpencilModifierData;
 
@@ -179,14 +206,21 @@ typedef enum eModifyColorGpencil_Flag {
 
 typedef struct TintGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
-       float rgb[3];                /* Tint color */
-       float factor;                /* Mix factor */
-       char modify_color;           /* modify stroke, fill or both */
+       /** Layer name. */
+       char layername[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Tint color. */
+       float rgb[3];
+       /** Mix factor. */
+       float factor;
+       /** Modify stroke, fill or both. */
+       char modify_color;
        char _pad[7];
-       int layer_pass;              /* custom index for passes */
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad1[4];
 } TintGpencilModifierData;
 
@@ -199,13 +233,19 @@ typedef enum eTintGpencil_Flag {
 
 typedef struct ColorGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
-       float hsv[3];                /* hsv factors */
-       char modify_color;           /* modify stroke, fill or both */
+       /** Layer name. */
+       char layername[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Hsv factors. */
+       float hsv[3];
+       /** Modify stroke, fill or both. */
+       char modify_color;
        char _pad[3];
-       int layer_pass;              /* custom index for passes */
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad1[4];
 } ColorGpencilModifierData;
 
@@ -218,14 +258,21 @@ typedef enum eColorGpencil_Flag {
 
 typedef struct OpacityGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       char vgname[64];             /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
-       float factor;                /* Main Opacity factor */
-       char modify_color;                    /* modify stroke, fill or both */
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Main Opacity factor. */
+       float factor;
+       /** Modify stroke, fill or both. */
+       char modify_color;
        char _pad[3];
-       int layer_pass;              /* custom index for passes */
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad1[4];
 } OpacityGpencilModifierData;
 
@@ -240,21 +287,34 @@ typedef enum eOpacityGpencil_Flag {
 typedef struct ArrayGpencilModifierData {
        GpencilModifierData modifier;
        struct Object *object;
-       int count;                   /* number of elements in array */
-       int flag;                    /* several flags */
-       float offset[3];             /* Location increments */
-       float shift[3];              /* shift increment */
-       float rnd_size;              /* random size factor */
-       float rnd_rot;               /* random size factor */
-       float rot[3];                /* Rotation changes */
-       float scale[3];              /* Scale changes */
-       float rnd[20];               /* (first element is the index) random values */
+       /** Number of elements in array. */
+       int count;
+       /** Several flags. */
+       int flag;
+       /** Location increments. */
+       float offset[3];
+       /** Shift increment. */
+       float shift[3];
+       /** Random size factor. */
+       float rnd_size;
+       /** Random size factor. */
+       float rnd_rot;
+       /** Rotation changes. */
+       float rot[3];
+       /** Scale changes. */
+       float scale[3];
+       /** (first element is the index) random values. */
+       float rnd[20];
        char _pad[4];
 
-       int pass_index;              /* custom index for passes */
-       char layername[64];          /* layer name */
-       int mat_rpl;                 /* material replace (0 keep default) */
-       int layer_pass;              /* custom index for passes */
+       /** Custom index for passes. */
+       int pass_index;
+       /** Layer name. */
+       char layername[64];
+       /** Material replace (0 keep default). */
+       int mat_rpl;
+       /** Custom index for passes. */
+       int layer_pass;
 } ArrayGpencilModifierData;
 
 typedef enum eArrayGpencil_Flag {
@@ -269,23 +329,38 @@ typedef enum eArrayGpencil_Flag {
 typedef struct BuildGpencilModifierData {
        GpencilModifierData modifier;
 
-       char layername[64];   /* if set, restrict modifier to operating on this layer */
+       /** If set, restrict modifier to operating on this layer. */
+       char layername[64];
        int pass_index;
 
-       int layer_pass;       /* custom index for passes */
+       /** Custom index for passes. */
+       int layer_pass;
 
-       float start_frame;    /* If GP_BUILD_RESTRICT_TIME is set, the defines the frame range where GP frames are considered */
+       /**
+        * If GP_BUILD_RESTRICT_TIME is set,
+        * the defines the frame range where GP frames are considered.
+        */
+       float start_frame;
        float end_frame;
 
-       float start_delay;    /* For each pair of gp keys, number of frames before strokes start appearing */
-       float length;         /* For each pair of gp keys, number of frames that build effect must be completed within */
+       /** For each pair of gp keys, number of frames before strokes start appearing. */
+       float start_delay;
+       /** For each pair of gp keys, number of frames that build effect must be completed within. */
+       float length;
 
-       short flag;           /* (eGpencilBuild_Flag) Options for controlling modifier behavior */
+       /** (eGpencilBuild_Flag) Options for controlling modifier behavior. */
+       short flag;
 
-       short mode;           /* (eGpencilBuild_Mode) How are strokes ordered */
-       short transition;     /* (eGpencilBuild_Transition) In what order do stroke points appear/disappear */
+       /** (eGpencilBuild_Mode) How are strokes ordered. */
+       short mode;
+       /** (eGpencilBuild_Transition) In what order do stroke points appear/disappear. */
+       short transition;
 
-       short time_alignment; /* (eGpencilBuild_TimeAlignment) For the "Concurrent" mode, when should "shorter" strips start/end */
+       /**
+        * (eGpencilBuild_TimeAlignment)
+        * For the "Concurrent" mode, when should "shorter" strips start/end.
+        */
+       short time_alignment;
 } BuildGpencilModifierData;
 
 typedef enum eBuildGpencil_Mode {
@@ -326,13 +401,19 @@ typedef enum eBuildGpencil_Flag {
 typedef struct LatticeGpencilModifierData {
        GpencilModifierData modifier;
        struct Object *object;
-       char layername[64];          /* layer name */
-       char vgname[64];             /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
        float strength;
-       int layer_pass;              /* custom index for passes */
-       void *cache_data; /* runtime only (LatticeDeformData) */
+       /** Custom index for passes. */
+       int layer_pass;
+       /** Runtime only (LatticeDeformData). */
+       void *cache_data;
 } LatticeGpencilModifierData;
 
 typedef enum eLatticeGpencil_Flag {
@@ -345,10 +426,14 @@ typedef enum eLatticeGpencil_Flag {
 typedef struct MirrorGpencilModifierData {
        GpencilModifierData modifier;
        struct Object *object;
-       char layername[64];          /* layer name */
-       int pass_index;              /* custom index for passes */
-       int flag;                    /* flags */
-       int layer_pass;              /* custom index for passes */
+       /** Layer name. */
+       char layername[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad[4];
 } MirrorGpencilModifierData;
 
@@ -366,19 +451,28 @@ typedef struct HookGpencilModifierData {
        GpencilModifierData modifier;
 
        struct Object *object;
-       char subtarget[64];     /* optional name of bone target, MAX_ID_NAME-2 */
-       char layername[64];     /* layer name */
-       char vgname[64];        /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;         /* custom index for passes */
-       int layer_pass;              /* custom index for passes */
+       /** Optional name of bone target, MAX_ID_NAME-2. */
+       char subtarget[64];
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad[4];
 
        int flag;
-       char falloff_type;      /* use enums from WarpGpencilModifier (exact same functionality) */
+       /** Use enums from WarpGpencilModifier (exact same functionality). */
+       char falloff_type;
        char _pad1[3];
-       float parentinv[4][4];  /* matrix making current transform unmodified */
-       float cent[3];          /* visualization of hook */
-       float falloff;          /* if not zero, falloff is distance where influence zero */
+       /** Matrix making current transform unmodified. */
+       float parentinv[4][4];
+       /** Visualization of hook. */
+       float cent[3];
+       /** If not zero, falloff is distance where influence zero. */
+       float falloff;
        float force;
        struct CurveMapping *curfalloff;
 } HookGpencilModifierData;
@@ -405,13 +499,20 @@ typedef enum eHookGpencil_Falloff {
 
 typedef struct SimplifyGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
-       float factor;                /* factor of simplify */
-       short mode;                  /* type of simplify */
-       short step;                  /* every n vertex to keep */
-       int layer_pass;              /* custom index for passes */
+       /** Layer name. */
+       char layername[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
+       /** Factor of simplify. */
+       float factor;
+       /** Type of simplify. */
+       short mode;
+       /** Every n vertex to keep. */
+       short step;
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad[4];
 } SimplifyGpencilModifierData;
 
@@ -430,14 +531,19 @@ typedef enum eSimplifyGpencil_Mode {
 
 typedef struct OffsetGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       char vgname[64];             /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;               /* custom index for passes */
-       int flag;                    /* flags */
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Flags. */
+       int flag;
        float loc[3];
        float rot[3];
        float scale[3];
-       int layer_pass;              /* custom index for passes */
+       /** Custom index for passes. */
+       int layer_pass;
 } OffsetGpencilModifierData;
 
 typedef enum eOffsetGpencil_Flag {
@@ -449,13 +555,20 @@ typedef enum eOffsetGpencil_Flag {
 
 typedef struct SmoothGpencilModifierData {
        GpencilModifierData modifier;
-       char layername[64];          /* layer name */
-       char vgname[64];             /* optional vertexgroup name, MAX_VGROUP_NAME */
-       int pass_index;              /* custom index for passes */
-       int flag;                    /* several flags */
-       float factor;                /* factor of noise */
-       int step;                    /* how many times apply smooth */
-       int layer_pass;              /* custom index for passes */
+       /** Layer name. */
+       char layername[64];
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgname[64];
+       /** Custom index for passes. */
+       int pass_index;
+       /** Several flags. */
+       int flag;
+       /** Factor of noise. */
+       float factor;
+       /** How many times apply smooth. */
+       int step;
+       /** Custom index for passes. */
+       int layer_pass;
        char _pad[4];
 } SmoothGpencilModifierData;
 
@@ -472,11 +585,14 @@ typedef enum eSmoothGpencil_Flag {
 
 typedef struct ArmatureGpencilModifierData {
        GpencilModifierData modifier;
-       short deformflag, multi;  /* deformflag replaces armature->deformflag */
+       /** Deformflag replaces armature->deformflag. */
+       short deformflag, multi;
        int _pad;
        struct Object *object;
-       float *prevCos;           /* stored input of previous modifier, for vertexgroup blending */
-       char vgname[64];         /* MAX_VGROUP_NAME */
+       /** Stored input of previous modifier, for vertexgroup blending. */
+       float *prevCos;
+       /** MAX_VGROUP_NAME. */
+       char vgname[64];
 
 } ArmatureGpencilModifierData;
 
index b841aba..0ae1937 100644 (file)
@@ -50,9 +50,12 @@ struct MDeformVert;
 
 /* 'Control Point' data for primitives and curves */
 typedef struct bGPDcontrolpoint {
-       float x, y, z;          /* x and y coordinates of control point */
-       float color[4];         /* point color */
-       int size;               /* radius */
+       /** X and y coordinates of control point. */
+       float x, y, z;
+       /** Point color. */
+       float color[4];
+       /** Radius. */
+       int size;
 } bGPDcontrolpoint;
 
 /* Grease-Pencil Annotations - 'Stroke Point'
@@ -61,14 +64,21 @@ typedef struct bGPDcontrolpoint {
  *    This assumes that the bottom-left corner is (0,0)
  */
 typedef struct bGPDspoint {
-       float x, y, z;                  /* co-ordinates of point (usually 2d, but can be 3d as well) */
-       float pressure;                 /* pressure of input device (from 0 to 1) at this point */
-       float strength;                 /* color strength (used for alpha factor) */
-       float time;                             /* seconds since start of stroke */
-       int flag;                               /* additional options */
-
-       float uv_fac;           /* factor of uv along the stroke */
-       float uv_rot;           /* uv rotation for dot mode */
+       /** Co-ordinates of point (usually 2d, but can be 3d as well). */
+       float x, y, z;
+       /** Pressure of input device (from 0 to 1) at this point. */
+       float pressure;
+       /** Color strength (used for alpha factor). */
+       float strength;
+       /** Seconds since start of stroke. */
+       float time;
+       /** Additional options. */
+       int flag;
+
+       /** Factor of uv along the stroke. */
+       float uv_fac;
+       /** Uv rotation for dot mode. */
+       float uv_rot;
 } bGPDspoint;
 
 /* bGPDspoint->flag */
@@ -104,11 +114,15 @@ typedef struct bGPDtriangle {
 /* color of palettes */
 typedef struct bGPDpalettecolor {
        struct bGPDpalettecolor *next, *prev;
-       char info[64];           /* Color name. Must be unique. */
+       /** Color name. Must be unique. */
+       char info[64];
        float color[4];
-       float fill[4];           /* color that should be used for drawing "fills" for strokes */
-       short flag;              /* settings for palette color */
-       char  _pad[6];           /* padding for compiler alignment error */
+       /** Color that should be used for drawing "fills" for strokes. */
+       float fill[4];
+       /** Settings for palette color. */
+       short flag;
+       /** Padding for compiler alignment error. */
+       char  _pad[6];
 } bGPDpalettecolor;
 
 /* bGPDpalettecolor->flag */
@@ -129,12 +143,13 @@ typedef enum eGPDpalettecolor_Flag {
 typedef struct bGPDpalette {
        struct bGPDpalette *next, *prev;
 
-       /* pointer to individual colours */
+       /** Pointer to individual colours. */
        ListBase colors;
-       char info[64];          /* Palette name. Must be unique. */
+       /** Palette name. Must be unique. */
+       char info[64];
 
        short flag;
-       char _pad[6];           /* padding for compiler alignment error */
+       char _pad[6];
 } bGPDpalette;
 
 /* bGPDpalette->flag */
@@ -155,7 +170,8 @@ typedef struct bGPDstroke_Runtime {
        /* temporary layer name only used during copy/paste to put the stroke in the original layer */
        char tmp_layerinfo[128];
 
-       float multi_frame_falloff; /* runtime falloff factor (only for transform) */
+       /** Runtime falloff factor (only for transform). */
+       float multi_frame_falloff;
 } bGPDstroke_Runtime;
 
 /* Grease-Pencil Annotations - 'Stroke'
@@ -165,22 +181,32 @@ typedef struct bGPDstroke_Runtime {
 typedef struct bGPDstroke {
        struct bGPDstroke *next, *prev;
 
-       bGPDspoint *points;             /* array of data-points for stroke */
-       bGPDtriangle *triangles;/* tessellated triangles for GP Fill */
-       int totpoints;          /* number of data-points in array */
-       int tot_triangles;      /* number of triangles in array */
+       /** Array of data-points for stroke. */
+       bGPDspoint *points;
+       /** Tessellated triangles for GP Fill. */
+       bGPDtriangle *triangles;
+       /** Number of data-points in array. */
+       int totpoints;
+       /** Number of triangles in array. */
+       int tot_triangles;
 
-       short thickness;        /* thickness of stroke */
-       short flag, _pad[2];    /* various settings about this stroke */
+       /** Thickness of stroke. */
+       short thickness;
+       /** Various settings about this stroke. */
+       short flag, _pad[2];
 
-       double inittime;                /* Init time of stroke */
+       /** Init time of stroke. */
+       double inittime;
 
-       char colorname[128] DNA_DEPRECATED;    /* color name */
+       /** Color name. */
+       char colorname[128] DNA_DEPRECATED;
 
-       int mat_nr;             /* material index */
+       /** Material index. */
+       int mat_nr;
        char _pad1[4];
 
-       struct MDeformVert *dvert;    /* vertex weight data */
+       /** Vertex weight data. */
+       struct MDeformVert *dvert;
 
        bGPDstroke_Runtime runtime;
        char _pad2[4];
@@ -211,7 +237,8 @@ typedef enum eGPDstroke_Flag {
 
 /* Runtime temp data for bGPDframe */
 typedef struct bGPDframe_Runtime {
-       float viewmatrix[4][4];     /* parent matrix for drawing */
+       /** Parent matrix for drawing. */
+       float viewmatrix[4][4];
 } bGPDframe_Runtime;
 
 /* Grease-Pencil Annotations - 'Frame'
@@ -220,12 +247,16 @@ typedef struct bGPDframe_Runtime {
 typedef struct bGPDframe {
        struct bGPDframe *next, *prev;
 
-       ListBase strokes;       /* list of the simplified 'strokes' that make up the frame's data */
+       /** List of the simplified 'strokes' that make up the frame's data. */
+       ListBase strokes;
 
-       int framenum;           /* frame number of this frame */
+       /** Frame number of this frame. */
+       int framenum;
 
-       short flag;                     /* temp settings */
-       short key_type;         /* keyframe type (eBezTriple_KeyframeType) */
+       /** Temp settings. */
+       short flag;
+       /** Keyframe type (eBezTriple_KeyframeType). */
+       short key_type;
 
        bGPDframe_Runtime runtime;
 } bGPDframe;
@@ -243,7 +274,8 @@ typedef enum eGPDframe_Flag {
 
 /* Runtime temp data for bGPDlayer */
 typedef struct bGPDlayer_Runtime {
-       int icon_id;                    /* id for dynamic icon used to show annotation color preview for layer */
+       /** Id for dynamic icon used to show annotation color preview for layer. */
+       int icon_id;
        char _pad[4];
 } bGPDlayer_Runtime;
 
@@ -251,40 +283,67 @@ typedef struct bGPDlayer_Runtime {
 typedef struct bGPDlayer {
        struct bGPDlayer *next, *prev;
 
-       ListBase frames;                /* list of annotations to display for frames (bGPDframe list) */
-       bGPDframe *actframe;    /* active frame (should be the frame that is currently being displayed) */
-
-       short flag;                             /* settings for layer */
-       short onion_flag;               /* Per-layer onion-skinning flags (eGPDlayer_OnionFlag) */
-
-       float color[4];                 /* Color for strokes in layers. Used for annotations, and for ruler (which uses GPencil internally) */
-       float fill[4];                  /* Fill color for strokes in layers. Not used anymore (was only for) */
-
-       char info[128];                 /* name/reference info for this layer (i.e. "director's comments, 12/3")
-                                                        * needs to be kept unique, as it's used as the layer identifier */
+       /** List of annotations to display for frames (bGPDframe list). */
+       ListBase frames;
+       /** Active frame (should be the frame that is currently being displayed). */
+       bGPDframe *actframe;
 
-       short thickness;                /* thickness to apply to strokes (Annotations) */
-       short pass_index;       /* used to filter groups of layers in modifiers */
+       /** Settings for layer. */
+       short flag;
+       /** Per-layer onion-skinning flags (eGPDlayer_OnionFlag). */
+       short onion_flag;
 
-       struct Object *parent;  /* parent object */
-       float inverse[4][4];    /* inverse matrix (only used if parented) */
-       char parsubstr[64];     /* String describing subobject info, MAX_ID_NAME-2 */
+       /** Color for strokes in layers. Used for annotations, and for ruler (which uses GPencil internally). */
+       float color[4];
+       /** Fill color for strokes in layers. Not used anymore (was only for). */
+       float fill[4];
+
+       /** Name/reference info for this layer (i.e. "director's comments, 12/.3")
+        * needs to be kept unique, as it's used as the layer identifier */
+       char info[128];
+
+       /** Thickness to apply to strokes (Annotations). */
+       short thickness;
+       /** Used to filter groups of layers in modifiers. */
+       short pass_index;
+
+       /** Parent object. */
+       struct Object *parent;
+       /** Inverse matrix (only used if parented). */
+       float inverse[4][4];
+       /** String describing subobject info, MAX_ID_NAME-2. */
+       char parsubstr[64];
        short partype;
 
-       short line_change;      /* Thickness adjustment */
-       float tintcolor[4];     /* Color used to tint layer, alpha value is used as factor */
-       float opacity;          /* Opacity of the layer */
-       char viewlayername[64]; /* Name of the layer used to filter render output */
-
-       int blend_mode;         /* blend modes */
+       /** Thickness adjustment. */
+       short line_change;
+       /** Color used to tint layer, alpha value is used as factor. */
+       float tintcolor[4];
+       /** Opacity of the layer. */
+       float opacity;
+       /** Name of the layer used to filter render output. */
+       char viewlayername[64];
+
+       /** Blend modes. */
+       int blend_mode;
        char _pad[4];
 
        /* annotation onion skin */
-       short gstep;                    /* Ghosts Before: max number of ghost frames to show between active frame and the one before it (0 = only the ghost itself) */
-       short gstep_next;               /* Ghosts After:  max number of ghost frames to show after active frame and the following it    (0 = only the ghost itself) */
+       /**
+        * Ghosts Before: max number of ghost frames to show between
+        * active frame and the one before it (0 = only the ghost itself).
+        */
+       short gstep;
+       /**
+        * Ghosts After: max number of ghost frames to show after
+        * active frame and the following it    (0 = only the ghost itself).
+        */
+       short gstep_next;
 
-       float gcolor_prev[3];   /* color for ghosts before the active frame */
-       float gcolor_next[3];   /* color for ghosts after the active frame */
+       /** Color for ghosts before the active frame. */
+       float gcolor_prev[3];
+       /** Color for ghosts after the active frame. */
+       float gcolor_next[3];
        char _pad1[4];
 
        bGPDlayer_Runtime runtime;
@@ -335,27 +394,38 @@ typedef enum eGPLayerBlendModes {
 
 /* Runtime temp data for bGPdata */
 typedef struct bGPdata_Runtime {
-       struct ARegion *ar;         /* last region where drawing was originated */
-       void *sbuffer;                          /* stroke buffer (can hold GP_STROKE_BUFFER_MAX) */
+       /** Last region where drawing was originated. */
+       struct ARegion *ar;
+       /** Stroke buffer (can hold GP_STROKE_BUFFER_MAX). */
+       void *sbuffer;
 
        /* GP Object drawing */
-       float scolor[4];            /* buffer stroke color */
-       float sfill[4];             /* buffer fill color */
-       short mode;                 /* settings for color */
-       short bstroke_style;        /* buffer style for drawing strokes (used to select shader type) */
-       short bfill_style;          /* buffer style for filling areas (used to select shader type) */
+       /** Buffer stroke color. */
+       float scolor[4];
+       /** Buffer fill color. */
+       float sfill[4];
+       /** Settings for color. */
+       short mode;
+       /** Buffer style for drawing strokes (used to select shader type). */
+       short bstroke_style;
+       /** Buffer style for filling areas (used to select shader type). */
+       short bfill_style;
 
        /* Stroke Buffer data (only used during paint-session)
         * - buffer must be initialized before use, but freed after
         *   whole paint operation is over
         */
-       short sbuffer_size;                     /* number of elements currently in cache */
-       short sbuffer_sflag;            /* flags for stroke that cache represents */
+       /** Number of elements currently in cache. */
+       short sbuffer_size;
+       /** Flags for stroke that cache represents. */
+       short sbuffer_sflag;
        char _pad[6];
 
-       int tot_cp_points;                 /* number of control-points for stroke */
+       /** Number of control-points for stroke. */
+       int tot_cp_points;
        char _pad1_[4];
-       bGPDcontrolpoint *cp_points;       /* array of control-points for stroke */
+       /** Array of control-points for stroke. */
+       bGPDcontrolpoint *cp_points;
 } bGPdata_Runtime;
 
 /* grid configuration */
@@ -371,36 +441,59 @@ typedef struct bGPgrid {
 
 /* Grease-Pencil Annotations - 'DataBlock' */
 typedef struct bGPdata {
-       ID id;                                  /* Grease Pencil data is a datablock */
-       struct AnimData *adt;   /* animation data - for animating draw settings */
+       /** Grease Pencil data is a datablock. */
+       ID id;
+       /** Animation data - for animating draw settings. */
+       struct AnimData *adt;
 
        /* Grease-Pencil data */
-       ListBase layers;                /* bGPDlayers */
-       int flag;                               /* settings for this datablock */
+       /** BGPDlayers. */
+       ListBase layers;
+       /** Settings for this datablock. */
+       int flag;
 
-       short xray_mode;            /* xray mode for strokes (eGP_DepthOrdering) */
+       /** Xray mode for strokes (eGP_DepthOrdering). */
+       short xray_mode;
        char _pad1[2];
 
        /* Palettes */
-       ListBase palettes DNA_DEPRECATED;    /* list of bGPDpalette's   - Deprecated (2.78 - 2.79 only) */
+       /** List of bGPDpalette's   - Deprecated (2.78 - 2.79 only). */
+       ListBase palettes DNA_DEPRECATED;
 
        /* 3D Viewport/Appearance Settings */
-       float pixfactor;            /* factor to define pixel size conversion */
-       float line_color[4];        /* color for edit line */
+       /** Factor to define pixel size conversion. */
+       float pixfactor;
+       /** Color for edit line. */
+       float line_color[4];
 
        /* Onion skinning */
-       float onion_factor;         /* onion alpha factor change */
-       int onion_mode;             /* onion skinning range (eGP_OnionModes) */
-       int onion_flag;             /* onion skinning flags (eGPD_OnionFlag) */
-       short gstep;                        /* Ghosts Before: max number of ghost frames to show between active frame and the one before it (0 = only the ghost itself) */
-       short gstep_next;                   /* Ghosts After:  max number of ghost frames to show after active frame and the following it    (0 = only the ghost itself) */
-
-       float gcolor_prev[3];       /* optional color for ghosts before the active frame */
-       float gcolor_next[3];       /* optional color for ghosts after the active frame */
-
-       float zdepth_offset;        /* offset for drawing over surfaces to keep strokes on top */
-       struct Material **mat;      /* materials array */
-       short totcol;               /* total materials */
+       /** Onion alpha factor change. */
+       float onion_factor;
+       /** Onion skinning range (eGP_OnionModes). */
+       int onion_mode;
+       /** Onion skinning flags (eGPD_OnionFlag). */
+       int onion_flag;
+       /**
+        * Ghosts Before: max number of ghost frames to show between
+        * active frame and the one before it (0 = only the ghost itself).
+        */
+       short gstep;
+       /** Ghosts After: max number of ghost frames to show after
+        * active frame and the following it (0 = only the ghost itself).
+        */
+       short gstep_next;
+
+       /** Optional color for ghosts before the active frame. */
+       float gcolor_prev[3];
+       /** Optional color for ghosts after the active frame. */
+       float gcolor_next[3];
+
+       /** Offset for drawing over surfaces to keep strokes on top. */
+       float zdepth_offset;
+       /** Materials array. */
+       struct Material **mat;
+       /** Total materials. */
+       short totcol;
 
        /* stats */
        short totlayer;
index be34309..050db93 100644 (file)
 #ifndef __DNA_GPU_TYPES_H__
 #define __DNA_GPU_TYPES_H__
 
-/* properties for dof effect */
+/** Properties for dof effect. */
 typedef struct GPUDOFSettings {
-       float focus_distance; /* focal distance for depth of field */
+       /** Focal distance for depth of field. */
+       float focus_distance;
        float fstop;
        float focal_length;
        float sensor;
@@ -44,20 +45,22 @@ typedef struct GPUDOFSettings {
        int high_quality;
 } GPUDOFSettings;
 
-/* properties for SSAO effect */
+/** Properties for SSAO effect. */
 typedef struct GPUSSAOSettings {
        float factor;
        float color[3];
        float distance_max;
        float attenuation;
-       int samples; /* ray samples, we use presets here for easy control instead of */
+       /** Ray samples, we use presets here for easy control instead of. */
+       int samples;
        int pad;
 } GPUSSAOSettings;
 
 typedef struct GPUFXSettings {
        GPUDOFSettings *dof;
        GPUSSAOSettings *ssao;
-       char fx_flag;  /* eGPUFXFlags */
+       /** EGPUFXFlags. */
+       char fx_flag;
        char pad[7];
 } GPUFXSettings;
 
index 37a0f65..e6efe8f 100644 (file)
@@ -46,19 +46,26 @@ struct GPUTexture;
 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
 /* should be used in conjunction with an ID * to Image. */
 typedef struct ImageUser {
-       struct Scene *scene;            /* to retrieve render result */
-
-       int framenr;                            /* movies, sequences: current to display */
-       int frames;                                     /* total amount of frames to use */
-       int offset, sfra;                       /* offset within movie, start frame in global time */
-       char _pad, cycl;                /* cyclic flag */
+       /** To retrieve render result. */
+       struct Scene *scene;
+
+       /** Movies, sequences: current to display. */
+       int framenr;
+       /** Total amount of frames to use. */
+       int frames;
+       /** Offset within movie, start frame in global time. */
+       int offset, sfra;
+       /** Cyclic flag. */
+       char _pad, cycl;
        char ok;
 
-       char multiview_eye;                     /* multiview current eye - for internal use of drawing routines */
+       /** Multiview current eye - for internal use of drawing routines. */
+       char multiview_eye;
        short pass;
        short pad;
 
-       short multi_index, view, layer;  /* listbase indices, for menu browsing or retrieve buffer */
+       /** Listbase indices, for menu browsing or retrieve buffer. */
+       short multi_index, view, layer;
        short flag;
 } ImageUser;
 
@@ -69,19 +76,23 @@ typedef struct ImageAnim {
 
 typedef struct ImageView {
        struct ImageView *next, *prev;
-       char name[64];                  /* MAX_NAME */
-       char filepath[1024];    /* 1024 = FILE_MAX */
+       /** MAX_NAME. */
+       char name[64];
+       /** 1024 = FILE_MAX. */
+       char filepath[1024];
 } ImageView;
 
 typedef struct ImagePackedFile {
        struct ImagePackedFile *next, *prev;
        struct PackedFile *packedfile;
-       char filepath[1024];    /* 1024 = FILE_MAX */
+       /** 1024 = FILE_MAX. */
+       char filepath[1024];
 } ImagePackedFile;
 
 typedef struct RenderSlot {
        struct RenderSlot *next, *prev;
-       char name[64];  /* 64 = MAX_NAME */
+       /** 64 = MAX_NAME. */
+       char name[64];
        struct RenderResult *render;
 } RenderSlot;
 
@@ -101,10 +112,13 @@ enum {
 typedef struct Image {
        ID id;
 
-       char name[1024];                        /* file path, 1024 = FILE_MAX */
+       /** File path, 1024 = FILE_MAX. */
+       char name[1024];
 
-       struct MovieCache *cache;       /* not written in file */
-       struct GPUTexture *gputexture[2]; /* not written in file 2 = TEXTARGET_COUNT */
+       /** Not written in file. */
+       struct MovieCache *cache;
+       /** Not written in file 2 = TEXTARGET_COUNT. */
+       struct GPUTexture *gputexture[2];
 
        /* sources from: */
        ListBase anims;
@@ -122,7 +136,8 @@ typedef struct Image {
        short pad2;
        unsigned int pad3;
 
-       struct PackedFile *packedfile DNA_DEPRECATED; /* deprecated */
+       /** Deprecated. */
+       struct PackedFile *packedfile DNA_DEPRECATED;
        struct ListBase packedfiles;
        struct PreviewImage *preview;
 
@@ -146,9 +161,11 @@ typedef struct Image {
        char pad[5];
 
        /* Multiview */
-       char eye; /* for viewer node stereoscopy */
+       /** For viewer node stereoscopy. */
+       char eye;
        char views_format;
-       ListBase views;  /* ImageView */
+       /** ImageView. */
+       ListBase views;
        struct Stereo3dFormat *stereo3d_format;
 } Image;
 
index 5f6ca27..a1021da 100644 (file)
 
 /* IPO Curve Driver */
 typedef struct IpoDriver {
-       struct Object *ob;                      /* target/driver ob */
-       short blocktype, adrcode;       /* sub-channel to use */
-
-       short type, flag;                       /* driver settings */
-       char name[128];                         /* bone, or python expression here */
+       /** Target/driver ob. */
+       struct Object *ob;
+       /** Sub-channel to use. */
+       short blocktype, adrcode;
+
+       /** Driver settings. */
+       short type, flag;
+       /** Bone, or python expression here. */
+       char name[128];
 } IpoDriver;
 
 /* --- IPO Curve --- */
@@ -64,22 +68,34 @@ typedef struct IpoDriver {
 typedef struct IpoCurve {
        struct IpoCurve *next,  *prev;
 
-       struct BPoint *bp;                                      /* array of BPoints (sizeof(BPoint) * totvert) - i.e. baked/imported data */
-       struct BezTriple *bezt;                         /* array of BezTriples (sizeof(BezTriple) * totvert)  - i.e. user-editable keyframes  */
-
-       rctf maxrct, totrct;                            /* bounding boxes */
-
-       short blocktype, adrcode, vartype;      /* blocktype= ipo-blocktype; adrcode= type of ipo-curve; vartype= 'format' of data */
-       short totvert;                                          /* total number of BezTriples (i.e. keyframes) on curve */
-       short ipo, extrap;                                      /* interpolation and extrapolation modes  */
-       short flag, rt;                                         /* flag= settings; rt= ??? */
-       float ymin, ymax;                                       /* minimum/maximum y-extents for curve */
-       unsigned int bitmask;                           /* ??? */
-
-       float slide_min, slide_max;                     /* minimum/maximum values for sliders (in action editor) */
-       float curval;                                           /* value of ipo-curve for current frame */
-
-       IpoDriver *driver;                                      /* pointer to ipo-driver for this curve */
+       /** Array of BPoints (sizeof(BPoint) * totvert) - i.e. baked/imported data. */
+       struct BPoint *bp;
+       /** Array of BezTriples (sizeof(BezTriple) * totvert)  - i.e. user-editable keyframes . */
+       struct BezTriple *bezt;
+
+       /** Bounding boxes. */
+       rctf maxrct, totrct;
+
+       /** Blocktype= ipo-blocktype; adrcode= type of ipo-curve; vartype= 'format' of data. */
+       short blocktype, adrcode, vartype;
+       /** Total number of BezTriples (i.e. keyframes) on curve. */
+       short totvert;
+       /** Interpolation and extrapolation modes . */
+       short ipo, extrap;
+       /** Flag= settings; rt= ???. */
+       short flag, rt;
+       /** Minimum/maximum y-extents for curve. */
+       float ymin, ymax;
+       /** ???. */
+       unsigned int bitmask;
+
+       /** Minimum/maximum values for sliders (in action editor). */
+       float slide_min, slide_max;
+       /** Value of ipo-curve for current frame. */
+       float curval;
+
+       /** Pointer to ipo-driver for this curve. */
+       IpoDriver *driver;
 } IpoCurve;
 
 /* --- ID-Datablock --- */
@@ -88,11 +104,15 @@ typedef struct IpoCurve {
 typedef struct Ipo {
        ID id;
 
-       ListBase curve;                         /* A list of IpoCurve structs in a linked list. */
-       rctf cur;                                       /* Rect defining extents of keyframes? */
+       /** A list of IpoCurve structs in a linked list. */
+       ListBase curve;
+       /** Rect defining extents of keyframes?. */
+       rctf cur;
 
-       short blocktype, showkey;       /* blocktype: self-explanatory; showkey: either 0 or 1 (show vertical yellow lines for editing) */
-       short muteipo, pad;                     /* muteipo: either 0 or 1 (whether ipo block is muted) */
+       /** Blocktype: self-explanatory; showkey: either 0 or 1 (show vertical yellow lines for editing). */
+       short blocktype, showkey;
+       /** Muteipo: either 0 or 1 (whether ipo block is muted). */
+       short muteipo, pad;
 } Ipo;
 
 /* ----------- adrcodes (for matching ipo-curves to data) ------------- */
index fa58f8f..740d8b2 100644 (file)
@@ -45,25 +45,36 @@ struct Ipo;
 typedef struct KeyBlock {
        struct KeyBlock *next, *prev;
 
-       float pos;         /* point in time   (Key->type == KEY_NORMAL) only,
-                           * for historic reasons this is relative to (Key->ctime / 100),
-                           * so this value increments by 0.1f per frame. */
-       float curval;      /* influence (typically [0 - 1] but can be more), (Key->type == KEY_RELATIVE) only.*/
-
-       short type;        /* interpolation type (Key->type == KEY_NORMAL) only. */
+       /**
+        * point in time   (Key->type == KEY_NORMAL) only,
+        * for historic reasons this is relative to (Key->ctime / 100),
+        * so this value increments by 0.1f per frame.
+        */
+       float pos;
+       /** influence (typically [0 - 1] but can be more), (Key->type == KEY_RELATIVE) only.*/
+       float curval;
+
+       /** interpolation type (Key->type == KEY_NORMAL) only. */
+       short type;
        short pad1;
 
-       short relative;    /* relative == 0 means first key is reference, otherwise the index of Key->blocks */
+       /** relative == 0 means first key is reference, otherwise the index of Key->blocks */
+       short relative;
        short flag;
 
-       int totelem;       /* total number if items in the keyblock (compare with mesh/curve verts to check we match) */
-       int uid;           /* for meshes only, match the unique number with the customdata layer */
+       /** total number if items in the keyblock (compare with mesh/curve verts to check we match) */
+       int totelem;
+       /** for meshes only, match the unique number with the customdata layer */
+       int uid;
 
-       void  *data;       /* array of shape key values, size is (Key->elemsize * KeyBlock->totelem) */
-       char   name[64];   /* MAX_NAME (unique name, user assigned) */
-       char   vgroup[64]; /* MAX_VGROUP_NAME (optional vertex group), array gets allocated into 'weights' when set */
+       /** array of shape key values, size is (Key->elemsize * KeyBlock->totelem) */
+       void  *data;
+       /** MAX_NAME (unique name, user assigned) */
+       char   name[64];
+       /** MAX_VGROUP_NAME (optional vertex group), array gets allocated into 'weights' when set */
+       char   vgroup[64];
 
-       /* ranges, for RNA and UI only to clamp 'curval' */
+       /** ranges, for RNA and UI only to clamp 'curval' */
        float slidermin;
        float slidermax;
 
@@ -72,36 +83,48 @@ typedef struct KeyBlock {
 
 typedef struct Key {
        ID id;
-       struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
 
-       /* commonly called 'Basis', (Key->type == KEY_RELATIVE) only.
+       /**
+        * commonly called 'Basis', (Key->type == KEY_RELATIVE) only.
         * Looks like this is  _always_ 'key->block.first',
-        * perhaps later on it could be defined as some other KeyBlock - campbell */
+        * perhaps later on it could be defined as some other KeyBlock - campbell
+        */
        KeyBlock *refkey;
 
-       /* this is not a regular string, although it is \0 terminated
+       /**
+        * This is not a regular string, although it is \0 terminated
         * this is an array of (element_array_size, element_type) pairs
-        * (each one char) used for calculating shape key-blocks */
+        * (each one char) used for calculating shape key-blocks. */
        char elemstr[32];
-       int elemsize;  /* size of each element in #KeyBlock.data, use for allocation and stride */
+       /** Size of each element in #KeyBlock.data, use for allocation and stride. */
+       int elemsize;
        int pad;
 
-       ListBase block;  /* list of KeyBlock's */
-       struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** list of KeyBlock's */
+       ListBase block;
+       /** old animation system, deprecated for 2.5 */
+       struct Ipo *ipo  DNA_DEPRECATED;
 
        ID *from;
 
-       int totkey;  /* (totkey == BLI_listbase_count(&key->block)) */
+       /** (totkey == BLI_listbase_count(&key->block)) */
+       int totkey;
        short flag;
-       char type;  /* absolute or relative shape key */
+       /** absolute or relative shape key */
+       char type;
        char pad2;
 
-       /* only used when (Key->type == KEY_NORMAL), this value is used as a time slider,
+       /** Only used when (Key->type == KEY_NORMAL), this value is used as a time slider,
         * rather then using the scenes time, this value can be animated to give greater control */
        float ctime;
 
-       /* can never be 0, this is used for detecting old data */
-       int uidgen; /* current free uid for keyblocks */
+       /**
+        * Can never be 0, this is used for detecting old data.
+        * current free uid for keyblocks
+        */
+       int uidgen;
 } Key;
 
 /* **************** KEY ********************* */
index ba1fbf2..3bdd0e0 100644 (file)
@@ -47,7 +47,8 @@ struct MTex;
 
 typedef struct Lamp {
        ID id;
-       struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
 
        short type, flag;
        int mode;
@@ -57,7 +58,8 @@ typedef struct Lamp {
 
        float energy, dist, spotsize, spotblend;
 
-       float att1, att2;       /* Quad1 and Quad2 attenuation */
+       /** Quad1 and Quad2 attenuation. */
+       float att1, att2;
        float coeff_const, coeff_lin, coeff_quad, coeff_pad;
        struct CurveMapping *curfalloff;
        short falloff_type;
@@ -74,7 +76,8 @@ typedef struct Lamp {
        /* texact is for buttons */
        short texact, shadhalostep;
 
-       struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo  DNA_DEPRECATED;
        short pr_texture, use_nodes;
        char pad6[4];
 
index 71d6b3b..cc3606d 100644 (file)
@@ -56,17 +56,20 @@ typedef struct Lattice {
        short pntsu, pntsv, pntsw, flag;
        short opntsu, opntsv, opntsw, pad2;
        char typeu, typev, typew, pad3;
-       int actbp; /* active element index, unset with LT_ACTBP_NONE */
+       /** Active element index, unset with LT_ACTBP_NONE. */
+       int actbp;
 
        float fu, fv, fw, du, dv, dw;
 
        struct BPoint *def;
 
-       struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo  DNA_DEPRECATED;
        struct Key *key;
 
        struct MDeformVert *dvert;
-       char vgroup[64]; /* multiply the influence, MAX_VGROUP_NAME */
+       /** Multiply the influence, MAX_VGROUP_NAME. */
+       char vgroup[64];
 
        struct EditLatt *editlatt;
        void *batch_cache;
index d959d54..c2d334e 100644 (file)
@@ -58,34 +58,42 @@ typedef struct LayerCollection {
        short flag;
        short runtime_flag;
        short pad[2];
-       ListBase layer_collections; /* synced with collection->children */
+       /** Synced with collection->children. */
+       ListBase layer_collections;
 } LayerCollection;
 
 typedef struct ViewLayer {
        struct ViewLayer *next, *prev;
-       char name[64]; /* MAX_NAME */
+       /** MAX_NAME. */
+       char name[64];
        short flag;
        short runtime_flag;
        short pad[2];
-       ListBase object_bases;      /* ObjectBase */
-       struct SceneStats *stats;   /* default allocated now */
+       /** ObjectBase. */
+       ListBase object_bases;
+       /** Default allocated now. */
+       struct SceneStats *stats;
        struct Base *basact;
-       ListBase layer_collections; /* LayerCollection */
+       /** LayerCollection. */
+       ListBase layer_collections;
        LayerCollection *active_collection;
 
        /* Old SceneRenderLayer data. */
        int layflag;
-       int passflag;                   /* pass_xor has to be after passflag */
+       /** Pass_xor has to be after passflag. */
+       int passflag;
        float pass_alpha_threshold;
        int samples;
 
        struct Material *mat_override;
-       struct IDProperty *id_properties; /* Equivalent to datablocks ID properties. */
+       /** Equivalent to datablocks ID properties. */
+       struct IDProperty *id_properties;
 
        struct FreestyleConfig freestyle_config;
 
        /* Runtime data */
-       ListBase drawdata;    /* ViewLayerEngineData */
+       /** ViewLayerEngineData. */
+       ListBase drawdata;
        struct Base **object_bases_array;
        struct GHash *object_bases_hash;
 } ViewLayer;
@@ -148,13 +156,17 @@ enum {
 
 typedef struct SceneCollection {
        struct SceneCollection *next, *prev;
-       char name[64]; /* MAX_NAME */
-       int active_object_index; /* for UI */
+       /** MAX_NAME. */
+       char name[64];
+       /** For UI. */
+       int active_object_index;
        short flag;
        char type;
        char pad;
-       ListBase objects;           /* (Object *)LinkData->data */
-       ListBase scene_collections; /* nested collections */
+       /** (Object *)LinkData->data. */
+       ListBase objects;
+       /** Nested collections. */
+       ListBase scene_collections;
 } SceneCollection;
 
 #ifdef __cplusplus
index 490e257..a618293 100644 (file)
@@ -41,32 +41,46 @@ struct AnimData;
 
 typedef struct LightProbe {
        ID id;
-       struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */
-
-       char type;        /* For realtime probe objects */
-       char flag;        /* General purpose flags for probes */
-       char attenuation_type; /* Attenuation type */
-       char parallax_type;    /* Parallax type */
-
-       float distinf;    /* Influence Radius */
-       float distpar;    /* Parallax Radius */
-       float falloff;    /* Influence falloff */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
+
+       /** For realtime probe objects. */
+       char type;
+       /** General purpose flags for probes. */
+       char flag;
+       /** Attenuation type. */
+       char attenuation_type;
+       /** Parallax type. */
+       char parallax_type;
+
+       /** Influence Radius. */
+       float distinf;
+       /** Parallax Radius. */
+       float distpar;
+       /** Influence falloff. */
+       float falloff;
 
        float clipsta, clipend;
 
-       float vis_bias, vis_bleedbias; /* VSM visibility biases */
+       /** VSM visibility biases. */
+       float vis_bias, vis_bleedbias;
        float vis_blur;
 
-       float intensity; /* Intensity multiplier */
+       /** Intensity multiplier. */
+       float intensity;
 
-       int grid_resolution_x;  /* Irradiance grid resolution */
+       /** Irradiance grid resolution. */
+       int grid_resolution_x;
        int grid_resolution_y;
        int grid_resolution_z;
        int pad1;
 
-       struct Object *parallax_ob;    /* Object to use as a parallax origin */
-       struct Image *image;           /* Image to use on as lighting data */
-       struct Collection *visibility_grp;  /* Object visibility group, inclusive or exclusive */
+       /** Object to use as a parallax origin. */
+       struct Object *parallax_ob;
+       /** Image to use on as lighting data. */
+       struct Image *image;
+       /** Object visibility group, inclusive or exclusive. */
+       struct Collection *visibility_grp;
 
        /* Runtime display data */
        float distfalloff, distgridinf;
@@ -119,9 +133,11 @@ typedef struct LightProbeCache {
 
 typedef struct LightGridCache {
        float mat[4][4];
-       int resolution[3], offset; /* offset to the first irradiance sample in the pool. */
+       /** Offset to the first irradiance sample in the pool. */
+       int resolution[3], offset;
        float corner[3], attenuation_scale;
-       float increment_x[3], attenuation_bias; /* world space vector between 2 opposite cells */
+       /** World space vector between 2 opposite cells. */
+       float increment_x[3], attenuation_bias;
        float increment_y[3], level_bias;
        float increment_z[3], pad4;
        float visibility_bias, visibility_bleed, visibility_range, pad5;
@@ -142,16 +158,21 @@ typedef struct LightCacheTexture {
 typedef struct LightCache {
        int flag;
        /* only a single cache for now */
-       int cube_len, grid_len;          /* Number of probes to use for rendering. */
-       int mips_len;                    /* Number of mipmap level to use. */
-       int vis_res, ref_res;            /* Size of a visibility/reflection sample. */
+       /** Number of probes to use for rendering. */
+       int cube_len, grid_len;
+       /** Number of mipmap level to use. */
+       int mips_len;
+       /** Size of a visibility/reflection sample. */
+       int vis_res, ref_res;
        int pad[2];
        /* In the future, we could create a bigger texture containing
         * multiple caches (for animation) and interpolate between the
         * caches overtime to another texture. */
        LightCacheTexture grid_tx;
-       LightCacheTexture cube_tx;        /* Contains data for mipmap level 0. */
-       LightCacheTexture *cube_mips;     /* Does not contains valid GPUTexture, only data. */
+       /** Contains data for mipmap level 0. */
+       LightCacheTexture cube_tx;
+       /** Does not contains valid GPUTexture, only data. */
+       LightCacheTexture *cube_mips;
        /* All lightprobes data contained in the cache. */
        LightProbeCache *cube_data;
        LightGridCache  *grid_data;
index fa9ce35..914bab3 100644 (file)
@@ -52,7 +52,8 @@ struct bNodeTree;
 typedef struct LineStyleModifier {
        struct LineStyleModifier *next, *prev;
 
-       char name[64]; /* MAX_NAME */
+       /** MAX_NAME. */
+       char name[64];
        int type;
        float influence;
        int flags;
@@ -383,7 +384,8 @@ typedef struct LineStyleGeometryModifier_PerlinNoise1D {
        struct LineStyleModifier modifier;
 
        float frequency, amplitude;
-       float angle; /* in radians! */
+       /** In radians!. */
+       float angle;
        unsigned int octaves;
        int seed;
        int pad1;
@@ -393,7 +395,8 @@ typedef struct LineStyleGeometryModifier_PerlinNoise2D {
        struct LineStyleModifier modifier;
 
        float frequency, amplitude;
-       float angle; /* in radians! */
+       /** In radians!. */
+       float angle;
        unsigned int octaves;
        int seed;
        int pad1;
@@ -462,7 +465,8 @@ typedef struct LineStyleGeometryModifier_2DTransform {
 
        int pivot;
        float scale_x, scale_y;
-       float angle; /* in radians! */
+       /** In radians!. */
+       float angle;
        float pivot_u;
        float pivot_x, pivot_y;
        int pad;
@@ -481,7 +485,8 @@ typedef struct LineStyleThicknessModifier_Calligraphy {
        struct LineStyleModifier modifier;
 
        float min_thickness, max_thickness;
-       float orientation; /* in radians! */
+       /** In radians!. */
+       float orientation;
        int pad;
 } LineStyleThicknessModifier_Calligraphy;
 
@@ -551,7 +556,8 @@ typedef struct FreestyleLineStyle {
        int chaining;
        unsigned int rounds;
        float split_length;
-       float min_angle, max_angle; /* in radians, for splitting */
+       /** In radians, for splitting. */
+       float min_angle, max_angle;
        float min_length, max_length;
        unsigned int chain_count;
        unsigned short split_dash1, split_gap1;
@@ -562,8 +568,10 @@ typedef struct FreestyleLineStyle {
        short texact, pr_texture;
        short use_nodes, pad[3];
        unsigned short dash1, gap1, dash2, gap2, dash3, gap3;
-       int panel; /* for UI */
-       struct MTex *mtex[18]; /* MAX_MTEX */
+       /** For UI. */
+       int panel;
+       /** MAX_MTEX. */
+       struct MTex *mtex[18];
        /* nodes */
        struct bNodeTree *nodetree;
 
index 2c6fcca..1b834cb 100644 (file)
 typedef struct Mask {
        ID id;
        struct AnimData *adt;
-       ListBase masklayers;  /* mask layers */
-       int masklay_act;      /* index of active mask layer (-1 == None) */
-       int masklay_tot;      /* total number of mask layers */
-
-       int sfra, efra;       /* frames, used by the sequencer */
-
-       int flag;  /* for anim info */
+       /** Mask layers. */
+       ListBase masklayers;
+       /** Index of active mask layer (-1 == None). */
+       int masklay_act;
+       /** Total number of mask layers. */
+       int masklay_tot;
+
+       /** Frames, used by the sequencer. */
+       int sfra, efra;
+
+       /** For anim info. */
+       int flag;
        int pad;
 } Mask;
 
 typedef struct MaskParent {
-       // int flag;             /* parenting flags */ /* not used */
-       int id_type;          /* type of parenting */
-       int type;             /* type of parenting */
-       ID *id;               /* ID block of entity to which mask/spline is parented to
-                              * in case of parenting to movie tracking data set to MovieClip datablock */
-       char parent[64];      /* entity of parent to which parenting happened
-                              * in case of parenting to movie tracking data contains name of layer */
-       char sub_parent[64];  /* sub-entity of parent to which parenting happened
-                              * in case of parenting to movie tracking data contains name of track */
-       float parent_orig[2]; /* track location at the moment of parenting,
-                              * stored in mask space*/
-
-       float parent_corners_orig[4][2]; /* Original corners of plane track at the moment of parenting */
+       //* /* Parenting flags */ /* not used. */
+       // int flag;
+       /** Type of parenting. */
+       int id_type;
+       /** Type of parenting. */
+       int type;
+       /**
+        * ID block of entity to which mask/spline is parented to
+        * in case of parenting to movie tracking data set to MovieClip datablock.
+        */
+       ID *id;
+       /**
+        * Entity of parent to which parenting happened
+        * in case of parenting to movie tracking data contains name of layer.
+        */
+       char parent[64];
+       /**
+        * Sub-entity of parent to which parenting happened
+        * in case of parenting to movie tracking data contains name of track.
+        */
+       char sub_parent[64];
+       /**
+        * Track location at the moment of parenting,
+        * stored in mask space.
+        */
+       float parent_orig[2];
+
+       /** Original corners of plane track at the moment of parenting. */
+       float parent_corners_orig[4][2];
 } MaskParent;
 
 typedef struct MaskSplinePointUW {
-       float u, w;            /* u coordinate along spline segment and weight of this point */
-       int flag;              /* different flags of this point */
+       /** U coordinate along spline segment and weight of this point. */
+       float u, w;
+       /** Different flags of this point. */
+       int flag;
 } MaskSplinePointUW;
 
 typedef struct MaskSplinePoint {
-       BezTriple bezt;        /* actual point coordinates and it's handles  */
+       /** Actual point coordinates and it's handles . */
+       BezTriple bezt;
        int pad;
-       int tot_uw;            /* number of uv feather values */
-       MaskSplinePointUW *uw; /* feather UV values */
-       MaskParent parent;     /* parenting information of particular spline point */
+       /** Number of uv feather values. */
+       int tot_uw;
+       /** Feather UV values. */
+       MaskSplinePointUW *uw;
+       /** Parenting information of particular spline point. */
+       MaskParent parent;
 } MaskSplinePoint;
 
 typedef struct MaskSpline {
        struct MaskSpline *next, *prev;
 
-       short flag;              /* different spline flag (closed, ...) */
-       char offset_mode;        /* feather offset method */
-       char weight_interp;      /* weight interpolation */
-
-       int tot_point;           /* total number of points */
-       MaskSplinePoint *points; /* points which defines spline itself */
-       MaskParent parent;       /* parenting information of the whole spline */
-
-       MaskSplinePoint *points_deform; /* deformed copy of 'points' BezTriple data - not saved */
+       /** Different spline flag (closed, ...). */
+       short flag;
+       /** Feather offset method. */
+       char offset_mode;
+       /** Weight interpolation. */
+       char weight_interp;
+
+       /** Total number of points. */
+       int tot_point;
+       /** Points which defines spline itself. */
+       MaskSplinePoint *points;
+       /** Parenting information of the whole spline. */
+       MaskParent parent;
+
+       /** Deformed copy of 'points' BezTriple data - not saved. */
+       MaskSplinePoint *points_deform;
 } MaskSpline;
 
 /* one per frame */
 typedef struct MaskLayerShape {
        struct MaskLayerShape *next, *prev;
 
-       float *data;             /* u coordinate along spline segment and weight of this point */
-       int    tot_vert;         /* to ensure no buffer overruns's: alloc size is (tot_vert * MASK_OBJECT_SHAPE_ELEM_SIZE) */
-       int    frame;            /* different flags of this point */
-       char   flag;             /* animation flag */
+       /** 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). */
+       int    tot_vert;
+       /** Different flags of this point. */
+       int    frame;
+       /** Animation flag. */
+       char   flag;
        char   pad[7];
 } MaskLayerShape;
 
@@ -122,13 +160,17 @@ typedef struct MaskLayerShapeElem {
 typedef struct MaskLayer {
        struct MaskLayer *next, *prev;
 
-       char name[64];                     /* name of the mask layer (64 = MAD_ID_NAME - 2) */
+       /** Name of the mask layer (64 = MAD_ID_NAME - 2). */
+       char name[64];
 
-       ListBase splines;                  /* list of splines which defines this mask layer */
+       /** List of splines which defines this mask layer. */
+       ListBase splines;
        ListBase splines_shapes;
 
-       struct MaskSpline *act_spline;     /* active spline */
-       struct MaskSplinePoint *act_point; /* active point */
+       /** Active spline. */
+       struct MaskSpline *act_spline;
+       /** Active point. */
+       struct MaskSplinePoint *act_point;
 
        /* blending options */
        float  alpha;
@@ -137,8 +179,10 @@ typedef struct MaskLayer {
        char   falloff;
        char   pad[7];
 
-       char   flag;             /* for animation */
-       char   restrictflag;     /* matching 'Object' flag of the same name - eventually use in the outliner  */
+       /** For animation. */
+       char   flag;
+       /** Matching 'Object' flag of the same name - eventually use in the outliner . */
+       char   restrictflag;
 } MaskLayer;
 
 /* MaskParent->flag */
index 312cb53..1e8173f 100644 (file)
@@ -48,36 +48,61 @@ struct Ipo;
 /* WATCH IT: change type? also make changes in ipo.h  */
 
 typedef struct TexPaintSlot {
-       struct Image *ima; /* image to be painted on */
-       char *uvname;      /* customdata index for uv layer, MAX_NAME*/
-       int valid;         /* do we have a valid image and UV map */
+       /** Image to be painted on. */
+       struct Image *ima;
+       /** Customdata index for uv layer, MAX_NAM.E*/
+       char *uvname;
+       /** Do we have a valid image and UV map. */
+       int valid;
        int pad;
 } TexPaintSlot;
 
 typedef struct MaterialGPencilStyle {
-       struct Image *sima;      /* Texture image for strokes */
-       struct Image *ima;       /* Texture image for filling */
-       float stroke_rgba[4];    /* color for paint and strokes (alpha included) */
-       float fill_rgba[4];      /* color that should be used for drawing "fills" for strokes (alpha included) */
-       float mix_rgba[4];       /* secondary color used for gradients and other stuff */
-       short flag;              /* settings */
-       short index;             /* custom index for passes */
-       short stroke_style;      /* style for drawing strokes (used to select shader type) */
-       short fill_style;        /* style for filling areas (used to select shader type) */
-       float mix_factor;        /* factor used to define shader behavior (several uses) */
-       float gradient_angle;    /* angle used for gradients orientation */
-       float gradient_radius;   /* radius for radial gradients */
-       float pattern_gridsize;  /* cheesboard size */
-       float gradient_scale[2]; /* uv coordinates scale */
-       float gradient_shift[2]; /* factor to shift filling in 2d space */
-       float texture_angle;     /* angle used for texture orientation */
-       float texture_scale[2];  /* texture scale (separated of uv scale) */
-       float texture_offset[2]; /* factor to shift texture in 2d space */
-       float texture_opacity;   /* texture opacity */
-       float texture_pixsize;   /* pixel size for uv along the stroke */
-       int mode;                /* drawing mode (line or dots) */
-
-       int gradient_type;       /* type of gradient */
+       /** Texture image for strokes. */
+       struct Image *sima;
+       /** Texture image for filling. */
+       struct Image *ima;
+       /** Color for paint and strokes (alpha included). */
+       float stroke_rgba[4];
+       /** Color that should be used for drawing "fills" for strokes (alpha included). */
+       float fill_rgba[4];
+       /** Secondary color used for gradients and other stuff. */
+       float mix_rgba[4];
+       /** Settings. */
+       short flag;
+       /** Custom index for passes. */
+       short index;
+       /** Style for drawing strokes (used to select shader type). */
+       short stroke_style;
+       /** Style for filling areas (used to select shader type). */
+       short fill_style;
+       /** Factor used to define shader behavior (several uses). */
+       float mix_factor;
+       /** Angle used for gradients orientation. */
+       float gradient_angle;
+       /** Radius for radial gradients. */
+       float gradient_radius;
+       /** Cheesboard size. */
+       float pattern_gridsize;
+       /** Uv coordinates scale. */
+       float gradient_scale[2];
+       /** Factor to shift filling in 2d space. */
+       float gradient_shift[2];
+       /** Angle used for texture orientation. */
+       float texture_angle;
+       /** Texture scale (separated of uv scale). */
+       float texture_scale[2];
+       /** Factor to shift texture in 2d space. */
+       float texture_offset[2];
+       /** Texture opacity. */
+       float texture_opacity;
+       /** Pixel size for uv along the stroke. */
+       float texture_pixsize;
+       /** Drawing mode (line or dots). */
+       int mode;
+
+       /** Type of gradient. */
+       int gradient_type;
        char pad[4];
 } MaterialGPencilStyle;
 
@@ -113,7 +138,8 @@ typedef enum eMaterialGPencilStyle_Mode {
 
 typedef struct Material {
        ID id;
-       struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
 
        short flag, pad1[7];
 
@@ -123,7 +149,8 @@ typedef struct Material {
        float alpha DNA_DEPRECATED;
        float ray_mirror  DNA_DEPRECATED;
        float spec;
-       float gloss_mir  DNA_DEPRECATED; /* renamed and inversed to roughness */
+       /** Renamed and inversed to roughness. */
+       float gloss_mir  DNA_DEPRECATED;
        float roughness;
        float metallic;
        float pad4[2];
@@ -136,7 +163,8 @@ typedef struct Material {
        short index;
 
        struct bNodeTree *nodetree;
-       struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo  DNA_DEPRECATED;
        struct PreviewImage *preview;
 
        /* Freestyle line settings. */
@@ -158,14 +186,16 @@ typedef struct Material {
        char blend_flag;
        char pad3[5];
 
-       /* Cached slots for texture painting, must be refreshed in
-        * refresh_texpaint_image_cache before using. */
+       /**
+        * Cached slots for texture painting, must be refreshed in
+        * refresh_texpaint_image_cache before using.
+        */
        struct TexPaintSlot *texpaintslot;
 
-       /* Runtime cache for GLSL materials. */
+       /** Runtime cache for GLSL materials. */
        ListBase gpumaterial;
 
-       /* grease pencil color */
+       /** Grease pencil color. */
        struct MaterialGPencilStyle *gp_style;
 } Material;
 
index 9a91d3a..d0c4104 100644 (file)
@@ -115,11 +115,13 @@ typedef struct Mesh_Runtime {
 
 typedef struct Mesh {
        ID id;
-       struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
 
        struct BoundBox *bb;
 
-       struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo  DNA_DEPRECATED;
        struct Key *key;
        struct Material **mat;
        struct MSelect *mselect;
@@ -134,12 +136,18 @@ typedef struct Mesh {
 
        /* mface stores the tessellation (triangulation) of the mesh,
         * real faces are now stored in nface.*/
-       struct MFace *mface;    /* array of mesh object mode faces for tessellation */
-       struct MTFace *mtface;  /* store tessellation face UV's and texture here */
-       struct TFace *tface     DNA_DEPRECATED; /* deprecated, use mtface */
-       struct MVert *mvert;    /* array of verts */
-       struct MEdge *medge;    /* array of edges */
-       struct MDeformVert *dvert;      /* deformgroup vertices */
+       /** Array of mesh object mode faces for tessellation. */
+       struct MFace *mface;
+       /** Store tessellation face UV's and texture here. */
+       struct MTFace *mtface;
+       /** Deprecated, use mtface. */
+       struct TFace *tface     DNA_DEPRECATED;
+       /** Array of verts. */
+       struct MVert *mvert;
+       /** Array of edges. */
+       struct MEdge *medge;
+       /** Deformgroup vertices. */
+       struct MDeformVert *dvert;
 
        /* array of colors for the tessellated faces, must be number of tessellated
         * faces * 4 in length */
@@ -147,7 +155,8 @@ typedef struct Mesh {
        struct Mesh *texcomesh;
 
        /* When the object is available, the preferred access method is: BKE_editmesh_from_object(ob) */
-       struct BMEditMesh *edit_btmesh; /* not saved in file! */
+       /** Not saved in file!. */
+       struct BMEditMesh *edit_btmesh;
 
        struct CustomData vdata, edata, fdata;
 
@@ -179,12 +188,14 @@ typedef struct Mesh {
        char cd_flag, pad;
 
        char subdiv  DNA_DEPRECATED, subdivr  DNA_DEPRECATED;
-       char subsurftype  DNA_DEPRECATED; /* only kept for backwards compat, not used anymore */
+       /** Only kept for backwards compat, not used anymore. */
+       char subsurftype  DNA_DEPRECATED;
        char editflag;
 
        short totcol;
 
-       struct Multires *mr DNA_DEPRECATED; /* deprecated multiresolution modeling data, only keep for loading old files */
+       /** Deprecated multiresolution modeling data, only keep for loading old files. */
+       struct Multires *mr DNA_DEPRECATED;
 
        Mesh_Runtime runtime;
 } Mesh;
@@ -192,7 +203,8 @@ typedef struct Mesh {
 /* deprecated by MTFace, only here for file reading */
 #ifdef DNA_DEPRECATED
 typedef struct TFace {
-       void *tpage;    /* the faces image for the active UVLayer */
+       /** The faces image for the active UVLayer. */
+       void *tpage;
        float uv[4][2];
        unsigned int col[4];
        char flag, transp;
index 8525f9d..f2d2550 100644 (file)
@@ -41,7 +41,8 @@ struct Image;
 typedef struct MFace {
        unsigned int v1, v2, v3, v4;
        short mat_nr;
-       char edcode, flag;  /* we keep edcode, for conversion to edges draw flags in old files */
+       /** We keep edcode, for conversion to edges draw flags in old files. */
+       char edcode, flag;
 } MFace;
 
 typedef struct MEdge {
@@ -58,7 +59,8 @@ typedef struct MDeformWeight {
 typedef struct MDeformVert {
        struct MDeformWeight *dw;
        int totweight;
-       int flag;  /* flag only in use for weightpaint now */
+       /** Flag only in use for weightpaint now. */
+       int flag;
 } MDeformVert;
 
 typedef struct MVert {
@@ -78,15 +80,18 @@ typedef struct MCol {
 typedef struct MPoly {
        /* offset into loop array and number of loops in the face */
        int loopstart;
-       int totloop;  /* keep signed since we need to subtract when getting the previous loop */
+       /** Keep signed since we need to subtract when getting the previous loop. */
+       int totloop;
        short mat_nr;
        char flag, pad;
 } MPoly;
 
 /* the e here is because we want to move away from relying on edge hashes.*/
 typedef struct MLoop {
-       unsigned int v;  /* vertex index */
-       unsigned int e;  /* edge index */
+       /** Vertex index. */
+       unsigned int v;
+       /** Edge index. */
+       unsigned int e;
 } MLoop;
 
 /**
@@ -237,7 +242,8 @@ typedef struct MLoopCol {
 
 typedef struct MSelect {
        int index;
-       int type;  /* ME_VSEL/ME_ESEL/ME_FSEL */
+       /** ME_VSEL/ME_ESEL/ME_FSEL. */
+       int type;
 } MSelect;
 
 /*tessellation uv face data*/
index 3f0b1b3..304e977 100644 (file)
@@ -45,21 +45,30 @@ struct Material;
 typedef struct MetaElem {
        struct MetaElem *next, *prev;
 
-       struct BoundBox *bb;        /* Bound Box of MetaElem */
+       /** Bound Box of MetaElem. */
+       struct BoundBox *bb;
 
        short type, flag;
        short pad[2];
-       float x, y, z;          /* Position of center of MetaElem */
-       float quat[4];          /* Rotation of MetaElem (MUST be kept normalized) */
-       float expx; /* dimension parameters, used for some types like cubes */
+       /** Position of center of MetaElem. */
+       float x, y, z;
+       /** Rotation of MetaElem (MUST be kept normalized). */
+       float quat[4];
+       /** Dimension parameters, used for some types like cubes. */
+       float expx;
        float expy;
        float expz;
-       float rad;              /* radius of the meta element */
-       float rad2;             /* temp field, used only while processing */
-       float s;                /* stiffness, how much of the element to fill */
-       float len;              /* old, only used for backwards compat. use dimensions now */
-
-       float *mat, *imat;      /* matrix and inverted matrix */
+       /** Radius of the meta element. */
+       float rad;
+       /** Temp field, used only while processing. */
+       float rad2;
+       /** Stiffness, how much of the element to fill. */
+       float s;
+       /** Old, only used for backwards compat. use dimensions now. */
+       float len;
+
+       /** Matrix and inverted matrix. */
+       float *mat, *imat;
 } MetaElem;
 
 typedef struct MetaBall {
@@ -68,22 +77,27 @@ typedef struct MetaBall {
 
        ListBase elems;
        ListBase disp;
-       ListBase *editelems;            /* not saved in files, note we use pointer for editmode check */
-       struct Ipo *ipo  DNA_DEPRECATED;  /* old animation system, deprecated for 2.5 */
+       /** Not saved in files, note we use pointer for editmode check. */
+       ListBase *editelems;
+       /** Old animation system, deprecated for 2.5. */
+       struct Ipo *ipo  DNA_DEPRECATED;
 
        /* material of the mother ball will define the material used of all others */
        struct Material **mat;
 
-       char flag, flag2;                       /* flag is enum for updates, flag2 is bitflags for settings */
+       /** Flag is enum for updates, flag2 is bitflags for settings. */
+       char flag, flag2;
        short totcol;
-       short texflag, pad; /* used to store MB_AUTOSPACE */
+       /** Used to store MB_AUTOSPACE. */
+       short texflag, pad;
 
        /* texture space, copied as one block in editobject.c */
        float loc[3];
        float size[3];
        float rot[3];
 
-       float wiresize, rendersize; /* display and render res */
+       /** Display and render res. */
+       float wiresize, rendersize;
 
        /* bias elements to have an offset volume.
         * mother ball changes will effect other objects thresholds,
index 3715724..1cd4c4e 100644 (file)
@@ -112,7 +112,8 @@ typedef struct ModifierData {
        int stackindex;
        short flag;
        short pad;
-       char name[64];  /* MAX_NAME */
+       /** MAX_NAME. */
+       char name[64];
 
        char *error;
 } ModifierData;
@@ -130,7 +131,8 @@ typedef struct MappingInfoModifierData {
 
        struct Tex *texture;
        struct Object *map_object;
-       char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
        int uvlayer_tmp;
        int texmapping;
 } MappingInfoModifierData;
@@ -172,7 +174,8 @@ typedef struct LatticeModifierData {
        ModifierData modifier;
 
        struct Object *object;
-       char name[64];          /* optional vertexgroup name, MAX_VGROUP_NAME */
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char name[64];
        float strength;
        char pad[4];
 } LatticeModifierData;
@@ -181,8 +184,10 @@ typedef struct CurveModifierData {
        ModifierData modifier;
 
        struct Object *object;
-       char name[64];          /* optional vertexgroup name, MAX_VGROUP_NAME */
-       short defaxis;          /* axis along which curve deforms */
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char name[64];
+       /** Axis along which curve deforms. */
+       short defaxis;
        char pad[6];
 } CurveModifierData;
 
@@ -202,8 +207,10 @@ typedef struct BuildModifierData {
        float start, length;
        short flag;
 
-       short randomize;      /* (bool) whether order of vertices is randomized - legacy files (for readfile conversion) */
-       int seed;             /* (int) random seed */
+       /** (bool) whether order of vertices is randomized - legacy files (for readfile conversion). */
+       short randomize;
+       /** (int) random seed. */
+       int seed;
 } BuildModifierData;
 
 /* Build Modifier -> flag */
@@ -216,11 +223,15 @@ enum {
 typedef struct MaskModifierData {
        ModifierData modifier;
 
-       struct Object *ob_arm;  /* armature to use to in place of hardcoded vgroup */
-       char vgroup[64];        /* name of vertex group to use to mask, MAX_VGROUP_NAME */
+       /** Armature to use to in place of hardcoded vgroup. */
+       struct Object *ob_arm;
+       /** Name of vertex group to use to mask, MAX_VGROUP_NAME. */
+       char vgroup[64];
 
-       short mode;               /* using armature or hardcoded vgroup */
-       short flag;               /* flags for various things */
+       /** Using armature or hardcoded vgroup. */
+       short mode;
+       /** Flags for various things. */
+       short flag;
        float threshold;
 } MaskModifierData;
 
@@ -303,7 +314,8 @@ enum {
 typedef struct MirrorModifierData {
        ModifierData modifier;
 
-       short axis  DNA_DEPRECATED; /* deprecated, use flag instead */
+       /** Deprecated, use flag instead. */
+       short axis  DNA_DEPRECATED;
        short flag;
        float tolerance;
        float uv_offset[2];
@@ -332,7 +344,8 @@ enum {
 typedef struct EdgeSplitModifierData {
        ModifierData modifier;
 
-       float split_angle;    /* angle above which edges should be split */
+       /** Angle above which edges should be split. */
+       float split_angle;
        int flags;
 } EdgeSplitModifierData;
 
@@ -349,17 +362,25 @@ typedef struct BevelModNorEditData {
 typedef struct BevelModifierData {
        ModifierData modifier;
 
-       float value;          /* the "raw" bevel value (distance/amount to bevel) */
-       int res;              /* the resolution (as originally coded, it is the number of recursive bevels) */
-       short flags;          /* general option flags */
-       short val_flags;      /* used to interpret the bevel value */
-       short lim_flags;      /* flags to tell the tool how to limit the bevel */
-       short e_flags;        /* flags to direct how edge weights are applied to verts */
-       short mat;            /* material index if >= 0, else material inherited from surrounding faces */
+       /** The "raw" bevel value (distance/amount to bevel). */
+       float value;
+       /** The resolution (as originally coded, it is the number of recursive bevels). */
+       int res;
+       /** General option flags. */
+       short flags;
+       /** Used to interpret the bevel value. */
+       short val_flags;
+       /** Flags to tell the tool how to limit the bevel. */
+       short lim_flags;
+       /** Flags to direct how edge weights are applied to verts. */
+       short e_flags;
+       /** Material index if >= 0, else material inherited from surrounding faces. */
+       short mat;
        short edge_flags;
        short face_str_mode;
        short pad2;
-       float profile;        /* controls profile shape (0->1, .5 is round) */
+       /** Controls profile shape (0->1, .5 is round). */
+       float profile;
        /* if the MOD_BEVEL_ANGLE is set, this will be how "sharp" an edge must be before it gets beveled */
        float bevel_angle;
        /* if the MOD_BEVEL_VWEIGHT option is set, this will be the name of the vert group, MAX_VGROUP_NAME */
@@ -414,10 +435,13 @@ typedef struct SmokeModifierData {
        ModifierData modifier;
 
        struct SmokeDomainSettings *domain;
-       struct SmokeFlowSettings *flow; /* inflow, outflow, smoke objects */
-       struct SmokeCollSettings *coll; /* collision objects */
+       /** Inflow, outflow, smoke objects. */
+       struct SmokeFlowSettings *flow;
+       /** Collision objects. */
+       struct SmokeCollSettings *coll;
        float time;
-       int type;  /* domain, inflow, outflow, ... */
+       /** Domain, inflow, outflow, .... */
+       int type;
 } SmokeModifierData;
 
 /* Smoke modifier flags */
@@ -433,14 +457,16 @@ typedef struct DisplaceModifierData {
        /* keep in sync with MappingInfoModifierData */
        struct Tex *texture;
        struct Object *map_object;
-       char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
        int uvlayer_tmp;
        int texmapping;
        /* end MappingInfoModifierData */
 
        float strength;
        int direction;
-       char defgrp_name[64];   /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        float midlevel;
        int space;
 } DisplaceModifierData;
@@ -473,12 +499,14 @@ typedef struct UVProjectModifierData {
        ModifierData modifier;
 
        /* the objects which do the projecting */
-       struct Object *projectors[10]; /* MOD_UVPROJECT_MAXPROJECTORS */
+       /** MOD_UVPROJECT_MAXPROJECTORS. */
+       struct Object *projectors[10];
        int pad2;
        int num_projectors;
        float aspectx, aspecty;
        float scalex, scaley;
-       char uvlayer_name[64];         /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
        int uvlayer_tmp, pad;
 } UVProjectModifierData;
 
@@ -492,13 +520,19 @@ enum {
 typedef struct DecimateModifierData {
        ModifierData modifier;
 
-       float percent;  /* (mode == MOD_DECIM_MODE_COLLAPSE) */
-       short iter;     /* (mode == MOD_DECIM_MODE_UNSUBDIV) */
-       char delimit;   /* (mode == MOD_DECIM_MODE_DISSOLVE) */
-       char symmetry_axis; /* (mode == MOD_DECIM_MODE_COLLAPSE) */
-       float angle;    /* (mode == MOD_DECIM_MODE_DISSOLVE) */
+       /** (mode == MOD_DECIM_MODE_COLLAPSE). */
+       float percent;
+       /** (mode == MOD_DECIM_MODE_UNSUBDIV). */
+       short iter;
+       /** (mode == MOD_DECIM_MODE_DISSOLVE). */
+       char delimit;
+       /** (mode == MOD_DECIM_MODE_COLLAPSE). */
+       char symmetry_axis;
+       /** (mode == MOD_DECIM_MODE_DISSOLVE). */
+       float angle;
 
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        float defgrp_factor;
        short flag, mode;
 
@@ -522,7 +556,8 @@ enum {
 typedef struct SmoothModifierData {
        ModifierData modifier;
        float fac;
-       char defgrp_name[64];   /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        short flag, repeat;
 
 } SmoothModifierData;
@@ -541,7 +576,8 @@ typedef struct CastModifierData {
        float fac;
        float radius;
        float size;
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        short flag, type;
 } CastModifierData;
 
@@ -568,13 +604,15 @@ typedef struct WaveModifierData {
        /* keep in sync with MappingInfoModifierData */
        struct Tex *texture;
        struct Object *map_object;
-       char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
        int uvlayer_tmp;
        int texmapping;
        /* end MappingInfoModifierData */
 
        struct Object *objectcenter;
-       char defgrp_name[64];   /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 
        short flag, pad;
 
@@ -600,11 +638,14 @@ enum {
 typedef struct ArmatureModifierData {
        ModifierData modifier;
 
-       short deformflag, multi;  /* deformflag replaces armature->deformflag */
+       /** Deformflag replaces armature->deformflag. */
+       short deformflag, multi;
        int pad2;
        struct Object *object;
-       float *prevCos;           /* stored input of previous modifier, for vertexgroup blending */
-       char defgrp_name[64];     /* MAX_VGROUP_NAME */
+       /** Stored input of previous modifier, for vertexgroup blending. */
+       float *prevCos;
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 } ArmatureModifierData;
 
 enum {
@@ -629,21 +670,28 @@ typedef struct HookModifierData {
        ModifierData modifier;
 
        struct Object *object;
-       char subtarget[64];     /* optional name of bone target, MAX_ID_NAME-2 */
+       /** Optional name of bone target, MAX_ID_NAME-2. */
+       char subtarget[64];
 
        char flag;
-       char falloff_type;      /* use enums from WarpModifier (exact same functionality) */
+       /** Use enums from WarpModifier (exact same functionality). */
+       char falloff_type;
        char pad[6];
-       float parentinv[4][4];  /* matrix making current transform unmodified */
-       float cent[3];          /* visualization of hook */
-       float falloff;          /* if not zero, falloff is distance where influence zero */
+       /** Matrix making current transform unmodified. */
+       float parentinv[4][4];
+       /** Visualization of hook. */
+       float cent[3];
+       /** If not zero, falloff is distance where influence zero. */
+       float falloff;
 
        struct CurveMapping *curfalloff;
 
-       int *indexar;           /* if NULL, it's using vertexgroup */
+       /** If NULL, it's using vertexgroup. */
+       int *indexar;
        int totindex;
        float force;
-       char name[64];          /* optional vertexgroup name, MAX_VGROUP_NAME */
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char name[64];
 } HookModifierData;
 
 typedef struct SoftbodyModifierData {
@@ -653,13 +701,17 @@ typedef struct SoftbodyModifierData {
 typedef struct ClothModifierData {
        ModifierData modifier;
 
-       struct Cloth *clothObject;            /* The internal data structure for cloth. */
-       struct ClothSimSettings *sim_parms;   /* definition is in DNA_cloth_types.h */
-       struct ClothCollSettings *coll_parms; /* definition is in DNA_cloth_types.h */
+       /** The internal data structure for cloth. */
+       struct Cloth *clothObject;
+       /** Definition is in DNA_cloth_types.h. */
+       struct ClothSimSettings *sim_parms;
+       /** 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. */
-       struct PointCache *point_cache;       /* definition is in DNA_object_force_types.h */
+       /** 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 */
@@ -676,33 +728,45 @@ typedef struct ClothModifierData {
 typedef struct CollisionModifierData {
        ModifierData modifier;
 
-       struct MVert *x;            /* position at the beginning of the frame */
-       struct MVert *xnew;         /* position at the end of the frame */
-       struct MVert *xold;         /* unused atm, but was discussed during sprint */
-       struct MVert *current_xnew; /* new position at the actual inter-frame step */
-       struct MVert *current_x;    /* position at the actual inter-frame step */
-       struct MVert *current_v;    /* (xnew - x) at the actual inter-frame step */
+       /** Position at the beginning of the frame. */
+       struct MVert *x;
+       /** Position at the end of the frame. */
+       struct MVert *xnew;
+       /** Unused atm, but was discussed during sprint. */
+       struct MVert *xold;
+       /** New position at the actual inter-frame step. */
+       struct MVert *current_xnew;
+       /** Position at the actual inter-frame step. */
+       struct MVert *current_x;
+       /** (xnew - x) at the actual inter-frame step. */
+       struct MVert *current_v;
 
        struct MVertTri *tri;
 
        unsigned int mvert_num;
        unsigned int tri_num;
-       float time_x, time_xnew;    /* cfra time of modifier */
-       char is_static;             /* collider doesn't move this frame, i.e. x[].co==xnew[].co */
+       /** Cfra time of modifier. */
+       float time_x, time_xnew;
+       /** Collider doesn't move this frame, i.e. x[].co==xnew[].co. */
+       char is_static;
        char pad[7];
 
-       struct BVHTree *bvhtree;    /* bounding volume hierarchy for this cloth object */
+       /** Bounding volume hierarchy for this cloth object. */
+       struct BVHTree *bvhtree;
 } CollisionModifierData;
 
 typedef struct SurfaceModifierData {
        ModifierData modifier;
 
-       struct MVert *x; /* old position */
-       struct MVert *v; /* velocity */
+       /** Old position. */
+       struct MVert *x;
+       /** Velocity. */
+       struct MVert *v;
 
        struct Mesh *mesh;
 
-       struct BVHTreeFromMesh *bvhtree; /* bounding volume hierarchy of the mesh faces */
+       /** Bounding volume hierarchy of the mesh faces. */
+       struct BVHTreeFromMesh *bvhtree;
 
        int cfra, numverts;
 } SurfaceModifierData;
@@ -743,30 +807,46 @@ typedef struct MDefCell {
 typedef struct MeshDeformModifierData {
        ModifierData modifier;
 
-       struct Object *object;          /* mesh object */
-       char defgrp_name[64];           /* optional vertexgroup name, MAX_VGROUP_NAME */
+       /** Mesh object. */
+       struct Object *object;
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 
        short gridsize, flag, pad[2];
 
        /* result of static binding */
-       MDefInfluence *bindinfluences;  /* influences */
-       int *bindoffsets;               /* offsets into influences array */
-       float *bindcagecos;             /* coordinates that cage was bound with */
-       int totvert, totcagevert;       /* total vertices in mesh and cage */
+       /** Influences. */
+       MDefInfluence *bindinfluences;
+       /** Offsets into influences array. */
+       int *bindoffsets;
+       /** Coordinates that cage was bound with. */
+       float *bindcagecos;
+       /** Total vertices in mesh and cage. */
+       int totvert, totcagevert;
 
        /* result of dynamic binding */
-       MDefCell *dyngrid;              /* grid with dynamic binding cell points */
-       MDefInfluence *dyninfluences;   /* dynamic binding vertex influences */
-       int *dynverts;                  /* is this vertex bound or not? */
-       int dyngridsize;                /* size of the dynamic bind grid */
-       int totinfluence;               /* total number of vertex influences */
-       float dyncellmin[3];            /* offset of the dynamic bind grid */
-       float dyncellwidth;             /* width of dynamic bind cell */
-       float bindmat[4][4];            /* matrix of cage at binding time */
+       /** Grid with dynamic binding cell points. */
+       MDefCell *dyngrid;
+       /** Dynamic binding vertex influences. */
+       MDefInfluence *dyninfluences;
+       /** Is this vertex bound or not?. */
+       int *dynverts;
+       /** Size of the dynamic bind grid. */
+       int dyngridsize;
+       /** Total number of vertex influences. */
+       int totinfluence;
+       /** Offset of the dynamic bind grid. */
+       float dyncellmin[3];
+       /** Width of dynamic bind cell. */
+       float dyncellwidth;
+       /** Matrix of cage at binding time. */
+       float bindmat[4][4];
 
        /* deprecated storage */
-       float *bindweights;             /* deprecated inefficient storage */
-       float *bindcos;                 /* deprecated storage of cage coords */
+       /** Deprecated inefficient storage. */
+       float *bindweights;
+       /** Deprecated storage of cage coords. */
+       float *bindcos;
 
        /* runtime */
        void (*bindfunc)(struct MeshDeformModifierData *mmd, struct Mesh *cagemesh,
@@ -787,8 +867,10 @@ typedef struct ParticleSystemModifierData {
        ModifierData modifier;
 
        struct ParticleSystem *psys;
-       struct Mesh *mesh_final;  /* Final Mesh - its topology may differ from orig mesh. */
-       struct Mesh *mesh_original;  /* Original mesh that particles are attached to. */
+       /** Final Mesh - its topology may differ from orig mesh. */
+       struct Mesh *mesh_final;
+       /** Original mesh that particles are attached to. */
+       struct Mesh *mesh_original;
        int totdmvert, totdmedge, totdmface;
        short flag, pad;
 } ParticleSystemModifierData;
@@ -823,8 +905,10 @@ typedef struct ParticleInstanceModifierData {
        float position, random_position;
        float rotation, random_rotation;
        float particle_amount, particle_offset;
-       char index_layer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
-       char value_layer_name[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char index_layer_name[64];
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char value_layer_name[64];
 } ParticleInstanceModifierData;
 
 typedef enum {
@@ -842,7 +926,8 @@ typedef struct ExplodeModifierData {
        int *facepa;
        short flag, vgroup;
        float protect;
-       char uvname[64]; /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvname[64];
 } ExplodeModifierData;
 
 typedef struct MultiresModifierData {
@@ -864,21 +949,31 @@ typedef enum {
 typedef struct FluidsimModifierData {
        ModifierData modifier;
 
-       struct FluidsimSettings *fss;   /* definition is in DNA_object_fluidsim_types.h */
+       /** Definition is in DNA_object_fluidsim_types.h. */
+       struct FluidsimSettings *fss;
 } FluidsimModifierData;
 
 typedef struct ShrinkwrapModifierData {
        ModifierData modifier;
 
-       struct Object *target;    /* shrink target */
-       struct Object *auxTarget; /* additional shrink target */
-       char vgroup_name[64];     /* optional vertexgroup name, MAX_VGROUP_NAME */
-       float keepDist;           /* distance offset to keep from mesh/projection point */
-       short shrinkType;         /* shrink type projection */
-       char  shrinkOpts;         /* shrink options */
-       char  shrinkMode;         /* shrink to surface mode */
-       float projLimit;          /* limit the projection ray cast */
-       char  projAxis;           /* axis to project over */
+       /** Shrink target. */
+       struct Object *target;
+       /** Additional shrink target. */
+       struct Object *auxTarget;
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgroup_name[64];
+       /** Distance offset to keep from mesh/projection point. */
+       float keepDist;
+       /** Shrink type projection. */
+       short shrinkType;
+       /** Shrink options. */
+       char  shrinkOpts;
+       /** Shrink to surface mode. */
+       char  shrinkMode;
+       /** Limit the projection ray cast. */
+       float projLimit;
+       /** Axis to project over. */
+       char  projAxis;
 
        /* If using projection over vertex normal this controls the level of subsurface that must be done
         * before getting the vertex coordinates and normal
@@ -944,14 +1039,21 @@ enum {
 typedef struct SimpleDeformModifierData {
        ModifierData modifier;
 
-       struct Object *origin;  /* object to control the origin of modifier space coordinates */
-       char vgroup_name[64];   /* optional vertexgroup name, MAX_VGROUP_NAME */
-       float factor;           /* factors to control simple deforms */
-       float limit[2];         /* lower and upper limit */
+       /** Object to control the origin of modifier space coordinates. */
+       struct Object *origin;
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgroup_name[64];
+       /** Factors to control simple deforms. */
+       float factor;
+       /** Lower and upper limit. */
+       float limit[2];
 
-       char mode;              /* deform function */
-       char axis;              /* lock axis (for taper and stretch) */
-       char deform_axis;       /* axis to perform the deform on (default is X, but can be overridden by origin */
+       /** Deform function. */
+       char mode;
+       /** Lock axis (for taper and stretch). */
+       char axis;
+       /** Axis to perform the deform on (default is X, but can be overridden by origin. */
+       char deform_axis;
        char flag;
 
 } SimpleDeformModifierData;
@@ -982,12 +1084,16 @@ typedef struct ShapeKeyModifierData {
 typedef struct SolidifyModifierData {
        ModifierData modifier;
 
-       char defgrp_name[64];   /* name of vertex group to use, MAX_VGROUP_NAME */
-       float offset;           /* new surface offset level*/
-       float offset_fac;       /* midpoint of the offset  */
+       /** Name of vertex group to use, MAX_VGROUP_NAME. */
+       char defgrp_name[64];
+       /** New surface offset leve.l*/
+       float offset;
+       /** Midpoint of the offset . */
+       float offset_fac;
        /* factor for the minimum weight to use when vgroups are used, avoids 0.0 weights giving duplicate geometry */
        float offset_fac_vg;
-       float offset_clamp;     /* clamp offset based on surrounding geometry */
+       /** Clamp offset based on surrounding geometry. */
+       float offset_clamp;
        float pad;
        float crease_inner;
        float crease_outer;
@@ -1061,8 +1167,10 @@ typedef struct OceanModifierData {
        int bakestart;
        int bakeend;
 
-       char cachepath[1024];    /* FILE_MAX */
-       char foamlayername[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** FILE_MAX. */
+       char cachepath[1024];
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char foamlayername[64];
        char cached;
        char geometry_mode;
 
@@ -1098,7 +1206,8 @@ typedef struct WarpModifierData {
        /* keep in sync with MappingInfoModifierData */
        struct Tex *texture;
        struct Object *map_object;
-       char uvlayer_name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
        int uvlayer_tmp;
        int texmapping;
        /* end MappingInfoModifierData */
@@ -1106,10 +1215,12 @@ typedef struct WarpModifierData {
        struct Object *object_from;
        struct Object *object_to;
        struct CurveMapping *curfalloff;
-       char defgrp_name[64];  /* optional vertexgroup name, MAX_VGROUP_NAME */
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        float strength;
        float falloff_radius;
-       char flag; /* not used yet */
+       /** Not used yet. */
+       char flag;
        char falloff_type;
        char pad[6];
 } WarpModifierData;
@@ -1132,28 +1243,40 @@ typedef enum {
 typedef struct WeightVGEditModifierData {
        ModifierData modifier;
 
-       char defgrp_name[64]; /* Name of vertex group to edit. MAX_VGROUP_NAME. */
+       /** Name of vertex group to edit. MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 
-       short edit_flags;     /* Using MOD_WVG_EDIT_* flags. */
-       short falloff_type;   /* Using MOD_WVG_MAPPING_* defines. */
-       float default_weight; /* Weight for vertices not in vgroup. */
+       /** Using MOD_WVG_EDIT_* flags. */
+       short edit_flags;
+       /** Using MOD_WVG_MAPPING_* defines. */
+       short falloff_type;
+       /** Weight for vertices not in vgroup. */
+       float default_weight;
 
        /* Mapping stuff. */
-       struct CurveMapping *cmap_curve;  /* The custom mapping curve! */
+       /** The custom mapping curve!. */
+       struct CurveMapping *cmap_curve;
 
        /* The add/remove vertices weight thresholds. */
        float add_threshold, rem_threshold;
 
        /* Masking options. */
-       float mask_constant;        /* The global "influence", if no vgroup nor tex is used as mask. */
-       char mask_defgrp_name[64];  /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
+       /** The global "influence", if no vgroup nor tex is used as mask. */
+       float mask_constant;
+       /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */
+       char mask_defgrp_name[64];
 
        /* Texture masking. */
-       int mask_tex_use_channel;          /* Which channel to use as weightf. */
-       struct Tex *mask_texture;          /* The texture. */
-       struct Object *mask_tex_map_obj;   /* Name of the map object. */
-       int mask_tex_mapping;              /* How to map the texture (using MOD_DISP_MAP_* enums). */
-       char mask_tex_uvlayer_name[64];    /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME */
+       /** Which channel to use as weightf. */
+       int mask_tex_use_channel;
+       /** The texture. */
+       struct Tex *mask_texture;
+       /** Name of the map object. */
+       struct Object *mask_tex_map_obj;
+       /** How to map the texture (using MOD_DISP_MAP_* enums). */
+       int mask_tex_mapping;
+       /** Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
+       char mask_tex_uvlayer_name[64];
 
        /* Padding... */
        int pad_i1;
@@ -1169,25 +1292,38 @@ enum {
 typedef struct WeightVGMixModifierData {
        ModifierData modifier;
 
-       char defgrp_name_a[64];    /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
-       char defgrp_name_b[64];    /* Name of other vertex group to mix in. MAX_VGROUP_NAME. */
-       float default_weight_a;    /* Default weight value for first vgroup. */
-       float default_weight_b;    /* Default weight value to mix in. */
-       char mix_mode;             /* How second vgroups weights affect first ones */
-       char mix_set;              /* What vertices to affect. */
+       /** Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
+       char defgrp_name_a[64];
+       /** Name of other vertex group to mix in. MAX_VGROUP_NAME. */
+       char defgrp_name_b[64];
+       /** Default weight value for first vgroup. */
+       float default_weight_a;
+       /** Default weight value to mix in. */
+       float default_weight_b;
+       /** How second vgroups weights affect first ones. */
+       char mix_mode;
+       /** What vertices to affect. */
+       char mix_set;
 
        char pad_c1[6];
 
        /* Masking options. */
-       float mask_constant;        /* The global "influence", if no vgroup nor tex is used as mask. */
-       char mask_defgrp_name[64];  /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
+       /** The global "influence", if no vgroup nor tex is used as mask. */
+       float mask_constant;
+       /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */
+       char mask_defgrp_name[64];
 
        /* Texture masking. */
-       int mask_tex_use_channel;         /* Which channel to use as weightf. */
-       struct Tex *mask_texture;         /* The texture. */
-       struct Object *mask_tex_map_obj;  /* Name of the map object. */
-       int mask_tex_mapping;             /* How to map the texture! */
-       char mask_tex_uvlayer_name[64];   /* Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
+       /** Which channel to use as weightf. */
+       int mask_tex_use_channel;
+       /** The texture. */
+       struct Tex *mask_texture;
+       /** Name of the map object. */
+       struct Object *mask_tex_map_obj;
+       /** How to map the texture!. */
+       int mask_tex_mapping;
+       /** Name of the UV map. MAX_CUSTOMDATA_LAYER_NAME. */
+       char mask_tex_uvlayer_name[64];
 
        /* Padding... */
        int pad_i1;
@@ -1216,7 +1352,8 @@ enum {
 typedef struct WeightVGProximityModifierData {
        ModifierData modifier;
 
-       char defgrp_name[64];      /* Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
+       /** Name of vertex group to modify/weight. MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 
        /* Proximity modes. */
        int proximity_mode;
@@ -1226,20 +1363,29 @@ typedef struct WeightVGProximityModifierData {
        struct Object *proximity_ob_target;
 
        /* Masking options. */
-       float mask_constant;        /* The global "influence", if no vgroup nor tex is used as mask. */
-       char mask_defgrp_name[64];  /* Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME */
+       /** The global "influence", if no vgroup nor tex is used as mask. */
+       float mask_constant;
+       /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */
+       char mask_defgrp_name[64];
 
        /* Texture masking. */
-       int mask_tex_use_channel;        /* Which channel to use as weightf. */
-       struct Tex *mask_texture;        /* The texture. */
-       struct Object *mask_tex_map_obj; /* Name of the map object. */
-       int mask_tex_mapping;            /* How to map the texture! */
-       char mask_tex_uvlayer_name[64];  /* Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
-
-       float min_dist, max_dist;        /* Distances mapping to 0.0/1.0 weights. */
+       /** Which channel to use as weightf. */
+       int mask_tex_use_channel;
+       /** The texture. */
+       struct Tex *mask_texture;
+       /** Name of the map object. */
+       struct Object *mask_tex_map_obj;
+       /** How to map the texture!. */
+       int mask_tex_mapping;
+       /** Name of the UV Map. MAX_CUSTOMDATA_LAYER_NAME. */
+       char mask_tex_uvlayer_name[64];
+
+       /** Distances mapping to 0.0/1.0 weights. */
+       float min_dist, max_dist;
 
        /* Put here to avoid breaking existing struct... */
-       short falloff_type;              /* Using MOD_WVG_MAPPING_* enums. */
+       /** Using MOD_WVG_MAPPING_* enums. */
+       short falloff_type;
 
        /* Padding... */
        short pad_s1;
@@ -1293,7 +1439,8 @@ typedef struct DynamicPaintModifierData {
 
        struct DynamicPaintCanvasSettings *canvas;
        struct DynamicPaintBrushSettings *brush;
-       int type;  /* ui display: canvas / brush */
+       /** Ui display: canvas / brush. */
+       int type;
        int pad;
 } DynamicPaintModifierData;
 
@@ -1396,7 +1543,8 @@ typedef struct LaplacianSmoothModifierData {
        ModifierData modifier;
 
        float lambda, lambda_border, pad1;
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        short flag, repeat;
 } LaplacianSmoothModifierData;
 
@@ -1425,7 +1573,8 @@ typedef struct CorrectiveSmoothModifierData {
        char smooth_type, rest_source;
        char pad[2];
 
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 
        /* runtime-only cache (delta's between),
         * delta's between the original positions and the smoothed positions */
@@ -1456,15 +1605,22 @@ typedef struct UVWarpModifierData {
 
        char axis_u, axis_v;
        char pad[6];
-       float center[2];            /* used for rotate/scale */
-
-       struct Object *object_src;  /* source */
-       char bone_src[64];          /* optional name of bone target, MAX_ID_NAME-2 */
-       struct Object *object_dst;  /* target */
-       char bone_dst[64];          /* optional name of bone target, MAX_ID_NAME-2 */
-
-       char vgroup_name[64];       /* optional vertexgroup name, MAX_VGROUP_NAME */
-       char uvlayer_name[64];      /* MAX_CUSTOMDATA_LAYER_NAME */
+       /** Used for rotate/scale. */
+       float center[2];
+
+       /** Source. */
+       struct Object *object_src;
+       /** Optional name of bone target, MAX_ID_NAME-2. */
+       char bone_src[64];
+       /** Target. */
+       struct Object *object_dst;
+       /** Optional name of bone target, MAX_ID_NAME-2. */
+       char bone_dst[64];
+
+       /** Optional vertexgroup name, MAX_VGROUP_NAME. */
+       char vgroup_name[64];
+       /** MAX_CUSTOMDATA_LAYER_NAME. */
+       char uvlayer_name[64];
 } UVWarpModifierData;
 
 /* cache modifier */
@@ -1472,7 +1628,8 @@ typedef struct MeshCacheModifierData {
        ModifierData modifier;
 
        char flag;
-       char type;  /* file format */
+       /** File format. */
+       char type;
        char time_mode;
        char play_mode;
 
@@ -1497,7 +1654,8 @@ typedef struct MeshCacheModifierData {
        float eval_time;
        float eval_factor;
 
-       char filepath[1024];  /* FILE_MAX */
+       /** FILE_MAX. */
+       char filepath[1024];
 } MeshCacheModifierData;
 
 enum {
@@ -1530,10 +1688,12 @@ enum {
 
 typedef struct LaplacianDeformModifierData {
        ModifierData modifier;
-       char anchor_grp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char anchor_grp_name[64];
        int total_verts, repeat;
        float *vertexco;
-       void *cache_system;  /* runtime only */
+       /** Runtime only. */
+       void *cache_system;
        short flag, pad[3];
 
 } LaplacianDeformModifierData;
@@ -1546,7 +1706,8 @@ enum {
 /* many of these options match 'solidify' */
 typedef struct WireframeModifierData {
        ModifierData modifier;
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        float offset;
        float offset_fac;
        float offset_fac_vg;
@@ -1570,7 +1731,8 @@ typedef struct DataTransferModifierData {
 
        struct Object *ob_source;
 
-       int data_types;  /* See DT_TYPE_ enum in ED_object.h */
+       /** See DT_TYPE_ enum in ED_object.h. */
+       int data_types;
 
        /* See MREMAP_MODE_ enum in BKE_mesh_mapping.h */
        int vmap_mode;
@@ -1584,12 +1746,16 @@ typedef struct DataTransferModifierData {
 
        int pad_i1;
 
-       int layers_select_src[4];  /* DT_MULTILAYER_INDEX_MAX; See DT_FROMLAYERS_ enum in ED_object.h */
-       int layers_select_dst[4];  /* DT_MULTILAYER_INDEX_MAX; See DT_TOLAYERS_ enum in ED_object.h */
+       /** DT_MULTILAYER_INDEX_MAX; See DT_FROMLAYERS_ enum in ED_object.h. */
+       int layers_select_src[4];
+       /** DT_MULTILAYER_INDEX_MAX; See DT_TOLAYERS_ enum in ED_object.h. */
+       int layers_select_dst[4];
 
-       int mix_mode;  /* See CDT_MIX_ enum in BKE_customdata.h */
+       /** See CDT_MIX_ enum in BKE_customdata.h. */
+       int mix_mode;
        float mix_factor;
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
 
        int flags;
 } DataTransferModifierData;
@@ -1610,8 +1776,10 @@ enum {
 /* Set Split Normals modifier */
 typedef struct NormalEditModifierData {
        ModifierData modifier;
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
-       struct Object *target;  /* Source of normals, or center of ellipsoid. */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
+       /** Source of normals, or center of ellipsoid. */
+       struct Object *target;
        short mode;
        short flag;
        short mix_mode;
@@ -1648,7 +1816,8 @@ typedef struct MeshSeqCacheModifierData {
 
        struct CacheFile *cache_file;
        struct CacheReader *reader;
-       char object_path[1024];  /* 1024 = FILE_MAX */
+       /** 1024 = FILE_MAX. */
+       char object_path[1024];
 
        char read_flag;
        char pad[7];
@@ -1681,8 +1850,10 @@ typedef struct SurfaceDeformModifierData {
        ModifierData modifier;
 
        struct Depsgraph *depsgraph;
-       struct Object *target;  /* bind target object */
-       SDefVert *verts;                /* vertex bind data */
+       /** Bind target object. */
+       struct Object *target;
+       /** Vertex bind data. */
+       SDefVert *verts;
        float falloff;
        unsigned int numverts, numpoly;
        int flags;
@@ -1708,7 +1879,8 @@ enum {
 typedef struct WeightedNormalModifierData {
        ModifierData modifier;
 
-       char defgrp_name[64];  /* MAX_VGROUP_NAME */
+       /** MAX_VGROUP_NAME. */
+       char defgrp_name[64];
        char mode, flag;
        short weight;
        float thresh;
index 56b9947..9032be7 100644 (file)
@@ -48,73 +48,111 @@ struct MovieTrackingTrack;
 struct MovieTrackingMarker;
 
 typedef struct MovieClipUser {
-       int framenr;    /* current frame number */
-       short render_size, render_flag;     /* proxy render size */
+       /** Current frame number. */
+       int framenr;
+       /** Proxy render size. */
+       short render_size, render_flag;
 } MovieClipUser;
 
 typedef struct MovieClipProxy {
-       char dir[768];          /* 768=FILE_MAXDIR custom directory for index and proxy files (defaults to BL_proxy) */
-
-       short tc;               /* time code in use */
-       short quality;          /* proxy build quality */
-       short build_size_flag;  /* size flags (see below) of all proxies to build */
-       short build_tc_flag;    /* time code flags (see below) of all tc indices to build */
+       /** 768=FILE_MAXDIR custom directory for index and proxy files (defaults to BL_proxy). */
+       char dir[768];
+
+       /** Time code in use. */
+       short tc;
+       /** Proxy build quality. */
+       short quality;
+       /** Size flags (see below) of all proxies to build. */
+       short build_size_flag;
+       /** Time code flags (see below) of all tc indices to build. */
+       short build_tc_flag;
 } MovieClipProxy;
 
 typedef struct MovieClip {
        ID id;
-       struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */
-
-       char name[1024];        /* file path, 1024 = FILE_MAX */
-
-       int source;         /* sequence or movie */
-       int lastframe;      /* last accessed frame number */
-       int lastsize[2];    /* size of last accessed frame */
-
-       float aspx, aspy;   /* display aspect */
-
-       struct anim *anim;  /* movie source data */
-       struct MovieClipCache *cache;       /* cache for different stuff, not in file */
-       struct bGPdata *gpd;                /* grease pencil data */
-
-       struct MovieTracking tracking;      /* data for SfM tracking */
-       void *tracking_context;             /* context of tracking job
-                                            * used to synchronize data like framenumber
-                                            * in SpaceClip clip user */
-
-       struct MovieClipProxy proxy;        /* proxy to clip data */
+       /** Animation data (must be immediately after id for utilities to use it). */
+       struct AnimData *adt;
+
+       /** File path, 1024 = FILE_MAX. */
+       char name[1024];
+
+       /** Sequence or movie. */
+       int source;
+       /** Last accessed frame number. */
+       int lastframe;
+       /** Size of last accessed frame. */
+       int lastsize[2];
+
+       /** Display aspect. */
+       float aspx, aspy;
+
+       /** Movie source data. */
+       struct anim *anim;
+       /** Cache for different stuff, not in file. */
+       struct MovieClipCache *cache;
+       /** Grease pencil data. */
+       struct bGPdata *gpd;
+
+       /** Data for SfM tracking. */
+       struct MovieTracking tracking;
+       /**
+        * Context of tracking job used to synchronize data
+        * like framenumber in SpaceClip clip user.
+        */
+       void *tracking_context;
+
+       /** Proxy to clip data. */
+       struct MovieClipProxy proxy;
        int flag;
 
-       int len;    /* length of movie */
-
-       int start_frame;    /* scene frame number footage starts playing at */
-                           /* affects all data which is associated with a clip */
-                           /* such as motion tracking, camera reconstruciton and so */
-
-       int frame_offset;   /* offset which is adding to a file number when reading frame */
-                           /* from a file. affects only a way how scene frame is mapping */
-                           /* to a file name and not touches other data associated with */
-                           /* a clip */
+       /** Length of movie. */
+       int len;
+
+       /**
+        * Scene frame number footage starts playing at affects all data
+        * which is associated with a clip such as motion tracking,
+        * camera reconstruciton and so.
+        */
+       int start_frame;
+       /**
+        * Offset which is adding to a file number when reading frame from a file.
+        * affects only a way how scene frame is mapping to a file name and not
+        * touches other data associated with a clip. */
+       int frame_offset;
 
        /* color management */
        ColorManagedColorspaceSettings colorspace_settings;
 } MovieClip;
 
 typedef struct MovieClipScopes {
-       short ok;                       /* 1 means scopes are ok and recalculation is unneeded */
-       short use_track_mask;           /* whether track's mask should be applied on preview */
-       int track_preview_height;       /* height of track preview widget */
-       int frame_width, frame_height;  /* width and height of frame for which scopes are calculated */
-       struct MovieTrackingMarker undist_marker;   /* undistorted position of marker used for pattern sampling */
-       struct ImBuf *track_search;     /* search area of a track */
-       struct ImBuf *track_preview;    /* ImBuf displayed in track preview */
-       float track_pos[2];             /* sub-pizel position of marker in track ImBuf */
-       short track_disabled;           /* active track is disabled, special notifier should be drawn */
-       short track_locked;             /* active track is locked, no transformation should be allowed */
-       int framenr;                    /* frame number scopes are created for */
-       struct MovieTrackingTrack *track;   /* track scopes are created for */
-       struct MovieTrackingMarker *marker; /* marker scopes are created for */
-       float slide_scale[2];           /* scale used for sliding from previewe area */
+       /** 1 means scopes are ok and recalculation is unneeded. */
+       short ok;
+       /** Whether track's mask should be applied on preview. */
+       short use_track_mask;
+       /** Height of track preview widget. */
+       int track_preview_height;
+       /** Width and height of frame for which scopes are calculated. */
+       int frame_width, frame_height;
+       /** Undistorted position of marker used for pattern sampling. */
+       struct MovieTrackingMarker undist_marker;
+       /** Search area of a track. */
+       struct ImBuf *track_search;
+       /** ImBuf displayed in track preview. */
+       struct ImBuf *track_preview;
+       /** Sub-pizel position of marker in track ImBuf. */
+       float track_pos[2];
+       /** Active track is disabled, special notifier should be drawn. */
+       short track_disabled;
+       /** Active track is locked, no transformation should be allowed. */
+       short track_locked;
+       /** Frame number scopes are created for. */
+       int framenr;
+       /** Track scopes are created for. */
+       struct MovieTrackingTrack *track;
+       /** Marker scopes are created for. */
+       struct MovieTrackingMarker *marker;
+       /** Scale used for sliding from previewe area. */
+       float slide_scale[2];
 } MovieClipScopes;
 
 /* MovieClipProxy->build_size_flag */
index 72db244..a10504e 100644 (file)
@@ -60,25 +60,40 @@ typedef struct bActionModifier {
 typedef struct bActionStrip {
        struct bActionStrip *next, *prev;
        short   flag, mode;
-       short   stride_axis;            /* axis 0=x, 1=y, 2=z */
-       short   curmod;                         /* current modifier for buttons */
-
-       struct  Ipo *ipo;                       /* Blending ipo - was used for some old NAN era experiments. Non-functional currently. */
-       struct  bAction *act;           /* The action referenced by this strip */
-       struct  Object *object;         /* For groups, the actual object being nla'ed */
-       float   start, end;                     /* The range of frames covered by this strip */
-       float   actstart, actend;       /* The range of frames taken from the action */
-       float   actoffs;                        /* Offset within action, for cycles and striding */
-       float   stridelen;                      /* The stridelength (considered when flag & ACT_USESTRIDE) */
-       float   repeat;                         /* The number of times to repeat the action range */
-       float   scale;                          /* The amount the action range is scaled by */
-
-       float   blendin, blendout;      /* The number of frames on either end of the strip's length to fade in/out */
-
-       char    stridechannel[32];      /* Instead of stridelen, it uses an action channel */
-       char    offs_bone[32];          /* if repeat, use this bone/channel for defining offset */
-
-       ListBase modifiers;                     /* modifier stack */
+       /** Axis 0=x, 1=y, 2=z. */
+       short   stride_axis;
+       /** Current modifier for buttons. */
+       short   curmod;
+
+       /** Blending ipo - was used for some old NAN era experiments. Non-functional currently. */
+       struct  Ipo *ipo;
+       /** The action referenced by this strip. */
+       struct  bAction *act;
+       /** For groups, the actual object being nla'ed. */
+       struct  Object *object;
+       /** The range of frames covered by this strip. */
+       float   start, end;
+       /** The range of frames taken from the action. */
+       float   actstart, actend;
+       /** Offset within action, for cycles and striding. */
+       float   actoffs;
+       /** The stridelength (considered when flag & ACT_USESTRIDE). */
+       float   stridelen;
+       /** The number of times to repeat the action range. */
+       float   repeat;
+       /** The amount the action range is scaled by. */
+       float   scale;
+
+       /** The number of frames on either end of the strip's length to fade in/out. */
+       float   blendin, blendout;
+
+       /** Instead of stridelen, it uses an action channel. */
+       char    stridechannel[32];
+       /** If repeat, use this bone/channel for defining offset. */
+       char    offs_bone[32];
+
+       /** Modifier stack. */
+       ListBase modifiers;
 } bActionStrip;
 
 /* strip->mode (these defines aren't really used, but are here for reference) */
@@ -89,12 +104,14 @@ typedef struct bActionStrip {
 typedef enum eActStrip_Flag {
        ACTSTRIP_SELECT                 = (1<<0),
        ACTSTRIP_USESTRIDE              = (1<<1),
-       ACTSTRIP_BLENDTONEXT    = (1<<2),       /* Not implemented. Is not used anywhere */
+       /* Not implemented. Is not used anywhere */
+       ACTSTRIP_BLENDTONEXT    = (1<<2),
        ACTSTRIP_HOLDLASTFRAME  = (1<<3),
        ACTSTRIP_ACTIVE                 = (1<<4),
        ACTSTRIP_LOCK_ACTION    = (1<<5),
        ACTSTRIP_MUTE                   = (1<<6),
-       ACTSTRIP_REVERSE                = (1<<7),       /* This has yet to be implemented. To indicate that a strip should be played backwards */
+       /* This has yet to be implemented. To indicate that a strip should be played backwards */
+       ACTSTRIP_REVERSE                = (1<<7),
        ACTSTRIP_CYCLIC_USEX    = (1<<8),
        ACTSTRIP_CYCLIC_USEY    = (1<<9),
        ACTSTRIP_CYCLIC_USEZ    = (1<<10),
index 32792fc..307efab 100644 (file)
@@ -62,12 +62,18 @@ typedef struct bNodeStack {
        float vec[4];
        float min, max;
        void *data;
-       short hasinput;                 /* when input has link, tagged before executing */
-       short hasoutput;                /* when output is linked, tagged before executing */
-       short datatype;                 /* type of data pointer */
-       short sockettype;               /* type of socket stack comes from, to remap linking different sockets */
-       short is_copy;                  /* data is a copy of external data (no freeing) */
-       short external;                 /* data is used by external nodes (no freeing) */
+       /** When input has link, tagged before executing. */
+       short hasinput;
+       /** When output is linked, tagged before executing. */
+       short hasoutput;
+       /** Type of data pointer. */
+       short datatype;
+       /** Type of socket stack comes from, to remap linking different sockets. */
+       short sockettype;
+       /** Data is a copy of external data (no freeing). */
+       short is_copy;
+       /** Data is used by external nodes (no freeing). */
+       short external;
        short pad[2];
 } bNodeStack;
 
@@ -86,48 +92,62 @@ typedef struct bNodeStack {
 typedef struct bNodeSocket {
        struct bNodeSocket *next, *prev, *new_sock;
 
-       IDProperty *prop;                       /* user-defined properties */
+       /** User-defined properties. */
+       IDProperty *prop;
 
-       char identifier[64];            /* unique identifier for mapping */
+       /** Unique identifier for mapping. */
+       char identifier[64];
 
-       char name[64];  /* MAX_NAME */
+       /** MAX_NAME. */
+       char name[64];
 
        /* XXX deprecated, only used for the Image and OutputFile nodes,
         * should be removed at some point.
         */
-       void *storage;                          /* custom storage */