From a207c1cdaf11864a413c5de3ade93f85a592b3cb Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 14 Dec 2021 18:35:23 +1100 Subject: Cleanup: resolve parameter mis-matches in doc-strings Renamed or removed parameters which no longer exist. --- source/blender/blenkernel/BKE_blendfile_link_append.h | 6 +++--- source/blender/blenkernel/BKE_bvhutils.h | 4 ++-- source/blender/blenkernel/BKE_displist.h | 2 +- source/blender/blenkernel/BKE_gpencil.h | 2 +- source/blender/blenkernel/BKE_gpencil_modifier.h | 2 +- source/blender/blenkernel/BKE_idtype.h | 2 +- source/blender/blenkernel/BKE_lib_override.h | 3 --- source/blender/blenkernel/BKE_lib_remap.h | 3 --- source/blender/blenkernel/BKE_main.h | 12 ++++-------- source/blender/blenkernel/BKE_nla.h | 6 +++--- source/blender/blenkernel/BKE_particle.h | 2 +- source/blender/blenkernel/intern/gpencil_modifier.c | 8 ++++---- 12 files changed, 21 insertions(+), 31 deletions(-) (limited to 'source/blender/blenkernel') diff --git a/source/blender/blenkernel/BKE_blendfile_link_append.h b/source/blender/blenkernel/BKE_blendfile_link_append.h index 52b8cc8c6f2..aaa31352316 100644 --- a/source/blender/blenkernel/BKE_blendfile_link_append.h +++ b/source/blender/blenkernel/BKE_blendfile_link_append.h @@ -38,9 +38,6 @@ typedef struct BlendfileLinkAppendContextItem BlendfileLinkAppendContextItem; /** * Allocate and initialize a new context to link/append data-blocks. - * - * \param flag: A combination of #eFileSel_Params_Flag from DNA_space_types.h & #eBLOLibLinkFlags - * from BLO_readfile.h */ BlendfileLinkAppendContext *BKE_blendfile_link_append_context_new( struct LibraryLink_Params *params); @@ -51,6 +48,9 @@ void BKE_blendfile_link_append_context_free(struct BlendfileLinkAppendContext *l /** * Set or clear flags in given \a lapp_context. * + * \param flag: A combination of: + * - #eFileSel_Params_Flag from `DNA_space_types.h` & + * - #eBLOLibLinkFlags * from `BLO_readfile.h`. * \param do_set: Set the given \a flag if true, clear it otherwise. */ void BKE_blendfile_link_append_context_flag_set(struct BlendfileLinkAppendContext *lapp_context, diff --git a/source/blender/blenkernel/BKE_bvhutils.h b/source/blender/blenkernel/BKE_bvhutils.h index 50fef9149ad..45c3a8ec159 100644 --- a/source/blender/blenkernel/BKE_bvhutils.h +++ b/source/blender/blenkernel/BKE_bvhutils.h @@ -143,7 +143,7 @@ BVHTree *bvhtree_from_mesh_verts_ex(struct BVHTreeFromMesh *data, const struct MVert *vert, const int verts_num, const bool vert_allocated, - const BLI_bitmap *mask, + const BLI_bitmap *verts_mask, int verts_num_active, float epsilon, int tree_type, @@ -207,7 +207,7 @@ BVHTree *bvhtree_from_mesh_faces_ex(struct BVHTreeFromMesh *data, const struct MFace *face, const int numFaces, const bool face_allocated, - const BLI_bitmap *mask, + const BLI_bitmap *faces_mask, int faces_num_active, float epsilon, int tree_type, diff --git a/source/blender/blenkernel/BKE_displist.h b/source/blender/blenkernel/BKE_displist.h index 12af80c2e30..db1217465d7 100644 --- a/source/blender/blenkernel/BKE_displist.h +++ b/source/blender/blenkernel/BKE_displist.h @@ -102,7 +102,7 @@ bool BKE_displist_surfindex_get( * \param normal_proj: Optional normal that's used to project the scan-fill verts into 2D coords. * Pass this along if known since it saves time calculating the normal. * This is also used to initialize #DispList.nors (one normal per display list). - * \param flipnormal: Flip the normal (same as passing \a normal_proj negated). + * \param flip_normal: Flip the normal (same as passing \a normal_proj negated). */ void BKE_displist_fill(const struct ListBase *dispbase, struct ListBase *to, diff --git a/source/blender/blenkernel/BKE_gpencil.h b/source/blender/blenkernel/BKE_gpencil.h index f1539c98522..a483d482bd5 100644 --- a/source/blender/blenkernel/BKE_gpencil.h +++ b/source/blender/blenkernel/BKE_gpencil.h @@ -471,7 +471,7 @@ struct Material *BKE_gpencil_brush_material_get(struct Brush *brush); /** * Set grease pencil brush material. * \param brush: Brush - * \param ma: Material + * \param material: Material */ void BKE_gpencil_brush_material_set(struct Brush *brush, struct Material *material); diff --git a/source/blender/blenkernel/BKE_gpencil_modifier.h b/source/blender/blenkernel/BKE_gpencil_modifier.h index d850dea0c30..5fc0abf6a2c 100644 --- a/source/blender/blenkernel/BKE_gpencil_modifier.h +++ b/source/blender/blenkernel/BKE_gpencil_modifier.h @@ -328,7 +328,7 @@ void BKE_gpencil_modifier_copydata_ex(struct GpencilModifierData *md, /** * Set grease pencil modifier error. * \param md: Modifier data. - * \param _format: Format. + * \param format: Format. */ void BKE_gpencil_modifier_set_error(struct GpencilModifierData *md, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3); diff --git a/source/blender/blenkernel/BKE_idtype.h b/source/blender/blenkernel/BKE_idtype.h index 0f63ff8a315..8cd5d2a2361 100644 --- a/source/blender/blenkernel/BKE_idtype.h +++ b/source/blender/blenkernel/BKE_idtype.h @@ -82,7 +82,7 @@ typedef void (*IDTypeCopyDataFunction)(struct Main *bmain, typedef void (*IDTypeFreeDataFunction)(struct ID *id); -/** \param flag: See BKE_lib_id.h's LIB_ID_MAKELOCAL_... flags. */ +/** \param flags: See BKE_lib_id.h's LIB_ID_MAKELOCAL_... flags. */ typedef void (*IDTypeMakeLocalFunction)(struct Main *bmain, struct ID *id, const int flags); typedef void (*IDTypeForeachIDFunction)(struct ID *id, struct LibraryForeachIDData *data); diff --git a/source/blender/blenkernel/BKE_lib_override.h b/source/blender/blenkernel/BKE_lib_override.h index 636d7842154..1c30db7a714 100644 --- a/source/blender/blenkernel/BKE_lib_override.h +++ b/source/blender/blenkernel/BKE_lib_override.h @@ -156,9 +156,6 @@ bool BKE_lib_override_library_proxy_convert(struct Main *bmain, * Convert all proxy objects into library overrides. * * \note Only affects local proxies, linked ones are not affected. - * - * \param view_layer: the active view layer to search instantiated collections in, can be NULL (in - * which case \a scene's master collection children hierarchy is used instead). */ void BKE_lib_override_library_main_proxy_convert(struct Main *bmain, struct BlendFileReadReport *reports); diff --git a/source/blender/blenkernel/BKE_lib_remap.h b/source/blender/blenkernel/BKE_lib_remap.h index f560780424e..9c8caa0266b 100644 --- a/source/blender/blenkernel/BKE_lib_remap.h +++ b/source/blender/blenkernel/BKE_lib_remap.h @@ -128,9 +128,6 @@ void BKE_libblock_unlink(struct Main *bmain, * * \param old_idv: Unlike BKE_libblock_remap, can be NULL, * in which case all ID usages by given \a idv will be cleared. - * \param us_min_never_null: If \a true and new_id is NULL, - * 'NEVER_NULL' ID usages keep their old id, but this one still gets its user count decremented - * (needed when given \a idv is going to be deleted right after being unlinked). */ void BKE_libblock_relink_ex(struct Main *bmain, void *idv, diff --git a/source/blender/blenkernel/BKE_main.h b/source/blender/blenkernel/BKE_main.h index df5c542db1e..953c29f797a 100644 --- a/source/blender/blenkernel/BKE_main.h +++ b/source/blender/blenkernel/BKE_main.h @@ -246,8 +246,7 @@ void BKE_main_library_weak_reference_destroy(struct GHash *library_weak_referenc * * \param library_weak_reference_mapping: the mapping data generated by * #BKE_main_library_weak_reference_create. - * \param library_relative_path: the path of a blend file library (relative to current working - * one). + * \param library_filepath: the path of a blend file library (relative to current working one). * \param library_id_name: the full ID name, including the leading two chars encoding the ID * type. */ @@ -260,8 +259,7 @@ struct ID *BKE_main_library_weak_reference_search_item( * * \param library_weak_reference_mapping: the mapping data generated by * #BKE_main_library_weak_reference_create. - * \param library_relative_path: the path of a blend file library (relative to current working - * one). + * \param library_filepath: the path of a blend file library (relative to current working one). * \param library_id_name: the full ID name, including the leading two chars encoding the ID type. * \param new_id: New local ID matching given weak reference. */ @@ -278,8 +276,7 @@ void BKE_main_library_weak_reference_add_item(struct GHash *library_weak_referen * * \param library_weak_reference_mapping: the mapping data generated by * #BKE_main_library_weak_reference_create. - * \param library_relative_path: the path of a blend file library (relative to current working - * one). + * \param library_filepath: the path of a blend file library (relative to current working one). * \param library_id_name: the full ID name, including the leading two chars encoding the ID type. * \param old_id: Existing local ID matching given weak reference. * \param new_id: New local ID matching given weak reference. @@ -294,8 +291,7 @@ void BKE_main_library_weak_reference_update_item(struct GHash *library_weak_refe * * \param library_weak_reference_mapping: the mapping data generated by * #BKE_main_library_weak_reference_create. - * \param library_relative_path: the path of a blend file library (relative to current working - * one). + * \param library_filepath: the path of a blend file library (relative to current working one). * \param library_id_name: the full ID name, including the leading two chars encoding the ID type. * \param old_id: Existing local ID matching given weak reference. */ diff --git a/source/blender/blenkernel/BKE_nla.h b/source/blender/blenkernel/BKE_nla.h index b53f8dbac68..b297851ad90 100644 --- a/source/blender/blenkernel/BKE_nla.h +++ b/source/blender/blenkernel/BKE_nla.h @@ -152,14 +152,14 @@ bool BKE_nlastrips_add_strip(ListBase *strips, struct NlaStrip *strip); * Convert 'islands' (i.e. continuous string of) selected strips to be * contained within 'Meta-Strips' which act as strips which contain strips. * - * \param temp: are the meta-strips to be created 'temporary' ones used for transforms? + * \param is_temp: are the meta-strips to be created 'temporary' ones used for transforms? */ void BKE_nlastrips_make_metas(ListBase *strips, bool is_temp); /** * Remove meta-strips (i.e. flatten the list of strips) from the top-level of the list of strips. * - * \param sel: only consider selected meta-strips, otherwise all meta-strips are removed - * \param onlyTemp: only remove the 'temporary' meta-strips used for transforms + * \param only_sel: only consider selected meta-strips, otherwise all meta-strips are removed + * \param only_temp: only remove the 'temporary' meta-strips used for transforms */ void BKE_nlastrips_clear_metas(ListBase *strips, bool only_sel, bool only_temp); /** diff --git a/source/blender/blenkernel/BKE_particle.h b/source/blender/blenkernel/BKE_particle.h index e3d59599ab3..972cba2d132 100644 --- a/source/blender/blenkernel/BKE_particle.h +++ b/source/blender/blenkernel/BKE_particle.h @@ -666,7 +666,7 @@ void psys_calc_dmcache(struct Object *ob, */ int psys_particle_dm_face_lookup(struct Mesh *mesh_final, struct Mesh *mesh_original, - int findex, + int findex_orig, const float fw[4], struct LinkNode **poly_nodes); diff --git a/source/blender/blenkernel/intern/gpencil_modifier.c b/source/blender/blenkernel/intern/gpencil_modifier.c index f3bd17d5ef7..62604286b43 100644 --- a/source/blender/blenkernel/intern/gpencil_modifier.c +++ b/source/blender/blenkernel/intern/gpencil_modifier.c @@ -536,14 +536,14 @@ GpencilModifierData *BKE_gpencil_modifiers_findby_type(Object *ob, GpencilModifi return md; } -void BKE_gpencil_modifier_set_error(GpencilModifierData *md, const char *_format, ...) +void BKE_gpencil_modifier_set_error(GpencilModifierData *md, const char *format, ...) { char buffer[512]; va_list ap; - const char *format = TIP_(_format); + const char *format_tip = TIP_(format); - va_start(ap, _format); - vsnprintf(buffer, sizeof(buffer), format, ap); + va_start(ap, format); + vsnprintf(buffer, sizeof(buffer), format_tip, ap); va_end(ap); buffer[sizeof(buffer) - 1] = '\0'; -- cgit v1.2.3