diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 16:55:11 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 17:14:10 +0300 |
commit | 61776befc3f88c373e47ccbdf8c75e2ca0f4e987 (patch) | |
tree | 0214b7c5146300d41b7bcbe99f87c92599608e7f /source/blender/editors/interface/interface_utils.c | |
parent | 8f1997975dc60bc1c18992458603ecd58dfded6d (diff) |
Cleanup: move public doc-strings into headers for 'editors'
Ref T92709
Diffstat (limited to 'source/blender/editors/interface/interface_utils.c')
-rw-r--r-- | source/blender/editors/interface/interface_utils.c | 34 |
1 files changed, 0 insertions, 34 deletions
diff --git a/source/blender/editors/interface/interface_utils.c b/source/blender/editors/interface/interface_utils.c index 1a41dc8e9fb..30436c52c38 100644 --- a/source/blender/editors/interface/interface_utils.c +++ b/source/blender/editors/interface/interface_utils.c @@ -354,12 +354,6 @@ uiBut *uiDefAutoButR(uiBlock *block, return but; } -/** - * \a check_prop callback filters functions to avoid drawing certain properties, - * in cases where PROP_HIDDEN flag can't be used for a property. - * - * \param prop_activate_init: Property to activate on initial popup (#UI_BUT_ACTIVATE_ON_INIT). - */ eAutoPropButsReturn uiDefAutoButsRNA(uiLayout *layout, PointerRNA *ptr, bool (*check_prop)(PointerRNA *ptr, @@ -593,7 +587,6 @@ void ui_rna_collection_search_update_fn(const struct bContext *C, MEM_freeN(items_list); } -/***************************** ID Utilities *******************************/ int UI_icon_from_id(const ID *id) { if (id == NULL) { @@ -618,7 +611,6 @@ int UI_icon_from_id(const ID *id) return (ptr.type) ? RNA_struct_ui_icon(ptr.type) : ICON_NONE; } -/* see: report_type_str */ int UI_icon_from_report_type(int type) { if (type & RPT_ERROR_ALL) { @@ -690,10 +682,6 @@ int UI_text_colorid_from_report_type(int type) /********************************** Misc **************************************/ -/** - * Returns the best "UI" precision for given floating value, - * so that e.g. 10.000001 rather gets drawn as '10'... - */ int UI_calc_float_precision(int prec, double value) { static const double pow10_neg[UI_PRECISION_FLOAT_MAX + 1] = { @@ -839,16 +827,6 @@ static bool ui_view2d_cur_ensure_rect_in_view(View2D *v2d, const rctf *rect) return changed; } -/** - * Adjust the view so the rectangle of \a but is in view, with some extra margin. - * - * It's important that this is only executed after buttons received their final #uiBut.rect. E.g. - * #UI_panels_end() modifies them, so if that is executed, this function must not be called before - * it. - * - * \param region: The region the button is placed in. Make sure this is actually the one the button - * is placed in, not just the context region. - */ void UI_but_ensure_in_view(const bContext *C, ARegion *region, const uiBut *but) { View2D *v2d = ®ion->v2d; @@ -892,9 +870,6 @@ struct uiButStoreElem { uiBut **but_p; }; -/** - * Create a new button store, the caller must manage and run #UI_butstore_free - */ uiButStore *UI_butstore_create(uiBlock *block) { uiButStore *bs_handle = MEM_callocN(sizeof(uiButStore), __func__); @@ -966,9 +941,6 @@ void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p) BLI_assert(0); } -/** - * Update the pointer for a registered button. - */ bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *but_src) { bool found = false; @@ -985,9 +957,6 @@ bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *bu return found; } -/** - * NULL all pointers, don't free since the owner needs to be able to inspect. - */ void UI_butstore_clear(uiBlock *block) { LISTBASE_FOREACH (uiButStore *, bs_handle, &block->butstore) { @@ -998,9 +967,6 @@ void UI_butstore_clear(uiBlock *block) } } -/** - * Map freed buttons from the old block and update pointers. - */ void UI_butstore_update(uiBlock *block) { /* move this list to the new block */ |