From dbaa9291f2731e1775f75cbb548c0296e3100227 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 30 Sep 2020 12:25:58 +1000 Subject: Cleanup: spelling --- intern/ghost/intern/GHOST_SystemCocoa.h | 10 +++++----- source/blender/blenkernel/BKE_paint.h | 2 +- source/blender/blenkernel/intern/paint.c | 24 +++++++++++++----------- source/blender/makesdna/intern/dna_genfile.c | 9 +++++---- 4 files changed, 24 insertions(+), 21 deletions(-) diff --git a/intern/ghost/intern/GHOST_SystemCocoa.h b/intern/ghost/intern/GHOST_SystemCocoa.h index b89edf8835d..22f3c58d297 100644 --- a/intern/ghost/intern/GHOST_SystemCocoa.h +++ b/intern/ghost/intern/GHOST_SystemCocoa.h @@ -251,10 +251,10 @@ class GHOST_SystemCocoa : public GHOST_System { /** * Handles a tablet event. - * \param eventPtr An NSEvent pointer (casted to void* to enable compilation in standard C++) - * \param eventType The type of the event. + * \param eventPtr: An #NSEvent pointer (cast to void* to enable compilation in standard C++). + * \param eventType: The type of the event. * It needs to be passed separately as it can be either directly in the event type, - * or as a subtype if combined with a mouse button event. + * or as a sub-type if combined with a mouse button event. * \return Indication whether the event was handled. */ GHOST_TSuccess handleTabletEvent(void *eventPtr, short eventType); @@ -262,14 +262,14 @@ class GHOST_SystemCocoa : public GHOST_System { /** * Handles a mouse event. - * \param eventPtr An NSEvent pointer (casted to void* to enable compilation in standard C++) + * \param eventPtr: An #NSEvent pointer (cast to `void *` to enable compilation in standard C++). * \return Indication whether the event was handled. */ GHOST_TSuccess handleMouseEvent(void *eventPtr); /** * Handles a key event. - * \param eventPtr An NSEvent pointer (casted to void* to enable compilation in standard C++) + * \param eventPtr: An #NSEvent pointer (cast to `void *` to enable compilation in standard C++). * \return Indication whether the event was handled. */ GHOST_TSuccess handleKeyEvent(void *eventPtr); diff --git a/source/blender/blenkernel/BKE_paint.h b/source/blender/blenkernel/BKE_paint.h index fc6cdc397cc..653c8a752d5 100644 --- a/source/blender/blenkernel/BKE_paint.h +++ b/source/blender/blenkernel/BKE_paint.h @@ -583,7 +583,7 @@ void BKE_sculpt_bvh_update_from_ccg(struct PBVH *pbvh, struct SubdivCCG *subdiv_ * updated according to the face sets. */ void BKE_sculpt_sync_face_set_visibility(struct Mesh *mesh, struct SubdivCCG *subdiv_ccg); -/* Ensures that a Face Set datalayers exists. If it does not, it creates one respecting the +/* Ensures that a Face Set data-layers exists. If it does not, it creates one respecting the * visibility stored in the vertices of the mesh. If it does, it copies the visibility from the * mesh to the Face Sets. */ void BKE_sculpt_face_sets_ensure_from_base_mesh_visibility(struct Mesh *mesh); diff --git a/source/blender/blenkernel/intern/paint.c b/source/blender/blenkernel/intern/paint.c index f07b98199bc..b09ee51995f 100644 --- a/source/blender/blenkernel/intern/paint.c +++ b/source/blender/blenkernel/intern/paint.c @@ -1312,7 +1312,9 @@ void BKE_sculptsession_free_vwpaint_data(struct SculptSession *ss) MEM_SAFE_FREE(gmap->poly_map_mem); } -/* Write out the sculpt dynamic-topology BMesh to the Mesh */ +/** + * Write out the sculpt dynamic-topology #BMesh to the #Mesh. + */ static void sculptsession_bm_to_me_update_data_only(Object *ob, bool reorder) { SculptSession *ss = ob->sculpt; @@ -1609,9 +1611,9 @@ static void sculpt_update_object(Depsgraph *depsgraph, /* Sculpt Face Sets. */ if (use_face_sets) { if (!CustomData_has_layer(&me->pdata, CD_SCULPT_FACE_SETS)) { - /* By checking here if the datalayer already exist this avoids copying the visibility from + /* By checking here if the data-layer already exist this avoids copying the visibility from * the mesh and looping over all vertices on every sculpt editing operation, using this - * function only the first time the Face Sets datalayer needs to be created. */ + * function only the first time the Face Sets data-layer needs to be created. */ BKE_sculpt_face_sets_ensure_from_base_mesh_visibility(me); } ss->face_sets = CustomData_get_layer(&me->pdata, CD_SCULPT_FACE_SETS); @@ -1896,7 +1898,7 @@ void BKE_sculpt_face_sets_ensure_from_base_mesh_visibility(Mesh *mesh) int *new_face_sets = CustomData_add_layer( &mesh->pdata, CD_SCULPT_FACE_SETS, CD_CALLOC, NULL, mesh->totpoly); - /* Initialize the new Face Set datalayer with a default valid visible ID and set the default + /* Initialize the new Face Set data-layer with a default valid visible ID and set the default * color to render it white. */ for (int i = 0; i < mesh->totpoly; i++) { new_face_sets[i] = face_sets_default_visible_id; @@ -1906,15 +1908,15 @@ void BKE_sculpt_face_sets_ensure_from_base_mesh_visibility(Mesh *mesh) int *face_sets = CustomData_get_layer(&mesh->pdata, CD_SCULPT_FACE_SETS); - /* Show the only the face sets that have all visibile vertices. */ + /* Show the only the face sets that have all visible vertices. */ for (int i = 0; i < mesh->totpoly; i++) { for (int l = 0; l < mesh->mpoly[i].totloop; l++) { MLoop *loop = &mesh->mloop[mesh->mpoly[i].loopstart + l]; if (mesh->mvert[loop->v].flag & ME_HIDE) { if (initialize_new_face_sets) { - /* When initializing a new Face Set datalayer, assing a new hidden Face Set ID to hidden + /* When initializing a new Face Set data-layer, assign a new hidden Face Set ID to hidden * vertices. This way, we get at initial split in two Face Sets between hidden and - * visible vertices based on the previous mesh visibily from other mode that can be + * visible vertices based on the previous mesh visibly from other mode that can be * useful in some cases. */ face_sets[i] = face_sets_default_hidden_id; } @@ -1936,7 +1938,7 @@ static void sculpt_sync_face_sets_visibility_to_base_mesh(Mesh *mesh) } /* Enabled if the vertex should be visible according to the Face Sets. */ - BLI_bitmap *visibile_vertex = BLI_BITMAP_NEW(mesh->totvert, "visible vertices"); + BLI_bitmap *visible_vertex = BLI_BITMAP_NEW(mesh->totvert, "visible vertices"); /* Enabled if the visibility of this vertex can be affected by the Face Sets to avoid modifying * disconnected geometry. */ BLI_bitmap *modified_vertex = BLI_BITMAP_NEW(mesh->totvert, "modified vertices"); @@ -1946,19 +1948,19 @@ static void sculpt_sync_face_sets_visibility_to_base_mesh(Mesh *mesh) for (int l = 0; l < mesh->mpoly[i].totloop; l++) { MLoop *loop = &mesh->mloop[mesh->mpoly[i].loopstart + l]; if (is_face_set_visible) { - BLI_BITMAP_ENABLE(visibile_vertex, loop->v); + BLI_BITMAP_ENABLE(visible_vertex, loop->v); } BLI_BITMAP_ENABLE(modified_vertex, loop->v); } } for (int i = 0; i < mesh->totvert; i++) { - if (BLI_BITMAP_TEST(modified_vertex, i) && !BLI_BITMAP_TEST(visibile_vertex, i)) { + if (BLI_BITMAP_TEST(modified_vertex, i) && !BLI_BITMAP_TEST(visible_vertex, i)) { mesh->mvert[i].flag |= ME_HIDE; } } - MEM_SAFE_FREE(visibile_vertex); + MEM_SAFE_FREE(visible_vertex); MEM_SAFE_FREE(modified_vertex); } diff --git a/source/blender/makesdna/intern/dna_genfile.c b/source/blender/makesdna/intern/dna_genfile.c index 74f587fe032..6bd855b6ad0 100644 --- a/source/blender/makesdna/intern/dna_genfile.c +++ b/source/blender/makesdna/intern/dna_genfile.c @@ -109,7 +109,7 @@ * * IMPORTANT: * - Do not use #defines in structs for array lengths, this cannot be read by the dna functions. - * - Do not use uint, but unsigned int instead, ushort and ulong are allowed. + * - Do not use `uint`, but unsigned int instead, `ushort` and `ulong` are allowed. * - Only use a long in Blender if you want this to be the size of a pointer. so it is * 32 bits or 64 bits, dependent at the cpu architecture. * - Chars are always unsigned @@ -731,7 +731,8 @@ const char *DNA_struct_get_compareflags(const SDNA *oldsdna, const SDNA *newsdna /** * Converts a value of one primitive type to another. - * Note there is no optimization for the case where otype and ctype are the same: + * + * \note there is no optimization for the case where \a otype and \a ctype are the same: * assumption is that caller will handle this case. * * \param old_type: Type to convert from. @@ -1546,8 +1547,8 @@ static int compress_reconstruct_steps(ReconstructStep *steps, const int old_step } /** - * Preprocess information about how structs in newsdna can be reconstructed from structs in - * oldsdna. This information is then used to speedup #DNA_struct_reconstruct. + * Pre-process information about how structs in \a newsdna can be reconstructed from structs in + * \a oldsdna. This information is then used to speedup #DNA_struct_reconstruct. */ DNA_ReconstructInfo *DNA_reconstruct_info_create(const SDNA *oldsdna, const SDNA *newsdna, -- cgit v1.2.3