[Bf-blender-cvs] [aa42da03859] master: Cleanup: comments (long lines) in blenkernel
Campbell Barton
noreply at git.blender.org
Sat Apr 27 04:22:23 CEST 2019
Commit: aa42da03859d28900a1d01130f07c38b1e2ad34b
Author: Campbell Barton
Date: Sat Apr 27 12:07:07 2019 +1000
Branches: master
https://developer.blender.org/rBaa42da03859d28900a1d01130f07c38b1e2ad34b
Cleanup: comments (long lines) in blenkernel
===================================================================
M source/blender/blenkernel/BKE_DerivedMesh.h
M source/blender/blenkernel/BKE_animsys.h
M source/blender/blenkernel/BKE_bvhutils.h
M source/blender/blenkernel/BKE_constraint.h
M source/blender/blenkernel/BKE_customdata.h
M source/blender/blenkernel/BKE_deform.h
M source/blender/blenkernel/BKE_effect.h
M source/blender/blenkernel/BKE_fcurve.h
M source/blender/blenkernel/BKE_gpencil_modifier.h
M source/blender/blenkernel/BKE_library.h
M source/blender/blenkernel/BKE_library_query.h
M source/blender/blenkernel/BKE_library_remap.h
M source/blender/blenkernel/BKE_main.h
M source/blender/blenkernel/BKE_mesh.h
M source/blender/blenkernel/BKE_mesh_remap.h
M source/blender/blenkernel/BKE_modifier.h
M source/blender/blenkernel/BKE_node.h
M source/blender/blenkernel/BKE_pointcache.h
M source/blender/blenkernel/BKE_rigidbody.h
M source/blender/blenkernel/BKE_screen.h
M source/blender/blenkernel/BKE_shrinkwrap.h
M source/blender/blenkernel/BKE_undo_system.h
M source/blender/blenkernel/intern/CCGSubSurf_intern.h
M source/blender/blenkernel/intern/DerivedMesh.c
M source/blender/blenkernel/intern/action.c
M source/blender/blenkernel/intern/anim.c
M source/blender/blenkernel/intern/anim_sys.c
M source/blender/blenkernel/intern/appdir.c
M source/blender/blenkernel/intern/armature.c
M source/blender/blenkernel/intern/armature_update.c
M source/blender/blenkernel/intern/blender.c
M source/blender/blenkernel/intern/blender_copybuffer.c
M source/blender/blenkernel/intern/blendfile.c
M source/blender/blenkernel/intern/brush.c
M source/blender/blenkernel/intern/bvhutils.c
M source/blender/blenkernel/intern/cachefile.c
M source/blender/blenkernel/intern/camera.c
M source/blender/blenkernel/intern/cdderivedmesh.c
M source/blender/blenkernel/intern/cloth.c
M source/blender/blenkernel/intern/collection.c
M source/blender/blenkernel/intern/collision.c
M source/blender/blenkernel/intern/colorband.c
M source/blender/blenkernel/intern/constraint.c
M source/blender/blenkernel/intern/curve.c
M source/blender/blenkernel/intern/customdata.c
M source/blender/blenkernel/intern/data_transfer.c
M source/blender/blenkernel/intern/deform.c
M source/blender/blenkernel/intern/dynamicpaint.c
M source/blender/blenkernel/intern/editmesh.c
M source/blender/blenkernel/intern/editmesh_tangent.c
M source/blender/blenkernel/intern/effect.c
M source/blender/blenkernel/intern/fcurve.c
M source/blender/blenkernel/intern/fmodifier.c
M source/blender/blenkernel/intern/font.c
M source/blender/blenkernel/intern/gpencil.c
M source/blender/blenkernel/intern/icons.c
M source/blender/blenkernel/intern/idprop.c
M source/blender/blenkernel/intern/image.c
M source/blender/blenkernel/intern/ipo.c
M source/blender/blenkernel/intern/key.c
M source/blender/blenkernel/intern/lattice.c
M source/blender/blenkernel/intern/layer.c
M source/blender/blenkernel/intern/library.c
M source/blender/blenkernel/intern/library_idmap.c
M source/blender/blenkernel/intern/library_override.c
M source/blender/blenkernel/intern/library_query.c
M source/blender/blenkernel/intern/library_remap.c
M source/blender/blenkernel/intern/light.c
M source/blender/blenkernel/intern/lightprobe.c
M source/blender/blenkernel/intern/linestyle.c
M source/blender/blenkernel/intern/main.c
M source/blender/blenkernel/intern/mask.c
M source/blender/blenkernel/intern/mask_rasterize.c
M source/blender/blenkernel/intern/material.c
M source/blender/blenkernel/intern/mball.c
M source/blender/blenkernel/intern/mball_tessellate.c
M source/blender/blenkernel/intern/mesh.c
M source/blender/blenkernel/intern/mesh_convert.c
M source/blender/blenkernel/intern/mesh_evaluate.c
M source/blender/blenkernel/intern/mesh_iterators.c
M source/blender/blenkernel/intern/mesh_mapping.c
M source/blender/blenkernel/intern/mesh_merge.c
M source/blender/blenkernel/intern/mesh_remap.c
M source/blender/blenkernel/intern/mesh_runtime.c
M source/blender/blenkernel/intern/mesh_tangent.c
M source/blender/blenkernel/intern/mesh_validate.c
M source/blender/blenkernel/intern/modifier.c
M source/blender/blenkernel/intern/movieclip.c
M source/blender/blenkernel/intern/multires.c
M source/blender/blenkernel/intern/nla.c
M source/blender/blenkernel/intern/node.c
M source/blender/blenkernel/intern/object.c
M source/blender/blenkernel/intern/object_deform.c
M source/blender/blenkernel/intern/object_dupli.c
M source/blender/blenkernel/intern/ocean.c
M source/blender/blenkernel/intern/packedFile.c
M source/blender/blenkernel/intern/paint.c
M source/blender/blenkernel/intern/particle.c
M source/blender/blenkernel/intern/particle_distribute.c
M source/blender/blenkernel/intern/particle_system.c
M source/blender/blenkernel/intern/pbvh.c
M source/blender/blenkernel/intern/pbvh_bmesh.c
M source/blender/blenkernel/intern/pointcache.c
M source/blender/blenkernel/intern/rigidbody.c
M source/blender/blenkernel/intern/scene.c
M source/blender/blenkernel/intern/screen.c
M source/blender/blenkernel/intern/sequencer.c
M source/blender/blenkernel/intern/shrinkwrap.c
M source/blender/blenkernel/intern/smoke.c
M source/blender/blenkernel/intern/softbody.c
M source/blender/blenkernel/intern/sound.c
M source/blender/blenkernel/intern/speaker.c
M source/blender/blenkernel/intern/studiolight.c
M source/blender/blenkernel/intern/subsurf_ccg.c
M source/blender/blenkernel/intern/text.c
M source/blender/blenkernel/intern/texture.c
M source/blender/blenkernel/intern/tracking.c
M source/blender/blenkernel/intern/tracking_region_tracker.c
M source/blender/blenkernel/intern/undo_system.c
M source/blender/blenkernel/intern/workspace.c
M source/blender/blenkernel/intern/world.c
M source/blender/blenkernel/intern/writeffmpeg.c
M source/blender/blenkernel/nla_private.h
===================================================================
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h
index 4fc519ecd6d..f835f4332ed 100644
--- a/source/blender/blenkernel/BKE_DerivedMesh.h
+++ b/source/blender/blenkernel/BKE_DerivedMesh.h
@@ -134,8 +134,9 @@ struct DerivedMesh {
* \warning Typical access is done via #getLoopTriArray, #getNumLoopTri.
*/
struct {
- /* WARNING! swapping between array (ready-to-be-used data) and array_wip (where data is actually computed)
- * shall always be protected by same lock as one used for looptris computing. */
+ /* WARNING! swapping between array (ready-to-be-used data) and array_wip
+ * (where data is actually computed) shall always be protected by same
+ * lock as one used for looptris computing. */
struct MLoopTri *array, *array_wip;
int num;
int num_alloc;
diff --git a/source/blender/blenkernel/BKE_animsys.h b/source/blender/blenkernel/BKE_animsys.h
index 0503efb1661..583a90b2dee 100644
--- a/source/blender/blenkernel/BKE_animsys.h
+++ b/source/blender/blenkernel/BKE_animsys.h
@@ -95,7 +95,8 @@ void BKE_animdata_merge_copy(struct Main *bmain,
/* ************************************* */
/* KeyingSets API */
-/* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
+/* Used to create a new 'custom' KeyingSet for the user,
+ * that will be automatically added to the stack */
struct KeyingSet *BKE_keyingset_add(
struct ListBase *list, const char idname[], const char name[], short flag, short keyingflag);
diff --git a/source/blender/blenkernel/BKE_bvhutils.h b/source/blender/blenkernel/BKE_bvhutils.h
index 1d40ba0bc78..4b64b6fa269 100644
--- a/source/blender/blenkernel/BKE_bvhutils.h
+++ b/source/blender/blenkernel/BKE_bvhutils.h
@@ -84,11 +84,12 @@ typedef struct BVHTreeFromMesh {
/**
* Builds a bvh tree where nodes are the relevant elements of the given mesh.
- * Configures BVHTreeFromMesh.
+ * Configures #BVHTreeFromMesh.
*
* The tree is build in mesh space coordinates, this means special care must be made on queries
* so that the coordinates and rays are first translated on the mesh local coordinates.
- * Reason for this is that bvh_from_mesh_* can use a cache in some cases and so it becomes possible to reuse a BVHTree.
+ * Reason for this is that bvh_from_mesh_* can use a cache in some cases and so it
+ * becomes possible to reuse a #BVHTree.
*
* free_bvhtree_from_mesh should be called when the tree is no longer needed.
*/
diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h
index 9ad3657284d..8fe3bd77a26 100644
--- a/source/blender/blenkernel/BKE_constraint.h
+++ b/source/blender/blenkernel/BKE_constraint.h
@@ -101,13 +101,22 @@ typedef struct bConstraintTypeInfo {
void (*id_looper)(struct bConstraint *con, ConstraintIDFunc func, void *userdata);
/** copy any special data that is allocated separately (optional) */
void (*copy_data)(struct bConstraint *con, struct bConstraint *src);
- /** set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */
+ /**
+ * Set settings for data that will be used for #bConstraint.data
+ * (memory already allocated using #MEM_callocN).
+ */
void (*new_data)(void *cdata);
/* target handling function pointers */
- /** for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */
+ /**
+ * For multi-target constraints: return that list;
+ * otherwise make a temporary list (returns number of targets).
+ */
int (*get_constraint_targets)(struct bConstraint *con, struct ListBase *list);
- /** for single-target constraints only: flush data back to source data, and the free memory used */
+ /**
+ * For single-target constraints only:
+ * flush data back to source data, and the free memory used.
+ */
void (*flush_constraint_targets)(struct bConstraint *con, struct ListBase *list, bool no_copy);
/* evaluation */
diff --git a/source/blender/blenkernel/BKE_customdata.h b/source/blender/blenkernel/BKE_customdata.h
index e4dc8ffae02..f354e5e6de3 100644
--- a/source/blender/blenkernel/BKE_customdata.h
+++ b/source/blender/blenkernel/BKE_customdata.h
@@ -113,7 +113,8 @@ bool CustomData_has_referenced(const struct CustomData *data);
* implemented for mloopuv/mloopcol, for now.*/
void CustomData_data_copy_value(int type, const void *source, void *dest);
-/* Same as above, but doing advanced mixing. Only available for a few types of data (like colors...). */
+/* Same as above, but doing advanced mixing.
+ * Only available for a few types of data (like colors...). */
void CustomData_data_mix_value(
int type, const void *source, void *dest, const int mixmode, const float mixfactor);
@@ -478,8 +479,8 @@ typedef void (*cd_datatransfer_interp)(const struct CustomDataTransferLayerMap *
const float mix_factor);
/**
- * Fake CD_LAYERS (those are actually 'real' data stored directly into elements' structs, or otherwise not (directly)
- * accessible to usual CDLayer system). */
+ * Fake CD_LAYERS (those are actually 'real' data stored directly into elements' structs,
+ * or otherwise not (directly) accessible to usual CDLayer system). */
enum {
CD_FAKE = 1 << 8,
@@ -531,23 +532,29 @@ typedef struct CustomDataTransferLayerMap {
int data_type;
int mix_mode;
float mix_factor;
- const float *
- mix_weights; /* If non-NULL, array of weights, one for each dest item, replaces mix_factor. */
-
- const void *
- data_src; /* Data source array (can be regular CD data, vertices/edges/etc., keyblocks...). */
- void *data_dst; /* Data dest array (same type as dat_src). */
- int data_src_n; /* Index to affect in data_src (used e.g. for vgroups). */
- int data_dst_n; /* Index to affect in data_dst (used e.g. for vgroups). */
- size_t elem_size; /* Size of one element of data_src/data_dst. */
-
- size_t data_size; /* Size of actual data we transfer. */
- size_t
- data_offset; /* Offset of actual data we transfer (in element contained in data_src/dst). */
- uint64_t data_flag; /* For bitflag transfer, flag(s) to affect in transferred data. */
-
- void *
- interp_data; /* Opaque pointer, to be used by specific interp callback (e.g. transformspace for normals). */
+ /** If non-NULL, array of weights, one for each dest item, replaces mix_factor. */
+ const float *mix_weights;
+
+ /** Data source array (can be regular CD data, vertices/edges/etc., keyblocks...). */
+ const void *data_src;
+ /** Data dest array (same type as dat_src). */
+ void *data_dst;
+ /** Index to affect in data_src (used e.g. for vgroups). */
+ int data_src_n;
+ /** Index to affect in data_dst (used e.g. for vgroups). */
+ int data_dst_n;
+ /** Size of one element of data_src/data_dst. */
+ size_t elem_size;
+
+ /** Size of actual data we transfer. */
+ size_t data_size;
+ /** Offset of actual data we transfer (in element contained in data_src/dst). */
+ size_t data_offset;
+ /** For bitflag transfer, flag(s) to affect in transferred data. */
+ uint64_t data_flag;
+
+ /** Opaque pointer, to be used by specific interp callback (e.g. transformspace for normals). */
+ void *interp_data;
cd_datatransfer_interp interp;
} CustomDataTransferLayerMap;
diff --git a/source/blender/blenkernel/BKE_deform.h b/source/blender/blenkernel/BKE_deform.h
index 510e989a087..fd7fa632999 100644
--- a/source/blender/blenkernel/BKE_deform.h
+++ b/source/blender/blenkernel/BKE_deform.h
@@ -109,7 +109,8 @@ void defvert_normalize_lock_map(struct MDeformVert *dvert,
const bool *lock_flags,
const int defbase_tot);
-/* Utilities to 'extract' a given vgroup into a simple float array, for verts, but also edges/polys/loops. */
+/* Utilities to 'extract' a given vgroup into a simple float array,
+ * for verts, but also edges/polys/loops. */
void BKE_defvert_extract_vgroup_to_vertweights(struct MDeformVert *dvert,
const int defgroup,
const int num_verts,
diff --git a/source/blender/blenkernel/BKE_effect.h b/source/blender/blenkernel/BKE_effect.h
index 15b59993d77..94e8f4304b8 100644
--- a/source/blender/blenkernel/BKE_effect.h
+++ b/source/blender/blenkernel/BKE_effect.h
@@ -154,8 +154,14 @@ int get_effector_data(struct EffectorCache *eff,
int real_velocity);
/* required for particle_system.c */
-//void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
-//float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);
+#if 0
+void do_physical_effector(struct EffectorData *eff,
+ struct EffectorPoint *point,
+ float *total_force);
+float effector_falloff(struct EffectorData *eff,
+ struct EffectorPoint *point,
+ struct EffectorWeights *weights);
+#endif
/* EffectedPoint->flag */
#define PE_WIND_AS_SPEED 1
diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h
index 5e45faf1d0b..c1232addee3 100644
--- a/source/blender/blenkernel/BKE_fcurve.h
+++ b/source/blender/blenkernel/BKE_fcurve.h
@@ -128,29 +128,38 @@ float evaluate_driver(struct PathResolvedRNA *anim_rna,
*/
typedef struct FModifierTypeInfo {
/* admin/ident */
- short type; /* FMODIFIER_TYPE_### */
- short size; /* size in bytes of the struct */
- short acttype; /* eFMI_Action_Types */
- short requires; /* eFMI_Requirement_Flags */
- char name[64]; /* name of modifier in interface */
- char structName[64]; /* name of struct for SDNA */
- uint storage_size; /* size of buffer that can be reused between time and value evaluation */
+ /** #FMODIFIER_TYPE_* */
+ short type;
+ /** size in bytes of the struct. */
+ short size;
+ /** #eFMI_Action_Types. */
+ short acttype;
+ /** #eFMI_Requirement_Flags. */
+ sh
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list