diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-04-14 11:48:42 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-04-14 11:48:42 +0300 |
commit | eff8cc9cccdaa7248d9d869473704e9db69c2f41 (patch) | |
tree | 95c67fbd688b1f63dfef77372a7eaeb40aa15ec5 /source/blender/editors/include/ED_keyframing.h | |
parent | b7e5433890debe629a0677473ba920f743de3342 (diff) |
Cleanup: doxy comments
Use doxy references to function and enums,
also correct some names which became out of sync.
Diffstat (limited to 'source/blender/editors/include/ED_keyframing.h')
-rw-r--r-- | source/blender/editors/include/ED_keyframing.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/source/blender/editors/include/ED_keyframing.h b/source/blender/editors/include/ED_keyframing.h index 51dfa3c7dff..5191978c529 100644 --- a/source/blender/editors/include/ED_keyframing.h +++ b/source/blender/editors/include/ED_keyframing.h @@ -377,11 +377,12 @@ bool fcurve_frame_has_keyframe(struct FCurve *fcu, float frame, short filter); */ bool fcurve_is_changed(struct PointerRNA ptr, struct PropertyRNA *prop, struct FCurve *fcu, float frame); -/* Main Keyframe Checking API call: +/** + * Main Keyframe Checking API call: * Checks whether a keyframe exists for the given ID-block one the given frame. * - It is recommended to call this method over the other keyframe-checkers directly, * in case some detail of the implementation changes... - * - frame: the value of this is quite often result of BKE_scene_frame_get() + * - frame: the value of this is quite often result of #BKE_scene_frame_get() */ bool id_frame_has_keyframe(struct ID *id, float frame, short filter); |