From 61776befc3f88c373e47ccbdf8c75e2ca0f4e987 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 9 Dec 2021 00:55:11 +1100 Subject: Cleanup: move public doc-strings into headers for 'editors' Ref T92709 --- source/blender/editors/util/ed_draw.c | 15 --------------- source/blender/editors/util/ed_util.c | 13 ------------- source/blender/editors/util/gizmo_utils.c | 1 - source/blender/editors/util/numinput.c | 4 ---- source/blender/editors/util/select_utils.c | 10 ---------- 5 files changed, 43 deletions(-) (limited to 'source/blender/editors/util') diff --git a/source/blender/editors/util/ed_draw.c b/source/blender/editors/util/ed_draw.c index 721e32a3051..ccbde07f5b1 100644 --- a/source/blender/editors/util/ed_draw.c +++ b/source/blender/editors/util/ed_draw.c @@ -397,17 +397,11 @@ tSlider *ED_slider_create(struct bContext *C) return slider; } -/** - * For modal operations so the percentage doesn't pop on the first mouse movement. - */ void ED_slider_init(struct tSlider *slider, const wmEvent *event) { copy_v2fl_v2i(slider->last_cursor, event->xy); } -/** - * Calculate slider factor based on mouse position. - */ bool ED_slider_modal(tSlider *slider, const wmEvent *event) { bool event_handled = true; @@ -441,9 +435,6 @@ bool ED_slider_modal(tSlider *slider, const wmEvent *event) return event_handled; } -/** - * Return string based on the current state of the slider. - */ void ED_slider_status_string_get(const struct tSlider *slider, char *status_string, const size_t size_of_status_string) @@ -523,9 +514,6 @@ void ED_slider_allow_overshoot_set(struct tSlider *slider, const bool value) /** \} */ -/** - * Callback that draws a line between the mouse and a position given as the initial argument. - */ void ED_region_draw_mouse_line_cb(const bContext *C, ARegion *region, void *arg_info) { wmWindow *win = CTX_wm_window(C); @@ -776,9 +764,6 @@ static float metadata_box_height_get(ImBuf *ibuf, int fontid, const bool is_top) return 0; } -/** - * \note Keep in sync with #BKE_image_stamp_buf. - */ void ED_region_image_metadata_draw( int x, int y, ImBuf *ibuf, const rctf *frame, float zoomx, float zoomy) { diff --git a/source/blender/editors/util/ed_util.c b/source/blender/editors/util/ed_util.c index 348deec1166..8e94dc23085 100644 --- a/source/blender/editors/util/ed_util.c +++ b/source/blender/editors/util/ed_util.c @@ -195,7 +195,6 @@ void ED_editors_init(bContext *C) wm->op_undo_depth--; } -/* frees all editmode stuff */ void ED_editors_exit(Main *bmain, bool do_undo_system) { if (!bmain) { @@ -291,8 +290,6 @@ bool ED_editors_flush_edits_for_object(Main *bmain, Object *ob) return ED_editors_flush_edits_for_object_ex(bmain, ob, false, false); } -/* flush any temp data from object editing to DNA before writing files, - * rendering, copying, etc. */ bool ED_editors_flush_edits_ex(Main *bmain, bool for_render, bool check_needs_flush) { bool has_edited = false; @@ -317,11 +314,6 @@ bool ED_editors_flush_edits(Main *bmain) /* ***** XXX: functions are using old blender names, cleanup later ***** */ -/** - * Now only used in 2D spaces, like time, f-curve, NLA, image, etc. - * - * \note Shift/Control are not configurable key-bindings. - */ void apply_keyb_grid( int shift, int ctrl, float *val, float fac1, float fac2, float fac3, int invert) { @@ -441,11 +433,6 @@ void unpack_menu(bContext *C, UI_popup_menu_end(C, pup); } -/** - * Use to free ID references within runtime data (stored outside of DNA) - * - * \param new_id: may be NULL to unlink \a old_id. - */ void ED_spacedata_id_remap(struct ScrArea *area, struct SpaceLink *sl, ID *old_id, ID *new_id) { SpaceType *st = BKE_spacetype_from_id(sl->spacetype); diff --git a/source/blender/editors/util/gizmo_utils.c b/source/blender/editors/util/gizmo_utils.c index 08e7b3a9a0a..99df194f0eb 100644 --- a/source/blender/editors/util/gizmo_utils.c +++ b/source/blender/editors/util/gizmo_utils.c @@ -70,7 +70,6 @@ bool ED_gizmo_poll_or_unlink_delayed_from_tool_ex(const bContext *C, return true; } -/** Can use this as poll function directly. */ bool ED_gizmo_poll_or_unlink_delayed_from_tool(const bContext *C, wmGizmoGroupType *gzgt) { return ED_gizmo_poll_or_unlink_delayed_from_tool_ex(C, gzgt, gzgt->idname); diff --git a/source/blender/editors/util/numinput.c b/source/blender/editors/util/numinput.c index d0f27770d9b..583e4060a9a 100644 --- a/source/blender/editors/util/numinput.c +++ b/source/blender/editors/util/numinput.c @@ -98,7 +98,6 @@ void initNumInput(NumInput *n) n->str_cur = 0; } -/* str must be NUM_STR_REP_LEN * (idx_max + 1) length. */ void outputNumInput(NumInput *n, char *str, UnitSettings *unit_settings) { short j; @@ -201,9 +200,6 @@ bool hasNumInput(const NumInput *n) return false; } -/** - * \warning \a vec must be set beforehand otherwise we risk uninitialized vars. - */ bool applyNumInput(NumInput *n, float *vec) { short i, j; diff --git a/source/blender/editors/util/select_utils.c b/source/blender/editors/util/select_utils.c index 99412079adf..c7bb26db1bd 100644 --- a/source/blender/editors/util/select_utils.c +++ b/source/blender/editors/util/select_utils.c @@ -26,7 +26,6 @@ #include "ED_select_utils.h" -/** 1: select, 0: deselect, -1: pass. */ int ED_select_op_action(const eSelectOp sel_op, const bool is_select, const bool is_inside) { switch (sel_op) { @@ -44,12 +43,6 @@ int ED_select_op_action(const eSelectOp sel_op, const bool is_select, const bool BLI_assert_msg(0, "invalid sel_op"); return -1; } -/** - * Use when we've de-selected all items first (for modes that need it). - * - * \note In some cases changing selection needs to perform other checks, - * so it's more straightforward to deselect all, then select. - */ int ED_select_op_action_deselected(const eSelectOp sel_op, const bool is_select, const bool is_inside) @@ -71,9 +64,6 @@ int ED_select_op_action_deselected(const eSelectOp sel_op, return -1; } -/** - * Utility to use for selection operations that run multiple times (circle select). - */ eSelectOp ED_select_op_modal(const eSelectOp sel_op, const bool is_first) { if (sel_op == SEL_OP_SET) { -- cgit v1.2.3