griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: use colon after the doxygen params argument & doxygen comments

Browse Source
This commit is contained in:
Campbell Barton
2025-07-22 23:25:02 +00:00
parent 06bb402f22
commit 72a88de9ef
9 changed files with 39 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
source/blender/blenkernel/BKE_animsys.h
View File

@@ -80,20 +80,23 @@ struct KS_Path *BKE_keyingset_find_path(struct KeyingSet *ks,
int array_index,
int group_mode);
/* Copy all KeyingSets in the given list */
/** Copy all KeyingSets in the given list. */
void BKE_keyingsets_copy(struct ListBase *newlist, const struct ListBase *list);
/** Process the ID pointers inside a scene's keyingsets, in see `BKE_lib_query.hh` for details. */
/**
* Process the ID pointers inside a scene's keying-sets, in.
* see `BKE_lib_query.hh` for details.
*/
void BKE_keyingsets_foreach_id(struct LibraryForeachIDData *data,
const struct ListBase *keyingsets);
/* Free the given Keying Set path */
/** Free the given Keying Set path. */
void BKE_keyingset_free_path(struct KeyingSet *ks, struct KS_Path *ksp);
/* Free data for KeyingSet but not set itself */
/** Free data for KeyingSet but not set itself. */
void BKE_keyingset_free_paths(struct KeyingSet *ks);
/* Free all the KeyingSets in the given list */
/** Free all the KeyingSets in the given list. */
void BKE_keyingsets_free(struct ListBase *list);
void BKE_keyingsets_blend_write(struct BlendWriter *writer, struct ListBase *list);
@@ -291,7 +294,7 @@ bool BKE_animsys_read_from_rna_path(struct PathResolvedRNA *anim_rna, float *r_v
/**
* Write the given value to a setting using RNA, and return success.
*
* \param force_write When false, this function will only call the RNA setter when `value` is
* \param force_write: When false, this function will only call the RNA setter when `value` is
* different from the property's current value. When true, this function will skip that check and
* always call the RNA setter.
*/
@@ -341,14 +344,16 @@ void animsys_evaluate_action(struct PointerRNA *ptr,
const struct AnimationEvalContext *anim_eval_context,
bool flush_to_original);
/* Evaluate action, and blend the result into the current values (instead of overwriting fully). */
/**
* Evaluate action, and blend the result into the current values (instead of overwriting fully).
*/
void animsys_blend_in_action(struct PointerRNA *ptr,
struct bAction *act,
int32_t action_slot_handle,
const AnimationEvalContext *anim_eval_context,
float blend_factor);
/* Evaluate Action Group */
/** Evaluate Action Group. */
void animsys_evaluate_action_group(struct PointerRNA *ptr,
struct bAction *act,
struct bActionGroup *agrp,

10
source/blender/blenkernel/BKE_idprop.hh
View File

@@ -56,7 +56,7 @@ union IDPropertyTemplate {
*/
IDProperty *IDP_NewIDPArray(blender::StringRef name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
/**
* \param flag the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* \param flag: the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* #BKE_id_copy_ex.
*/
IDProperty *IDP_CopyIDPArray(const IDProperty *array, int flag) ATTR_WARN_UNUSED_RESULT
@@ -117,7 +117,7 @@ bool IDP_EnumItemsValidate(const IDPropertyUIDataEnumItem *items,
using IDPWalkFunc = void (*)(void *user_data, IDProperty *idp);
/**
* \param flag the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* \param flag: the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* #BKE_id_copy_ex.
*/
void IDP_AssignID(IDProperty *prop, ID *id, int flag);
@@ -141,7 +141,7 @@ void IDP_ReplaceInGroup(IDProperty *group, IDProperty *prop) ATTR_NONNULL();
* Checks if a property with the same name as prop exists, and if so replaces it.
* Use this to preserve order!
*
* \param flag the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* \param flag: the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* #BKE_id_copy_ex.
*/
void IDP_ReplaceInGroup_ex(IDProperty *group, IDProperty *prop, IDProperty *prop_exist, int flag);
@@ -154,7 +154,7 @@ void IDP_MergeGroup(IDProperty *dest, const IDProperty *src, bool do_overwrite)
* If a property is missing in \a dest, add it.
* Do it recursively.
*
* \param flag the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* \param flag: the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* #BKE_id_copy_ex.
*/
void IDP_MergeGroup_ex(IDProperty *dest, const IDProperty *src, bool do_overwrite, int flag)
@@ -220,7 +220,7 @@ IDProperty *IDP_ID_system_properties_ensure(ID *id) ATTR_WARN_UNUSED_RESULT ATTR
IDProperty *IDP_CopyProperty(const IDProperty *prop) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
/**
* \param flag the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* \param flag: the ID creation/copying flags (`LIB_ID_CREATE_...`), same as passed to
* #BKE_id_copy_ex.
*/
IDProperty *IDP_CopyProperty_ex(const IDProperty *prop, int flag) ATTR_WARN_UNUSED_RESULT

2
source/blender/blenkernel/BKE_path_templates.hh
View File

@@ -385,7 +385,7 @@ blender::Vector<blender::bke::path_templates::Error> BKE_path_validate_template(
* - Format specifications that don't apply to the type of variable they're
* paired with.
*
* \param path_max_length The maximum length that template expansion is allowed
* \param path_max_length: The maximum length that template expansion is allowed
* to make the template-expanded path (in bytes), including the null terminator.
* In general, this should be the size of the underlying allocation of `path`.
*

2
source/blender/blenkernel/BKE_subdiv_eval.hh
View File

@@ -31,7 +31,7 @@ bool eval_begin(Subdiv *subdiv,
const OpenSubdiv_EvaluatorSettings *settings);
/**
* \param coarse_vert_positions optional span of positions to override the mesh positions
* \param coarse_vert_positions: optional span of positions to override the mesh positions.
*/
bool eval_begin_from_mesh(Subdiv *subdiv,
const Mesh *mesh,

7
source/blender/blenkernel/intern/path_templates.cc
View File

@@ -639,12 +639,11 @@ static FormatSpecifier parse_format_specifier(blender::StringRef format_specifie
* Find and parse the next valid token in `path` starting from index
* `from_char`.
*
* \param path The path string to parse.
* \param path: The path string to parse.
*
* \param from_char The char index to start from.
* \param from_char: The char index to start from.
*
* \return The parsed token information, or nullopt if no token is found in
* `path`.
* \return The parsed token information, or #std::nullopt if no token is found in `path`.
*/
static std::optional<Token> next_token(blender::StringRef path, const int from_char)
{

7
source/blender/editors/sculpt_paint/sculpt.cc
View File

@@ -4795,9 +4795,10 @@ bool cursor_geometry_info_update(bContext *C,
}
/**
* \param check_closest if true and the ray test fails a point closest to the ray will be found.
* \param limit_closest_radius if true then the closest point will be tested against the active
* brush radius. */
* \param check_closest: if true and the ray test fails a point closest to the ray will be found.
* \param limit_closest_radius: if true then the closest point will be tested against the active
* brush radius.
*/
static bool stroke_get_location_bvh_ex(bContext *C,
float3 &out,
const float2 &mval,

20
source/blender/geometry/GEO_interpolate_curves.hh
View File

@@ -11,10 +11,10 @@ namespace blender::geometry {
/**
* Assign source point indices and interpolation factors to target points.
*
* \param positions Source curve positions.
* \param cyclic True if the source curve is cyclic.
* \param r_indices Output array of point indices of the source curve.
* \param r_factors Output array of interpolation factors between a source point and the next.
* \param positions: Source curve positions.
* \param cyclic: True if the source curve is cyclic.
* \param r_indices: Output array of point indices of the source curve.
* \param r_factors: Output array of interpolation factors between a source point and the next.
*/
void sample_curve_padded(const Span<float3> positions,
bool cyclic,
@@ -24,12 +24,12 @@ void sample_curve_padded(const Span<float3> positions,
/**
* Assign source point indices and interpolation factors to target points for a single curve.
*
* \param curves Source curves geometry to sample.
* \param curve_index Index of the source curve to sample.
* \param cyclic True if the source curve is cyclic.
* \param reverse True if the curve should be sampled in reverse direction.
* \param r_indices Output array of point indices of the source curve.
* \param r_factors Output array of interpolation factors between a source point and the next.
* \param curves: Source curves geometry to sample.
* \param curve_index: Index of the source curve to sample.
* \param cyclic: True if the source curve is cyclic.
* \param reverse: True if the curve should be sampled in reverse direction.
* \param r_indices: Output array of point indices of the source curve.
* \param r_factors: Output array of interpolation factors between a source point and the next.
*/
void sample_curve_padded(const bke::CurvesGeometry &curves,
int curve_index,

2
source/blender/imbuf/movie/intern/movie_write.cc
View File

@@ -1469,7 +1469,7 @@ static void flush_delayed_frames(AVCodecContext *c, AVStream *stream, AVFormatCo
/**
* Get the output filename-- similar to the other output formats.
*
* \param reports If non-null, will report errors with `RPT_ERROR` level reports.
* \param reports: If non-null, will report errors with `RPT_ERROR` level reports.
*
* \return true on success, false on failure due to errors.
*/

2
source/blender/nodes/composite/nodes/node_composite_file_output.cc
View File

@@ -951,7 +951,7 @@ class FileOutputOperation : public NodeOperation {
* If there are any errors processing the path, the resulting path will be
* empty.
*
* \param apply_template Whether to run templating on the path or not. This is
* \param apply_template: Whether to run templating on the path or not. This is
* needed because this function is called from more than one place, some of
* which have already applied templating to the path and some of which
* haven't. Double-applying templating can give incorrect results.