diff options
author | Campbell Barton <campbell@blender.org> | 2022-03-01 01:09:24 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-03-01 01:36:25 +0300 |
commit | 5777bd719b01f56e52d618a3260bd4cdf223d5cd (patch) | |
tree | f0f9e80c3a44ca542939ee03010b66a255fd01e7 /source/blender/editors/include/ED_keyframes_keylist.h | |
parent | 94a4dddb1b64ec0912b7b2ac5b2264e86cd3d955 (diff) |
Cleanup: use doxygen comments, correct spelling
Also move eDupli_ID_Flags doc-string to it's declaration.
Diffstat (limited to 'source/blender/editors/include/ED_keyframes_keylist.h')
-rw-r--r-- | source/blender/editors/include/ED_keyframes_keylist.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/source/blender/editors/include/ED_keyframes_keylist.h b/source/blender/editors/include/ED_keyframes_keylist.h index 39f050c9739..fd3d35e1df7 100644 --- a/source/blender/editors/include/ED_keyframes_keylist.h +++ b/source/blender/editors/include/ED_keyframes_keylist.h @@ -132,8 +132,10 @@ const struct ActKeyColumn *ED_keylist_find_any_between(const struct AnimKeylist bool ED_keylist_is_empty(const struct AnimKeylist *keylist); const struct ListBase /* ActKeyColumn */ *ED_keylist_listbase(const struct AnimKeylist *keylist); bool ED_keylist_all_keys_frame_range(const struct AnimKeylist *keylist, Range2f *r_frame_range); -/* Return the selected keyframe's range. If none are selected, return False and does not affect - * the frame range. */ +/** + * Return the selected key-frame's range. + * \return False If none are selected and does not affect the frame range. + */ bool ED_keylist_selected_keys_frame_range(const struct AnimKeylist *keylist, Range2f *r_frame_range); const ActKeyColumn *ED_keylist_array(const struct AnimKeylist *keylist); @@ -187,10 +189,10 @@ void mask_to_keylist(struct bDopeSheet *ads, /* ActKeyColumn API ---------------- */ -/* Checks if ActKeyColumn has any block data */ +/** Checks if #ActKeyColumn has any block data. */ bool actkeyblock_is_valid(const ActKeyColumn *ac); -/* Checks if ActKeyColumn can be used as a block (i.e. drawn/used to detect "holds") */ +/** Checks if #ActKeyColumn can be used as a block (i.e. drawn/used to detect "holds"). */ int actkeyblock_get_valid_hold(const ActKeyColumn *ac); #ifdef __cplusplus |