[Bf-blender-cvs] [1fbcb2ba851] temp-gpu-image-engine: Cleanup: resolve parameter mis-matches in doc-strings
Campbell Barton
noreply at git.blender.org
Wed Dec 15 14:37:49 CET 2021
Commit: 1fbcb2ba8517c2334c602924de14b49a4c5387ff
Author: Campbell Barton
Date: Tue Dec 14 18:35:23 2021 +1100
Branches: temp-gpu-image-engine
https://developer.blender.org/rB1fbcb2ba8517c2334c602924de14b49a4c5387ff
Cleanup: resolve parameter mis-matches in doc-strings
Renamed or removed parameters which no longer exist.
===================================================================
M intern/ghost/intern/GHOST_Window.h
M source/blender/blenkernel/BKE_blendfile_link_append.h
M source/blender/blenkernel/BKE_bvhutils.h
M source/blender/blenkernel/BKE_displist.h
M source/blender/blenkernel/BKE_gpencil.h
M source/blender/blenkernel/BKE_gpencil_modifier.h
M source/blender/blenkernel/BKE_idtype.h
M source/blender/blenkernel/BKE_lib_override.h
M source/blender/blenkernel/BKE_lib_remap.h
M source/blender/blenkernel/BKE_main.h
M source/blender/blenkernel/BKE_nla.h
M source/blender/blenkernel/BKE_particle.h
M source/blender/blenkernel/intern/gpencil_modifier.c
M source/blender/blenlib/BLI_math_rotation.h
M source/blender/blenlib/BLI_memiter.h
M source/blender/blenlib/BLI_string.h
M source/blender/blenlib/BLI_string_utf8.h
M source/blender/blenlib/BLI_string_utils.h
M source/blender/blenlib/BLI_timecode.h
M source/blender/blenloader/BLO_readfile.h
M source/blender/bmesh/intern/bmesh_mesh_partial_update.h
M source/blender/bmesh/intern/bmesh_polygon_edgenet.h
M source/blender/bmesh/intern/bmesh_query.h
M source/blender/compositor/COM_compositor.h
M source/blender/depsgraph/intern/builder/deg_builder_nodes.h
M source/blender/editors/gpencil/gpencil_intern.h
M source/blender/editors/include/ED_gpencil.h
M source/blender/editors/include/ED_keyframes_edit.h
M source/blender/editors/include/ED_view3d.h
M source/blender/editors/include/UI_interface.h
M source/blender/editors/include/UI_view2d.h
M source/blender/editors/transform/transform_snap_object.c
M source/blender/freestyle/intern/image/GaussianFilter.h
M source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h
M source/blender/freestyle/intern/winged_edge/Curvature.h
M source/blender/gpu/GPU_immediate_util.h
M source/blender/gpu/intern/gpu_immediate_util.c
M source/blender/imbuf/IMB_imbuf.h
M source/blender/imbuf/intern/IMB_filetype.h
M source/blender/sequencer/SEQ_add.h
M source/blender/sequencer/SEQ_edit.h
M source/blender/sequencer/SEQ_iterator.h
M source/blender/windowmanager/WM_api.h
===================================================================
diff --git a/intern/ghost/intern/GHOST_Window.h b/intern/ghost/intern/GHOST_Window.h
index f061e07b3c8..69d0eea838c 100644
--- a/intern/ghost/intern/GHOST_Window.h
+++ b/intern/ghost/intern/GHOST_Window.h
@@ -42,10 +42,9 @@ class GHOST_Window : public GHOST_IWindow {
* Creates a new window and opens it.
* To check if the window was created properly, use the getValid() method.
* \param width: The width the window.
- * \param heigh: The height the window.
+ * \param height: The height the window.
* \param state: The state the window is initially opened with.
- * \param type: The type of drawing context installed in this window.
- * \param stereoVisual: Stereo visual for quad buffered stereo.
+ * \param wantStereoVisual: Stereo visual for quad buffered stereo.
* \param exclusive: Use to show the window ontop and ignore others (used full-screen).
*/
GHOST_Window(uint32_t width,
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/sou
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list