From 265c3a4724e1a8ec7ad0b048eaa98316018445ec Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 21 Jul 2021 13:05:39 +1000 Subject: [PATCH] Cleanup: replace NB with NOTE in comments --- build_files/cmake/cmake_netbeans_project.py | 2 +- intern/cycles/render/osl.cpp | 2 +- intern/memutil/MEM_Allocator.h | 4 ++-- release/scripts/modules/nodeitems_utils.py | 2 +- release/scripts/templates_py/custom_nodes.py | 2 +- source/blender/blenkernel/intern/node.cc | 8 ++++--- .../blenloader/intern/versioning_260.c | 2 +- .../blender/editors/space_node/node_edit.cc | 16 ++++++-------- .../intern/winged_edge/Curvature.cpp | 22 +++++++++---------- source/blender/makesrna/intern/rna_nodetree.c | 16 ++++++-------- source/blender/nodes/NOD_static_types.h | 2 +- .../composite/nodes/node_composite_common.c | 5 ++--- .../nodes/shader/nodes/node_shader_common.c | 6 ++--- .../nodes/texture/nodes/node_texture_common.c | 6 ++--- .../simulation/intern/implicit_blender.c | 2 +- .../simulation/intern/implicit_eigen.cpp | 2 +- 16 files changed, 48 insertions(+), 51 deletions(-) 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 &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 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 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, "socket", "NodeSocket", "", "New socket"); RNA_def_function_return(func, parm); - /* NB: methods below can use the standard node socket API functions, - * included here for completeness. - */ + /* NOTE: methods below can use the standard node socket API functions, + * included here for completeness. */ func = RNA_def_function(srna, "remove", "rna_Node_socket_remove"); RNA_def_function_ui_description(func, "Remove a file slot from this node"); @@ -10301,11 +10299,11 @@ static void rna_def_node_socket(BlenderRNA *brna) RNA_def_property_override_flag(prop, PROPOVERRIDE_NO_COMPARISON); RNA_def_property_ui_text(prop, "Node", "Node owning this socket"); - /* NB: the type property is used by standard sockets. + /* NOTE: The type property is used by standard sockets. * Ideally should be defined only for the registered subclass, * but to use the existing DNA is added in the base type here. - * Future socket types can ignore or override this if needed. - */ + * Future socket types can ignore or override this if needed. */ + prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE); RNA_def_property_enum_sdna(prop, NULL, "type"); RNA_def_property_enum_items(prop, node_socket_type_items); diff --git a/source/blender/nodes/NOD_static_types.h b/source/blender/nodes/NOD_static_types.h index 42a0454d3e6..2a3dcf7c169 100644 --- a/source/blender/nodes/NOD_static_types.h +++ b/source/blender/nodes/NOD_static_types.h @@ -156,7 +156,7 @@ DefNode(CompositorNode, CMP_NODE_HUE_SAT, 0, "HUE_SA DefNode(CompositorNode, CMP_NODE_IMAGE, def_cmp_image, "IMAGE", Image, "Image", "" ) DefNode(CompositorNode, CMP_NODE_R_LAYERS, def_cmp_render_layers, "R_LAYERS", RLayers, "Render Layers", "" ) DefNode(CompositorNode, CMP_NODE_COMPOSITE, def_cmp_composite, "COMPOSITE", Composite, "Composite", "" ) -/* NB: OutputFile node has special rna setup function called in rna_nodetree.c */ +/* NOTE: #OutputFile node has special RNA setup function called in rna_nodetree.c */ DefNode(CompositorNode, CMP_NODE_OUTPUT_FILE, 0, "OUTPUT_FILE", OutputFile, "File Output", "" ) DefNode(CompositorNode, CMP_NODE_TEXTURE, def_texture, "TEXTURE", Texture, "Texture", "" ) DefNode(CompositorNode, CMP_NODE_TRANSLATE, def_cmp_translate, "TRANSLATE", Translate, "Translate", "" ) diff --git a/source/blender/nodes/composite/nodes/node_composite_common.c b/source/blender/nodes/composite/nodes/node_composite_common.c index f5eaaef8a31..61abc80fe93 100644 --- a/source/blender/nodes/composite/nodes/node_composite_common.c +++ b/source/blender/nodes/composite/nodes/node_composite_common.c @@ -36,9 +36,8 @@ void register_node_type_cmp_group(void) { static bNodeType ntype; - /* NB: cannot use sh_node_type_base for node group, because it would map the node type - * to the shared NODE_GROUP integer type id. - */ + /* NOTE: Cannot use sh_node_type_base for node group, because it would map the node type + * to the shared NODE_GROUP integer type id. */ node_type_base_custom( &ntype, "CompositorNodeGroup", "Group", NODE_CLASS_GROUP, NODE_CONST_OUTPUT); ntype.type = NODE_GROUP; diff --git a/source/blender/nodes/shader/nodes/node_shader_common.c b/source/blender/nodes/shader/nodes/node_shader_common.c index a864bef60d9..4df5add7151 100644 --- a/source/blender/nodes/shader/nodes/node_shader_common.c +++ b/source/blender/nodes/shader/nodes/node_shader_common.c @@ -229,9 +229,9 @@ void register_node_type_sh_group(void) { static bNodeType ntype; - /* NB: cannot use sh_node_type_base for node group, because it would map the node type - * to the shared NODE_GROUP integer type id. - */ + /* NOTE: cannot use #sh_node_type_base for node group, because it would map the node type + * to the shared #NODE_GROUP integer type id. */ + node_type_base_custom(&ntype, "ShaderNodeGroup", "Group", NODE_CLASS_GROUP, NODE_CONST_OUTPUT); ntype.type = NODE_GROUP; ntype.poll = sh_node_poll_default; diff --git a/source/blender/nodes/texture/nodes/node_texture_common.c b/source/blender/nodes/texture/nodes/node_texture_common.c index b87720be5b0..2de64779ea6 100644 --- a/source/blender/nodes/texture/nodes/node_texture_common.c +++ b/source/blender/nodes/texture/nodes/node_texture_common.c @@ -158,9 +158,9 @@ void register_node_type_tex_group(void) { static bNodeType ntype; - /* NB: cannot use sh_node_type_base for node group, because it would map the node type - * to the shared NODE_GROUP integer type id. - */ + /* NOTE: Cannot use #sh_node_type_base for node group, because it would map the node type + * to the shared #NODE_GROUP integer type id. */ + node_type_base_custom(&ntype, "TextureNodeGroup", "Group", NODE_CLASS_GROUP, NODE_CONST_OUTPUT); ntype.type = NODE_GROUP; ntype.poll = tex_node_poll_default; diff --git a/source/blender/simulation/intern/implicit_blender.c b/source/blender/simulation/intern/implicit_blender.c index 8aa3774a3f2..64ee8d7d389 100644 --- a/source/blender/simulation/intern/implicit_blender.c +++ b/source/blender/simulation/intern/implicit_blender.c @@ -1439,7 +1439,7 @@ void SIM_mass_spring_force_drag(Implicit_Data *data, float drag) for (i = 0; i < numverts; i++) { float tmp[3][3]; - /* NB: uses root space velocity, no need to transform */ + /* NOTE: Uses root space velocity, no need to transform. */ madd_v3_v3fl(data->F[i], data->V[i], -drag); copy_m3_m3(tmp, I); diff --git a/source/blender/simulation/intern/implicit_eigen.cpp b/source/blender/simulation/intern/implicit_eigen.cpp index aa9d5d1d34d..e34d51fb227 100644 --- a/source/blender/simulation/intern/implicit_eigen.cpp +++ b/source/blender/simulation/intern/implicit_eigen.cpp @@ -797,7 +797,7 @@ void SIM_mass_spring_force_drag(Implicit_Data *data, float drag) for (int i = 0; i < numverts; i++) { float tmp[3][3]; - /* NB: uses root space velocity, no need to transform */ + /* NOTE: Uses root space velocity, no need to transform. */ madd_v3_v3fl(data->F.v3(i), data->V.v3(i), -drag); copy_m3_m3(tmp, I);