From addb1a5c9a91c3b4428a8d0548815632fa608e36 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 2 Jul 2021 12:11:54 +1000 Subject: Cleanup: spelling in comments --- intern/ghost/GHOST_C-api.h | 6 ++--- intern/ghost/intern/GHOST_SystemCocoa.h | 2 +- intern/ghost/test/gears/GHOST_C-Test.c | 2 +- source/blender/blenkernel/BKE_tracking.h | 2 +- source/blender/blenkernel/intern/bvhutils.cc | 30 +++++++++++----------- source/blender/blenkernel/intern/customdata_file.c | 4 +-- source/blender/blenkernel/intern/fcurve.c | 6 ++--- source/blender/blenkernel/intern/mesh_normals.c | 4 +-- source/blender/blenlib/intern/delaunay_2d.cc | 4 ++- source/blender/bmesh/operators/bmo_inset.c | 4 +-- source/blender/editors/mesh/editmesh_select.c | 2 +- .../editors/space_sequencer/sequencer_edit.c | 2 +- source/blender/makesdna/DNA_windowmanager_types.h | 2 +- .../modifiers/intern/MOD_weightvgproximity.c | 6 ++--- 14 files changed, 39 insertions(+), 37 deletions(-) diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 2bd9af6df5c..6e22d4ca3a5 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -507,7 +507,7 @@ extern GHOST_TimerProcPtr GHOST_GetTimerProc(GHOST_TimerTaskHandle timertaskhand /** * Changes the timer callback. - * \param timertaskhandle: The handle to the timertask. + * \param timertaskhandle: The handle to the timer-task. * \param timerProc: The timer callback. */ extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle, @@ -515,14 +515,14 @@ extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle, /** * Returns the timer user data. - * \param timertaskhandle: The handle to the timertask. + * \param timertaskhandle: The handle to the timer-task. * \return The timer user data. */ extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle); /** * Changes the time user data. - * \param timertaskhandle: The handle to the timertask. + * \param timertaskhandle: The handle to the timer-task. * \param userdata: The timer user data. */ extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle, diff --git a/intern/ghost/intern/GHOST_SystemCocoa.h b/intern/ghost/intern/GHOST_SystemCocoa.h index cee6398b5a6..8a209c9efaf 100644 --- a/intern/ghost/intern/GHOST_SystemCocoa.h +++ b/intern/ghost/intern/GHOST_SystemCocoa.h @@ -137,7 +137,7 @@ class GHOST_SystemCocoa : public GHOST_System { bool processEvents(bool waitForEvent); /** - * Handle User request to quit, from Menu bar Quit, and Cmd+Q + * Handle User request to quit, from Menu bar Quit, and Command+Q * Display alert panel if changes performed since last save */ void handleQuitRequest(); diff --git a/intern/ghost/test/gears/GHOST_C-Test.c b/intern/ghost/test/gears/GHOST_C-Test.c index 8cd1b5acb89..1867218ec65 100644 --- a/intern/ghost/test/gears/GHOST_C-Test.c +++ b/intern/ghost/test/gears/GHOST_C-Test.c @@ -274,7 +274,7 @@ static void setViewPortGL(GHOST_WindowHandle hWindow) glMatrixMode(GL_PROJECTION); glLoadIdentity(); glFrustum(-w, w, -h, h, 5.0, 60.0); - /* glOrtho(0, bnds.getWidth(), 0, bnds.getHeight(), -10, 10); */ + // glOrtho(0, bnds.getWidth(), 0, bnds.getHeight(), -10, 10); glMatrixMode(GL_MODELVIEW); glLoadIdentity(); glTranslatef(0.0, 0.0, -40.0); diff --git a/source/blender/blenkernel/BKE_tracking.h b/source/blender/blenkernel/BKE_tracking.h index c2544c06514..47145a7d6bd 100644 --- a/source/blender/blenkernel/BKE_tracking.h +++ b/source/blender/blenkernel/BKE_tracking.h @@ -161,7 +161,7 @@ struct MovieTrackingMarker *BKE_tracking_marker_get_exact(struct MovieTrackingTr struct MovieTrackingMarker *BKE_tracking_marker_ensure(struct MovieTrackingTrack *track, int framenr); -/* Get marker position, possibly interpolating interpolating gap between keyframed/tracked markers. +/* Get marker position, possibly interpolating gap between key-framed/tracked markers. * * The result marker frame number is set to the requested frame number. Its flags are 0 if the * marker is interpolated, and is set to original marker flag if there were no interpolation diff --git a/source/blender/blenkernel/intern/bvhutils.cc b/source/blender/blenkernel/intern/bvhutils.cc index d4fc8968f31..c2852426174 100644 --- a/source/blender/blenkernel/intern/bvhutils.cc +++ b/source/blender/blenkernel/intern/bvhutils.cc @@ -458,7 +458,7 @@ static void mesh_edges_nearest_point(void *userdata, } } -/* Helper, does all the point-spherecast work actually. */ +/* Helper, does all the point-sphere-cast work actually. */ static void mesh_verts_spherecast_do(int index, const float v[3], const BVHTreeRay *ray, @@ -672,7 +672,7 @@ BVHTree *bvhtree_from_editmesh_verts_ex(BVHTreeFromEditMesh *data, bvhtree_balance(tree, true); /* Save on cache for later use */ - /* printf("BVHTree built and saved on cache\n"); */ + // printf("BVHTree built and saved on cache\n"); bvhcache_insert(*bvh_cache_p, tree, bvh_cache_type); data->cached = true; } @@ -704,7 +704,7 @@ BVHTree *bvhtree_from_editmesh_verts( } /** - * Builds a bvh tree where nodes are the given vertices (note: does not copy given mverts!). + * Builds a bvh tree where nodes are the given vertices (note: does not copy given `vert`!). * \param vert_allocated: if true, vert freeing will be done when freeing data. * \param verts_mask: if not null, true elements give which vert to add to BVH tree. * \param verts_num_active: if >= 0, number of active verts to add to BVH tree @@ -737,7 +737,7 @@ BVHTree *bvhtree_from_mesh_verts_ex(BVHTreeFromMesh *data, if (bvh_cache_p) { /* Save on cache for later use */ - /* printf("BVHTree built and saved on cache\n"); */ + // printf("BVHTree built and saved on cache\n"); BVHCache *bvh_cache = *bvh_cache_p; bvhcache_insert(bvh_cache, tree, bvh_cache_type); in_cache = true; @@ -818,7 +818,7 @@ static BVHTree *bvhtree_from_mesh_edges_create_tree(const MVert *vert, } if (edges_num_active) { - /* Create a bvh-tree of the given target */ + /* Create a BVH-tree of the given target */ tree = BLI_bvhtree_new(edges_num_active, epsilon, tree_type, axis); if (tree) { for (int i = 0; i < edge_num; i++) { @@ -884,7 +884,7 @@ BVHTree *bvhtree_from_editmesh_edges_ex(BVHTreeFromEditMesh *data, epsilon, tree_type, axis, em, edges_mask, edges_num_active); bvhtree_balance(tree, true); /* Save on cache for later use */ - /* printf("BVHTree built and saved on cache\n"); */ + // printf("BVHTree built and saved on cache\n"); bvhcache_insert(bvh_cache, tree, bvh_cache_type); data->cached = true; } @@ -954,7 +954,7 @@ BVHTree *bvhtree_from_mesh_edges_ex(BVHTreeFromMesh *data, BVHCache *bvh_cache = *bvh_cache_p; /* Save on cache for later use */ - /* printf("BVHTree built and saved on cache\n"); */ + // printf("BVHTree built and saved on cache\n"); bvhcache_insert(bvh_cache, tree, bvh_cache_type); in_cache = true; } @@ -999,8 +999,8 @@ static BVHTree *bvhtree_from_mesh_faces_create_tree(float epsilon, faces_num_active = faces_num; } - /* Create a bvh-tree of the given target */ - /* printf("%s: building BVH, total=%d\n", __func__, numFaces); */ + /* Create a BVH-tree of the given target. */ + // printf("%s: building BVH, total=%d\n", __func__, numFaces); tree = BLI_bvhtree_new(faces_num_active, epsilon, tree_type, axis); if (tree) { if (vert && face) { @@ -1087,7 +1087,7 @@ BVHTree *bvhtree_from_mesh_faces_ex(BVHTreeFromMesh *data, if (bvh_cache_p) { /* Save on cache for later use */ - /* printf("BVHTree built and saved on cache\n"); */ + // printf("BVHTree built and saved on cache\n"); BVHCache *bvh_cache = *bvh_cache_p; bvhcache_insert(bvh_cache, tree, bvh_cache_type); in_cache = true; @@ -1129,8 +1129,8 @@ static BVHTree *bvhtree_from_editmesh_looptri_create_tree(float epsilon, looptri_num_active = looptri_num; } - /* Create a bvh-tree of the given target */ - /* printf("%s: building BVH, total=%d\n", __func__, numFaces); */ + /* Create a BVH-tree of the given target */ + // printf("%s: building BVH, total=%d\n", __func__, numFaces); tree = BLI_bvhtree_new(looptri_num_active, epsilon, tree_type, axis); if (tree) { const BMLoop *(*looptris)[3] = (const BMLoop *(*)[3])em->looptris; @@ -1180,8 +1180,8 @@ static BVHTree *bvhtree_from_mesh_looptri_create_tree(float epsilon, } if (looptri_num_active) { - /* Create a bvh-tree of the given target */ - /* printf("%s: building BVH, total=%d\n", __func__, numFaces); */ + /* Create a BVH-tree of the given target */ + // printf("%s: building BVH, total=%d\n", __func__, numFaces); tree = BLI_bvhtree_new(looptri_num_active, epsilon, tree_type, axis); if (tree) { if (vert && looptri) { @@ -1261,7 +1261,7 @@ BVHTree *bvhtree_from_editmesh_looptri_ex(BVHTreeFromEditMesh *data, epsilon, tree_type, axis, em, looptri_mask, looptri_num_active); /* Save on cache for later use */ - /* printf("BVHTree built and saved on cache\n"); */ + // printf("BVHTree built and saved on cache\n"); bvhcache_insert(bvh_cache, tree, bvh_cache_type); } bvhcache_unlock(bvh_cache, lock_started); diff --git a/source/blender/blenkernel/intern/customdata_file.c b/source/blender/blenkernel/intern/customdata_file.c index 314d5f4ff82..ef86a65f47d 100644 --- a/source/blender/blenkernel/intern/customdata_file.c +++ b/source/blender/blenkernel/intern/customdata_file.c @@ -361,9 +361,9 @@ bool cdf_write_open(CDataFile *cdf, const char *filename) cdf->writef = f; - /* fill header */ + /* Fill header. */ header = &cdf->header; - /* strcpy(, "BCDF"); // terminator out of range */ + /* Copy "BCDF" (string terminator out of range). */ header->ID[0] = 'B'; header->ID[1] = 'C'; header->ID[2] = 'D'; diff --git a/source/blender/blenkernel/intern/fcurve.c b/source/blender/blenkernel/intern/fcurve.c index 7fe7b38e120..a670e7b9ac5 100644 --- a/source/blender/blenkernel/intern/fcurve.c +++ b/source/blender/blenkernel/intern/fcurve.c @@ -2194,9 +2194,9 @@ float evaluate_fcurve(FCurve *fcu, float evaltime) float evaluate_fcurve_only_curve(FCurve *fcu, float evaltime) { - /* Can be used to evaluate the (keyframed) fcurve only. - * Also works for driver-fcurves when the driver itself is not relevant. - * E.g. when inserting a keyframe in a driver fcurve. */ + /* Can be used to evaluate the (key-framed) f-curve only. + * Also works for driver-f-curves when the driver itself is not relevant. + * E.g. when inserting a keyframe in a driver f-curve. */ return evaluate_fcurve_ex(fcu, evaltime, 0.0); } diff --git a/source/blender/blenkernel/intern/mesh_normals.c b/source/blender/blenkernel/intern/mesh_normals.c index 9f09ce46e11..a268f814cd0 100644 --- a/source/blender/blenkernel/intern/mesh_normals.c +++ b/source/blender/blenkernel/intern/mesh_normals.c @@ -688,8 +688,8 @@ void BKE_lnor_space_custom_data_to_normal(MLoopNorSpace *lnor_space, } { - /* TODO Check whether using sincosf() gives any noticeable benefit - * (could not even get it working under linux though)! */ + /* TODO: Check whether using #sincosf() gives any noticeable benefit + * (could not even get it working under linux though)! */ const float pi2 = (float)(M_PI * 2.0); const float alphafac = unit_short_to_float(clnor_data[0]); const float alpha = (alphafac > 0.0f ? lnor_space->ref_alpha : pi2 - lnor_space->ref_alpha) * diff --git a/source/blender/blenlib/intern/delaunay_2d.cc b/source/blender/blenlib/intern/delaunay_2d.cc index eb3e64c49e6..91d63e3444e 100644 --- a/source/blender/blenlib/intern/delaunay_2d.cc +++ b/source/blender/blenlib/intern/delaunay_2d.cc @@ -896,7 +896,9 @@ template inline bool is_original_vert(const CDTVert *v, CDT_state return (v->index < cdt->input_vert_tot); } -/* Return the Symedge that goes from v1 to v2, if it exists, else return nullptr. */ +/** + * Return the #SymEdge that goes from v1 to v2, if it exists, else return nullptr. + */ template SymEdge *find_symedge_between_verts(const CDTVert *v1, const CDTVert *v2) { diff --git a/source/blender/bmesh/operators/bmo_inset.c b/source/blender/bmesh/operators/bmo_inset.c index 39f8f41432a..3f6619cc2ee 100644 --- a/source/blender/bmesh/operators/bmo_inset.c +++ b/source/blender/bmesh/operators/bmo_inset.c @@ -1016,8 +1016,8 @@ void bmo_inset_region_exec(BMesh *bm, BMOperator *op) if (use_even_boundary) { /** - * This case where only one edge attached to #v_split - * is used - ei - the face to inset is on a boundary. + * This case where only one edge attached to #v_split is used. + * i.e. the face to inset is on a boundary. * * 
                  *                  We want the inset to align flush with the
diff --git a/source/blender/editors/mesh/editmesh_select.c b/source/blender/editors/mesh/editmesh_select.c
index d8973e100bc..49fd2a441f0 100644
--- a/source/blender/editors/mesh/editmesh_select.c
+++ b/source/blender/editors/mesh/editmesh_select.c
@@ -964,7 +964,7 @@ static bool unified_findnearest(ViewContext *vc,
     }
   }
 
-  /* return only one of 3 pointers, for frontbuffer redraws */
+  /* Return only one of 3 pointers, for front-buffer redraws. */
   if (hit.v.ele) {
     hit.f.ele = NULL;
     hit.e.ele = NULL;
diff --git a/source/blender/editors/space_sequencer/sequencer_edit.c b/source/blender/editors/space_sequencer/sequencer_edit.c
index 48b8a1b87a3..94572698727 100644
--- a/source/blender/editors/space_sequencer/sequencer_edit.c
+++ b/source/blender/editors/space_sequencer/sequencer_edit.c
@@ -3008,7 +3008,7 @@ static int sequencer_export_subtitles_exec(bContext *C, wmOperator *op)
     char timecode_str_start[32];
     char timecode_str_end[32];
 
-    /* Write timecode relative to start frame of scene. Don't allow negative timecodes. */
+    /* Write time-code relative to start frame of scene. Don't allow negative time-codes. */
     BLI_timecode_string_from_time(timecode_str_start,
                                   sizeof(timecode_str_start),
                                   -2,
diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h
index 59091fec4b8..e4df420fb34 100644
--- a/source/blender/makesdna/DNA_windowmanager_types.h
+++ b/source/blender/makesdna/DNA_windowmanager_types.h
@@ -366,7 +366,7 @@ typedef struct wmKeyMapItem {
   short type;
   /** KM_ANY, KM_PRESS, KM_NOTHING etc. */
   short val;
-  /** Oskey is apple or windowskey, value denotes order of pressed. */
+  /** `oskey` also known as apple, windows-key or super, value denotes order of pressed. */
   short shift, ctrl, alt, oskey;
   /** Raw-key modifier. */
   short keymodifier;
diff --git a/source/blender/modifiers/intern/MOD_weightvgproximity.c b/source/blender/modifiers/intern/MOD_weightvgproximity.c
index cd03175f16c..b0d2f52f78c 100644
--- a/source/blender/modifiers/intern/MOD_weightvgproximity.c
+++ b/source/blender/modifiers/intern/MOD_weightvgproximity.c
@@ -174,7 +174,7 @@ static void get_vert2geom_distance(int numVerts,
   BVHTreeFromMesh treeData_f = {NULL};
 
   if (dist_v) {
-    /* Create a bvh-tree of the given target's verts. */
+    /* Create a BVH-tree of the given target's verts. */
     BKE_bvhtree_from_mesh_get(&treeData_v, target, BVHTREE_FROM_VERTS, 2);
     if (treeData_v.tree == NULL) {
       OUT_OF_MEMORY();
@@ -182,7 +182,7 @@ static void get_vert2geom_distance(int numVerts,
     }
   }
   if (dist_e) {
-    /* Create a bvh-tree of the given target's edges. */
+    /* Create a BVH-tree of the given target's edges. */
     BKE_bvhtree_from_mesh_get(&treeData_e, target, BVHTREE_FROM_EDGES, 2);
     if (treeData_e.tree == NULL) {
       OUT_OF_MEMORY();
@@ -190,7 +190,7 @@ static void get_vert2geom_distance(int numVerts,
     }
   }
   if (dist_f) {
-    /* Create a bvh-tree of the given target's faces. */
+    /* Create a BVH-tree of the given target's faces. */
     BKE_bvhtree_from_mesh_get(&treeData_f, target, BVHTREE_FROM_LOOPTRI, 2);
     if (treeData_f.tree == NULL) {
       OUT_OF_MEMORY();
-- 
cgit v1.2.3