From 2abfcebb0eb7989e3d1e7d03f37ecf5c088210af Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 10 Oct 2020 18:19:55 +1100 Subject: Cleanup: use C comments for descriptive text Follow our code style guide by using C-comments for text descriptions. --- source/blender/editors/interface/interface.c | 6 +++--- source/blender/editors/interface/interface_draw.c | 2 +- source/blender/editors/interface/interface_eyedropper_driver.c | 4 ++-- source/blender/editors/interface/interface_handlers.c | 8 ++++---- source/blender/editors/interface/interface_icons.c | 6 +++--- source/blender/editors/interface/interface_templates.c | 3 ++- source/blender/editors/interface/interface_widgets.c | 2 +- source/blender/editors/interface/view2d.c | 4 ++-- source/blender/editors/interface/view2d_ops.c | 4 ++-- 9 files changed, 20 insertions(+), 19 deletions(-) (limited to 'source/blender/editors/interface') diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c index 98e76114956..e2e19e9fcd4 100644 --- a/source/blender/editors/interface/interface.c +++ b/source/blender/editors/interface/interface.c @@ -2628,7 +2628,7 @@ static void ui_get_but_string_unit( int precision; if (unit->scale_length < 0.0001f) { - unit->scale_length = 1.0f; // XXX do_versions + unit->scale_length = 1.0f; /* XXX do_versions */ } /* Use precision override? */ @@ -3663,7 +3663,7 @@ static void ui_but_update_ex(uiBut *but, const bool validate) } /* safety is 4 to enable small number buttons (like 'users') */ - // okwidth = -4 + (BLI_rcti_size_x(&but->rect)); // UNUSED + // okwidth = -4 + (BLI_rcti_size_x(&but->rect)); /* UNUSED */ /* name: */ switch (but->type) { @@ -3805,7 +3805,7 @@ void UI_block_align_begin(uiBlock *block) block->flag |= UI_BUT_ALIGN_DOWN; block->alignnr++; - /* buttons declared after this call will get this align nr */ // XXX flag? + /* buttons declared after this call will get this align nr */ /* XXX flag? */ } void UI_block_align_end(uiBlock *block) diff --git a/source/blender/editors/interface/interface_draw.c b/source/blender/editors/interface/interface_draw.c index bcb8a10be02..dec1710ac69 100644 --- a/source/blender/editors/interface/interface_draw.c +++ b/source/blender/editors/interface/interface_draw.c @@ -783,7 +783,7 @@ void ui_draw_but_IMAGE(ARegion *UNUSED(region), GPU_blend(GPU_BLEND_NONE); # if 0 - // restore scissortest + /* restore scissortest */ GPU_scissor(scissor[0], scissor[1], scissor[2], scissor[3]); # endif diff --git a/source/blender/editors/interface/interface_eyedropper_driver.c b/source/blender/editors/interface/interface_eyedropper_driver.c index 29c0368219b..8762a4819d4 100644 --- a/source/blender/editors/interface/interface_eyedropper_driver.c +++ b/source/blender/editors/interface/interface_eyedropper_driver.c @@ -58,7 +58,7 @@ typedef struct DriverDropper { int index; bool is_undo; - // TODO: new target? + /* TODO: new target? */ } DriverDropper; static bool driverdropper_init(bContext *C, wmOperator *op) @@ -130,7 +130,7 @@ static void driverdropper_sample(bContext *C, wmOperator *op, const wmEvent *eve UI_context_update_anim_flag(C); DEG_relations_tag_update(CTX_data_main(C)); DEG_id_tag_update(ddr->ptr.owner_id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY); - WM_event_add_notifier(C, NC_ANIMATION | ND_FCURVES_ORDER, NULL); // XXX + WM_event_add_notifier(C, NC_ANIMATION | ND_FCURVES_ORDER, NULL); /* XXX */ } } diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index 8448acaaceb..2c1b6d9f9d5 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -2385,7 +2385,7 @@ static void ui_but_paste_numeric_array(bContext *C, { const int array_length = get_but_property_array_length(but); if (array_length > 4) { - // not supported for now + /* not supported for now */ return; } @@ -5747,7 +5747,7 @@ static bool ui_numedit_but_UNITVEC( } else { /* outer circle */ - mrad = rad / sqrtf(mrad); // veclen + mrad = rad / sqrtf(mrad); /* veclen */ dx *= (2.0f * mrad - 1.0f); dy *= (2.0f * mrad - 1.0f); @@ -6371,7 +6371,7 @@ static bool ui_numedit_but_HSVCIRCLE(uiBut *but, /* exception, when using color wheel in 'locked' value state: * allow choosing a hue for black values, by giving a tiny increment */ if (cpicker->use_color_lock) { - if (U.color_picker_type == USER_CP_CIRCLE_HSV) { // lock + if (U.color_picker_type == USER_CP_CIRCLE_HSV) { /* lock */ if (hsv[2] == 0.f) { hsv[2] = 0.0001f; } @@ -6474,7 +6474,7 @@ static void ui_ndofedit_but_HSVCIRCLE(uiBut *but, /* exception, when using color wheel in 'locked' value state: * allow choosing a hue for black values, by giving a tiny increment */ if (cpicker->use_color_lock) { - if (U.color_picker_type == USER_CP_CIRCLE_HSV) { // lock + if (U.color_picker_type == USER_CP_CIRCLE_HSV) { /* lock */ if (hsv[2] == 0.f) { hsv[2] = 0.0001f; } diff --git a/source/blender/editors/interface/interface_icons.c b/source/blender/editors/interface/interface_icons.c index b89f7a60ae1..fbe61a23d11 100644 --- a/source/blender/editors/interface/interface_icons.c +++ b/source/blender/editors/interface/interface_icons.c @@ -771,7 +771,7 @@ static ImBuf *create_mono_icon_with_border(ImBuf *buf, const int asy = MAX2(by - blur_size, 0); const int aey = MIN2(by + blur_size + 1, icon_height); - // blur alpha channel + /* blur alpha channel */ const int write_offset = by * (ICON_GRID_W + 2 * ICON_MONO_BORDER_OUTSET) + bx; float alpha_accum = 0.0; uint alpha_samples = 0; @@ -908,7 +908,7 @@ void UI_icons_reload_internal_textures(void) static void init_internal_icons(void) { -# if 0 // temp disabled +# if 0 /* temp disabled */ if ((btheme != NULL) && btheme->tui.iconfile[0]) { char *icondir = BKE_appdir_folder_id(BLENDER_DATAFILES, "icons"); char iconfilestr[FILE_MAX]; @@ -1299,7 +1299,7 @@ static void ui_studiolight_free_function(StudioLight *sl, void *data) return; } - // get icons_id, get icons and kill wm jobs + /* get icons_id, get icons and kill wm jobs */ if (sl->icon_id_radiance) { ui_studiolight_kill_icon_preview_job(wm, sl->icon_id_radiance); } diff --git a/source/blender/editors/interface/interface_templates.c b/source/blender/editors/interface/interface_templates.c index 6b11e727b66..89cd17319bd 100644 --- a/source/blender/editors/interface/interface_templates.c +++ b/source/blender/editors/interface/interface_templates.c @@ -98,7 +98,8 @@ #include "PIL_time.h" -// #define USE_OP_RESET_BUT // we may want to make this optional, disable for now. +/* we may want to make this optional, disable for now. */ +// #define USE_OP_RESET_BUT /* defines for templateID/TemplateSearch */ #define TEMPLATE_SEARCH_TEXTBUT_WIDTH (UI_UNIT_X * 6) diff --git a/source/blender/editors/interface/interface_widgets.c b/source/blender/editors/interface/interface_widgets.c index 3d98688dc04..68b804f5b28 100644 --- a/source/blender/editors/interface/interface_widgets.c +++ b/source/blender/editors/interface/interface_widgets.c @@ -4199,7 +4199,7 @@ static void widget_tab(uiWidgetColors *wcol, rcti *rect, int state, int roundbox /* Draw shaded outline - Disabled for now, * seems incorrect and also looks nicer without it imho ;) */ - //#define USE_TAB_SHADED_HIGHLIGHT + // #define USE_TAB_SHADED_HIGHLIGHT uiWidgetBase wtb; uchar theme_col_tab_highlight[3]; diff --git a/source/blender/editors/interface/view2d.c b/source/blender/editors/interface/view2d.c index dddd6446c0e..f115618c13b 100644 --- a/source/blender/editors/interface/view2d.c +++ b/source/blender/editors/interface/view2d.c @@ -402,7 +402,7 @@ void UI_view2d_region_reinit(View2D *v2d, short type, int winx, int winy) * Ensure View2D rects remain in a viable configuration * 'cur' is not allowed to be: larger than max, smaller than min, or outside of 'tot' */ -// XXX pre2.5 -> this used to be called test_view2d() +/* XXX pre2.5 -> this used to be called test_view2d() */ static void ui_view2d_curRect_validate_resize(View2D *v2d, bool resize) { float totwidth, totheight, curwidth, curheight, width, height; @@ -994,7 +994,7 @@ void UI_view2d_totRect_set_resize(View2D *v2d, int width, int height, bool resiz printf("Error: View2D totRect set exiting: v2d=%p width=%d height=%d\n", (void *)v2d, width, - height); // XXX temp debug info + height); /* XXX temp debug info */ } return; } diff --git a/source/blender/editors/interface/view2d_ops.c b/source/blender/editors/interface/view2d_ops.c index 38530fc4b5c..e4a7ad0d635 100644 --- a/source/blender/editors/interface/view2d_ops.c +++ b/source/blender/editors/interface/view2d_ops.c @@ -1122,7 +1122,7 @@ static void view_zoomdrag_apply(bContext *C, wmOperator *op) } /* continuous zoom shouldn't move that fast... */ - if (U.viewzoom == USER_ZOOM_CONT) { // XXX store this setting as RNA prop? + if (U.viewzoom == USER_ZOOM_CONT) { /* XXX store this setting as RNA prop? */ const double time = PIL_check_seconds_timer(); const float time_step = (float)(time - vzd->timer_lastdraw); @@ -1406,7 +1406,7 @@ static int view_zoomdrag_modal(bContext *C, wmOperator *op, const wmEvent *event * - Continuous zoom only depends on distance of mouse * to starting point to determine rate of change. */ - if (U.viewzoom != USER_ZOOM_CONT) { // XXX store this setting as RNA prop? + if (U.viewzoom != USER_ZOOM_CONT) { /* XXX store this setting as RNA prop? */ vzd->lastx = event->x; vzd->lasty = event->y; } -- cgit v1.2.3