Cleanup: spelling

11 files changed, 46 insertions, 40 deletions

diff --git a/source/blender/blenkernel/BKE_attribute_math.hh b/source/blender/blenkernel/BKE_attribute_math.hh
index 606811ca12d..0294a8c09d5 100644
--- a/source/blender/blenkernel/BKE_attribute_math.hh
+++ b/source/blender/blenkernel/BKE_attribute_math.hh
@@ -242,8 +242,8 @@ template<> struct DefaultMixerStruct<bool> {
   {
     return value >= 0.5f;
   }
-  /* Store interpolated bools in a float temporary. Otherwise information provided by weights is
-   * easily rounded away. */
+  /* Store interpolated booleans in a float temporary.
+   * Otherwise information provided by weights is easily rounded away. */
   using type = SimpleMixerWithAccumulationType<bool, float, float_to_bool>;
 };
 
diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c
index b8a0ed087e0..a59ead84aca 100644
--- a/source/blender/blenkernel/intern/armature.c
+++ b/source/blender/blenkernel/intern/armature.c
@@ -1891,9 +1891,8 @@ void BKE_armature_mat_pose_to_bone_ex(struct Depsgraph *depsgraph,
    * bone loc/sca/rot is ignored, scene and frame are not used. */
   BKE_pose_where_is_bone(depsgraph, NULL, ob, &work_pchan, 0.0f, false);
 
-  /* find the matrix, need to remove the bone transforms first so this is
-   * calculated as a matrix to set rather than a difference ontop of what's
-   * already there. */
+  /* Find the matrix, need to remove the bone transforms first so this is calculated
+   * as a matrix to set rather than a difference on top of what's already there. */
   unit_m4(outmat);
   BKE_pchan_apply_mat4(&work_pchan, outmat, false);
 
@@ -1945,7 +1944,7 @@ void BKE_pchan_rot_to_mat3(const bPoseChannel *pchan, float r_mat[3][3])
     float quat[4];
 
     /* NOTE: we now don't normalize the stored values anymore,
-     * since this was kindof evil in some cases but if this proves to be too problematic,
+     * since this was kind of evil in some cases but if this proves to be too problematic,
      * switch back to the old system of operating directly on the stored copy. */
     normalize_qt_qt(quat, pchan->quat);
     quat_to_mat3(r_mat, quat);
diff --git a/source/blender/blenkernel/intern/attribute_access.cc b/source/blender/blenkernel/intern/attribute_access.cc
index cc833e094c8..d6ceb9beb70 100644
--- a/source/blender/blenkernel/intern/attribute_access.cc
+++ b/source/blender/blenkernel/intern/attribute_access.cc
@@ -515,7 +515,7 @@ CustomDataType cpp_type_to_custom_data_type(const blender::fn::CPPType &type)
  * "legacy" data structures. For example, some builtin attributes cannot be deleted. */
 class BuiltinAttributeProvider {
  public:
-  /* Some utility enums to avoid hard to read bools in function calls. */
+  /* Some utility enums to avoid hard to read booleans in function calls. */
   enum CreatableEnum {
     Creatable,
     NonCreatable,
diff --git a/source/blender/blenlib/intern/math_interp.c b/source/blender/blenlib/intern/math_interp.c
index 3cec3db9806..163a3ab5fe3 100644
--- a/source/blender/blenlib/intern/math_interp.c
+++ b/source/blender/blenlib/intern/math_interp.c
@@ -139,10 +139,10 @@ BLI_INLINE void bicubic_interpolation(const unsigned char *byte_buffer,
 
       y1 = j + m;
       CLAMP(y1, 0, height - 1);
-      /* normally we could do this */
-      /* w = P(n-a) * P(b-m); */
-      /* except that would call P() 16 times per pixel therefor pow() 64 times,
-       * better precalc these */
+      /* Normally we could do this:
+       * `w = P(n-a) * P(b-m);`
+       * except that would call `P()` 16 times per pixel therefor `pow()` 64 times,
+       * better pre-calculate these. */
       w = wx * wy[m + 1];
 
       if (float_output) {
diff --git a/source/blender/blenloader/intern/versioning_290.c b/source/blender/blenloader/intern/versioning_290.c
index 1c6d4d2dbe4..8891197a7d9 100644
--- a/source/blender/blenloader/intern/versioning_290.c
+++ b/source/blender/blenloader/intern/versioning_290.c
@@ -1669,7 +1669,7 @@ void blo_do_versions_290(FileData *fd, Library *UNUSED(lib), Main *bmain)
             SpaceImage *sima = (SpaceImage *)space;
             sima->iuser.flag |= IMA_SHOW_MAX_RESOLUTION;
           }
-          /* Enable Outliner render visibilty column. */
+          /* Enable Outliner render visibility column. */
           else if (space->spacetype == SPACE_OUTLINER) {
             SpaceOutliner *space_outliner = (SpaceOutliner *)space;
             space_outliner->show_restrict_flags |= SO_RESTRICT_RENDER;
diff --git a/source/blender/bmesh/operators/bmo_fill_grid.c b/source/blender/bmesh/operators/bmo_fill_grid.c
index 3aad37b3b02..df15778558b 100644
--- a/source/blender/bmesh/operators/bmo_fill_grid.c
+++ b/source/blender/bmesh/operators/bmo_fill_grid.c
@@ -326,8 +326,8 @@ static void bm_grid_fill_array(BMesh *bm,
       v = BM_vert_create(bm, co, NULL, BM_CREATE_NOP);
       v_grid[(y * xtot) + x] = v;
 
-      /* interpolate only along one axis, this could be changed
-       * but from user pov gives predictable results since these are selected loop */
+      /* Interpolate only along one axis, this could be changed
+       * but from user POV gives predictable results since these are selected loop. */
       if (use_vert_interp) {
         const float *w = weight_table[XY(x, y)];
 
diff --git a/source/blender/compositor/operations/COM_TonemapOperation.h b/source/blender/compositor/operations/COM_TonemapOperation.h
index 3870593b423..cb8816b93b3 100644
--- a/source/blender/compositor/operations/COM_TonemapOperation.h
+++ b/source/blender/compositor/operations/COM_TonemapOperation.h
@@ -22,7 +22,7 @@
 #include "DNA_node_types.h"
 
 /**
- * \brief temporarily storage during execution of Tonemap
+ * \brief temporarily storage during execution of Tone-map
  * \ingroup operation
  */
 typedef struct AvgLogLum {
diff --git a/source/blender/draw/engines/eevee/eevee_shaders.c b/source/blender/draw/engines/eevee/eevee_shaders.c
index 52d330c3ad2..82b2395cc6e 100644
--- a/source/blender/draw/engines/eevee/eevee_shaders.c
+++ b/source/blender/draw/engines/eevee/eevee_shaders.c
@@ -438,7 +438,7 @@ GPUShader *EEVEE_shaders_probe_planar_display_sh_get(void)
 }
 
 /* -------------------------------------------------------------------- */
-/** \name Downsampling
+/** \name Down-sampling
  * \{ */
 
 GPUShader *EEVEE_shaders_effect_downsample_sh_get(void)
diff --git a/source/blender/editors/gpencil/gpencil_fill.c b/source/blender/editors/gpencil/gpencil_fill.c
index 72d58b78219..832191c8321 100644
--- a/source/blender/editors/gpencil/gpencil_fill.c
+++ b/source/blender/editors/gpencil/gpencil_fill.c
@@ -93,7 +93,7 @@ enum {
   GP_DRAWFILLS_ONLY3D = (1 << 1),   /* only draw 3d-strokes */
 };
 
-/* Temporary fill operation data (op->customdata) */
+/* Temporary fill operation data `op->customdata`. */
 typedef struct tGPDfill {
   bContext *C;
   struct Main *bmain;
@@ -112,7 +112,7 @@ typedef struct tGPDfill {
   struct View3D *v3d;
   /** region where painting originated */
   struct ARegion *region;
-  /** current GP datablock */
+  /** Current GP data-block. */
   struct bGPdata *gpd;
   /** current material */
   struct Material *mat;
@@ -172,9 +172,9 @@ typedef struct tGPDfill {
   /** handle for drawing strokes while operator is running 3d stuff */
   void *draw_handle_3d;
 
-  /* tmp size x */
+  /* Temporary size x. */
   int bwinx;
-  /* tmp size y */
+  /* Temporary size y. */
   int bwiny;
   rcti brect;
 
@@ -610,7 +610,7 @@ static void gpencil_draw_datablock(tGPDfill *tgpf, const float ink[4])
   GPU_blend(GPU_BLEND_NONE);
 }
 
-/* draw strokes in offscreen buffer */
+/* Draw strokes in off-screen buffer. */
 static bool gpencil_render_offscreen(tGPDfill *tgpf)
 {
   bool is_ortho = false;
@@ -661,7 +661,7 @@ static bool gpencil_render_offscreen(tGPDfill *tgpf)
                                      &clip_end,
                                      NULL);
 
-  /* Rescale viewplane to fit all strokes. */
+  /* Rescale `viewplane` to fit all strokes. */
   float width = viewplane.xmax - viewplane.xmin;
   float height = viewplane.ymax - viewplane.ymin;
 
@@ -734,21 +734,21 @@ static bool gpencil_render_offscreen(tGPDfill *tgpf)
 
   BKE_image_release_ibuf(tgpf->ima, ibuf, NULL);
 
-  /* switch back to window-system-provided framebuffer */
+  /* Switch back to window-system-provided frame-buffer. */
   GPU_offscreen_unbind(offscreen, true);
   GPU_offscreen_free(offscreen);
 
   return true;
 }
 
-/* return pixel data (rgba) at index */
+/* Return pixel data (RGBA) at index. */
 static void get_pixel(const ImBuf *ibuf, const int idx, float r_col[4])
 {
   BLI_assert(ibuf->rect_float != NULL);
   memcpy(r_col, &ibuf->rect_float[idx * 4], sizeof(float[4]));
 }
 
-/* set pixel data (rgba) at index */
+/* Set pixel data (RGBA) at index. */
 static void set_pixel(ImBuf *ibuf, int idx, const float col[4])
 {
   BLI_assert(ibuf->rect_float != NULL);
@@ -890,17 +890,20 @@ static void gpencil_boundaryfill_area(tGPDfill *tgpf)
     }
   }
 
-  /* the fill use a stack to save the pixel list instead of the common recursive
+  /**
+   * The fill use a stack to save the pixel list instead of the common recursive
    * 4-contact point method.
    * The problem with recursive calls is that for big fill areas, we can get max limit
    * of recursive calls and STACK_OVERFLOW error.
    *
    * The 4-contact point analyze the pixels to the left, right, bottom and top
-   *      -----------
-   *      |    X    |
-   *      |   XoX   |
-   *      |    X    |
-   *      -----------
+   * <pre>
+   * -----------
+   * |    X    |
+   * |   XoX   |
+   * |    X    |
+   * -----------
+   * </pre>
    */
   while (!BLI_stack_is_empty(stack)) {
     int v;
@@ -988,7 +991,7 @@ static void gpencil_set_borders(tGPDfill *tgpf, const bool transparent)
   tgpf->ima->id.tag |= LIB_TAG_DOIT;
 }
 
-/* Invert image to paint invese area. */
+/* Invert image to paint inverse area. */
 static void gpencil_invert_image(tGPDfill *tgpf)
 {
   ImBuf *ibuf;
@@ -1092,16 +1095,19 @@ static void gpencil_erase_processed_area(tGPDfill *tgpf)
   tgpf->ima->id.tag |= LIB_TAG_DOIT;
 }
 
-/* Naive dilate
+/**
+ * Naive dilate
  *
  * Expand green areas into enclosing red areas.
  * Using stack prevents creep when replacing colors directly.
+ * <pre>
  * -----------
  *  XXXXXXX
  *  XoooooX
  *  XXooXXX
  *   XXXX
  * -----------
+ * </pre>
  */
 static bool dilate_shape(ImBuf *ibuf)
 {
@@ -1276,7 +1282,7 @@ static void gpencil_get_outline_points(tGPDfill *tgpf, const bool dilate)
     int cur_back_offset = -1;
     for (int i = 0; i < NEIGHBOR_COUNT; i++) {
       if (backtracked_offset[0][0] == offset[i][0] && backtracked_offset[0][1] == offset[i][1]) {
-        /* Finding the bracktracked pixel offset index */
+        /* Finding the back-tracked pixel offset index */
         cur_back_offset = i;
         break;
       }
@@ -1306,7 +1312,7 @@ static void gpencil_get_outline_points(tGPDfill *tgpf, const bool dilate)
       cur_back_offset++;
       loop++;
     }
-    /* Current pixel is equal to starting or firt pixel. */
+    /* Current pixel is equal to starting or first pixel. */
     if ((boundary_co[0] == start_co[0] && boundary_co[1] == start_co[1]) ||
         (boundary_co[0] == first_co[0] && boundary_co[1] == first_co[1])) {
       BLI_stack_pop(tgpf->stack, &v);
@@ -1323,7 +1329,7 @@ static void gpencil_get_outline_points(tGPDfill *tgpf, const bool dilate)
   BKE_image_release_ibuf(tgpf->ima, ibuf, lock);
 }
 
-/* get z-depth array to reproject on surface */
+/* Get z-depth array to reproject on surface. */
 static void gpencil_get_depth_array(tGPDfill *tgpf)
 {
   tGPspoint *ptc;
@@ -1374,7 +1380,7 @@ static void gpencil_get_depth_array(tGPDfill *tgpf)
     }
 
     if (found_depth == false) {
-      /* eeh... not much we can do.. :/, ignore depth in this case */
+      /* Sigh! not much we can do here. Ignore depth in this case. */
       for (i = totpoints - 1; i >= 0; i--) {
         tgpf->depth_arr[i] = 0.9999f;
       }
diff --git a/source/blender/editors/object/object_add.c b/source/blender/editors/object/object_add.c
index 2d3505fa9d0..b6b6dcfaa59 100644
--- a/source/blender/editors/object/object_add.c
+++ b/source/blender/editors/object/object_add.c
@@ -516,7 +516,7 @@ bool ED_object_add_generic_get_opts(bContext *C,
     if (RNA_struct_property_is_set(op->ptr, "rotation")) {
       /* If rotation is set, always use it. Alignment (and corresponding user preference)
        * can be ignored since this is in world space anyways.
-       * To not confuse (e.g. on redo), dont set it to ALIGN_WORLD in the op UI though. */
+       * To not confuse (e.g. on redo), don't set it to #ALIGN_WORLD in the op UI though. */
       *is_view_aligned = false;
       RNA_float_get_array(op->ptr, "rotation", rot);
     }
diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h
index 1eafa655195..c66618c0acd 100644
--- a/source/blender/makesdna/DNA_anim_types.h
+++ b/source/blender/makesdna/DNA_anim_types.h
@@ -438,9 +438,10 @@ typedef enum eDriverVar_Types {
   /** 'final' transform for object/bones */
   DVAR_TYPE_TRANSFORM_CHAN,
 
-  /** Maximum number of variable types.
+  /**
+   * Maximum number of variable types.
    *
-   * \note This must always be th last item in this list,
+   * \note This must always be the last item in this list,
    * so add new types above this line.
    */
   MAX_DVAR_TYPES,