Cleanup: doxygen formatting for param

This commit is contained in:
Campbell Barton
2025-01-16 13:02:07 +11:00
parent e3e8c154fa
commit 4e683c4bd6
11 changed files with 22 additions and 22 deletions

View File

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

View File

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

View File

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

View File

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

View File

@@ -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<typename T> struct VolumeGridTraits {
/**

View File

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

View File

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

View File

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

View File

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

View File

@@ -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<typename ThresholdFn> Bitmap *image_to_bitmap(const ImBuf &ibuf, ThresholdFn fn)
{

View File

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