From 4e683c4bd6a7850405d677503a40da582dfda2d1 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 16 Jan 2025 13:02:07 +1100 Subject: [PATCH] Cleanup: doxygen formatting for param --- source/blender/animrig/ANIM_action.hh | 8 ++++---- source/blender/animrig/ANIM_action_iterators.hh | 2 +- source/blender/animrig/ANIM_action_legacy.hh | 6 +++--- source/blender/blenkernel/BKE_action.hh | 2 +- .../blenkernel/BKE_volume_grid_type_traits.hh | 2 +- source/blender/bmesh/operators/bmo_join_triangles.cc | 2 +- source/blender/editors/include/ED_curves.hh | 12 ++++++------ source/blender/editors/include/ED_util.hh | 2 +- .../editors/sculpt_paint/grease_pencil_intern.hh | 4 ++-- .../editors/sculpt_paint/grease_pencil_trace_util.hh | 2 +- source/blender/editors/sculpt_paint/paint_intern.hh | 2 +- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/source/blender/animrig/ANIM_action.hh b/source/blender/animrig/ANIM_action.hh index 7d08287b563..4230f288c68 100644 --- a/source/blender/animrig/ANIM_action.hh +++ b/source/blender/animrig/ANIM_action.hh @@ -163,7 +163,7 @@ class Action : public ::bAction { * \note At the time of writing this comment only a single layer per Action is * supported in Blender, but this function does NOT enforce that. Be careful! * - * \param name The name to give the new layer. If no name is given, a default + * \param name: The name to give the new layer. If no name is given, a default * name is used. The name may be altered (e.g. appending ".001") to enforce * uniqueness within the Action. * @@ -200,7 +200,7 @@ class Action : public ::bAction { /** * Return the Slot with the given handle. * - * \param handle can be `Slot::unassigned`, in which case `nullptr` is returned. + * \param handle: can be `Slot::unassigned`, in which case `nullptr` is returned. * * \return `nullptr` when the slot cannot be found, so either the handle was * `Slot::unassigned` or some value that does not match any Slot in this Action. @@ -321,7 +321,7 @@ class Action : public ::bAction { /** * Set the active Slot, ensuring only one Slot is flagged as the Active one. * - * \param slot_handle if #Slot::unassigned, there will not be any active slot. + * \param slot_handle: if #Slot::unassigned, there will not be any active slot. * Passing an unknown/invalid slot handle will result in no slot being active. */ void slot_active_set(slot_handle_t slot_handle); @@ -1721,7 +1721,7 @@ void action_fcurve_attach(Action &action, * The F-Curve must exist on the source Action. All channelbags for all slots * are searched for the F-Curve. * - * \param action_slot_dst may not be #Slot::unassigned on layered Actions. + * \param action_slot_dst: may not be #Slot::unassigned on layered Actions. * * \see #blender::animrig::action_fcurve_detach */ diff --git a/source/blender/animrig/ANIM_action_iterators.hh b/source/blender/animrig/ANIM_action_iterators.hh index c13c57ea23a..96d36e51b7e 100644 --- a/source/blender/animrig/ANIM_action_iterators.hh +++ b/source/blender/animrig/ANIM_action_iterators.hh @@ -50,7 +50,7 @@ void foreach_fcurve_in_action_slot(Action &action, * - NLA strips. * - Action Constraints, both on Object and Pose Bone level. * - * \param callback The function to call for each Action+Slot used. Even when there is no slot + * \param callback: The function to call for each Action+Slot used. Even when there is no slot * assigned, this function will be called (but then with slot_handle = Slot::unassigned). The * callback should return `true` to continue the foreach loop, or return `false` to stop it. * diff --git a/source/blender/animrig/ANIM_action_legacy.hh b/source/blender/animrig/ANIM_action_legacy.hh index 2b1188498e7..1abfdb900a8 100644 --- a/source/blender/animrig/ANIM_action_legacy.hh +++ b/source/blender/animrig/ANIM_action_legacy.hh @@ -129,9 +129,9 @@ bool action_treat_as_legacy(const bAction &action); * This function works for both legacy and layered Actions. For the former, the * slot handle is ignored. * - * \param rna_path_prefix All F-Curves whose RNA path start with this string will get removed. Note - * that there is no other semantics here, so `prefix = "rotation"` will remove "rotation_euler" as - * well. The prefix may not be an empty string. + * \param rna_path_prefix: All F-Curves whose RNA path start with this string will get removed. + * Note that there is no other semantics here, so `prefix = "rotation"` will remove + * "rotation_euler" as well. The prefix may not be an empty string. * * \return true if any were removed, false otherwise. */ diff --git a/source/blender/blenkernel/BKE_action.hh b/source/blender/blenkernel/BKE_action.hh index bace610d46d..b5593e3d597 100644 --- a/source/blender/blenkernel/BKE_action.hh +++ b/source/blender/blenkernel/BKE_action.hh @@ -377,7 +377,7 @@ using FoundFCurveCallbackConst = /** * Calls `callback` for every fcurve in an action slot that targets any bone. * - * \param slot_handle only FCurves from the given action slot are visited. + * \param slot_handle: only FCurves from the given action slot are visited. */ void BKE_action_find_fcurves_with_bones(bAction *action, blender::animrig::slot_handle_t slot_handle, diff --git a/source/blender/blenkernel/BKE_volume_grid_type_traits.hh b/source/blender/blenkernel/BKE_volume_grid_type_traits.hh index c1be36f4ca5..3855fb55124 100644 --- a/source/blender/blenkernel/BKE_volume_grid_type_traits.hh +++ b/source/blender/blenkernel/BKE_volume_grid_type_traits.hh @@ -25,7 +25,7 @@ namespace blender::bke { * types, while only the code that deals with OpenVDB specifically has to care about the mapping * between math type representations. * - * \param T The Blender type that we want to get the grid traits for (e.g. `blender::float3`). + * \param T: The Blender type that we want to get the grid traits for (e.g. `blender::float3`). */ template struct VolumeGridTraits { /** diff --git a/source/blender/bmesh/operators/bmo_join_triangles.cc b/source/blender/bmesh/operators/bmo_join_triangles.cc index c50929420d3..f568c962b79 100644 --- a/source/blender/bmesh/operators/bmo_join_triangles.cc +++ b/source/blender/bmesh/operators/bmo_join_triangles.cc @@ -865,7 +865,7 @@ static void reprioritize_join(JoinEdgesState &s, * * \param s: State information about the join_triangles process. * \param f: A quad. - * \param f_error The current error of the face. + * \param f_error: The current error of the face. */ static void reprioritize_face_neighbors(JoinEdgesState &s, BMFace *f, float f_error) { diff --git a/source/blender/editors/include/ED_curves.hh b/source/blender/editors/include/ED_curves.hh index a9121d069ee..af03f920ece 100644 --- a/source/blender/editors/include/ED_curves.hh +++ b/source/blender/editors/include/ED_curves.hh @@ -157,7 +157,7 @@ IndexMask curve_mask_from_points(const bke::CurvesGeometry &curves, /** * Return a mask of all the end points in the curves. - * \param curves_mask (optional): The curves that should be used in the resulting point mask. + * \param curves_mask: (optional) The curves that should be used in the resulting point mask. * \param amount_start: The amount of points to mask from the front. * \param amount_end: The amount of points to mask from the back. * \param inverted: Invert the resulting mask. @@ -177,7 +177,7 @@ IndexMask end_points(const bke::CurvesGeometry &curves, /** * Return a mask of random points or curves. * - * \param mask (optional): The elements that should be used in the resulting mask. This mask should + * \param mask: (optional) The elements that should be used in the resulting mask. This mask should * be in the same domain as the \a selection_domain. \param random_seed: The seed for the \a * RandomNumberGenerator. \param probability: Determines how likely a point/curve will be chosen. * If set to 0.0, nothing will be in the mask, if set to 1.0 everything will be in the mask. @@ -267,7 +267,7 @@ void apply_selection_operation_at_index(GMutableSpan selection, int index, eSele /** * (De)select all the curves. * - * \param mask (optional): The elements that should be affected. This mask should be in the domain + * \param mask: (optional) The elements that should be affected. This mask should be in the domain * of the \a selection_domain. * \param action: One of #SEL_TOGGLE, #SEL_SELECT, #SEL_DESELECT, or #SEL_INVERT. * See `ED_select_utils.hh`. @@ -281,7 +281,7 @@ void select_all(bke::CurvesGeometry &curves, /** * Select the points of all curves that have at least one point selected. * - * \param curves_mask (optional): The curves that should be affected. + * \param curves_mask: (optional) The curves that should be affected. */ void select_linked(bke::CurvesGeometry &curves); void select_linked(bke::CurvesGeometry &curves, const IndexMask &curves_mask); @@ -289,7 +289,7 @@ void select_linked(bke::CurvesGeometry &curves, const IndexMask &curves_mask); /** * Select alternated points in strokes with already selected points * - * \param curves_mask (optional): The curves that should be affected. + * \param curves_mask: (optional) The curves that should be affected. */ void select_alternate(bke::CurvesGeometry &curves, const bool deselect_ends); void select_alternate(bke::CurvesGeometry &curves, @@ -299,7 +299,7 @@ void select_alternate(bke::CurvesGeometry &curves, /** * (De)select all the adjacent points of the current selected points. * - * \param curves_mask (optional): The curves that should be affected. + * \param curves_mask: (optional) The curves that should be affected. */ void select_adjacent(bke::CurvesGeometry &curves, bool deselect); void select_adjacent(bke::CurvesGeometry &curves, const IndexMask &curves_mask, bool deselect); diff --git a/source/blender/editors/include/ED_util.hh b/source/blender/editors/include/ED_util.hh index d47008eb68e..da57cf1c943 100644 --- a/source/blender/editors/include/ED_util.hh +++ b/source/blender/editors/include/ED_util.hh @@ -93,7 +93,7 @@ void ED_slider_factor_set(tSlider *slider, float factor); * By default the increment step is 0.1, which depending on the factor bounds might not be desired. * Only has an effect if increment is allowed and enabled. * See `ED_slider_allow_increments_set`. - * \param increment_step cannot be 0. + * \param increment_step: cannot be 0. */ void ED_slider_increment_step_set(tSlider *slider, float increment_step); diff --git a/source/blender/editors/sculpt_paint/grease_pencil_intern.hh b/source/blender/editors/sculpt_paint/grease_pencil_intern.hh index c4a340ba93b..15b13ab3565 100644 --- a/source/blender/editors/sculpt_paint/grease_pencil_intern.hh +++ b/source/blender/editors/sculpt_paint/grease_pencil_intern.hh @@ -153,8 +153,8 @@ DeltaProjectionFunc get_screen_projection_fn(const GreasePencilStrokeParams &par /** * Compute position offset for a point in the original geometry * from a screen offset and crazyspace deformation info. - * \param projection_fn Projection from screen space to the evaluated object. - * \param deformation Converts evaluated position delta to original geometry. + * \param projection_fn: Projection from screen space to the evaluated object. + * \param deformation: Converts evaluated position delta to original geometry. */ float3 compute_orig_delta(const DeltaProjectionFunc &projection_fn, const bke::crazyspace::GeometryDeformation &deformation, diff --git a/source/blender/editors/sculpt_paint/grease_pencil_trace_util.hh b/source/blender/editors/sculpt_paint/grease_pencil_trace_util.hh index 6efacec81dc..ec0449e1c04 100644 --- a/source/blender/editors/sculpt_paint/grease_pencil_trace_util.hh +++ b/source/blender/editors/sculpt_paint/grease_pencil_trace_util.hh @@ -100,7 +100,7 @@ bke::CurvesGeometry trace_to_curves(const Trace &trace, /** * Convert an image to a potrace bitmap representing foreground and background regions. - * \param fn Function that returns true if the given color is a foreground color. + * \param fn: Function that returns true if the given color is a foreground color. */ template Bitmap *image_to_bitmap(const ImBuf &ibuf, ThresholdFn fn) { diff --git a/source/blender/editors/sculpt_paint/paint_intern.hh b/source/blender/editors/sculpt_paint/paint_intern.hh index 4335bd10cb7..2e7b9403a3f 100644 --- a/source/blender/editors/sculpt_paint/paint_intern.hh +++ b/source/blender/editors/sculpt_paint/paint_intern.hh @@ -69,7 +69,7 @@ namespace blender::ed::sculpt_paint { /** * Callback function to retrieve the object space coordinates based on screen space coordinates. - * \param location resulting object space coordinates + * \param location: resulting object space coordinates * \returns whether or not a value was actually found & the value in location is usable */ using StrokeGetLocation = bool (*)(bContext *C,