[Bf-blender-cvs] [da3d1e9165f] master: Cleanup: spelling in comments, correct doxy slashes, replace '/w'
Campbell Barton
noreply at git.blender.org
Wed Sep 7 05:05:19 CEST 2022
Commit: da3d1e9165f4d0ffcb04645aded3eea489fd6cdd
Author: Campbell Barton
Date: Wed Sep 7 12:52:05 2022 +1000
Branches: master
https://developer.blender.org/rBda3d1e9165f4d0ffcb04645aded3eea489fd6cdd
Cleanup: spelling in comments, correct doxy slashes, replace '/w'
===================================================================
M intern/ghost/intern/GHOST_ContextCGL.mm
M source/blender/blenkernel/BKE_gpencil_geom.h
M source/blender/blenkernel/intern/collection.c
M source/blender/blenkernel/intern/image_partial_update.cc
M source/blender/blenkernel/intern/node.cc
M source/blender/blenkernel/intern/object.cc
M source/blender/blenkernel/intern/particle.c
M source/blender/blenlib/BLI_pool.hh
M source/blender/editors/include/UI_interface.h
M source/blender/makesdna/intern/dna_genfile.c
M source/blender/makesdna/intern/makesdna.c
M source/blender/makesrna/intern/rna_rna.c
M source/blender/windowmanager/WM_types.h
===================================================================
diff --git a/intern/ghost/intern/GHOST_ContextCGL.mm b/intern/ghost/intern/GHOST_ContextCGL.mm
index eb84f901d80..488aa58aa59 100644
--- a/intern/ghost/intern/GHOST_ContextCGL.mm
+++ b/intern/ghost/intern/GHOST_ContextCGL.mm
@@ -201,7 +201,7 @@ static void makeAttribList(std::vector<NSOpenGLPixelFormatAttribute> &attribs,
attribs.push_back(NSOpenGLPFAOpenGLProfile);
attribs.push_back(NSOpenGLProfileVersion3_2Core);
- /* Pixel Format Attributes for the windowed NSOpenGLContext. */
+ /* Pixel Format Attributes for the windowed #NSOpenGLContext. */
attribs.push_back(NSOpenGLPFADoubleBuffer);
if (softwareGL) {
@@ -212,7 +212,7 @@ static void makeAttribList(std::vector<NSOpenGLPixelFormatAttribute> &attribs,
attribs.push_back(NSOpenGLPFAAccelerated);
attribs.push_back(NSOpenGLPFANoRecovery);
- /* Attempt to initialise device with extended sampler limit.
+ /* Attempt to initialize device with extended sampler limit.
* Resolves EEVEE purple rendering artifacts on macOS. */
if (increasedSamplerLimit) {
attribs.push_back((NSOpenGLPixelFormatAttribute)400);
@@ -267,7 +267,7 @@ GHOST_TSuccess GHOST_ContextCGL::initializeDrawingContext()
pixelFormat = [[NSOpenGLPixelFormat alloc] initWithAttributes:&attribs[0]];
if (pixelFormat == nil) {
/* If pixel format creation fails when testing increased sampler limit,
- * attempt intialisation again with feature disabled, otherwise, fail. */
+ * attempt initialization again with feature disabled, otherwise, fail. */
if (increasedSamplerLimit) {
increasedSamplerLimit = false;
continue;
diff --git a/source/blender/blenkernel/BKE_gpencil_geom.h b/source/blender/blenkernel/BKE_gpencil_geom.h
index 67560470516..b9219814c08 100644
--- a/source/blender/blenkernel/BKE_gpencil_geom.h
+++ b/source/blender/blenkernel/BKE_gpencil_geom.h
@@ -401,7 +401,7 @@ void BKE_gpencil_stroke_set_random_color(struct bGPDstroke *gps);
/**
* Join two strokes using the shortest distance (reorder stroke if necessary).
- * \param auto_flip: Flip the stroke if the join between two strokes is not end->start points.
+ * \param auto_flip: Flip the stroke if the join between two strokes is not end->start points.
*/
void BKE_gpencil_stroke_join(struct bGPDstroke *gps_a,
struct bGPDstroke *gps_b,
diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c
index b3254794fa7..cbab1a2de6a 100644
--- a/source/blender/blenkernel/intern/collection.c
+++ b/source/blender/blenkernel/intern/collection.c
@@ -242,7 +242,7 @@ void BKE_collection_blend_read_data(BlendDataReader *reader, Collection *collect
*
* NOTE: Using do_version is not a solution here, since this code will be called before any
* do_version takes place. Keeping it here also ensures future (or unknown existing) similar
- * bugs won't go easily unoticed. */
+ * bugs won't go easily unnoticed. */
CLOG_WARN(&LOG,
"Fixing root node tree '%s' owned by '%s' missing EMBEDDED tag, please consider "
"re-saving your (startup) file",
@@ -483,8 +483,8 @@ void BKE_collection_add_from_collection(Main *bmain,
is_instantiated = true;
}
else if (!is_instantiated && collection_find_child(collection, collection_dst)) {
- /* If given collection_dst is already instantiated in scene, even if its 'model' src one is
- * not, do not add it to master scene collection. */
+ /* If given collection_dst is already instantiated in scene, even if its 'model'
+ * collection_src one is not, do not add it to master scene collection. */
is_instantiated = true;
}
}
diff --git a/source/blender/blenkernel/intern/image_partial_update.cc b/source/blender/blenkernel/intern/image_partial_update.cc
index c77ee77a5f2..6ffd323cc1e 100644
--- a/source/blender/blenkernel/intern/image_partial_update.cc
+++ b/source/blender/blenkernel/intern/image_partial_update.cc
@@ -413,7 +413,7 @@ struct PartialUpdateRegisterImpl {
}
/**
- * /brief Check if data is available to construct the update tiles for the given
+ * \brief Check if data is available to construct the update tiles for the given
* changeset_id.
*
* The update tiles can be created when changeset id is between
diff --git a/source/blender/blenkernel/intern/node.cc b/source/blender/blenkernel/intern/node.cc
index f97e8df4387..a685eefcf4f 100644
--- a/source/blender/blenkernel/intern/node.cc
+++ b/source/blender/blenkernel/intern/node.cc
@@ -660,7 +660,7 @@ void ntreeBlendReadData(BlendDataReader *reader, ID *owner_id, bNodeTree *ntree)
*
* NOTE: Using do_version is not a solution here, since this code will be called before any
* do_version takes place. Keeping it here also ensures future (or unknown existing) similar
- * bugs won't go easily unoticed. */
+ * bugs won't go easily unnoticed. */
CLOG_WARN(&LOG,
"Fixing root node tree '%s' owned by '%s' missing EMBEDDED tag, please consider "
"re-saving your (startup) file",
@@ -913,9 +913,9 @@ void ntreeBlendReadLib(struct BlendLibReader *reader, struct bNodeTree *ntree)
lib_link_node_sockets(reader, lib, &ntree->inputs);
lib_link_node_sockets(reader, lib, &ntree->outputs);
- /* Set node->typeinfo pointers. This is done in lib linking, after the
+ /* Set `node->typeinfo` pointers. This is done in lib linking, after the
* first versioning that can change types still without functions that
- * update the typeinfo pointers. Versioning after lib linking needs
+ * update the `typeinfo` pointers. Versioning after lib linking needs
* these top be valid. */
ntreeSetTypes(nullptr, ntree);
@@ -1072,7 +1072,7 @@ static void node_add_sockets_from_type(bNodeTree *ntree, bNode *node, bNodeType
}
/* NOTE: This function is called to initialize node data based on the type.
- * The bNodeType may not be registered at creation time of the node,
+ * The #bNodeType may not be registered at creation time of the node,
* so this can be delayed until the node type gets registered.
*/
static void node_init(const struct bContext *C, bNodeTree *ntree, bNode *node)
diff --git a/source/blender/blenkernel/intern/object.cc b/source/blender/blenkernel/intern/object.cc
index ec21d0b127b..ac33b11fcd2 100644
--- a/source/blender/blenkernel/intern/object.cc
+++ b/source/blender/blenkernel/intern/object.cc
@@ -2416,7 +2416,7 @@ ParticleSystem *BKE_object_copy_particlesystem(ParticleSystem *psys, const int f
}
/* XXX(@campbellbarton): from reading existing code this seems correct but intended usage of
- * point-cache should /w cloth should be added in 'ParticleSystem'. */
+ * point-cache should with cloth should be added in 'ParticleSystem'. */
if (psysn->clmd) {
psysn->clmd->point_cache = psysn->pointcache;
}
diff --git a/source/blender/blenkernel/intern/particle.c b/source/blender/blenkernel/intern/particle.c
index 8db83031e17..f560b30b297 100644
--- a/source/blender/blenkernel/intern/particle.c
+++ b/source/blender/blenkernel/intern/particle.c
@@ -5418,7 +5418,7 @@ void BKE_particle_system_blend_read_lib(BlendLibReader *reader,
if (psys->clmd) {
/* XXX(@campbellbarton): from reading existing code this seems correct but intended usage
- * of pointcache /w cloth should be added in 'ParticleSystem'. */
+ * of point-cache with cloth should be added in #ParticleSystem. */
psys->clmd->point_cache = psys->pointcache;
psys->clmd->ptcaches.first = psys->clmd->ptcaches.last = NULL;
BLO_read_id_address(reader, id->lib, &psys->clmd->coll_parms->group);
@@ -5426,7 +5426,7 @@ void BKE_particle_system_blend_read_lib(BlendLibReader *reader,
}
}
else {
- /* particle modifier must be removed before particle system */
+ /* Particle modifier must be removed before particle system. */
ParticleSystemModifierData *psmd = psys_get_modifier(ob, psys);
BKE_modifier_remove_from_list(ob, (ModifierData *)psmd);
BKE_modifier_free((ModifierData *)psmd);
diff --git a/source/blender/blenlib/BLI_pool.hh b/source/blender/blenlib/BLI_pool.hh
index 7ed39fea195..8745c019db5 100644
--- a/source/blender/blenlib/BLI_pool.hh
+++ b/source/blender/blenlib/BLI_pool.hh
@@ -5,7 +5,7 @@
*
* A `blender::Pool` allows fast allocation and deallocation of many elements of the same type.
*
- * It is compatible with types that are not moveable.
+ * It is compatible with types that are not movable.
*
* Freed elements memory will be reused by next allocations.
* Elements are allocated in chunks to reduce memory fragmentation and avoid reallocation.
diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h
index 163ea7e9493..27e2f89f684 100644
--- a/source/blender/editors/include/UI_interface.h
+++ b/source/blender/editors/include/UI_interface.h
@@ -354,7 +354,7 @@ typedef enum {
UI_BTYPE_LABEL = 20 << 9,
UI_BTYPE_KEY_EVENT = 24 << 9,
UI_BTYPE_HSVCUBE = 26 << 9,
- /** menu (often used in headers), **_MENU /w different draw-type */
+ /** Menu (often used in headers), `*_MENU` with different draw-type. */
UI_BTYPE_PULLDOWN = 27 << 9,
UI_BTYPE_ROUNDBOX = 28 << 9,
UI_BTYPE_COLORBAND = 30 << 9,
diff --git a/source/blender/makesdna/intern/dna_genfile.c b/source/blender/makesdna/intern/dna_genfile.c
index f43cf02c0b8..1b424756b0a 100644
--- a/source/blender/makesdna/intern/dna_genfile.c
+++ b/source/blender/makesdna/intern/dna_genfile.c
@@ -491,15 +491,15 @@ static bool init_structDNA(SDNA *sdna, bool do_endian_swap, const char **r_error
return false;
}
- /* finally pointer_size: use struct ListBase to test it, never change the size of it! */
+ /* finally pointer_size: use struct #ListBase to test it, never change the size of it! */
SDNA_Struct *struct_info = sdna->structs[nr];
- /* weird; i have no memory of that... I think I used sizeof(void *) before... (ton) */
+ /* Weird; I have no memory of that... I think I used `sizeof(void *)` before... (ton). */
sdna->
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list