From b0e7108eda0081636e30de253562cdb372dc65e0 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 1 Oct 2019 18:03:33 +1000 Subject: Cleanup: use doxy sections for clip_ops.c --- source/blender/editors/space_clip/clip_ops.c | 103 ++++++++++++++++++++++----- 1 file changed, 85 insertions(+), 18 deletions(-) (limited to 'source/blender/editors/space_clip/clip_ops.c') diff --git a/source/blender/editors/space_clip/clip_ops.c b/source/blender/editors/space_clip/clip_ops.c index e6c5195d64a..446e3408d8c 100644 --- a/source/blender/editors/space_clip/clip_ops.c +++ b/source/blender/editors/space_clip/clip_ops.c @@ -78,7 +78,9 @@ #include "clip_intern.h" // own include -/******************** view navigation utilities *********************/ +/* -------------------------------------------------------------------- */ +/** \name View Navigation Utilities + * \{ */ static void sclip_zoom_set(const bContext *C, float zoom, @@ -162,7 +164,11 @@ static void sclip_zoom_set_factor_exec(bContext *C, const wmEvent *event, float ED_region_tag_redraw(ar); } -/******************** open clip operator ********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Open Clip Operator + * \{ */ static void clip_filesel(bContext *C, wmOperator *op, const char *path) { @@ -326,7 +332,11 @@ void CLIP_OT_open(wmOperatorType *ot) FILE_SORT_ALPHA); } -/******************* reload clip operator *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Reload Clip Operator + * \{ */ static int reload_exec(bContext *C, wmOperator *UNUSED(op)) { @@ -355,7 +365,11 @@ void CLIP_OT_reload(wmOperatorType *ot) ot->exec = reload_exec; } -/********************** view pan operator *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name View Pan Operator + * \{ */ typedef struct ViewPanData { float x, y; @@ -525,7 +539,11 @@ void CLIP_OT_view_pan(wmOperatorType *ot) FLT_MAX); } -/********************** view zoom operator *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name View Zoom Operator + * \{ */ typedef struct ViewZoomData { float x, y; @@ -729,7 +747,11 @@ void CLIP_OT_view_zoom(wmOperatorType *ot) WM_operator_properties_use_cursor_init(ot); } -/********************** view zoom in/out operator *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name View Zoom In/Out Operator + * \{ */ static int view_zoom_in_exec(bContext *C, wmOperator *op) { @@ -845,7 +867,11 @@ void CLIP_OT_view_zoom_out(wmOperatorType *ot) RNA_def_property_flag(prop, PROP_HIDDEN); } -/********************** view zoom ratio operator *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name View Zoom Ratio Operator + * \{ */ static int view_zoom_ratio_exec(bContext *C, wmOperator *op) { @@ -887,8 +913,11 @@ void CLIP_OT_view_zoom_ratio(wmOperatorType *ot) -FLT_MAX, FLT_MAX); } +/** \} */ -/********************** view all operator *********************/ +/* -------------------------------------------------------------------- */ +/** \name View All Operator + * \{ */ static int view_all_exec(bContext *C, wmOperator *op) { @@ -961,8 +990,11 @@ void CLIP_OT_view_all(wmOperatorType *ot) prop = RNA_def_boolean(ot->srna, "fit_view", 0, "Fit View", "Fit frame to the viewport"); RNA_def_property_flag(prop, PROP_SKIP_SAVE); } +/** \} */ -/********************** view selected operator *********************/ +/* -------------------------------------------------------------------- */ +/** \name View Selected Operator + * \{ */ static int view_selected_exec(bContext *C, wmOperator *UNUSED(op)) { @@ -992,8 +1024,11 @@ void CLIP_OT_view_selected(wmOperatorType *ot) /* flags */ ot->flag = OPTYPE_LOCK_BYPASS; } +/** \} */ -/********************** change frame operator *********************/ +/* -------------------------------------------------------------------- */ +/** \name Change Frame Operator + * \{ */ static bool change_frame_poll(bContext *C) { @@ -1109,8 +1144,11 @@ void CLIP_OT_change_frame(wmOperatorType *ot) /* rna */ RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME); } +/** \} */ -/********************** rebuild proxies operator *********************/ +/* -------------------------------------------------------------------- */ +/** \name Rebuild Proxies Operator + * \{ */ typedef struct ProxyBuildJob { Scene *scene; @@ -1521,8 +1559,11 @@ void CLIP_OT_rebuild_proxy(wmOperatorType *ot) /* flags */ ot->flag = OPTYPE_REGISTER; } +/** \} */ -/********************** mode set operator *********************/ +/* -------------------------------------------------------------------- */ +/** \name Mode Set Operator + * \{ */ static int mode_set_exec(bContext *C, wmOperator *op) { @@ -1558,7 +1599,12 @@ void CLIP_OT_mode_set(wmOperatorType *ot) } #ifdef WITH_INPUT_NDOF -/********************** NDOF operator *********************/ + +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name NDOF Operator + * \{ */ /* Combined pan/zoom from a 3D mouse device. * Z zooms, XY pans @@ -1608,9 +1654,14 @@ void CLIP_OT_view_ndof(wmOperatorType *ot) /* flags */ ot->flag = OPTYPE_LOCK_BYPASS; } + +/** \} */ + #endif /* WITH_INPUT_NDOF */ -/********************** Prefetch operator *********************/ +/* -------------------------------------------------------------------- */ +/** \name Prefetch Operator + * \{ */ static int clip_prefetch_modal(bContext *C, wmOperator *UNUSED(op), const wmEvent *event) { @@ -1650,8 +1701,11 @@ void CLIP_OT_prefetch(wmOperatorType *ot) ot->invoke = clip_prefetch_invoke; ot->modal = clip_prefetch_modal; } +/** \} */ -/********************** Set scene frames *********************/ +/* -------------------------------------------------------------------- */ +/** \name Set Scene Frames Operator + * \{ */ static int clip_set_scene_frames_exec(bContext *C, wmOperator *UNUSED(op)) { @@ -1686,8 +1740,11 @@ void CLIP_OT_set_scene_frames(wmOperatorType *ot) ot->poll = ED_space_clip_view_clip_poll; ot->exec = clip_set_scene_frames_exec; } +/** \} */ -/******************** set 3d cursor operator ********************/ +/* -------------------------------------------------------------------- */ +/** \name Set 3d Cursor Operator + * \{ */ static int clip_set_2d_cursor_exec(bContext *C, wmOperator *op) { @@ -1748,7 +1805,11 @@ void CLIP_OT_cursor_set(wmOperatorType *ot) 10.0f); } -/********************** Toggle lock to selection operator *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Toggle Lock To Selection Operator + * \{ */ static int lock_selection_togglee_exec(bContext *C, wmOperator *UNUSED(op)) { @@ -1773,7 +1834,11 @@ void CLIP_OT_lock_selection_toggle(wmOperatorType *ot) ot->flag = OPTYPE_LOCK_BYPASS; } -/********************** macros *********************/ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Macros + * \{ */ void ED_operatormacros_clip(void) { @@ -1797,3 +1862,5 @@ void ED_operatormacros_clip(void) otmacro = WM_operatortype_macro_define(ot, "TRANSFORM_OT_translate"); RNA_boolean_set(otmacro->ptr, "release_confirm", true); } + +/** \} */ -- cgit v1.2.3