diff options
author | Campbell Barton <ideasman42@gmail.com> | 2018-12-12 04:55:20 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2018-12-12 05:02:09 +0300 |
commit | 49490e5cfbeb2b0b823aa2042401891001870a6e (patch) | |
tree | a1d32562af2dea0c336ebd3d017a387834e936cc /source/blender/editors | |
parent | 16fc62e15f0a749d6d64e784ea048e07d6ea3397 (diff) | |
parent | e757c4a3bec8b0e8d198531a28327332af00a9ba (diff) |
Merge branch 'master' into blender2.8
Diffstat (limited to 'source/blender/editors')
34 files changed, 132 insertions, 132 deletions
diff --git a/source/blender/editors/animation/anim_channels_edit.c b/source/blender/editors/animation/anim_channels_edit.c index 2dec9c251f5..84b59835750 100644 --- a/source/blender/editors/animation/anim_channels_edit.c +++ b/source/blender/editors/animation/anim_channels_edit.c @@ -850,8 +850,8 @@ static bool rearrange_island_bottom(ListBase *list, tReorderChannelIsland *islan /** * typedef for channel rearranging function * - * \param list List of tReorderChannelIsland's that channels belong to - * \param island Island to be moved + * \param list: List of tReorderChannelIsland's that channels belong to + * \param island: Island to be moved * \return Whether operation was a success */ typedef bool (*AnimChanRearrangeFp)(ListBase *list, tReorderChannelIsland *island); diff --git a/source/blender/editors/animation/anim_markers.c b/source/blender/editors/animation/anim_markers.c index 9144c0b3dcc..74169128e5a 100644 --- a/source/blender/editors/animation/anim_markers.c +++ b/source/blender/editors/animation/anim_markers.c @@ -127,12 +127,12 @@ ListBase *ED_animcontext_get_markers(const bAnimContext *ac) /** * Apply some transformation to markers after the fact * - * \param markers List of markers to affect - this may or may not be the scene markers list, so don't assume anything - * \param scene Current scene (for getting current frame) - * \param mode (TfmMode) transform mode that this transform is for - * \param value From the transform code, this is ``t->vec[0]`` + * \param markers: List of markers to affect - this may or may not be the scene markers list, so don't assume anything + * \param scene: Current scene (for getting current frame) + * \param mode: (TfmMode) transform mode that this transform is for + * \param value: From the transform code, this is ``t->vec[0]`` * (which is delta transform for grab/extend, and scale factor for scale) - * \param side (B/L/R) for 'extend' functionality, which side of current frame to use + * \param side: (B/L/R) for 'extend' functionality, which side of current frame to use */ int ED_markers_post_apply_transform(ListBase *markers, Scene *scene, int mode, float value, char side) { @@ -596,7 +596,7 @@ static bool ed_markers_poll_markers_exist(bContext *C) * "custom"/third-tier invoke() callback supplied as the last arg (which would normally * be the operator's invoke() callback elsewhere) * - * \param invoke_func "standard" invoke function that operator would otherwise have used. + * \param invoke_func: "standard" invoke function that operator would otherwise have used. * If NULL, the operator's standard exec() * callback will be called instead in the appropriate places. */ diff --git a/source/blender/editors/armature/armature_utils.c b/source/blender/editors/armature/armature_utils.c index 53b07c59973..275d00ded58 100644 --- a/source/blender/editors/armature/armature_utils.c +++ b/source/blender/editors/armature/armature_utils.c @@ -181,8 +181,8 @@ bool ED_armature_ebone_is_child_recursive(EditBone *ebone_parent, EditBone *ebon /** * Finds the first parent shared by \a ebone_child * - * \param ebone_child Children bones to search - * \param ebone_child_tot Size of the ebone_child array + * \param ebone_child: Children bones to search + * \param ebone_child_tot: Size of the ebone_child array * \return The shared parent or NULL. */ EditBone *ED_armature_ebone_find_shared_parent(EditBone *ebone_child[], const unsigned int ebone_child_tot) diff --git a/source/blender/editors/armature/pose_transform.c b/source/blender/editors/armature/pose_transform.c index 18a9b546e83..ffbe8b52137 100644 --- a/source/blender/editors/armature/pose_transform.c +++ b/source/blender/editors/armature/pose_transform.c @@ -311,10 +311,10 @@ static void set_pose_keys(Object *ob) /** * Perform paste pose, for a single bone. * - * \param ob Object where bone to paste to lives - * \param chan Bone that pose to paste comes from - * \param selOnly Only paste on selected bones - * \param flip Flip on x-axis + * \param ob: Object where bone to paste to lives + * \param chan: Bone that pose to paste comes from + * \param selOnly: Only paste on selected bones + * \param flip: Flip on x-axis * \return Whether the bone that we pasted to if we succeeded */ static bPoseChannel *pose_bone_do_paste(Object *ob, bPoseChannel *chan, const bool selOnly, const bool flip) diff --git a/source/blender/editors/gpencil/editaction_gpencil.c b/source/blender/editors/gpencil/editaction_gpencil.c index 57bba10fa50..335dc254f40 100644 --- a/source/blender/editors/gpencil/editaction_gpencil.c +++ b/source/blender/editors/gpencil/editaction_gpencil.c @@ -288,7 +288,7 @@ void ED_gplayer_frames_duplicate(bGPDlayer *gpl) } /* Set keyframe type for selected frames from given gp-layer - * \param type The type of keyframe (eBezTriple_KeyframeType) to set selected frames to + * \param type: The type of keyframe (eBezTriple_KeyframeType) to set selected frames to */ void ED_gplayer_frames_keytype_set(bGPDlayer *gpl, short type) { diff --git a/source/blender/editors/gpencil/gpencil_fill.c b/source/blender/editors/gpencil/gpencil_fill.c index 68f463dbce0..d0b581abaf2 100644 --- a/source/blender/editors/gpencil/gpencil_fill.c +++ b/source/blender/editors/gpencil/gpencil_fill.c @@ -394,11 +394,11 @@ static void set_pixel(ImBuf *ibuf, int idx, const float col[4]) * this is used for strokes with small gaps between them to get a full fill * and do not get a full screen fill. * - * \param ibuf Image pixel data - * \param maxpixel Maximum index - * \param limit Limit of pixels to analyze - * \param index Index of current pixel - * \param type 0-Horizontal 1-Vertical + * \param ibuf: Image pixel data + * \param maxpixel: Maximum index + * \param limit: Limit of pixels to analyze + * \param index: Index of current pixel + * \param type: 0-Horizontal 1-Vertical */ static bool is_leak_narrow(ImBuf *ibuf, const int maxpixel, int limit, int index, int type) { @@ -496,7 +496,7 @@ static bool is_leak_narrow(ImBuf *ibuf, const int maxpixel, int limit, int index * Fills the space created by a set of strokes using the stroke color as the boundary * of the shape to fill. * - * \param tgpf Temporary fill data + * \param tgpf: Temporary fill data */ static void gpencil_boundaryfill_area(tGPDfill *tgpf) { diff --git a/source/blender/editors/gpencil/gpencil_intern.h b/source/blender/editors/gpencil/gpencil_intern.h index 50ae61209cc..f9951c2561a 100644 --- a/source/blender/editors/gpencil/gpencil_intern.h +++ b/source/blender/editors/gpencil/gpencil_intern.h @@ -487,9 +487,9 @@ struct GP_EditableStrokes_Iter { * stopping on each usable layer + stroke pair (i.e. gpl and gps) * to perform some operations on the stroke. * - * \param gpl The identifier to use for the layer of the stroke being processed. + * \param gpl: The identifier to use for the layer of the stroke being processed. * Choose a suitable value to avoid name clashes. - * \param gps The identifier to use for current stroke being processed. + * \param gps: The identifier to use for current stroke being processed. * Choose a suitable value to avoid name clashes. */ #define GP_EDITABLE_STROKES_BEGIN(gpstroke_iter, C, gpl, gps) \ diff --git a/source/blender/editors/gpencil/gpencil_paint.c b/source/blender/editors/gpencil/gpencil_paint.c index be92f8ab74a..39bca4d096c 100644 --- a/source/blender/editors/gpencil/gpencil_paint.c +++ b/source/blender/editors/gpencil/gpencil_paint.c @@ -503,9 +503,9 @@ static void gp_brush_angle(bGPdata *gpd, Brush *brush, tGPspoint *pt, const floa * * A----B-----C------D * - * \param p Temp data - * \param inf Influence factor - * \param idx Index of the last point (need minimum 3 points in the array) + * \param p: Temp data + * \param inf: Influence factor + * \param idx: Index of the last point (need minimum 3 points in the array) */ static void gp_smooth_buffer(tGPsdata *p, float inf, int idx) { diff --git a/source/blender/editors/gpencil/gpencil_utils.c b/source/blender/editors/gpencil/gpencil_utils.c index 7aabe546ce6..7cc153e0f61 100644 --- a/source/blender/editors/gpencil/gpencil_utils.c +++ b/source/blender/editors/gpencil/gpencil_utils.c @@ -427,12 +427,12 @@ const EnumPropertyItem *ED_gpencil_layers_with_new_enum_itemf( /** * Check whether a given stroke segment is inside a circular brush * - * \param mval The current screen-space coordinates (midpoint) of the brush - * \param mvalo The previous screen-space coordinates (midpoint) of the brush (NOT CURRENTLY USED) - * \param rad The radius of the brush + * \param mval: The current screen-space coordinates (midpoint) of the brush + * \param mvalo: The previous screen-space coordinates (midpoint) of the brush (NOT CURRENTLY USED) + * \param rad: The radius of the brush * - * \param x0, y0 The screen-space x and y coordinates of the start of the stroke segment - * \param x1, y1 The screen-space x and y coordinates of the end of the stroke segment + * \param x0, y0: The screen-space x and y coordinates of the start of the stroke segment + * \param x1, y1: The screen-space x and y coordinates of the end of the stroke segment */ bool gp_stroke_inside_circle( const float mval[2], const float UNUSED(mvalo[2]), diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c index f9d17386be6..39dcdda5ee8 100644 --- a/source/blender/editors/interface/interface.c +++ b/source/blender/editors/interface/interface.c @@ -2264,7 +2264,7 @@ void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) } /** - * \param float_precision Override the button precision. + * \param float_precision: Override the button precision. */ static void ui_get_but_string_unit(uiBut *but, char *str, int len_max, double value, bool pad, int float_precision) { @@ -2326,8 +2326,8 @@ static float ui_get_but_step_unit(uiBut *but, float step_default) } /** - * \param float_precision For number buttons the precision to use or -1 to fallback to the button default. - * \param use_exp_float Use exponent representation of floats when out of reasonable range (outside of 1e3/1e-3). + * \param float_precision: For number buttons the precision to use or -1 to fallback to the button default. + * \param use_exp_float: Use exponent representation of floats when out of reasonable range (outside of 1e3/1e-3). */ void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision, const bool use_exp_float, bool *r_use_exp_float) { diff --git a/source/blender/editors/interface/interface_draw.c b/source/blender/editors/interface/interface_draw.c index 59f8cfdb562..ef9a69cd1dd 100644 --- a/source/blender/editors/interface/interface_draw.c +++ b/source/blender/editors/interface/interface_draw.c @@ -685,8 +685,8 @@ void ui_draw_but_IMAGE(ARegion *UNUSED(ar), uiBut *but, uiWidgetColors *UNUSED(w * * \Note This functionn is to be used with the 2D dashed shader enabled. * - * \param pos is a PRIM_FLOAT, 2, GPU_FETCH_FLOAT vertex attrib - * \param line_origin is a PRIM_FLOAT, 2, GPU_FETCH_FLOAT vertex attrib + * \param pos: is a PRIM_FLOAT, 2, GPU_FETCH_FLOAT vertex attrib + * \param line_origin: is a PRIM_FLOAT, 2, GPU_FETCH_FLOAT vertex attrib * * The next 4 parameters are the offsets for the view, not the zones. */ diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index baf472deb28..5ab23ed3893 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -2582,7 +2582,7 @@ static bool ui_textedit_delete_selection(uiBut *but, uiHandleButtonData *data) } /** - * \param x Screen space cursor location - #wmEvent.x + * \param x: Screen space cursor location - #wmEvent.x * * \note ``but->block->aspect`` is used here, so drawing button style is getting scaled too. */ @@ -6905,7 +6905,7 @@ static bool ui_but_find_select_in_enum__cmp(const uiBut *but_a, const uiBut *but /** * Finds the pressed button in an aligned row (typically an expanded enum). * - * \param direction Use when there may be multiple buttons pressed. + * \param direction: Use when there may be multiple buttons pressed. */ uiBut *ui_but_find_select_in_enum(uiBut *but, int direction) { diff --git a/source/blender/editors/mesh/editmesh_knife.c b/source/blender/editors/mesh/editmesh_knife.c index 7313469eda9..b89a7dd91a1 100644 --- a/source/blender/editors/mesh/editmesh_knife.c +++ b/source/blender/editors/mesh/editmesh_knife.c @@ -1424,7 +1424,7 @@ static bool bm_ray_cast_cb_elem_not_in_face_check(BMFace *f, void *user_data) * Check if \a p is visible (not clipped, not occluded by another face). * s in screen projection of p. * - * \param ele_test Optional vert/edge/face to use when \a p is on the surface of the geometry, + * \param ele_test: Optional vert/edge/face to use when \a p is on the surface of the geometry, * intersecting faces matching this face (or connected when an vert/edge) will be ignored. */ static bool point_is_visible( @@ -3012,7 +3012,7 @@ static bool edbm_mesh_knife_point_isect(LinkNode *polys, const float cent_ss[2]) } /** - * \param use_tag When set, tag all faces inside the polylines. + * \param use_tag: When set, tag all faces inside the polylines. */ void EDBM_mesh_knife(bContext *C, LinkNode *polys, bool use_tag, bool cut_through) { diff --git a/source/blender/editors/mesh/editmesh_rip.c b/source/blender/editors/mesh/editmesh_rip.c index fb380dfaaa9..f00973768ed 100644 --- a/source/blender/editors/mesh/editmesh_rip.c +++ b/source/blender/editors/mesh/editmesh_rip.c @@ -59,7 +59,7 @@ /** * helper to find edge for edge_rip, * - * \param inset is used so we get some useful distance + * \param inset: is used so we get some useful distance * when comparing multiple edges that meet at the same * point and would result in the same distance. */ diff --git a/source/blender/editors/mesh/editmesh_select.c b/source/blender/editors/mesh/editmesh_select.c index 3e97a73eade..c24aca83f36 100644 --- a/source/blender/editors/mesh/editmesh_select.c +++ b/source/blender/editors/mesh/editmesh_select.c @@ -466,11 +466,11 @@ static void findnearestvert__doClosest(void *userData, BMVert *eve, const float /** * Nearest vertex under the cursor. * - * \param r_dist (in/out), minimal distance to the nearest and at the end, actual distance - * \param use_select_bias + * \param r_dist: (in/out), minimal distance to the nearest and at the end, actual distance + * \param use_select_bias: * - When true, selected vertice are given a 5 pixel bias to make them further than unselect verts. * - When false, unselected vertice are given the bias. - * \param use_cycle Cycle over elements within #FIND_NEAR_CYCLE_THRESHOLD_MIN in order of index. + * \param use_cycle: Cycle over elements within #FIND_NEAR_CYCLE_THRESHOLD_MIN in order of index. */ BMVert *EDBM_vert_find_nearest_ex( ViewContext *vc, float *r_dist, diff --git a/source/blender/editors/mesh/editmesh_utils.c b/source/blender/editors/mesh/editmesh_utils.c index cb8d4f8d00e..6c4e82f5b71 100644 --- a/source/blender/editors/mesh/editmesh_utils.c +++ b/source/blender/editors/mesh/editmesh_utils.c @@ -991,12 +991,12 @@ static BMVert *cache_mirr_intptr_as_bmvert(intptr_t *index_lookup, int index) #define BM_SEARCH_MAXDIST_MIRR 0.00002f #define BM_CD_LAYER_ID "__mirror_index" /** - * \param em Editmesh. - * \param use_self Allow a vertex to point to its self (middle verts). - * \param use_select Restrict to selected verts. - * \param use_topology Use topology mirror. - * \param maxdist Distance for close point test. - * \param r_index Optional array to write into, as an alternative to a customdata layer (length of total verts). + * \param em: Editmesh. + * \param use_self: Allow a vertex to point to its self (middle verts). + * \param use_select: Restrict to selected verts. + * \param use_topology: Use topology mirror. + * \param maxdist: Distance for close point test. + * \param r_index: Optional array to write into, as an alternative to a customdata layer (length of total verts). */ void EDBM_verts_mirror_cache_begin_ex( BMEditMesh *em, const int axis, const bool use_self, const bool use_select, diff --git a/source/blender/editors/screen/area.c b/source/blender/editors/screen/area.c index c6af7cda220..85f46d86abc 100644 --- a/source/blender/editors/screen/area.c +++ b/source/blender/editors/screen/area.c @@ -1801,7 +1801,7 @@ void ED_area_swapspace(bContext *C, ScrArea *sa1, ScrArea *sa2) } /** - * \param skip_ar_exit Skip calling area exit callback. Set for opening temp spaces. + * \param skip_ar_exit: Skip calling area exit callback. Set for opening temp spaces. */ void ED_area_newspace(bContext *C, ScrArea *sa, int type, const bool skip_ar_exit) { diff --git a/source/blender/editors/sculpt_paint/sculpt.c b/source/blender/editors/sculpt_paint/sculpt.c index 5a0b53945ac..a4605eddd79 100644 --- a/source/blender/editors/sculpt_paint/sculpt.c +++ b/source/blender/editors/sculpt_paint/sculpt.c @@ -325,7 +325,7 @@ typedef struct SculptProjectVector { } SculptProjectVector; /** - * \param plane Direction, can be any length. + * \param plane: Direction, can be any length. */ static void sculpt_project_v3_cache_init( SculptProjectVector *spvc, const float plane[3]) diff --git a/source/blender/editors/space_file/fsmenu.h b/source/blender/editors/space_file/fsmenu.h index bb201a7a80c..e5a59e356eb 100644 --- a/source/blender/editors/space_file/fsmenu.h +++ b/source/blender/editors/space_file/fsmenu.h @@ -45,7 +45,7 @@ struct FSMenuEntry; /** Inserts a new fsmenu entry with the given \a path. * Duplicate entries are not added. - * \param flag Options for inserting the entry. + * \param flag: Options for inserting the entry. */ void fsmenu_insert_entry(struct FSMenu *fsmenu, enum FSMenuCategory category, const char *path, const char *name, const enum FSMenuInsert flag); diff --git a/source/blender/editors/space_image/image_ops.c b/source/blender/editors/space_image/image_ops.c index edf0c67ca7d..87d2f439ad7 100644 --- a/source/blender/editors/space_image/image_ops.c +++ b/source/blender/editors/space_image/image_ops.c @@ -1094,8 +1094,8 @@ static void image_open_cancel(bContext *UNUSED(C), wmOperator *op) /** * \brief Get a list of frames from the list of image files matching the first file name sequence pattern - * \param ptr [in] the RNA pointer containing the "directory" entry and "files" collection - * \param frames_all [out] the list of frame numbers found in the files matching the first one by name + * \param ptr: [in] the RNA pointer containing the "directory" entry and "files" collection + * \param frames_all: [out] the list of frame numbers found in the files matching the first one by name */ static void image_sequence_get_frame_ranges(PointerRNA *ptr, ListBase *frames_all) { diff --git a/source/blender/editors/space_node/node_edit.c b/source/blender/editors/space_node/node_edit.c index 86b7ebf46b4..b8921ba6521 100644 --- a/source/blender/editors/space_node/node_edit.c +++ b/source/blender/editors/space_node/node_edit.c @@ -258,7 +258,7 @@ static void compo_startjob(void *cjv, short *stop, short *do_update, float *prog } /** - * \param scene_owner is the owner of the job, + * \param scene_owner: is the owner of the job, * we don't use it for anything else currently so could also be a void pointer, * but for now keep it an 'Scene' for consistency. * diff --git a/source/blender/editors/space_outliner/outliner_collections.c b/source/blender/editors/space_outliner/outliner_collections.c index 6b4a7e10e63..d219457aeac 100644 --- a/source/blender/editors/space_outliner/outliner_collections.c +++ b/source/blender/editors/space_outliner/outliner_collections.c @@ -822,9 +822,9 @@ void OUTLINER_OT_collection_indirect_only_clear(wmOperatorType *ot) } /** - * Populates the \param objects ListBase with all the outliner selected objects + * Populates the \param objects: ListBase with all the outliner selected objects * We store it as (Object *)LinkData->data - * \param objects expected to be empty + * \param objects: expected to be empty */ void ED_outliner_selected_objects_get(const bContext *C, ListBase *objects) { diff --git a/source/blender/editors/space_outliner/outliner_tree.c b/source/blender/editors/space_outliner/outliner_tree.c index 60467854e73..f7f0d441138 100644 --- a/source/blender/editors/space_outliner/outliner_tree.c +++ b/source/blender/editors/space_outliner/outliner_tree.c @@ -213,7 +213,7 @@ void outliner_cleanup_tree(SpaceOops *soops) * Free \a element and its sub-tree and remove its link in \a parent_subtree. * * \note Does not remove the TreeStoreElem of \a element! - * \param parent_subtree Subtree of the parent element, so the list containing \a element. + * \param parent_subtree: Subtree of the parent element, so the list containing \a element. */ void outliner_free_tree_element(TreeElement *element, ListBase *parent_subtree) { diff --git a/source/blender/editors/space_text/text_format.c b/source/blender/editors/space_text/text_format.c index b64eefe969b..7a36b4f3e9c 100644 --- a/source/blender/editors/space_text/text_format.c +++ b/source/blender/editors/space_text/text_format.c @@ -144,7 +144,7 @@ int text_check_format_len(TextLine *line, unsigned int len) * Fill the string with formatting constant, * advancing \a str_p and \a fmt_p * - * \param len length in bytes of \a fmt_p to fill. + * \param len: length in bytes of \a fmt_p to fill. */ void text_format_fill(const char **str_p, char **fmt_p, const char type, const int len) { diff --git a/source/blender/editors/space_view3d/view3d_camera_control.c b/source/blender/editors/space_view3d/view3d_camera_control.c index 15edce3fc87..d8b7d449c36 100644 --- a/source/blender/editors/space_view3d/view3d_camera_control.c +++ b/source/blender/editors/space_view3d/view3d_camera_control.c @@ -282,7 +282,7 @@ void ED_view3d_cameracontrol_update( /** * Release view control. * - * \param restore Sets the view state to the values that were set + * \param restore: Sets the view state to the values that were set * before #ED_view3d_control_acquire was called. */ void ED_view3d_cameracontrol_release( diff --git a/source/blender/editors/space_view3d/view3d_edit.c b/source/blender/editors/space_view3d/view3d_edit.c index 2bc680bcbeb..d073c62dfcc 100644 --- a/source/blender/editors/space_view3d/view3d_edit.c +++ b/source/blender/editors/space_view3d/view3d_edit.c @@ -1039,7 +1039,7 @@ static float view3d_ndof_pan_speed_calc(RegionView3D *rv3d) /** * Zoom and pan in the same function since sometimes zoom is interpreted as dolly (pan forward). * - * \param has_zoom zoom, otherwise dolly, often `!rv3d->is_persp` since it doesn't make sense to dolly in ortho. + * \param has_zoom: zoom, otherwise dolly, often `!rv3d->is_persp` since it doesn't make sense to dolly in ortho. */ static void view3d_ndof_pan_zoom( const struct wmNDOFMotionData *ndof, ScrArea *sa, ARegion *ar, diff --git a/source/blender/editors/space_view3d/view3d_gizmo_navigate_type.c b/source/blender/editors/space_view3d/view3d_gizmo_navigate_type.c index 1358204a3a4..f57ff4464e0 100644 --- a/source/blender/editors/space_view3d/view3d_gizmo_navigate_type.c +++ b/source/blender/editors/space_view3d/view3d_gizmo_navigate_type.c @@ -88,7 +88,7 @@ struct AxisDrawInfo { #ifndef USE_AXIS_FONT /** - * \param viewmat_local_unit is typically the 'rv3d->viewmatob' + * \param viewmat_local_unit: is typically the 'rv3d->viewmatob' * copied into a 3x3 matrix and normalized. */ static void draw_xyz_wire( diff --git a/source/blender/editors/space_view3d/view3d_project.c b/source/blender/editors/space_view3d/view3d_project.c index 116f4af34e5..718f3cd40f1 100644 --- a/source/blender/editors/space_view3d/view3d_project.c +++ b/source/blender/editors/space_view3d/view3d_project.c @@ -361,13 +361,13 @@ bool ED_view3d_clip_segment(const RegionView3D *rv3d, float ray_start[3], float * 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. - * \param ar 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 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. - * \param do_clip_planes Optionally clip the start of the ray by the view clipping planes. + * \param ar: 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 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. + * \param do_clip_planes: Optionally clip the start of the ray by the view clipping planes. * \return success, false if the ray is totally clipped. */ bool ED_view3d_win_to_ray_clipped_ex( @@ -392,12 +392,12 @@ bool ED_view3d_win_to_ray_clipped_ex( * 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. - * \param ar 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 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. - * \param do_clip_planes Optionally clip the start of the ray by the view clipping planes. + * \param ar: 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 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. + * \param do_clip_planes: Optionally clip the start of the ray by the view clipping planes. * \return success, false if the ray is totally clipped. */ bool ED_view3d_win_to_ray_clipped( @@ -411,10 +411,10 @@ bool ED_view3d_win_to_ray_clipped( /** * 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. - * \param ar 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 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. + * \param ar: 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 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. * * \note Ignores view near/far clipping, to take this into account use #ED_view3d_win_to_ray_clipped. */ @@ -429,9 +429,9 @@ void ED_view3d_win_to_ray( /** * Calculate a normalized 3d direction vector from the viewpoint towards a global location. * In orthographic view the resulting vector will match the view vector. - * \param rv3d The region (used for the window width and height). - * \param coord The world-space location. - * \param vec The resulting normalized vector. + * \param rv3d: The region (used for the window width and height). + * \param coord: The world-space location. + * \param vec: The resulting normalized vector. */ void ED_view3d_global_to_vector(const RegionView3D *rv3d, const float coord[3], float vec[3]) { @@ -491,10 +491,10 @@ bool view3d_get_view_aligned_coordinate(ARegion *ar, float fp[3], const int mval /** * Calculate a 3d location from 2d window coordinates. - * \param ar 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 r_out The resulting world-space location. + * \param ar: 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 r_out: The resulting world-space location. */ void ED_view3d_win_to_3d( const View3D *v3d, const ARegion *ar, @@ -586,9 +586,9 @@ bool ED_view3d_win_to_3d_on_plane_int( * Calculate a 3d difference vector from 2d window offset. * note that ED_view3d_calc_zfac() must be called first to determine * the depth used to calculate the delta. - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d difference (such as event->mval[0] - other_x). - * \param out The resulting world-space delta. + * \param ar: The region (used for the window width and height). + * \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 ARegion *ar, const float mval[2], float out[3], const float zfac) { @@ -609,9 +609,9 @@ void ED_view3d_win_to_delta(const ARegion *ar, const float mval[2], float out[3] * Since far clip can be a very large value resulting in numeric precision issues, * the origin in this case is close to zero coordinate. * - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d location (such as event->mval converted to floats). - * \param out The resulting normalized world-space direction vector. + * \param ar: The region (used for the window width and height). + * \param mval: The area relative 2d location (such as event->mval converted to floats). + * \param out: The resulting normalized world-space direction vector. */ void ED_view3d_win_to_origin(const ARegion *ar, const float mval[2], float out[3]) { @@ -643,9 +643,9 @@ void ED_view3d_win_to_origin(const ARegion *ar, const float mval[2], float out[3 * for perspective view, get the vector direction to * the mouse cursor as a normalized vector. * - * \param ar The region (used for the window width and height). - * \param mval The area relative 2d location (such as event->mval converted to floats). - * \param out The resulting normalized world-space direction vector. + * \param ar: The region (used for the window width and height). + * \param mval: The area relative 2d location (such as event->mval converted to floats). + * \param out: The resulting normalized world-space direction vector. */ void ED_view3d_win_to_vector(const ARegion *ar, const float mval[2], float out[3]) { @@ -670,12 +670,12 @@ void ED_view3d_win_to_vector(const ARegion *ar, const float mval[2], float out[3 * ray_start and ray_end are clipped by the view near and far limits * so points along this line are always in view. * In orthographic view all resulting segments will be parallel. - * \param ar The region (used for the window width and height). - * \param v3d The 3d viewport (used for near and far clipping range). - * \param mval The area relative 2d location (such as event->mval, converted into float[2]). - * \param r_ray_start The world-space starting point of the segment. - * \param r_ray_end The world-space end point of the segment. - * \param do_clip_planes Optionally clip the ray by the view clipping planes. + * \param ar: The region (used for the window width and height). + * \param v3d: The 3d viewport (used for near and far clipping range). + * \param mval: The area relative 2d location (such as event->mval, converted into float[2]). + * \param r_ray_start: The world-space starting point of the segment. + * \param r_ray_end: The world-space end point of the segment. + * \param do_clip_planes: Optionally clip the ray by the view clipping planes. * \return success, false if the segment is totally clipped. */ bool ED_view3d_win_to_segment_clipped( diff --git a/source/blender/editors/space_view3d/view3d_utils.c b/source/blender/editors/space_view3d/view3d_utils.c index bcfaf9e9afa..87f2e6b32d4 100644 --- a/source/blender/editors/space_view3d/view3d_utils.c +++ b/source/blender/editors/space_view3d/view3d_utils.c @@ -1069,10 +1069,10 @@ float ED_view3d_radius_to_dist_ortho(const float lens, const float radius) * + * </pre> * - * \param ar Can be NULL if \a use_aspect is false. - * \param persp Allow the caller to tell what kind of perspective to use (ortho/view/camera) - * \param use_aspect Increase the distance to account for non 1:1 view aspect. - * \param radius The radius will be fitted exactly, typically pre-scaled by a margin (#VIEW3D_MARGIN). + * \param ar: Can be NULL if \a use_aspect is false. + * \param persp: Allow the caller to tell what kind of perspective to use (ortho/view/camera) + * \param use_aspect: Increase the distance to account for non 1:1 view aspect. + * \param radius: The radius will be fitted exactly, typically pre-scaled by a margin (#VIEW3D_MARGIN). */ float ED_view3d_radius_to_dist( const View3D *v3d, const ARegion *ar, @@ -1283,10 +1283,10 @@ bool ED_view3d_lock(RegionView3D *rv3d) /** * Set the view transformation from a 4x4 matrix. * - * \param mat The view 4x4 transformation matrix to assign. - * \param ofs The view offset, normally from RegionView3D.ofs. - * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat: The view 4x4 transformation matrix to assign. + * \param ofs: The view offset, normally from RegionView3D.ofs. + * \param quat: The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_from_m4(const float mat[4][4], float ofs[3], float quat[4], float *dist) { @@ -1316,10 +1316,10 @@ void ED_view3d_from_m4(const float mat[4][4], float ofs[3], float quat[4], float /** * Calculate the view transformation matrix from RegionView3D input. * The resulting matrix is equivalent to RegionView3D.viewinv - * \param mat The view 4x4 transformation matrix to calculate. - * \param ofs The view offset, normally from RegionView3D.ofs. - * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat: The view 4x4 transformation matrix to calculate. + * \param ofs: The view offset, normally from RegionView3D.ofs. + * \param quat: The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], const float dist) { @@ -1333,11 +1333,11 @@ void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], c /** * Set the RegionView3D members from an objects transformation and optionally lens. - * \param ob The object to set the view to. - * \param ofs The view offset to be set, normally from RegionView3D.ofs. - * \param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs to be set, normally from RegionView3D.dist. - * \param lens The view lens angle set for cameras and lamps, normally from View3D.lens. + * \param ob: The object to set the view to. + * \param ofs: The view offset to be set, normally from RegionView3D.ofs. + * \param quat: The view rotation to be set, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs to be set, normally from RegionView3D.dist. + * \param lens: The view lens angle set for cameras and lamps, normally from View3D.lens. */ void ED_view3d_from_object(const Object *ob, float ofs[3], float quat[4], float *dist, float *lens) { @@ -1354,11 +1354,11 @@ void ED_view3d_from_object(const Object *ob, float ofs[3], float quat[4], float /** * Set the object transformation from RegionView3D members. - * \param depsgraph The depsgraph to get the evaluated object parent for the transformation calculation. - * \param ob The object which has the transformation assigned. - * \param ofs The view offset, normally from RegionView3D.ofs. - * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * \param dist The view distance from ofs, normally from RegionView3D.dist. + * \param depsgraph: The depsgraph to get the evaluated object parent for the transformation calculation. + * \param ob: The object which has the transformation assigned. + * \param ofs: The view offset, normally from RegionView3D.ofs. + * \param quat: The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist: The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_object(const Depsgraph *depsgraph, Object *ob, const float ofs[3], const float quat[4], const float dist) { diff --git a/source/blender/editors/space_view3d/view3d_view.c b/source/blender/editors/space_view3d/view3d_view.c index d99fa5e8760..4d698428dfd 100644 --- a/source/blender/editors/space_view3d/view3d_view.c +++ b/source/blender/editors/space_view3d/view3d_view.c @@ -694,7 +694,7 @@ void VIEW3D_OT_object_as_camera(wmOperatorType *ot) * \{ */ /** - * \param rect optional for picking (can be NULL). + * \param rect: optional for picking (can be NULL). */ void view3d_winmatrix_set(Depsgraph *depsgraph, ARegion *ar, const View3D *v3d, const rcti *rect) { diff --git a/source/blender/editors/space_view3d/view3d_walk.c b/source/blender/editors/space_view3d/view3d_walk.c index d4bb213e5c7..a716264febb 100644 --- a/source/blender/editors/space_view3d/view3d_walk.c +++ b/source/blender/editors/space_view3d/view3d_walk.c @@ -369,7 +369,7 @@ static void walk_navigation_mode_set(bContext *C, wmOperator *op, WalkInfo *walk } /** - * \param r_distance Distance to the hit point + * \param r_distance: Distance to the hit point */ static bool walk_floor_distance_get( RegionView3D *rv3d, WalkInfo *walk, const float dvec[3], @@ -403,9 +403,9 @@ static bool walk_floor_distance_get( } /** - * \param ray_distance Distance to the hit point - * \param r_location Location of the hit point - * \param r_normal Normal of the hit surface, transformed to always face the camera + * \param ray_distance: Distance to the hit point + * \param r_location: Location of the hit point + * \param r_normal: Normal of the hit surface, transformed to always face the camera */ static bool walk_ray_cast( RegionView3D *rv3d, WalkInfo *walk, diff --git a/source/blender/editors/transform/transform.c b/source/blender/editors/transform/transform.c index 324cd26a54f..ee8181f11a3 100644 --- a/source/blender/editors/transform/transform.c +++ b/source/blender/editors/transform/transform.c @@ -6304,7 +6304,7 @@ static bool bm_loop_calc_opposite_co(BMLoop *l_tmp, * Given 2 edges and a loop, step over the loops * and calculate a direction to slide along. * - * \param r_slide_vec the direction to slide, + * \param r_slide_vec: the direction to slide, * the length of the vector defines the slide distance. */ static BMLoop *get_next_loop(BMVert *v, BMLoop *l, diff --git a/source/blender/editors/transform/transform_generics.c b/source/blender/editors/transform/transform_generics.c index c566bcb7266..0e06162e335 100644 --- a/source/blender/editors/transform/transform_generics.c +++ b/source/blender/editors/transform/transform_generics.c @@ -1996,7 +1996,7 @@ void calculateCenterBound(TransInfo *t, float r_center[3]) } /** - * \param select_only only get active center from data being transformed. + * \param select_only: only get active center from data being transformed. */ bool calculateCenterActive(TransInfo *t, bool select_only, float r_center[3]) { diff --git a/source/blender/editors/util/ed_util.c b/source/blender/editors/util/ed_util.c index 8de46442fe9..d2bed9ca06e 100644 --- a/source/blender/editors/util/ed_util.c +++ b/source/blender/editors/util/ed_util.c @@ -377,7 +377,7 @@ void ED_region_draw_mouse_line_cb(const bContext *C, ARegion *ar, void *arg_info /** * Use to free ID references within runtime data (stored outside of DNA) * - * \param new_id may be NULL to unlink \a old_id. + * \param new_id: may be NULL to unlink \a old_id. */ void ED_spacedata_id_remap(struct ScrArea *sa, struct SpaceLink *sl, ID *old_id, ID *new_id) { |