[Bf-blender-cvs] [427a2c920a2] master: Cleanup: spelling in comments, capitalize tags

Campbell Barton noreply at git.blender.org
Fri May 13 01:45:09 CEST 2022


Commit: 427a2c920a249c066e324e4a5e40dd141a4968aa
Author: Campbell Barton
Date:   Fri May 13 09:24:28 2022 +1000
Branches: master
https://developer.blender.org/rB427a2c920a249c066e324e4a5e40dd141a4968aa

Cleanup: spelling in comments, capitalize tags

Also add missing task-ID reference & remove colon after \note as it
doesn't render properly in doxygen.

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

M	intern/cycles/device/metal/kernel.mm
M	intern/cycles/kernel/osl/services.h
M	intern/ghost/intern/GHOST_SystemCocoa.mm
M	intern/ghost/intern/GHOST_WindowCocoa.mm
M	intern/ghost/intern/GHOST_WindowWin32.cpp
M	intern/iksolver/intern/IK_QTask.cpp
M	intern/libmv/libmv/multiview/euclidean_resection.h
M	intern/opensubdiv/internal/evaluator/eval_output_cpu.h
M	intern/rigidbody/RBI_api.h
M	source/blender/blenkernel/BKE_constraint.h
M	source/blender/blenkernel/BKE_image.h
M	source/blender/blenkernel/BKE_subdiv.h
M	source/blender/blenkernel/intern/anim_sys.c
M	source/blender/blenkernel/intern/blender_copybuffer.c
M	source/blender/blenkernel/intern/cloth.c
M	source/blender/blenkernel/intern/gpencil.c
M	source/blender/blenkernel/intern/node.cc
M	source/blender/blenkernel/intern/particle.c
M	source/blender/blenkernel/intern/pbvh_intern.h
M	source/blender/blenlib/BLI_any.hh
M	source/blender/blenlib/BLI_bitmap.h
M	source/blender/blenlib/BLI_virtual_array.hh
M	source/blender/blenlib/intern/hash_md5.c
M	source/blender/blenlib/intern/scanfill.c
M	source/blender/bmesh/intern/bmesh_core.c
M	source/blender/bmesh/intern/bmesh_mods.c
M	source/blender/bmesh/intern/bmesh_polygon.c
M	source/blender/bmesh/tools/bmesh_bevel.c
M	source/blender/draw/engines/eevee/eevee_lightcache.c
M	source/blender/draw/engines/eevee/shaders/volumetric_frag.glsl
M	source/blender/draw/engines/eevee/shaders/volumetric_integration_frag.glsl
M	source/blender/draw/engines/eevee_next/shaders/infos/eevee_material_info.hh
M	source/blender/draw/engines/gpencil/gpencil_cache_utils.c
M	source/blender/draw/engines/overlay/shaders/outline_detect_frag.glsl
M	source/blender/draw/engines/workbench/shaders/infos/workbench_prepass_info.hh
M	source/blender/draw/engines/workbench/shaders/workbench_volume_frag.glsl
M	source/blender/draw/intern/draw_cache_impl_mesh.c
M	source/blender/draw/intern/draw_hair.cc
M	source/blender/draw/intern/draw_manager.c
M	source/blender/draw/intern/shaders/common_hair_lib.glsl
M	source/blender/editors/gizmo_library/gizmo_draw_utils.c
M	source/blender/editors/gizmo_library/gizmo_types/button2d_gizmo.c
M	source/blender/editors/gizmo_library/gizmo_types/dial3d_gizmo.c
M	source/blender/editors/gizmo_library/gizmo_types/move3d_gizmo.c
M	source/blender/editors/include/ED_anim_api.h
M	source/blender/editors/include/ED_screen.h
M	source/blender/editors/mesh/editmesh_knife.c
M	source/blender/editors/object/object_add.cc
M	source/blender/editors/screen/screen_edit.c
M	source/blender/editors/space_sequencer/sequencer_channels_draw.c
M	source/blender/editors/space_sequencer/sequencer_edit.c
M	source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.cpp
M	source/blender/functions/FN_field.hh
M	source/blender/gpencil_modifiers/intern/lineart/MOD_lineart.h
M	source/blender/gpu/GPU_state.h
M	source/blender/gpu/intern/gpu_material.c
M	source/blender/gpu/metal/mtl_context.hh
M	source/blender/gpu/metal/mtl_context.mm
M	source/blender/gpu/metal/mtl_state.mm
M	source/blender/gpu/metal/mtl_texture.mm
M	source/blender/imbuf/IMB_imbuf_types.h
M	source/blender/imbuf/intern/dds/Stream.cpp
M	source/blender/io/collada/AnimationImporter.h
M	source/blender/io/collada/MeshImporter.h
M	source/blender/io/wavefront_obj/exporter/obj_export_file_writer.cc
M	source/blender/io/wavefront_obj/exporter/obj_export_io.hh
M	source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh
M	source/blender/io/wavefront_obj/importer/obj_import_string_utils.cc
M	source/blender/io/wavefront_obj/tests/obj_importer_tests.cc
M	source/blender/makesdna/DNA_space_types.h
M	source/blender/nodes/geometry/nodes/node_geo_curve_to_points.cc
M	source/blender/nodes/geometry/nodes/node_geo_extrude_mesh.cc
M	source/blender/nodes/shader/nodes/node_shader_tex_image.cc
M	source/blender/python/intern/bpy_rna.c
M	source/blender/render/intern/texture_image.c
M	source/blender/render/intern/texture_procedural.c
M	source/blender/windowmanager/WM_api.h
M	source/blender/windowmanager/intern/wm_event_system.c

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

diff --git a/intern/cycles/device/metal/kernel.mm b/intern/cycles/device/metal/kernel.mm
index fc9a8cecd75..304efc813ec 100644
--- a/intern/cycles/device/metal/kernel.mm
+++ b/intern/cycles/device/metal/kernel.mm
@@ -172,7 +172,7 @@ void ShaderCache::load_kernel(DeviceKernel device_kernel,
     for (auto &pipeline : pipelines[device_kernel]) {
       if (scene_specialized) {
         if (pipeline->source_md5 == device->source_md5[PSO_SPECIALISED]) {
-          /* we already requested a pipeline that is specialised for this kernel data */
+          /* we already requested a pipeline that is specialized for this kernel data */
           metal_printf("Specialized kernel already requested (%s)\n",
                        device_kernel_as_string(device_kernel));
           return;
@@ -445,7 +445,7 @@ void MetalKernelPipeline::compile()
 
     string options;
     if (use_metalrt && kernel_has_intersection(device_kernel)) {
-      /* incorporate any MetalRT specialisations into the archive name */
+      /* incorporate any MetalRT specializations into the archive name */
       options += string_printf(".hair_%d.hair_thick_%d.pointcloud_%d",
                                metalrt_hair ? 1 : 0,
                                metalrt_hair_thick ? 1 : 0,
diff --git a/intern/cycles/kernel/osl/services.h b/intern/cycles/kernel/osl/services.h
index 27d7f7fb8e1..edffd912bad 100644
--- a/intern/cycles/kernel/osl/services.h
+++ b/intern/cycles/kernel/osl/services.h
@@ -41,7 +41,7 @@ struct KernelGlobalsCPU;
  * These are stored in a concurrent hash map, because OSL can compile multiple
  * shaders in parallel.
  *
- * Note: The svm_slots array contains a compressed mapping of tile to svm_slot pairs
+ * NOTE: The svm_slots array contains a compressed mapping of tile to svm_slot pairs
  * stored as follows: x:tile_a, y:svm_slot_a, z:tile_b, w:svm_slot_b etc. */
 
 struct OSLTextureHandle : public OIIO::RefCnt {
diff --git a/intern/ghost/intern/GHOST_SystemCocoa.mm b/intern/ghost/intern/GHOST_SystemCocoa.mm
index b6836614962..8677c0b9552 100644
--- a/intern/ghost/intern/GHOST_SystemCocoa.mm
+++ b/intern/ghost/intern/GHOST_SystemCocoa.mm
@@ -967,7 +967,7 @@ bool GHOST_SystemCocoa::processEvents(bool waitForEvent)
   return anyProcessed;
 }
 
-// Note: called from NSApplication delegate
+/* NOTE: called from #NSApplication delegate. */
 GHOST_TSuccess GHOST_SystemCocoa::handleApplicationBecomeActiveEvent()
 {
   for (GHOST_IWindow *iwindow : m_windowManager->getWindows()) {
@@ -1046,7 +1046,7 @@ void GHOST_SystemCocoa::notifyExternalEventProcessed()
   m_outsideLoopEventProcessed = true;
 }
 
-// Note: called from NSWindow delegate
+/* NOTE: called from #NSWindow delegate. */
 GHOST_TSuccess GHOST_SystemCocoa::handleWindowEvent(GHOST_TEventType eventType,
                                                     GHOST_WindowCocoa *window)
 {
@@ -1108,7 +1108,7 @@ GHOST_TSuccess GHOST_SystemCocoa::handleWindowEvent(GHOST_TEventType eventType,
   return GHOST_kSuccess;
 }
 
-// Note: called from NSWindow subclass
+/* NOTE: called from #NSWindow subclass. */
 GHOST_TSuccess GHOST_SystemCocoa::handleDraggingEvent(GHOST_TEventType eventType,
                                                       GHOST_TDragnDropTypes draggedObjectType,
                                                       GHOST_WindowCocoa *window,
diff --git a/intern/ghost/intern/GHOST_WindowCocoa.mm b/intern/ghost/intern/GHOST_WindowCocoa.mm
index 4a1b3c2fe16..e7f5fdaa011 100644
--- a/intern/ghost/intern/GHOST_WindowCocoa.mm
+++ b/intern/ghost/intern/GHOST_WindowCocoa.mm
@@ -426,8 +426,8 @@ GHOST_WindowCocoa::~GHOST_WindowCocoa()
     [m_window close];
   }
 
-  // Check for other blender opened windows and make the frontmost key
-  // Note: for some reason the closed window is still in the list
+  /* Check for other blender opened windows and make the front-most key
+   * NOTE: for some reason the closed window is still in the list. */
   NSArray *windowsList = [NSApp orderedWindows];
   for (int a = 0; a < [windowsList count]; a++) {
     if (m_window != (CocoaWindow *)[windowsList objectAtIndex:a]) {
diff --git a/intern/ghost/intern/GHOST_WindowWin32.cpp b/intern/ghost/intern/GHOST_WindowWin32.cpp
index 897e6c145da..2e17454d24f 100644
--- a/intern/ghost/intern/GHOST_WindowWin32.cpp
+++ b/intern/ghost/intern/GHOST_WindowWin32.cpp
@@ -322,7 +322,7 @@ void GHOST_WindowWin32::adjustWindowRectForClosestMonitor(LPRECT win_rect,
   }
 
   /* Adjust to allow for caption, borders, shadows, scaling, etc. Resulting values can be
-   * correctly outside of monitor bounds. Note: You cannot specify WS_OVERLAPPED when calling. */
+   * correctly outside of monitor bounds. NOTE: You cannot specify #WS_OVERLAPPED when calling. */
   if (fpAdjustWindowRectExForDpi) {
     UINT dpiX, dpiY;
     GetDpiForMonitor(hmonitor, MDT_EFFECTIVE_DPI, &dpiX, &dpiY);
diff --git a/intern/iksolver/intern/IK_QTask.cpp b/intern/iksolver/intern/IK_QTask.cpp
index caf9585a94e..80eda01b17f 100644
--- a/intern/iksolver/intern/IK_QTask.cpp
+++ b/intern/iksolver/intern/IK_QTask.cpp
@@ -116,7 +116,7 @@ void IK_QOrientationTask::ComputeJacobian(IK_QJacobian &jacobian)
 }
 
 // IK_QCenterOfMassTask
-// Note: implementation not finished!
+// NOTE: implementation not finished!
 
 IK_QCenterOfMassTask::IK_QCenterOfMassTask(bool primary,
                                            const IK_QSegment *segment,
diff --git a/intern/libmv/libmv/multiview/euclidean_resection.h b/intern/libmv/libmv/multiview/euclidean_resection.h
index 3c4c3979ff6..cdb9b5af52e 100644
--- a/intern/libmv/libmv/multiview/euclidean_resection.h
+++ b/intern/libmv/libmv/multiview/euclidean_resection.h
@@ -118,7 +118,7 @@ void EuclideanResectionAnsarDaniilidis(const Mat2X& x_camera,
  * This is the algorithm described in:
  * "{EP$n$P: An Accurate $O(n)$ Solution to the P$n$P Problem", by V. Lepetit
  * and F. Moreno-Noguer and P. Fua, IJCV 2009. vol. 81, no. 2
- * \note: the non-linear optimization is not implemented here.
+ * \note the non-linear optimization is not implemented here.
  */
 bool EuclideanResectionEPnP(const Mat2X& x_camera,
                             const Mat3X& X_world,
diff --git a/intern/opensubdiv/internal/evaluator/eval_output_cpu.h b/intern/opensubdiv/internal/evaluator/eval_output_cpu.h
index 58bae7a322e..42aa052863a 100644
--- a/intern/opensubdiv/internal/evaluator/eval_output_cpu.h
+++ b/intern/opensubdiv/internal/evaluator/eval_output_cpu.h
@@ -32,7 +32,7 @@ using OpenSubdiv::Osd::CpuVertexBuffer;
 namespace blender {
 namespace opensubdiv {
 
-// Note: Define as a class instead of typedef to make it possible
+// NOTE: Define as a class instead of typedef to make it possible
 // to have anonymous class in opensubdiv_evaluator_internal.h
 class CpuEvalOutput : public VolatileEvalOutput<CpuVertexBuffer,
                                                 CpuVertexBuffer,
diff --git a/intern/rigidbody/RBI_api.h b/intern/rigidbody/RBI_api.h
index 791a4a6ac05..13b1c096a80 100644
--- a/intern/rigidbody/RBI_api.h
+++ b/intern/rigidbody/RBI_api.h
@@ -14,7 +14,7 @@ extern "C" {
 #endif
 
 /* API Notes:
- * Currently, this API is optimised for Bullet RigidBodies, and doesn't
+ * Currently, this API is optimized for Bullet RigidBodies, and doesn't
  * take into account other Physics Engines. Some tweaking may be necessary
  * to allow other systems to be used, in particular there may be references
  * to datatypes that aren't used here...
diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h
index b3119666f0a..ce1f4c2b98c 100644
--- a/source/blender/blenkernel/BKE_constraint.h
+++ b/source/blender/blenkernel/BKE_constraint.h
@@ -67,7 +67,7 @@ typedef void (*ConstraintIDFunc)(struct bConstraint *con,
  * Callers of these functions must check that they actually point to something useful,
  * as some constraints don't define some of these.
  *
- * Warning:
+ * WARNING:
  * it is not too advisable to reorder order of members of this struct,
  * as you'll have to edit quite a few #NUM_CONSTRAINT_TYPES of these
  * structs.
diff --git a/source/blender/blenkernel/BKE_image.h b/source/blender/blenkernel/BKE_image.h
index 532fa88e7b4..b6607a92c14 100644
--- a/source/blender/blenkernel/BKE_image.h
+++ b/source/blender/blenkernel/BKE_image.h
@@ -379,7 +379,7 @@ void BKE_image_ensure_tile_token(char *filename);
 /**
  * When provided with an absolute virtual `filepath`, check to see if at least
  * one concrete file exists.
- * Note: This function requires directory traversal and may be inefficient in time-critical,
+ * NOTE: This function requires directory traversal and may be inefficient in time-critical,
  * or iterative, code paths.
  */
 bool BKE_image_tile_filepath_exists(const char *filepath);
diff --git a/source/blender/blenkernel/BKE_subdiv.h b/source/blender/blenkernel/BKE_subdiv.h
index c18e8a2986c..486c9430279 100644
--- a/source/blender/blenkernel/BKE_subdiv.h
+++ b/source/blender/blenkernel/BKE_subdiv.h
@@ -251,7 +251,7 @@ Subdiv *BKE_subdiv_update_from_mesh(Subdiv *subdiv,
 void BKE_subdiv_free(Subdiv *subdiv);
 
 /* --------------------------------------------------------------------
- * Displacemnt API.
+ * Displacement API.
  */
 
 void BKE_subdiv_displacement_attach_from_multires(Subdiv *subdiv,
diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c
index b886722676b..94b85e42f96 100644
--- a/source/blender/blenkernel/intern/anim_sys.c
+++ b/source/blender/blenkernel/intern/anim_sys.c
@@ -2868,7 +2868,7 @@ static void nlastrip_evaluate_meta(const int evaluation_mode,
   /* Assert currently supported modes. If new mode added, then assertion marks potentially missed
    * area.
    *
-   * Note: In the future if support is ever added to metastrips to support nested tracks, then
+   * NOTE: In the future if support is ever added to metastrips to support nested tracks, then
    * STRIP_EVAL_BLEND and STRIP_EVAL_BLEND_GET_INVERTED_LOWER_SNAPSHOT cases are no longer
    * equivalent. The output of nlastrips_ctime_get_strip() may return a list of strips. The only
    * case difference should be the evaluation order.
diff --git a/source/blender/blenkernel/intern/ble

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list