From 7cd6bda206800218da47ee35c53066a71d25ef22 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 7 Apr 2022 14:48:00 +1000 Subject: [PATCH] Cleanup: spelling in comments, minor reformatting changes --- source/blender/blenkernel/BKE_attribute.h | 7 ++++--- source/blender/blenkernel/intern/dynamicpaint.c | 2 +- source/blender/blenkernel/intern/softbody.c | 2 +- source/blender/draw/engines/workbench/workbench_data.c | 2 +- source/blender/editors/armature/pose_lib.c | 2 +- source/blender/editors/interface/interface.cc | 2 +- source/blender/imbuf/intern/bmp.c | 2 +- source/blender/imbuf/intern/indexer.c | 2 +- source/blender/imbuf/intern/jp2.c | 6 +++--- source/blender/io/collada/collada_utils.cpp | 3 +-- source/blender/makesdna/DNA_text_types.h | 1 - source/blender/windowmanager/WM_types.h | 6 +++--- source/blender/windowmanager/wm_event_types.h | 2 +- 13 files changed, 19 insertions(+), 20 deletions(-) diff --git a/source/blender/blenkernel/BKE_attribute.h b/source/blender/blenkernel/BKE_attribute.h index f3968c0d761..c5aca6a9373 100644 --- a/source/blender/blenkernel/BKE_attribute.h +++ b/source/blender/blenkernel/BKE_attribute.h @@ -51,7 +51,8 @@ typedef enum AttributeDomainMask { bool BKE_id_attributes_supported(struct ID *id); -/** Create a new attribute layer. +/** + * Create a new attribute layer. */ struct CustomDataLayer *BKE_id_attribute_new( struct ID *id, const char *name, int type, AttributeDomain domain, struct ReportList *reports); @@ -103,11 +104,11 @@ void BKE_id_attribute_subset_active_set(struct ID *id, CustomDataMask mask); /** - * Sets up a temporary ID with arbitrary CustomData domains. r_id will + * Sets up a temporary ID with arbitrary CustomData domains. `r_id` will * be zero initialized with ID type id_type and any non-nullptr * CustomData parameter will be copied into the appropriate struct members. * - * \param r_id Pointer to storage sufficient for ID typecode id_type. + * \param r_id: Pointer to storage sufficient for ID type-code id_type. */ void BKE_id_attribute_copy_domains_temp(short id_type, const struct CustomData *vdata, diff --git a/source/blender/blenkernel/intern/dynamicpaint.c b/source/blender/blenkernel/intern/dynamicpaint.c index 0f5814c0a23..b85b2b3157c 100644 --- a/source/blender/blenkernel/intern/dynamicpaint.c +++ b/source/blender/blenkernel/intern/dynamicpaint.c @@ -4018,7 +4018,7 @@ static void dynamic_paint_paint_mesh_cell_point_cb_ex( treeData->tree, ray_start, ray_dir, 0.0f, &hit, mesh_tris_spherecast_dp, treeData); if (hit.index != -1) { - /* Add factor on supersample filter */ + /* Add factor on super-sample filter. */ volume_factor = 1.0f; hit_found = HIT_VOLUME; diff --git a/source/blender/blenkernel/intern/softbody.c b/source/blender/blenkernel/intern/softbody.c index 38066f95084..afb8d5cb9f8 100644 --- a/source/blender/blenkernel/intern/softbody.c +++ b/source/blender/blenkernel/intern/softbody.c @@ -292,7 +292,7 @@ static ccd_Mesh *ccd_mesh_make(Object *ob) pccd_M->bbmax[0] = pccd_M->bbmax[1] = pccd_M->bbmax[2] = -1e30f; pccd_M->mprevvert = NULL; - /* blow it up with forcefield ranges */ + /* Blow it up with force-field ranges. */ hull = max_ff(ob->pd->pdef_sbift, ob->pd->pdef_sboft); /* Allocate and copy verts. */ diff --git a/source/blender/draw/engines/workbench/workbench_data.c b/source/blender/draw/engines/workbench/workbench_data.c index 326727685fc..f4e042933d1 100644 --- a/source/blender/draw/engines/workbench/workbench_data.c +++ b/source/blender/draw/engines/workbench/workbench_data.c @@ -99,7 +99,7 @@ static void workbench_studiolight_data_update(WORKBENCH_PrivateData *wpd, WORKBE if (sl && sl->flag) { copy_v3_v3(light->light_direction, sl->vec); mul_mat3_m4_v3(rot_matrix, light->light_direction); - /* We should predivide the power by PI but that makes the lights really dim. */ + /* We should pre-divide the power by PI but that makes the lights really dim. */ copy_v3_v3(light->specular_color, sl->spec); copy_v3_v3(light->diffuse_color, sl->col); light->wrapped = sl->smooth; diff --git a/source/blender/editors/armature/pose_lib.c b/source/blender/editors/armature/pose_lib.c index 753ffe47698..e0e5693c79b 100644 --- a/source/blender/editors/armature/pose_lib.c +++ b/source/blender/editors/armature/pose_lib.c @@ -450,7 +450,7 @@ static int poselib_add_menu_invoke(bContext *C, wmOperator *op, const wmEvent *U "frame", CFRA); - /* replace existing - submenu */ + /* Replace existing - sub-menu. */ uiItemMenuF( layout, IFACE_("Replace Existing..."), 0, poselib_add_menu_invoke__replacemenu, NULL); } diff --git a/source/blender/editors/interface/interface.cc b/source/blender/editors/interface/interface.cc index b34d61d5192..0ecaead4194 100644 --- a/source/blender/editors/interface/interface.cc +++ b/source/blender/editors/interface/interface.cc @@ -722,7 +722,7 @@ bool ui_but_rna_equals_ex(const uiBut *but, return true; } -/* NOTE: if but->poin is allocated memory for every defbut, things fail... */ +/* NOTE: if `but->poin` is allocated memory for every `uiDefBut*`, things fail. */ static bool ui_but_equals_old(const uiBut *but, const uiBut *oldbut) { /* various properties are being compared here, hopefully sufficient diff --git a/source/blender/imbuf/intern/bmp.c b/source/blender/imbuf/intern/bmp.c index 3ea65c57577..967cbd04813 100644 --- a/source/blender/imbuf/intern/bmp.c +++ b/source/blender/imbuf/intern/bmp.c @@ -70,7 +70,7 @@ static bool checkbmp(const uchar *mem, const size_t size) BMPINFOHEADER bmi; uint u; - /* skip fileheader */ + /* Skip file-header. */ mem += BMP_FILEHEADER_SIZE; /* for systems where an int needs to be 4 bytes aligned */ diff --git a/source/blender/imbuf/intern/indexer.c b/source/blender/imbuf/intern/indexer.c index 357b250d0fe..1cc91d25d2a 100644 --- a/source/blender/imbuf/intern/indexer.c +++ b/source/blender/imbuf/intern/indexer.c @@ -272,7 +272,7 @@ int IMB_indexer_get_frame_index(struct anim_index *idx, int frameno) int middle; int first = 0; - /* bsearch (lower bound) the right index */ + /* Binary-search (lower bound) the right index. */ while (len > 0) { half = len >> 1; diff --git a/source/blender/imbuf/intern/jp2.c b/source/blender/imbuf/intern/jp2.c index 97749585c16..a14c94d5d62 100644 --- a/source/blender/imbuf/intern/jp2.c +++ b/source/blender/imbuf/intern/jp2.c @@ -633,8 +633,8 @@ BLI_INLINE int DOWNSAMPLE_FLOAT_TO_16BIT(const float _val) /* ****************************** COPIED FROM image_to_j2k.c */ /* ----------------------------------------------------------------------- */ -#define CINEMA_24_CS 1302083 /* Codestream length for 24fps. */ -#define CINEMA_48_CS 651041 /* Codestream length for 48fps. */ +#define CINEMA_24_CS 1302083 /* Code-stream length for 24fps. */ +#define CINEMA_48_CS 651041 /* Code-stream length for 48fps. */ #define COMP_24_CS 1041666 /* Maximum size per color component for 2K & 4K @ 24fps. */ #define COMP_48_CS 520833 /* Maximum size per color component for 2K @ 48fps. */ @@ -673,7 +673,7 @@ static void cinema_parameters(opj_cparameters_t *parameters) parameters->image_offset_x0 = 0; parameters->image_offset_y0 = 0; - /* Codeblock size = 32 * 32. */ + /* Code-block size = 32 * 32. */ parameters->cblockw_init = 32; parameters->cblockh_init = 32; parameters->csty |= 0x01; diff --git a/source/blender/io/collada/collada_utils.cpp b/source/blender/io/collada/collada_utils.cpp index 8d7ada4a600..0c902700b6b 100644 --- a/source/blender/io/collada/collada_utils.cpp +++ b/source/blender/io/collada/collada_utils.cpp @@ -614,8 +614,7 @@ void BoneExtended::set_bone_layers(std::string layerString, std::vectorbone_layers = bc_set_layer(this->bone_layers, pos); } } diff --git a/source/blender/makesdna/DNA_text_types.h b/source/blender/makesdna/DNA_text_types.h index 362c7eae3cb..335a366c814 100644 --- a/source/blender/makesdna/DNA_text_types.h +++ b/source/blender/makesdna/DNA_text_types.h @@ -22,7 +22,6 @@ typedef struct TextLine { char *line; /** May be NULL if syntax is off or not yet formatted. */ char *format; - /** Blen unused. */ int len; char _pad0[4]; } TextLine; diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h index 5d341c479a7..11603b9e5f7 100644 --- a/source/blender/windowmanager/WM_types.h +++ b/source/blender/windowmanager/WM_types.h @@ -1156,12 +1156,12 @@ typedef struct wmDrag { } wmDrag; /** - * Dropboxes are like keymaps, part of the screen/area/region definition. + * Drop-boxes are like key-maps, part of the screen/area/region definition. * Allocation and free is on startup and exit. * * The operator is polled and invoked with the current context (#WM_OP_INVOKE_DEFAULT), there is no - * way to override that (by design, since dropboxes should act on the exact mouse position). So the - * drop-boxes are supposed to check the required area and region context in their poll. + * way to override that (by design, since drop-boxes should act on the exact mouse position). + * So the drop-boxes are supposed to check the required area and region context in their poll. */ typedef struct wmDropBox { struct wmDropBox *next, *prev; diff --git a/source/blender/windowmanager/wm_event_types.h b/source/blender/windowmanager/wm_event_types.h index 0a0fdfa769a..2d3624704d0 100644 --- a/source/blender/windowmanager/wm_event_types.h +++ b/source/blender/windowmanager/wm_event_types.h @@ -5,7 +5,7 @@ */ /* - * These define have its origin at sgi, where all device defines were written down in device.h. + * These define have its origin at SGI, where all device defines were written down in device.h. * Blender copied the conventions quite some, and expanded it with internal new defines (ton) */