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

Campbell Barton noreply at git.blender.org
Thu Aug 11 03:04:02 CEST 2022 

Commit: 32c8a28720cba0202fcc1ce679e6b54401d8d6b4
Author: Campbell Barton
Date:   Thu Aug 11 09:44:33 2022 +1000
Branches: master
https://developer.blender.org/rB32c8a28720cba0202fcc1ce679e6b54401d8d6b4

Cleanup: spelling in comments

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

M	source/blender/blenkernel/BKE_idtype.h
M	source/blender/blenkernel/intern/cryptomatte_test.cc
M	source/blender/compositor/operations/COM_MovieClipOperation.cc
M	source/blender/compositor/realtime_compositor/intern/shader_operation.cc
M	source/blender/depsgraph/intern/node/deg_node_operation.cc
M	source/blender/draw/intern/draw_shader_shared.h
M	source/blender/gpu/metal/mtl_query.mm
M	source/blender/imbuf/IMB_imbuf_types.h
M	source/blender/makesdna/DNA_node_types.h

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

diff --git a/source/blender/blenkernel/BKE_idtype.h b/source/blender/blenkernel/BKE_idtype.h
index 30f7ed45859..ec8d6f76a0b 100644
--- a/source/blender/blenkernel/BKE_idtype.h
+++ b/source/blender/blenkernel/BKE_idtype.h
@@ -109,7 +109,7 @@ typedef struct IDTypeInfo {
    */
   short id_code;
   /**
-   * Bitflag matching id_code, used for filtering (e.g. in file browser), see DNA_ID.h's
+   * Bit-flag matching id_code, used for filtering (e.g. in file browser), see DNA_ID.h's
    * FILTER_ID_XX enums.
    */
   uint64_t id_filter;
diff --git a/source/blender/blenkernel/intern/cryptomatte_test.cc b/source/blender/blenkernel/intern/cryptomatte_test.cc
index 2f15242b4a4..bb09b276645 100644
--- a/source/blender/blenkernel/intern/cryptomatte_test.cc
+++ b/source/blender/blenkernel/intern/cryptomatte_test.cc
@@ -163,7 +163,7 @@ TEST(cryptomatte, session_from_stamp_data)
  * best as possible. */
 TEST(cryptomatte, parsing_malformed_manifests)
 {
-  /* Manifest from multilayer.exr in the cryptomatte git-repository. */
+  /* Manifest from `multilayer.exr` in the cryptomatte git-repository. */
   test_cryptomatte_manifest(
       R"({"/obj/instance1:instances:0":"0d54c6cc","/obj/instance1:instances:1":"293d9340","/obj/instance1:instances:110":"ccb9e1f2","/obj/instance1:instances:111":"f8dd3a48","/obj/instance1:instances:112":"a99e07a8","/obj/instance1:instances:113":"e75599a4","/obj/instance1:instances:114":"794200f3","/obj/instance1:instances:115":"2a3a1728","/obj/instance1:instances:116":"478544a1","/obj/instance1:instances:117":"b2bd969a","/obj/instance1:instances:10":"3a0c8681","/obj/instance1:instances [...]
       R"({"\/obj\/box:polygons:1":"9d416418","\/obj\/instance1:instances:0":"0d54c6cc","\/obj\/instance1:instances:1":"293d9340","\/obj\/instance1:instances:10":"3a0c8681","\/obj\/instance1:instances:100":"2dcd2966","\/obj\/instance1:instances:101":"9331cd82","\/obj\/instance1:instances:102":"df50fccb","\/obj\/instance1:instances:103":"97f8590d","\/obj\/instance1:instances:104":"bbcd220d","\/obj\/instance1:instances:105":"4ae06139","\/obj\/instance1:instances:106":"8873d5ea","\/obj\/inst [...]
diff --git a/source/blender/compositor/operations/COM_MovieClipOperation.cc b/source/blender/compositor/operations/COM_MovieClipOperation.cc
index d7cf41cf422..b62d972e807 100644
--- a/source/blender/compositor/operations/COM_MovieClipOperation.cc
+++ b/source/blender/compositor/operations/COM_MovieClipOperation.cc
@@ -74,7 +74,7 @@ void MovieClipBaseOperation::execute_pixel_sampled(float output[4],
     zero_v4(output);
   }
   else if (ibuf->rect == nullptr && ibuf->rect_float == nullptr) {
-    /* Happens for multilayer exr, i.e. */
+    /* Happens for multi-layer EXR, i.e. */
     zero_v4(output);
   }
   else {
diff --git a/source/blender/compositor/realtime_compositor/intern/shader_operation.cc b/source/blender/compositor/realtime_compositor/intern/shader_operation.cc
index 931d417acad..a097c81a4c5 100644
--- a/source/blender/compositor/realtime_compositor/intern/shader_operation.cc
+++ b/source/blender/compositor/realtime_compositor/intern/shader_operation.cc
@@ -225,8 +225,8 @@ void ShaderOperation::declare_operation_input(DInputSocket input_socket,
 
   /* Add a new GPU attribute representing an input to the GPU material. Instead of using the
    * attribute directly, we link it to an appropriate set function and use its output link instead.
-   * This is needed because the gputype member of the attribute is only initialized if it is linked
-   * to a GPU node. */
+   * This is needed because the `gputype` member of the attribute is only initialized if it is
+   * linked to a GPU node. */
   GPUNodeLink *attribute_link;
   GPU_link(material,
            get_set_function_name(input_descriptor.type),
diff --git a/source/blender/depsgraph/intern/node/deg_node_operation.cc b/source/blender/depsgraph/intern/node/deg_node_operation.cc
index 65adfded6b3..016af735fcf 100644
--- a/source/blender/depsgraph/intern/node/deg_node_operation.cc
+++ b/source/blender/depsgraph/intern/node/deg_node_operation.cc
@@ -227,7 +227,7 @@ void OperationNode::tag_update(Depsgraph *graph, eUpdateSource source)
    * the evaluated clues that evaluation needs to happen again. */
   graph->add_entry_tag(this);
 
-  /* Enforce dynamic visibility codepath update.
+  /* Enforce dynamic visibility code-path update.
    * This ensures visibility flags are consistently propagated throughout the dependency graph when
    * there is no animated visibility in the graph.
    *
diff --git a/source/blender/draw/intern/draw_shader_shared.h b/source/blender/draw/intern/draw_shader_shared.h
index 0fe4f3fbbff..90a6475c42b 100644
--- a/source/blender/draw/intern/draw_shader_shared.h
+++ b/source/blender/draw/intern/draw_shader_shared.h
@@ -154,7 +154,7 @@ BLI_STATIC_ASSERT_ALIGN(DispatchCommand, 16)
  * But we use plain array in shader code instead because of driver issues. */
 struct DRWDebugPrintBuffer {
   DrawCommand command;
-  /** Each character is encoded as 3 uchar with char_index, row and column position. */
+  /** Each character is encoded as 3 `uchar` with char_index, row and column position. */
   uint char_array[DRW_DEBUG_PRINT_MAX];
 };
 BLI_STATIC_ASSERT_ALIGN(DRWDebugPrintBuffer, 16)
diff --git a/source/blender/gpu/metal/mtl_query.mm b/source/blender/gpu/metal/mtl_query.mm
index dfda0a8de7f..f574140531d 100644
--- a/source/blender/gpu/metal/mtl_query.mm
+++ b/source/blender/gpu/metal/mtl_query.mm
@@ -9,7 +9,7 @@
 namespace blender::gpu {
 
 static const size_t VISIBILITY_COUNT_PER_BUFFER = 512;
-/* defined in the documentation but not queryable programmatically:
+/* Defined in the documentation but can't be queried programmatically:
  * https://developer.apple.com/documentation/metal/mtlvisibilityresultmode/mtlvisibilityresultmodeboolean?language=objc
  */
 static const size_t VISIBILITY_RESULT_SIZE_IN_BYTES = 8;
diff --git a/source/blender/imbuf/IMB_imbuf_types.h b/source/blender/imbuf/IMB_imbuf_types.h
index 1b32bef0a98..5ad226a26f2 100644
--- a/source/blender/imbuf/IMB_imbuf_types.h
+++ b/source/blender/imbuf/IMB_imbuf_types.h
@@ -251,11 +251,11 @@ typedef struct ImBuf {
   int refcounter;
 
   /* some parameters to pass along for packing images */
-  /** Compressed image only used with png and exr currently */
+  /** Compressed image only used with PNG and EXR currently */
   unsigned char *encodedbuffer;
-  /** Size of data written to encodedbuffer */
+  /** Size of data written to `encodedbuffer`. */
   unsigned int encodedsize;
-  /** Size of encodedbuffer */
+  /** Size of `encodedbuffer` */
   unsigned int encodedbuffersize;
 
   /* color management */
diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h
index 6388595a8c2..b9161e918c0 100644
--- a/source/blender/makesdna/DNA_node_types.h
+++ b/source/blender/makesdna/DNA_node_types.h
@@ -1838,37 +1838,37 @@ enum {
 /* viewer and composite output. */
 #define CMP_NODE_OUTPUT_IGNORE_ALPHA 1
 
-/* Split Viewer Node. Stored in custom2. */
+/** Split Viewer Node. Stored in `custom2`. */
 typedef enum CMPNodeSplitViewerAxis {
   CMP_NODE_SPLIT_VIEWER_HORIZONTAL = 0,
   CMP_NODE_SPLIT_VIEWER_VERTICAL = 1,
 } CMPNodeSplitViewerAxis;
 
-/* Color Balance Node. Stored in custom1. */
+/** Color Balance Node. Stored in `custom1`. */
 typedef enum CMPNodeColorBalanceMethod {
   CMP_NODE_COLOR_BALANCE_LGG = 0,
   CMP_NODE_COLOR_BALANCE_ASC_CDL = 1,
 } CMPNodeColorBalanceMethod;
 
-/* Alpha Convert Node. Stored in custom1. */
+/** Alpha Convert Node. Stored in `custom1`. */
 typedef enum CMPNodeAlphaConvertMode {
   CMP_NODE_ALPHA_CONVERT_PREMULTIPLY = 0,
   CMP_NODE_ALPHA_CONVERT_UNPREMULTIPLY = 1,
 } CMPNodeAlphaConvertMode;
 
-/* Distance Matte Node. Stored in NodeChroma.channel. */
+/** Distance Matte Node. Stored in #NodeChroma.channel. */
 typedef enum CMPNodeDistanceMatteColorSpace {
   CMP_NODE_DISTANCE_MATTE_COLOR_SPACE_YCCA = 0,
   CMP_NODE_DISTANCE_MATTE_COLOR_SPACE_RGBA = 1,
 } CMPNodeDistanceMatteColorSpace;
 
-/* Color Spill Node. Stored in custom2. */
+/** Color Spill Node. Stored in `custom2`. */
 typedef enum CMPNodeColorSpillLimitAlgorithm {
   CMP_NODE_COLOR_SPILL_LIMIT_ALGORITHM_SINGLE = 0,
   CMP_NODE_COLOR_SPILL_LIMIT_ALGORITHM_AVERAGE = 1,
 } CMPNodeColorSpillLimitAlgorithm;
 
-/* Channel Matte Node. Stored in NodeChroma.algorith. */
+/** Channel Matte Node. Stored in #NodeChroma.algorithm. */
 typedef enum CMPNodeChannelMatteLimitAlgorithm {
   CMP_NODE_CHANNEL_MATTE_LIMIT_ALGORITHM_SINGLE = 0,
   CMP_NODE_CHANNEL_MATTE_LIMIT_ALGORITHM_MAX = 1,

More information about the Bf-blender-cvs mailing list