Cleanup: spelling in comments

This commit is contained in:
Campbell Barton
2022-10-10 11:21:53 +11:00
parent e0ad4712f6
commit 210f4db81c
11 changed files with 19 additions and 23 deletions

View File

@@ -285,7 +285,7 @@ void PathTraceWorkCPU::cryptomatte_postproces()
}
#ifdef WITH_PATH_GUIDING
/* Note: It seems that this is called before every rendering iteration/progression and not once per
/* NOTE: It seems that this is called before every rendering iteration/progression and not once per
* rendering. May be we find a way to call it only once per rendering. */
void PathTraceWorkCPU::guiding_init_kernel_globals(void *guiding_field,
void *sample_data_storage,

View File

@@ -100,7 +100,7 @@ ccl_device_inline bool sample_is_class_A(int pattern, int sample)
if (!(pattern == SAMPLING_PATTERN_PMJ || pattern == SAMPLING_PATTERN_SOBOL_BURLEY)) {
/* Fallback: assign samples randomly.
* This is guaranteed to work "okay" for any sampler, but isn't good.
* (Note: the seed constant is just a random number to guard against
* (NOTE: the seed constant is just a random number to guard against
* possible interactions with other uses of the hash. There's nothing
* special about it.)
*/

View File

@@ -723,12 +723,11 @@ template<typename Mesh> class Mikktspace {
void build4RuleGroups()
{
/* Note: This could be parallelized by grouping all [t, i] pairs into
/* NOTE: This could be parallelized by grouping all [t, i] pairs into
* shards by hash(triangles[t].vertices[i]). This way, each shard can be processed
* independently and in parallel.
* However, the groupWithAny logic needs special handling (e.g. lock a mutex when
* encountering a groupWithAny triangle, then sort it out, then unlock and proceed).
*/
* However, the `groupWithAny` logic needs special handling (e.g. lock a mutex when
* encountering a `groupWithAny` triangle, then sort it out, then unlock and proceed). */
for (uint t = 0; t < nrTriangles; t++) {
Triangle &triangle = triangles[t];
for (uint i = 0; i < 3; i++) {

View File

@@ -103,7 +103,7 @@ enum eView2D_CommonViewTypes {
/** \} */
/* -------------------------------------------------------------------- */
/** \name Foeard Declarations
/** \name Forward Declarations
* \{ */
struct View2D;

View File

@@ -101,7 +101,7 @@ struct UndoMesh {
int shapenr;
#ifdef USE_ARRAY_STORE
/* N`ull arrays are considered empty */
/* Null arrays are considered empty. */
struct { /* most data is stored as 'custom' data */
BArrayCustomData *vdata, *edata, *ldata, *pdata;
BArrayState **keyblocks;

View File

@@ -5749,15 +5749,14 @@ static int sculpt_brush_stroke_modal(bContext *C, wmOperator *op, const wmEvent
if (!started && ELEM(retval, OPERATOR_FINISHED, OPERATOR_CANCELLED)) {
/* Did the stroke never start? If so push a blank sculpt undo
* step to prevent a global undo step (which is triggered by the
* OPTYPE_UNDO flag in SCULPT_OT_brush_stroke).
* #OPTYPE_UNDO flag in #SCULPT_OT_brush_stroke).
*
* Having blank global undo steps interleaved with sculpt steps
* corrupts the DynTopo undo stack.
* See T101430.
*
* Note: simply returning OPERATOR_CANCELLED was not
* sufficient to prevent this.
*/
* NOTE: simply returning #OPERATOR_CANCELLED was not
* sufficient to prevent this. */
Sculpt *sd = CTX_data_tool_settings(C)->sculpt;
Brush *brush = BKE_paint_brush(&sd->paint);

View File

@@ -1294,11 +1294,10 @@ static int sculpt_reveal_all_exec(bContext *C, wmOperator *op)
SCULPT_visibility_sync_all_from_faces(ob);
/* Note: SCULPT_visibility_sync_all_from_faces may have deleted
* pbvh->hide_vert if hide_poly did not exist, which is why
* we call BKE_pbvh_update_hide_attributes_from_mesh here instead of
* after CustomData_free_layer_named above.
*/
/* NOTE: #SCULPT_visibility_sync_all_from_faces may have deleted
* `pbvh->hide_vert` if hide_poly did not exist, which is why
* we call #BKE_pbvh_update_hide_attributes_from_mesh here instead of
* after #CustomData_free_layer_named above. */
if (!with_bmesh) {
BKE_pbvh_update_hide_attributes_from_mesh(ss->pbvh);
}

View File

@@ -125,7 +125,7 @@ void MTLImmediate::end()
* TODO(Metal): Cache this vertex state based on Vertex format and shaders. */
for (int i = 0; i < interface->get_total_attributes(); i++) {
/* Note: Attribute in VERTEX FORMAT does not necessarily share the same array index as
/* NOTE: Attribute in VERTEX FORMAT does not necessarily share the same array index as
* attributes in shader interface. */
GPUVertAttr *attr = nullptr;
const MTLShaderInputAttribute &mtl_shader_attribute = interface->get_attribute(i);

View File

@@ -534,7 +534,7 @@ void OBJParser::parse(Vector<std::unique_ptr<Geometry>> &r_all_geometries,
state_shaded_smooth = false;
state_group_name = "";
/* Reset object-local material index that's used in face infos.
* Note: do not reset the material name; that has to carry over
* NOTE: do not reset the material name; that has to carry over
* into the next object if needed. */
state_material_index = -1;
curr_geom = create_geometry(

View File

@@ -330,9 +330,8 @@ typedef enum eAutomasking_flag {
BRUSH_AUTOMASKING_BOUNDARY_FACE_SETS = (1 << 3),
BRUSH_AUTOMASKING_CAVITY_NORMAL = (1 << 4),
/* Note: normal and inverted are mutually exclusive,
* inverted has priority if both bits are set.
*/
/* NOTE: normal and inverted are mutually exclusive,
* inverted has priority if both bits are set. */
BRUSH_AUTOMASKING_CAVITY_INVERTED = (1 << 5),
BRUSH_AUTOMASKING_CAVITY_ALL = (1 << 4) | (1 << 5),
BRUSH_AUTOMASKING_CAVITY_USE_CURVE = (1 << 6),

View File

@@ -92,7 +92,7 @@ static const EnumPropertyItem rna_enum_brush_texture_slot_map_texture_mode_items
#endif
/* clang-format off */
/* Note: we don't actually turn these into a single enum bitmask property,
/* Note: we don't actually turn these into a single enum bit-mask property,
* instead we construct individual boolean properties. */
const EnumPropertyItem RNA_automasking_flags[] = {
{BRUSH_AUTOMASKING_TOPOLOGY, "use_automasking_topology", 0,"Topology", "Affect only vertices connected to the active vertex under the brush"},