[Bf-blender-cvs] [33c30af7425] master: Cleanup: comments in struct declarations
Campbell Barton
noreply at git.blender.org
Mon Jan 16 03:28:23 CET 2023
Commit: 33c30af74256445c7cc2fece1b4ddfdd9a8233b3
Author: Campbell Barton
Date: Mon Jan 16 12:41:11 2023 +1100
Branches: master
https://developer.blender.org/rB33c30af74256445c7cc2fece1b4ddfdd9a8233b3
Cleanup: comments in struct declarations
Use a consistent style for declaring the names of struct members
in their declarations. Note that this convention was already used in
many places but not everywhere.
Remove spaces around the text (matching commented arguments) with
the advantage that the the spell checking utility skips these terms.
Making it possible to extract & validate these comments automatically.
Also use struct names for `bAnimChannelType` & `bConstraintTypeInfo`
which were using brief descriptions.
===================================================================
M intern/ghost/intern/GHOST_SystemWayland.cpp
M source/blender/blenkernel/intern/action.c
M source/blender/blenkernel/intern/brush.cc
M source/blender/blenkernel/intern/constraint.c
M source/blender/blenkernel/intern/curve.cc
M source/blender/blenkernel/intern/curves.cc
M source/blender/blenkernel/intern/customdata.cc
M source/blender/blenkernel/intern/fmodifier.c
M source/blender/blenkernel/intern/key.cc
M source/blender/blenkernel/intern/linestyle.cc
M source/blender/blenkernel/intern/material.cc
M source/blender/blenkernel/intern/mball.cc
M source/blender/blenkernel/intern/mesh.cc
M source/blender/blenkernel/intern/node.cc
M source/blender/blenkernel/intern/object.cc
M source/blender/blenkernel/intern/object_dupli.cc
M source/blender/blenkernel/intern/paint.cc
M source/blender/blenkernel/intern/pointcloud.cc
M source/blender/blenkernel/intern/simulation.cc
M source/blender/blenkernel/intern/texture.cc
M source/blender/blenkernel/intern/volume.cc
M source/blender/blenkernel/intern/workspace.cc
M source/blender/draw/engines/basic/basic_engine.c
M source/blender/draw/engines/compositor/compositor_engine.cc
M source/blender/draw/engines/eevee/eevee_engine.c
M source/blender/draw/engines/external/external_engine.c
M source/blender/draw/engines/gpencil/gpencil_engine.c
M source/blender/draw/engines/image/image_engine.cc
M source/blender/draw/engines/select/select_debug_engine.c
M source/blender/draw/engines/select/select_engine.c
M source/blender/draw/engines/workbench/workbench_engine.c
M source/blender/draw/intern/draw_manager.c
M source/blender/editors/animation/anim_channels_defines.c
M source/blender/editors/animation/anim_channels_edit.c
M source/blender/editors/animation/keyframes_draw.c
M source/blender/editors/animation/keyframes_keylist.cc
M source/blender/editors/asset/intern/asset_ops.cc
M source/blender/editors/include/ED_file_indexer.h
M source/blender/editors/space_file/file_indexer.cc
M source/blender/editors/transform/transform_convert_action.c
M source/blender/editors/transform/transform_convert_armature.c
M source/blender/editors/transform/transform_convert_cursor.c
M source/blender/editors/transform/transform_convert_curve.c
M source/blender/editors/transform/transform_convert_gpencil.c
M source/blender/editors/transform/transform_convert_graph.c
M source/blender/editors/transform/transform_convert_lattice.c
M source/blender/editors/transform/transform_convert_mask.c
M source/blender/editors/transform/transform_convert_mball.c
M source/blender/editors/transform/transform_convert_mesh.c
M source/blender/editors/transform/transform_convert_mesh_edge.c
M source/blender/editors/transform/transform_convert_mesh_skin.c
M source/blender/editors/transform/transform_convert_mesh_uv.c
M source/blender/editors/transform/transform_convert_mesh_vert_cdata.c
M source/blender/editors/transform/transform_convert_nla.c
M source/blender/editors/transform/transform_convert_node.cc
M source/blender/editors/transform/transform_convert_object.c
M source/blender/editors/transform/transform_convert_object_texspace.c
M source/blender/editors/transform/transform_convert_paintcurve.c
M source/blender/editors/transform/transform_convert_particle.c
M source/blender/editors/transform/transform_convert_sculpt.c
M source/blender/editors/transform/transform_convert_sequencer.c
M source/blender/editors/transform/transform_convert_sequencer_image.c
M source/blender/editors/transform/transform_convert_tracking.c
M source/blender/freestyle/intern/blender_interface/FRS_freestyle.cpp
M source/blender/gpencil_modifiers/intern/MOD_gpencilarmature.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilarray.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilbuild.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilcolor.c
M source/blender/gpencil_modifiers/intern/MOD_gpencildash.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilenvelope.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilhook.c
M source/blender/gpencil_modifiers/intern/MOD_gpencillattice.c
M source/blender/gpencil_modifiers/intern/MOD_gpencillength.c
M source/blender/gpencil_modifiers/intern/MOD_gpencillineart.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilmirror.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilmultiply.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilnoise.c
M source/blender/gpencil_modifiers/intern/MOD_gpenciloffset.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilopacity.c
M source/blender/gpencil_modifiers/intern/MOD_gpenciloutline.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilshrinkwrap.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilsimplify.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilsmooth.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilsubdiv.c
M source/blender/gpencil_modifiers/intern/MOD_gpenciltexture.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilthick.c
M source/blender/gpencil_modifiers/intern/MOD_gpenciltime.c
M source/blender/gpencil_modifiers/intern/MOD_gpenciltint.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilweight_angle.c
M source/blender/gpencil_modifiers/intern/MOD_gpencilweight_proximity.c
M source/blender/makesrna/intern/rna_key.c
M source/blender/modifiers/intern/MOD_armature.c
M source/blender/modifiers/intern/MOD_array.cc
M source/blender/modifiers/intern/MOD_bevel.c
M source/blender/modifiers/intern/MOD_boolean.cc
M source/blender/modifiers/intern/MOD_build.c
M source/blender/modifiers/intern/MOD_cast.c
M source/blender/modifiers/intern/MOD_cloth.c
M source/blender/modifiers/intern/MOD_collision.c
M source/blender/modifiers/intern/MOD_correctivesmooth.c
M source/blender/modifiers/intern/MOD_curve.c
M source/blender/modifiers/intern/MOD_datatransfer.cc
M source/blender/modifiers/intern/MOD_decimate.c
M source/blender/modifiers/intern/MOD_displace.cc
M source/blender/modifiers/intern/MOD_dynamicpaint.c
M source/blender/modifiers/intern/MOD_edgesplit.c
M source/blender/modifiers/intern/MOD_explode.c
M source/blender/modifiers/intern/MOD_fluid.c
M source/blender/modifiers/intern/MOD_hook.c
M source/blender/modifiers/intern/MOD_laplaciandeform.c
M source/blender/modifiers/intern/MOD_laplaciansmooth.c
M source/blender/modifiers/intern/MOD_lattice.c
M source/blender/modifiers/intern/MOD_mask.cc
M source/blender/modifiers/intern/MOD_mesh_to_volume.cc
M source/blender/modifiers/intern/MOD_meshcache.c
M source/blender/modifiers/intern/MOD_meshdeform.c
M source/blender/modifiers/intern/MOD_meshsequencecache.cc
M source/blender/modifiers/intern/MOD_mirror.cc
M source/blender/modifiers/intern/MOD_multires.cc
M source/blender/modifiers/intern/MOD_nodes.cc
M source/blender/modifiers/intern/MOD_none.c
M source/blender/modifiers/intern/MOD_normal_edit.cc
M source/blender/modifiers/intern/MOD_ocean.c
M source/blender/modifiers/intern/MOD_particleinstance.c
M source/blender/modifiers/intern/MOD_particlesystem.cc
M source/blender/modifiers/intern/MOD_remesh.c
M source/blender/modifiers/intern/MOD_screw.cc
M source/blender/modifiers/intern/MOD_shapekey.c
M source/blender/modifiers/intern/MOD_shrinkwrap.c
M source/blender/modifiers/intern/MOD_simpledeform.c
M source/blender/modifiers/intern/MOD_skin.c
M source/blender/modifiers/intern/MOD_smooth.c
M source/blender/modifiers/intern/MOD_softbody.c
M source/blender/modifiers/intern/MOD_solidify.c
M source/blender/modifiers/intern/MOD_subsurf.cc
M source/blender/modifiers/intern/MOD_surface.c
M source/blender/modifiers/intern/MOD_surfacedeform.c
M source/blender/modifiers/intern/MOD_triangulate.cc
M source/blender/modifiers/intern/MOD_uvproject.cc
M source/blender/modifiers/intern/MOD_uvwarp.cc
M source/blender/modifiers/intern/MOD_volume_displace.cc
M source/blender/modifiers/intern/MOD_volume_to_mesh.cc
M source/blender/modifiers/intern/MOD_warp.c
M source/blender/modifiers/intern/MOD_wave.cc
M source/blender/modifiers/intern/MOD_weighted_normal.cc
M source/blender/modifiers/intern/MOD_weightvgedit.cc
M source/blender/modifiers/intern/MOD_weightvgmix.cc
M source/blender/modifiers/intern/MOD_weightvgproximity.cc
M source/blender/modifiers/intern/MOD_weld.cc
M source/blender/modifiers/intern/MOD_wireframe.c
M source/blender/python/intern/bpy_rna.c
M source/blender/sequencer/intern/modifier.c
M source/blender/shader_fx/intern/FX_shader_blur.c
M source/blender/shader_fx/intern/FX_shader_colorize.c
M source/blender/shader_fx/intern/FX_shader_flip.c
M source/blender/shader_fx/intern/FX_shader_glow.c
M source/blender/shader_fx/intern/FX_shader_pixel.c
M source/blender/shader_fx/intern/FX_shader_rim.c
M source/blender/shader_fx/intern/FX_shader_shadow.c
M source/blender/shader_fx/intern/FX_shader_swirl.c
M source/blender/shader_fx/intern/FX_shader_wave.c
===================================================================
diff --git a/intern/ghost/intern/GHOST_SystemWayland.cpp b/intern/ghost/intern/GHOST_SystemWayland.cpp
index d9e5b0c4e9d..fbe5159ea78 100644
--- a/intern/ghost/intern/GHOST_SystemWayland.cpp
+++ b/intern/ghost/intern/GHOST_SystemWayland.cpp
@@ -280,41 +280,41 @@ struct GWL_ModifierInfo {
};
static const GWL_ModifierInfo g_modifier_info_table[MOD_INDEX_NUM] = {
- /* MOD_INDEX_SHIFT */
+ /*MOD_INDEX_SHIFT*/
{
- /* display_name */ "Shift",
- /* xkb_id */ XKB_MOD_NAME_SHIFT,
- /* key_l */ GHOST_kKeyLeftShift,
- /* key_r */ GHOST_kKeyRightShift,
- /* mod_l */ GHOST_kModifierKeyLeftShift,
- /* mod_r */ GHOST_kModifierKeyRightShift,
+ /*display_name*/ "Shift",
+ /*xkb_id*/ XKB_MOD_NAME_SHIFT,
+ /*key_l*/ GHOST_kKeyLeftShift,
+ /*key_r*/ GHOST_kKeyRightShift,
+ /*mod_l*/ GHOST_kModifierKeyLeftShift,
+ /*mod_r*/ GHOST_kModifierKeyRightShift,
},
- /* MOD_INDEX_ALT */
+ /*MOD_INDEX_ALT*/
{
- /* display_name */ "Alt",
- /* xkb_id */ XKB_MOD_NAME_ALT,
- /* key_l */ GHOST_kKeyLeftAlt,
- /* key_r */ GHOST_kKeyRightAlt,
- /* mod_l */ GHOST_kModifierKeyLeftAlt,
- /* mod_r */ GHOST_kModifierKeyRightAlt,
+ /*display_name*/ "Alt",
+ /*xkb_id*/ XKB_MOD_NAME_ALT,
+ /*key_l*/ GHOST_kKeyLeftAlt,
+ /*key_r*/ GHOST_kKeyRightAlt,
+ /*mod_l*/ GHOST_kModifierKeyLeftAlt,
+ /*mod_r*/ GHOST_kModifierKeyRightAlt,
},
- /* MOD_INDEX_CTRL */
+ /*MOD_INDEX_CTRL*/
{
- /* display_name */ "Control",
- /* xkb_id */ XKB_MOD_NAME_CTRL,
- /* key_l */ GHOST_kKeyLeftControl,
- /* key_r */ GHOST_kKeyRightControl,
- /* mod_l */ GHOST_kModifierKeyLeftControl,
- /* mod_r */ GHOST_kModifierKeyRightControl,
+ /*display_name*/ "Control",
+ /*xkb_id*/ XKB_MOD_NAME_CTRL,
+ /*key_l*/ GHOST_kKeyLeftControl,
+ /*key_r*/ GHOST_kKeyRightControl,
+ /*mod_l*/ GHOST_kModifierKeyLeftControl,
+ /*mod_r*/ GHOST_kModifierKeyRightControl,
},
- /* MOD_INDEX_OS */
+ /*MOD_INDEX_OS*/
{
- /* display_name */ "OS",
- /* xkb_id */ XKB_MOD_NAME_LOGO,
- /* key_l */ GHOST_kKeyLeftOS,
- /* key_r */ GHOST_kKeyRightOS,
- /* mod_l */ GHOST_kModifierKeyLeftOS,
- /* mod_r */ GHOST_kModifierKeyRightOS,
+ /*display_name*/ "OS",
+ /*xkb_id*/ XKB_MOD_NAME_LOGO,
+ /*key_l*/ GHOST_kKeyLeftOS,
+ /*key_r*/ GHOST_kKeyRightOS,
+ /*mod_l*/ GHOST_kModifierKeyLeftOS,
+ /*mod_r*/ GHOST_kModifierKeyRightOS,
},
};
diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c
index dcd0c25967b..d4a7a7cbb1e 100644
--- a/source/blender/blenkernel/intern/action.c
+++ b/source/blender/blenkernel/intern/action.c
@@ -294,7 +294,7 @@ static void action_asset_pre_save(void *asset_ptr, struct AssetMetaData *asset_d
}
static AssetTypeInfo AssetType_AC = {
- /* pre_save_fn */ action_asset_pre_save,
+ /*pre_save_fn*/ action_asset_pre_save,
};
IDTypeInfo IDType_ID_AC = {
diff --git a/source/blender/blenkernel/intern/brush.cc b/source/blender/blenkernel/intern/brush.cc
index 28baa871e12..414a316ba7a 100644
--- a/source/blender/blenkernel/intern/brush.cc
+++ b/source/blender/blenkernel/intern/brush.cc
@@ -411,33 +411,33 @@ static void brush_undo_preserve(BlendLibReader *reader, ID *id_new, ID *id_old)
}
IDTypeInfo IDType_ID_BR = {
- /* id_code */ ID_BR,
- /* id_filter */ FILTER_ID_BR,
- /* main_listbase_index */ INDEX_ID_BR,
- /* struct_size */ sizeof(Brush),
- /* name */ "Brush",
- /* name_plural */ "brushes",
- /* translation_context */ BLT_I18NCONTEXT_ID_BRUSH,
- /* flags */ IDTYPE_FLAGS_NO_ANIMDATA,
- /* asset_type_info */ nullptr,
-
- /* init_data */ brush_init_data,
- /* copy_data */ brush_copy_data,
- /* free_data */ brush_free_data,
- /* make_local */ brush_make_local,
- /* foreach_id */ brush_foreach_id,
- /* foreach_cache */ nullptr,
- /* foreach_path */ brush_foreach_path,
- /* owner_pointer_get */ nullptr,
-
- /* blend_write */ brush_blend_write,
- /* blend_read_data */ brush_blend_read_data,
- /* blend_read_lib */ brush_blend_read_lib,
- /* blend_read_expand */ brush_blend_read_expand,
-
- /* blend_read_undo_preserve */ brush_undo_preserve,
-
- /* lib_override_apply_post */ nullptr,
+ /*id_code*/ ID_BR,
+ /*id_filter*/ FILTER_ID_BR,
+ /*main_listbase_index*/ INDEX_ID_BR,
+ /*struct_size*/ sizeof(Brush),
+ /*name*/ "Brush",
+ /*name_plural*/ "brushes",
+ /*translation_context*/ BLT_I18NCONTEXT_ID_BRUSH,
+ /*flags*/ IDTYPE_FLAGS_NO_ANIMDATA,
+ /*asset_type_info*/ nullptr,
+
+ /*init_data*/ brush_init_data,
+ /*copy_data*/ brush_copy_data,
+ /*free_data*/ brush_free_data,
+ /*make_local*/ brush_make_local,
+ /*foreach_id*/ brush_foreach_id,
+ /*foreach_cache*/ nullptr,
+ /*foreach_path*/ brush_foreach_path,
+ /*owner_pointer_get*/ nullptr,
+
+ /*blend_write*/ brush_blend_write,
+ /*blend_read_data*/ brush_blend_read_data,
+ /*blend_read_lib*/ brush_blend_read_lib,
+ /*blend_read_expand*/ brush_blend_read_expand,
+
+ /*blend_read_undo_preserve*/ brush_undo_preserve,
+
+ /*lib_override_apply_post*/ nullptr,
};
static RNG *brush_rng;
diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c
index 4ebf7d184b3..93ab47651ed 100644
--- a/source/blender/blenkernel/intern/constraint.c
+++ b/source/blender/blenkernel/intern/constraint.c
@@ -787,18 +787,18 @@ static void constraint_target_to_mat4(Object *ob,
*/
#if 0
static bConstraintTypeInfo CTI_CONSTRNAME = {
- CONSTRAINT_TYPE_CONSTRNAME, /* type */
- sizeof(bConstrNameConstraint), /* size */
- "ConstrName", /* name */
- "bConstrNameConstraint", /* struct name */
- constrname_free, /* free data */
- constrname_id_looper, /* id looper */
- constrname_copy, /* copy data */
- constrname_new_data, /* new data */
- constrname_get_tars, /* get constraint targets */
- constrname_flush_tars, /* flush constraint targets */
- constrname_get_tarmat, /* get target matrix */
- constrname_evaluate, /* evaluate */
+ /*type*/ CONSTRAINT_TYPE_CONSTRNAME,
+ /*size*/ sizeof(bConstrNameConstraint),
+ /*name*/ "ConstrName",
+ /*structName*/ "bConstrNameConstraint",
+ /*free_data*/ constrname_free,
+ /*id_looper*/ constrname_id_looper,
+ /*copy_data*/ constrname_copy,
+ /*new_data*/ constrname_new_data,
+ /*get_constraint_targets*/ constrname_get_tars,
+ /*flush_constraint_targets*/ constrname_flush_tars,
+ /*get_target_matrix*/ constrname_get_tarmat,
+ /*evaluate_constraint*/ constrname_evaluate,
};
#endif
@@ -1109,18 +1109,18 @@ static void childof_evaluate(bConstraint *con, bConstraintOb *cob, ListBase *tar
/* XXX NOTE: con->flag should be CONSTRAINT_SPACEONCE for bone-childof, patched in `readfile.c`. */
static bConstraintTypeInfo CTI_CHILDOF = {
- CONSTRAINT_TYPE_CHILDOF, /* type */
- sizeof(bChildOfConstraint), /* size */
- N_("Child Of"), /* name */
- "bChildOfConstraint", /* struct name */
- NULL, /* free data */
- childof_id_looper, /* id looper */
- NULL, /* copy data */
- childof_new_data, /* new data */
- childof_get_tars, /* get constraint targets */
- childof_flush_tars, /* flush constraint targets */
- default_get_tarmat, /* get a target matrix */
- childof_evaluate, /* evaluate */
+ /*type*/ CONSTRAINT_TYPE_CHILDOF,
+ /*size*/ sizeof(bChildOfConstraint),
+ /*name*/ N_("Child Of"),
+ /*structName*/ "bChildOfConstraint",
+ /*free_data*/ NULL,
+ /*id_looper*/ childof_id_looper,
+ /*copy_data*/ NULL,
+ /*new_data*/ childof_new_data,
+ /*get_constraint_targets*/ childof_get_tars,
+ /*flush_constraint_targets*/ childof_flush_tars,
+ /* get a target matrix */ default_get_tarmat,
+ /*evaluate_constraint*/ childof_evaluate,
};
/* -------- TrackTo Constraint ------- */
@@ -1293,18 +1293,18 @@ static void trackto_evaluate(bConstraint *con, bConstraintOb *cob, ListBase *tar
}
static bConstraintTypeInfo CTI_TRACKTO = {
- CONSTRAINT_TYPE_TRACKTO, /* type */
- sizeof(bTrackToConstraint), /* size */
- N_("Track To"), /* name */
- "bTrackToConstraint", /* struct name */
- NULL, /* free data */
- trackto_id_looper, /* id looper */
- NULL, /* copy data */
- trackto_new_data, /* new data */
- trackto_get_tars, /* get constraint targets */
- trackto_flush_tars, /* flush constraint targets */
- default_get_tarmat, /* get target matrix */
- trackto_evaluate, /* evaluate */
+ /*type*/ CONSTRAINT_TYPE_TRACKTO,
+ /*size*/ sizeof(bTrackToConstraint),
+ /*name*/ N_("Track To"),
+ /*structName*/ "bTrackToConstraint",
+ /*free_data*/ NULL,
+ /*id_looper*/ trackto_id_looper,
+ /*copy_data*/ NULL,
+ /*new_data*/ trackto_new_data,
+ /*get_constraint_targets*/ trackto_get_tars,
+ /*flush_constraint_targets*/ trackto_flush_tars,
+ /*get_target_matrix*/ default_get_tarmat,
+ /*evaluate_constraint*/ trackto_evaluate,
};
/* --------- Inverse-Kinematics --------- */
@@ -1399,18 +1399,18 @@ static void kinematic_get_tarmat(struct Depsgraph *UNUSED(depsgraph),
}
static bConstraintTypeInfo CTI_KINEMATIC = {
- CONSTRAINT_TYPE_KINEMATIC, /* type */
- sizeof(bKinematicConstraint), /* size */
- N_("IK"), /* name */
- "bKinematicConstraint", /* struct name */
- NULL, /* free data */
- kinematic_id_looper, /* id looper */
- NULL, /* copy data */
- kinematic_new_data, /* new data */
- kinematic_get_tars, /*
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list