From 71d0f6f8965850e3f8298d14e380b22defbef98a Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sun, 19 Jul 2020 17:12:48 +1000 Subject: Cleanup: spelling --- source/blender/blenkernel/intern/image.c | 2 +- source/blender/blenlib/intern/timecode.c | 4 ++-- source/blender/blenloader/intern/versioning_legacy.c | 2 +- .../draw/engines/workbench/shaders/workbench_common_lib.glsl | 4 ++-- source/blender/editors/space_clip/clip_ops.c | 2 +- source/blender/gpu/intern/gpu_node_graph.h | 2 +- source/blender/imbuf/IMB_imbuf.h | 12 ++++++------ source/blender/imbuf/intern/IMB_indexer.h | 6 +++--- source/blender/imbuf/intern/openexr/openexr_api.cpp | 10 +++++----- source/blender/io/usd/intern/usd_hierarchy_iterator.cc | 2 +- source/blender/makesdna/DNA_userdef_types.h | 8 ++++---- source/blender/makesrna/intern/rna_movieclip.c | 2 +- source/blender/makesrna/intern/rna_sequencer.c | 2 +- source/blender/makesrna/intern/rna_userdef.c | 7 +++---- source/blender/python/intern/bpy_interface.c | 6 +++--- source/blender/python/intern/bpy_rna.c | 4 ++-- source/blender/python/intern/bpy_traceback.c | 4 ++-- 17 files changed, 39 insertions(+), 40 deletions(-) (limited to 'source/blender') diff --git a/source/blender/blenkernel/intern/image.c b/source/blender/blenkernel/intern/image.c index a246265c3f2..9365ee040c2 100644 --- a/source/blender/blenkernel/intern/image.c +++ b/source/blender/blenkernel/intern/image.c @@ -64,7 +64,7 @@ #include "BLI_mempool.h" #include "BLI_system.h" #include "BLI_threads.h" -#include "BLI_timecode.h" /* for stamp timecode format */ +#include "BLI_timecode.h" /* For stamp time-code format. */ #include "BLI_utildefines.h" #include "BLT_translation.h" diff --git a/source/blender/blenlib/intern/timecode.c b/source/blender/blenlib/intern/timecode.c index 510b9651961..9586da941a4 100644 --- a/source/blender/blenlib/intern/timecode.c +++ b/source/blender/blenlib/intern/timecode.c @@ -36,7 +36,7 @@ #include "BLI_strict_flags.h" /** - * Generate timecode/frame number string and store in \a str + * Generate time-code/frame number string and store in \a str * * \param str: destination string * \param maxncpy: maximum number of characters to copy ``sizeof(str)`` @@ -44,7 +44,7 @@ * used to specify how detailed we need to be * \param time_seconds: time total time in seconds * \param fps: frames per second, typically from the #FPS macro - * \param timecode_style: enum from eTimecodeStyles + * \param timecode_style: enum from #eTimecodeStyles * \return length of \a str */ diff --git a/source/blender/blenloader/intern/versioning_legacy.c b/source/blender/blenloader/intern/versioning_legacy.c index ce472a97337..8c00c20c822 100644 --- a/source/blender/blenloader/intern/versioning_legacy.c +++ b/source/blender/blenloader/intern/versioning_legacy.c @@ -579,7 +579,7 @@ void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain) } if (bmain->versionfile <= 109) { - /* new variable: gridlines */ + /* New variable: `gridlines`. */ bScreen *screen = bmain->screens.first; while (screen) { ScrArea *area = screen->areabase.first; diff --git a/source/blender/draw/engines/workbench/shaders/workbench_common_lib.glsl b/source/blender/draw/engines/workbench/shaders/workbench_common_lib.glsl index 265d19f336f..c529f23265b 100644 --- a/source/blender/draw/engines/workbench/shaders/workbench_common_lib.glsl +++ b/source/blender/draw/engines/workbench/shaders/workbench_common_lib.glsl @@ -48,7 +48,7 @@ float workbench_float_pair_encode(float v1, float v2) { // const uint v1_mask = ~(0xFFFFFFFFu << ROUGHNESS_BITS); // const uint v2_mask = ~(0xFFFFFFFFu << METALLIC_BITS); - /* Same as above because some compiler are dumb af. and think we use mediump int. */ + /* Same as above because some compiler are very dumb and think we use medium int. */ const int v1_mask = 0x1F; const int v2_mask = 0x7; int iv1 = int(v1 * float(v1_mask)); @@ -60,7 +60,7 @@ void workbench_float_pair_decode(float data, out float v1, out float v2) { // const uint v1_mask = ~(0xFFFFFFFFu << ROUGHNESS_BITS); // const uint v2_mask = ~(0xFFFFFFFFu << METALLIC_BITS); - /* Same as above because some compiler are dumb af. and think we use mediump int. */ + /* Same as above because some compiler are very dumb and think we use medium int. */ const int v1_mask = 0x1F; const int v2_mask = 0x7; int idata = int(data); diff --git a/source/blender/editors/space_clip/clip_ops.c b/source/blender/editors/space_clip/clip_ops.c index 9da75ab7e3c..8532d8420f9 100644 --- a/source/blender/editors/space_clip/clip_ops.c +++ b/source/blender/editors/space_clip/clip_ops.c @@ -1515,7 +1515,7 @@ static void proxy_endjob(void *pjv) } if (pj->clip->source == MCLIP_SRC_MOVIE) { - /* Timecode might have changed, so do a full reload to deal with this. */ + /* Time-code might have changed, so do a full reload to deal with this. */ DEG_id_tag_update(&pj->clip->id, ID_RECALC_SOURCE); } else { diff --git a/source/blender/gpu/intern/gpu_node_graph.h b/source/blender/gpu/intern/gpu_node_graph.h index 3067be1c485..bf59b720cff 100644 --- a/source/blender/gpu/intern/gpu_node_graph.h +++ b/source/blender/gpu/intern/gpu_node_graph.h @@ -116,7 +116,7 @@ typedef struct GPUInput { struct GPUInput *next, *prev; GPUNode *node; - eGPUType type; /* datatype */ + eGPUType type; /* data-type. */ GPUNodeLink *link; int id; /* unique id as created by code generator */ diff --git a/source/blender/imbuf/IMB_imbuf.h b/source/blender/imbuf/IMB_imbuf.h index fc7e03c3073..478297e61b2 100644 --- a/source/blender/imbuf/IMB_imbuf.h +++ b/source/blender/imbuf/IMB_imbuf.h @@ -291,7 +291,7 @@ void IMB_rectblend_threaded(struct ImBuf *dbuf, */ typedef enum IMB_Timecode_Type { - /** Don't use timecode files at all. */ + /** Don't use time-code files at all. */ IMB_TC_NONE = 0, /** use images in the order as they are recorded * (currently, this is the only one implemented @@ -318,7 +318,7 @@ typedef enum IMB_Proxy_Size { IMB_PROXY_MAX_SLOT = 4, } IMB_Proxy_Size; -/* defaults to BL_proxy within the directory of the animation */ +/* Defaults to BL_proxy within the directory of the animation. */ void IMB_anim_set_index_dir(struct anim *anim, const char *dir); void IMB_anim_get_fname(struct anim *anim, char *file, int size); @@ -328,7 +328,7 @@ IMB_Proxy_Size IMB_anim_proxy_get_existing(struct anim *anim); struct IndexBuildContext; -/* prepare context for proxies/imecodes builder */ +/* Prepare context for proxies/time-codes builder. */ struct IndexBuildContext *IMB_anim_index_rebuild_context(struct anim *anim, IMB_Timecode_Type tcs_in_use, IMB_Proxy_Size proxy_sizes_in_use, @@ -336,13 +336,13 @@ struct IndexBuildContext *IMB_anim_index_rebuild_context(struct anim *anim, const bool overwrite, struct GSet *file_list); -/* will rebuild all used indices and proxies at once */ +/* Will rebuild all used indices and proxies at once. */ void IMB_anim_index_rebuild(struct IndexBuildContext *context, short *stop, short *do_update, float *progress); -/* finish rebuilding proxises/timecodes and free temporary contexts used */ +/* Finish rebuilding proxies/time-codes and free temporary contexts used. */ void IMB_anim_index_rebuild_finish(struct IndexBuildContext *context, short stop); /** @@ -391,7 +391,7 @@ struct ImBuf *IMB_anim_absolute(struct anim *anim, /** * * \attention Defined in anim_movie.c - * fetches a define previewframe, usually half way into the movie + * fetches a define preview-frame, usually half way into the movie. */ struct ImBuf *IMB_anim_previewframe(struct anim *anim); diff --git a/source/blender/imbuf/intern/IMB_indexer.h b/source/blender/imbuf/intern/IMB_indexer.h index 61bb50aff38..446aaa0655e 100644 --- a/source/blender/imbuf/intern/IMB_indexer.h +++ b/source/blender/imbuf/intern/IMB_indexer.h @@ -31,9 +31,9 @@ /* * separate animation index files to solve the following problems: * - * a) different timecodes within one file (like DTS/PTS, Timecode-Track, - * "implicit" timecodes within DV-files and HDV-files etc.) - * b) seeking difficulties within ffmpeg for files with timestamp holes + * a) different time-codes within one file (like DTS/PTS, Time-code-Track, + * "implicit" time-codes within DV-files and HDV-files etc.) + * b) seeking difficulties within FFMPEG for files with timestamp holes * c) broken files that miss several frames / have varying framerates * d) use proxies accordingly * diff --git a/source/blender/imbuf/intern/openexr/openexr_api.cpp b/source/blender/imbuf/intern/openexr/openexr_api.cpp index 2a5532a0902..887225f0dc6 100644 --- a/source/blender/imbuf/intern/openexr/openexr_api.cpp +++ b/source/blender/imbuf/intern/openexr/openexr_api.cpp @@ -1209,7 +1209,7 @@ void IMB_exr_read_channels(void *handle) ExrHandle *data = (ExrHandle *)handle; int numparts = data->ifile->parts(); - /* check if exr was saved with previous versions of blender which flipped images */ + /* Check if EXR was saved with previous versions of blender which flipped images. */ const StringAttribute *ta = data->ifile->header(0).findTypedAttribute( "BlenderMultiChannel"); @@ -1803,12 +1803,12 @@ static void imb_exr_type_by_channels(ChannelList &channels, } if (!layerNames.empty()) { - /* if layerNames is not empty, it means at least one layer is non-empty, + /* If `layerNames` is not empty, it means at least one layer is non-empty, * but it also could be layers without names in the file and such case - * shall be considered a multilayer exr + * shall be considered a multi-layer EXR. * - * that's what we do here: test whether there're empty layer names together - * with non-empty ones in the file + * That's what we do here: test whether there are empty layer names together + * with non-empty ones in the file. */ for (ChannelList::ConstIterator i = channels.begin(); i != channels.end(); i++) { for (std::set::iterator i = layerNames.begin(); i != layerNames.end(); i++) { diff --git a/source/blender/io/usd/intern/usd_hierarchy_iterator.cc b/source/blender/io/usd/intern/usd_hierarchy_iterator.cc index f42349d99e8..d0db1284c77 100644 --- a/source/blender/io/usd/intern/usd_hierarchy_iterator.cc +++ b/source/blender/io/usd/intern/usd_hierarchy_iterator.cc @@ -73,7 +73,7 @@ std::string USDHierarchyIterator::make_valid_name(const std::string &name) const void USDHierarchyIterator::set_export_frame(float frame_nr) { - // The USD stage is already set up to have FPS timecodes per frame. + /* The USD stage is already set up to have FPS time-codes per frame. */ export_time_ = pxr::UsdTimeCode(frame_nr); } diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index cd5be0638e1..e6f6ce1e208 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -661,9 +661,9 @@ typedef struct UserDef { char anim_player[1024]; int anim_player_preset; - /** Minimum spacing between gridlines in View2D grids. */ + /** Minimum spacing between grid-lines in View2D grids. */ short v2d_min_gridsize; - /** #eTimecodeStyles, style of timecode display. */ + /** #eTimecodeStyles, style of time-code display. */ short timecode_style; short versions; @@ -694,7 +694,7 @@ typedef struct UserDef { float ui_scale; /** Setting for UI line width. */ int ui_line_width; - /** Runtime, full DPI divided by pixelsize. */ + /** Runtime, full DPI divided by `pixelsize`. */ int dpi; /** Runtime, multiplier to scale UI elements based on DPI. */ float dpi_fac; @@ -704,7 +704,7 @@ typedef struct UserDef { /** Deprecated, for forward compatibility. */ int virtual_pixel; - /** Console scrollback limit. */ + /** Console scroll-back limit. */ int scrollback; /** Node insert offset (aka auto-offset) margin, but might be useful for later stuff as well. */ char node_margin; diff --git a/source/blender/makesrna/intern/rna_movieclip.c b/source/blender/makesrna/intern/rna_movieclip.c index f3c73e75434..b94221ae936 100644 --- a/source/blender/makesrna/intern/rna_movieclip.c +++ b/source/blender/makesrna/intern/rna_movieclip.c @@ -218,7 +218,7 @@ static void rna_def_movieclip_proxy(BlenderRNA *brna) RNA_def_property_ui_text( prop, "100%", "Build proxy resolution 100% of the original undistorted footage dimension"); - /* build timecodes */ + /* Build time-codes. */ prop = RNA_def_property(srna, "build_record_run", PROP_BOOLEAN, PROP_NONE); RNA_def_property_boolean_sdna(prop, NULL, "build_tc_flag", IMB_TC_RECORD_RUN); RNA_def_property_clear_flag(prop, PROP_ANIMATABLE); diff --git a/source/blender/makesrna/intern/rna_sequencer.c b/source/blender/makesrna/intern/rna_sequencer.c index de225e3c685..6589ae4b8da 100644 --- a/source/blender/makesrna/intern/rna_sequencer.c +++ b/source/blender/makesrna/intern/rna_sequencer.c @@ -2145,7 +2145,7 @@ static void rna_def_proxy(StructRNA *srna) prop = RNA_def_property(srna, "use_proxy", PROP_BOOLEAN, PROP_NONE); RNA_def_property_boolean_sdna(prop, NULL, "flag", SEQ_USE_PROXY); RNA_def_property_ui_text( - prop, "Use Proxy / Timecode", "Use a preview proxy and/or timecode index for this strip"); + prop, "Use Proxy / Timecode", "Use a preview proxy and/or time-code index for this strip"); RNA_def_property_boolean_funcs(prop, NULL, "rna_Sequence_use_proxy_set"); RNA_def_property_update(prop, NC_SCENE | ND_SEQUENCER, "rna_Sequence_invalidate_raw_update"); diff --git a/source/blender/makesrna/intern/rna_userdef.c b/source/blender/makesrna/intern/rna_userdef.c index e609bdacb02..4884b536258 100644 --- a/source/blender/makesrna/intern/rna_userdef.c +++ b/source/blender/makesrna/intern/rna_userdef.c @@ -440,13 +440,12 @@ static void rna_userdef_timecode_style_set(PointerRNA *ptr, int value) UserDef *userdef = (UserDef *)ptr->data; int required_size = userdef->v2d_min_gridsize; - /* set the timecode style */ + /* Set the time-code style. */ userdef->timecode_style = value; - /* adjust the v2d gridsize if needed so that timecodes don't overlap + /* Adjust the v2d grid-size if needed so that time-codes don't overlap * NOTE: most of these have been hand-picked to avoid overlaps while still keeping - * things from getting too blown out - */ + * things from getting too blown out. */ switch (value) { case USER_TIMECODE_MINIMAL: case USER_TIMECODE_SECONDS_ONLY: diff --git a/source/blender/python/intern/bpy_interface.c b/source/blender/python/intern/bpy_interface.c index be5a92309f2..ed5e505176c 100644 --- a/source/blender/python/intern/bpy_interface.c +++ b/source/blender/python/intern/bpy_interface.c @@ -268,11 +268,11 @@ void BPY_python_start(int argc, const char **argv) /* allow to use our own included python */ PyC_SetHomePath(py_path_bundle); - /* without this the sys.stdout may be set to 'ascii' + /* Without this the `sys.stdout` may be set to 'ascii' * (it is on my system at least), where printing unicode values will raise - * an error, this is highly annoying, another stumbling block for devs, + * an error, this is highly annoying, another stumbling block for developers, * so use a more relaxed error handler and enforce utf-8 since the rest of - * blender is utf-8 too - campbell */ + * Blender is utf-8 too - campbell */ Py_SetStandardStreamEncoding("utf-8", "surrogateescape"); /* Suppress error messages when calculating the module search path. diff --git a/source/blender/python/intern/bpy_rna.c b/source/blender/python/intern/bpy_rna.c index ebbbc8f3140..893832b61b6 100644 --- a/source/blender/python/intern/bpy_rna.c +++ b/source/blender/python/intern/bpy_rna.c @@ -7660,8 +7660,8 @@ void BPY_update_rna_module(void) } #if 0 -/* This is a way we can access docstrings for RNA types - * without having the datatypes in blender */ +/* This is a way we can access doc-strings for RNA types + * without having the data-types in Blender. */ PyObject *BPY_rna_doc(void) { PointerRNA ptr; diff --git a/source/blender/python/intern/bpy_traceback.c b/source/blender/python/intern/bpy_traceback.c index dd7e6b03e8b..e2c894e90f8 100644 --- a/source/blender/python/intern/bpy_traceback.c +++ b/source/blender/python/intern/bpy_traceback.c @@ -140,8 +140,8 @@ void python_script_error_jump(const char *filepath, int *lineno, int *offset) PyErr_Fetch(&exception, &value, (PyObject **)&tb); if (exception && PyErr_GivenExceptionMatches(exception, PyExc_SyntaxError)) { - /* no traceback available when SyntaxError. - * python has no api's to this. reference parse_syntax_error() from pythonrun.c */ + /* no trace-back available when `SyntaxError`. + * python has no API's to this. reference #parse_syntax_error() from pythonrun.c */ PyErr_NormalizeException(&exception, &value, (PyObject **)&tb); if (value) { /* should always be true */ -- cgit v1.2.3