[Bf-blender-cvs] [265c3a4724e] master: Cleanup: replace NB with NOTE in comments

Campbell Barton noreply at git.blender.org
Wed Jul 21 05:16:43 CEST 2021


Commit: 265c3a4724e1a8ec7ad0b048eaa98316018445ec
Author: Campbell Barton
Date:   Wed Jul 21 13:05:39 2021 +1000
Branches: master
https://developer.blender.org/rB265c3a4724e1a8ec7ad0b048eaa98316018445ec

Cleanup: replace NB with NOTE in comments

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

M	build_files/cmake/cmake_netbeans_project.py
M	intern/cycles/render/osl.cpp
M	intern/memutil/MEM_Allocator.h
M	release/scripts/modules/nodeitems_utils.py
M	release/scripts/templates_py/custom_nodes.py
M	source/blender/blenkernel/intern/node.cc
M	source/blender/blenloader/intern/versioning_260.c
M	source/blender/editors/space_node/node_edit.cc
M	source/blender/freestyle/intern/winged_edge/Curvature.cpp
M	source/blender/makesrna/intern/rna_nodetree.c
M	source/blender/nodes/NOD_static_types.h
M	source/blender/nodes/composite/nodes/node_composite_common.c
M	source/blender/nodes/shader/nodes/node_shader_common.c
M	source/blender/nodes/texture/nodes/node_texture_common.c
M	source/blender/simulation/intern/implicit_blender.c
M	source/blender/simulation/intern/implicit_eigen.cpp

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

diff --git a/build_files/cmake/cmake_netbeans_project.py b/build_files/cmake/cmake_netbeans_project.py
index cfc3ff6b6fa..a16fc42c9b7 100755
--- a/build_files/cmake/cmake_netbeans_project.py
+++ b/build_files/cmake/cmake_netbeans_project.py
@@ -82,7 +82,7 @@ def create_nb_project_main():
         make_exe = cmake_cache_var("CMAKE_MAKE_PROGRAM")
         make_exe_basename = os.path.basename(make_exe)
 
-        # --------------- NB specific
+        # --------------- NetBeans specific.
         defines = [("%s=%s" % cdef) if cdef[1] else cdef[0] for cdef in defines]
         defines += [cdef.replace("#define", "").strip() for cdef in cmake_compiler_defines()]
 
diff --git a/intern/cycles/render/osl.cpp b/intern/cycles/render/osl.cpp
index 9bd6e3a5e2d..7dc79f48145 100644
--- a/intern/cycles/render/osl.cpp
+++ b/intern/cycles/render/osl.cpp
@@ -993,7 +993,7 @@ void OSLCompiler::parameter_array(const char *name, const float f[], int arrayle
 
 void OSLCompiler::parameter_color_array(const char *name, const array<float3> &f)
 {
-  /* NB: cycles float3 type is actually 4 floats! need to use an explicit array */
+  /* NOTE: cycles float3 type is actually 4 floats! need to use an explicit array. */
   array<float[3]> table(f.size());
 
   for (int i = 0; i < f.size(); ++i) {
diff --git a/intern/memutil/MEM_Allocator.h b/intern/memutil/MEM_Allocator.h
index 50a3e978197..1dbb2d5a9f7 100644
--- a/intern/memutil/MEM_Allocator.h
+++ b/intern/memutil/MEM_Allocator.h
@@ -62,8 +62,8 @@ template<typename _Tp> struct MEM_Allocator {
     return &__x;
   }
 
-  // NB: __n is permitted to be 0.  The C++ standard says nothing
-  // about what the return value is when __n == 0.
+  /* NOTE: `__n` is permitted to be 0.
+   * The C++ standard says nothing about what the return value is when `__n == 0`. */
   _Tp *allocate(size_type __n, const void * = 0)
   {
     _Tp *__ret = NULL;
diff --git a/release/scripts/modules/nodeitems_utils.py b/release/scripts/modules/nodeitems_utils.py
index a50997fab5f..a5c18cee463 100644
--- a/release/scripts/modules/nodeitems_utils.py
+++ b/release/scripts/modules/nodeitems_utils.py
@@ -77,7 +77,7 @@ class NodeItem:
             else:
                 return bpy.app.translations.contexts.default
 
-    # NB: is a staticmethod because called with an explicit self argument
+    # NOTE: is a staticmethod because called with an explicit self argument
     # NodeItemCustom sets this as a variable attribute in __init__
     @staticmethod
     def draw(self, layout, _context):
diff --git a/release/scripts/templates_py/custom_nodes.py b/release/scripts/templates_py/custom_nodes.py
index ca9534e7cd3..fba94e23d0d 100644
--- a/release/scripts/templates_py/custom_nodes.py
+++ b/release/scripts/templates_py/custom_nodes.py
@@ -147,7 +147,7 @@ node_categories = [
     MyNodeCategory('OTHERNODES', "Other Nodes", items=[
         # the node item can have additional settings,
         # which are applied to new nodes
-        # NB: settings values are stored as string expressions,
+        # NOTE: settings values are stored as string expressions,
         # for this reason they should be converted to strings using repr()
         NodeItem("CustomNodeType", label="Node A", settings={
             "my_string_prop": repr("Lorem ipsum dolor sit amet"),
diff --git a/source/blender/blenkernel/intern/node.cc b/source/blender/blenkernel/intern/node.cc
index 3d5973b1d5e..4e44699b371 100644
--- a/source/blender/blenkernel/intern/node.cc
+++ b/source/blender/blenkernel/intern/node.cc
@@ -1212,10 +1212,12 @@ static void update_typeinfo(Main *bmain,
   FOREACH_NODETREE_END;
 }
 
-/* Try to initialize all typeinfo in a node tree.
- * NB: In general undefined typeinfo is a perfectly valid case,
+/**
+ * Try to initialize all type-info in a node tree.
+ *
+ * \note In general undefined type-info is a perfectly valid case,
  * the type may just be registered later.
- * In that case the update_typeinfo function will set typeinfo on registration
+ * In that case the update_typeinfo function will set type-info on registration
  * and do necessary updates.
  */
 void ntreeSetTypes(const struct bContext *C, bNodeTree *ntree)
diff --git a/source/blender/blenloader/intern/versioning_260.c b/source/blender/blenloader/intern/versioning_260.c
index 5bf4d3b68b5..858f5d85a90 100644
--- a/source/blender/blenloader/intern/versioning_260.c
+++ b/source/blender/blenloader/intern/versioning_260.c
@@ -2149,7 +2149,7 @@ void blo_do_versions_260(FileData *fd, Library *UNUSED(lib), Main *bmain)
     }
 
     for (scene = bmain->scenes.first; scene; scene = scene->id.next) {
-      /* NB: scene->nodetree is a local ID block, has been direct_link'ed */
+      /* NOTE: `scene->nodetree` is a local ID block, has been direct_link'ed. */
       if (scene->nodetree) {
         scene->nodetree->active_viewer_key = active_viewer_key;
       }
diff --git a/source/blender/editors/space_node/node_edit.cc b/source/blender/editors/space_node/node_edit.cc
index af9c888cbf7..cbf03f553f6 100644
--- a/source/blender/editors/space_node/node_edit.cc
+++ b/source/blender/editors/space_node/node_edit.cc
@@ -613,9 +613,8 @@ void snode_set_context(const bContext *C)
   /* check the tree type */
   if (!treetype || (treetype->poll && !treetype->poll(C, treetype))) {
     /* invalid tree type, skip
-     * NB: not resetting the node path here, invalid bNodeTreeType
-     * may still be registered at a later point.
-     */
+     * NOTE: not resetting the node path here, invalid #bNodeTreeType
+     * may still be registered at a later point. */
     return;
   }
 
@@ -1303,9 +1302,8 @@ static int node_duplicate_exec(bContext *C, wmOperator *op)
     }
   }
 
-  /* copy links between selected nodes
-   * NB: this depends on correct node->new_node and sock->new_sock pointers from above copy!
-   */
+  /* Copy links between selected nodes.
+   * NOTE: this depends on correct node->new_node and sock->new_sock pointers from above copy! */
   bNodeLink *lastlink = (bNodeLink *)ntree->links.last;
   LISTBASE_FOREACH (bNodeLink *, link, &ntree->links) {
     /* This creates new links between copied nodes.
@@ -2163,9 +2161,9 @@ static int node_clipboard_copy_exec(bContext *C, wmOperator *UNUSED(op))
     }
   }
 
-  /* copy links between selected nodes
-   * NB: this depends on correct node->new_node and sock->new_sock pointers from above copy!
-   */
+  /* Copy links between selected nodes.
+   * NOTE: this depends on correct node->new_node and sock->new_sock pointers from above copy! */
+
   LISTBASE_FOREACH (bNodeLink *, link, &ntree->links) {
     /* This creates new links between copied nodes. */
     if (link->tonode && (link->tonode->flag & NODE_SELECT) && link->fromnode &&
diff --git a/source/blender/freestyle/intern/winged_edge/Curvature.cpp b/source/blender/freestyle/intern/winged_edge/Curvature.cpp
index 478e48de66c..f052f1af104 100644
--- a/source/blender/freestyle/intern/winged_edge/Curvature.cpp
+++ b/source/blender/freestyle/intern/winged_edge/Curvature.cpp
@@ -371,29 +371,29 @@ void gts_vertex_principal_directions(WVertex *v, Vec3r Kh, real Kg, Vec3r &e1, V
     }
     e = *itE;
 
-    /* since this vertex passed the tests in gts_vertex_mean_curvature_normal(), this should be
-     * true. */
+    /* Since this vertex passed the tests in gts_vertex_mean_curvature_normal(),
+       this should be true. */
     // g_assert(gts_edge_face_number (e, s) == 2);
 
-    /* identify the two triangles bordering e in s */
+    /* Identify the two triangles bordering e in s. */
     f1 = e->GetaFace();
     f2 = e->GetbFace();
 
     /* We are solving for the values of the curvature tensor
-     *     B = [ a b ; b c ].
-     *  The computations here are from section 5 of [Meyer et al 2002].
+     *     `B = [ a b ; b c ]`.
+     * The computations here are from section 5 of [Meyer et al 2002].
      *
-     *  The first step is to calculate the linear equations governing the values of (a,b,c). These
+     * The first step is to calculate the linear equations governing the values of (a,b,c). These
      * can be computed by setting the derivatives of the error E to zero (section 5.3).
      *
-     *  Since a + c = norm(Kh), we only compute the linear equations for dE/da and dE/db. (NB:
-     * [Meyer et al 2002] has the equation a + b = norm(Kh), but I'm almost positive this is
-     * incorrect).
+     * Since a + c = norm(Kh), we only compute the linear equations for `dE/da` and `dE/db`.
+     * (NOTE: [Meyer et al 2002] has the equation `a + b = norm(Kh)`,
+     * but I'm almost positive this is incorrect).
      *
-     *  Note that the w_ij (defined in section 5.2) are all scaled by (1/8*A_mixed). We drop this
+     * Note that the w_ij (defined in section 5.2) are all scaled by `(1/8*A_mixed)`. We drop this
      * uniform scale factor because the solution of the linear equations doesn't rely on it.
      *
-     *  The terms of the linear equations are xterm_dy with x in {a,b,c} and y in {a,b}. There are
+     * The terms of the linear equations are xterm_dy with x in {a,b,c} and y in {a,b}. There are
      * also const_dy terms that are the constant factors in the equations.
      */
 
diff --git a/source/blender/makesrna/intern/rna_nodetree.c b/source/blender/makesrna/intern/rna_nodetree.c
index 6998a7d0afe..a534c85681b 100644
--- a/source/blender/makesrna/intern/rna_nodetree.c
+++ b/source/blender/makesrna/intern/rna_nodetree.c
@@ -6622,10 +6622,9 @@ static void def_cmp_image(StructRNA *srna)
                            "Put node output buffer to straight alpha instead of premultiplied");
   RNA_def_property_update(prop, NC_NODE | NA_EDITED, "rna_Node_update");
 
-  /* NB: image user properties used in the UI are redefined in def_node_image_user,
+  /* NOTE: Image user properties used in the UI are redefined in def_node_image_user,
    * to trigger correct updates of the node editor. RNA design problem that prevents
-   * updates from nested structs ...
-   */
+   * updates from nested structs. */
   RNA_def_struct_sdna_from(srna, "ImageUser", "storage");
   def_node_image_user(srna);
 }
@@ -6722,9 +6721,8 @@ static void rna_def_cmp_output_file_slots_api(BlenderRNA *brna,
   parm = RNA_def_pointer(func, "socke

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list