Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2021-09-24 11:31:23 +10:00
parent 599d96e8f9
commit bc65c7d0e5
31 changed files with 64 additions and 61 deletions

View File

@ -163,7 +163,7 @@ class GPUDisplay {
* This call might happen in parallel with draw, but can never happen in parallel with the
* update.
*
* The actual zero-ing can be deferred to a later moment. What is important is that after clear
* The actual zeroing can be deferred to a later moment. What is important is that after clear
* and before pixels update the drawing texture will be fully empty, and that partial update
* after clear will write new pixel values for an updating area, leaving everything else zeroed.
*

View File

@ -727,8 +727,8 @@ void OSLCompiler::add(ShaderNode *node, const char *name, bool isfilepath)
}
}
/* create shader of the appropriate type. OSL only distinguishes between "surface"
* and "displacement" atm */
/* Create shader of the appropriate type. OSL only distinguishes between "surface"
* and "displacement" at the moment. */
if (current_type == SHADER_TYPE_SURFACE)
ss->Shader("surface", name, id(node).c_str());
else if (current_type == SHADER_TYPE_VOLUME)

View File

@ -89,7 +89,7 @@ class DebugFlags {
void reset();
/* Whether adaptive feature based runtime compile is enabled or not.
* Requires the CUDA Toolkit and only works on Linux atm. */
* Requires the CUDA Toolkit and only works on Linux at the moment. */
bool adaptive_compile;
};

View File

@ -374,8 +374,8 @@ void GHOST_SystemSDL::processEvent(SDL_Event *sdl_event)
if (window->getCursorGrabBounds(bounds) == GHOST_kFailure)
window->getClientBounds(bounds);
/* Could also clamp to screen bounds wrap with a window outside the view will fail atm.
* Use offset of 8 in case the window is at screen bounds. */
/* Could also clamp to screen bounds wrap with a window outside the view will
* fail at the moment. Use offset of 8 in case the window is at screen bounds. */
bounds.wrapPoint(x_new, y_new, 8, window->getCursorGrabAxis());
window->getCursorGrabAccum(x_accum, y_accum);

View File

@ -1100,8 +1100,8 @@ GHOST_EventCursor *GHOST_SystemWin32::processCursorEvent(GHOST_WindowWin32 *wind
window->getClientBounds(bounds);
}
/* Could also clamp to screen bounds wrap with a window outside the view will fail atm.
* Use inset in case the window is at screen bounds. */
/* Could also clamp to screen bounds wrap with a window outside the view will
* fail at the moment. Use inset in case the window is at screen bounds. */
bounds.wrapPoint(x_new, y_new, 2, window->getCursorGrabAxis());
window->getCursorGrabAccum(x_accum, y_accum);

View File

@ -973,8 +973,8 @@ void GHOST_SystemX11::processEvent(XEvent *xe)
if (window->getCursorGrabBounds(bounds) == GHOST_kFailure)
window->getClientBounds(bounds);
/* Could also clamp to screen bounds wrap with a window outside the view will fail atm.
* Use offset of 8 in case the window is at screen bounds. */
/* Could also clamp to screen bounds wrap with a window outside the view will
* fail at the moment. Use offset of 8 in case the window is at screen bounds. */
bounds.wrapPoint(x_new, y_new, 8, window->getCursorGrabAxis());
window->getCursorGrabAccum(x_accum, y_accum);

View File

@ -48,7 +48,7 @@ struct AssetTagEnsureResult BKE_asset_metadata_tag_ensure(struct AssetMetaData *
const char *name);
void BKE_asset_metadata_tag_remove(struct AssetMetaData *asset_data, struct AssetTag *tag);
/** Clean up the catalog ID (whitespaces removed, length reduced, etc.) and assign it. */
/** Clean up the catalog ID (white-spaces removed, length reduced, etc.) and assign it. */
void BKE_asset_metadata_catalog_id_clear(struct AssetMetaData *asset_data);
void BKE_asset_metadata_catalog_id_set(struct AssetMetaData *asset_data,
bUUID catalog_id,

View File

@ -69,7 +69,7 @@ class AssetCatalogService {
* still have to be saved.
*
* Return true on success, which either means there were no in-memory categories to save, or the
* save was succesfful. */
* save was successful. */
bool write_to_disk(const CatalogFilePath &directory_for_new_files);
/**
@ -96,7 +96,7 @@ class AssetCatalogService {
AssetCatalogTree *get_catalog_tree();
/** Return true iff there are no catalogs known. */
/** Return true only if there are no catalogs known. */
bool is_empty() const;
protected:
@ -196,7 +196,7 @@ class AssetCatalogDefinitionFile {
bool write_to_disk(const CatalogFilePath &dest_file_path) const;
bool contains(CatalogID catalog_id) const;
/* Add a new catalog. Undefined behaviour if a catalog with the same ID was already added. */
/* Add a new catalog. Undefined behavior if a catalog with the same ID was already added. */
void add_new(AssetCatalog *catalog);
using AssetCatalogParsedFn = FunctionRef<bool(std::unique_ptr<AssetCatalog>)>;
@ -230,9 +230,9 @@ class AssetCatalog {
CatalogPath path;
/**
* Simple, human-readable name for the asset catalog. This is stored on assets alongside the
* catalog ID; the catalog ID is a UUID that is not human-readable, so to avoid complete dataloss
* when the catalog definition file gets lost, we also store a human-readable simple name for the
* catalog. */
* catalog ID; the catalog ID is a UUID that is not human-readable,
* so to avoid complete data-loss when the catalog definition file gets lost,
* we also store a human-readable simple name for the catalog. */
std::string simple_name;
struct Flags {
@ -242,7 +242,7 @@ class AssetCatalog {
} flags;
/**
* Create a new Catalog with the given path, auto-generating a sensible catalog simplename.
* Create a new Catalog with the given path, auto-generating a sensible catalog simple-name.
*
* NOTE: the given path will be cleaned up (trailing spaces removed, etc.), so the returned
* `AssetCatalog`'s path differ from the given one.

View File

@ -42,7 +42,7 @@ TEST(AssetMetadataTest, set_catalog_id)
EXPECT_TRUE(BLI_uuid_equal(uuid, meta.catalog_id));
EXPECT_STREQ("simple", meta.catalog_simple_name);
/* Test whitespace trimming. */
/* Test white-space trimming. */
BKE_asset_metadata_catalog_id_set(&meta, uuid, " Govoriš angleško? ");
EXPECT_STREQ("Govoriš angleško?", meta.catalog_simple_name);
@ -52,7 +52,7 @@ TEST(AssetMetadataTest, set_catalog_id)
BKE_asset_metadata_catalog_id_set(&meta, uuid, len66);
EXPECT_STREQ(len63, meta.catalog_simple_name);
/* Test length trimming happens after whitespace trimming. */
/* Test length trimming happens after white-space trimming. */
constexpr char len68[] =
" \
000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f20 ";

View File

@ -261,7 +261,7 @@ bool BKE_displist_surfindex_get(
return true;
}
/* ****************** make displists ********************* */
/* ****************** Make #DispList ********************* */
#ifdef __INTEL_COMPILER
/* ICC with the optimization -02 causes crashes. */
# pragma intel optimization_level 1

View File

@ -317,7 +317,7 @@ static bool setError(DynamicPaintCanvasSettings *canvas, const char *string)
static int dynamicPaint_surfaceNumOfPoints(DynamicPaintSurface *surface)
{
if (surface->format == MOD_DPAINT_SURFACE_F_PTEX) {
return 0; /* not supported atm */
return 0; /* Not supported at the moment. */
}
if (surface->format == MOD_DPAINT_SURFACE_F_VERTEX) {
const Mesh *canvas_mesh = dynamicPaint_canvas_mesh_get(surface->canvas);

View File

@ -65,7 +65,7 @@
static CLG_LogRef LOG = {"bke.gpencil_modifier"};
static GpencilModifierTypeInfo *modifier_gpencil_types[NUM_GREASEPENCIL_MODIFIER_TYPES] = {NULL};
#if 0
/* Note that GPencil actually does not support these atm, but might do in the future. */
/* Note that GPencil actually does not support these at the moment, but might do in the future. */
static GpencilVirtualModifierData virtualModifierCommonData;
#endif
@ -129,7 +129,8 @@ GpencilModifierData *BKE_gpencil_modifiers_get_virtual_modifierlist(
GpencilModifierData *md = ob->greasepencil_modifiers.first;
#if 0
/* Note that GPencil actually does not support these atm, but might do in the future. */
/* Note that GPencil actually does not support these at the moment,
* but might do in the future. */
*virtualModifierData = virtualModifierCommonData;
if (ob->parent) {
if (ob->parent->type == OB_ARMATURE && ob->partype == PARSKEL) {
@ -328,7 +329,8 @@ void BKE_gpencil_modifier_init(void)
gpencil_modifier_type_init(modifier_gpencil_types); /* MOD_gpencil_util.c */
#if 0
/* Note that GPencil actually does not support these atm, but might do in the future. */
/* Note that GPencil actually does not support these at the moment,
* but might do in the future. */
/* Initialize global common storage used for virtual modifier list. */
GpencilModifierData *md;
md = BKE_gpencil_modifier_new(eGpencilModifierType_Armature);

View File

@ -2013,7 +2013,8 @@ static void nlastrips_to_animdata(ID *id, ListBase *strips)
}
}
/* try to add this strip to the current NLA-Track (i.e. the 'last' one on the stack atm) */
/* Try to add this strip to the current NLA-Track
* (i.e. the 'last' one on the stack at the moment). */
if (BKE_nlatrack_add_strip(nlt, strip, false) == 0) {
/* trying to add to the current failed (no space),
* so add a new track to the stack, and add to that...

View File

@ -473,7 +473,7 @@ bool BKE_object_material_slot_used(ID *id, short actcol)
case ID_CU:
return BKE_curve_material_index_used((Curve *)id, actcol - 1);
case ID_MB:
/* meta-elems don't have materials atm */
/* Meta-elements don't support materials at the moment. */
return false;
case ID_GD:
return BKE_gpencil_material_index_used((bGPdata *)id, actcol - 1);

View File

@ -454,7 +454,7 @@ static void make_face(PROCESS *process, int i1, int i2, int i3, int i4)
cur = process->indices[process->curindex++];
/* displists now support array drawing, we treat tri's as fake quad */
/* #DispList supports array drawing, treat tri's as fake quad. */
cur[0] = i1;
cur[1] = i2;

View File

@ -873,8 +873,8 @@ static Object *object_for_curve_to_mesh_create(const Object *object)
{
const Curve *curve = (const Curve *)object->data;
/* reate a temporary object which can be evaluated and modified by generic
* curve evaluation (hence the LIB_ID_COPY_SET_COPIED_ON_WRITE flag). */
/* Create a temporary object which can be evaluated and modified by generic
* curve evaluation (hence the #LIB_ID_COPY_SET_COPIED_ON_WRITE flag). */
Object *temp_object = (Object *)BKE_id_copy_ex(
nullptr, &object->id, nullptr, LIB_ID_COPY_LOCALIZE | LIB_ID_COPY_SET_COPIED_ON_WRITE);
@ -882,7 +882,7 @@ static Object *object_for_curve_to_mesh_create(const Object *object)
BKE_object_free_modifiers(temp_object, LIB_ID_CREATE_NO_USER_REFCOUNT);
/* Need to create copy of curve itself as well, since it will be changed by the curve evaluation
* process. NOTE: Copies the data, but not the shapekeys. */
* process. NOTE: Copies the data, but not the shape-keys. */
temp_object->data = BKE_id_copy_ex(nullptr,
(const ID *)object->data,
nullptr,
@ -893,7 +893,7 @@ static Object *object_for_curve_to_mesh_create(const Object *object)
* result. */
BKE_curve_texspace_calc(temp_curve);
/* Temporarily set edit so we get updates from edit mode, but also because for text datablocks
/* Temporarily set edit so we get updates from edit mode, but also because for text data-blocks
* copying it while in edit mode gives invalid data structures. */
temp_curve->editfont = curve->editfont;
temp_curve->editnurb = curve->editnurb;
@ -1189,7 +1189,7 @@ Mesh *BKE_mesh_new_from_object_to_bmain(Main *bmain,
return mesh_in_bmain;
}
/* Make sure mesh only points original datablocks, also increase users of materials and other
/* Make sure mesh only points original data-blocks, also increase users of materials and other
* possibly referenced data-blocks.
*
* Going to original data-blocks is required to have bmain in a consistent state, where

View File

@ -1123,7 +1123,7 @@ static void node_init(const struct bContext *C, bNodeTree *ntree, bNode *node)
RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
/* XXX Warning: context can be nullptr in case nodes are added in do_versions.
* Delayed init is not supported for nodes with context-based initfunc_api atm.
* Delayed init is not supported for nodes with context-based `initfunc_api` at the moment.
*/
BLI_assert(C != nullptr);
ntype->initfunc_api(C, &ptr);

View File

@ -2465,7 +2465,7 @@ static void scene_graph_update_tagged(Depsgraph *depsgraph, Main *bmain, bool on
// DEG_debug_graph_relations_validate(depsgraph, bmain, scene);
/* Flush editing data if needed. */
prepare_mesh_for_viewport_render(bmain, view_layer);
/* Update all objects: drivers, matrices, displists, etc. flags set
/* Update all objects: drivers, matrices, #DispList, etc. flags set
* by depsgraph or manual, no layer check here, gets correct flushed. */
DEG_evaluate_on_refresh(depsgraph);
/* Update sound system. */
@ -2541,7 +2541,7 @@ void BKE_scene_graph_update_for_newframe_ex(Depsgraph *depsgraph, const bool cle
BKE_image_editors_update_frame(bmain, scene->r.cfra);
BKE_sound_set_cfra(scene->r.cfra);
DEG_graph_relations_update(depsgraph);
/* Update all objects: drivers, matrices, displists, etc. flags set
/* Update all objects: drivers, matrices, #DispList, etc. flags set
* by depgraph or manual, no layer check here, gets correct flushed.
*
* NOTE: Only update for new frame on first iteration. Second iteration is for ensuring user

View File

@ -79,17 +79,17 @@ namespace blender {
class bUUID : public ::bUUID {
public:
/**
* Default constructor, used with `bUUID value{};`, will initialise to the nil UUID.
* Default constructor, used with `bUUID value{};`, will initialize to the nil UUID.
*/
bUUID() = default;
/** Initialise from the bUUID DNA struct. */
/** Initialize from the bUUID DNA struct. */
bUUID(const ::bUUID &struct_uuid);
/** Initialise from 11 integers, 5 for the regular fields and 6 for the `node` array. */
/** Initialize from 11 integers, 5 for the regular fields and 6 for the `node` array. */
bUUID(std::initializer_list<uint32_t> field_values);
/** Initialise by parsing the string; undefined behaviour when the string is invalid. */
/** Initialize by parsing the string; undefined behavior when the string is invalid. */
explicit bUUID(const std::string &string_formatted_uuid);
uint64_t hash() const;

View File

@ -3582,7 +3582,7 @@ static void adjust_the_cycle_or_chain(BoundVert *vstart, bool iscycle)
}
/* Residue np + 2*i (if cycle) else np - 1 + 2*i:
* right offset for parm i matches its spec; weighted. */
* right offset for parameter i matches its spec; weighted. */
int row = iscycle ? np + 2 * i : np - 1 + 2 * i;
EIG_linear_solver_matrix_add(solver, row, i, weight);
EIG_linear_solver_right_hand_side_add(solver, 0, row, weight * eright->offset_r);
@ -3595,7 +3595,7 @@ static void adjust_the_cycle_or_chain(BoundVert *vstart, bool iscycle)
#endif
/* Residue np + 2*i + 1 (if cycle) else np - 1 + 2*i + 1:
* left offset for parm i matches its spec; weighted. */
* left offset for parameter i matches its spec; weighted. */
row = row + 1;
EIG_linear_solver_matrix_add(
solver, row, (i == np - 1) ? 0 : i + 1, weight * v->adjchain->sinratio);

View File

@ -610,7 +610,7 @@ void ANIM_keyingset_info_unregister(Main *bmain, KeyingSetInfo *ksi)
KeyingSet *ks, *ksn;
/* find relevant builtin KeyingSets which use this, and remove them */
/* TODO: this isn't done now, since unregister is really only used atm when we
/* TODO: this isn't done now, since unregister is really only used at the moment when we
* reload the scripts, which kindof defeats the purpose of "builtin"? */
for (ks = builtin_keyingsets.first; ks; ks = ksn) {
ksn = ks->next;

View File

@ -2104,7 +2104,7 @@ static void annotation_draw_apply_event(
p->flags |= GP_PAINTFLAG_USE_STABILIZER_TEMP;
}
}
/* We are using the temporal stabilizer flag atm,
/* We are using the temporal stabilizer flag at the moment,
* but shift is not pressed as well as the permanent flag is not used,
* so we don't need the cursor anymore. */
else if (p->flags & GP_PAINTFLAG_USE_STABILIZER_TEMP) {

View File

@ -3000,7 +3000,7 @@ void ED_region_panels_layout_ex(const bContext *C,
/* before setting the view */
if (region_layout_based) {
/* XXX, only single panel support atm.
/* XXX, only single panel support at the moment.
* Can't use x/y values calculated above because they're not using the real height of panels,
* instead they calculate offsets for the next panel to start drawing. */
Panel *panel = region->panels.last;

View File

@ -196,8 +196,8 @@ static bool track_markers_initjob(bContext *C, TrackMarkersJob *tmj, bool backwa
/* XXX: silly to store this, but this data is needed to update scene and
* movie-clip numbers when tracking is finished. This introduces
* better feedback for artists.
* Maybe there's another way to solve this problem, but can't think
* better way atm.
* Maybe there's another way to solve this problem,
* but can't think better way at the moment.
* Anyway, this way isn't more unstable as animation rendering
* animation which uses the same approach (except storing screen).
*/

View File

@ -555,7 +555,7 @@ static bool imb_save_openexr_float(ImBuf *ibuf, const char *name, const int flag
int xstride = sizeof(float) * channels;
int ystride = -xstride * width;
/* last scanline, stride negative */
/* Last scan-line, stride negative. */
float *rect[4] = {nullptr, nullptr, nullptr, nullptr};
rect[0] = ibuf->rect_float + channels * (height - 1) * width;
rect[1] = (channels >= 2) ? rect[0] + 1 : rect[0];
@ -654,7 +654,7 @@ struct ExrChannel {
char name[EXR_TOT_MAXNAME + 1]; /* full name with everything */
struct MultiViewChannelName *m; /* struct to store all multipart channel info */
int xstride, ystride; /* step to next pixel, to next scanline */
int xstride, ystride; /* step to next pixel, to next scan-line. */
float *rect; /* first pointer to write in */
char chan_id; /* quick lookup of channel char */
int view_id; /* quick lookup of channel view */
@ -1127,7 +1127,7 @@ void IMB_exr_write_channels(void *handle)
}
for (echan = (ExrChannel *)data->channels.first; echan; echan = echan->next) {
/* Writing starts from last scanline, stride negative. */
/* Writing starts from last scan-line, stride negative. */
if (echan->use_half_float) {
float *rect = echan->rect;
half *cur = current_rect_half;
@ -1269,7 +1269,7 @@ void IMB_exr_read_channels(void *handle)
if (!flip) {
/* Inverse correct first pixel for data-window coordinates. */
rect -= echan->xstride * (dw.min.x - dw.min.y * data->width);
/* move to last scanline to flip to Blender convention */
/* Move to last scan-line to flip to Blender convention. */
rect += echan->xstride * (data->height - 1) * data->width;
ystride = -ystride;
}
@ -2009,7 +2009,7 @@ struct ImBuf *imb_load_openexr(const unsigned char *mem,
/* Inverse correct first pixel for data-window
* coordinates (- dw.min.y because of y flip). */
first = ibuf->rect_float - 4 * (dw.min.x - dw.min.y * width);
/* but, since we read y-flipped (negative y stride) we move to last scanline */
/* But, since we read y-flipped (negative y stride) we move to last scan-line. */
first += 4 * (height - 1) * width;
if (num_rgb_channels > 0) {

View File

@ -42,7 +42,7 @@ extern "C" {
*/
typedef struct ClothSimSettings {
/** UNUSED atm. */
/** UNUSED. */
struct LinkNode *cache;
/** See SB. */
float mingoal;

View File

@ -81,8 +81,8 @@ typedef struct bConstraint {
/** Local influence ipo or driver */
struct Ipo *ipo DNA_DEPRECATED;
/* below are readonly fields that are set at runtime
* by the solver for use in the GE (only IK atm) */
/* Below are read-only fields that are set at runtime
* by the solver for use in the GE (only IK at the moment). */
/** Residual error on constraint expressed in blender unit. */
float lin_error;
/** Residual error on constraint expressed in radiant. */

View File

@ -848,7 +848,7 @@ typedef struct CollisionModifierData {
struct MVert *x;
/** Position at the end of the frame. */
struct MVert *xnew;
/** Unused atm, but was discussed during sprint. */
/** Unused at the moment, but was discussed during sprint. */
struct MVert *xold;
/** New position at the actual inter-frame step. */
struct MVert *current_xnew;

View File

@ -38,8 +38,8 @@
void RNA_api_material(StructRNA *UNUSED(srna))
{
/* FunctionRNA *func; */
/* PropertyRNA *parm; */
// FunctionRNA *func;
// PropertyRNA *parm;
}
#endif

View File

@ -1056,8 +1056,8 @@ static void rna_def_ptcache_point_caches(BlenderRNA *brna, PropertyRNA *cprop)
StructRNA *srna;
PropertyRNA *prop;
/* FunctionRNA *func; */
/* PropertyRNA *parm; */
// FunctionRNA *func;
// PropertyRNA *parm;
RNA_def_property_srna(cprop, "PointCaches");
srna = RNA_def_struct(brna, "PointCaches", NULL);

View File

@ -548,7 +548,7 @@ Vector<const NodeRef *> NodeTreeRef::toposort(const ToposortDirection direction)
const SocketRef &socket = *sockets[item.socket_index];
const Span<const SocketRef *> linked_sockets = socket.directly_linked_sockets();
if (item.link_index == linked_sockets.size()) {
/* All linkes connected to this socket have already been visited. */
/* All links connected to this socket have already been visited. */
item.socket_index++;
item.link_index = 0;
continue;