Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2018-12-12 04:50:58 +0300
committerCampbell Barton <ideasman42@gmail.com>2018-12-12 04:50:58 +0300
commite757c4a3bec8b0e8d198531a28327332af00a9ba (patch)
tree4707fd51cffdbe932123a29bbcfe4528fc9c2b55 /source/blender/editors
parentba8d6ca3dd92eed5d679caa28f5446cd07b8a112 (diff)
Cleanup: use colon separator after parameter
Helps separate variable names from descriptive text. Was already used in some parts of the code, double space and dashes were used elsewhere.
Diffstat (limited to 'source/blender/editors')
-rw-r--r--source/blender/editors/animation/anim_channels_edit.c4
-rw-r--r--source/blender/editors/animation/anim_markers.c12
-rw-r--r--source/blender/editors/armature/armature_utils.c4
-rw-r--r--source/blender/editors/armature/pose_transform.c8
-rw-r--r--source/blender/editors/gpencil/editaction_gpencil.c2
-rw-r--r--source/blender/editors/gpencil/gpencil_intern.h4
-rw-r--r--source/blender/editors/gpencil/gpencil_utils.c42
-rw-r--r--source/blender/editors/include/BIF_glutil.h18
-rw-r--r--source/blender/editors/interface/interface.c6
-rw-r--r--source/blender/editors/interface/interface_handlers.c4
-rw-r--r--source/blender/editors/mesh/editmesh_knife.c4
-rw-r--r--source/blender/editors/mesh/editmesh_rip.c2
-rw-r--r--source/blender/editors/mesh/editmesh_select.c6
-rw-r--r--source/blender/editors/mesh/editmesh_utils.c12
-rw-r--r--source/blender/editors/screen/area.c2
-rw-r--r--source/blender/editors/screen/glutil.c4
-rw-r--r--source/blender/editors/sculpt_paint/sculpt.c2
-rw-r--r--source/blender/editors/space_file/fsmenu.h2
-rw-r--r--source/blender/editors/space_image/image_ops.c4
-rw-r--r--source/blender/editors/space_node/node_edit.c2
-rw-r--r--source/blender/editors/space_text/text_format.c2
-rw-r--r--source/blender/editors/space_view3d/drawobject.c6
-rw-r--r--source/blender/editors/space_view3d/view3d_camera_control.c2
-rw-r--r--source/blender/editors/space_view3d/view3d_edit.c2
-rw-r--r--source/blender/editors/space_view3d/view3d_project.c78
-rw-r--r--source/blender/editors/space_view3d/view3d_utils.c42
-rw-r--r--source/blender/editors/space_view3d/view3d_view.c2
-rw-r--r--source/blender/editors/space_view3d/view3d_walk.c8
-rw-r--r--source/blender/editors/transform/transform.c2
-rw-r--r--source/blender/editors/transform/transform_generics.c2
-rw-r--r--source/blender/editors/util/ed_util.c2
31 files changed, 146 insertions, 146 deletions
diff --git a/source/blender/editors/animation/anim_channels_edit.c b/source/blender/editors/animation/anim_channels_edit.c
index c125c129e1d..8900e19def4 100644
--- a/source/blender/editors/animation/anim_channels_edit.c
+++ b/source/blender/editors/animation/anim_channels_edit.c
@@ -847,8 +847,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 05682292485..821cbd32705 100644
--- a/source/blender/editors/animation/anim_markers.c
+++ b/source/blender/editors/animation/anim_markers.c
@@ -120,12 +120,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)
{
@@ -545,7 +545,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 c6cd9475008..46e1b868520 100644
--- a/source/blender/editors/armature/armature_utils.c
+++ b/source/blender/editors/armature/armature_utils.c
@@ -170,8 +170,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 304a1f8df8c..f21d990a19e 100644
--- a/source/blender/editors/armature/pose_transform.c
+++ b/source/blender/editors/armature/pose_transform.c
@@ -296,10 +296,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 3a3953579a6..0becffa0bc6 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_intern.h b/source/blender/editors/gpencil/gpencil_intern.h
index f48736a15e1..229cc14719a 100644
--- a/source/blender/editors/gpencil/gpencil_intern.h
+++ b/source/blender/editors/gpencil/gpencil_intern.h
@@ -323,9 +323,9 @@ typedef enum ACTCONT_TYPES {
* 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(C, gpl, gps) \
diff --git a/source/blender/editors/gpencil/gpencil_utils.c b/source/blender/editors/gpencil/gpencil_utils.c
index 2b49b2bd3d1..50c1c2075ac 100644
--- a/source/blender/editors/gpencil/gpencil_utils.c
+++ b/source/blender/editors/gpencil/gpencil_utils.c
@@ -397,12 +397,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 int mval[2], const int UNUSED(mvalo[2]),
int rad, int x0, int y0, int x1, int y1)
@@ -558,8 +558,8 @@ void gp_point_conversion_init(bContext *C, GP_SpaceConversion *r_gsc)
/**
* Convert point to parent space
*
- * \param pt Original point
- * \param diff_mat Matrix with the difference between original parent matrix
+ * \param pt: Original point
+ * \param diff_mat: Matrix with the difference between original parent matrix
* \param[out] r_pt Pointer to new point after apply matrix
*/
void gp_point_to_parent_space(bGPDspoint *pt, float diff_mat[4][4], bGPDspoint *r_pt)
@@ -769,10 +769,10 @@ bool gp_point_xy_to_3d(GP_SpaceConversion *gsc, Scene *scene, const float screen
/**
* Apply smooth to stroke point
- * \param gps Stroke to smooth
- * \param i Point index
- * \param inf Amount of smoothing to apply
- * \param affect_pressure Apply smoothing to pressure values too?
+ * \param gps: Stroke to smooth
+ * \param i: Point index
+ * \param inf: Amount of smoothing to apply
+ * \param affect_pressure: Apply smoothing to pressure values too?
*/
bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure)
{
@@ -851,9 +851,9 @@ bool gp_smooth_stroke(bGPDstroke *gps, int i, float inf, bool affect_pressure)
/**
* Apply smooth for strength to stroke point
-* \param gps Stroke to smooth
-* \param i Point index
-* \param inf Amount of smoothing to apply
+* \param gps: Stroke to smooth
+* \param i: Point index
+* \param inf: Amount of smoothing to apply
*/
bool gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf)
{
@@ -889,9 +889,9 @@ bool gp_smooth_stroke_strength(bGPDstroke *gps, int i, float inf)
/**
* Apply smooth for thickness to stroke point (use pressure)
-* \param gps Stroke to smooth
-* \param i Point index
-* \param inf Amount of smoothing to apply
+* \param gps: Stroke to smooth
+* \param i: Point index
+* \param inf: Amount of smoothing to apply
*/
bool gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf)
{
@@ -927,8 +927,8 @@ bool gp_smooth_stroke_thickness(bGPDstroke *gps, int i, float inf)
/**
* Subdivide a stroke once, by adding a point half way between each pair of existing points
- * \param gps Stroke data
- * \param new_totpoints Total number of points (after subdividing)
+ * \param gps: Stroke data
+ * \param new_totpoints: Total number of points (after subdividing)
*/
void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints)
{
@@ -960,8 +960,8 @@ void gp_subdivide_stroke(bGPDstroke *gps, const int new_totpoints)
/**
* Add randomness to stroke
- * \param gps Stroke data
- * \param brush Brush data
+ * \param gps: Stroke data
+ * \param brush: Brush data
*/
void gp_randomize_stroke(bGPDstroke *gps, bGPDbrush *brush)
{
diff --git a/source/blender/editors/include/BIF_glutil.h b/source/blender/editors/include/BIF_glutil.h
index efd66dd79cf..ceb1a4f416a 100644
--- a/source/blender/editors/include/BIF_glutil.h
+++ b/source/blender/editors/include/BIF_glutil.h
@@ -69,10 +69,10 @@ extern const unsigned char stipple_checker_8px[128];
* through \a angle. The arc is centered at the origin
* and drawn in the XY plane.
*
- * \param start The initial angle (in radians).
- * \param angle The length of the arc (in radians).
- * \param radius The arc radius.
- * \param nsegments The number of segments to use in drawing the arc.
+ * \param start: The initial angle (in radians).
+ * \param angle: The length of the arc (in radians).
+ * \param radius: The arc radius.
+ * \param nsegments: The number of segments to use in drawing the arc.
*/
void glutil_draw_lined_arc(float start, float angle, float radius, int nsegments);
@@ -82,10 +82,10 @@ void glutil_draw_lined_arc(float start, float angle, float radius, int nsegments
* \a angle. The arc is centered at the origin
* and drawn in the XY plane.
*
- * \param start The initial angle (in radians).
- * \param angle The length of the arc (in radians).
- * \param radius The arc radius.
- * \param nsegments The number of segments to use in drawing the arc.
+ * \param start: The initial angle (in radians).
+ * \param angle: The length of the arc (in radians).
+ * \param radius: The arc radius.
+ * \param nsegments: The number of segments to use in drawing the arc.
*/
void glutil_draw_filled_arc(float start, float angle, float radius, int nsegments);
@@ -172,7 +172,7 @@ void glaDrawPixelsTexScaled_clipping(float x, float y, int img_w, int img_h, int
* thus no reason to +-0.5 the coordinates or perform other silly
* tricks.
*
- * \param screen_rect The screen rectangle to be defined for 2D drawing.
+ * \param screen_rect: The screen rectangle to be defined for 2D drawing.
*/
void glaDefine2DArea(struct rcti *screen_rect);
diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c
index ab87e1dda55..c2a0d00b2cd 100644
--- a/source/blender/editors/interface/interface.c
+++ b/source/blender/editors/interface/interface.c
@@ -2124,7 +2124,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)
{
@@ -2187,8 +2187,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_handlers.c b/source/blender/editors/interface/interface_handlers.c
index 64c3ae32eaa..d454d3bcbeb 100644
--- a/source/blender/editors/interface/interface_handlers.c
+++ b/source/blender/editors/interface/interface_handlers.c
@@ -2646,7 +2646,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.
*/
@@ -6872,7 +6872,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 9cc19d5194e..0b3c4dbc982 100644
--- a/source/blender/editors/mesh/editmesh_knife.c
+++ b/source/blender/editors/mesh/editmesh_knife.c
@@ -1390,7 +1390,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(
@@ -3003,7 +3003,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 0c8bd560bb2..f23f0ae5fab 100644
--- a/source/blender/editors/mesh/editmesh_rip.c
+++ b/source/blender/editors/mesh/editmesh_rip.c
@@ -58,7 +58,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 968c276c8bd..4f3db525c1b 100644
--- a/source/blender/editors/mesh/editmesh_select.c
+++ b/source/blender/editors/mesh/editmesh_select.c
@@ -443,11 +443,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 65b42571bbc..60aa410a665 100644
--- a/source/blender/editors/mesh/editmesh_utils.c
+++ b/source/blender/editors/mesh/editmesh_utils.c
@@ -993,12 +993,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 3ca989c92fe..5edd4ff63be 100644
--- a/source/blender/editors/screen/area.c
+++ b/source/blender/editors/screen/area.c
@@ -1635,7 +1635,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/screen/glutil.c b/source/blender/editors/screen/glutil.c
index 6e9a580e403..b83ee70fdb1 100644
--- a/source/blender/editors/screen/glutil.c
+++ b/source/blender/editors/screen/glutil.c
@@ -713,8 +713,8 @@ void gla2DSetMap(gla2DDrawInfo *di, rctf *rect)
*
* See glaDefine2DArea for an explanation of why this function uses integers.
*
- * \param screen_rect The screen rectangle to be used for 2D drawing.
- * \param world_rect The world rectangle that the 2D area represented
+ * \param screen_rect: The screen rectangle to be used for 2D drawing.
+ * \param world_rect: The world rectangle that the 2D area represented
* by \a screen_rect is supposed to represent. If NULL it is assumed the
* world has a 1 to 1 mapping to the screen.
*/
diff --git a/source/blender/editors/sculpt_paint/sculpt.c b/source/blender/editors/sculpt_paint/sculpt.c
index afee44c3dcc..c70aabb2d80 100644
--- a/source/blender/editors/sculpt_paint/sculpt.c
+++ b/source/blender/editors/sculpt_paint/sculpt.c
@@ -323,7 +323,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 df303a7bf11..b6e51ab4655 100644
--- a/source/blender/editors/space_image/image_ops.c
+++ b/source/blender/editors/space_image/image_ops.c
@@ -1092,8 +1092,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 c1fd7aa120f..ad3a1a37f7a 100644
--- a/source/blender/editors/space_node/node_edit.c
+++ b/source/blender/editors/space_node/node_edit.c
@@ -257,7 +257,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_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/drawobject.c b/source/blender/editors/space_view3d/drawobject.c
index c10f8f0ce16..dd174c7fd7a 100644
--- a/source/blender/editors/space_view3d/drawobject.c
+++ b/source/blender/editors/space_view3d/drawobject.c
@@ -411,7 +411,7 @@ static const float cosval[CIRCLE_RESOL] = {
};
/**
- * \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(const float viewmat_local_unit[3][3], const float c[3], float size, int axis)
@@ -4337,7 +4337,7 @@ static bool draw_mesh_object(Scene *scene, ARegion *ar, View3D *v3d, RegionView3
/**
- * \param dl_type_mask Only draw types matching this mask.
+ * \param dl_type_mask: Only draw types matching this mask.
* \return true when nothing was drawn
*/
static bool drawDispListwire_ex(ListBase *dlbase, unsigned int dl_type_mask)
@@ -7455,7 +7455,7 @@ static void draw_rigidbody_shape(Object *ob)
/**
* main object drawing function, draws in selection
- * \param dflag (draw flag) can be DRAW_PICKING and/or DRAW_CONSTCOLOR, DRAW_SCENESET
+ * \param dflag: (draw flag) can be DRAW_PICKING and/or DRAW_CONSTCOLOR, DRAW_SCENESET
*/
void draw_object(Main *bmain, Scene *scene, ARegion *ar, View3D *v3d, Base *base, const short dflag)
{
diff --git a/source/blender/editors/space_view3d/view3d_camera_control.c b/source/blender/editors/space_view3d/view3d_camera_control.c
index 31956ee5f86..5c544ed24df 100644
--- a/source/blender/editors/space_view3d/view3d_camera_control.c
+++ b/source/blender/editors/space_view3d/view3d_camera_control.c
@@ -281,7 +281,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 679498ab16d..23c445ebc3e 100644
--- a/source/blender/editors/space_view3d/view3d_edit.c
+++ b/source/blender/editors/space_view3d/view3d_edit.c
@@ -1033,7 +1033,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_project.c b/source/blender/editors/space_view3d/view3d_project.c
index 3cc0857c8a7..20f3feb28ac 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(
@@ -391,12 +391,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(
@@ -409,10 +409,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.
*/
@@ -427,9 +427,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])
{
@@ -489,10 +489,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,
@@ -584,9 +584,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)
{
@@ -607,9 +607,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])
{
@@ -641,9 +641,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])
{
@@ -668,12 +668,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 68582644f34..90da960ada8 100644
--- a/source/blender/editors/space_view3d/view3d_utils.c
+++ b/source/blender/editors/space_view3d/view3d_utils.c
@@ -1059,10 +1059,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,
@@ -1271,10 +1271,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(float mat[4][4], float ofs[3], float quat[4], float *dist)
{
@@ -1304,10 +1304,10 @@ void ED_view3d_from_m4(float mat[4][4], float ofs[3], float quat[4], float *dist
/**
* 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)
{
@@ -1321,11 +1321,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(Object *ob, float ofs[3], float quat[4], float *dist, float *lens)
{
@@ -1342,10 +1342,10 @@ void ED_view3d_from_object(Object *ob, float ofs[3], float quat[4], float *dist,
/**
* Set the object transformation from RegionView3D members.
- * \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 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(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 92f226f72de..cfd506caf6e 100644
--- a/source/blender/editors/space_view3d/view3d_view.c
+++ b/source/blender/editors/space_view3d/view3d_view.c
@@ -687,7 +687,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(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 b81d84a1436..b2846a630d2 100644
--- a/source/blender/editors/space_view3d/view3d_walk.c
+++ b/source/blender/editors/space_view3d/view3d_walk.c
@@ -407,7 +407,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],
@@ -441,9 +441,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 3276c4af8fc..b5d0ece3057 100644
--- a/source/blender/editors/transform/transform.c
+++ b/source/blender/editors/transform/transform.c
@@ -5806,7 +5806,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 5e24a3d9e47..a56b74983e7 100644
--- a/source/blender/editors/transform/transform_generics.c
+++ b/source/blender/editors/transform/transform_generics.c
@@ -1789,7 +1789,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 67b43814d40..b61960997b1 100644
--- a/source/blender/editors/util/ed_util.c
+++ b/source/blender/editors/util/ed_util.c
@@ -344,7 +344,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)
{