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

Campbell Barton noreply at git.blender.org
Thu Aug 26 04:47:33 CEST 2021


Commit: afcd06e1e11b1166deb55b0ce05b777706369028
Author: Campbell Barton
Date:   Thu Aug 26 12:27:14 2021 +1000
Branches: master
https://developer.blender.org/rBafcd06e1e11b1166deb55b0ce05b777706369028

Cleanup: spelling in comments

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

M	intern/cycles/kernel/closure/bsdf_microfacet.h
M	intern/ghost/intern/GHOST_SystemCocoa.mm
M	intern/ghost/intern/GHOST_SystemX11.cpp
M	source/blender/blenfont/intern/blf_dir.c
M	source/blender/draw/engines/image/image_engine.c
M	source/blender/editors/render/render_opengl.c
M	source/blender/editors/transform/transform.c
M	source/blender/gpu/GPU_capabilities.h
M	source/blender/modifiers/intern/MOD_collision.c
M	source/blender/sequencer/intern/iterator.c
M	source/blender/sequencer/intern/sequencer.c

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

diff --git a/intern/cycles/kernel/closure/bsdf_microfacet.h b/intern/cycles/kernel/closure/bsdf_microfacet.h
index aed4b849aca..af03bab39f7 100644
--- a/intern/cycles/kernel/closure/bsdf_microfacet.h
+++ b/intern/cycles/kernel/closure/bsdf_microfacet.h
@@ -1050,7 +1050,7 @@ ccl_device int bsdf_microfacet_beckmann_sample(KernelGlobals *kg,
             float D, G1i;
 
             if (alpha_x == alpha_y) {
-              /* istropic distribution */
+              /* Isotropic distribution. */
               float cosThetaM2 = cosThetaM * cosThetaM;
               float cosThetaM4 = cosThetaM2 * cosThetaM2;
               float tanThetaM2 = 1 / (cosThetaM2)-1;
diff --git a/intern/ghost/intern/GHOST_SystemCocoa.mm b/intern/ghost/intern/GHOST_SystemCocoa.mm
index 933e0c70cc8..189e663f91a 100644
--- a/intern/ghost/intern/GHOST_SystemCocoa.mm
+++ b/intern/ghost/intern/GHOST_SystemCocoa.mm
@@ -424,7 +424,7 @@ extern "C" int GHOST_HACK_getFirstFile(char buf[FIRSTFILEBUFLG])
 {
   /* TODO: implement graceful termination through Cocoa mechanism
    * to avoid session log off to be canceled. */
-  /* Note that Cmd+Q is already handled by keyhandler. */
+  /* Note that Cmd+Q is already handled by key-handler. */
   systemCocoa->handleQuitRequest();
   return NSTerminateCancel;
 }
diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp
index 9422d15692d..10ccb00cc15 100644
--- a/intern/ghost/intern/GHOST_SystemX11.cpp
+++ b/intern/ghost/intern/GHOST_SystemX11.cpp
@@ -1922,7 +1922,7 @@ static GHOST_TKey ghost_key_from_keycode(const XkbDescPtr xkb_descr, const KeyCo
 
 #undef MAKE_ID
 
-/* from xclip.c xcout() v0.11 */
+/* From `xclip.c` #xcout() v0.11. */
 
 #define XCLIB_XCOUT_NONE 0          /* no context */
 #define XCLIB_XCOUT_SENTCONVSEL 1   /* sent a request */
diff --git a/source/blender/blenfont/intern/blf_dir.c b/source/blender/blenfont/intern/blf_dir.c
index 9520e971148..55c02b34f3d 100644
--- a/source/blender/blenfont/intern/blf_dir.c
+++ b/source/blender/blenfont/intern/blf_dir.c
@@ -172,12 +172,12 @@ char *blf_dir_metrics_search(const char *filename)
     s[1] = 'f';
     s[2] = 'm';
 
-    /* first check .afm */
+    /* First check `.afm`. */
     if (BLI_exists(mfile)) {
       return mfile;
     }
 
-    /* and now check .pfm */
+    /* And now check `.pfm`. */
     s[0] = 'p';
 
     if (BLI_exists(mfile)) {
diff --git a/source/blender/draw/engines/image/image_engine.c b/source/blender/draw/engines/image/image_engine.c
index b4c0ade380e..662238df270 100644
--- a/source/blender/draw/engines/image/image_engine.c
+++ b/source/blender/draw/engines/image/image_engine.c
@@ -120,7 +120,7 @@ static void space_image_gpu_texture_get(Image *image,
   }
 
   if (ibuf->rect == NULL && ibuf->rect_float == NULL) {
-    /* This codepath is only supposed to happen when drawing a lazily-allocatable render result.
+    /* This code-path is only supposed to happen when drawing a lazily-allocatable render result.
      * In all the other cases the `ED_space_image_acquire_buffer()` is expected to return NULL as
      * an image buffer when it has no pixels. */
 
diff --git a/source/blender/editors/render/render_opengl.c b/source/blender/editors/render/render_opengl.c
index 749010a5ba3..834c023dde9 100644
--- a/source/blender/editors/render/render_opengl.c
+++ b/source/blender/editors/render/render_opengl.c
@@ -697,7 +697,7 @@ static void gather_frames_to_render(bContext *C, OGLRender *oglrender)
     AnimData *adt = BKE_animdata_from_id(id);
     gather_frames_to_render_for_adt(oglrender, adt);
 
-    /* Gather the frames from linked datablocks (materials, shapkeys, etc.). */
+    /* Gather the frames from linked data-blocks (materials, shape-keys, etc.). */
     BKE_library_foreach_ID_link(
         NULL, id, gather_frames_to_render_for_id, oglrender, IDWALK_RECURSE);
   }
diff --git a/source/blender/editors/transform/transform.c b/source/blender/editors/transform/transform.c
index 7287927a0be..58491f8c2d3 100644
--- a/source/blender/editors/transform/transform.c
+++ b/source/blender/editors/transform/transform.c
@@ -1400,7 +1400,7 @@ static void drawTransformPixel(const struct bContext *C, ARegion *region, void *
 
     /* draw auto-key-framing hint in the corner
      * - only draw if enabled (advanced users may be distracted/annoyed),
-     *   for objects that will be autokeyframed (no point otherwise),
+     *   for objects that will be auto-keyframed (no point otherwise),
      *   AND only for the active region (as showing all is too overwhelming)
      */
     if ((U.autokey_flag & AUTOKEY_FLAG_NOWARNING) == 0) {
diff --git a/source/blender/gpu/GPU_capabilities.h b/source/blender/gpu/GPU_capabilities.h
index 0c054d4f264..5b5d0f16c9f 100644
--- a/source/blender/gpu/GPU_capabilities.h
+++ b/source/blender/gpu/GPU_capabilities.h
@@ -22,7 +22,7 @@
  *
  * GPU Capabilities & workarounds
  * This module expose the reported implementation limits & enabled
- * workaround for drivers that needs specific codepaths.
+ * workaround for drivers that needs specific code-paths.
  */
 
 #pragma once
diff --git a/source/blender/modifiers/intern/MOD_collision.c b/source/blender/modifiers/intern/MOD_collision.c
index e7d5fe056c5..d94e9a988c6 100644
--- a/source/blender/modifiers/intern/MOD_collision.c
+++ b/source/blender/modifiers/intern/MOD_collision.c
@@ -277,8 +277,8 @@ static void blendRead(BlendDataReader *UNUSED(reader), ModifierData *md)
 {
   CollisionModifierData *collmd = (CollisionModifierData *)md;
 #if 0
-      // TODO: CollisionModifier should use pointcache
-      // + have proper reset events before enabling this
+      /* TODO: #CollisionModifier should use point-cache
+       * + have proper reset events before enabling this. */
       collmd->x = newdataadr(fd, collmd->x);
       collmd->xnew = newdataadr(fd, collmd->xnew);
       collmd->mfaces = newdataadr(fd, collmd->mfaces);
diff --git a/source/blender/sequencer/intern/iterator.c b/source/blender/sequencer/intern/iterator.c
index 2ac93ccc9d3..a9cbf4879f1 100644
--- a/source/blender/sequencer/intern/iterator.c
+++ b/source/blender/sequencer/intern/iterator.c
@@ -107,14 +107,13 @@ static bool seq_for_each_recursive(ListBase *seqbase, SeqForEachFunc callback, v
 }
 
 /**
- * Utility function to recursivily iterate through all sequence strips in a seqbase list.
+ * Utility function to recursively iterate through all sequence strips in a `seqbase` list.
  * Uses callback to do operations on each sequence element.
  * The callback can stop the iteration if needed.
  *
- * \param seqbase: ListBase of sequences to be iterated over
- * \param callback: query function callback, returns false if iteration should stop
- * \param user_data: pointer to user data that can be used in the callback function
- *
+ * \param seqbase: #ListBase of sequences to be iterated over.
+ * \param callback: query function callback, returns false if iteration should stop.
+ * \param user_data: pointer to user data that can be used in the callback function.
  */
 void SEQ_for_each_callback(ListBase *seqbase, SeqForEachFunc callback, void *user_data)
 {
diff --git a/source/blender/sequencer/intern/sequencer.c b/source/blender/sequencer/intern/sequencer.c
index 49d08d0e022..2863af8fb2e 100644
--- a/source/blender/sequencer/intern/sequencer.c
+++ b/source/blender/sequencer/intern/sequencer.c
@@ -755,9 +755,9 @@ static bool seq_write_data_cb(Sequence *seq, void *userdata)
   BlendWriter *writer = (BlendWriter *)userdata;
   BLO_write_struct(writer, Sequence, seq);
   if (seq->strip && seq->strip->done == 0) {
-    /* write strip with 'done' at 0 because readfile */
+    /* Write strip with 'done' at 0 because read-file. */
 
-    // TODO this doesn't depend on the `Strip` data to be present?
+    /* TODO this doesn't depend on the `Strip` data to be present? */
     if (seq->effectdata) {
       switch (seq->type) {
         case SEQ_TYPE_COLOR:



More information about the Bf-blender-cvs mailing list