From 6089a96be2993d0808018cdf209db3691a1f2d0f Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 4 Aug 2022 07:54:29 +1000 Subject: Cleanup: spelling, code-blocks --- source/blender/blenkernel/BKE_image.h | 2 +- source/blender/blenkernel/BKE_lib_override.h | 2 +- source/blender/blenkernel/intern/image.cc | 24 +++--- source/blender/blenloader/intern/versioning_290.c | 2 +- source/blender/depsgraph/intern/depsgraph_tag.cc | 2 +- .../engines/eevee_next/eevee_depth_of_field.hh | 4 +- .../blender/draw/engines/eevee_next/eevee_film.hh | 2 +- .../shaders/infos/eevee_depth_of_field_info.hh | 2 +- source/blender/draw/intern/DRW_render.h | 2 +- .../blender/editors/interface/interface_panel.cc | 4 +- .../editors/interface/interface_region_search.cc | 8 +- .../editors/interface/interface_region_tooltip.cc | 93 +++++++++++----------- .../editors/space_sequencer/sequencer_draw.c | 4 +- .../gpencil_modifiers/intern/lineart/MOD_lineart.h | 5 +- source/blender/gpu/intern/gpu_buffers.c | 4 +- source/blender/makesdna/DNA_ID.h | 2 +- source/blender/makesrna/intern/rna_path.cc | 4 +- 17 files changed, 81 insertions(+), 85 deletions(-) (limited to 'source') diff --git a/source/blender/blenkernel/BKE_image.h b/source/blender/blenkernel/BKE_image.h index e3c249e56f9..8512992282f 100644 --- a/source/blender/blenkernel/BKE_image.h +++ b/source/blender/blenkernel/BKE_image.h @@ -423,7 +423,7 @@ int BKE_image_get_tile_from_pos(struct Image *ima, void BKE_image_get_tile_uv(const struct Image *ima, const int tile_number, float r_uv[2]); /** - * Return the tile_number for the closest UDIM tile. + * Return the tile_number for the closest UDIM tile to `co`. */ int BKE_image_find_nearest_tile_with_offset(const struct Image *image, const float co[2], diff --git a/source/blender/blenkernel/BKE_lib_override.h b/source/blender/blenkernel/BKE_lib_override.h index 9ad5a32e6f0..f933946164c 100644 --- a/source/blender/blenkernel/BKE_lib_override.h +++ b/source/blender/blenkernel/BKE_lib_override.h @@ -60,7 +60,7 @@ void BKE_lib_override_library_clear(struct IDOverrideLibrary *override, bool do_ void BKE_lib_override_library_free(struct IDOverrideLibrary **override, bool do_id_user); /** - * Return the actual #IDOverrideLibrary data 'controlling' the given `id`, and the acutal ID owning + * Return the actual #IDOverrideLibrary data 'controlling' the given `id`, and the actual ID owning * it. * * \note This is especially useful when `id` is a non-real override (e.g. embedded ID like a master diff --git a/source/blender/blenkernel/intern/image.cc b/source/blender/blenkernel/intern/image.cc index 8af696b0088..4ce413d3705 100644 --- a/source/blender/blenkernel/intern/image.cc +++ b/source/blender/blenkernel/intern/image.cc @@ -863,17 +863,17 @@ void BKE_image_get_tile_uv(const Image *ima, const int tile_number, float r_uv[2 } } -/* Linear distance between #x and the unit interval. */ +/** Linear distance between #x and the unit interval. */ static float distance_to_unit_interval(float x) { /* The unit interval is between 0 and 1. - Within the interval, return 0. - Outside the interval, return the distance to the nearest boundary. - Intuitively, the function looks like: - \ | | / - __\|___|/__ - 0 1 - */ + * Within the interval, return 0. + * Outside the interval, return the distance to the nearest boundary. + * Intuitively, the function looks like: + * \ | | / + * __\|___|/__ + * 0 1 + */ if (x <= 0.0f) { return -x; /* Distance to left border. */ @@ -884,7 +884,7 @@ static float distance_to_unit_interval(float x) return x - 1.0f; /* Distance to right border. */ } -/* Distance squared between #co and the unit square with lower-left starting at #udim. */ +/** Distance squared between #co and the unit square with lower-left starting at #udim. */ static float distance_squared_to_udim(const float co[2], const float udim[2]) { float delta[2]; @@ -908,12 +908,12 @@ static bool nearest_udim_tile_tie_break(const float best_dist_sq, return (dist_sq < best_dist_sq); /* Closer than previous candidate? */ } -/* Finds the nearest tile and offset to #co. - * If the co-ordinates are integers, take special care to break ties. */ int BKE_image_find_nearest_tile_with_offset(const Image *image, const float co[2], float r_uv_offset[2]) { + /* NOTE: If the co-ordinates are integers, take special care to break ties. */ + zero_v2(r_uv_offset); int tile_number_best = -1; @@ -962,7 +962,7 @@ static void image_init_color_management(Image *ima) BKE_image_user_file_path(nullptr, ima, name); - /* will set input color space to image format default's */ + /* Will set input color space to image format default's. */ ibuf = IMB_loadiffname(name, IB_test | IB_alphamode_detect, ima->colorspace_settings.name); if (ibuf) { diff --git a/source/blender/blenloader/intern/versioning_290.c b/source/blender/blenloader/intern/versioning_290.c index 9ab744337a8..ff72bfe95b8 100644 --- a/source/blender/blenloader/intern/versioning_290.c +++ b/source/blender/blenloader/intern/versioning_290.c @@ -1697,7 +1697,7 @@ void blo_do_versions_290(FileData *fd, Library *UNUSED(lib), Main *bmain) } } - /* Add subpanels for FModifiers, which requires a field to store expansion. */ + /* Add sub-panels for FModifiers, which requires a field to store expansion. */ if (!DNA_struct_elem_find(fd->filesdna, "FModifier", "short", "ui_expand_flag")) { LISTBASE_FOREACH (bAction *, act, &bmain->actions) { LISTBASE_FOREACH (FCurve *, fcu, &act->curves) { diff --git a/source/blender/depsgraph/intern/depsgraph_tag.cc b/source/blender/depsgraph/intern/depsgraph_tag.cc index c508bee3218..cc742b98866 100644 --- a/source/blender/depsgraph/intern/depsgraph_tag.cc +++ b/source/blender/depsgraph/intern/depsgraph_tag.cc @@ -228,7 +228,7 @@ void depsgraph_tag_to_component_opcode(const ID *id, case ID_RECALC_PROVISION_30: case ID_RECALC_PROVISION_31: /* Silently ignore. - * The bits might be passed here from ID_RECALC_ALL. This is not a codmistake, but just the + * The bits might be passed here from ID_RECALC_ALL. This is not a code-mistake, but just the * way how the recalc flags are handled. */ break; } diff --git a/source/blender/draw/engines/eevee_next/eevee_depth_of_field.hh b/source/blender/draw/engines/eevee_next/eevee_depth_of_field.hh index 12d9e7ebd9f..8d62e0c0784 100644 --- a/source/blender/draw/engines/eevee_next/eevee_depth_of_field.hh +++ b/source/blender/draw/engines/eevee_next/eevee_depth_of_field.hh @@ -122,7 +122,7 @@ class DepthOfField { /** Scene settings that are immutable. */ float user_overblur_; float fx_max_coc_; - /** Use Hiqh Quality (expensive) in-focus gather pass. */ + /** Use High Quality (expensive) in-focus gather pass. */ bool do_hq_slight_focus_; /** Use jittered depth of field where we randomize camera location. */ bool do_jitter_; @@ -180,4 +180,4 @@ class DepthOfField { /** \} */ -} // namespace blender::eevee \ No newline at end of file +} // namespace blender::eevee diff --git a/source/blender/draw/engines/eevee_next/eevee_film.hh b/source/blender/draw/engines/eevee_next/eevee_film.hh index e1ace9a40a8..3e368782d31 100644 --- a/source/blender/draw/engines/eevee_next/eevee_film.hh +++ b/source/blender/draw/engines/eevee_next/eevee_film.hh @@ -40,7 +40,7 @@ class Film { private: Instance &inst_; - /** Incoming combined buffer with post fx applied (motion blur + depth of field). */ + /** Incoming combined buffer with post FX applied (motion blur + depth of field). */ GPUTexture *combined_final_tx_ = nullptr; /** Main accumulation textures containing every render-pass except depth and combined. */ diff --git a/source/blender/draw/engines/eevee_next/shaders/infos/eevee_depth_of_field_info.hh b/source/blender/draw/engines/eevee_next/shaders/infos/eevee_depth_of_field_info.hh index 42a8c78a51d..75436940ef2 100644 --- a/source/blender/draw/engines/eevee_next/shaders/infos/eevee_depth_of_field_info.hh +++ b/source/blender/draw/engines/eevee_next/shaders/infos/eevee_depth_of_field_info.hh @@ -117,7 +117,7 @@ GPU_SHADER_CREATE_INFO(eevee_depth_of_field_no_lut) .define("DOF_BOKEH_TEXTURE", "false") /** * WORKAROUND(@fclem): This is to keep the code as is for now. The bokeh_lut_tx is referenced - * even if not used after optimisation. But we don't want to include it in the create infos. + * even if not used after optimization. But we don't want to include it in the create infos. */ .define("bokeh_lut_tx", "color_tx"); diff --git a/source/blender/draw/intern/DRW_render.h b/source/blender/draw/intern/DRW_render.h index 2b2288f23cd..a3097251d35 100644 --- a/source/blender/draw/intern/DRW_render.h +++ b/source/blender/draw/intern/DRW_render.h @@ -795,7 +795,7 @@ bool DRW_culling_box_test(const DRWView *view, const BoundBox *bbox); bool DRW_culling_plane_test(const DRWView *view, const float plane[4]); /** * Return True if the given box intersect the current view frustum. - * This function will have to be replaced when world space bb per objects is implemented. + * This function will have to be replaced when world space bounding-box per objects is implemented. */ bool DRW_culling_min_max_test(const DRWView *view, float obmat[4][4], float min[3], float max[3]); diff --git a/source/blender/editors/interface/interface_panel.cc b/source/blender/editors/interface/interface_panel.cc index 9199e6d052d..dc6a0fecb73 100644 --- a/source/blender/editors/interface/interface_panel.cc +++ b/source/blender/editors/interface/interface_panel.cc @@ -1090,7 +1090,7 @@ static void panel_draw_aligned_widgets(const uiStyle *style, const int header_height = BLI_rcti_size_y(header_rect); const int scaled_unit = round_fl_to_int(UI_UNIT_X / aspect); - /* Offset triangle and text to the right for subpanels. */ + /* Offset triangle and text to the right for sub-panels. */ rcti widget_rect; widget_rect.xmin = header_rect->xmin + (is_subpanel ? scaled_unit * 0.7f : 0); widget_rect.xmax = header_rect->xmax; @@ -2092,7 +2092,7 @@ static void ui_handle_panel_header(const bContext *C, ui_panel_drag_collapse_handler_add(C, UI_panel_is_closed(panel)); } - /* Set panel custom data (modifier) active when expanding subpanels, but not top-level + /* Set panel custom data (modifier) active when expanding sub-panels, but not top-level * panels to allow collapsing and expanding without setting the active element. */ if (is_subpanel) { panel_custom_data_active_set(panel); diff --git a/source/blender/editors/interface/interface_region_search.cc b/source/blender/editors/interface/interface_region_search.cc index f04229609f9..6bb47666afd 100644 --- a/source/blender/editors/interface/interface_region_search.cc +++ b/source/blender/editors/interface/interface_region_search.cc @@ -710,18 +710,18 @@ static ARegion *ui_searchbox_create_generic_ex(bContext *C, type.regionid = RGN_TYPE_TEMPORARY; region->type = &type; - /* create searchbox data */ + /* Create search-box data. */ uiSearchboxData *data = MEM_cnew(__func__); - /* set font, get bb */ + /* Set font, get the bounding-box. */ data->fstyle = style->widget; /* copy struct */ ui_fontscale(&data->fstyle.points, aspect); UI_fontstyle_set(&data->fstyle); region->regiondata = data; - /* special case, hardcoded feature, not draw backdrop when called from menus, - * assume for design that popup already added it */ + /* Special case, hard-coded feature, not draw backdrop when called from menus, + * assume for design that popup already added it. */ if (but->block->flag & UI_BLOCK_SEARCH_MENU) { data->noback = true; } diff --git a/source/blender/editors/interface/interface_region_tooltip.cc b/source/blender/editors/interface/interface_region_tooltip.cc index e18d23c8a1c..6a39b761983 100644 --- a/source/blender/editors/interface/interface_region_tooltip.cc +++ b/source/blender/editors/interface/interface_region_tooltip.cc @@ -90,8 +90,10 @@ struct uiTooltipField { char *text; char *text_suffix; struct { - uint x_pos; /* x cursor position at the end of the last line */ - uint lines; /* number of lines, 1 or more with word-wrap */ + /** X cursor position at the end of the last line. */ + uint x_pos; + /** Number of lines, 1 or more with word-wrap. */ + uint lines; } geom; uiTooltipFormat format; }; @@ -165,7 +167,7 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region float tip_colors[UI_TIP_LC_MAX][3]; uchar drawcol[4] = {0, 0, 0, 255}; /* to store color in while drawing (alpha is always 255) */ - /* the color from the theme */ + /* The color from the theme. */ float *main_color = tip_colors[static_cast(uiTooltipFormat::ColorID::Main)]; float *value_color = tip_colors[static_cast(uiTooltipFormat::ColorID::Value)]; float *active_color = tip_colors[static_cast(uiTooltipFormat::ColorID::Active)]; @@ -177,13 +179,13 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region wmOrtho2_region_pixelspace(region); - /* draw background */ + /* Draw background. */ ui_draw_tooltip_background(UI_style_get(), nullptr, &bbox); /* set background_color */ rgb_uchar_to_float(background_color, theme->inner); - /* calculate normal_color */ + /* Calculate `normal_color`. */ rgb_uchar_to_float(main_color, theme->text); copy_v3_v3(active_color, main_color); copy_v3_v3(normal_color, main_color); @@ -191,19 +193,19 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region copy_v3_v3(alert_color, main_color); copy_v3_v3(value_color, main_color); - /* find the brightness difference between background and text colors */ + /* Find the brightness difference between background and text colors. */ const float tone_bg = rgb_to_grayscale(background_color); - /* tone_fg = rgb_to_grayscale(main_color); */ + // tone_fg = rgb_to_grayscale(main_color); - /* mix the colors */ + /* Mix the colors. */ rgb_tint(value_color, 0.0f, 0.0f, tone_bg, 0.2f); /* Light gray. */ rgb_tint(active_color, 0.6f, 0.2f, tone_bg, 0.2f); /* Light blue. */ rgb_tint(normal_color, 0.0f, 0.0f, tone_bg, 0.4f); /* Gray. */ rgb_tint(python_color, 0.0f, 0.0f, tone_bg, 0.5f); /* Dark gray. */ rgb_tint(alert_color, 0.0f, 0.8f, tone_bg, 0.1f); /* Red. */ - /* draw text */ + /* Draw text. */ BLF_wordwrap(data->fstyle.uifont_id, data->wrap_width); BLF_wordwrap(blf_mono_font, data->wrap_width); @@ -221,12 +223,12 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region fs_params.align = UI_STYLE_TEXT_LEFT; fs_params.word_wrap = true; - /* draw header and active data (is done here to be able to change color) */ + /* Draw header and active data (is done here to be able to change color). */ rgb_float_to_uchar(drawcol, tip_colors[static_cast(uiTooltipFormat::ColorID::Main)]); UI_fontstyle_set(&data->fstyle); UI_fontstyle_draw(&data->fstyle, &bbox, field->text, UI_TIP_STR_MAX, drawcol, &fs_params); - /* offset to the end of the last line */ + /* Offset to the end of the last line. */ if (field->text_suffix) { const float xofs = field->geom.x_pos; const float yofs = data->lineh * (field->geom.lines - 1); @@ -238,7 +240,7 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region UI_fontstyle_draw( &data->fstyle, &bbox, field->text_suffix, UI_TIP_STR_MAX, drawcol, &fs_params); - /* undo offset */ + /* Undo offset. */ bbox.xmin -= xofs; bbox.ymax += yofs; } @@ -251,7 +253,7 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region fstyle_mono.uifont_id = blf_mono_font; UI_fontstyle_set(&fstyle_mono); - /* XXX, needed because we don't have mono in 'U.uifonts' */ + /* XXX: needed because we don't have mono in 'U.uifonts'. */ BLF_size(fstyle_mono.uifont_id, fstyle_mono.points * U.pixelsize, U.dpi); rgb_float_to_uchar(drawcol, tip_colors[static_cast(field->format.color_id)]); UI_fontstyle_draw(&fstyle_mono, &bbox, field->text, UI_TIP_STR_MAX, drawcol, &fs_params); @@ -262,7 +264,7 @@ static void ui_tooltip_region_draw_cb(const bContext *UNUSED(C), ARegion *region fs_params.align = UI_STYLE_TEXT_LEFT; fs_params.word_wrap = true; - /* draw remaining data */ + /* Draw remaining data. */ rgb_float_to_uchar(drawcol, tip_colors[static_cast(field->format.color_id)]); UI_fontstyle_set(&data->fstyle); UI_fontstyle_draw(&data->fstyle, &bbox, field->text, UI_TIP_STR_MAX, drawcol, &fs_params); @@ -327,13 +329,13 @@ static bool ui_tooltip_data_append_from_keymap(bContext *C, uiTooltipData *data, LISTBASE_FOREACH (wmKeyMapItem *, kmi, &keymap->items) { wmOperatorType *ot = WM_operatortype_find(kmi->idname, true); if (ot != nullptr) { - /* Tip */ + /* Tip. */ { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Normal, uiTooltipFormat::ColorID::Main, true); field->text = BLI_strdup(ot->description ? ot->description : ot->name); } - /* Shortcut */ + /* Shortcut. */ { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Normal, uiTooltipFormat::ColorID::Normal); @@ -344,7 +346,7 @@ static bool ui_tooltip_data_append_from_keymap(bContext *C, uiTooltipData *data, field->text = BLI_sprintfN(TIP_("Shortcut: %s"), found ? buf : "None"); } - /* Python */ + /* Python. */ if (U.flag & USER_TOOLTIPS_PYTHON) { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Normal, uiTooltipFormat::ColorID::Python); @@ -408,9 +410,8 @@ static uiTooltipData *ui_tooltip_data_from_tool(bContext *C, uiBut *but, bool is uiTooltipData *data = MEM_cnew(__func__); #ifdef WITH_PYTHON - /* it turns out to be most simple to do this via Python since C - * doesn't have access to information about non-active tools. - */ + /* It turns out to be most simple to do this via Python since C + * doesn't have access to information about non-active tools. */ /* Title (when icon-only). */ if (but->drawstr[0] == '\0') { @@ -781,8 +782,8 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, /* Tip Label (only for buttons not already showing the label). * Check prefix instead of comparing because the button may include the shortcut. - * Buttons with dynamic tooltips also don't get their default label here since they - * can already provide more accurate and specific tooltip content. */ + * Buttons with dynamic tool-tips also don't get their default label here since they + * can already provide more accurate and specific tool-tip content. */ if (but_label.strinfo && !STRPREFIX(but->drawstr, but_label.strinfo) && !but->tip_func) { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Header, uiTooltipFormat::ColorID::Normal); @@ -811,21 +812,21 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, field->text = BLI_strdup(TIP_("(Shift-Click/Drag to select multiple)")); } } - /* Enum field label & tip */ + /* Enum field label & tip. */ if (enum_tip.strinfo) { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Normal, uiTooltipFormat::ColorID::Value); field->text = BLI_strdup(enum_tip.strinfo); } - /* Op shortcut */ + /* Operator shortcut. */ if (op_keymap.strinfo) { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Normal, uiTooltipFormat::ColorID::Value, true); field->text = BLI_sprintfN(TIP_("Shortcut: %s"), op_keymap.strinfo); } - /* Property context-toggle shortcut */ + /* Property context-toggle shortcut. */ if (prop_keymap.strinfo) { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Normal, uiTooltipFormat::ColorID::Value, true); @@ -833,9 +834,9 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, } if (ELEM(but->type, UI_BTYPE_TEXT, UI_BTYPE_SEARCH_MENU)) { - /* better not show the value of a password */ + /* Better not show the value of a password. */ if ((rnaprop && (RNA_property_subtype(rnaprop) == PROP_PASSWORD)) == 0) { - /* full string */ + /* Full string. */ ui_but_string_get(but, buf, sizeof(buf)); if (buf[0]) { uiTooltipField *field = text_field_add( @@ -879,15 +880,15 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, } else if (optype) { PointerRNA *opptr = extra_icon ? UI_but_extra_operator_icon_opptr_get(extra_icon) : - /* allocated when needed, the button owns it */ + /* Allocated when needed, the button owns it. */ UI_but_operator_ptr_get(but); - /* so the context is passed to fieldf functions (some py fieldf functions use it) */ + /* So the context is passed to field functions (some Python field functions use it). */ WM_operator_properties_sanitize(opptr, false); char *str = ui_tooltip_text_python_from_op(C, optype, opptr); - /* operator info */ + /* Operator info. */ if (U.flag & USER_TOOLTIPS_PYTHON) { uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Mono, uiTooltipFormat::ColorID::Python, true); @@ -897,12 +898,12 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, MEM_freeN(str); } - /* button is disabled, we may be able to tell user why */ + /* Button is disabled, we may be able to tell user why. */ if ((but->flag & UI_BUT_DISABLED) || extra_icon) { const char *disabled_msg = nullptr; bool disabled_msg_free = false; - /* if operator poll check failed, it can give pretty precise info why */ + /* If operator poll check failed, it can give pretty precise info why. */ if (optype) { const wmOperatorCallContext opcontext = extra_icon ? extra_icon->optype_params->opcontext : but->opcontext; @@ -913,7 +914,7 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, ui_but_context_poll_operator_ex(C, but, &call_params); disabled_msg = CTX_wm_operator_poll_msg_get(C, &disabled_msg_free); } - /* alternatively, buttons can store some reasoning too */ + /* Alternatively, buttons can store some reasoning too. */ else if (!extra_icon && but->disabled_info) { disabled_msg = TIP_(but->disabled_info); } @@ -937,7 +938,7 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, field->text = BLI_sprintfN(TIP_("Python: %s.%s"), rna_struct.strinfo, rna_prop.strinfo); } else { - /* Only struct (e.g. menus) */ + /* Only struct (e.g. menus). */ field->text = BLI_sprintfN(TIP_("Python: %s"), rna_struct.strinfo); } } @@ -946,7 +947,7 @@ static uiTooltipData *ui_tooltip_data_from_button_or_extra_icon(bContext *C, uiTooltipField *field = text_field_add( data, uiTooltipFormat::Style::Mono, uiTooltipFormat::ColorID::Python); - /* this could get its own 'BUT_GET_...' type */ + /* This could get its own `BUT_GET_...` type. */ /* never fails */ /* Move ownership (no need for re-allocation). */ @@ -997,7 +998,7 @@ static uiTooltipData *ui_tooltip_data_from_gizmo(bContext *C, wmGizmo *gz) { uiTooltipData *data = MEM_cnew(__func__); - /* TODO(campbell): a way for gizmos to have their own descriptions (low priority). */ + /* TODO(@campbellbarton): a way for gizmos to have their own descriptions (low priority). */ /* Operator Actions */ { @@ -1059,7 +1060,7 @@ static uiTooltipData *ui_tooltip_data_from_gizmo(bContext *C, wmGizmo *gz) if (gz->type->target_property_defs_len) { wmGizmoProperty *gz_prop_array = WM_gizmo_target_property_array(gz); for (int i = 0; i < gz->type->target_property_defs_len; i++) { - /* TODO(campbell): function callback descriptions. */ + /* TODO(@campbellbarton): function callback descriptions. */ wmGizmoProperty *gz_prop = &gz_prop_array[i]; if (gz_prop->prop != nullptr) { const char *info = RNA_property_ui_description(gz_prop->prop); @@ -1093,7 +1094,7 @@ static ARegion *ui_tooltip_create_with_data(bContext *C, rcti rect_i; int font_flag = 0; - /* create area region */ + /* Create area region. */ ARegion *region = ui_region_temp_add(CTX_wm_screen(C)); static ARegionType type; @@ -1103,7 +1104,7 @@ static ARegion *ui_tooltip_create_with_data(bContext *C, type.regionid = RGN_TYPE_TEMPORARY; region->type = &type; - /* set font, get bb */ + /* Set font, get bounding-box. */ data->fstyle = style->widget; /* copy struct */ ui_fontscale(&data->fstyle.points, aspect); @@ -1117,7 +1118,7 @@ static ARegion *ui_tooltip_create_with_data(bContext *C, BLF_wordwrap(data->fstyle.uifont_id, data->wrap_width); BLF_wordwrap(blf_mono_font, data->wrap_width); - /* these defines tweaked depending on font */ + /* These defines tweaked depending on font. */ #define TIP_BORDER_X (16.0f / aspect) #define TIP_BORDER_Y (6.0f / aspect) @@ -1186,8 +1187,8 @@ static ARegion *ui_tooltip_create_with_data(bContext *C, /* Clamp to window bounds. */ { - /* Ensure at least 5 px above screen bounds - * UI_UNIT_Y is just a guess to be above the menu item */ + /* Ensure at least 5 px above screen bounds. + * #UI_UNIT_Y is just a guess to be above the menu item. */ if (init_rect_overlap != nullptr) { const int pad = max_ff(1.0f, U.pixelsize) * 5; rcti init_rect; @@ -1333,7 +1334,7 @@ ARegion *UI_tooltip_create_from_button_or_extra_icon( bContext *C, ARegion *butregion, uiBut *but, uiButExtraOpIcon *extra_icon, bool is_label) { wmWindow *win = CTX_wm_window(C); - /* aspect values that shrink text are likely unreadable */ + /* Aspect values that shrink text are likely unreadable. */ const float aspect = min_ff(1.0f, but->block->aspect); float init_position[2]; @@ -1406,10 +1407,8 @@ ARegion *UI_tooltip_create_from_gizmo(bContext *C, wmGizmo *gz) return nullptr; } - /* TODO(harley): - * Julian preferred that the gizmo callback return the 3D bounding box - * which we then project to 2D here. Would make a nice improvement. - */ + /* TODO(@harley): Julian preferred that the gizmo callback return the 3D bounding box + * which we then project to 2D here. Would make a nice improvement. */ if (gz->type->screen_bounds_get) { rcti bounds; if (gz->type->screen_bounds_get(C, gz, &bounds)) { diff --git a/source/blender/editors/space_sequencer/sequencer_draw.c b/source/blender/editors/space_sequencer/sequencer_draw.c index eb2e4ef05e5..0bacbde8240 100644 --- a/source/blender/editors/space_sequencer/sequencer_draw.c +++ b/source/blender/editors/space_sequencer/sequencer_draw.c @@ -519,7 +519,7 @@ static void draw_seq_waveform_overlay( MEM_freeN(waveform_data); } -/* +#if 0 static size_t *waveform_append(WaveVizData *waveform_data, vec2f pos, const float value_min, @@ -529,7 +529,7 @@ static size_t *waveform_append(WaveVizData *waveform_data, const float rms, const bool is_clipping, const bool is_line_strip) -*/ +#endif static void drawmeta_contents(Scene *scene, Sequence *seqm, diff --git a/source/blender/gpencil_modifiers/intern/lineart/MOD_lineart.h b/source/blender/gpencil_modifiers/intern/lineart/MOD_lineart.h index 5dd833fb12b..01d1e95efb3 100644 --- a/source/blender/gpencil_modifiers/intern/lineart/MOD_lineart.h +++ b/source/blender/gpencil_modifiers/intern/lineart/MOD_lineart.h @@ -366,8 +366,9 @@ typedef struct LineartData { /* Keep an copy of these data so when line art is running it's self-contained. */ bool cam_is_persp; - bool cam_is_persp_secondary; /* "Secondary" ones are from viewing camera (as opposed to shadow - camera), during shadow calculation. */ + /* "Secondary" ones are from viewing camera + * (as opposed to shadow camera), during shadow calculation. */ + bool cam_is_persp_secondary; float cam_obmat[4][4]; float cam_obmat_secondary[4][4]; double camera_pos[3]; diff --git a/source/blender/gpu/intern/gpu_buffers.c b/source/blender/gpu/intern/gpu_buffers.c index 9e8e75be23b..2a0f624ac45 100644 --- a/source/blender/gpu/intern/gpu_buffers.c +++ b/source/blender/gpu/intern/gpu_buffers.c @@ -1243,9 +1243,7 @@ static int gpu_pbvh_make_attr_offs(eAttrDomainMask domain_mask, } } - /* ensure render layer is last - draw cache code seems to need this - */ + /* Ensure render layer is last, draw cache code seems to need this. */ for (int i = 0; i < count; i++) { GPUAttrRef *ref = r_cd_attrs + i; diff --git a/source/blender/makesdna/DNA_ID.h b/source/blender/makesdna/DNA_ID.h index 0dc7d75e744..7cecead8230 100644 --- a/source/blender/makesdna/DNA_ID.h +++ b/source/blender/makesdna/DNA_ID.h @@ -873,7 +873,7 @@ typedef enum IDRecalcFlag { /* Provisioned flags. * * Not for actual use. The idea of them is to have all bits of the `IDRecalcFlag` defined to a - * known value, silencing sanitizer warnings when checkign bits of the ID_RECALC_ALL. */ + * known value, silencing sanitizer warnings when checking bits of the ID_RECALC_ALL. */ ID_RECALC_PROVISION_26 = (1 << 26), ID_RECALC_PROVISION_27 = (1 << 27), ID_RECALC_PROVISION_28 = (1 << 28), diff --git a/source/blender/makesrna/intern/rna_path.cc b/source/blender/makesrna/intern/rna_path.cc index fe1f4c0101f..22bd607b027 100644 --- a/source/blender/makesrna/intern/rna_path.cc +++ b/source/blender/makesrna/intern/rna_path.cc @@ -380,9 +380,7 @@ static bool rna_path_parse(const PointerRNA *ptr, } const bool use_id_prop = (*path == '['); - /* custom property lookup ? - * C.object["someprop"] - */ + /* Custom property lookup: e.g. `C.object["someprop"]`. */ if (!curptr.data) { return false; -- cgit v1.2.3