Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2025-01-20 11:19:23 +11:00
parent 05efd19982
commit 90b03d2344
14 changed files with 33 additions and 31 deletions

View file

@ -751,7 +751,7 @@ class SEQUENCER_MT_add(Menu):
col = layout.column()
col.menu("SEQUENCER_MT_add_transitions", icon='ARROW_LEFTRIGHT')
# Enable for video transitions or sound crossfade.
# Enable for video transitions or sound cross-fade.
col.enabled = nonsound == 2 or (nonsound == 0 and total == 2)
col = layout.column()

View file

@ -28,7 +28,7 @@ void pose_apply_action_all_bones(Object *ob,
const AnimationEvalContext *anim_eval_context);
/**
* Evaluate the action and blend the result into the curent pose based on `blend_factor`.
* Evaluate the action and blend the result into the current pose based on `blend_factor`.
* Only FCurves that relate to selected bones are evaluated.
*/
void pose_apply_action_blend(Object *ob,

View file

@ -53,8 +53,10 @@ struct BoneInstanceData {
BoneInstanceData() = default;
/* Constructor used by metaball overlays and expected to be used for drawing
* metaball edit circles with armature wire shader that produces wide-lines. */
/**
* Constructor used by meta-ball overlays and expected to be used for drawing
* meta-ball edit circles with armature wire shader that produces wide-lines.
*/
BoneInstanceData(const float4x4 &ob_mat,
const float3 &pos,
const float radius,
@ -143,11 +145,11 @@ struct State {
bool hide_overlays = false;
bool xray_enabled = false;
bool xray_enabled_and_not_wire = false;
/* Can be true even if Xray Alpha is 1.0. */
/** Can be true even if X-ray Alpha is 1.0. */
bool xray_flag_enabled = false;
/* Brings the active pose armature in front of all objects. */
/** Brings the active pose armature in front of all objects. */
bool do_pose_xray = false;
/* Add a veil on top of all surfaces to make the active pose armature pop out. */
/** Add a veil on top of all surfaces to make the active pose armature pop out. */
bool do_pose_fade_geom = false;
float xray_opacity = 0.0f;
short v3d_flag = 0; /* TODO: move to #View3DOverlay. */
@ -157,7 +159,7 @@ struct State {
float3 camera_forward = float3(0.0f);
int clipping_plane_count = 0;
/* Active Image properties. Only valid image space only. */
/** Active Image properties. Only valid image space only. */
bool is_image_valid = false;
int2 image_size = int2(0);
float2 image_uv_aspect = float2(0.0f);
@ -173,17 +175,17 @@ struct State {
/** Convenience functions. */
/* Scene geometry is solid. Occlude overlays behind scene geometry. */
/** Scene geometry is solid. Occlude overlays behind scene geometry. */
bool is_solid() const
{
return xray_opacity == 1.0f;
}
/* Scene geometry is semi-transparent. Fade overlays behind scene geometry (see #XrayFade). */
/** Scene geometry is semi-transparent. Fade overlays behind scene geometry (see #XrayFade). */
bool is_xray() const
{
return (xray_opacity < 1.0f) && (xray_opacity > 0.0f);
}
/* Scene geometry is fully transparent. Scene geometry does not occlude overlays. */
/** Scene geometry is fully transparent. Scene geometry does not occlude overlays. */
bool is_wire() const
{
return xray_opacity == 0.0f;

View file

@ -1416,7 +1416,7 @@ static void VIEW2D_OT_zoom(wmOperatorType *ot)
* -# RIGHTMOUSE - zoom out of view
*
* Currently, these key mappings are hardcoded, but it shouldn't be too important to
* have custom keymappings for this.
* have custom key-mappings for this.
* \{ */
static int view_borderzoom_exec(bContext *C, wmOperator *op)

View file

@ -1255,7 +1255,7 @@ static void opengl_render_startjob(void *customdata, wmJobWorkerStatus *worker_s
}
if (canceled) {
/* Cancel task pool writing images async. */
/* Cancel task pool writing images asynchronously. */
oglrender->pool_ok = false;
}
}

View file

@ -358,7 +358,7 @@ static void outliner_header_region_listener(const wmRegionListenerParams *params
ED_region_tag_redraw(region);
break;
case ND_LAYER:
/* Not needed by blender itself, but requested by Addon devs. #109995 */
/* Not needed by blender itself, but requested by add-on developers. #109995 */
if ((wmn->subtype == NS_LAYER_COLLECTION) && (wmn->action == NA_ACTIVATED)) {
ED_region_tag_redraw(region);
}

View file

@ -460,12 +460,12 @@ void VKCommandBuilder::send_pipeline_barriers(VKCommandBufferInterface &command_
VkPipelineStageFlagBits(barrier.src_stage_mask);
VkPipelineStageFlags dst_stage_mask = barrier.dst_stage_mask;
// TODO: this should be done during barrier extraction making within_rendering obsolete.
/* TODO: this should be done during barrier extraction making within_rendering obsolete. */
if (within_rendering) {
/* See: VUID - vkCmdPipelineBarrier - srcStageMask - 09556
* If vkCmdPipelineBarrier is called within a render pass instance started with
* vkCmdBeginRendering, this command must only specify framebuffer-space stages in
* srcStageMask and dstStageMask */
/* See: VUID - `vkCmdPipelineBarrier` - `srcStageMask` - 09556
* If `vkCmdPipelineBarrier` is called within a render pass instance started with
* `vkCmdBeginRendering`, this command must only specify frame-buffer-space stages in
* `srcStageMask` and `dstStageMask`. */
src_stage_mask = dst_stage_mask = VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT |
VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT |
VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT |

View file

@ -167,7 +167,7 @@ class VKCommandBuilder {
/** Barriers that will be recorded after a group is recorded. */
Vector<Barriers> group_post_barriers_;
/**
* Barriers that will be recorded just befor the commands of a specific node are recorded. The
* Barriers that will be recorded just before the commands of a specific node are recorded. The
* barriers are stored per NodeHandle and in the same order as `Span<NodeHandle> nodes`.
*/
Vector<Barriers> node_pre_barriers_;

View file

@ -190,7 +190,7 @@ void VKDescriptorSetTracker::bind_input_attachment_resource(
VK_REMAINING_ARRAY_LAYERS});
}
else {
/* Fallback to renderpasses / subpasses. */
/* Fallback to render-passes / sub-passes. */
bind_image(VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT,
VK_NULL_HANDLE,
texture->image_view_get(resource_binding.arrayed, VKImageViewFlags::NO_SWIZZLING)

View file

@ -95,9 +95,9 @@ else()
)
endif()
# OpenImageIO headers include Imath headers when there is no SSE support for
# OpenImageIO headers include `Imath` headers when there is no SSE support for
# matrix operations. This depends on the specific architecture and compiler
# flags, most reliable is to always include the Imath headers if we have them.
# flags, most reliable is to always include the `Imath` headers if we have them.
if(DEFINED IMATH_INCLUDE_DIRS)
list(APPEND INC_SYS
${IMATH_INCLUDE_DIRS}

View file

@ -44,9 +44,9 @@ if(WITH_IMAGE_OPENEXR)
)
endif()
# OpenImageIO headers include Imath headers when there is no SSE support for
# OpenImageIO headers include `Imath` headers when there is no SSE support for
# matrix operations. This depends on the specific architecture and compiler
# flags, most reliable is to always include the Imath headers if we have them.
# flags, most reliable is to always include the `Imath` headers if we have them.
if(DEFINED IMATH_INCLUDE_DIRS)
list(APPEND INC_SYS
${IMATH_INCLUDE_DIRS}

View file

@ -287,9 +287,9 @@ static AVFormatContext *init_format_context_vpx_workarounds(const char *filepath
return nullptr;
}
/* By default ffmpeg uses built-in VP8/VP9 decoders, however those do not detect
* alpha channel (see ffmpeg trac issue #8344 https://trac.ffmpeg.org/ticket/8344).
* The trick for VP8/VP9 is to explicitly force use of libvpx decoder.
/* By default FFMPEG uses built-in VP8/VP9 decoders, however those do not detect
* alpha channel (see FFMPEG issue #8344 https://trac.ffmpeg.org/ticket/8344).
* The trick for VP8/VP9 is to explicitly force use of LIBVPX decoder.
* Only do this where alpha_mode=1 metadata is set. Note that in order to work,
* the previously initialized format context must be closed and a fresh one
* with explicitly requested codec must be created. */
@ -373,7 +373,7 @@ static int startffmpeg(MovieReader *anim)
anim->frame_rate = av_guess_frame_rate(pFormatCtx, video_stream, nullptr);
if (anim->never_seek_decode_one_frame) {
/* Files that need this workaround have nonsensical frame rates too, resulting
* in "millions of frames" if done through regular math. Treat framerate as 24/1 instead. */
* in "millions of frames" if done through regular math. Treat frame-rate as 24/1 instead. */
anim->frame_rate = {24, 1};
}
int frs_num = anim->frame_rate.num;

View file

@ -383,7 +383,7 @@ void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop,
* for the `0`-indexed item of the array.
*
* The maximum #len depends on the type of the DNA member, and the #booleanbit value. The left-most
* bit is not usable (because bitshift operations over signed negative values are typically
* bit is not usable (because bit-shift operations over signed negative values are typically
* 'arithmetic', and not 'bitwise', in C++). So e.g. `31` for an `int32_t` with a `booleanbit`
* value of `1 << 0`, and so on.
*/

View file

@ -471,7 +471,7 @@ if(WITH_PYTHON)
install(
FILES ${CMAKE_SOURCE_DIR}/scripts/site/sitecustomize.py
DESTINATION ${TARGETDIR_VER}/scripts/startup
# Rename to avoid conflict with system sitecustomize.py
# Rename to avoid conflict with system `sitecustomize.py`.
RENAME bpy_site_customize.py
)
elseif(WITH_PYTHON_INSTALL)