From d616c87d037ec3c76ab273d46b828b99ed609319 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 21 Mar 2025 00:51:50 +0000 Subject: [PATCH] Cleanup: spelling in comments (make check_spelling_*) --- build_files/utils/make_bpy_wheel.py | 6 +++--- intern/cycles/blender/mesh.cpp | 2 +- intern/cycles/kernel/light/background.h | 2 +- intern/cycles/session/buffers.cpp | 2 +- source/blender/blenkernel/BKE_ipo.h | 2 +- source/blender/blenkernel/BKE_lib_query.hh | 2 +- source/blender/blenkernel/BKE_mesh.hh | 2 +- source/blender/blenkernel/intern/tracking.cc | 2 +- source/blender/blenlib/intern/math_rotation_c.cc | 2 +- source/blender/blenlib/tests/BLI_array_store_test.cc | 2 +- source/blender/blenloader/intern/readfile.cc | 2 +- source/blender/blenloader/intern/versioning_280.cc | 4 ++-- source/blender/draw/intern/draw_context.cc | 2 +- source/blender/draw/intern/draw_view_data.hh | 8 ++++---- source/blender/editors/animation/anim_channels_edit.cc | 8 ++++---- source/blender/editors/animation/anim_deps.cc | 2 +- source/blender/editors/animation/anim_draw.cc | 4 ++-- source/blender/editors/animation/keyframes_draw.cc | 2 +- source/blender/editors/animation/keyframes_edit.cc | 2 +- source/blender/editors/armature/armature_naming.cc | 2 +- .../blender/editors/gpencil_legacy/editaction_gpencil.cc | 4 ++-- .../editors/grease_pencil/intern/grease_pencil_frames.cc | 4 ++-- source/blender/editors/include/ED_anim_api.hh | 4 ++-- source/blender/editors/include/ED_keyframes_edit.hh | 4 ++-- source/blender/editors/interface/interface_icons.cc | 7 ++++--- source/blender/editors/screen/screen_context.cc | 2 +- source/blender/editors/space_action/action_draw.cc | 2 +- source/blender/editors/space_action/action_edit.cc | 2 +- source/blender/editors/space_action/action_select.cc | 4 ++-- source/blender/editors/space_action/space_action.cc | 7 +++---- source/blender/editors/space_graph/graph_utils.cc | 2 +- source/blender/editors/space_graph/graph_view.cc | 2 +- source/blender/editors/space_graph/space_graph.cc | 6 +++--- source/blender/editors/space_nla/nla_draw.cc | 2 +- source/blender/editors/space_nla/space_nla.cc | 7 +++---- source/blender/editors/transform/transform_generics.cc | 4 ++-- source/blender/editors/undo/ed_undo.cc | 2 +- source/blender/gpu/intern/gpu_select_pick.cc | 2 +- source/blender/gpu/metal/mtl_index_buffer.mm | 2 +- source/blender/makesdna/DNA_action_types.h | 6 +++--- source/blender/makesdna/DNA_grease_pencil_types.h | 2 +- source/blender/makesdna/DNA_object_fluidsim_types.h | 2 +- source/blender/makesdna/DNA_tracking_types.h | 4 ++-- source/blender/makesdna/DNA_userdef_types.h | 4 ++-- source/blender/makesrna/intern/rna_armature.cc | 2 +- source/blender/makesrna/intern/rna_space.cc | 2 +- source/blender/windowmanager/intern/wm_window.cc | 2 +- 47 files changed, 76 insertions(+), 77 deletions(-) diff --git a/build_files/utils/make_bpy_wheel.py b/build_files/utils/make_bpy_wheel.py index a9a651f931e..882f8ce6e00 100755 --- a/build_files/utils/make_bpy_wheel.py +++ b/build_files/utils/make_bpy_wheel.py @@ -246,9 +246,9 @@ def main() -> None: name="bpy", version=blender_version_str, - # bpy is not compatible with numpy 2+, as the VFX reference platform uses - # 1.26 atm. This fix amended the install requirement package to specify - # numpy>=1.26,<2.0 to mitigate this issue. + # `bpy` is not compatible with `numpy` 2+, as the VFX reference platform uses + # 1.26 at the moment. This fix amended the install requirement package to specify + # `numpy>=1.26,<2.0` to mitigate this issue. install_requires=["cython", "numpy>=1.26,<2.0", "requests", "zstandard"], python_requires="==%d.%d.*" % (python_version_number[0], python_version_number[1]), diff --git a/intern/cycles/blender/mesh.cpp b/intern/cycles/blender/mesh.cpp index bdf2001cad0..63445685d98 100644 --- a/intern/cycles/blender/mesh.cpp +++ b/intern/cycles/blender/mesh.cpp @@ -1085,7 +1085,7 @@ static void create_subd_mesh(Scene *scene, } } - /* set subd params */ + /* Set subd parameters. */ PointerRNA cobj = RNA_pointer_get(&b_ob.ptr, "cycles"); const float subd_dicing_rate = max(0.1f, RNA_float_get(&cobj, "dicing_rate") * dicing_rate); diff --git a/intern/cycles/kernel/light/background.h b/intern/cycles/kernel/light/background.h index 559a8e8348f..3bc25c2c419 100644 --- a/intern/cycles/kernel/light/background.h +++ b/intern/cycles/kernel/light/background.h @@ -104,7 +104,7 @@ ccl_device float3 background_map_sample(KernelGlobals kg, } /* TODO(sergey): Same as above, after the release we should consider using - * 'noinline' for all devices. + * `noinline` for all devices. */ ccl_device float background_map_pdf(KernelGlobals kg, const float3 direction) { diff --git a/intern/cycles/session/buffers.cpp b/intern/cycles/session/buffers.cpp index b96458d3091..1f31f1ae3b4 100644 --- a/intern/cycles/session/buffers.cpp +++ b/intern/cycles/session/buffers.cpp @@ -69,7 +69,7 @@ PassInfo BufferPass::get_info() const } /* -------------------------------------------------------------------- - * Buffer Params. + * Buffer Parameters. */ NODE_DEFINE(BufferParams) diff --git a/source/blender/blenkernel/BKE_ipo.h b/source/blender/blenkernel/BKE_ipo.h index 31e5fe0dd89..418b8bbcb4e 100644 --- a/source/blender/blenkernel/BKE_ipo.h +++ b/source/blender/blenkernel/BKE_ipo.h @@ -10,7 +10,7 @@ struct Main; /** - * Called from #do_versions() in `readfile.cc` to convert the old 'IPO/adrcode' + * Called from #do_versions() in `readfile.cc` to convert the old `IPO/adrcode` * system to the new Layered Action system. * * Note: this *only* deals with animation data that is *pre-Animato*, and diff --git a/source/blender/blenkernel/BKE_lib_query.hh b/source/blender/blenkernel/BKE_lib_query.hh index d2f5c5f2725..d7060d1b1e1 100644 --- a/source/blender/blenkernel/BKE_lib_query.hh +++ b/source/blender/blenkernel/BKE_lib_query.hh @@ -87,7 +87,7 @@ enum LibraryForeachIDCallbackFlag { * Note that all embedded IDs pointers (#IDWALK_CB_EMBEDDED and #IDWALK_CB_EMBEDDED_NOT_OWNING) * cases are also ignored during readfile. * - * Mainly used for some 'loopback' pointers like the 'owner_id' of the embedded IDs. + * Mainly used for some 'loop-back' pointers like the 'owner_id' of the embedded IDs. */ IDWALK_CB_READFILE_IGNORE = (1 << 10), diff --git a/source/blender/blenkernel/BKE_mesh.hh b/source/blender/blenkernel/BKE_mesh.hh index 3da48aa91c6..ae0963e2b8a 100644 --- a/source/blender/blenkernel/BKE_mesh.hh +++ b/source/blender/blenkernel/BKE_mesh.hh @@ -230,7 +230,7 @@ void normals_corner_custom_set_from_verts(Span vert_positions, MutableSpan r_clnors_data); /** - * Define sharp edges as needed to mimic 'autosmooth' from angle threshold. + * Define sharp edges as needed to mimic "auto-smooth" from angle threshold. * * Used when defining an empty custom corner normals data layer, * to keep same shading as with auto-smooth! diff --git a/source/blender/blenkernel/intern/tracking.cc b/source/blender/blenkernel/intern/tracking.cc index 17432aff154..47c1ae16a2a 100644 --- a/source/blender/blenkernel/intern/tracking.cc +++ b/source/blender/blenkernel/intern/tracking.cc @@ -2955,7 +2955,7 @@ void BKE_tracking_disable_channels( } /* -------------------------------------------------------------------- - * Dopesheet functions. + * Dope-sheet functions. */ /* ** Channels sort comparators ** */ diff --git a/source/blender/blenlib/intern/math_rotation_c.cc b/source/blender/blenlib/intern/math_rotation_c.cc index 1bd1d77deb1..ddd5a0e2374 100644 --- a/source/blender/blenlib/intern/math_rotation_c.cc +++ b/source/blender/blenlib/intern/math_rotation_c.cc @@ -2317,7 +2317,7 @@ float fov_to_focallength(float hfov, float sensor) return (sensor / 2.0f) / tanf(hfov * 0.5f); } -/* 'mod_inline(-3, 4)= 1', 'fmod(-3, 4)= -3' */ +/* `mod_inline(-3, 4)= 1`, `fmod(-3, 4)= -3` */ static float mod_inline(float a, float b) { return a - (b * floorf(a / b)); diff --git a/source/blender/blenlib/tests/BLI_array_store_test.cc b/source/blender/blenlib/tests/BLI_array_store_test.cc index 29f07a421cb..8dcbfbbd888 100644 --- a/source/blender/blenlib/tests/BLI_array_store_test.cc +++ b/source/blender/blenlib/tests/BLI_array_store_test.cc @@ -421,7 +421,7 @@ TEST(array_store, TextDupeIncreaseDecrease) /* Plain Text Tests */ /** - * Test that uses text input with different params for the array-store + * Test that uses text input with different parameters for the array-store * to ensure no corner cases fail. */ static void plain_text_helper(const char *words, diff --git a/source/blender/blenloader/intern/readfile.cc b/source/blender/blenloader/intern/readfile.cc index 71b2d5128f6..9edb7384c28 100644 --- a/source/blender/blenloader/intern/readfile.cc +++ b/source/blender/blenloader/intern/readfile.cc @@ -3277,7 +3277,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } /* WATCH IT!!!: pointers from libdata have not been converted yet here! */ - /* WATCH IT 2!: Userdef struct init see do_versions_userdef() above! */ + /* WATCH IT 2!: #UserDef struct init see #do_versions_userdef() above! */ /* don't forget to set version number in BKE_blender_version.h! */ diff --git a/source/blender/blenloader/intern/versioning_280.cc b/source/blender/blenloader/intern/versioning_280.cc index add986f7675..89a5cc675ae 100644 --- a/source/blender/blenloader/intern/versioning_280.cc +++ b/source/blender/blenloader/intern/versioning_280.cc @@ -3796,7 +3796,7 @@ void blo_do_versions_280(FileData *fd, Library * /*lib*/, Main *bmain) LISTBASE_FOREACH (SpaceLink *, sl, &area->spacedata) { if (sl->spacetype == SPACE_ACTION) { SpaceAction *saction = (SpaceAction *)sl; - /* "Dopesheet" should be default here, + /* "Dope-sheet" should be default here, * unless it looks like the Action Editor was active instead. */ if ((saction->mode_prev == 0) && (saction->action == nullptr)) { saction->mode_prev = SACTCONT_DOPESHEET; @@ -5015,7 +5015,7 @@ void blo_do_versions_280(FileData *fd, Library * /*lib*/, Main *bmain) } if (!MAIN_VERSION_FILE_ATLEAST(bmain, 280, 57)) { - /* Enable Show Interpolation in dopesheet by default. */ + /* Enable Show Interpolation in dope-sheet by default. */ LISTBASE_FOREACH (bScreen *, screen, &bmain->screens) { LISTBASE_FOREACH (ScrArea *, area, &screen->areabase) { LISTBASE_FOREACH (SpaceLink *, sl, &area->spacedata) { diff --git a/source/blender/draw/intern/draw_context.cc b/source/blender/draw/intern/draw_context.cc index 2cf5f1b801d..4f372620850 100644 --- a/source/blender/draw/intern/draw_context.cc +++ b/source/blender/draw/intern/draw_context.cc @@ -945,7 +945,7 @@ static void drw_callbacks_pre_scene(DRWContext &draw_ctx) DRW_submission_end(); } - /* State is reset later at the begining of `draw_ctx.engines_draw_scene()`. */ + /* State is reset later at the beginning of `draw_ctx.engines_draw_scene()`. */ } static void drw_callbacks_post_scene(DRWContext &draw_ctx) diff --git a/source/blender/draw/intern/draw_view_data.hh b/source/blender/draw/intern/draw_view_data.hh index d0fb81f076b..591bc5506ad 100644 --- a/source/blender/draw/intern/draw_view_data.hh +++ b/source/blender/draw/intern/draw_view_data.hh @@ -100,7 +100,7 @@ struct DRWViewData { { /* IMPORTANT: Order here defines the draw order. */ - /* Render engines. Output to the render result framebuffer. Mutually exclusive. */ + /* Render engines. Output to the render result frame-buffer. Mutually exclusive. */ callback(eevee); callback(workbench); callback(external); @@ -108,11 +108,11 @@ struct DRWViewData { #ifdef WITH_DRAW_DEBUG callback(edit_select_debug); #endif - /* Grease pencil. Merge its output to the render result framebuffer. */ + /* Grease pencil. Merge its output to the render result frame-buffer. */ callback(grease_pencil); - /* GPU compositor. Processes render result and output to the render result framebuffer. */ + /* GPU compositor. Processes render result and output to the render result frame-buffer. */ callback(compositor); - /* Overlays. Draw on a separate overlay framebuffer. Can read render result. */ + /* Overlays. Draw on a separate overlay frame-buffer. Can read render result. */ callback(overlay); /* Selection. Are always enabled alone and have no interaction with other engines. */ diff --git a/source/blender/editors/animation/anim_channels_edit.cc b/source/blender/editors/animation/anim_channels_edit.cc index 1d5e9508685..b6e793c9780 100644 --- a/source/blender/editors/animation/anim_channels_edit.cc +++ b/source/blender/editors/animation/anim_channels_edit.cc @@ -2419,7 +2419,7 @@ static bool animchannels_grouping_poll(bContext *C) case SPACE_ACTION: { SpaceAction *saction = reinterpret_cast(sl); - /* Dopesheet and action only - all others are for other data-types or have no groups. */ + /* Dope-sheet and action only - all others are for other data-types or have no groups. */ if (ELEM(saction->mode, SACTCONT_ACTION, SACTCONT_DOPESHEET) == 0) { return false; } @@ -3525,7 +3525,7 @@ static bool animchannels_enable_poll(bContext *C) return false; } - /* animation editor test - Action/Dopesheet/etc. and Graph only */ + /* animation editor test - Action/Dope-sheet/etc. and Graph only */ if (ELEM(area->spacetype, SPACE_ACTION, SPACE_GRAPH) == 0) { return false; } @@ -3605,7 +3605,7 @@ static bool animchannels_select_filter_poll(bContext *C) return false; } - /* animation editor with dopesheet */ + /* animation editor with dope-sheet */ return ELEM(area->spacetype, SPACE_ACTION, SPACE_GRAPH, SPACE_NLA); } @@ -4285,7 +4285,7 @@ static int click_select_channel_group(bAnimContext *ac, * things here easier for animators by mapping group selection to bone * selection. * - * Only do this if "Only Selected" dopesheet filter is not active, or else it + * Only do this if "Only Selected" dope-sheet filter is not active, or else it * becomes too unpredictable/tricky to manage */ if ((ac->ads->filterflag & ADS_FILTER_ONLYSEL) == 0) { diff --git a/source/blender/editors/animation/anim_deps.cc b/source/blender/editors/animation/anim_deps.cc index 76753e7df6a..59614f217ca 100644 --- a/source/blender/editors/animation/anim_deps.cc +++ b/source/blender/editors/animation/anim_deps.cc @@ -240,7 +240,7 @@ static void animchan_sync_gplayer(bAnimListElem *ale) bGPDlayer *gpl = static_cast(ale->data); /* Make sure the selection flags agree with the "active" flag. - * The selection flags are used in the Dopesheet only, whereas + * The selection flags are used in the Dope-sheet only, whereas * the active flag is used everywhere else. Hence, we try to * sync these here so that it all seems to be have as the user * expects - #50184 diff --git a/source/blender/editors/animation/anim_draw.cc b/source/blender/editors/animation/anim_draw.cc index 5778cb2fc1c..51047373cf4 100644 --- a/source/blender/editors/animation/anim_draw.cc +++ b/source/blender/editors/animation/anim_draw.cc @@ -607,7 +607,7 @@ static bool find_prev_next_keyframes(bContext *C, int *r_nextfra, int *r_prevfra cfranext = cfraprev = float(scene->r.cfra); - /* seed up dummy dopesheet context with flags to perform necessary filtering */ + /* Seed up dummy dope-sheet context with flags to perform necessary filtering. */ if ((scene->flag & SCE_KEYS_NO_SELONLY) == 0) { /* only selected channels are included */ ads.filterflag |= ADS_FILTER_ONLYSEL; @@ -628,7 +628,7 @@ static bool find_prev_next_keyframes(bContext *C, int *r_nextfra, int *r_prevfra } ED_keylist_prepare_for_direct_access(keylist); - /* TODO(jbakker): Keylists are ordered, no need to do any searching at all. */ + /* TODO(jbakker): Key-lists are ordered, no need to do any searching at all. */ /* find matching keyframe in the right direction */ do { aknext = ED_keylist_find_next(keylist, cfranext); diff --git a/source/blender/editors/animation/keyframes_draw.cc b/source/blender/editors/animation/keyframes_draw.cc index 0bf1b2ef61c..2f7e789dcde 100644 --- a/source/blender/editors/animation/keyframes_draw.cc +++ b/source/blender/editors/animation/keyframes_draw.cc @@ -456,7 +456,7 @@ static void build_channel_keylist(ChannelListElement *elem, blender::float2 rang break; } case ChannelType::ACTION_LAYERED: { - /* This is only called for action summaries in the Dopesheet, *not* the + /* This is only called for action summaries in the Dope-sheet, *not* the * Action Editor. Therefore despite the name `ACTION_LAYERED`, this is * only used to show a *single slot* of the action: the slot used by the * ID the action is listed under. diff --git a/source/blender/editors/animation/keyframes_edit.cc b/source/blender/editors/animation/keyframes_edit.cc index 226e95541e2..181c586ae32 100644 --- a/source/blender/editors/animation/keyframes_edit.cc +++ b/source/blender/editors/animation/keyframes_edit.cc @@ -426,7 +426,7 @@ short ANIM_animchannel_keyframes_loop(KeyframeEditData *ked, return agrp_keyframes_loop( ked, static_cast(ale->data), key_ok, key_cb, fcu_cb); case ALE_ACTION_LAYERED: { /* Layered Action. */ - /* This assumes that the ALE_ACTION_LAYERED channel is shown in the dopesheet context, + /* This assumes that the ALE_ACTION_LAYERED channel is shown in the dope-sheet context, * underneath the data-block that owns `ale->adt`. So that means that the loop is limited to * the keys that belong to that slot. */ animrig::Action &action = static_cast(ale->key_data)->wrap(); diff --git a/source/blender/editors/armature/armature_naming.cc b/source/blender/editors/armature/armature_naming.cc index 98436f4a31b..66689b74538 100644 --- a/source/blender/editors/armature/armature_naming.cc +++ b/source/blender/editors/armature/armature_naming.cc @@ -480,7 +480,7 @@ static wmOperatorStatus armature_flip_names_exec(bContext *C, wmOperator *op) DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY); /* copied from #rna_Bone_update_renamed */ - /* Redraw Outliner / Dopesheet. */ + /* Redraw Outliner / Dope-sheet. */ WM_event_add_notifier(C, NC_GEOM | ND_DATA | NA_RENAME, ob->data); /* update animation channels */ diff --git a/source/blender/editors/gpencil_legacy/editaction_gpencil.cc b/source/blender/editors/gpencil_legacy/editaction_gpencil.cc index 9ab3178f398..01d8539037d 100644 --- a/source/blender/editors/gpencil_legacy/editaction_gpencil.cc +++ b/source/blender/editors/gpencil_legacy/editaction_gpencil.cc @@ -330,7 +330,7 @@ bool ED_gpencil_anim_copybuf_copy(bAnimContext *ac) LISTBASE_FOREACH (bAnimListElem *, ale, &anim_data) { /* This function only deals with grease pencil layer frames. - * This check is needed in the case of a call from the main dopesheet. */ + * This check is needed in the case of a call from the main dope-sheet. */ if (ale->type != ANIMTYPE_GPLAYER) { continue; } @@ -421,7 +421,7 @@ bool ED_gpencil_anim_copybuf_paste(bAnimContext *ac, const short offset_mode) /* from selected channels */ LISTBASE_FOREACH (bAnimListElem *, ale, &anim_data) { - /* only deal with GPlayers (case of calls from general dopesheet) */ + /* Only deal with GPlayers (case of calls from general dope-sheet). */ if (ale->type != ANIMTYPE_GPLAYER) { continue; } diff --git a/source/blender/editors/grease_pencil/intern/grease_pencil_frames.cc b/source/blender/editors/grease_pencil/intern/grease_pencil_frames.cc index d07c66b0b32..25ca673435a 100644 --- a/source/blender/editors/grease_pencil/intern/grease_pencil_frames.cc +++ b/source/blender/editors/grease_pencil/intern/grease_pencil_frames.cc @@ -626,7 +626,7 @@ bool grease_pencil_copy_keyframes(bAnimContext *ac, KeyframeClipboard &clipboard LISTBASE_FOREACH (bAnimListElem *, ale, &anim_data) { /* This function only deals with grease pencil layer frames. - * This check is needed in the case of a call from the main dopesheet. */ + * This check is needed in the case of a call from the main dope-sheet. */ if (ale->type != ANIMTYPE_GREASE_PENCIL_LAYER) { continue; } @@ -714,7 +714,7 @@ bool grease_pencil_paste_keyframes(bAnimContext *ac, const bool from_single_channel = clipboard.copy_buffer.size() == 1; LISTBASE_FOREACH (bAnimListElem *, ale, &anim_data) { - /* Only deal with GPlayers (case of calls from general dopesheet). */ + /* Only deal with GPlayers (case of calls from general dope-sheet). */ if (ale->type != ANIMTYPE_GREASE_PENCIL_LAYER) { continue; } diff --git a/source/blender/editors/include/ED_anim_api.hh b/source/blender/editors/include/ED_anim_api.hh index 8a311c2680b..7fa2bf04460 100644 --- a/source/blender/editors/include/ED_anim_api.hh +++ b/source/blender/editors/include/ED_anim_api.hh @@ -411,7 +411,7 @@ ENUM_OPERATORS(eAnimFilter_Flags, ANIMFILTER_TMP_IGNORE_ONLYSEL); /* XXX check on all of these flags again. */ -/* Dopesheet only */ +/* Dope-sheet only. */ /* 'Scene' channels */ #define SEL_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene *), ((sce->flag & SCE_DS_SELECTED))) #define EXPANDED_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene *), ((sce->flag & SCE_DS_COLLAPSED) == 0)) @@ -452,7 +452,7 @@ ENUM_OPERATORS(eAnimFilter_Flags, ANIMFILTER_TMP_IGNORE_ONLYSEL); #define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED) == 0) #define EXPANDED_ADT(adt) ((adt->flag & ADT_UI_EXPANDED) != 0) -/* Actions (also used for Dopesheet) */ +/* Actions (also used for Dope-sheet). */ /** Action Channel Group. */ #define EDITABLE_AGRP(agrp) (((agrp)->flag & AGRP_PROTECTED) == 0) #define EXPANDED_AGRP(ac, agrp) \ diff --git a/source/blender/editors/include/ED_keyframes_edit.hh b/source/blender/editors/include/ED_keyframes_edit.hh index 31457c6f24b..6263e5ae040 100644 --- a/source/blender/editors/include/ED_keyframes_edit.hh +++ b/source/blender/editors/include/ED_keyframes_edit.hh @@ -44,7 +44,7 @@ enum eEditKeyframes_Validate { BEZT_OK_REGION, BEZT_OK_REGION_LASSO, BEZT_OK_REGION_CIRCLE, - /* Only for keyframes a certain Dopesheet channel */ + /* Only for keyframes a certain Dope-sheet channel. */ BEZT_OK_CHANNEL_LASSO, BEZT_OK_CHANNEL_CIRCLE, }; @@ -188,7 +188,7 @@ struct KeyframeEditData { FCurve *fcu; /** index of current keyframe being iterated over */ int curIndex; - /** y-position of midpoint of the channel (for the dopesheet) */ + /** Y-position of midpoint of the channel (for the dope-sheet). */ float channel_y; /* flags */ diff --git a/source/blender/editors/interface/interface_icons.cc b/source/blender/editors/interface/interface_icons.cc index 59e99c5a03e..6526e35e172 100644 --- a/source/blender/editors/interface/interface_icons.cc +++ b/source/blender/editors/interface/interface_icons.cc @@ -235,8 +235,9 @@ static void vicon_keytype_draw_wrapper(const int x, immBegin(GPU_PRIM_POINTS, 1); /* draw keyframe - * - size: (default icon size == 16, default dopesheet icon size == 10) - * - sel: true unless in handletype icons (so that "keyframe" state shows the iconic yellow icon) + * - size: (default icon size == 16, default dope-sheet icon size == 10) + * - sel: true unless in handle-type icons + * (so that "keyframe" state shows the iconic yellow icon). */ const bool sel = (handle_type == KEYFRAME_HANDLE_NONE); @@ -1277,7 +1278,7 @@ static void icon_draw_rect(float x, float scale_x = 1.0f; float scale_y = 1.0f; - /* rect contains image in 'rendersize', we only scale if needed */ + /* `rect` contains image in render-size, we only scale if needed. */ if (rw != w || rh != h) { /* preserve aspect ratio and center */ if (rw > rh) { diff --git a/source/blender/editors/screen/screen_context.cc b/source/blender/editors/screen/screen_context.cc index 27d3afbee0e..7af1c15ce1f 100644 --- a/source/blender/editors/screen/screen_context.cc +++ b/source/blender/editors/screen/screen_context.cc @@ -944,7 +944,7 @@ static eContextResult screen_ctx_sel_actions_impl(const bContext *C, blender::Set seen_set; LISTBASE_FOREACH (bAnimListElem *, ale, &anim_data) { - /* In dopesheet check selection status of individual items, skipping + /* In dope-sheet check selection status of individual items, skipping * if not selected or has no selection flag. This is needed so that * selecting action or group rows without any channels works. */ if (check_selected && ANIM_channel_setting_get(&ac, ale, ACHANNEL_SETTING_SELECT) <= 0) { diff --git a/source/blender/editors/space_action/action_draw.cc b/source/blender/editors/space_action/action_draw.cc index 99636ab0d6c..646b42748c9 100644 --- a/source/blender/editors/space_action/action_draw.cc +++ b/source/blender/editors/space_action/action_draw.cc @@ -475,7 +475,7 @@ void draw_channel_strips(bAnimContext *ac, { View2D *v2d = ®ion->v2d; - /* Draw the manual frame ranges for actions in the background of the dopesheet. + /* Draw the manual frame ranges for actions in the background of the dope-sheet. * The action editor has already drawn the range for its action so it's not needed. */ if (ac->datatype == ANIMCONT_DOPESHEET) { draw_channel_action_ranges(anim_data, v2d); diff --git a/source/blender/editors/space_action/action_edit.cc b/source/blender/editors/space_action/action_edit.cc index d98b2798133..c144f2a15f9 100644 --- a/source/blender/editors/space_action/action_edit.cc +++ b/source/blender/editors/space_action/action_edit.cc @@ -159,7 +159,7 @@ static bool get_keyframe_extents(bAnimContext *ac, float *min, float *max, const eAnimFilter_Flags filter; bool found = false; - /* get data to filter, from Action or Dopesheet */ + /* Get data to filter, from Action or Dope-sheet. */ /* XXX: what is sel doing here?! * Commented it, was breaking things (eg. the "auto preview range" tool). */ filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_LIST_VISIBLE /*| ANIMFILTER_SEL */ | diff --git a/source/blender/editors/space_action/action_select.cc b/source/blender/editors/space_action/action_select.cc index 2eba7b43424..fd9dcb4b5ef 100644 --- a/source/blender/editors/space_action/action_select.cc +++ b/source/blender/editors/space_action/action_select.cc @@ -111,7 +111,7 @@ static void actkeys_list_element_to_keylist(bAnimContext *ac, break; } case ALE_ACTION_LAYERED: { - /* This is only called for action summaries in the Dopesheet, *not* the + /* This is only called for action summaries in the Dope-sheet, *not* the * Action Editor. Therefore despite the name `ALE_ACTION_LAYERED`, this * is only used to show a *single slot* of the action: the slot used by * the ID the action is listed under. @@ -158,7 +158,7 @@ static void actkeys_list_element_to_keylist(bAnimContext *ac, } } else if (ale->type == ANIMTYPE_SUMMARY) { - /* dopesheet summary covers everything */ + /* Dope-sheet summary covers everything. */ summary_to_keylist(ac, keylist, 0, range); } else if (ale->type == ANIMTYPE_GROUP) { diff --git a/source/blender/editors/space_action/space_action.cc b/source/blender/editors/space_action/space_action.cc index 1f10eaf7548..d9647195e69 100644 --- a/source/blender/editors/space_action/space_action.cc +++ b/source/blender/editors/space_action/space_action.cc @@ -418,14 +418,13 @@ static void saction_channel_region_message_subscribe(const wmRegionMessageSubscr msg_sub_value_region_tag_redraw.user_data = region; msg_sub_value_region_tag_redraw.notify = ED_region_do_msg_notify_tag_redraw; - /* All dopesheet filter settings, etc. affect the drawing of this editor, + /* All dope-sheet filter settings, etc. affect the drawing of this editor, * also same applies for all animation-related data-types that may appear here, - * so just whitelist the entire structs for updates - */ + * so just whitelist the entire structs for updates. */ { wmMsgParams_RNA msg_key_params = {{}}; StructRNA *type_array[] = { - &RNA_DopeSheet, /* dopesheet filters */ + &RNA_DopeSheet, /* Dope-sheet filters. */ &RNA_ActionGroup, /* channel groups */ diff --git a/source/blender/editors/space_graph/graph_utils.cc b/source/blender/editors/space_graph/graph_utils.cc index 816ef3680a7..3785f122362 100644 --- a/source/blender/editors/space_graph/graph_utils.cc +++ b/source/blender/editors/space_graph/graph_utils.cc @@ -169,7 +169,7 @@ bool graphop_editable_keyframes_poll(bContext *C) int filter; bool found = false; - /* firstly, check if in Graph Editor or Dopesheet */ + /* Firstly, check if in Graph Editor or Dope-sheet. */ /* TODO: also check for region? */ if (area == nullptr || !ELEM(area->spacetype, SPACE_GRAPH, SPACE_ACTION)) { return found; diff --git a/source/blender/editors/space_graph/graph_view.cc b/source/blender/editors/space_graph/graph_view.cc index 035bf84bb36..a7ae8b20222 100644 --- a/source/blender/editors/space_graph/graph_view.cc +++ b/source/blender/editors/space_graph/graph_view.cc @@ -52,7 +52,7 @@ void get_graph_keyframe_extents(bAnimContext *ac, ListBase anim_data = {nullptr, nullptr}; int filter; - /* Get data to filter, from Dopesheet. */ + /* Get data to filter, from Dope-sheet. */ filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FCURVESONLY | ANIMFILTER_NODUPLIS); if (U.animation_flag & USER_ANIM_ONLY_SHOW_SELECTED_CURVE_KEYS) { diff --git a/source/blender/editors/space_graph/space_graph.cc b/source/blender/editors/space_graph/space_graph.cc index 4a4ecacaa23..7c1d7ecb16f 100644 --- a/source/blender/editors/space_graph/space_graph.cc +++ b/source/blender/editors/space_graph/space_graph.cc @@ -141,7 +141,7 @@ static void graph_init(wmWindowManager *wm, ScrArea *area) { SpaceGraph *sipo = (SpaceGraph *)area->spacedata.first; - /* init dopesheet data if non-existent (i.e. for old files) */ + /* Init dope-sheet if non-existent (i.e. for old files). */ if (sipo->ads == nullptr) { wmWindow *win = WM_window_find_by_area(wm, area); sipo->ads = static_cast(MEM_callocN(sizeof(bDopeSheet), "GraphEdit DopeSheet")); @@ -540,14 +540,14 @@ static void graph_region_message_subscribe(const wmRegionMessageSubscribeParams } } - /* All dopesheet filter settings, etc. affect the drawing of this editor, + /* All dope-sheet filter settings, etc. affect the drawing of this editor, * also same applies for all animation-related data-types that may appear here, * so just whitelist the entire structs for updates */ { wmMsgParams_RNA msg_key_params = {{}}; StructRNA *type_array[] = { - &RNA_DopeSheet, /* dopesheet filters */ + &RNA_DopeSheet, /* dope-sheet filters */ &RNA_ActionGroup, /* channel groups */ &RNA_FCurve, /* F-Curve */ diff --git a/source/blender/editors/space_nla/nla_draw.cc b/source/blender/editors/space_nla/nla_draw.cc index fdabe0c8a92..183d5ebc582 100644 --- a/source/blender/editors/space_nla/nla_draw.cc +++ b/source/blender/editors/space_nla/nla_draw.cc @@ -58,7 +58,7 @@ void nla_action_get_color(AnimData *adt, bAction *act, float color[4]) } else { if (act) { - /* reddish color - same as dopesheet summary */ + /* reddish color - same as dope-sheet summary */ UI_GetThemeColor4fv(TH_ANIM_ACTIVE, color); } else { diff --git a/source/blender/editors/space_nla/space_nla.cc b/source/blender/editors/space_nla/space_nla.cc index 34298bc8ff1..29159e93c64 100644 --- a/source/blender/editors/space_nla/space_nla.cc +++ b/source/blender/editors/space_nla/space_nla.cc @@ -132,7 +132,7 @@ static void nla_init(wmWindowManager *wm, ScrArea *area) { SpaceNla *snla = static_cast(area->spacedata.first); - /* init dopesheet data if non-existent (i.e. for old files) */ + /* init dope-sheet data if non-existent (i.e. for old files). */ if (snla->ads == nullptr) { snla->ads = MEM_callocN("NlaEdit DopeSheet"); wmWindow *win = WM_window_find_by_area(wm, area); @@ -512,9 +512,8 @@ static void nla_track_region_message_subscribe(const wmRegionMessageSubscribePar msg_sub_value_region_tag_redraw.user_data = region; msg_sub_value_region_tag_redraw.notify = ED_region_do_msg_notify_tag_redraw; - /* All dopesheet filter settings, etc. affect the drawing of this editor, - * so just whitelist the entire struct for updates - */ + /* All dope-sheet filter settings, etc. affect the drawing of this editor, + * so just whitelist the entire struct for updates. */ { wmMsgParams_RNA msg_key_params = {{}}; StructRNA *type_array[] = { diff --git a/source/blender/editors/transform/transform_generics.cc b/source/blender/editors/transform/transform_generics.cc index a72b4ef033a..645f3c2acb5 100644 --- a/source/blender/editors/transform/transform_generics.cc +++ b/source/blender/editors/transform/transform_generics.cc @@ -1184,8 +1184,8 @@ static void calculateZfac(TransInfo *t) } else if (t->region) { View2D *v2d = &t->region->v2d; - /* Get zoom fac the same way as in - * `ui_view2d_curRect_validate_resize` - better keep in sync! */ + /* Get zoom factor the same way as in + * #ui_view2d_curRect_validate_resize - better keep in sync! */ const float zoomx = float(BLI_rcti_size_x(&v2d->mask) + 1) / BLI_rctf_size_x(&v2d->cur); t->zfac = 1.0f / zoomx; } diff --git a/source/blender/editors/undo/ed_undo.cc b/source/blender/editors/undo/ed_undo.cc index 62488602847..d393068446d 100644 --- a/source/blender/editors/undo/ed_undo.cc +++ b/source/blender/editors/undo/ed_undo.cc @@ -418,7 +418,7 @@ bool ED_undo_is_legacy_compatible_for_property(bContext *C, ID *id, PointerRNA & Object *obact = BKE_view_layer_active_object_get(view_layer); if (obact != nullptr) { if (obact->mode & (OB_MODE_ALL_PAINT & ~OB_MODE_WEIGHT_PAINT)) { - /* For all non-weightpaint paint modes: Don't store property changes when painting. + /* For all non-weight-paint paint modes: Don't store property changes when painting. * Weight Paint uses global undo, and thus doesn't need to be special-cased here. */ CLOG_INFO(&LOG, 1, "skipping undo for paint-mode"); return false; diff --git a/source/blender/gpu/intern/gpu_select_pick.cc b/source/blender/gpu/intern/gpu_select_pick.cc index a5f84346a20..c4119cf08aa 100644 --- a/source/blender/gpu/intern/gpu_select_pick.cc +++ b/source/blender/gpu/intern/gpu_select_pick.cc @@ -39,7 +39,7 @@ /** \name #SubRectStride * \{ */ -/** For looping over a sub-region of a #rcti, could be moved into 'rct.c'. */ +/** For looping over a sub-region of a #rcti, could be moved into `rct.c`. */ struct SubRectStride { /** Start here. */ uint start; diff --git a/source/blender/gpu/metal/mtl_index_buffer.mm b/source/blender/gpu/metal/mtl_index_buffer.mm index 99febea9036..13c36fefb82 100644 --- a/source/blender/gpu/metal/mtl_index_buffer.mm +++ b/source/blender/gpu/metal/mtl_index_buffer.mm @@ -496,7 +496,7 @@ id MTLIndexBuf::get_index_buffer(GPUPrimType &in_out_primitive_type, ibo_ = nullptr; } - /* Output params. */ + /* Output parameters. */ in_out_v_count = emulated_v_count; in_out_primitive_type = GPU_PRIM_TRIS; return optimized_ibo_->get_metal_buffer(); diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h index 11e597e988a..fdde0625fa7 100644 --- a/source/blender/makesdna/DNA_action_types.h +++ b/source/blender/makesdna/DNA_action_types.h @@ -842,11 +842,11 @@ typedef enum eAction_Flags { } eAction_Flags; /* ************************************************ */ -/* Action/Dopesheet Editor */ +/* Action/Dope-sheet Editor */ -/** Storage for Dopesheet/Grease-Pencil Editor data. */ +/** Storage for Dope-sheet/Grease-Pencil Editor data. */ typedef struct bDopeSheet { - /** Currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil). */ + /** Currently ID_SCE (for Dope-sheet), and ID_SC (for Grease Pencil). */ ID *source; /** Cache for channels (only initialized when pinned). */ /* XXX not used! */ ListBase chanbase; diff --git a/source/blender/makesdna/DNA_grease_pencil_types.h b/source/blender/makesdna/DNA_grease_pencil_types.h index e2e2797e443..f3c68d465fc 100644 --- a/source/blender/makesdna/DNA_grease_pencil_types.h +++ b/source/blender/makesdna/DNA_grease_pencil_types.h @@ -261,7 +261,7 @@ typedef struct GreasePencilLayerTreeNode { int8_t type; char _pad[7]; /** - * Channel color for dopesheet. + * Channel color for dope-sheet. */ float color[3]; /** diff --git a/source/blender/makesdna/DNA_object_fluidsim_types.h b/source/blender/makesdna/DNA_object_fluidsim_types.h index 2f7e0038800..fbda288e566 100644 --- a/source/blender/makesdna/DNA_object_fluidsim_types.h +++ b/source/blender/makesdna/DNA_object_fluidsim_types.h @@ -70,7 +70,7 @@ typedef struct FluidsimSettings { /* values are initialized during derived mesh display. */ float bbStart[3], bbSize[3]; - /* animated params */ + /** Animated parameters. */ struct Ipo *ipo; /* additional flags depending on the type, lower short contains flags diff --git a/source/blender/makesdna/DNA_tracking_types.h b/source/blender/makesdna/DNA_tracking_types.h index 513ba50e761..e82f63f8230 100644 --- a/source/blender/makesdna/DNA_tracking_types.h +++ b/source/blender/makesdna/DNA_tracking_types.h @@ -411,7 +411,7 @@ typedef struct MovieTrackingDopesheet { /** Method to be used to sort tracks. */ short sort_method; - /** Dopesheet building flag such as inverted order of sort. */ + /** Dope-sheet building flag such as inverted order of sort. */ short flag; /* ** runtime stuff ** */ @@ -455,7 +455,7 @@ typedef struct MovieTracking { /** Statistics displaying in clip editor. */ MovieTrackingStats *stats; - /** Dopesheet data. */ + /** Dope-sheet data. */ MovieTrackingDopesheet dopesheet; } MovieTracking; diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index 7d501105873..065fd8be938 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -322,7 +322,7 @@ typedef struct ThemeSpace { unsigned char handle_sel_free[4], handle_sel_auto[4], handle_sel_vect[4], handle_sel_align[4], handle_sel_auto_clamped[4]; - /** Dopesheet. */ + /** Dope-sheet. */ unsigned char ds_channel[4], ds_subchannel[4], ds_ipoline[4]; /** Keytypes. */ unsigned char keytype_keyframe[4], keytype_extreme[4], keytype_breakdown[4], keytype_jitter[4], @@ -366,7 +366,7 @@ typedef struct ThemeSpace { unsigned char effect[4], transition[4], meta[4], text_strip[4], color_strip[4]; unsigned char active_strip[4], selected_strip[4], text_strip_cursor[4], selected_text[4]; - /** For dopesheet - scale factor for size of keyframes (i.e. height of channels). */ + /** For dope-sheet - scale factor for size of keyframes (i.e. height of channels). */ float keyframe_scale_fac; unsigned char editmesh_active[4]; diff --git a/source/blender/makesrna/intern/rna_armature.cc b/source/blender/makesrna/intern/rna_armature.cc index 9b13aa0f199..2a0d939fa22 100644 --- a/source/blender/makesrna/intern/rna_armature.cc +++ b/source/blender/makesrna/intern/rna_armature.cc @@ -728,7 +728,7 @@ static void rna_Bone_update_renamed(Main * /*bmain*/, Scene * /*scene*/, Pointer { ID *id = ptr->owner_id; - /* Redraw Outliner / Dopesheet. */ + /* Redraw Outliner / Dope-sheet. */ WM_main_add_notifier(NC_GEOM | ND_DATA | NA_RENAME, id); /* update animation channels */ diff --git a/source/blender/makesrna/intern/rna_space.cc b/source/blender/makesrna/intern/rna_space.cc index 84cac1d8d7e..8d4ce9cb88c 100644 --- a/source/blender/makesrna/intern/rna_space.cc +++ b/source/blender/makesrna/intern/rna_space.cc @@ -2221,7 +2221,7 @@ static void rna_ConsoleLine_current_character_set(PointerRNA *ptr, const int ind ci->cursor = BLI_str_utf8_offset_from_index(ci->line, ci->len, index); } -/* Space Dopesheet */ +/* Space Dope-sheet */ static void rna_SpaceDopeSheetEditor_action_set(PointerRNA *ptr, PointerRNA value, diff --git a/source/blender/windowmanager/intern/wm_window.cc b/source/blender/windowmanager/intern/wm_window.cc index d37f56b0c6e..df2f6488a6a 100644 --- a/source/blender/windowmanager/intern/wm_window.cc +++ b/source/blender/windowmanager/intern/wm_window.cc @@ -878,7 +878,7 @@ static void wm_window_ghostwindow_add(wmWindowManager *wm, /* Until screens get drawn, make it nice gray. */ GPU_clear_color(0.25f, 0.25f, 0.25f, 1.0f); - /* Needed here, because it's used before it reads userdef. */ + /* Needed here, because it's used before it reads #UserDef. */ WM_window_set_dpi(win); wm_window_swap_buffers(win);