diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-11-24 17:14:39 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-11-24 17:51:11 +0300 |
commit | 249f4423ee1c28e7f8ad6fdfff6c61a1f3e6d53d (patch) | |
tree | 41f7476be0d4d2ac9856602d1094c542d74afeef /source/blender/editors/interface | |
parent | ace5677ef0db996a4236073d1e1d6895fd5cf4bd (diff) |
Cleanup: doxygen comments
Also correct some outdated symbol references,
add missing 'name' commands.
Diffstat (limited to 'source/blender/editors/interface')
5 files changed, 22 insertions, 15 deletions
diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index 4a354dabd30..11106dd403f 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -2695,7 +2695,7 @@ void ui_but_clipboard_free(void) * It converts every UTF-8 character to an asterisk, and also remaps * the cursor position and selection start/end. * - * \note: remapping is used, because password could contain UTF-8 characters. + * \note remapping is used, because password could contain UTF-8 characters. * * \{ */ @@ -6976,8 +6976,10 @@ static bool ui_numedit_but_CURVEPROFILE(uiBlock *block, return changed; } -/** Interaction for curve profile widget. - * \note Uses hardcoded keys rather than the keymap. */ +/** + * Interaction for curve profile widget. + * \note Uses hardcoded keys rather than the keymap. + */ static int ui_do_but_CURVEPROFILE( bContext *C, uiBlock *block, uiBut *but, uiHandleButtonData *data, const wmEvent *event) { diff --git a/source/blender/editors/interface/interface_ops.c b/source/blender/editors/interface/interface_ops.c index 7ce4242c697..8af82864b03 100644 --- a/source/blender/editors/interface/interface_ops.c +++ b/source/blender/editors/interface/interface_ops.c @@ -852,10 +852,10 @@ bool UI_context_copy_to_selected_list(bContext *C, } /** - * called from both exec & poll + * Called from both exec & poll. * - * \note: normally we wouldn't call a loop from within a poll function, - * However this is a special case, and for regular poll calls, getting + * \note Normally we wouldn't call a loop from within a poll function, + * however this is a special case, and for regular poll calls, getting * the context from the button will fail early. */ static bool copy_to_selected_button(bContext *C, bool all, bool poll) @@ -1323,8 +1323,9 @@ static void UI_OT_editsource(wmOperatorType *ot) /** * EditTranslation utility funcs and operator, - * \note: this includes utility functions and button matching checks. - * this only works in conjunction with a py operator! + * + * \note this includes utility functions and button matching checks. + * this only works in conjunction with a Python operator! */ static void edittranslation_find_po_file(const char *root, const char *uilng, diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c index b205572ba06..f5c5ef5f5e2 100644 --- a/source/blender/editors/interface/interface_templates.c +++ b/source/blender/editors/interface/interface_templates.c @@ -5068,8 +5068,10 @@ static void CurveProfile_buttons_layout(uiLayout *layout, PointerRNA *ptr, RNAUp UI_block_funcN_set(block, NULL, NULL, NULL); } -/** Template for a path creation widget intended for custom bevel profiles. - * This section is quite similar to uiTemplateCurveMapping, but with reduced complexity */ +/** + * Template for a path creation widget intended for custom bevel profiles. + * This section is quite similar to #uiTemplateCurveMapping, but with reduced complexity. + */ void uiTemplateCurveProfile(uiLayout *layout, PointerRNA *ptr, const char *propname) { RNAUpdateCb *cb; diff --git a/source/blender/editors/interface/interface_widgets.c b/source/blender/editors/interface/interface_widgets.c index 7f7352517c8..f9e4248fde3 100644 --- a/source/blender/editors/interface/interface_widgets.c +++ b/source/blender/editors/interface/interface_widgets.c @@ -249,8 +249,9 @@ typedef struct uiWidgetBase { uiWidgetBaseParameters uniform_params; } uiWidgetBase; -/** uiWidgetType: for time being only for visual appearance, - * later, a handling callback can be added too +/** + * For time being only for visual appearance, + * later, a handling callback can be added too. */ typedef struct uiWidgetType { diff --git a/source/blender/editors/interface/resources.c b/source/blender/editors/interface/resources.c index a405069efd8..a4dd0cb5c9f 100644 --- a/source/blender/editors/interface/resources.c +++ b/source/blender/editors/interface/resources.c @@ -971,9 +971,10 @@ const uchar *UI_ThemeGetColorPtr(bTheme *btheme, int spacetype, int colorid) } /** - * initialize default theme - * \note: when you add new colors, created & saved themes need initialized - * use function below, init_userdef_do_versions() + * Initialize default theme. + * + * \note When you add new colors, created & saved themes need initialized + * use function below, #init_userdef_do_versions. */ void UI_theme_init_default(void) { |