[Bf-blender-cvs] [8b06c524d20] master: Cleanup: spelling in comments, function name

Campbell Barton noreply at git.blender.org
Fri Mar 4 00:31:55 CET 2022


Commit: 8b06c524d207f5e67ef22d6a1869c94d8f91717f
Author: Campbell Barton
Date:   Fri Mar 4 10:29:53 2022 +1100
Branches: master
https://developer.blender.org/rB8b06c524d207f5e67ef22d6a1869c94d8f91717f

Cleanup: spelling in comments, function name

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

M	intern/cycles/integrator/path_trace.cpp
M	source/blender/draw/engines/gpencil/gpencil_render.c
M	source/blender/draw/engines/image/image_drawing_mode.hh
M	source/blender/editors/gpencil/annotate_draw.c
M	source/blender/editors/gpencil/annotate_paint.c
M	source/blender/editors/gpencil/gpencil_paint.c
M	source/blender/editors/include/ED_numinput.h
M	source/blender/editors/interface/interface_handlers.c
M	source/blender/editors/mesh/editmesh_select.c
M	source/blender/editors/object/object_bake.c
M	source/blender/editors/object/object_bake_api.c
M	source/blender/editors/render/render_internal.cc
M	source/blender/editors/render/render_preview.cc
M	source/blender/editors/render/render_shading.cc
M	source/blender/editors/space_image/image_sequence.c
M	source/blender/editors/transform/transform_mode_timescale.c
M	source/blender/editors/transform/transform_mode_timeslide.c
M	source/blender/editors/transform/transform_mode_timetranslate.c
M	source/blender/editors/util/ed_draw.c
M	source/blender/editors/uvedit/uvedit_ops.c
M	source/blender/makesdna/DNA_screen_types.h
M	source/blender/makesdna/DNA_space_types.h
M	source/blender/makesdna/DNA_windowmanager_types.h
M	source/blender/windowmanager/intern/wm.c
M	source/blender/windowmanager/intern/wm_init_exit.c
M	source/blender/windowmanager/intern/wm_window.c

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

diff --git a/intern/cycles/integrator/path_trace.cpp b/intern/cycles/integrator/path_trace.cpp
index eb12b0a6a11..ab134179602 100644
--- a/intern/cycles/integrator/path_trace.cpp
+++ b/intern/cycles/integrator/path_trace.cpp
@@ -466,7 +466,7 @@ void PathTrace::set_denoiser_params(const DenoiseParams &params)
   denoiser_ = Denoiser::create(device_, params);
 
   /* Only take into account the "immediate" cancel to have interactive rendering responding to
-   * navigation as quickly as possible, but allow to run denoiser after user hit Esc button while
+   * navigation as quickly as possible, but allow to run denoiser after user hit Escape key while
    * doing offline rendering. */
   denoiser_->is_cancelled_cb = [this]() { return render_cancel_.is_requested; };
 }
diff --git a/source/blender/draw/engines/gpencil/gpencil_render.c b/source/blender/draw/engines/gpencil/gpencil_render.c
index 9c3779c18ad..19afdb3de5a 100644
--- a/source/blender/draw/engines/gpencil/gpencil_render.c
+++ b/source/blender/draw/engines/gpencil/gpencil_render.c
@@ -174,7 +174,7 @@ static void GPENCIL_render_result_z(struct RenderLayer *rl,
 
     int pix_ct = BLI_rcti_size_x(rect) * BLI_rcti_size_y(rect);
 
-    /* Convert ogl depth [0..1] to view Z [near..far] */
+    /* Convert GPU depth [0..1] to view Z [near..far] */
     if (DRW_view_is_persp_get(NULL)) {
       for (int i = 0; i < pix_ct; i++) {
         if (rp->rect[i] == 1.0f) {
diff --git a/source/blender/draw/engines/image/image_drawing_mode.hh b/source/blender/draw/engines/image/image_drawing_mode.hh
index c091f800d95..46482ab6668 100644
--- a/source/blender/draw/engines/image/image_drawing_mode.hh
+++ b/source/blender/draw/engines/image/image_drawing_mode.hh
@@ -401,7 +401,7 @@ template<typename TextureMethod> class ScreenSpaceDrawingMode : public AbstractD
   /**
    * \brief Ensure that the float buffer of the given image buffer is available.
    *
-   * Returns true when a float buffer was created. Somehow the VSE cache increases the ref
+   * Returns true when a float buffer was created. Somehow the sequencer cache increases the ref
    * counter, but might use a different mechanism for destructing the image, that doesn't free the
    * rect_float as the reference-counter isn't 0. To work around this we destruct any created local
    * buffers ourself.
diff --git a/source/blender/editors/gpencil/annotate_draw.c b/source/blender/editors/gpencil/annotate_draw.c
index f175145fca7..f720f261ad5 100644
--- a/source/blender/editors/gpencil/annotate_draw.c
+++ b/source/blender/editors/gpencil/annotate_draw.c
@@ -110,7 +110,9 @@ static void annotation_draw_stroke_arrow_buffer(uint pos,
   immEnd();
 }
 
-/* draw stroke defined in buffer (simple ogl lines/points for now, as dotted lines) */
+/**
+ * Draw stroke defined in buffer (simple GPU lines/points for now, as dotted lines).
+ */
 static void annotation_draw_stroke_buffer(bGPdata *gps,
                                           short thickness,
                                           short dflag,
@@ -298,7 +300,9 @@ static void annotation_draw_stroke_point(const bGPDspoint *points,
   immUnbindProgram();
 }
 
-/* draw a given stroke in 3d (i.e. in 3d-space), using simple ogl lines */
+/**
+ * Draw a given stroke in 3d (i.e. in 3d-space), using simple GPU lines.
+ */
 static void annotation_draw_stroke_3d(
     const bGPDspoint *points, int totpoints, short thickness, const float ink[4], bool cyclic)
 {
diff --git a/source/blender/editors/gpencil/annotate_paint.c b/source/blender/editors/gpencil/annotate_paint.c
index 5ab4a663efe..1a7b034f2f8 100644
--- a/source/blender/editors/gpencil/annotate_paint.c
+++ b/source/blender/editors/gpencil/annotate_paint.c
@@ -2466,10 +2466,10 @@ static int annotation_draw_modal(bContext *C, wmOperator *op, const wmEvent *eve
                   EVT_PAD7,
                   EVT_PAD8,
                   EVT_PAD9)) {
-      /* allow numpad keys so that camera/view manipulations can still take place
-       * - PAD0 in particular is really important for Grease Pencil drawing,
+      /* Allow numpad keys so that camera/view manipulations can still take place
+       * - #EVT_PAD0 in particular is really important for Grease Pencil drawing,
        *   as animators may be working "to camera", so having this working
-       *   is essential for ensuring that they can quickly return to that view
+       *   is essential for ensuring that they can quickly return to that view.
        */
     }
     else if ((event->type == EVT_BKEY) && (event->val == KM_RELEASE)) {
diff --git a/source/blender/editors/gpencil/gpencil_paint.c b/source/blender/editors/gpencil/gpencil_paint.c
index 4862545e917..22bdc1af119 100644
--- a/source/blender/editors/gpencil/gpencil_paint.c
+++ b/source/blender/editors/gpencil/gpencil_paint.c
@@ -3649,10 +3649,10 @@ static int gpencil_draw_modal(bContext *C, wmOperator *op, const wmEvent *event)
                   EVT_PAD7,
                   EVT_PAD8,
                   EVT_PAD9)) {
-      /* allow numpad keys so that camera/view manipulations can still take place
-       * - PAD0 in particular is really important for Grease Pencil drawing,
+      /* Allow numpad keys so that camera/view manipulations can still take place
+       * - #EVT_PAD0 in particular is really important for Grease Pencil drawing,
        *   as animators may be working "to camera", so having this working
-       *   is essential for ensuring that they can quickly return to that view
+       *   is essential for ensuring that they can quickly return to that view.
        */
     }
     else if ((!ELEM(p->paintmode, GP_PAINTMODE_ERASER, GP_PAINTMODE_SET_CP))) {
diff --git a/source/blender/editors/include/ED_numinput.h b/source/blender/editors/include/ED_numinput.h
index 77c3794b6fc..12e3ffee627 100644
--- a/source/blender/editors/include/ED_numinput.h
+++ b/source/blender/editors/include/ED_numinput.h
@@ -66,14 +66,14 @@ struct UnitSettings;
  * \{ */
 
 /**
- * There are important things to note here for code using numinput:
+ * There are important things to note here for code using numeric-input:
  * - Values passed to #applyNumInput() should be valid and are stored as default ones (val_org),
  *   if it is not EDITED.
- * - bool returned by #applyNumInput should be used to decide whether to apply
- *   numinput-specific post-process to data.
+ * - `bool` returned by #applyNumInput should be used to decide whether to apply
+ *   numeric-input-specific post-process to data.
  * - Once #applyNumInput has been called,
- *   #hasNumInput returns a valid value to decide whether to use numinput as drawstr source or not
- *   (i.e. to call #outputNumInput).
+ *   #hasNumInput returns a valid value to decide whether to use numinput as `drawstr`
+ *   source or not (i.e. to call #outputNumInput).
  *
  * Those two steps have to be separated
  * (so do not use a common call to #hasNumInput() to do both in the same time!).
diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c
index 80fef93faf8..dbb2ea1dd42 100644
--- a/source/blender/editors/interface/interface_handlers.c
+++ b/source/blender/editors/interface/interface_handlers.c
@@ -3903,8 +3903,8 @@ static void ui_do_but_textedit(
       char ascii = event->ascii;
       const char *utf8_buf = event->utf8_buf;
 
-      /* exception that's useful for number buttons, some keyboard
-       * numpads have a comma instead of a period */
+      /* Exception that's useful for number buttons, some keyboard
+       * numpads have a comma instead of a period. */
       if (ELEM(but->type, UI_BTYPE_NUM, UI_BTYPE_NUM_SLIDER)) { /* Could use `data->min`. */
         if (event->type == EVT_PADPERIOD && ascii == ',') {
           ascii = '.';
diff --git a/source/blender/editors/mesh/editmesh_select.c b/source/blender/editors/mesh/editmesh_select.c
index d8fc7a4f9d4..8784b1a90d9 100644
--- a/source/blender/editors/mesh/editmesh_select.c
+++ b/source/blender/editors/mesh/editmesh_select.c
@@ -3552,7 +3552,7 @@ static int edbm_select_linked_pick_invoke(bContext *C, wmOperator *op, const wmE
     return edbm_select_linked_pick_exec(C, op);
   }
 
-  /* unified_finednearest needs ogl */
+  /* #unified_findnearest needs OpenGL. */
   view3d_operator_needs_opengl(C);
 
   /* setup view context for argument to callbacks */
diff --git a/source/blender/editors/object/object_bake.c b/source/blender/editors/object/object_bake.c
index 8f5aa919ec0..dbb6916dfce 100644
--- a/source/blender/editors/object/object_bake.c
+++ b/source/blender/editors/object/object_bake.c
@@ -571,7 +571,7 @@ static int multiresbake_image_exec(bContext *C, wmOperator *op)
 
 /* ****************** render BAKING ********************** */
 
-/* catch esc */
+/** Catch escape key to cancel. */
 static int objects_bake_render_modal(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
 {
   /* no running blender, remove handler and pass through */
diff --git a/source/blender/editors/object/object_bake_api.c b/source/blender/editors/object/object_bake_api.c
index 3b40a10eb2a..3529574a3a4 100644
--- a/source/blender/editors/object/object_bake_api.c
+++ b/source/blender/editors/object/object_bake_api.c
@@ -123,7 +123,7 @@ static void bake_progress_update(void *bjv, float progress)
   }
 }
 
-/* catch esc */
+/** Catch escape key to cancel. */
 static int bake_modal(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
 {
   /* no running blender, remove handler and pass through */
diff --git a/source/blender/editors/render/render_internal.cc b/source/blender/editors/render/render_internal.cc
index 03c0f3977b7..33b68dfb47b 100644
--- a/source/blender/editors/render/render_internal.cc
+++ b/source/blender/editors/render/render_internal.cc
@@ -818,7 +818,7 @@ static void render_drawlock(void *rjv, bool lock)
   }
 }
 
-/* catch esc */
+/** Catch escape key to cancel. */
 static int screen_render_modal(bContext *C, wmOperator *op, const wmEvent *event)
 {
   Scene *scene = (Scene *)op->customdata;
diff --git a/source/blender/editors/render/render_preview.cc b/source/blender/editors/render/render_preview.cc
index eca30a6ac25..cfb88cd7868 100644
--- a/source/blender/editors/render/rend

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list