Cleanup: use color after doxygen parameters

This commit is contained in:
Campbell Barton
2023-12-17 16:04:40 +11:00
parent 225fc6fca7
commit 53a51d2148
7 changed files with 12 additions and 12 deletions

View File

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

View File

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

View File

@@ -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<std::string> rna_paths,

View File

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

View File

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

View File

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

View File

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