[Bf-blender-cvs] [2467becade7] master: Cleanup: spelling in comments

Campbell Barton noreply at git.blender.org
Mon Jan 16 03:58:20 CET 2023


Commit: 2467becade76fafa4a6c5d3031048d3d8767b774
Author: Campbell Barton
Date:   Mon Jan 16 13:57:10 2023 +1100
Branches: master
https://developer.blender.org/rB2467becade76fafa4a6c5d3031048d3d8767b774

Cleanup: spelling in comments

===================================================================

M	source/blender/blenkernel/BKE_customdata.h
M	source/blender/blenkernel/BKE_particle.h
M	source/blender/blenkernel/intern/constraint.c
M	source/blender/blenkernel/intern/dynamicpaint.c
M	source/blender/blenkernel/intern/mesh_remap.cc
M	source/blender/blenkernel/intern/particle_distribute.c
M	source/blender/blenkernel/intern/softbody.c
M	source/blender/blenloader/intern/versioning_250.c
M	source/blender/blenloader/intern/versioning_290.c
M	source/blender/blenloader/intern/versioning_300.cc
M	source/blender/blenloader/intern/versioning_defaults.cc
M	source/blender/draw/intern/draw_manager.c
M	source/blender/editors/transform/transform_convert_armature.c
M	source/blender/editors/transform/transform_mode_resize.c
M	source/blender/gpencil_modifiers/intern/MOD_gpencilbuild.c
M	source/blender/io/collada/MeshImporter.cpp
M	source/blender/makesdna/DNA_scene_types.h
M	source/blender/makesrna/intern/rna_particle.c
M	source/blender/modifiers/intern/MOD_ocean.c
M	source/blender/modifiers/intern/MOD_solidify_extrude.c
M	source/blender/windowmanager/intern/wm_event_system.cc

===================================================================

diff --git a/source/blender/blenkernel/BKE_customdata.h b/source/blender/blenkernel/BKE_customdata.h
index e7161722925..905eb43179a 100644
--- a/source/blender/blenkernel/BKE_customdata.h
+++ b/source/blender/blenkernel/BKE_customdata.h
@@ -681,7 +681,7 @@ typedef struct CustomDataTransferLayerMap {
   /** If non-NULL, array of weights, one for each dest item, replaces mix_factor. */
   const float *mix_weights;
 
-  /** Data source array (can be regular CD data, vertices/edges/etc., keyblocks...). */
+  /** Data source array (can be regular CD data, vertices/edges/etc., key-blocks...). */
   const void *data_src;
   /** Data dest array (same type as dat_src). */
   void *data_dst;
@@ -699,7 +699,7 @@ typedef struct CustomDataTransferLayerMap {
   /** For bit-flag transfer, flag(s) to affect in transferred data. */
   uint64_t data_flag;
 
-  /** Opaque pointer, to be used by specific interp callback (e.g. transformspace for normals). */
+  /** Opaque pointer, to be used by specific interp callback (e.g. transform-space for normals). */
   void *interp_data;
 
   cd_datatransfer_interp interp;
diff --git a/source/blender/blenkernel/BKE_particle.h b/source/blender/blenkernel/BKE_particle.h
index fc9769a94a4..f295979f23c 100644
--- a/source/blender/blenkernel/BKE_particle.h
+++ b/source/blender/blenkernel/BKE_particle.h
@@ -210,10 +210,12 @@ typedef struct ParticleCollision {
 
   ParticleCollisionElement pce;
 
-  /* total_time is the amount of time in this subframe
-   * inv_total_time is the opposite
-   * inv_timestep is the inverse of the amount of time in this frame */
-  float total_time, inv_total_time, inv_timestep;
+  /** The amount of time in this sub-frame. */
+  float total_time;
+  /** The inverse of `total_time`. */
+  float inv_total_time;
+  /** The inverse of the amount of time in this frame. */
+  float inv_timestep;
 
   float radius;
   float co1[3], co2[3];
diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c
index 93ab47651ed..fbaadca09cd 100644
--- a/source/blender/blenkernel/intern/constraint.c
+++ b/source/blender/blenkernel/intern/constraint.c
@@ -124,7 +124,7 @@ bConstraintOb *BKE_constraints_make_evalob(
   /* create regardless of whether we have any data! */
   cob = MEM_callocN(sizeof(bConstraintOb), "bConstraintOb");
 
-  /* for system time, part of deglobalization, code nicer later with local time (ton) */
+  /* NOTE(@ton): For system time, part of de-globalization, code nicer later with local time. */
   cob->scene = scene;
   cob->depsgraph = depsgraph;
 
@@ -236,7 +236,7 @@ void BKE_constraints_clear_evalob(bConstraintOb *cob)
     }
   }
 
-  /* free tempolary struct */
+  /* Free temporary struct. */
   MEM_freeN(cob);
 }
 
@@ -3842,7 +3842,7 @@ static void clampto_evaluate(bConstraint *con, bConstraintOb *cob, ListBase *tar
      * be used that doesn't lazy initialize to avoid thread safety issues in the future. */
     BKE_object_minmax(ct->tar, curveMin, curveMax, true);
 
-    /* get targetmatrix */
+    /* Get target-matrix. */
     if (data->tar->runtime.curve_cache && data->tar->runtime.curve_cache->anim_path_accum_length) {
       float vec[4], totmat[4][4];
       float curvetime;
diff --git a/source/blender/blenkernel/intern/dynamicpaint.c b/source/blender/blenkernel/intern/dynamicpaint.c
index 4f24a503a4d..705e5d56f9b 100644
--- a/source/blender/blenkernel/intern/dynamicpaint.c
+++ b/source/blender/blenkernel/intern/dynamicpaint.c
@@ -507,7 +507,7 @@ static float mixColors(
 
 static void scene_setSubframe(Scene *scene, float subframe)
 {
-  /* dynamic paint subframes must be done on previous frame */
+  /* Dynamic paint sub-frames must be done on previous frame. */
   scene->r.cfra -= 1;
   scene->r.subframe = subframe;
 }
@@ -1139,7 +1139,7 @@ bool dynamicPaint_createType(struct DynamicPaintModifierData *pmd, int type, str
       brush->smudge_strength = 0.3f;
       brush->max_velocity = 1.0f;
 
-      /* Paint proximity falloff colorramp. */
+      /* Paint proximity falloff color-ramp. */
       {
         CBData *ramp;
 
@@ -1659,7 +1659,7 @@ static void dynamicPaint_setInitialColor(const Scene *scene, DynamicPaintSurface
   /* vertex color layer */
   else if (surface->init_color_type == MOD_DPAINT_INITIAL_VERTEXCOLOR) {
 
-    /* for vertex surface, just copy colors from mcol */
+    /* For vertex surface, just copy colors from #MLoopCol. */
     if (surface->format == MOD_DPAINT_SURFACE_F_VERTEX) {
       const MLoop *mloop = BKE_mesh_loops(mesh);
       const int totloop = mesh->totloop;
@@ -2787,7 +2787,7 @@ int dynamicPaint_createUVSurface(Scene *scene,
                                  float *progress,
                                  bool *do_update)
 {
-  /* Antialias jitter point relative coords */
+  /* Anti-alias jitter point relative coords. */
   const int aa_samples = (surface->flags & MOD_DPAINT_ANTIALIAS) ? 5 : 1;
   char uvname[MAX_CUSTOMDATA_LAYER_NAME];
   uint32_t active_points = 0;
@@ -5333,7 +5333,7 @@ static void dynamic_paint_effect_drip_cb(void *__restrict userdata,
 
       const uint n_trgt = (uint)n_target[n_idx];
 
-      /* Sort of spinlock, but only for given ePoint.
+      /* Sort of spin-lock, but only for given ePoint.
        * Since the odds a same ePoint is modified at the same time by several threads is very low,
        * this is much more efficient than a global spin lock. */
       const uint epointlock_idx = n_trgt / 8;
diff --git a/source/blender/blenkernel/intern/mesh_remap.cc b/source/blender/blenkernel/intern/mesh_remap.cc
index c36fbfb3274..c32a9c067ac 100644
--- a/source/blender/blenkernel/intern/mesh_remap.cc
+++ b/source/blender/blenkernel/intern/mesh_remap.cc
@@ -448,9 +448,9 @@ struct IslandResult {
  *   This only concerns loops, currently (because of islands), and 'sampled' edges/polys norproj.
  */
 
-/* At most n raycasts per 'real' ray. */
+/** At most N ray-casts per 'real' ray. */
 #define MREMAP_RAYCAST_APPROXIMATE_NR 3
-/* Each approximated raycasts will have n times bigger radius than previous one. */
+/** Each approximated ray-casts will have n times bigger radius than previous one. */
 #define MREMAP_RAYCAST_APPROXIMATE_FAC 5.0f
 
 /* min 16 rays/face, max 400. */
diff --git a/source/blender/blenkernel/intern/particle_distribute.c b/source/blender/blenkernel/intern/particle_distribute.c
index 7cec485e6dd..085f2cc8ddb 100644
--- a/source/blender/blenkernel/intern/particle_distribute.c
+++ b/source/blender/blenkernel/intern/particle_distribute.c
@@ -316,9 +316,10 @@ static void distribute_grid(Mesh *mesh, ParticleSystem *psys)
   }
 }
 
-/* modified copy from rayshade.c */
 static void hammersley_create(float *out, int n, int seed, float amount)
 {
+  /* This code is originally from a modified copy from `rayshade.c`
+   * (a file that's no longer included). */
   RNG *rng;
 
   double ofs[2], t;
@@ -917,7 +918,7 @@ static int psys_thread_context_init_distribute(ParticleThreadContext *ctx,
   }
 
   /* XXX This distribution code is totally broken in case from == PART_FROM_CHILD,
-   *     it's always using finaldm even if use_modifier_stack is unset...
+   *     it's always using `final_mesh` even if use_modifier_stack is unset...
    *     But making things consistent here break all existing edited
    *     hair systems, so better wait for complete rewrite. */
 
diff --git a/source/blender/blenkernel/intern/softbody.c b/source/blender/blenkernel/intern/softbody.c
index 0500e924d2f..b322a0a803d 100644
--- a/source/blender/blenkernel/intern/softbody.c
+++ b/source/blender/blenkernel/intern/softbody.c
@@ -377,7 +377,7 @@ static void ccd_mesh_update(Object *ob, ccd_Mesh *pccd_M)
   pccd_M->bbmin[0] = pccd_M->bbmin[1] = pccd_M->bbmin[2] = 1e30f;
   pccd_M->bbmax[0] = pccd_M->bbmax[1] = pccd_M->bbmax[2] = -1e30f;
 
-  /* blow it up with forcefield ranges */
+  /* Blow it up with force-field ranges. */
   hull = max_ff(ob->pd->pdef_sbift, ob->pd->pdef_sboft);
 
   /* rotate current to previous */
@@ -848,7 +848,7 @@ static void renew_softbody(Object *ob, int totpoint, int totspring)
       }
       else {
         bp->goal = 0.0f;
-        /* so this will definily be below SOFTGOALSNAP */
+        /* So this will definitely be below #SOFTGOALSNAP. */
       }
 
       bp->nofsprings = 0;
@@ -1793,7 +1793,7 @@ static int sb_detect_vertex_collisionCached(float opco[3],
   return deflected;
 }
 
-/* sandbox to plug in various deflection algos */
+/* Sandbox to plug in various deflection algorithms. */
 static int sb_deflect_face(Object *ob,
                            float *actpos,
                            float *facenormal,
diff --git a/source/blender/blenloader/intern/versioning_250.c b/source/blender/blenloader/intern/versioning_250.c
index da4783e19ea..5d2072e0fd9 100644
--- a/source/blender/blenloader/intern/versioning_250.c
+++ b/source/blender/blenloader/intern/versioning_250.c
@@ -1465,7 +1465,7 @@ void blo_do_versions_250(FileData *fd, Library *lib, Main *bmain)
     } /* sequencer changes */
   }
 
-  if (bmain->versionfile <= 251) { /* 2.5.1 had no subversions */
+  if (bmain->versionfile <= 251) { /* 2.5.1 had no sub-versions */
     bScreen *screen;
 
     /* Blender 2.5.2 - subversion 0 introduced a new setting: V3D_HIDE_OVERLAYS.
diff --git a/source/blender/blenloader/intern/versioning_290.c b/source/blender/blenloader/intern/versioning_290.c
index 202b9ea692d..10f72f22b8e 100644
--- a/source/blender/blenloader/intern/versioning_290.c
+++ b/source/blender/blenloader/intern/versioning_290.c
@@ -1101,9 +1101,8 @@ void blo_do_versions_290(FileData *fd, Library *UNUSED(lib), Main *bmain)
         continue;
       }
 
-      /* The substep method changed from "per second" to "per frame".
-       * To get the new value simply divide the old bullet sim fps with the scene fps.
-       */
+      /* The sub-step method changed from "per second" to "per frame".
+       * To get the new value simply divide the old bullet sim FPS with the scene FPS. */
       rbw->substeps_per_frame /= FPS;
 
       if (rbw->substeps_per_frame <= 0) {
diff --git a/source/blender/blenloader/intern/versioning_300.cc b/source/blender/blenloader/intern/versioning_300.cc
index ff7c7f4480a..4c45e1433ab

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list