Cleanup: spelling

This commit is contained in:
Campbell Barton 2020-05-09 17:15:25 +10:00
parent 00e99959d3
commit d06384aa41
16 changed files with 41 additions and 45 deletions

View File

@ -443,7 +443,7 @@ bool BKE_shrinkwrap_project_normal(char options,
BVHTreeRayHit *hit)
{
/* don't use this because this dist value could be incompatible
* this value used by the callback for comparing prev/new dist values.
* this value used by the callback for comparing previous/new dist values.
* also, at the moment there is no need to have a corrected 'dist' value */
// #define USE_DIST_CORRECT

View File

@ -114,8 +114,8 @@ template<typename Allocator = GuardedAllocator> class LinearAllocator : NonCopya
*
* Arguments passed to this method will be forwarded to the constructor of T.
*
* You must not call `delete` on the returned pointer. Instead, the destructor has to be called
* explicitely.
* You must not call `delete` on the returned pointer.
* Instead, the destruct has to be called explicitly.
*/
template<typename T, typename... Args> T *construct(Args &&... args)
{

View File

@ -36,7 +36,7 @@ typedef struct ScanFillContext {
ListBase fillfacebase;
/* increment this value before adding each curve to skip having to calculate
* 'poly_nr' for edges and verts (which can take approx half scanfill time) */
* 'poly_nr' for edges and verts (which can take approx half scan-fill time) */
unsigned short poly_nr;
/* private */
@ -46,9 +46,9 @@ typedef struct ScanFillContext {
#define BLI_SCANFILL_ARENA_SIZE MEM_SIZE_OPTIMAL(1 << 14)
/**
* \note this is USHRT_MAX so incrementing will set to zero
* \note this is USHRT_MAX so incrementing will set to zero
* which happens if callers choose to increment #ScanFillContext.poly_nr before adding each curve.
* Nowhere else in scanfill do we make use of intentional overflow like this.
* Nowhere else in scan-fill do we make use of intentional overflow like this.
*/
#define SF_POLY_UNSET ((unsigned short)-1)
@ -64,7 +64,7 @@ typedef struct ScanFillVert {
float co[3];
/** 2D projection of vertex location */
float xy[2];
/** index, caller can use how it likes to match the scanfill result with own data */
/** index, caller can use how it likes to match the scan-fill result with own data */
unsigned int keyindex;
unsigned short poly_nr;
/** number of edges using this vertex */

View File

@ -218,7 +218,7 @@ BLI_INLINE void BLI_parallel_range_settings_defaults(TaskParallelSettings *setti
}
/* Don't use this, store any thread specific data in tls->userdata_chunk instead.
* Ony here for code to be removed. */
* Only here for code to be removed. */
int BLI_task_parallel_thread_id(const TaskParallelTLS *tls);
#ifdef __cplusplus

View File

@ -443,7 +443,7 @@ TaskPool *BLI_task_pool_create_no_threads(void *userdata)
}
/**
* Task pool that executeds one task after the other, possibly on different threads
* Task pool that executes one task after the other, possibly on different threads
* but never in parallel.
*/
TaskPool *BLI_task_pool_create_background_serial(void *userdata, TaskPriority priority)

View File

@ -54,7 +54,7 @@ void BLI_task_scheduler_init()
task_scheduler_num_threads = num_threads_override;
}
else {
/* Let TBB choose the number of threads. For (legacy) code that calss
/* Let TBB choose the number of threads. For (legacy) code that calls
* BLI_task_scheduler_num_threads() we provide the system thread count.
* Ideally such code should be rewritten not to use the number of threads
* at all. */

View File

@ -9754,7 +9754,7 @@ static bool read_libblock_undo_restore(
* this is only for do_version-like code), but for sake of consistency, and also because
* it will tell us which ID is re-used from old Main, and which one is actually new. */
/* Also do not add LIB_TAG_NEED_LINK, those IDs will never be re-liblinked, hence that tag will
* never be cleared, leading to critical issue in link/appemd code. */
* never be cleared, leading to critical issue in link/append code. */
const int id_tag = tag | LIB_TAG_UNDO_OLD_ID_REUSED;
read_libblock_undo_restore_identical(fd, main, id, id_old, id_tag);

View File

@ -893,7 +893,7 @@ bool BM_mesh_intersect_edges(
if (BM_vert_pair_share_face_check(va, va_dest)) {
/* Vert par acts on the same face.
* Although there are cases like this where the face can be splitted,
* Although there are cases like this where the face can be split,
* for efficiency it is better to ignore then. */
continue;
}
@ -909,7 +909,7 @@ bool BM_mesh_intersect_edges(
if (BM_vert_pair_share_face_check(v_other, v_other_dest)) {
/* Vert par acts on the same face.
* Although there are cases like this where the face can be splitted,
* Although there are cases like this where the face can be split,
* for efficiency and to avoid complications, it is better to ignore these cases.
*/
break;

View File

@ -55,7 +55,7 @@ class RenderLayersProg : public NodeOperation {
float *m_inputBuffer;
/**
* renderpass where this operation needs to get its data from
* Render-pass where this operation needs to get its data from.
*/
std::string m_passName;

View File

@ -1149,8 +1149,8 @@ void DepsgraphNodeBuilder::build_particle_systems(Object *object, bool is_object
* evaluation context for an object. It acts as the container
* for all the nodes associated with a particular set of particle
* systems.
* 2) Particle System Eval Operation - This operation node acts as a
* blackbox evaluation step for one particle system referenced by
* 2) Particle System Evaluation Operation - This operation node acts as a
* black-box evaluation step for one particle system referenced by
* the particle systems stack. All dependencies link to this operation. */
/* Component for all particle systems. */
ComponentNode *psys_comp = add_component_node(&object->id, NodeType::PARTICLE_SYSTEM);

View File

@ -141,8 +141,7 @@ void DepsgraphNodeBuilder::build_rig(Object *object, bool is_object_visible)
Scene *scene_cow = get_cow_datablock(scene_);
Object *object_cow = get_cow_datablock(object);
OperationNode *op_node;
/* Animation and/or drivers linking posebones to base-armature used to
* define them.
/* Animation and/or drivers linking pose-bones to base-armature used to define them.
*
* NOTE: AnimData here is really used to control animated deform properties,
* which ideally should be able to be unique across different

View File

@ -2080,7 +2080,7 @@ void uiItemFullR(uiLayout *layout,
if (use_prop_sep) {
if (type == PROP_BOOLEAN && (icon == ICON_NONE) && !icon_only) {
use_prop_sep_split_label = false;
/* For checkboxes we make an expection: We allow showing them in a split row even without
/* For check-boxes we make an exception: We allow showing them in a split row even without
* label. It typically relates to its neighbor items, so no need for an extra label. */
use_split_empty_name = true;
}

View File

@ -5300,7 +5300,7 @@ static void do_brush_action(Sculpt *sd, Object *ob, Brush *brush, UnifiedPaintSe
/* Draw Face Sets in draw mode makes a single undo push, in alt-smooth mode deforms the
* vertices and uses regular coords undo. */
/* It also assings the paint_face_set here as it needs to be done regardless of the stroke type
/* It also assigns the paint_face_set here as it needs to be done regardless of the stroke type
* and the number of nodes under the brush influence. */
if (brush->sculpt_tool == SCULPT_TOOL_DRAW_FACE_SETS && ss->cache->first_time &&
ss->cache->mirror_symmetry_pass == 0 && !ss->cache->alt_smooth) {

View File

@ -164,13 +164,13 @@ static void actedit_change_action(bContext *C, bAction *act)
* 1) There must be an dopesheet/action editor, and it must be in a mode which uses actions...
* OR
* The NLA Editor is active (i.e. Animation Data panel -> new action)
* 2) The associated AnimData block must not be in tweakmode
* 2) The associated AnimData block must not be in tweak-mode.
*/
static bool action_new_poll(bContext *C)
{
Scene *scene = CTX_data_scene(C);
/* Check tweakmode is off (as you don't want to be tampering with the action in that case) */
/* Check tweak-mode is off (as you don't want to be tampering with the action in that case) */
/* NOTE: unlike for pushdown,
* this operator needs to be run when creating an action from nothing... */
if (ED_operator_action_active(C)) {
@ -300,7 +300,7 @@ void ACTION_OT_new(wmOperatorType *ot)
/* Criteria:
* 1) There must be an dopesheet/action editor, and it must be in a mode which uses actions
* 2) There must be an action active
* 3) The associated AnimData block must not be in tweakmode
* 3) The associated AnimData block must not be in tweak-mode
*/
static bool action_pushdown_poll(bContext *C)
{
@ -308,7 +308,7 @@ static bool action_pushdown_poll(bContext *C)
SpaceAction *saction = (SpaceAction *)CTX_wm_space_data(C);
AnimData *adt = ED_actedit_animdata_from_context(C);
/* Check for AnimData, Actions, and that tweakmode is off */
/* Check for AnimData, Actions, and that tweak-mode is off. */
if (adt && saction->action) {
/* NOTE: We check this for the AnimData block in question and not the global flag,
* as the global flag may be left dirty by some of the browsing ops here.
@ -330,9 +330,8 @@ static int action_pushdown_exec(bContext *C, wmOperator *op)
/* Do the deed... */
if (adt) {
/* Perform the pushdown operation
* - This will deal with all the AnimData-side usercounts
*/
/* Perform the push-down operation
* - This will deal with all the AnimData-side user-counts. */
if (action_has_motion(adt->action) == 0) {
/* action may not be suitable... */
BKE_report(op->reports, RPT_WARNING, "Action must have at least one keyframe or F-Modifier");
@ -389,7 +388,7 @@ static int action_stash_exec(bContext *C, wmOperator *op)
if (BKE_nla_action_stash(adt)) {
/* The stash operation will remove the user already,
* so the flushing step later shouldn't double up
* the usercount fixes. Hence, we must unset this ref
* the user-count fixes. Hence, we must unset this ref
* first before setting the new action.
*/
saction->action = NULL;
@ -435,14 +434,14 @@ void ACTION_OT_stash(wmOperatorType *ot)
/* Criteria:
* 1) There must be an dopesheet/action editor, and it must be in a mode which uses actions
* 2) The associated AnimData block must not be in tweakmode
* 2) The associated AnimData block must not be in tweak-mode
*/
static bool action_stash_create_poll(bContext *C)
{
if (ED_operator_action_active(C)) {
AnimData *adt = ED_actedit_animdata_from_context(C);
/* Check tweakmode is off (as you don't want to be tampering with the action in that case) */
/* Check tweak-mode is off (as you don't want to be tampering with the action in that case) */
/* NOTE: unlike for pushdown,
* this operator needs to be run when creating an action from nothing... */
if (adt) {
@ -498,7 +497,7 @@ static int action_stash_create_exec(bContext *C, wmOperator *op)
/* The stash operation will remove the user already,
* so the flushing step later shouldn't double up
* the usercount fixes. Hence, we must unset this ref
* the user-count fixes. Hence, we must unset this ref
* first before setting the new action.
*/
saction->action = NULL;
@ -728,8 +727,8 @@ static NlaStrip *action_layer_get_nlastrip(ListBase *strips, float ctime)
static void action_layer_switch_strip(
AnimData *adt, NlaTrack *old_track, NlaStrip *old_strip, NlaTrack *nlt, NlaStrip *strip)
{
/* Exit tweakmode on old strip
* NOTE: We need to manually clear this stuff ourselves, as tweakmode exit doesn't do it
/* Exit tweak-mode on old strip
* NOTE: We need to manually clear this stuff ourselves, as tweak-mode exit doesn't do it
*/
BKE_nla_tweakmode_exit(adt);
@ -761,11 +760,11 @@ static void action_layer_switch_strip(
adt->flag |= ADT_NLA_SOLO_TRACK;
nlt->flag |= NLATRACK_SOLO;
// TODO: Needs restpose flushing (when we get reference track)
// TODO: Needs rest-pose flushing (when we get reference track)
}
}
/* Enter tweakmode again - hopefully we're now "it" */
/* Enter tweak-mode again - hopefully we're now "it" */
BKE_nla_tweakmode_enter(adt);
BLI_assert(adt->actstrip == strip);
}
@ -778,7 +777,7 @@ static bool action_layer_next_poll(bContext *C)
if (ED_operator_action_active(C)) {
AnimData *adt = ED_actedit_animdata_from_context(C);
if (adt) {
/* only allow if we're in tweakmode, and there's something above us... */
/* only allow if we're in tweak-mode, and there's something above us... */
if (adt->flag & ADT_NLA_EDIT_ON) {
/* We need to check if there are any tracks above the active one
* since the track the action comes from is not stored in AnimData
@ -840,7 +839,7 @@ static int action_layer_next_exec(bContext *C, wmOperator *op)
}
else {
/* No more actions (strips) - Go back to editing the original active action
* NOTE: This will mean exiting tweakmode...
* NOTE: This will mean exiting tweak-mode...
*/
BKE_nla_tweakmode_exit(adt);
@ -855,13 +854,12 @@ static int action_layer_next_exec(bContext *C, wmOperator *op)
/* turn on NLA muting (to keep same effect) */
adt->flag |= ADT_NLA_EVAL_OFF;
// TODO: Needs restpose flushing (when we get reference track)
// TODO: Needs rest-pose flushing (when we get reference track)
}
}
/* Update the action that this editor now uses
* NOTE: The calls above have already handled the usercount/animdata side of things
*/
* NOTE: The calls above have already handled the user-count/anim-data side of things. */
actedit_change_action(C, adt->action);
return OPERATOR_FINISHED;
}
@ -960,8 +958,7 @@ static int action_layer_prev_exec(bContext *C, wmOperator *op)
}
/* Update the action that this editor now uses
* NOTE: The calls above have already handled the usercount/animdata side of things
*/
* NOTE: The calls above have already handled the user-count/animdata side of things. */
actedit_change_action(C, adt->action);
return OPERATOR_FINISHED;
}

View File

@ -1657,7 +1657,7 @@ static bool node_link_insert_offset_frame_chain_cb(bNode *fromnode,
}
/**
* Applies NodeInsertOfsData.offset_x to all childs of \a parent
* Applies #NodeInsertOfsData.offset_x to all children of \a parent.
*/
static void node_link_insert_offset_frame_chains(const bNodeTree *ntree,
const bNode *parent,

View File

@ -462,8 +462,8 @@ static void generate_geometry(GpencilModifierData *md,
}
/* Early exit if current frame is outside start/end bounds */
/* NOTE: If we're beyond the next/prev frames (if existent), then we wouldn't have this problem
* anyway... */
/* NOTE: If we're beyond the next/previous frames (if existent),
* then we wouldn't have this problem anyway... */
if (ctime < start_frame) {
/* Before Start - Animation hasn't started. Display initial state. */
if (reverse) {