diff --git a/intern/cycles/blender/device.cpp b/intern/cycles/blender/device.cpp index cabf15b4ac0..95ae225daed 100644 --- a/intern/cycles/blender/device.cpp +++ b/intern/cycles/blender/device.cpp @@ -108,7 +108,7 @@ DeviceInfo blender_device_info(BL::Preferences &b_preferences, /* Default to CPU device. */ DeviceInfo cpu_device = Device::available_devices(DEVICE_MASK_CPU).front(); - /* Device, which is choosen in the Blender Preferences. Default to CPU device. */ + /* Device, which is chosen in the Blender Preferences. Default to CPU device. */ preferences_device = cpu_device; /* Test if we are using GPU devices. */ diff --git a/intern/cycles/blender/display_driver.cpp b/intern/cycles/blender/display_driver.cpp index de7991231ab..3be95d188d4 100644 --- a/intern/cycles/blender/display_driver.cpp +++ b/intern/cycles/blender/display_driver.cpp @@ -775,7 +775,7 @@ void BlenderDisplayDriver::draw(const Params ¶ms) const int position_attribute = GPU_vertformat_attr_add( format, display_shader_->position_attribute_name, GPU_COMP_F32, 2, GPU_FETCH_FLOAT); - /* Note: Shader is bound again through IMM to register this shader with the IMM module + /* NOTE: Shader is bound again through IMM to register this shader with the IMM module * and perform required setup for IMM rendering. This is required as the IMM module * needs to be aware of which shader is bound, and the main display shader * is bound externally. */ diff --git a/intern/cycles/integrator/denoiser.cpp b/intern/cycles/integrator/denoiser.cpp index 75bc4016dc6..957a7f08ad2 100644 --- a/intern/cycles/integrator/denoiser.cpp +++ b/intern/cycles/integrator/denoiser.cpp @@ -85,7 +85,7 @@ unique_ptr Denoiser::create(Device *denoiser_device, } else { /* Find best device from the ones which are proposed for denoising. */ - /* The choise is expected to be between few GPUs, or between GPU and a CPU + /* The choice is expected to be between few GPUs, or between GPU and a CPU * or between few GPU and a CPU. */ single_denoiser_device = find_best_device(denoiser_device, params.type); } @@ -113,7 +113,7 @@ unique_ptr Denoiser::create(Device *denoiser_device, oidn_params.type = DENOISER_OPENIMAGEDENOISE; oidn_params.use_gpu = false; - /* Used preference CPU when possible, and fallback on cpu fallback device otherwice. */ + /* Used preference CPU when possible, and fallback on CPU fallback device otherwise. */ return make_unique( is_cpu_denoiser_device ? single_denoiser_device : cpu_fallback_device, oidn_params); } diff --git a/intern/cycles/kernel/closure/bsdf_util.h b/intern/cycles/kernel/closure/bsdf_util.h index 0b1a93e5a0b..72c7cf63322 100644 --- a/intern/cycles/kernel/closure/bsdf_util.h +++ b/intern/cycles/kernel/closure/bsdf_util.h @@ -376,7 +376,7 @@ ccl_device Spectrum fresnel_iridescence(KernelGlobals kg, * The proper way to do this would be a Von Kries-style transform, but to keep it simple, * we just multiply by the white point here. * - * Note: The reference implementation sidesteps all this by just hard-coding a XYZ->CIE RGB + * NOTE: The reference implementation sidesteps all this by just hard-coding a XYZ->CIE RGB * matrix. Since CIE RGB uses E as its white point, this sidesteps the chromatic adaption * topic, but the primary colors don't match (unless you happen to actually work in CIE RGB.) */ diff --git a/intern/cycles/kernel/integrator/subsurface.h b/intern/cycles/kernel/integrator/subsurface.h index 3fec8c560ac..cb3f307ddd1 100644 --- a/intern/cycles/kernel/integrator/subsurface.h +++ b/intern/cycles/kernel/integrator/subsurface.h @@ -68,9 +68,9 @@ ccl_device_inline bool subsurface_entry_bounce(KernelGlobals kg, const float nK = (neta * cos_HI) - dnp; *wo = -(neta * sd->wi) + (nK * H); return true; - /* Note: For a proper refractive GGX interface, we should be computing lambdaI and lambdaO + /* NOTE: For a proper refractive GGX interface, we should be computing lambdaI and lambdaO * and multiplying the throughput by BSDF/pdf, which for VNDF sampling works out to - * (1 + lambdaI) / (1 + lambdaI + lambdaO). + * `(1 + lambdaI) / (1 + lambdaI + lambdaO)`. * However, this causes darkening due to the single-scattering approximation, which we'd * then have to correct with a lookup table. * Since we only really care about the directional distribution here, it's much easier to diff --git a/intern/cycles/kernel/types.h b/intern/cycles/kernel/types.h index 016d2a08629..9279402e03d 100644 --- a/intern/cycles/kernel/types.h +++ b/intern/cycles/kernel/types.h @@ -758,7 +758,7 @@ typedef struct Intersection { } Intersection; /* On certain GPUs (Apple Silicon), splitting every integrator state field into its own separate - * array can be detrimental for cache utilisation. By enabling __INTEGRATOR_GPU_PACKED_STATE__, we + * array can be detrimental for cache utilization. By enabling __INTEGRATOR_GPU_PACKED_STATE__, we * specify that certain fields should be packed together. This improves cache hit ratios in cases * where fields are often accessed together (e.g. "ray" and "isect"). */ diff --git a/intern/cycles/session/session.h b/intern/cycles/session/session.h index bfbfdf75661..2b53521d788 100644 --- a/intern/cycles/session/session.h +++ b/intern/cycles/session/session.h @@ -35,7 +35,7 @@ class SceneParams; class SessionParams { public: - /* Device, which is choosen based on Blender Cycles preferences, as well as Scene settings and + /* Device, which is chosen based on Blender Cycles preferences, as well as Scene settings and * command line arguments. */ DeviceInfo device; /* Device from Cycles preferences for denoising. */ diff --git a/intern/cycles/util/hash.h b/intern/cycles/util/hash.h index f9c4e4bb627..f8680d9fec4 100644 --- a/intern/cycles/util/hash.h +++ b/intern/cycles/util/hash.h @@ -13,11 +13,11 @@ CCL_NAMESPACE_BEGIN /* [0, uint_max] -> [0.0, 1.0) */ ccl_device_forceinline float uint_to_float_excl(uint n) { - // Note: we divide by 4294967808 instead of 2^32 because the latter - // leads to a [0.0, 1.0] mapping instead of [0.0, 1.0) due to floating - // point rounding error. 4294967808 unfortunately leaves (precisely) - // one unused ulp between the max number this outputs and 1.0, but - // that's the best you can do with this construction. + /* NOTE: we divide by 4294967808 instead of 2^32 because the latter + * leads to a [0.0, 1.0] mapping instead of [0.0, 1.0) due to floating + * point rounding error. 4294967808 unfortunately leaves (precisely) + * one unused ULP between the max number this outputs and 1.0, but + * that's the best you can do with this construction. */ return (float)n * (1.0f / 4294967808.0f); } diff --git a/intern/cycles/util/simd.h b/intern/cycles/util/simd.h index 9dd37a9d819..bbe55769d77 100644 --- a/intern/cycles/util/simd.h +++ b/intern/cycles/util/simd.h @@ -213,8 +213,8 @@ type shuffle_neon(const type &a, const type &b) (i3 * 4) + 2 + 16, (i3 * 4) + 3 + 16}; - // Note: This cannot all be put in a single line due to how MSVC ARM64 - // implements the function calls as several layers of macros. + /* NOTE: This cannot all be put in a single line due to how MSVC ARM64 + * implements the function calls as several layers of macros. */ int8x16x2_t t = {int8x16_t(a), int8x16_t(b)}; uint8x16_t idx = *(uint8x16_t *)tbl; return type(vqtbl2q_s8(t, idx)); diff --git a/intern/ghost/intern/GHOST_ContextVK.cc b/intern/ghost/intern/GHOST_ContextVK.cc index 174bd007057..248727324fa 100644 --- a/intern/ghost/intern/GHOST_ContextVK.cc +++ b/intern/ghost/intern/GHOST_ContextVK.cc @@ -793,7 +793,7 @@ GHOST_TSuccess GHOST_ContextVK::createSwapchain() /* Driver can stall if only using minimal image count. */ uint32_t image_count = capabilities.minImageCount + 1; - /* Note: maxImageCount == 0 means no limit. */ + /* NOTE: maxImageCount == 0 means no limit. */ if (image_count > capabilities.maxImageCount && capabilities.maxImageCount > 0) { image_count = capabilities.maxImageCount; } diff --git a/intern/ghost/intern/GHOST_SystemWayland.cc b/intern/ghost/intern/GHOST_SystemWayland.cc index 3107865b339..a3b6b2d8a96 100644 --- a/intern/ghost/intern/GHOST_SystemWayland.cc +++ b/intern/ghost/intern/GHOST_SystemWayland.cc @@ -2256,7 +2256,7 @@ static int file_descriptor_is_io_ready(int fd, const int flags, const int timeou GHOST_ASSERT(flags & (GWL_IOR_READ | GWL_IOR_WRITE), "X"); - /* Note: We don't bother to account for elapsed time if we get EINTR */ + /* NOTE: We don't bother to account for elapsed time if we get #EINTR. */ do { #ifdef HAVE_POLL pollfd info; diff --git a/intern/openvdb/openvdb_fwd.hh b/intern/openvdb/openvdb_fwd.hh index 6d569e09590..6a2167090b9 100644 --- a/intern/openvdb/openvdb_fwd.hh +++ b/intern/openvdb/openvdb_fwd.hh @@ -4,7 +4,7 @@ #pragma once -/* Note: version header included here to enable correct forward declaration of some types. No other +/* NOTE: version header included here to enable correct forward declaration of some types. No other * OpenVDB headers should be included here, especially openvdb.h, to avoid affecting other * compilation units. */ #include diff --git a/source/blender/animrig/ANIM_action.hh b/source/blender/animrig/ANIM_action.hh index 15a4cb090d1..2f8c7fad00b 100644 --- a/source/blender/animrig/ANIM_action.hh +++ b/source/blender/animrig/ANIM_action.hh @@ -559,7 +559,7 @@ void unassign_animation(ID &animated_id); * binding, before un-assigning. This is to ensure that the stored name reflects * the actual binding that was used, making re-binding trivial. * - * \param adt the AnimData of the animated ID. + * \param adt: the AnimData of the animated ID. * * \note this does not clear the Animation pointer, just the binding handle. */ diff --git a/source/blender/animrig/intern/fcurve.cc b/source/blender/animrig/intern/fcurve.cc index be06a8190ef..3c2d31a2363 100644 --- a/source/blender/animrig/intern/fcurve.cc +++ b/source/blender/animrig/intern/fcurve.cc @@ -280,7 +280,7 @@ void initialize_bezt(BezTriple *beztr, * This is a helper function for determining whether to insert a keyframe or not * when "only insert needed" is enabled. * - * Note: this does *not* determine whether inserting the keyframe would change + * NOTE: this does *not* determine whether inserting the keyframe would change * the fcurve at points other than the keyframe itself. For example, even if * inserting the key wouldn't change the fcurve's value at the time of the * keyframe, the resulting changes to bezier interpolation could change the diff --git a/source/blender/animrig/intern/keyframing_test.cc b/source/blender/animrig/intern/keyframing_test.cc index 5c9c3fde97c..c95d7af0cee 100644 --- a/source/blender/animrig/intern/keyframing_test.cc +++ b/source/blender/animrig/intern/keyframing_test.cc @@ -308,7 +308,7 @@ TEST_F(KeyframingTest, insert_key_rna__only_available) EXPECT_EQ(0, result_1.get_count(SingleKeyingResult::SUCCESS)); /* It's unclear why AnimData and an Action should be created if keying fails - * here. It may even be undesireable. These checks are just here to ensure no + * here. It may even be undesirable. These checks are just here to ensure no * *unintentional* changes in behavior. */ ASSERT_NE(nullptr, object->adt); ASSERT_NE(nullptr, object->adt->action); diff --git a/source/blender/blenkernel/BKE_armature.hh b/source/blender/blenkernel/BKE_armature.hh index 916cddc0cec..7a2e15cdecd 100644 --- a/source/blender/blenkernel/BKE_armature.hh +++ b/source/blender/blenkernel/BKE_armature.hh @@ -189,7 +189,7 @@ void BKE_pchan_minmax(const Object *ob, * * \note This uses #BKE_pchan_minmax, see its documentation for details on bounds calculation. * - * \param use_select When true, only consider selected bones. When false, selection state is + * \param use_select: When true, only consider selected bones. When false, selection state is * ignored and all bones are included in the bounds. */ std::optional> BKE_pose_minmax(const Object *ob, bool use_select); diff --git a/source/blender/blenkernel/BKE_lib_query.hh b/source/blender/blenkernel/BKE_lib_query.hh index 5a660bea623..b1adb74b4de 100644 --- a/source/blender/blenkernel/BKE_lib_query.hh +++ b/source/blender/blenkernel/BKE_lib_query.hh @@ -287,12 +287,12 @@ void BKE_lib_query_idpropertiesForeachIDLink_callback(IDProperty *id_prop, void /** * Loop over all of the ID's this data-block links to. * - * \param bmain The Main data-base containing `owner_id`, may be null. - * \param id The ID to process. Note that currently, embedded IDs may also be passed here. - * \param callback The callback processing a given ID usage (i.e. a given ID pointer within the + * \param bmain: The Main data-base containing `owner_id`, may be null. + * \param id: The ID to process. Note that currently, embedded IDs may also be passed here. + * \param callback: The callback processing a given ID usage (i.e. a given ID pointer within the * given \a id data). - * \param user_data Opaque user data for the callback processing a given ID usage. - * \param flag Flags controlling how/which ID pointers are processed. + * \param user_data: Opaque user data for the callback processing a given ID usage. + * \param flag: Flags controlling how/which ID pointers are processed. */ void BKE_library_foreach_ID_link(Main *bmain, ID *id, @@ -315,17 +315,17 @@ void BKE_library_foreach_ID_link(Main *bmain, * initializes a #LibraryForeachIDData object with given parameters, and wraps a call to given * `subdata_foreach_id`. * - * \param bmain The Main data-base containing `owner_id`, may be null. - * \param owner_id The owner ID, i.e. the data-block owning the given sub-data (may differ from + * \param bmain: The Main data-base containing `owner_id`, may be null. + * \param owner_id: The owner ID, i.e. the data-block owning the given sub-data (may differ from * `self_id` in case the later is an embedded ID). - * \param self_id Typically the same as `owner_id`, unless it is an embedded ID. - * \param subdata_foreach_id The callback handling which data to process, and iterating over all ID - * usages of this subdata. Typically a lambda capturing that subdata, see comments above for + * \param self_id: Typically the same as `owner_id`, unless it is an embedded ID. + * \param subdata_foreach_id: The callback handling which data to process, and iterating over all + * ID usages of this subdata. Typically a lambda capturing that subdata, see comments above for * details. - * \param callback The callback processing a given ID usage, see #BKE_library_foreach_ID_link. - * \param user_data Opaque user data for the callback processing a given ID usage, see + * \param callback: The callback processing a given ID usage, see #BKE_library_foreach_ID_link. + * \param user_data: Opaque user data for the callback processing a given ID usage, see * #BKE_library_foreach_ID_link. - * \param flag Flags controlling the process, see #BKE_library_foreach_ID_link. Note that some + * \param flag: Flags controlling the process, see #BKE_library_foreach_ID_link. Note that some * flags are not accepted here (#IDWALK_RECURSE, #IDWALK_DO_INTERNAL_RUNTIME_POINTERS, * #IDWALK_DO_LIBRARY_POINTER, #IDWALK_INCLUDE_UI). */ diff --git a/source/blender/blenkernel/BKE_node_runtime.hh b/source/blender/blenkernel/BKE_node_runtime.hh index 33f3959e06f..5a8f9431974 100644 --- a/source/blender/blenkernel/BKE_node_runtime.hh +++ b/source/blender/blenkernel/BKE_node_runtime.hh @@ -299,7 +299,7 @@ class bNodeRuntime : NonCopyable, NonMovable { /** Update flags. */ int update = 0; - /** Offset that will be added to #bNote::locx for insert offset animation. */ + /** Offset that will be added to #bNode::locx for insert offset animation. */ float anim_ofsx; /** List of cached internal links (input to output), for muted nodes and operators. */ diff --git a/source/blender/blenkernel/intern/blendfile_link_append.cc b/source/blender/blenkernel/intern/blendfile_link_append.cc index af59a887c86..44b89402580 100644 --- a/source/blender/blenkernel/intern/blendfile_link_append.cc +++ b/source/blender/blenkernel/intern/blendfile_link_append.cc @@ -1032,7 +1032,7 @@ static int foreach_libblock_append_add_dependencies_callback(LibraryIDLinkCallba const BlendfileLinkAppendContextCallBack *data = static_cast(cb_data->user_data); - /* Note: In append case, all dependencies are needed in the items list, to cover potential + /* NOTE: In append case, all dependencies are needed in the items list, to cover potential * complex cases (e.g. linked data from another library referencing other IDs from the */ BlendfileLinkAppendContextItem *item = static_cast( diff --git a/source/blender/blenkernel/intern/gpencil_modifier_legacy.cc b/source/blender/blenkernel/intern/gpencil_modifier_legacy.cc index f61caedcd18..fa777b59131 100644 --- a/source/blender/blenkernel/intern/gpencil_modifier_legacy.cc +++ b/source/blender/blenkernel/intern/gpencil_modifier_legacy.cc @@ -478,8 +478,8 @@ void BKE_gpencil_modifier_copydata_generic(const GpencilModifierData *md_src, const GpencilModifierTypeInfo *mti = BKE_gpencil_modifier_get_info( GpencilModifierType(md_src->type)); - /* md_dst may have already be fully initialized with some extra allocated data, - * we need to free it now to avoid memleak. */ + /* `md_dst` may have already be fully initialized with some extra allocated data, + * we need to free it now to avoid a memory leak. */ if (mti->free_data) { mti->free_data(md_dst); } diff --git a/source/blender/blenkernel/intern/shader_fx.cc b/source/blender/blenkernel/intern/shader_fx.cc index 3692e564019..ceab162309b 100644 --- a/source/blender/blenkernel/intern/shader_fx.cc +++ b/source/blender/blenkernel/intern/shader_fx.cc @@ -159,8 +159,8 @@ void BKE_shaderfx_copydata_generic(const ShaderFxData *fx_src, ShaderFxData *fx_ { const ShaderFxTypeInfo *fxi = BKE_shaderfx_get_info(ShaderFxType(fx_src->type)); - /* fx_dst may have already be fully initialized with some extra allocated data, - * we need to free it now to avoid memleak. */ + /* `fx_dst` may have already be fully initialized with some extra allocated data, + * we need to free it now to avoid a memory leak. */ if (fxi->free_data) { fxi->free_data(fx_dst); } diff --git a/source/blender/blenlib/BLI_subprocess.hh b/source/blender/blenlib/BLI_subprocess.hh index 15cf2a2a715..e276ab54f08 100644 --- a/source/blender/blenlib/BLI_subprocess.hh +++ b/source/blender/blenlib/BLI_subprocess.hh @@ -41,7 +41,7 @@ namespace blender { * Creates a subprocess of the current Blender executable. * WARNING: This class doesn't handle subprocess destruction. * On Windows, subprocesses are closed automatically when the parent process finishes. - * On Linux, subprocesses become children of init or systemd when the parent process finishes. + * On Linux, subprocesses become children of init or SYSTEMD when the parent process finishes. */ class BlenderSubprocess : NonCopyable { private: @@ -89,7 +89,7 @@ class SharedMemory : NonCopyable { public: /** - * WARNING: The name should be unique a unique identifier accross all processes (including + * WARNING: The name should be unique a unique identifier across all processes (including * multiple Blender instances). You should include the PID of the "owner" process in the name to * prevent name collisions. * `is_owner` should only be true for the first process that creates a SharedMemory with a given @@ -116,7 +116,7 @@ class SharedMemory : NonCopyable { }; /** - * Creates or get access to a semaphore that can be used accros multiple processes. + * Creates or get access to a semaphore that can be used across multiple processes. */ class SharedSemaphore : NonCopyable { private: @@ -130,7 +130,7 @@ class SharedSemaphore : NonCopyable { public: /** - * WARNING: The name should be unique a unique identifier accross all processes (including + * WARNING: The name should be unique a unique identifier across all processes (including * multiple Blender instances). You should include the PID of the "owner" process in the name to * prevent name collisions. * `is_owner` should only be true for the last process that needs to read it (It's ok if the diff --git a/source/blender/blenlib/intern/BLI_subprocess.cc b/source/blender/blenlib/intern/BLI_subprocess.cc index bfb0dabbc5a..06017c5f574 100644 --- a/source/blender/blenlib/intern/BLI_subprocess.cc +++ b/source/blender/blenlib/intern/BLI_subprocess.cc @@ -6,7 +6,7 @@ #if BLI_SUBPROCESS_SUPPORT -/* Based on https://github.com/jarikomppa/ipc (Unlicense) */ +/* Based on https://github.com/jarikomppa/ipc (Unlicensed) */ # include "BLI_assert.h" # include "BLI_path_util.h" diff --git a/source/blender/blenloader/intern/versioning_400.cc b/source/blender/blenloader/intern/versioning_400.cc index eeecfaee81f..84531f47751 100644 --- a/source/blender/blenloader/intern/versioning_400.cc +++ b/source/blender/blenloader/intern/versioning_400.cc @@ -861,7 +861,7 @@ void do_versions_after_linking_400(FileData *fd, Main *bmain) /* No need to match the surface since shadows are disabled. */ } else if (material->blend_shadow == MA_BS_SOLID) { - /* This is already versionned an transfered to `transparent_shadows`. */ + /* This is already versioned an transferred to `transparent_shadows`. */ } else if ((material->blend_shadow == MA_BS_CLIP && material->blend_method != MA_BM_CLIP) || (material->blend_shadow == MA_BS_HASHED)) @@ -874,7 +874,7 @@ void do_versions_after_linking_400(FileData *fd, Main *bmain) continue; } - /* TODO(fclem): Check if theshold is driven or has animation. Bail out if needed? */ + /* TODO(fclem): Check if threshold is driven or has animation. Bail out if needed? */ float threshold = (material->blend_method == MA_BM_CLIP) ? material->alpha_threshold : 2.0f; diff --git a/source/blender/compositor/operations/COM_TranslateOperation.cc b/source/blender/compositor/operations/COM_TranslateOperation.cc index fc417a6fadd..4917f2b1e8f 100644 --- a/source/blender/compositor/operations/COM_TranslateOperation.cc +++ b/source/blender/compositor/operations/COM_TranslateOperation.cc @@ -61,9 +61,9 @@ void TranslateOperation::get_area_of_interest(const int input_idx, } else if (x_extend_mode_ == MemoryBufferExtend::Repeat) { /* The region of interest should consider the whole input image to avoid cropping effects, - * e.g. by prior scaling or rotating. Note: this is still consistent with immediate - * realization of transform nodes in GPU compositor, where nodes are to be evaluated from - * left to right. */ + * e.g. by prior scaling or rotating. + * NOTE: this is still consistent with immediate realization of transform nodes in GPU + * compositor, where nodes are to be evaluated from left to right. */ const int in_width = get_width(); BLI_rcti_resize_x(&r_input_area, in_width); } diff --git a/source/blender/draw/engines/eevee_next/shaders/eevee_depth_of_field_lib.glsl b/source/blender/draw/engines/eevee_next/shaders/eevee_depth_of_field_lib.glsl index 0c0c312de2e..041bfe4d9f7 100644 --- a/source/blender/draw/engines/eevee_next/shaders/eevee_depth_of_field_lib.glsl +++ b/source/blender/draw/engines/eevee_next/shaders/eevee_depth_of_field_lib.glsl @@ -218,7 +218,7 @@ CocTile dof_coc_tile_unpack(vec3 fg, vec3 bg) return tile; } -/* WORKAROUND(fclem): GLSL compilers differs in what qualifiers are requires to pass images as +/* WORKAROUND(@fclem): GLSL compilers differs in what qualifiers are requires to pass images as * parameters. Workaround by using defines. */ #define dof_coc_tile_load(tiles_fg_img_, tiles_bg_img_, texel_) \ dof_coc_tile_unpack( \ diff --git a/source/blender/draw/engines/eevee_next/shaders/eevee_shadow_page_mask_comp.glsl b/source/blender/draw/engines/eevee_next/shaders/eevee_shadow_page_mask_comp.glsl index 56b768ccd8d..7f937a10c0e 100644 --- a/source/blender/draw/engines/eevee_next/shaders/eevee_shadow_page_mask_comp.glsl +++ b/source/blender/draw/engines/eevee_next/shaders/eevee_shadow_page_mask_comp.glsl @@ -155,7 +155,7 @@ void main() for (int i = 1; i < max_view_per_tilemap; i++) { max_lod = findMSB(levels_rendered & ~(~0u << max_lod)); } - /* Note: Concurent writting of the same value to the same data. */ + /* NOTE: Concurrent writing of the same value to the same data. */ tilemaps_buf[tilemap_index].effective_lod_min = max_lod; /* Collapse all bits to highest level. */ for (int lod = 0; lod < max_lod; lod++) { @@ -177,11 +177,11 @@ void main() } } else { - /* Note: Concurent writting of the same value to the same data. */ + /* NOTE: Concurrent writing of the same value to the same data. */ tilemaps_buf[tilemap_index].effective_lod_min = 0; } #else - /* Note: Concurent writting of the same value to the same data. */ + /* NOTE: Concurrent writing of the same value to the same data. */ tilemaps_buf[tilemap_index].effective_lod_min = 0; #endif diff --git a/source/blender/draw/engines/gpencil/gpencil_engine_c.cc b/source/blender/draw/engines/gpencil/gpencil_engine_c.cc index 59ff134c588..b8cb015698b 100644 --- a/source/blender/draw/engines/gpencil/gpencil_engine_c.cc +++ b/source/blender/draw/engines/gpencil/gpencil_engine_c.cc @@ -71,7 +71,7 @@ void GPENCIL_engine_init(void *ved) GPENCIL_ViewLayerData *vldata = GPENCIL_view_layer_data_ensure(); - /* Resize and reset memblocks. */ + /* Resize and reset memory-blocks. */ BLI_memblock_clear(vldata->gp_light_pool, gpencil_light_pool_free); BLI_memblock_clear(vldata->gp_material_pool, gpencil_material_pool_free); BLI_memblock_clear(vldata->gp_object_pool, nullptr); diff --git a/source/blender/draw/engines/overlay/shaders/overlay_facing_frag.glsl b/source/blender/draw/engines/overlay/shaders/overlay_facing_frag.glsl index e0347212534..89671ac4b02 100644 --- a/source/blender/draw/engines/overlay/shaders/overlay_facing_frag.glsl +++ b/source/blender/draw/engines/overlay/shaders/overlay_facing_frag.glsl @@ -5,6 +5,6 @@ void main() { fragColor = gl_FrontFacing ? colorFaceFront : colorFaceBack; - /* Pre-multiply the output as we do not do any blending in the framebuffer. */ + /* Pre-multiply the output as we do not do any blending in the frame-buffer. */ fragColor.rgb *= fragColor.a; } diff --git a/source/blender/draw/engines/overlay/shaders/overlay_motion_path_line_vert_no_geom.glsl b/source/blender/draw/engines/overlay/shaders/overlay_motion_path_line_vert_no_geom.glsl index 87fa6e81723..427e7cb2f4e 100644 --- a/source/blender/draw/engines/overlay/shaders/overlay_motion_path_line_vert_no_geom.glsl +++ b/source/blender/draw/engines/overlay/shaders/overlay_motion_path_line_vert_no_geom.glsl @@ -99,7 +99,7 @@ void main() * - IF PrimType == LineList: base_vertex_id = quad_id*2 * - IF PrimType == LineStrip: base_vertex_id = quad_id * - * Note: Primitive is LineStrip for this shader. */ + * NOTE: Primitive is LineStrip for this shader. */ int base_vertex_id = quad_id; /* Fetch attributes for self and neighboring vertex. */ diff --git a/source/blender/editors/grease_pencil/intern/grease_pencil_add.cc b/source/blender/editors/grease_pencil/intern/grease_pencil_add.cc index 65d977fd431..42ff6786bdd 100644 --- a/source/blender/editors/grease_pencil/intern/grease_pencil_add.cc +++ b/source/blender/editors/grease_pencil/intern/grease_pencil_add.cc @@ -1203,7 +1203,7 @@ void create_stroke(Main &bmain, Object &object, const float4x4 &matrix, const in Layer &layer_lines = grease_pencil.add_layer(DATA_("Lines")); grease_pencil.set_active_layer(&layer_lines); - /* Note: We assume that this keyframe insertion can't fail. */ + /* NOTE: We assume that this keyframe insertion can't fail. */ Drawing &drawing_lines = *grease_pencil.insert_frame(layer_lines, frame_number); grease_pencil.insert_frame(layer_color, frame_number); 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 19332e36191..054cce6def3 100644 --- a/source/blender/editors/grease_pencil/intern/grease_pencil_frames.cc +++ b/source/blender/editors/grease_pencil/intern/grease_pencil_frames.cc @@ -359,7 +359,7 @@ bool ensure_active_keyframe(const Scene &scene, { /* For additive drawing, we duplicate the frame that's currently visible and insert it at the * current frame. - * Note: Also duplicate the frame when erasing, Otherwise empty drawing is added, see + * NOTE: Also duplicate the frame when erasing, Otherwise empty drawing is added, see * !119051. */ grease_pencil.insert_duplicate_frame( diff --git a/source/blender/editors/grease_pencil/intern/grease_pencil_image_render.cc b/source/blender/editors/grease_pencil/intern/grease_pencil_image_render.cc index 876923d5a55..bd9269515ee 100644 --- a/source/blender/editors/grease_pencil/intern/grease_pencil_image_render.cc +++ b/source/blender/editors/grease_pencil/intern/grease_pencil_image_render.cc @@ -361,7 +361,7 @@ void draw_dots(const IndexRange indices, const float thickness = radii[point_i] * radius_scale * radius_to_pixel_factor; immAttr4fv(attr_color, colors[point_i]); - /* Note: extra factor 0.5 for point size to match rendering. */ + /* NOTE: extra factor 0.5 for point size to match rendering. */ immAttr1f(attr_size, std::max(thickness, min_stroke_thickness) * 0.5f); immVertex3fv(attr_pos, math::transform_point(layer_to_world, positions[point_i])); } @@ -441,7 +441,7 @@ void draw_grease_pencil_strokes(const RegionView3D &rv3d, break; case GP_MATERIAL_MODE_DOT: case GP_MATERIAL_MODE_SQUARE: - /* Note: Squares don't have their own shader, render as dots too. */ + /* NOTE: Squares don't have their own shader, render as dots too. */ draw_dots( points_by_curve[stroke_i], positions, radii, colors, layer_to_world, radius_scale); break; diff --git a/source/blender/editors/include/ED_anim_api.hh b/source/blender/editors/include/ED_anim_api.hh index a3be67136f0..7fe1cadcdde 100644 --- a/source/blender/editors/include/ED_anim_api.hh +++ b/source/blender/editors/include/ED_anim_api.hh @@ -1043,7 +1043,7 @@ void ANIM_center_frame(bContext *C, int smooth_viewtx); /** * Add horizontal margin to the rectangle. * - * This function assumes that the xmin/xmax are set to a frame range to show. + * This function assumes that the X-min/X-max are set to a frame range to show. * * \return The new rectangle with horizontal margin added, for visual comfort. */ diff --git a/source/blender/editors/include/ED_grease_pencil.hh b/source/blender/editors/include/ED_grease_pencil.hh index c3f5e608c8f..f22cb1b311c 100644 --- a/source/blender/editors/include/ED_grease_pencil.hh +++ b/source/blender/editors/include/ED_grease_pencil.hh @@ -416,7 +416,7 @@ void clipboard_free(); const bke::CurvesGeometry &clipboard_curves(); /** * Paste curves from the clipboard into the drawing. - * \param paste_back Render behind existing curves by inserting curves at the front. + * \param paste_back: Render behind existing curves by inserting curves at the front. * \return Index range of the new curves in the drawing after pasting. */ IndexRange clipboard_paste_strokes(Main &bmain, diff --git a/source/blender/editors/interface/interface_handlers.cc b/source/blender/editors/interface/interface_handlers.cc index 4bb8433b72d..fb04aac94d3 100644 --- a/source/blender/editors/interface/interface_handlers.cc +++ b/source/blender/editors/interface/interface_handlers.cc @@ -1226,7 +1226,7 @@ static void ui_apply_but_TEX(bContext *C, uiBut *but, uiHandleButtonData *data) * feature used for bone renaming, channels, etc. * afterfunc frees rename_orig */ if (data->text_edit.original_string && (but->flag & UI_BUT_TEXTEDIT_UPDATE)) { - /* In this case, we need to keep origstr available, + /* In this case, we need to keep `original_string` available, * to restore real org string in case we cancel after having typed something already. */ but->rename_orig = BLI_strdup(data->text_edit.original_string); } diff --git a/source/blender/editors/interface/interface_ops.cc b/source/blender/editors/interface/interface_ops.cc index c4490c41246..00a830e4d53 100644 --- a/source/blender/editors/interface/interface_ops.cc +++ b/source/blender/editors/interface/interface_ops.cc @@ -1711,9 +1711,9 @@ int paste_property_drivers(blender::Span src_drivers, * bool to switch between exec and poll behavior. This isn't great, but seems * like the lesser evil under the circumstances. * - * \param copy_entire_array If true, copies drivers of all elements of an array + * \param copy_entire_array: If true, copies drivers of all elements of an array * property. Otherwise only copies one specific element. - * \param poll If true, only checks if the driver(s) could be copied rather than + * \param poll: If true, only checks if the driver(s) could be copied rather than * actually performing the copy. * * \returns true in exec mode if any copies were successfully made, and false diff --git a/source/blender/editors/sculpt_paint/grease_pencil_paint.cc b/source/blender/editors/sculpt_paint/grease_pencil_paint.cc index 1f747f8de46..b0b89ea5bb5 100644 --- a/source/blender/editors/sculpt_paint/grease_pencil_paint.cc +++ b/source/blender/editors/sculpt_paint/grease_pencil_paint.cc @@ -204,7 +204,7 @@ struct PaintOperationExecutor { /** * Creates a new curve with one point at the beginning or end. - * Note: Does not initialize the new curve or points. + * \note Does not initialize the new curve or points. */ static void create_blank_curve(bke::CurvesGeometry &curves, const bool on_back) { @@ -248,7 +248,7 @@ struct PaintOperationExecutor { /** * Extends the first or last curve by `new_points_num` number of points. - * Note: Does not initialize the new points. + * \note Does not initialize the new points. */ static void extend_curve(bke::CurvesGeometry &curves, const bool on_back, diff --git a/source/blender/editors/sculpt_paint/sculpt_intern.hh b/source/blender/editors/sculpt_paint/sculpt_intern.hh index 6a921c20061..1b628d41f1a 100644 --- a/source/blender/editors/sculpt_paint/sculpt_intern.hh +++ b/source/blender/editors/sculpt_paint/sculpt_intern.hh @@ -461,7 +461,10 @@ struct StrokeCache { float4x4 symm_rot_mat; float4x4 symm_rot_mat_inv; - /* Accumulate mode. Note: inverted for SCULPT_TOOL_DRAW_SHARP. */ + /** + * Accumulate mode. + * \note inverted for #SCULPT_TOOL_DRAW_SHARP. + */ bool accum; float3 anchored_location; diff --git a/source/blender/editors/space_sequencer/sequencer_view.cc b/source/blender/editors/space_sequencer/sequencer_view.cc index a7d26eaffac..f30dc5bbff3 100644 --- a/source/blender/editors/space_sequencer/sequencer_view.cc +++ b/source/blender/editors/space_sequencer/sequencer_view.cc @@ -358,8 +358,7 @@ static void seq_view_collection_rect_timeline(const bContext *C, if (orig_height > timeline_ymax - timeline_ymin) { /* Do nothing, we can't align the viewport any better if we - * are zoomed out futher than the current timeline bounds. - */ + * are zoomed out further than the current timeline bounds. */ return; } diff --git a/source/blender/gpu/metal/mtl_immediate.mm b/source/blender/gpu/metal/mtl_immediate.mm index a07bbcaa80d..70ccb855e28 100644 --- a/source/blender/gpu/metal/mtl_immediate.mm +++ b/source/blender/gpu/metal/mtl_immediate.mm @@ -184,7 +184,7 @@ void MTLImmediate::end() * - Converting from a normalized short2 format to float2 * - Type truncation e.g. Float4 to Float2. * - Type expansion from Float3 to Float4. - * - Note: extra components are filled with the corresponding components of (0,0,0,1). + * - NOTE: extra components are filled with the corresponding components of (0,0,0,1). * (See * https://developer.apple.com/documentation/metal/mtlvertexattributedescriptor/1516081-format) */ diff --git a/source/blender/gpu/shaders/gpu_shader_sequencer_strips_frag.glsl b/source/blender/gpu/shaders/gpu_shader_sequencer_strips_frag.glsl index 71ff97d4aa3..89ea3f907f7 100644 --- a/source/blender/gpu/shaders/gpu_shader_sequencer_strips_frag.glsl +++ b/source/blender/gpu/shaders/gpu_shader_sequencer_strips_frag.glsl @@ -137,7 +137,7 @@ void main() } } - /* Outside of strip rounded rect? */ + /* Outside of strip rounded rectangle? */ if (sdf > 0.0) { col = vec4(0.0); } @@ -147,7 +147,7 @@ void main() bool selected = (strip.flags & GPU_SEQ_FLAG_SELECTED) != 0; vec4 col_outline = unpackUnorm4x8(strip.col_outline); if (selected) { - /* Inset 1px line with backround color. */ + /* Inset 1px line with background color. */ col = add_outline(sdf, 0.0, 1.0, col, unpackUnorm4x8(context_data.col_back)); /* 2x wide outline. */ col = add_outline(sdf, 0.5, -0.5, col, col_outline); diff --git a/source/blender/imbuf/intern/transform.cc b/source/blender/imbuf/intern/transform.cc index 7f12507abfc..302914bbd23 100644 --- a/source/blender/imbuf/intern/transform.cc +++ b/source/blender/imbuf/intern/transform.cc @@ -297,7 +297,8 @@ static void process_scanlines(const TransformContext &ctx, IndexRange y_range) } } else { - /* One sample per pixel. Note: sample at pixel center for proper filtering. */ + /* One sample per pixel. + * NOTE: sample at pixel center for proper filtering. */ float2 uv_start = ctx.start_uv + ctx.add_x * 0.5f + ctx.add_y * 0.5f; for (int yi : y_range) { T *output = init_pixel_pointer(ctx.dst, ctx.dst_region_x_range.first(), yi); diff --git a/source/blender/io/usd/intern/usd_light_convert.cc b/source/blender/io/usd/intern/usd_light_convert.cc index 2339ea37e04..c78822b0584 100644 --- a/source/blender/io/usd/intern/usd_light_convert.cc +++ b/source/blender/io/usd/intern/usd_light_convert.cc @@ -42,12 +42,13 @@ static const pxr::TfToken texture_file("texture:file", pxr::TfToken::Immortal); namespace { -/* If the given attribute has an authored value, return its value in the r_value +/** + * If the given attribute has an authored value, return its value in the r_value * out parameter. * * We wish to support older UsdLux APIs in older versions of USD. For example, - * in previous versions of the API, shader input attibutes did not have the - * "inputs:" prefix. One can provide the older input attibute name in the + * in previous versions of the API, shader input attributes did not have the + * "inputs:" prefix. One can provide the older input attribute name in the * 'fallback_attr_name' argument, and that attribute will be queried if 'attr' * doesn't exist or doesn't have an authored value. */ @@ -74,8 +75,10 @@ bool get_authored_value(const pxr::UsdAttribute &attr, return false; } -/* Helper struct for retrieving shader information when traversing a world material - * node chain, provided as user data for bke::nodeChainIter(). */ +/** + * Helper struct for retrieving shader information when traversing a world material + * node chain, provided as user data for #bke::nodeChainIter(). + */ struct WorldNtreeSearchResults { const blender::io::usd::USDExportParams ¶ms; pxr::UsdStageRefPtr stage; @@ -102,9 +105,11 @@ struct WorldNtreeSearchResults { namespace blender::io::usd { -/* If the given path already exists on the given stage, return the path with - * a numerical suffix appende to the name that ensures the path is unique. If - * the path does not exist on the stage, it will be returned unchanged. */ +/** + * If the given path already exists on the given stage, return the path with + * a numerical suffix appended to the name that ensures the path is unique. If + * the path does not exist on the stage, it will be returned unchanged. + */ static pxr::SdfPath get_unique_path(pxr::UsdStageRefPtr stage, const std::string &path) { std::string unique_path = path; @@ -115,8 +120,10 @@ static pxr::SdfPath get_unique_path(pxr::UsdStageRefPtr stage, const std::string return pxr::SdfPath(unique_path); } -/* Load the image at the given path. Handle packing and copying based in the import options. - * Return the opened image on succsss or a nullptr on failure. */ +/** + * Load the image at the given path. Handle packing and copying based in the import options. + * Return the opened image on success or a nullptr on failure. + */ static Image *load_image(std::string tex_path, Main *bmain, const USDImportParams ¶ms) { /* Optionally copy the asset if it's inside a USDZ package. */ @@ -181,9 +188,11 @@ static bNode *append_node(bNode *dst_node, return src_node; } -/* Callback function for iterating over a shader node chain to retrieve data +/** + * Callback function for iterating over a shader node chain to retrieve data * necessary for converting a world material to a USD dome light. It also - * handles copying textures, if required. */ + * handles copying textures, if required. + */ static bool node_search(bNode *fromnode, bNode * /* tonode */, void *userdata, @@ -247,8 +256,10 @@ static bool node_search(bNode *fromnode, return true; } -/* If the Blender scene has an environment texture, - * export it as a USD dome light. */ +/** + * If the Blender scene has an environment texture, + * export it as a USD dome light. + */ void world_material_to_dome_light(const USDExportParams ¶ms, const Scene *scene, pxr::UsdStageRefPtr stage) diff --git a/source/blender/io/usd/intern/usd_writer_material.cc b/source/blender/io/usd/intern/usd_writer_material.cc index c6f1ce19de6..cf9f970ec77 100644 --- a/source/blender/io/usd/intern/usd_writer_material.cc +++ b/source/blender/io/usd/intern/usd_writer_material.cc @@ -1164,7 +1164,7 @@ static pxr::SdfPath reflow_materialx_paths(pxr::SdfPath input_path, return input_path.ReplacePrefix(temp_path, target_path); } -/* Exports the material as a MaterialX nodegraph within the USD layer. */ +/* Exports the material as a MaterialX node-graph within the USD layer. */ static void create_usd_materialx_material(const USDExporterContext &usd_export_context, pxr::SdfPath usd_path, Material *material, diff --git a/source/blender/makesdna/DNA_object_types.h b/source/blender/makesdna/DNA_object_types.h index f1f2901638f..20d76e4a556 100644 --- a/source/blender/makesdna/DNA_object_types.h +++ b/source/blender/makesdna/DNA_object_types.h @@ -437,7 +437,7 @@ typedef struct ObHook { /** * This is used as a flag for many kinds of data that use selections, examples include: * - #BezTriple.f1, #BezTriple.f2, #BezTriple.f3 - * - #bNote.flag + * - #bNode.flag * - #MovieTrackingTrack.flag * And more, ideally this would have a generic location. */ diff --git a/source/blender/nodes/shader/materialx/node_item.cc b/source/blender/nodes/shader/materialx/node_item.cc index d9025ffd20d..6aab7039677 100644 --- a/source/blender/nodes/shader/materialx/node_item.cc +++ b/source/blender/nodes/shader/materialx/node_item.cc @@ -764,8 +764,8 @@ NodeItem NodeItem::create_node(const std::string &category, Type type) const std::string type_str = this->type(type); CLOG_INFO(LOG_MATERIALX_SHADER, 2, "<%s type=%s>", category.c_str(), type_str.c_str()); NodeItem res = empty(); - /* Surfaceshader nodes and materials are added directly to the document, - * otherwise to thenodegraph */ + /* Surface-shader nodes and materials are added directly to the document, + * otherwise to the node-graph. */ if (type == Type::SurfaceShader || type == Type::Material) { res.node = graph_->getDocument()->addNode(category, MaterialX::EMPTY_STRING, type_str); } diff --git a/source/blender/python/intern/bpy_library_load.cc b/source/blender/python/intern/bpy_library_load.cc index 4f97721fbf3..f4c970dcc99 100644 --- a/source/blender/python/intern/bpy_library_load.cc +++ b/source/blender/python/intern/bpy_library_load.cc @@ -477,7 +477,7 @@ static PyObject *bpy_lib_exit(BPy_Library *self, PyObject * /*args*/) BlendfileLinkAppendContext *lapp_context = BKE_blendfile_link_append_context_new( &liblink_params); - /* Note: Transfers the ownership of the `blo_handle` to the `lapp_context`. */ + /* NOTE: Transfers the ownership of the `blo_handle` to the `lapp_context`. */ BKE_blendfile_link_append_context_library_add(lapp_context, self->abspath, self->blo_handle); self->blo_handle = nullptr; diff --git a/source/blender/sequencer/SEQ_utils.hh b/source/blender/sequencer/SEQ_utils.hh index 66e030e8d30..2435fc434b0 100644 --- a/source/blender/sequencer/SEQ_utils.hh +++ b/source/blender/sequencer/SEQ_utils.hh @@ -63,8 +63,8 @@ namespace blender::seq { * Results of the query for this strip will be cached into #MediaPresence cache. The cache * will be created on demand. * - * \param scene Scene to query. - * \param seq Sequencer strip. + * \param scene: Scene to query. + * \param seq: Sequencer strip. * \return True if media file is missing. */ bool media_presence_is_missing(Scene *scene, const Sequence *seq); diff --git a/tools/check_source/check_spelling_config.py b/tools/check_source/check_spelling_config.py index 9cd333f8881..679719b2196 100644 --- a/tools/check_source/check_spelling_config.py +++ b/tools/check_source/check_spelling_config.py @@ -48,6 +48,7 @@ dict_custom = { "atomicity", "attachmentless", "attenuations", + "backends", "backlit", "bindless", "bitwise", @@ -345,6 +346,7 @@ dict_custom = { "resyncing", "retarget", "retiming", + "reupload", "reusability", "rotationally", "saveable", @@ -372,6 +374,8 @@ dict_custom = { "submenu", "submenus", "suboptimally", + "subprocess", + "subprocesses", "subrange", "subtractive", "subtype",