diff options
author | Campbell Barton <ideasman42@gmail.com> | 2014-05-29 15:16:04 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2014-05-29 15:17:48 +0400 |
commit | 6c721a86ffae49b7ce34b8a83fbe9346faefd043 (patch) | |
tree | 054804868b2115e81c73f4b72b359a5bda3709a4 /source/blender/editors/animation/anim_markers.c | |
parent | d7708817d68617cb15d0690ebbd33a0fa090f4d2 (diff) |
Cleanup: Use doxy for more structured comments
Diffstat (limited to 'source/blender/editors/animation/anim_markers.c')
-rw-r--r-- | source/blender/editors/animation/anim_markers.c | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/source/blender/editors/animation/anim_markers.c b/source/blender/editors/animation/anim_markers.c index 04363f61fd6..e0592e594be 100644 --- a/source/blender/editors/animation/anim_markers.c +++ b/source/blender/editors/animation/anim_markers.c @@ -115,12 +115,15 @@ ListBase *ED_animcontext_get_markers(const bAnimContext *ac) /* --------------------------------- */ -/* Apply some transformation to markers after the fact - * < markers: list of markers to affect - this may or may not be the scene markers list, so don't assume anything - * < scene: current scene (for getting current frame) - * < mode: (TfmMode) transform mode that this transform is for - * < value: from the transform code, this is t->vec[0] (which is delta transform for grab/extend, and scale factor for scale) - * < side: (B/L/R) for 'extend' functionality, which side of current frame to use +/** + * Apply some transformation to markers after the fact + * + * \param markers List of markers to affect - this may or may not be the scene markers list, so don't assume anything + * \param scene Current scene (for getting current frame) + * \param mode (TfmMode) transform mode that this transform is for + * \param value From the transform code, this is ``t->vec[0]`` + * (which is delta transform for grab/extend, and scale factor for scale) + * \param side (B/L/R) for 'extend' functionality, which side of current frame to use */ int ED_markers_post_apply_transform(ListBase *markers, Scene *scene, int mode, float value, char side) { @@ -472,13 +475,14 @@ static int ed_markers_poll_markers_exist(bContext *C) /* ------------------------ */ -/* Second-tier invoke() callback that performs context validation before running the +/** + * Second-tier invoke() callback that performs context validation before running the * "custom"/third-tier invoke() callback supplied as the last arg (which would normally * be the operator's invoke() callback elsewhere) * - * < invoke_func: (fn(bContext *, wmOperator *, wmEvent *)=int) "standard" invoke function - * that operator would otherwise have used. If NULL, the operator's standard - * exec() callback will be called instead in the appropriate places. + * \param invoke_func "standard" invoke function that operator would otherwise have used. + * If NULL, the operator's standard exec() + * callback will be called instead in the appropriate places. */ static int ed_markers_opwrap_invoke_custom(bContext *C, wmOperator *op, const wmEvent *event, int (*invoke_func)(bContext *, wmOperator *, const wmEvent *)) |