blender
/
blender
136
406
Fork 588
Code Issues 6.2k Pull Requests 754 Projects 19 Wiki Activity

Cleanup: resolve parameter mis-matches in doc-strings 

Renamed or removed parameters which no longer exist.
This commit is contained in:
Campbell Barton 2021-12-14 18:35:23 +11:00
parent c097c7b855
commit a207c1cdaf
43 changed files with 122 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
intern/ghost/intern/GHOST_Window.h
View File

@ -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,

6
source/blender/blenkernel/BKE_blendfile_link_append.h
View File

@ -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,

4
source/blender/blenkernel/BKE_bvhutils.h
View File

@ -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,

2
source/blender/blenkernel/BKE_displist.h
View File

@ -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,

2
source/blender/blenkernel/BKE_gpencil.h
View File

@ -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);

2
source/blender/blenkernel/BKE_gpencil_modifier.h
View File

@ -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);

2
source/blender/blenkernel/BKE_idtype.h
View File

@ -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);

3
source/blender/blenkernel/BKE_lib_override.h
View File

@ -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);

3
source/blender/blenkernel/BKE_lib_remap.h
View File

@ -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,

12
source/blender/blenkernel/BKE_main.h
View File

@ -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.
*/

6
source/blender/blenkernel/BKE_nla.h
View File

@ -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);
/**

2
source/blender/blenkernel/BKE_particle.h
View File

@ -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);

8
source/blender/blenkernel/intern/gpencil_modifier.c
View File

@ -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';

2
source/blender/blenlib/BLI_math_rotation.h
View File

@ -118,7 +118,7 @@ bool is_zero_qt(const float q[4]);
* \param cosom: dot product from normalized vectors/quats.
* \param r_w: calculated weights.
*/
void interp_dot_slerp(const float t, const float cosom, float w[2]);
void interp_dot_slerp(const float t, const float cosom, float r_w[2]);
void interp_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);
void add_qt_qtqt(float q[4], const float a[4], const float b[4], const float t);

2
source/blender/blenlib/BLI_memiter.h
View File

@ -44,7 +44,7 @@ typedef struct BLI_memiter BLI_memiter;
*
* Its intended that many elements can be stored per chunk.
*/
BLI_memiter *BLI_memiter_create(unsigned int chunk_size)
BLI_memiter *BLI_memiter_create(unsigned int chunk_size_min)
ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
void *BLI_memiter_alloc(BLI_memiter *mi, unsigned int size)
/* WARNING: `ATTR_MALLOC` attribute on #BLI_memiter_alloc causes crash, see: D2756. */

2
source/blender/blenlib/BLI_string.h
View File

@ -176,7 +176,7 @@ char *BLI_str_replaceN(const char *__restrict str,
* \param src: The character to replace.
* \param dst: The character to replace with.
*/
void BLI_str_replace_char(char *string, char src, char dst) ATTR_NONNULL();
void BLI_str_replace_char(char *str, char src, char dst) ATTR_NONNULL();
/**
* Simple exact-match string replacement.

4
source/blender/blenlib/BLI_string_utf8.h
View File

@ -125,8 +125,8 @@ size_t BLI_str_utf32_as_utf8_len(const char32_t *src) ATTR_WARN_UNUSED_RESULT AT
/**
* BLI_str_find_prev_char_utf8:
* \param str: pointer to the beginning of a UTF-8 encoded string
* \param p: pointer to some position within \a str
* \param str_start: pointer to the beginning of a UTF-8 encoded string
*
* Given a position \a p with a UTF-8 encoded string \a str, find the start
* of the previous UTF-8 character starting before. \a p Returns \a str_start if no
@ -142,7 +142,7 @@ const char *BLI_str_find_prev_char_utf8(const char *p, const char *str_start)
ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL ATTR_NONNULL(1, 2);
/**
* \param p: a pointer to a position within a UTF-8 encoded string
* \param end: a pointer to the byte following the end of the string.
* \param str_end: a pointer to the byte following the end of the string.
*
* Finds the start of the next UTF-8 character in the string after \a p
*

2
source/blender/blenlib/BLI_string_utils.h
View File

@ -163,7 +163,7 @@ bool BLI_uniquename(struct ListBase *list,
const char *defname,
char delim,
int name_offset,
size_t len);
size_t name_len);
#ifdef __cplusplus
}

2
source/blender/blenlib/BLI_timecode.h
View File

@ -45,7 +45,7 @@ size_t BLI_timecode_string_from_time(char *str,
const size_t maxncpy,
const int brevity_level,
const float time_seconds,
const double scene_fps,
const double fps,
const short timecode_style) ATTR_NONNULL();
/**

4
source/blender/blenloader/BLO_readfile.h
View File

@ -226,8 +226,8 @@ BlendHandle *BLO_blendhandle_from_memory(const void *mem,
*
* \param bh: The blendhandle to access.
* \param ofblocktype: The type of names to get.
* \param tot_names: The length of the returned list.
* \param use_assets_only: Only list IDs marked as assets.
* \param r_tot_names: The length of the returned list.
* \return A BLI_linklist of strings. The string links should be freed with #MEM_freeN().
*/
struct LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh,
@ -242,7 +242,7 @@ struct LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh,
* \param bh: The blendhandle to access.
* \param ofblocktype: The type of names to get.
* \param use_assets_only: Limit the result to assets only.
* \param tot_info_items: The length of the returned list.
* \param r_tot_info_items: The length of the returned list.
* \return A BLI_linklist of `BLODataBlockInfo *`.
* The links and #BLODataBlockInfo.asset_data should be freed with MEM_freeN.
*/

4
source/blender/bmesh/intern/bmesh_mesh_partial_update.h
View File

@ -85,12 +85,12 @@ BMPartialUpdate *BM_mesh_partial_create_from_verts_group_single(
* since one side needs to have a different group to the other since a face that has vertices
* attached to both won't have an affine transformation.
*
* \param verts_groups: Vertex aligned array of groups.
* \param verts_group: Vertex aligned array of groups.
* Values are used as follows:
* - >0: Each face is grouped with other faces of the same group.
* - 0: Not in a group (don't handle these).
* - -1: Don't use grouping logic (include any face that contains a vertex with this group).
* \param verts_groups_count: The number of non-zero values in `verts_groups`.
* \param verts_group_count: The number of non-zero values in `verts_groups`.
*/
BMPartialUpdate *BM_mesh_partial_create_from_verts_group_multi(
BMesh *bm,

2
source/blender/bmesh/intern/bmesh_polygon_edgenet.h
View File

@ -48,7 +48,7 @@ bool BM_face_split_edgenet_connect_islands(BMesh *bm,
BMEdge **edge_net_init,
const uint edge_net_init_len,
bool use_partial_connect,
struct MemArena *arena,
struct MemArena *mem_arena,
BMEdge ***r_edge_net_new,
uint *r_edge_net_new_len) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL(1, 2, 3, 6, 7, 8);

2
source/blender/bmesh/intern/bmesh_query.h
View File

@ -421,7 +421,7 @@ float BM_loop_calc_face_normal_safe(const BMLoop *l, float r_normal[3]) ATTR_NON
* \param epsilon_sq: Value to avoid numeric errors (1e-5f works well).
* \param r_normal: Resulting normal.
*/
float BM_loop_calc_face_normal_safe_ex(const BMLoop *l, const float epsilon, float r_normal[3])
float BM_loop_calc_face_normal_safe_ex(const BMLoop *l, const float epsilon_sq, float r_normal[3])
ATTR_NONNULL();
/**
* A version of BM_loop_calc_face_normal_safe_ex which takes vertex coordinates.

4
source/blender/compositor/COM_compositor.h
View File

@ -301,10 +301,10 @@ extern "C" {
* It can be executed during editing (blenkernel/node.cc) or rendering
* (renderer/pipeline.c)
*
* \param rd: [struct RenderData]
* \param render_data: [struct RenderData]
* Render data for this composite, this won't always belong to a scene.
*
* \param editingtree: [struct bNodeTree]
* \param node_tree: [struct bNodeTree]
* reference to the compositor editing tree
*
* \param rendering: [true false]

2
source/blender/depsgraph/intern/builder/deg_builder_nodes.h
View File

@ -217,7 +217,7 @@ class DepsgraphNodeBuilder : public DepsgraphBuilder {
/**
* Build graph node(s) for Driver
* \param id: ID-Block that driver is attached to
* \param fcu: Driver-FCurve
* \param fcurve: Driver-FCurve
* \param driver_index: Index in animation data drivers list
*/
virtual void build_driver(ID *id, FCurve *fcurve, int driver_index);

2
source/blender/editors/gpencil/gpencil_intern.h
View File

@ -361,7 +361,7 @@ void gpencil_stroke_convertcoords_tpoint(struct Scene *scene,
struct Object *ob,
const struct tGPspoint *point2D,
float *depth,
float out[3]);
float r_out[3]);
/* Poll Callbacks ------------------------------------ */
/* gpencil_utils.c */

2
source/blender/editors/include/ED_gpencil.h
View File

@ -476,7 +476,7 @@ void ED_gpencil_project_point_to_plane(const struct Scene *scene,
void ED_gpencil_drawing_reference_get(const struct Scene *scene,
const struct Object *ob,
char align_flag,
float vec[3]);
float r_vec[3]);
void ED_gpencil_project_stroke_to_view(struct bContext *C,
struct bGPDlayer *gpl,
struct bGPDstroke *gps);

7
source/blender/editors/include/ED_keyframes_edit.h
View File

@ -259,8 +259,7 @@ short ANIM_fcurve_keyframes_loop(KeyframeEditData *ked,
KeyframeEditFunc key_cb,
FcuEditFunc fcu_cb);
/**
* Function for working with any type (i.e. one of the known types) of animation channel
* \param filterflag: is bDopeSheet->flag (#DOPESHEET_FILTERFLAG).
* Function for working with any type (i.e. one of the known types) of animation channel.
*/
short ANIM_animchannel_keyframes_loop(KeyframeEditData *ked,
struct bDopeSheet *ads,
@ -269,8 +268,8 @@ short ANIM_animchannel_keyframes_loop(KeyframeEditData *ked,
KeyframeEditFunc key_cb,
FcuEditFunc fcu_cb);
/**
* Same as above, except bAnimListElem wrapper is not needed...
* \param keytype: is eAnim_KeyType.
* Same as above, except bAnimListElem wrapper is not needed.
* \param keytype: is #eAnim_KeyType.
*/
short ANIM_animchanneldata_keyframes_loop(KeyframeEditData *ked,
struct bDopeSheet *ads,

35
source/blender/editors/include/ED_view3d.h
View File

@ -185,17 +185,16 @@ void ED_view3d_lastview_store(struct RegionView3D *rv3d);
/* Depth buffer */
typedef enum {
/** Redraw viewport without Grease Pencil and Annotations. */
V3D_DEPTH_NO_GPENCIL = 0,
/** Redraw viewport with Grease Pencil and Annotations only. */
V3D_DEPTH_GPENCIL_ONLY,
/** Redraw viewport with active object only. */
V3D_DEPTH_OBJECT_ONLY,
} eV3DDepthOverrideMode;
/**
* Redraw the viewport depth buffer.
*
* \param mode: V3D_DEPTH_NO_GPENCIL - Redraw viewport without Grease Pencil and Annotations.
* V3D_DEPTH_GPENCIL_ONLY - Redraw viewport with Grease Pencil and Annotations only.
* V3D_DEPTH_OBJECT_ONLY - Redraw viewport with active object only.
* \param update_cache: If true, store the entire depth buffer in #rv3d->depths.
*/
void ED_view3d_depth_override(struct Depsgraph *depsgraph,
struct ARegion *region,
@ -549,19 +548,19 @@ bool ED_view3d_win_to_ray_clipped(struct Depsgraph *depsgraph,
const struct ARegion *region,
const struct View3D *v3d,
const float mval[2],
float ray_start[3],
float ray_normal[3],
const bool do_clip);
float r_ray_start[3],
float r_ray_normal[3],
const bool do_clip_planes);
/**
* Calculate a 3d viewpoint and direction vector from 2d window coordinates.
* This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
* This ray_start is located at the viewpoint, ray_normal is the direction towards `mval`.
* ray_start is clipped by the view near limit so points in front of it are always in view.
* In orthographic view the resulting ray_normal will match the view vector.
* This version also returns the ray_co point of the ray on window plane, useful to fix precision
* issues esp. with ortho view, where default ray_start is set rather far away.
* issues especially with orthographic view, where default ray_start is set rather far away.
* \param region: The region (used for the window width and height).
* \param v3d: The 3d viewport (used for near clipping value).
* \param mval: The area relative 2d location (such as event->mval, converted into float[2]).
* \param mval: The area relative 2d location (such as `event->mval`, converted into float[2]).
* \param r_ray_co: The world-space point where the ray intersects the window plane.
* \param r_ray_normal: The normalized world-space direction of towards mval.
* \param r_ray_start: The world-space starting point of the ray.
@ -575,12 +574,12 @@ bool ED_view3d_win_to_ray_clipped_ex(struct Depsgraph *depsgraph,
float r_ray_co[3],
float r_ray_normal[3],
float r_ray_start[3],
bool do_clip);
bool do_clip_planes);
/**
* Calculate a 3d viewpoint and direction vector from 2d window coordinates.
* This ray_start is located at the viewpoint, ray_normal is the direction towards mval.
* This ray_start is located at the viewpoint, ray_normal is the direction towards `mval`.
* \param region: The region (used for the window width and height).
* \param mval: The area relative 2d location (such as event->mval, converted into float[2]).
* \param mval: The area relative 2d location (such as `event->mval`, converted into float[2]).
* \param r_ray_start: The world-space point where the ray intersects the window plane.
* \param r_ray_normal: The normalized world-space direction of towards mval.
*
@ -605,7 +604,7 @@ void ED_view3d_global_to_vector(const struct RegionView3D *rv3d,
* Calculate a 3d location from 2d window coordinates.
* \param region: The region (used for the window width and height).
* \param depth_pt: The reference location used to calculate the Z depth.
* \param mval: The area relative location (such as event->mval converted to floats).
* \param mval: The area relative location (such as `event->mval` converted to floats).
* \param r_out: The resulting world-space location.
*/
void ED_view3d_win_to_3d(const struct View3D *v3d,
@ -646,7 +645,7 @@ bool ED_view3d_win_to_3d_on_plane_int(const struct ARegion *region,
* note that #ED_view3d_calc_zfac() must be called first to determine
* the depth used to calculate the delta.
* \param region: The region (used for the window width and height).
* \param mval: The area relative 2d difference (such as event->mval[0] - other_x).
* \param mval: The area relative 2d difference (such as `event->mval[0] - other_x`).
* \param out: The resulting world-space delta.
*/
void ED_view3d_win_to_delta(const struct ARegion *region,
@ -698,7 +697,7 @@ bool ED_view3d_win_to_segment_clipped(struct Depsgraph *depsgraph,
const float mval[2],
float r_ray_start[3],
float r_ray_end[3],
const bool do_clip);
const bool do_clip_planes);
void ED_view3d_ob_project_mat_get(const struct RegionView3D *v3d,
const struct Object *ob,
float r_pmat[4][4]);
@ -791,7 +790,7 @@ void ED_view3d_clipping_local(struct RegionView3D *rv3d, const float mat[4][4]);
/**
* Return true when `co` is hidden by the 3D views clipping planes.
*
* \param local: When true use local (object-space) #ED_view3d_clipping_local must run first,
* \param is_local: When true use local (object-space) #ED_view3d_clipping_local must run first,
* then all comparisons can be done in local-space.
* \return True when `co` is outside all clipping planes.
*

4
source/blender/editors/include/UI_interface.h
View File

@ -457,7 +457,7 @@ void UI_draw_text_underline(int pos_x, int pos_y, int len, int height, const flo
* \note This function is to be used with the 2D dashed shader enabled.
*
* \param pos: is a #PRIM_FLOAT, 2, #GPU_FETCH_FLOAT vertex attribute.
* \param x1, x2, y1, y2: The offsets for the view, not the zones.
* \param rect: The offsets for the view, not the zones.
*/
void UI_draw_safe_areas(uint pos,
const struct rctf *rect,
@ -3301,7 +3301,7 @@ void UI_tree_view_item_context_menu_build(struct bContext *C,
uiLayout *column);
/**
* \param x, y: Coordinate to find a tree-row item at, in window space.
* \param xy: Coordinate to find a tree-row item at, in window space.
*/
uiTreeViewItemHandle *UI_block_tree_view_find_item_at(const struct ARegion *region,
const int xy[2]) ATTR_NONNULL(1, 2);

12
source/blender/editors/include/UI_view2d.h
View File

@ -198,7 +198,7 @@ void UI_view2d_multi_grid_draw(
*/
void UI_view2d_dot_grid_draw(const struct View2D *v2d,
int grid_color_id,
float step,
float min_step,
int grid_levels);
void UI_view2d_draw_lines_y__values(const struct View2D *v2d);
@ -269,7 +269,7 @@ void UI_view2d_scrollers_draw(struct View2D *v2d, const struct rcti *mask_custom
* (like for Animation Editor channel lists, to make the first entry more visible), these will be
* the min-coordinates of the first item.
* \param viewx, viewy: 2D-coordinates (in 2D-view / 'tot' rect space) to get the cell for
* \param r_column, r_row: the 'coordinates' of the relevant 'cell'
* \param r_column, r_row: The 'coordinates' of the relevant 'cell'.
*/
void UI_view2d_listview_view_to_cell(float columnwidth,
float rowheight,
@ -277,8 +277,8 @@ void UI_view2d_listview_view_to_cell(float columnwidth,
float starty,
float viewx,
float viewy,
int *column,
int *row);
int *r_column,
int *r_row);
/* Coordinate conversion. */
@ -381,8 +381,8 @@ void UI_view2d_offset(struct View2D *v2d, float xfac, float yfac);
/**
* Check if mouse is within scrollers
*
* \param x, y: Mouse coordinates in screen (not region) space.
* \param r_scroll: Mapped view2d scroll flag.
* \param xy: Mouse coordinates in screen (not region) space.
* \param r_scroll: Return argument for the mapped view2d scroll flag.
*
* \return appropriate code for match.
* - 'h' = in horizontal scroller.

4
source/blender/editors/transform/transform_snap_object.c
View File

@ -996,8 +996,6 @@ struct RaycastObjUserData {
};
/**
* \param use_obedit: Uses the coordinates of BMesh (if any) to do the snapping;
*
* \note Duplicate args here are documented at #snapObjectsRay
*/
static void raycast_obj_fn(SnapObjectContext *sctx,
@ -2677,8 +2675,6 @@ struct SnapObjUserData {
};
/**
* \param use_obedit: Uses the coordinates of BMesh (if any) to do the snapping;
*
* \note Duplicate args here are documented at #snapObjectsRay
*/
static void snap_obj_fn(SnapObjectContext *sctx,

14
source/blender/freestyle/intern/image/GaussianFilter.h
View File

@ -37,14 +37,16 @@ namespace Freestyle {
class GaussianFilter {
protected:
/* The mask is a symmetrical 2d array (with respect to the middle point).
* Thus, M(i,j) = M(-i,j) = M(i,-j) = M(-i,-j).
* For this reason, to represent a NxN array (N odd), we only store a ((N+1)/2)x((N+1)/2) array.
*/
* Thus: `M(i,j) = M(-i,j) = M(i,-j) = M(-i,-j)`.
* For this reason, to represent a NxN array (N odd),
* we only store a `((N+1)/2)x((N+1)/2)` array. */
/** The sigma value of the gaussian function. */
float _sigma;
float *_mask;
int _bound;
// the real mask size (must be odd)(the size of the mask we store is
// ((_maskSize+1)/2)*((_maskSize+1)/2))
/* the real mask size (must be odd)(the size of the mask we store is:
* `((_maskSize+1)/2)*((_maskSize+1)/2))`. */
int _maskSize;
int _storedMaskSize; // (_maskSize+1)/2)
@ -65,8 +67,6 @@ class GaussianFilter {
* The abscissa of the pixel where we want to evaluate the gaussian blur.
* \param y:
* The ordinate of the pixel where we want to evaluate the gaussian blur.
* \param sigma:
* The sigma value of the gaussian function.
*/
template<class Map> float getSmoothedPixel(Map *map, int x, int y);

2
source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h
View File

@ -119,7 +119,7 @@ class SmoothingShader : public StrokeShader {
* 0.2
* \param iAnisoPoint:
* 0
* \param iAnisNormal:
* \param iAnisoNormal:
* 0
* \param iAnisoCurvature:
* 0

3
source/blender/freestyle/intern/winged_edge/Curvature.h
View File

@ -124,7 +124,6 @@ class Face_Curvature_Info {
/**
* \param v: a #WVertex.
* \param s: a #GtsSurface.
* \param Kh: the Mean Curvature Normal at \a v.
*
* Computes the Discrete Mean Curvature Normal approximation at \a v.
@ -147,7 +146,6 @@ bool gts_vertex_mean_curvature_normal(WVertex *v, Vec3r &Kh);
/**
* \param v: a #WVertex.
* \param s: a #GtsSurface.
* \param Kg: the Discrete Gaussian Curvature approximation at \a v.
*
* Computes the Discrete Gaussian Curvature approximation at \a v.
@ -181,7 +179,6 @@ void gts_vertex_principal_curvatures(real Kh, real Kg, real *K1, real *K2);
/**
* \param v: a #WVertex.
* \param s: a #GtsSurface.
* \param Kh: mean curvature normal (a #Vec3r).
* \param Kg: Gaussian curvature (a real).
* \param e1: first principal curvature direction (direction of largest curvature).

10
source/blender/gpu/GPU_immediate_util.h
View File

@ -61,7 +61,7 @@ void imm_cpack(uint x);
* \param shdr_pos: The vertex attribute number for position.
* \param x: Horizontal center.
* \param y: Vertical center.
* \param rad: The circle's radius.
* \param radius: The circle's radius.
* \param nsegments: The number of segments to use in drawing (more = smoother).
*/
void imm_draw_circle_wire_2d(uint shdr_pos, float x, float y, float radius, int nsegments);
@ -72,15 +72,15 @@ void imm_draw_circle_wire_2d(uint shdr_pos, float x, float y, float radius, int
* \param shdr_pos: The vertex attribute number for position.
* \param x: Horizontal center.
* \param y: Vertical center.
* \param rad: The circle's radius.
* \param radius: The circle's radius.
* \param nsegments: The number of segments to use in drawing (more = smoother).
*/
void imm_draw_circle_fill_2d(uint shdr_pos, float x, float y, float radius, int nsegments);
void imm_draw_circle_wire_aspect_2d(
uint shdr_pos, float x, float y, float rad_x, float rad_y, int nsegments);
uint shdr_pos, float x, float y, float radius_x, float radius_y, int nsegments);
void imm_draw_circle_fill_aspect_2d(
uint shdr_pos, float x, float y, float rad_x, float rad_y, int nsegments);
uint shdr_pos, float x, float y, float radius_x, float radius_y, int nsegments);
/**
* Use this version when #GPUVertFormat has a vec3 position.
@ -169,7 +169,7 @@ void imm_draw_cylinder_wire_3d(
void imm_draw_cylinder_fill_3d(
uint pos, float base, float top, float height, int slices, int stacks);
void imm_drawcircball(const float cent[3], float rad, const float tmat[4][4], uint pos);
void imm_drawcircball(const float cent[3], float radius, const float tmat[4][4], uint pos);
#ifdef __cplusplus
}
#endif

56
source/blender/gpu/intern/gpu_immediate_util.c
View File

@ -152,44 +152,44 @@ static void imm_draw_circle(GPUPrimType prim_type,
const uint shdr_pos,
float x,
float y,
float rad_x,
float rad_y,
float radius_x,
float radius_y,
int nsegments)
{
immBegin(prim_type, nsegments);
for (int i = 0; i < nsegments; i++) {
const float angle = (float)(2 * M_PI) * ((float)i / (float)nsegments);
immVertex2f(shdr_pos, x + (rad_x * cosf(angle)), y + (rad_y * sinf(angle)));
immVertex2f(shdr_pos, x + (radius_x * cosf(angle)), y + (radius_y * sinf(angle)));
}
immEnd();
}
void imm_draw_circle_wire_2d(uint shdr_pos, float x, float y, float rad, int nsegments)
void imm_draw_circle_wire_2d(uint shdr_pos, float x, float y, float radius, int nsegments)
{
imm_draw_circle(GPU_PRIM_LINE_LOOP, shdr_pos, x, y, rad, rad, nsegments);
imm_draw_circle(GPU_PRIM_LINE_LOOP, shdr_pos, x, y, radius, radius, nsegments);
}
void imm_draw_circle_fill_2d(uint shdr_pos, float x, float y, float rad, int nsegments)
void imm_draw_circle_fill_2d(uint shdr_pos, float x, float y, float radius, int nsegments)
{
imm_draw_circle(GPU_PRIM_TRI_FAN, shdr_pos, x, y, rad, rad, nsegments);
imm_draw_circle(GPU_PRIM_TRI_FAN, shdr_pos, x, y, radius, radius, nsegments);
}
void imm_draw_circle_wire_aspect_2d(
uint shdr_pos, float x, float y, float rad_x, float rad_y, int nsegments)
uint shdr_pos, float x, float y, float radius_x, float radius_y, int nsegments)
{
imm_draw_circle(GPU_PRIM_LINE_LOOP, shdr_pos, x, y, rad_x, rad_y, nsegments);
imm_draw_circle(GPU_PRIM_LINE_LOOP, shdr_pos, x, y, radius_x, radius_y, nsegments);
}
void imm_draw_circle_fill_aspect_2d(
uint shdr_pos, float x, float y, float rad_x, float rad_y, int nsegments)
uint shdr_pos, float x, float y, float radius_x, float radius_y, int nsegments)
{
imm_draw_circle(GPU_PRIM_TRI_FAN, shdr_pos, x, y, rad_x, rad_y, nsegments);
imm_draw_circle(GPU_PRIM_TRI_FAN, shdr_pos, x, y, radius_x, radius_y, nsegments);
}
static void imm_draw_circle_partial(GPUPrimType prim_type,
uint pos,
float x,
float y,
float rad,
float radius,
int nsegments,
float start,
float sweep)
@ -203,15 +203,15 @@ static void imm_draw_circle_partial(GPUPrimType prim_type,
const float angle = interpf(angle_start, angle_end, ((float)i / (float)(nsegments - 1)));
const float angle_sin = sinf(angle);
const float angle_cos = cosf(angle);
immVertex2f(pos, x + rad * angle_cos, y + rad * angle_sin);
immVertex2f(pos, x + radius * angle_cos, y + radius * angle_sin);
}
immEnd();
}
void imm_draw_circle_partial_wire_2d(
uint pos, float x, float y, float rad, int nsegments, float start, float sweep)
uint pos, float x, float y, float radius, int nsegments, float start, float sweep)
{
imm_draw_circle_partial(GPU_PRIM_LINE_STRIP, pos, x, y, rad, nsegments, start, sweep);
imm_draw_circle_partial(GPU_PRIM_LINE_STRIP, pos, x, y, radius, nsegments, start, sweep);
}
static void imm_draw_disk_partial(GPUPrimType prim_type,
@ -257,29 +257,29 @@ void imm_draw_disk_partial_fill_2d(uint pos,
}
static void imm_draw_circle_3D(
GPUPrimType prim_type, uint pos, float x, float y, float rad, int nsegments)
GPUPrimType prim_type, uint pos, float x, float y, float radius, int nsegments)
{
immBegin(prim_type, nsegments);
for (int i = 0; i < nsegments; i++) {
float angle = (float)(2 * M_PI) * ((float)i / (float)nsegments);
immVertex3f(pos, x + rad * cosf(angle), y + rad * sinf(angle), 0.0f);
immVertex3f(pos, x + radius * cosf(angle), y + radius * sinf(angle), 0.0f);
}
immEnd();
}
void imm_draw_circle_wire_3d(uint pos, float x, float y, float rad, int nsegments)
void imm_draw_circle_wire_3d(uint pos, float x, float y, float radius, int nsegments)
{
imm_draw_circle_3D(GPU_PRIM_LINE_LOOP, pos, x, y, rad, nsegments);
imm_draw_circle_3D(GPU_PRIM_LINE_LOOP, pos, x, y, radius, nsegments);
}
void imm_draw_circle_dashed_3d(uint pos, float x, float y, float rad, int nsegments)
void imm_draw_circle_dashed_3d(uint pos, float x, float y, float radius, int nsegments)
{
imm_draw_circle_3D(GPU_PRIM_LINES, pos, x, y, rad, nsegments / 2);
imm_draw_circle_3D(GPU_PRIM_LINES, pos, x, y, radius, nsegments / 2);
}
void imm_draw_circle_fill_3d(uint pos, float x, float y, float rad, int nsegments)
void imm_draw_circle_fill_3d(uint pos, float x, float y, float radius, int nsegments)
{
imm_draw_circle_3D(GPU_PRIM_TRI_FAN, pos, x, y, rad, nsegments);
imm_draw_circle_3D(GPU_PRIM_TRI_FAN, pos, x, y, radius, nsegments);
}
void imm_draw_box_wire_2d(uint pos, float x1, float y1, float x2, float y2)
@ -538,7 +538,7 @@ void imm_draw_cylinder_fill_3d(
static void circball_array_fill(const float verts[CIRCLE_RESOL][3],
const float cent[3],
float rad,
const float radius,
const float tmat[4][4])
{
/* 32 values of sin function (still same result!) */
@ -562,8 +562,8 @@ static void circball_array_fill(const float verts[CIRCLE_RESOL][3],
float vx[3], vy[3];
float *viter = (float *)verts;
mul_v3_v3fl(vx, tmat[0], rad);
mul_v3_v3fl(vy, tmat[1], rad);
mul_v3_v3fl(vx, tmat[0], radius);
mul_v3_v3fl(vy, tmat[1], radius);
for (uint a = 0; a < CIRCLE_RESOL; a++, viter += 3) {
viter[0] = cent[0] + sinval[a] * vx[0] + cosval[a] * vy[0];
@ -572,11 +572,11 @@ static void circball_array_fill(const float verts[CIRCLE_RESOL][3],
}
}
void imm_drawcircball(const float cent[3], float rad, const float tmat[4][4], uint pos)
void imm_drawcircball(const float cent[3], float radius, const float tmat[4][4], uint pos)
{
float verts[CIRCLE_RESOL][3];
circball_array_fill(verts, cent, rad, tmat);
circball_array_fill(verts, cent, radius, tmat);
immBegin(GPU_PRIM_LINE_LOOP, CIRCLE_RESOL);
for (int i = 0; i < CIRCLE_RESOL; i++) {

4
source/blender/imbuf/IMB_imbuf.h
View File

@ -152,8 +152,6 @@ bool IMB_initImBuf(
* Create a copy of a pixel buffer and wrap it to a new ImBuf
* (transferring ownership to the in imbuf).
* \attention Defined in allocimbuf.c
*
* \param take_ownership: When true, the buffers become owned by the resulting image.
*/
struct ImBuf *IMB_allocFromBufferOwn(
unsigned int *rect, float *rectf, unsigned int w, unsigned int h, unsigned int channels);
@ -802,7 +800,7 @@ void IMB_freezbuffloatImBuf(struct ImBuf *ibuf);
*/
/**
* Replace pixels of entire image with solid color.
* \param ibuf: An image to be filled with color. It must be 4 channel image.
* \param drect: An image to be filled with color. It must be 4 channel image.
* \param col: RGBA color, which is assigned directly to both byte (via scaling) and float buffers.
*/
void IMB_rectfill(struct ImBuf *drect, const float col[4]);

2
source/blender/imbuf/intern/IMB_filetype.h
View File

@ -244,7 +244,7 @@ void imb_loadtiletiff(
* not strictly correct, but are permitted anyhow.
*
* \param ibuf: Image buffer.
* \param name: Name of the TIFF file to create.
* \param filepath: Name of the TIFF file to create.
* \param flags: Currently largely ignored.
*
* \return 1 if the function is successful, 0 on failure.

6
source/blender/sequencer/SEQ_add.h
View File

@ -85,7 +85,7 @@ void SEQ_add_load_data_init(struct SeqLoadData *load_data,
* Add image strip.
* \note Use #SEQ_add_image_set_directory() and #SEQ_add_image_load_file() to load image sequences
*
* \param main: Main reference
* \param bmain: Main reference
* \param scene: Scene where strips will be added
* \param seqbase: ListBase where strips will be added
* \param load_data: SeqLoadData with information necessary to create strip
@ -99,7 +99,7 @@ struct Sequence *SEQ_add_image_strip(struct Main *bmain,
* Add sound strip.
* \note Use SEQ_add_image_set_directory() and SEQ_add_image_load_file() to load image sequences
*
* \param main: Main reference
* \param bmain: Main reference
* \param scene: Scene where strips will be added
* \param seqbase: ListBase where strips will be added
* \param load_data: SeqLoadData with information necessary to create strip
@ -124,7 +124,7 @@ struct Sequence *SEQ_add_meta_strip(struct Scene *scene,
/**
* Add movie strip.
*
* \param main: Main reference
* \param bmain: Main reference
* \param scene: Scene where strips will be added
* \param seqbase: ListBase where strips will be added
* \param load_data: SeqLoadData with information necessary to create strip

4
source/blender/sequencer/SEQ_edit.h
View File

@ -37,13 +37,13 @@ int SEQ_edit_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const
* Move sequence to seqbase.
*
* \param scene: Scene containing the editing
* \param dst_seqbase: seqbase where `seq` is located
* \param seqbase: seqbase where `seq` is located
* \param seq: Sequence to move
* \param dst_seqbase: Target seqbase
*/
bool SEQ_edit_move_strip_to_seqbase(struct Scene *scene,
ListBase *seqbase,
struct Sequence *src_seq,
struct Sequence *seq,
ListBase *dst_seqbase);
/**
* Move sequence to meta sequence.

10
source/blender/sequencer/SEQ_iterator.h
View File

@ -132,7 +132,7 @@ bool SEQ_collection_has_strip(const struct Sequence *seq, const SeqCollection *c
* \param collection: collection to which strip will be added
* \return false if strip is already in set, otherwise true
*/
bool SEQ_collection_append_strip(struct Sequence *seq, SeqCollection *data);
bool SEQ_collection_append_strip(struct Sequence *seq, SeqCollection *collection);
/**
* Remove strip from collection.
*
@ -140,7 +140,7 @@ bool SEQ_collection_append_strip(struct Sequence *seq, SeqCollection *data);
* \param collection: collection from which strip will be removed
* \return true if strip exists in set and it was removed from set, otherwise false
*/
bool SEQ_collection_remove_strip(struct Sequence *seq, SeqCollection *data);
bool SEQ_collection_remove_strip(struct Sequence *seq, SeqCollection *collection);
/**
* Free strip collection.
*
@ -172,9 +172,9 @@ void SEQ_collection_exclude(SeqCollection *collection, SeqCollection *exclude_el
*/
void SEQ_collection_expand(struct ListBase *seqbase,
SeqCollection *collection,
void query_func(struct Sequence *seq_reference,
struct ListBase *seqbase,
SeqCollection *collection));
void seq_query_func(struct Sequence *seq_reference,
struct ListBase *seqbase,
SeqCollection *collection));
/**
* Query strips from seqbase. seq_reference is used by query function as filter condition.
*

2
source/blender/windowmanager/WM_api.h
View File

@ -1202,8 +1202,6 @@ struct AssetMetaData *WM_drag_get_asset_meta_data(const struct wmDrag *drag, int
*
* Use #WM_drag_free_imported_drag_ID() as cancel callback of the drop-box, so that the asset
* import is rolled back if the drop operator fails.
*
* \param flag: #eFileSel_Params_Flag passed to linking code.
*/
struct ID *WM_drag_get_local_ID_or_import_from_asset(const struct wmDrag *drag, int idcode);