[Bf-blender-cvs] [cea588b9ef8] master: Cleanup: spelling in comments, C++ style comments for disabled code

Campbell Barton noreply at git.blender.org
Fri Jan 14 01:24:55 CET 2022


Commit: cea588b9ef8f9bdb2729fb233d6f1ed0886700e1
Author: Campbell Barton
Date:   Fri Jan 14 10:47:50 2022 +1100
Branches: master
https://developer.blender.org/rBcea588b9ef8f9bdb2729fb233d6f1ed0886700e1

Cleanup: spelling in comments, C++ style comments for disabled code

Also ensure space at end of comment.

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

M	intern/cycles/bvh/build.cpp
M	intern/cycles/session/session.cpp
M	intern/opencolorio/ocio_impl_glsl.cc
M	source/blender/blenkernel/BKE_asset_catalog.hh
M	source/blender/blenkernel/BKE_lib_override.h
M	source/blender/blenkernel/BKE_mesh.h
M	source/blender/blenkernel/intern/asset_catalog_test.cc
M	source/blender/blenlib/intern/polyfill_2d_beautify.c
M	source/blender/blenloader/intern/versioning_300.c
M	source/blender/draw/intern/DRW_gpu_wrapper.hh
M	source/blender/editors/animation/keyframes_general.c
M	source/blender/editors/animation/keyframes_keylist.cc
M	source/blender/editors/animation/keyframing.c
M	source/blender/editors/asset/ED_asset_mark_clear.h
M	source/blender/editors/gpencil/annotate_paint.c
M	source/blender/editors/mask/mask_draw.c
M	source/blender/editors/space_buttons/buttons_texture.c
M	source/blender/editors/space_file/asset_catalog_tree_view.cc
M	source/blender/editors/space_file/filelist.c
M	source/blender/editors/space_file/fsmenu.c
M	source/blender/editors/space_graph/graph_slider_ops.c
M	source/blender/editors/space_outliner/outliner_draw.cc
M	source/blender/editors/space_outliner/outliner_edit.cc
M	source/blender/editors/space_outliner/outliner_intern.hh
M	source/blender/editors/space_outliner/outliner_select.cc
M	source/blender/editors/space_outliner/outliner_sync.cc
M	source/blender/editors/space_outliner/outliner_utils.cc
M	source/blender/editors/space_outliner/tree/tree_display.h
M	source/blender/editors/space_sequencer/sequencer_edit.c
M	source/blender/editors/space_userpref/space_userpref.c
M	source/blender/makesdna/DNA_space_defaults.h
M	source/blender/makesrna/intern/rna_scene_api.c
M	source/blender/makesrna/intern/rna_wm_api.c
M	source/blender/nodes/geometry/nodes/node_geo_dual_mesh.cc
M	source/blender/python/intern/bpy_operator.c
M	source/blender/python/intern/bpy_rna_array.c
M	source/blender/render/intern/texture_image.c
M	source/blender/simulation/intern/SIM_mass_spring.cpp
M	source/blender/simulation/intern/implicit_blender.c

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

diff --git a/intern/cycles/bvh/build.cpp b/intern/cycles/bvh/build.cpp
index 242595bee4c..082041f5ed2 100644
--- a/intern/cycles/bvh/build.cpp
+++ b/intern/cycles/bvh/build.cpp
@@ -935,7 +935,7 @@ BVHNode *BVHBuild::create_object_leaf_nodes(const BVHReference *ref, int start,
 
 BVHNode *BVHBuild::create_leaf_node(const BVHRange &range, const vector<BVHReference> &references)
 {
-  /* This is a bit overallocating here (considering leaf size into account),
+  /* This is a bit over-allocating here (considering leaf size into account),
    * but chunk-based re-allocation in vector makes it difficult to use small
    * size of stack storage here. Some tweaks are possible tho.
    *
diff --git a/intern/cycles/session/session.cpp b/intern/cycles/session/session.cpp
index 2c50a9a6d7f..d03063a7dda 100644
--- a/intern/cycles/session/session.cpp
+++ b/intern/cycles/session/session.cpp
@@ -428,7 +428,7 @@ void Session::do_delayed_reset()
 
   /* Update temp directory on reset.
    * This potentially allows to finish the existing rendering with a previously configure temporary
-   * direcotry in the host software and switch to a new temp directory when new render starts. */
+   * directory in the host software and switch to a new temp directory when new render starts. */
   tile_manager_.set_temp_dir(params.temp_dir);
 
   /* Progress. */
diff --git a/intern/opencolorio/ocio_impl_glsl.cc b/intern/opencolorio/ocio_impl_glsl.cc
index 87bc2842539..fc45ec4e301 100644
--- a/intern/opencolorio/ocio_impl_glsl.cc
+++ b/intern/opencolorio/ocio_impl_glsl.cc
@@ -642,7 +642,7 @@ bool OCIOImpl::gpuDisplayShaderBind(OCIO_ConstConfigRcPtr *config,
   }
 
   /* Bind textures to sampler units. Texture 0 is set by caller.
-   * Uniforms have already been set for texture bind points.*/
+   * Uniforms have already been set for texture bind points. */
   if (!use_overlay) {
     /* Avoid missing binds. */
     GPU_texture_bind(textures.dummy, TEXTURE_SLOT_OVERLAY);
diff --git a/source/blender/blenkernel/BKE_asset_catalog.hh b/source/blender/blenkernel/BKE_asset_catalog.hh
index ecc839050b7..004b70c2925 100644
--- a/source/blender/blenkernel/BKE_asset_catalog.hh
+++ b/source/blender/blenkernel/BKE_asset_catalog.hh
@@ -141,7 +141,7 @@ class AssetCatalogService {
   AssetCatalogFilter create_catalog_filter(CatalogID active_catalog_id) const;
 
   /** Create a catalog with some sensible auto-generated catalog ID.
-   * The catalog will be saved to the default catalog file.*/
+   * The catalog will be saved to the default catalog file. */
   AssetCatalog *create_catalog(const AssetCatalogPath &catalog_path);
 
   /**
diff --git a/source/blender/blenkernel/BKE_lib_override.h b/source/blender/blenkernel/BKE_lib_override.h
index 16156824f8e..30e75259967 100644
--- a/source/blender/blenkernel/BKE_lib_override.h
+++ b/source/blender/blenkernel/BKE_lib_override.h
@@ -306,7 +306,8 @@ void BKE_lib_override_library_main_validate(struct Main *bmain, struct ReportLis
  * This is typically used to detect whether some property has been changed in local and a new
  * #IDOverrideProperty (of #IDOverridePropertyOperation) has to be added.
  *
- * \return true if status is OK, false otherwise. */
+ * \return true if status is OK, false otherwise.
+ */
 bool BKE_lib_override_library_status_check_local(struct Main *bmain, struct ID *local);
 /**
  * Check that status of reference data-block is still valid against current local one.
@@ -317,7 +318,8 @@ bool BKE_lib_override_library_status_check_local(struct Main *bmain, struct ID *
  * This is typically used to detect whether some reference has changed and local
  * needs to be updated against it.
  *
- * \return true if status is OK, false otherwise. */
+ * \return true if status is OK, false otherwise.
+ */
 bool BKE_lib_override_library_status_check_reference(struct Main *bmain, struct ID *local);
 
 /**
diff --git a/source/blender/blenkernel/BKE_mesh.h b/source/blender/blenkernel/BKE_mesh.h
index a9a78bbc12e..e7382ce448a 100644
--- a/source/blender/blenkernel/BKE_mesh.h
+++ b/source/blender/blenkernel/BKE_mesh.h
@@ -461,7 +461,7 @@ void BKE_mesh_calc_normals_poly(const struct MVert *mvert,
 /**
  * Calculate vertex and face normals, storing the result in custom data layers on the mesh.
  *
- * \note It is usually preferrable to calculate normals lazily with
+ * \note It is usually preferable to calculate normals lazily with
  * #BKE_mesh_vertex_normals_ensure, but some areas (perhaps unnecessarily)
  * can also calculate them eagerly.
  */
diff --git a/source/blender/blenkernel/intern/asset_catalog_test.cc b/source/blender/blenkernel/intern/asset_catalog_test.cc
index 3ff7831b19a..8c39bfc9770 100644
--- a/source/blender/blenkernel/intern/asset_catalog_test.cc
+++ b/source/blender/blenkernel/intern/asset_catalog_test.cc
@@ -239,7 +239,7 @@ class AssetCatalogTest : public testing::Test {
     }
 
     /* Create an empty CDF to add complexity. It should not save to this, but to the top-level
-     * one.*/
+     * one. */
     ASSERT_TRUE(BLI_file_touch(cdf_in_subdir.c_str()));
     ASSERT_EQ(0, BLI_file_size(cdf_in_subdir.c_str()));
 
diff --git a/source/blender/blenlib/intern/polyfill_2d_beautify.c b/source/blender/blenlib/intern/polyfill_2d_beautify.c
index 684094234cf..aab33cb163b 100644
--- a/source/blender/blenlib/intern/polyfill_2d_beautify.c
+++ b/source/blender/blenlib/intern/polyfill_2d_beautify.c
@@ -400,7 +400,7 @@ void BLI_polyfill_beautify(const float (*coords)[2],
 
   BLI_heap_clear(eheap, NULL);
 
-  /* MEM_freeN(eheap_table); */ /* arena */
+  // MEM_freeN(eheap_table); /* arena */
 
   /* get tris from half edge. */
   uint tri_index = 0;
diff --git a/source/blender/blenloader/intern/versioning_300.c b/source/blender/blenloader/intern/versioning_300.c
index dd0cd9e24dc..a80be65bd75 100644
--- a/source/blender/blenloader/intern/versioning_300.c
+++ b/source/blender/blenloader/intern/versioning_300.c
@@ -1174,7 +1174,7 @@ static void legacy_vec_roll_to_mat3_normalized(const float nor[3],
   const float z = nor[2];
 
   const float theta = 1.0f + y;          /* remapping Y from [-1,+1] to [0,2]. */
-  const float theta_alt = x * x + z * z; /* Helper value for matrix calculations.*/
+  const float theta_alt = x * x + z * z; /* Helper value for matrix calculations. */
   float rMatrix[3][3], bMatrix[3][3];
 
   BLI_ASSERT_UNIT_V3(nor);
diff --git a/source/blender/draw/intern/DRW_gpu_wrapper.hh b/source/blender/draw/intern/DRW_gpu_wrapper.hh
index 01c57406dac..7a9bdb377fe 100644
--- a/source/blender/draw/intern/DRW_gpu_wrapper.hh
+++ b/source/blender/draw/intern/DRW_gpu_wrapper.hh
@@ -31,40 +31,40 @@
  *
  * All types are not copyable and Buffers are not Movable.
  *
- * drw::UniformArrayBuffer<T, len>
+ * `drw::UniformArrayBuffer<T, len>`
  *   Uniform buffer object containing an array of T with len elements.
  *   Data can be accessed using the [] operator.
  *
- * drw::UniformBuffer<T>
+ * `drw::UniformBuffer<T>`
  *   A uniform buffer object class inheriting from T.
  *   Data can be accessed just like a normal T object.
  *
- * drw::StorageArrayBuffer<T, len>
+ * `drw::StorageArrayBuffer<T, len>`
  *   Storage buffer object containing an array of T with len elements.
  *   The item count can be changed after creation using `resize()`.
  *   However, this requires the invalidation of the whole buffer and
  *   discarding all data inside it.
  *   Data can be accessed using the [] operator.
  *
- * drw::StorageBuffer<T>
+ * `drw::StorageBuffer<T>`
  *   A storage buffer object class inheriting from T.
  *   Data can be accessed just like a normal T object.
  *
- * drw::Texture
- *   A simple wrapper to GPUTexture. A drw::Texture can be created without allocation.
+ * `drw::Texture`
+ *   A simple wrapper to #GPUTexture. A #drw::Texture can be created without allocation.
  *   The `ensure_[1d|2d|3d|cube][_array]()` method is here to make sure the underlying texture
- *   will meet the requirements and create (or recreate) the GPUTexture if needed.
+ *   will meet the requirements and create (or recreate) the #GPUTexture if needed.
  *
- * drw::TextureFromPool
+ * `drw::TextureFromPool`
  *   A GPUTexture from the viewport texture pool. This texture can be shared with other engines
- *   and its content is undefined when aquiring it.
- *   A drw::TextureFromPool is acquired for rendering using `acquire()` and released once the
+ *   and its content is undefined when acquiring it.
+ *   A #drw::TextureFromPool is acquired for rendering using `acquire()` and released once the
  *   rendering is done using `release()`. The same texture can be acquired & released multiple
  *   time in one draw loop.
  *   The `sync()` method *MUST* be called once during the cache populate (aka: Sync) phase.
  *
- * drw::Framebuffer
- *   Simple wrapper to GPUFramebuffer that can be moved.
+ * `drw::Framebuffer`
+ *   Simple wrapper to #GPUFramebuffer that can be moved.
  *
  */
 
@@ -627,7 +627,7 @@ class Texture : NonCopyable {
   }
 
   /**
-   * Free the internal texture but not the drw::Texture itself.
+   * Free the internal texture but not the #drw::Texture itself.
    */
   void free()
   {
@@ -646,7 +646,7 @@ class Texture : NonCopyable {
 
   {
     /* TODO(fclem) In the future, we need to check if mip_count did not change.
-     * For now it's ok as we always define all mip level.*/
+     * For now it's ok as we always define all MIP level. */
     if (tx_) {
       int3 size = this->size();
       if (size != int3(w, h, d) || GPU_texture_format(tx_) != format ||
diff --git a/source/blender/editors/animation/keyframes_general.c b/source/blender/editors/animation/keyframes_general.c
index 5d82b3b9939..92017c02858 100644
--- a/source/blender/editors/animation/keyframes_general.c
+++ b/source/blender/editors/animation/keyframes_general.c
@@ -307,11 +307,13 @@ void clean_fcurve(struct bAnimContext *ac, bAnimListElem *ale, float thresh, boo
   }
 }
 
-/** Find the first segment of consecutive selected curve points, starting from \a start_index.
+/**
+ * Find the first segment of consecutive selected curve points, starting from \a start_index.
  * Keys that have BEZT_FLAG_IGNORE_TAG set are treated as unselected.
  * \param r_segment_start_idx: returns

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list