Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2023-09-08 16:58:00 +10:00
parent 4fc5d287ac
commit 9e41eccc6e
24 changed files with 45 additions and 41 deletions

View File

@ -202,7 +202,7 @@ bool metalrt_shadow_all_hit(constant KernelParamsMetal &launch_params_metal,
type = segment.type;
prim = segment.prim;
/* Filter out curve endcaps */
/* Filter out curve end-caps. */
if (u == 0.0f || u == 1.0f) {
/* continue search */
return true;
@ -349,7 +349,7 @@ inline TReturnType metalrt_visibility_test(
if (intersection_type == METALRT_HIT_BOUNDING_BOX &&
(type == PRIMITIVE_CURVE_THICK || type == PRIMITIVE_CURVE_RIBBON))
{
/* Filter out curve endcaps. */
/* Filter out curve end-caps. */
if (u == 0.0f || u == 1.0f) {
result.accept = false;
result.continue_search = true;

View File

@ -83,7 +83,7 @@ class _BPyOpsSubModOp:
return _op_poll(self.idname_py(), C_exec)
def idname(self):
# submod.foo -> SUBMOD_OT_foo
# `submod.foo` -> `SUBMOD_OT_foo`.
return self._module.upper() + "_OT_" + self._func
def idname_py(self):

View File

@ -867,7 +867,7 @@ class VIEW3D_PT_tools_weight_gradient(Panel, View3DPaintPanel):
@classmethod
def poll(cls, context):
# since we dont give context above, check mode here (to not show in other modes like sculpt)
# since we don't give context above, check mode here (to not show in other modes like sculpt).
if context.mode != 'PAINT_WEIGHT':
return False
settings = context.tool_settings.weight_paint

View File

@ -2879,7 +2879,7 @@ static void nlastrip_evaluate_meta(const int evaluation_mode,
/* Assert currently supported modes. If new mode added, then assertion marks potentially missed
* area.
*
* NOTE: In the future if support is ever added to metastrips to support nested tracks, then
* NOTE: In the future if support is ever added to meta-strips to support nested tracks, then
* STRIP_EVAL_BLEND and STRIP_EVAL_BLEND_GET_INVERTED_LOWER_SNAPSHOT cases are no longer
* equivalent. The output of nlastrips_ctime_get_strip() may return a list of strips. The only
* case difference should be the evaluation order.

View File

@ -3317,7 +3317,7 @@ static void lib_link_all(FileData *fd, Main *bmain)
/* Some data that should be persistent, like the 3DCursor or the tool settings, are
* stored in IDs affected by undo, like Scene. So this requires some specific handling. */
/* NOTE: even though the ID may have been detected as unchanged, the 'undo_preserve' may have
* to actually change some of its ID pointers, it's e.g. the case with Scene's toolsettings
* to actually change some of its ID pointers, it's e.g. the case with Scene's tool-settings
* Brush/Palette pointers. This is the case where both new and old ID may be the same. */
if (id_type->blend_read_undo_preserve != nullptr) {
BLI_assert(fd->flags & FD_FLAGS_IS_MEMFILE);

View File

@ -205,10 +205,9 @@ bool BLO_memfile_write_file(MemFile *memfile, const char *filepath)
int file, oflags;
/* NOTE: This is currently used for auto-save and `quit.blend`,
* where _not_ following symlinks is OK,
* where _not_ following symbolic-links is OK,
* however if this is ever executed explicitly by the user,
* we may want to allow writing to symlinks.
*/
* we may want to allow writing to symbolic-links. */
oflags = O_BINARY | O_WRONLY | O_CREAT | O_TRUNC;
#ifdef O_NOFOLLOW

View File

@ -1060,7 +1060,7 @@ static bNodeSocket *version_make_socket_stub(const char *idname,
/* Note: technically socket values can store ref-counted ID pointers, but at this stage the
* refcount can be ignored. It gets recomputed after lib-linking for all ID pointers. Socket
* values don't have allocated data, so a simple dupalloc works here. */
* values don't have allocated data, so a simple duplication works here. */
socket->default_value = default_value ? MEM_dupallocN(default_value) : nullptr;
socket->prop = prop ? IDP_CopyProperty(prop) : nullptr;

View File

@ -626,7 +626,7 @@ void do_versions_after_linking_290(FileData * /*fd*/, Main *bmain)
}
if (!MAIN_VERSION_FILE_ATLEAST(bmain, 292, 8)) {
/* Systematically rebuild posebones to ensure consistent ordering matching the one of bones in
/* Systematically rebuild pose-bones to ensure consistent ordering matching the one of bones in
* Armature obdata. */
LISTBASE_FOREACH (Object *, ob, &bmain->objects) {
if (ob->type == OB_ARMATURE) {

View File

@ -73,7 +73,7 @@ static void version_composite_nodetree_null_id(bNodeTree *ntree, Scene *scene)
}
}
/* Move bonegroup color to the individual bones. */
/* Move bone-group color to the individual bones. */
static void version_bonegroup_migrate_color(Main *bmain)
{
using PoseSet = blender::Set<bPose *>;
@ -91,14 +91,14 @@ static void version_bonegroup_migrate_color(Main *bmain)
/* There is no guarantee that the current state of poses is in sync with the Armature data.
*
* NOTE: No need to handle user refcounting in readfile code. */
* NOTE: No need to handle user reference-counting in readfile code. */
BKE_pose_ensure(bmain, ob, arm, false);
PoseSet &pose_set = armature_poses.lookup_or_add_default(arm);
pose_set.add(ob->pose);
}
/* Move colors from the pose's bonegroup to either the armature bones or the
/* Move colors from the pose's bone-group to either the armature bones or the
* pose bones, depending on how many poses use the Armature. */
for (const PoseSet &pose_set : armature_poses.values()) {
/* If the Armature is shared, the bone group colors might be different, and thus they have to

View File

@ -405,11 +405,14 @@ struct VelocityObjectIndex {
BLI_STATIC_ASSERT_ALIGN(VelocityObjectIndex, 16)
struct VelocityGeometryIndex {
/** Offset inside #VelocityGeometryBuf for each timestep. Indexed using eVelocityStep. */
/** Offset inside #VelocityGeometryBuf for each time-step. Indexed using eVelocityStep. */
packed_int3 ofs;
/** If true, compute deformation motion blur. */
bool1 do_deform;
/** Length of data inside #VelocityGeometryBuf for each timestep. Indexed using eVelocityStep. */
/**
* Length of data inside #VelocityGeometryBuf for each time-step.
* Indexed using eVelocityStep.
*/
packed_int3 len;
int _pad0;
@ -861,9 +864,9 @@ struct ShadowPagesInfoData {
int page_alloc_count;
/** Index of the next cache page in the cached page buffer. */
uint page_cached_next;
/** Index of the first page in the buffer since the last defrag. */
/** Index of the first page in the buffer since the last defragment. */
uint page_cached_start;
/** Index of the last page in the buffer since the last defrag. */
/** Index of the last page in the buffer since the last defragment. */
uint page_cached_end;
int _pad0;

View File

@ -1,6 +1,6 @@
/**
* Virtual shadowmapping: Usage tagging
* Virtual shadow-mapping: Usage tagging
*
* Shadow pages are only allocated if they are visible.
* This pass scans all volume froxels and tags tiles needed for shadowing.

View File

@ -623,9 +623,9 @@ bool ED_autokeyframe_pchan(
bContext *C, Scene *scene, Object *ob, bPoseChannel *pchan, KeyingSet *ks);
/**
* Use for auto-key-framing
* Use for auto-key-framing.
* \param only_if_property_keyed: if true, auto-key-framing only creates keyframes on already keyed
* properties. This is by design when using buttons. For other callers such as gizmos or VSE
* properties. This is by design when using buttons. For other callers such as gizmos or sequencer
* preview transform, creating new animation/keyframes also on non-keyed properties is desired.
*/
bool ED_autokeyframe_property(bContext *C,

View File

@ -1449,7 +1449,7 @@ static int constraint_delete_exec(bContext *C, wmOperator *op)
/* free the constraint */
if (BKE_constraint_remove_ex(lb, ob, con, true)) {
/* needed to set the flags on posebones correctly */
/* Needed to set the flags on pose-bones correctly. */
ED_object_constraint_update(bmain, ob);
/* relations */
@ -1539,7 +1539,7 @@ static int constraint_apply_exec(bContext *C, wmOperator *op)
/* Update for any children that may get moved. */
DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM);
/* Needed to set the flags on posebones correctly. */
/* Needed to set the flags on pose-bones correctly. */
ED_object_constraint_update(bmain, ob);
DEG_relations_tag_update(bmain);
@ -1639,7 +1639,7 @@ static int constraint_copy_exec(bContext *C, wmOperator *op)
BLI_assert(current_index >= 0);
BLI_listbase_link_move(constraints, copy_con, new_index - current_index);
/* Needed to set the flags on posebones correctly. */
/* Needed to set the flags on pose-bones correctly. */
ED_object_constraint_update(bmain, ob);
DEG_relations_tag_update(bmain);

View File

@ -1006,8 +1006,8 @@ float ED_vgroup_vert_weight(Object *ob, bDeformGroup *dg, int vertnum)
void ED_vgroup_select_by_name(Object *ob, const char *name)
{
/* NOTE: actdef==0 signals on painting to create a new one,
* if a bone in posemode is selected */
/* NOTE: `actdef == 0` signals on painting to create a new one,
* if a bone in pose-mode is selected. */
BKE_object_defgroup_active_index_set(ob, BKE_object_defgroup_name_index(ob, name) + 1);
}

View File

@ -36,7 +36,7 @@ void TreeElementIDArmature::expand(SpaceOutliner &space_outliner) const
expand_edit_bones();
}
else {
/* do not extend Armature when we have posemode */
/* Do not extend Armature when we have pose-mode. */
TreeStoreElem *tselem = TREESTORE(legacy_te_.parent);
if (TSE_IS_REAL_ID(tselem) && GS(tselem->id->name) == ID_OB &&
((Object *)tselem->id)->mode & OB_MODE_POSE)

View File

@ -3313,9 +3313,9 @@ static int sequencer_set_range_to_strips_exec(bContext *C, wmOperator *op)
if (seq->flag & SELECT) {
selected = true;
sfra = min_ii(sfra, SEQ_time_left_handle_frame_get(scene, seq));
/* Offset of -1 is needed because in VSE every frame has width. Range from 1 to 1 is drawn
* as range 1 to 2, because 1 frame long strip starts at frame 1 and ends at frame 2.
* See #106480. */
/* Offset of -1 is needed because in the sequencer every frame has width.
* Range from 1 to 1 is drawn as range 1 to 2, because 1 frame long strip starts at frame 1
* and ends at frame 2. See #106480. */
efra = max_ii(efra, SEQ_time_right_handle_frame_get(scene, seq) - 1);
}
}

View File

@ -2032,7 +2032,7 @@ bool initTransform(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *eve
initSnapSpatial(t, t->snap_spatial, &t->snap_spatial_precision);
/* EVIL! posemode code can switch translation to rotate when 1 bone is selected.
/* EVIL! pose-mode code can switch translation to rotate when 1 bone is selected.
* will be removed (ton) */
/* EVIL2: we gave as argument also texture space context bit... was cleared */

View File

@ -1302,7 +1302,7 @@ static void recalcData_edit_armature(TransInfo *t)
/**
* if pose bone (partial) selected, copy data.
* context; posemode armature, with mirror editing enabled.
* context; pose-mode armature, with mirror editing enabled.
*/
static void pose_transform_mirror_update(TransInfo *t, TransDataContainer *tc, Object *ob)
{
@ -1440,7 +1440,7 @@ static void recalcData_pose(TransInfo *t)
}
}
else if (ob->mode == OB_MODE_POSE) {
/* actually support TFM_BONESIZE in posemode as well */
/* Actually support #TFM_BONESIZE in pose-mode as well. */
DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
bPose *pose = ob->pose;
if (arm->flag & ARM_MIRROR_EDIT || pose->flag & POSE_MIRROR_EDIT) {

View File

@ -675,7 +675,7 @@ struct ShaderCreateInfo {
}
/**
* Allows to fetch framebuffer values from previous render sub-pass.
* Allows to fetch frame-buffer values from previous render sub-pass.
*
* On Apple Silicon, the additional `raster_order_group` is there to set the sub-pass
* dependencies. Any sub-pass input need to have the same `raster_order_group` defined in the

View File

@ -638,7 +638,7 @@ std::string GLShader::fragment_interface_declare(const ShaderCreateInfo &info) c
if (epoxy_has_gl_extension("GL_ARB_conservative_depth")) {
ss << "layout(" << to_string(info.depth_write_) << ") out float gl_FragDepth;\n";
}
ss << "\n/* Subpass Inputs. */\n";
ss << "\n/* Sub-pass Inputs. */\n";
for (const ShaderCreateInfo::SubpassIn &input : info.subpass_inputs_) {
/* TODO(fclem): Add GL_EXT_shader_framebuffer_fetch support and fallback using imageLoad.
* For now avoid compilation failure. */

View File

@ -31,7 +31,7 @@ struct SpaceLink;
/* Motion Paths ------------------------------------ */
/* (used for Pose Channels and Objects) */
/* Data point for motion path (mpv) */
/** Data point for motion path (`mpv`). */
typedef struct bMotionPathVert {
/** Coordinates of point in 3D-space. */
float co[3];
@ -39,7 +39,7 @@ typedef struct bMotionPathVert {
int flag;
} bMotionPathVert;
/* bMotionPathVert->flag */
/** #bMotionPathVert::flag */
typedef enum eMotionPathVert_Flag {
/* vert is selected */
MOTIONPATH_VERT_SEL = (1 << 0),
@ -391,10 +391,10 @@ typedef enum ePchan_Flag {
typedef enum ePchan_ConstFlag {
PCHAN_HAS_IK = (1 << 0),
PCHAN_HAS_CONST = (1 << 1),
/* only used for drawing Posemode, not stored in channel */
/* Only used for drawing pose-mode, not stored in channel. */
/* PCHAN_HAS_ACTION = (1 << 2), */ /* UNUSED */
PCHAN_HAS_TARGET = (1 << 3),
/* only for drawing Posemode too */
/* Only for drawing pose-mode too. */
/* PCHAN_HAS_STRIDE = (1 << 4), */ /* UNUSED */
/* spline IK */
PCHAN_HAS_SPLINEIK = (1 << 5),

View File

@ -118,7 +118,7 @@ static void sequence_invalidate_cache(Scene *scene,
SEQ_prefetch_stop(scene);
}
/* Find metastrips that contain invalidated_seq and invalidate them. */
/* Find meta-strips that contain invalidated_seq and invalidate them. */
static bool seq_relations_find_and_invalidate_metas(Scene *scene,
Sequence *invalidated_seq,
Sequence *meta_seq)

View File

@ -231,7 +231,7 @@ PointerRNA *WM_gizmo_operator_set(wmGizmo *gz,
int WM_gizmo_operator_invoke(bContext *C, wmGizmo *gz, wmGizmoOpElem *gzop, const wmEvent *event)
{
if (gz->flag & WM_GIZMO_OPERATOR_TOOL_INIT) {
/* Merge toolsettings into the gizmo properties. */
/* Merge tool-settings into the gizmo properties. */
PointerRNA tref_ptr;
bToolRef *tref = WM_toolsystem_ref_from_context(C);
if (tref && WM_toolsystem_ref_properties_get_from_operator(tref, gzop->type, &tref_ptr)) {

View File

@ -344,6 +344,8 @@ dict_custom = {
"subclassing",
"subdirectories",
"subdirectory",
"submenu",
"submenus",
"suboptimally",
"subrange",
"subtractive",