diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-14 10:35:23 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-14 10:35:23 +0300 |
commit | a207c1cdaf11864a413c5de3ade93f85a592b3cb (patch) | |
tree | 658b0676ffbaea37c9ec98689bdba8de5eae1d11 /source/blender/editors/include | |
parent | c097c7b855d4b01950494dc369e9def59486b0fd (diff) |
Cleanup: resolve parameter mis-matches in doc-strings
Renamed or removed parameters which no longer exist.
Diffstat (limited to 'source/blender/editors/include')
-rw-r--r-- | source/blender/editors/include/ED_gpencil.h | 2 | ||||
-rw-r--r-- | source/blender/editors/include/ED_keyframes_edit.h | 7 | ||||
-rw-r--r-- | source/blender/editors/include/ED_view3d.h | 35 | ||||
-rw-r--r-- | source/blender/editors/include/UI_interface.h | 4 | ||||
-rw-r--r-- | source/blender/editors/include/UI_view2d.h | 12 |
5 files changed, 29 insertions, 31 deletions
diff --git a/source/blender/editors/include/ED_gpencil.h b/source/blender/editors/include/ED_gpencil.h index 53c55a7668f..99164bbe439 100644 --- a/source/blender/editors/include/ED_gpencil.h +++ b/source/blender/editors/include/ED_gpencil.h @@ -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); diff --git a/source/blender/editors/include/ED_keyframes_edit.h b/source/blender/editors/include/ED_keyframes_edit.h index 76ba2ebf4a6..bafe68bd28d 100644 --- a/source/blender/editors/include/ED_keyframes_edit.h +++ b/source/blender/editors/include/ED_keyframes_edit.h @@ -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, diff --git a/source/blender/editors/include/ED_view3d.h b/source/blender/editors/include/ED_view3d.h index a4f07248d71..6c986d8efe1 100644 --- a/source/blender/editors/include/ED_view3d.h +++ b/source/blender/editors/include/ED_view3d.h @@ -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. * diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h index 5d21c30644f..ba83b259267 100644 --- a/source/blender/editors/include/UI_interface.h +++ b/source/blender/editors/include/UI_interface.h @@ -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); diff --git a/source/blender/editors/include/UI_view2d.h b/source/blender/editors/include/UI_view2d.h index c38c4dc1156..37246c2fe8f 100644 --- a/source/blender/editors/include/UI_view2d.h +++ b/source/blender/editors/include/UI_view2d.h @@ -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. |