From 53a51d21480a246f99ef3d9228b21640daca36d3 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sun, 17 Dec 2023 16:04:40 +1100 Subject: [PATCH] Cleanup: use color after doxygen parameters --- source/blender/animrig/ANIM_action.hh | 2 +- source/blender/animrig/ANIM_fcurve.hh | 2 +- source/blender/animrig/ANIM_keyframing.hh | 4 ++-- source/blender/blenkernel/BKE_fcurve.h | 2 +- source/blender/blenkernel/BKE_lib_override.hh | 2 +- source/blender/editors/include/ED_keyframes_keylist.hh | 4 ++-- source/blender/makesdna/DNA_grease_pencil_types.h | 8 ++++---- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/source/blender/animrig/ANIM_action.hh b/source/blender/animrig/ANIM_action.hh index 7a8037cfb21..fbbd93ec1aa 100644 --- a/source/blender/animrig/ANIM_action.hh +++ b/source/blender/animrig/ANIM_action.hh @@ -17,7 +17,7 @@ namespace blender::animrig { /** * Get (or add relevant data to be able to do so) F-Curve from the given Action, * for the given Animation Data block. This assumes that all the destinations are valid. - * \param ptr can be a null pointer. + * \param ptr: can be a null pointer. */ FCurve *action_fcurve_ensure(Main *bmain, bAction *act, diff --git a/source/blender/animrig/ANIM_fcurve.hh b/source/blender/animrig/ANIM_fcurve.hh index 5d0ac31f016..70d99a44433 100644 --- a/source/blender/animrig/ANIM_fcurve.hh +++ b/source/blender/animrig/ANIM_fcurve.hh @@ -25,7 +25,7 @@ struct KeyframeSettings { /** * Helper function to generate the KeyframeSettings struct. * - * \param from_userprefs if true read the user preferences for the settings, else return static + * \param from_userprefs: if true read the user preferences for the settings, else return static * defaults. */ KeyframeSettings get_keyframe_settings(bool from_userprefs); diff --git a/source/blender/animrig/ANIM_keyframing.hh b/source/blender/animrig/ANIM_keyframing.hh index a3738d3a495..fa0cbfa0a1b 100644 --- a/source/blender/animrig/ANIM_keyframing.hh +++ b/source/blender/animrig/ANIM_keyframing.hh @@ -179,7 +179,7 @@ bool autokeyframe_property(bContext *C, /** * Insert keys for the given rna_path in the given action. The length of the values Span is * expected to be the size of the property array. - * \param frame is expected to be in the local time of the action, meaning it has to be NLA mapped + * \param frame: is expected to be in the local time of the action, meaning it has to be NLA mapped * already. * \returns The number of keys inserted. */ @@ -195,7 +195,7 @@ int insert_key_action(Main *bmain, /** * Insert keys to the ID of the given PointerRNA for the given RNA paths. Tries to create an * action if none exists yet. - * \param scene_frame is expected to be not NLA mapped as that happens within the function. + * \param scene_frame: is expected to be not NLA mapped as that happens within the function. */ void insert_key_rna(PointerRNA *rna_pointer, const blender::Span rna_paths, diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h index ff4ab3a0d76..3ab81d00f85 100644 --- a/source/blender/blenkernel/BKE_fcurve.h +++ b/source/blender/blenkernel/BKE_fcurve.h @@ -505,7 +505,7 @@ void BKE_fcurve_delete_key(struct FCurve *fcu, int index); * removing keys. * Has a complexity of O(N) with respect to number of keys in `fcu`. * - * \param index_range is right exclusive. + * \param index_range: is right exclusive. */ void BKE_fcurve_delete_keys(FCurve *fcu, blender::uint2 index_range); diff --git a/source/blender/blenkernel/BKE_lib_override.hh b/source/blender/blenkernel/BKE_lib_override.hh index ff8e4752c99..648390e351c 100644 --- a/source/blender/blenkernel/BKE_lib_override.hh +++ b/source/blender/blenkernel/BKE_lib_override.hh @@ -292,7 +292,7 @@ void BKE_lib_override_library_delete(Main *bmain, ID *id_root); /** * Make given ID fully local. * - * \param bmain If given, all liboverrides hierarchy roots will be re-validated/generated after + * \param bmain: If given, all liboverrides hierarchy roots will be re-validated/generated after * clearing the liboverride data from given \a id. If nullptr, caller is responsible to perform * this action (call #BKE_lib_override_library_main_hierarchy_root_ensure) itself. * diff --git a/source/blender/editors/include/ED_keyframes_keylist.hh b/source/blender/editors/include/ED_keyframes_keylist.hh index d2b61bae4d3..3290e843d7e 100644 --- a/source/blender/editors/include/ED_keyframes_keylist.hh +++ b/source/blender/editors/include/ED_keyframes_keylist.hh @@ -148,8 +148,8 @@ int64_t ED_keylist_array_len(const AnimKeylist *keylist); /** * Add the keyframes of the F-Curve to the keylist. - * \param adt can be a nullptr. - * \param range only adds keys in the given range to the keylist. + * \param adt: can be a nullptr. + * \param range: only adds keys in the given range to the keylist. */ void fcurve_to_keylist( AnimData *adt, FCurve *fcu, AnimKeylist *keylist, int saction_flag, blender::float2 range); diff --git a/source/blender/makesdna/DNA_grease_pencil_types.h b/source/blender/makesdna/DNA_grease_pencil_types.h index cc4e7ab2579..60b66e0cb2a 100644 --- a/source/blender/makesdna/DNA_grease_pencil_types.h +++ b/source/blender/makesdna/DNA_grease_pencil_types.h @@ -536,11 +536,11 @@ typedef struct GreasePencil { /** * Moves and/or inserts duplicates of a set of frames in a \a layer. * - * \param frame_number_destination describes all transformations that should be applied on the + * \param frame_number_destination: describes all transformations that should be applied on the * frame keys. - * \param duplicate_frames the frames that should be duplicated instead of moved. Keys of the map - * are the keys of the corresponding source frames. Frames will be inserted at the key given by - * the map \a frame_number_destination. + * \param duplicate_frames: the frames that should be duplicated instead of moved. + * Keys of the map are the keys of the corresponding source frames. + * Frames will be inserted at the key given by the map \a frame_number_destination. * * If a transformation overlaps another frames, the frame will be overwritten, and the * corresponding drawing may be removed, if it no longer has users.