diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-10 13:42:06 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-10 13:42:06 +0300 |
commit | bd2b48e98d77c8437b8b0c77582084a3c984e45c (patch) | |
tree | 0d9eeff42d23943f9e01d2f6dbdb158944aa41d8 /source/blender/editors/animation/anim_markers.c | |
parent | 63f8d18c0fbc8bce12c65eb6bd49ec28eef703e4 (diff) |
Cleanup: move public doc-strings into headers for various API's
Some doc-strings were skipped because of blank-lines between
the doc-string and the symbol and needed to be moved manually.
- Added space below non doc-string comments to make it clear
these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
Ref T92709
Diffstat (limited to 'source/blender/editors/animation/anim_markers.c')
-rw-r--r-- | source/blender/editors/animation/anim_markers.c | 31 |
1 files changed, 3 insertions, 28 deletions
diff --git a/source/blender/editors/animation/anim_markers.c b/source/blender/editors/animation/anim_markers.c index e12433f4d4c..baf3eaae8e2 100644 --- a/source/blender/editors/animation/anim_markers.c +++ b/source/blender/editors/animation/anim_markers.c @@ -99,13 +99,11 @@ static ListBase *context_get_markers(Scene *scene, ScrArea *area) /* ............. */ -/* public API for getting markers from context */ ListBase *ED_context_get_markers(const bContext *C) { return context_get_markers(CTX_data_scene(C), CTX_wm_area(C)); } -/* public API for getting markers from "animation" context */ ListBase *ED_animcontext_get_markers(const bAnimContext *ac) { if (ac) { @@ -116,17 +114,6 @@ ListBase *ED_animcontext_get_markers(const bAnimContext *ac) /* --------------------------------- */ -/** - * 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) { @@ -168,8 +155,6 @@ int ED_markers_post_apply_transform( /* --------------------------------- */ -/* Get the marker that is closest to this point */ -/* XXX for select, the min_dist should be small */ TimeMarker *ED_markers_find_nearest_marker(ListBase *markers, float x) { TimeMarker *marker, *nearest = NULL; @@ -189,7 +174,6 @@ TimeMarker *ED_markers_find_nearest_marker(ListBase *markers, float x) return nearest; } -/* Return the time of the marker that occurs on a frame closest to the given time */ int ED_markers_find_nearest_marker_time(ListBase *markers, float x) { TimeMarker *nearest = ED_markers_find_nearest_marker(markers, x); @@ -323,10 +307,6 @@ static void add_marker_to_cfra_elem(ListBase *lb, TimeMarker *marker, short only cen->sel = marker->flag; } -/* This function makes a list of all the markers. The only_sel - * argument is used to specify whether only the selected markers - * are added. - */ void ED_markers_make_cfra_list(ListBase *markers, ListBase *lb, short only_sel) { TimeMarker *marker; @@ -375,7 +355,6 @@ void ED_markers_deselect_all(ListBase *markers, int action) /* --------------------------------- */ -/* Get the first selected marker */ TimeMarker *ED_markers_get_first_selected(ListBase *markers) { TimeMarker *marker; @@ -393,12 +372,11 @@ TimeMarker *ED_markers_get_first_selected(ListBase *markers) /* --------------------------------- */ -/* Print debugging prints of list of markers - * BSI's: do NOT make static or put in if-defs as "unused code". - * That's too much trouble when we need to use for quick debugging! - */ void debug_markers_print_list(ListBase *markers) { + /* NOTE: do NOT make static or put in if-defs as "unused code". + * That's too much trouble when we need to use for quick debugging! */ + TimeMarker *marker; if (markers == NULL) { @@ -564,7 +542,6 @@ static void get_marker_clip_frame_range(View2D *v2d, float xscale, int r_range[2 r_range[1] = v2d->cur.xmax + font_width_max; } -/* Draw Scene-Markers in time window */ void ED_markers_draw(const bContext *C, int flag) { ListBase *markers = ED_context_get_markers(C); @@ -1699,7 +1676,6 @@ static void MARKER_OT_camera_bind(wmOperatorType *ot) /* ************************** registration **********************************/ -/* called in screen_ops.c:ED_operatortypes_screen() */ void ED_operatortypes_marker(void) { WM_operatortype_append(MARKER_OT_add); @@ -1716,7 +1692,6 @@ void ED_operatortypes_marker(void) #endif } -/* called in screen_ops.c:ED_keymap_screen() */ void ED_keymap_marker(wmKeyConfig *keyconf) { WM_keymap_ensure(keyconf, "Markers", 0, 0); |