From 4e45265dc6cafe0bf6f36a14a469288183059858 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 30 Nov 2021 09:04:50 +1100 Subject: Cleanup: spelling in comments & strings --- .../blender/blenkernel/BKE_blendfile_link_append.h | 6 +++--- source/blender/blenkernel/BKE_bpath.h | 8 ++++---- source/blender/blenkernel/BKE_modifier.h | 2 +- .../blenkernel/intern/blendfile_link_append.c | 24 +++++++++++----------- source/blender/blenkernel/intern/image.c | 2 +- source/blender/blenkernel/intern/lib_id.c | 2 +- source/blender/blenkernel/intern/scene.c | 2 +- source/blender/blenlib/BLI_virtual_array.hh | 2 +- source/blender/blenloader/BLO_undofile.h | 2 +- source/blender/blenloader/BLO_writefile.h | 2 +- source/blender/blenloader/intern/versioning_300.c | 4 ++-- source/blender/depsgraph/intern/node/deg_node.h | 2 +- .../blender/editors/asset/intern/asset_indexer.cc | 6 +++--- source/blender/editors/asset/intern/asset_ops.cc | 2 +- source/blender/editors/include/ED_file_indexer.h | 4 ++-- source/blender/editors/interface/interface.c | 2 +- source/blender/editors/interface/interface_view.cc | 2 +- source/blender/editors/sculpt_paint/paint_intern.h | 3 +-- .../editors/space_file/asset_catalog_tree_view.cc | 2 +- source/blender/editors/space_file/filelist.c | 2 +- source/blender/editors/space_file/filesel.c | 4 ++-- source/blender/editors/undo/memfile_undo.c | 2 +- .../gpencil_modifiers/intern/lineart/lineart_cpu.c | 6 +++--- source/blender/makesdna/DNA_effect_types.h | 2 +- source/blender/makesdna/DNA_outliner_types.h | 6 +++--- source/blender/makesdna/DNA_pointcache_types.h | 2 +- source/blender/makesdna/DNA_space_types.h | 2 +- .../modifiers/intern/MOD_solidify_nonmanifold.c | 2 +- source/blender/nodes/intern/derived_node_tree.cc | 2 +- source/blender/python/bmesh/bmesh_py_types.c | 4 ++-- source/blender/python/gpu/gpu_py_offscreen.c | 2 +- .../windowmanager/message_bus/wm_message_bus.h | 2 +- 32 files changed, 58 insertions(+), 59 deletions(-) (limited to 'source/blender') diff --git a/source/blender/blenkernel/BKE_blendfile_link_append.h b/source/blender/blenkernel/BKE_blendfile_link_append.h index 9e4a498f5e7..cda6a620326 100644 --- a/source/blender/blenkernel/BKE_blendfile_link_append.h +++ b/source/blender/blenkernel/BKE_blendfile_link_append.h @@ -72,13 +72,13 @@ short BKE_blendfile_link_append_context_item_idcode_get( struct BlendfileLinkAppendContext *lapp_context, struct BlendfileLinkAppendContextItem *item); typedef enum eBlendfileLinkAppendForeachItemFlag { - /** Loop over directly linked items (i.e. those explicitely defined by user code). */ + /** Loop over directly linked items (i.e. those explicitly defined by user code). */ BKE_BLENDFILE_LINK_APPEND_FOREACH_ITEM_FLAG_DO_DIRECT = 1 << 0, /** Loop over indirectly linked items (i.e. those defined by internal code, as dependencies of * direct ones). * - * IMPORTANT: Those 'indirect' items currently may not cover **all** indrectly linked data. See - * comments in #foreach_libblock_link_append_callback. */ + * IMPORTANT: Those 'indirect' items currently may not cover **all** indirectly linked data. + * See comments in #foreach_libblock_link_append_callback. */ BKE_BLENDFILE_LINK_APPEND_FOREACH_ITEM_FLAG_DO_INDIRECT = 1 << 0, } eBlendfileLinkAppendForeachItemFlag; /** Callback called by #BKE_blendfile_link_append_context_item_foreach over each (or a subset of diff --git a/source/blender/blenkernel/BKE_bpath.h b/source/blender/blenkernel/BKE_bpath.h index 984c7f609f6..338aec4ae4f 100644 --- a/source/blender/blenkernel/BKE_bpath.h +++ b/source/blender/blenkernel/BKE_bpath.h @@ -22,7 +22,7 @@ */ /* TODO: Make this module handle a bit more safely string length, instead of assuming buffers are - * FILE_MAX len etc. */ + * FILE_MAX length etc. */ #pragma once @@ -54,13 +54,13 @@ typedef enum eBPathForeachFlag { * `foreach_path` implementations and/or callbacks to implement specific behaviors. */ /** Skip paths where a single dir is used with an array of files, eg. sequence strip images or - * pointcaches. In this case only use the first file path is processed. + * point-caches. In this case only use the first file path is processed. * * This is needed for directory manipulation callbacks which might otherwise modify the same * directory multiple times. */ BKE_BPATH_FOREACH_PATH_SKIP_MULTIFILE = (1 << 8), /** Reload data (when the path is edited). - * \note Ony used by Image IDType currently. */ + * \note Only used by Image IDType currently. */ BKE_BPATH_FOREACH_PATH_RELOAD_EDITED = (1 << 9), } eBPathForeachFlag; @@ -76,7 +76,7 @@ typedef bool (*BPathForeachPathFunctionCallback)(struct BPathForeachPathData *bp char *r_path_dst, const char *path_src); -/** Storage for common data needed accross the BPath 'foreach_path' code. */ +/** Storage for common data needed across the BPath 'foreach_path' code. */ typedef struct BPathForeachPathData { struct Main *bmain; diff --git a/source/blender/blenkernel/BKE_modifier.h b/source/blender/blenkernel/BKE_modifier.h index 8be563e4c96..eca6bc38da6 100644 --- a/source/blender/blenkernel/BKE_modifier.h +++ b/source/blender/blenkernel/BKE_modifier.h @@ -98,7 +98,7 @@ typedef enum { eModifierTypeFlag_RequiresOriginalData = (1 << 5), /** - * For modifiers that support pointcache, + * For modifiers that support point-cache, * so we can check to see if it has files we need to deal with. */ eModifierTypeFlag_UsesPointCache = (1 << 6), diff --git a/source/blender/blenkernel/intern/blendfile_link_append.c b/source/blender/blenkernel/intern/blendfile_link_append.c index fb961dba482..17c44bbd5f5 100644 --- a/source/blender/blenkernel/intern/blendfile_link_append.c +++ b/source/blender/blenkernel/intern/blendfile_link_append.c @@ -18,8 +18,8 @@ * \ingroup bke * * High level `.blend` file link/append code, - * including linking/appending several IDs from different libraries, handling instanciations of - * collections/objects/obdata in current scene. + * including linking/appending several IDs from different libraries, handling instantiations of + * collections/objects/object-data in current scene. */ #include @@ -110,7 +110,7 @@ typedef struct BlendfileLinkAppendContext { LinkNodePair items; int num_libraries; int num_items; - /** Linking/appending parameters. Including bmain, scene, viewlayer and view3d. */ + /** Linking/appending parameters. Including `bmain`, `scene`, `viewlayer` and `view3d`. */ LibraryLink_Params *params; /** Allows to easily find an existing items from an ID pointer. */ @@ -245,7 +245,7 @@ void BKE_blendfile_link_append_context_embedded_blendfile_set( BlendfileLinkAppendContext *lapp_context, const void *blendfile_mem, int blendfile_memsize) { BLI_assert_msg(lapp_context->blendfile_mem == NULL, - "Please explicitely clear reference to an embedded blender memfile before " + "Please explicitly clear reference to an embedded blender memfile before " "setting a new one"); lapp_context->blendfile_mem = blendfile_mem; lapp_context->blendfile_memsize = (size_t)blendfile_memsize; @@ -530,7 +530,7 @@ static void loose_data_instantiate_object_base_instance_init(Main *bmain, } /* Tag obdata that actually need to be instantiated (those referenced by an object do not, since - * the object will be instantiated instaed if needed. */ + * the object will be instantiated instead if needed. */ static void loose_data_instantiate_obdata_preprocess( LooseDataInstantiateContext *instantiate_context) { @@ -854,7 +854,7 @@ static int foreach_libblock_link_append_callback(LibraryIDLinkCallbackData *cb_d * processed, so we need to recursively deal with them here. */ /* NOTE: Since we are by-passing checks in `BKE_library_foreach_ID_link` by manually calling it * recursively, we need to take care of potential recursion cases ourselves (e.g.animdata of - * shapekey referencing the shapekey itself). */ + * shape-key referencing the shape-key itself). */ if (id != cb_data->id_self) { BKE_library_foreach_ID_link( cb_data->bmain, id, foreach_libblock_link_append_callback, data, IDWALK_NOP); @@ -946,8 +946,8 @@ void BKE_blendfile_append(BlendfileLinkAppendContext *lapp_context, ReportList * /* Linked IDs should never be marked as needing post-processing (instantiation of loose * objects etc.). - * NOTE: This is dev test check, can be removed once we get rid of instantiation code in BLO - * completely.*/ + * NOTE: This is a developer test check, can be removed once we get rid of instantiation code + * in BLO completely.*/ BLI_assert((id->tag & LIB_TAG_DOIT) == 0); ID *existing_local_id = BKE_idtype_idcode_append_is_reusable(GS(id->name)) ? @@ -1206,8 +1206,8 @@ void BKE_blendfile_link(BlendfileLinkAppendContext *lapp_context, ReportList *re /* here appending/linking starts */ - /* NOTE: This is temporary hotfix until whole code using link/append features has been moved to - * use new BKE code. */ + /* NOTE: This is temporary hot-fix until whole code using link/append features has been moved + * to use new BKE code. */ /* Do not handle instantiation in linking process anymore, we do it here in * #loose_data_instantiate instead. */ lapp_context->params->flag &= ~BLO_LIBLINK_NEEDS_ID_TAG_DOIT; @@ -1271,8 +1271,8 @@ void BKE_blendfile_link(BlendfileLinkAppendContext *lapp_context, ReportList *re /* Linked IDs should never be marked as needing post-processing (instantiation of loose * objects etc.). - * NOTE: This is dev test check, can be removed once we get rid of instantiation code in BLO - * completely.*/ + * NOTE: This is developer test check, can be removed once we get rid of instantiation code + * in BLO completely.*/ BLI_assert((id->tag & LIB_TAG_DOIT) == 0); BlendfileLinkAppendContextCallBack cb_data = { diff --git a/source/blender/blenkernel/intern/image.c b/source/blender/blenkernel/intern/image.c index 295157abe9a..6fe415aedab 100644 --- a/source/blender/blenkernel/intern/image.c +++ b/source/blender/blenkernel/intern/image.c @@ -264,7 +264,7 @@ static void image_foreach_path(ID *id, BPathForeachPathData *bpath_data) /* Skip empty file paths, these are typically from generated images and * don't make sense to add directories to until the image has been saved * once to give it a meaningful value. */ - /* TODO re-assess whether this behavior is disired in the new generic code context. */ + /* TODO re-assess whether this behavior is desired in the new generic code context. */ if (!ELEM(ima->source, IMA_SRC_FILE, IMA_SRC_MOVIE, IMA_SRC_SEQUENCE, IMA_SRC_TILED) || ima->filepath[0] == '\0') { return; diff --git a/source/blender/blenkernel/intern/lib_id.c b/source/blender/blenkernel/intern/lib_id.c index 58c909d0cd6..c53fed4ba4c 100644 --- a/source/blender/blenkernel/intern/lib_id.c +++ b/source/blender/blenkernel/intern/lib_id.c @@ -1854,7 +1854,7 @@ bool BKE_id_new_name_validate(ListBase *lb, ID *id, const char *tname, const boo return result; } -/* next to indirect usage in read/writefile also in editobject.c scene.c */ +/* Next to indirect usage in `readfile.c/writefile.c` also in `editobject.c`, `scene.c`. */ void BKE_main_id_newptr_and_tag_clear(Main *bmain) { ID *id; diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c index 31e1ca464fc..f2ac6b7fd22 100644 --- a/source/blender/blenkernel/intern/scene.c +++ b/source/blender/blenkernel/intern/scene.c @@ -902,7 +902,7 @@ static bool seq_foreach_path_callback(Sequence *seq, void *user_data) BKE_bpath_foreach_path_dirfile_fixed_process(bpath_data, seq->strip->dir, se->name); } else if ((seq->type == SEQ_TYPE_IMAGE) && se) { - /* NOTE: An option not to loop over all strips could be usefull? */ + /* NOTE: An option not to loop over all strips could be useful? */ unsigned int len = (unsigned int)MEM_allocN_len(se) / (unsigned int)sizeof(*se); unsigned int i; diff --git a/source/blender/blenlib/BLI_virtual_array.hh b/source/blender/blenlib/BLI_virtual_array.hh index 96128fc5c32..5103ac4b668 100644 --- a/source/blender/blenlib/BLI_virtual_array.hh +++ b/source/blender/blenlib/BLI_virtual_array.hh @@ -578,7 +578,7 @@ template class VArrayCommon { /* Make sure we are actually constructing a #VArrayImpl. */ static_assert(std::is_base_of_v, ImplT>); if constexpr (std::is_copy_constructible_v && Storage::template is_inline_v) { - /* Only inline the implementatiton when it is copyable and when it fits into the inline + /* Only inline the implementation when it is copyable and when it fits into the inline * buffer of the storage. */ impl_ = &storage_.template emplace(std::forward(args)...); } diff --git a/source/blender/blenloader/BLO_undofile.h b/source/blender/blenloader/BLO_undofile.h index 4e240e2462b..b2cf1cd27b5 100644 --- a/source/blender/blenloader/BLO_undofile.h +++ b/source/blender/blenloader/BLO_undofile.h @@ -77,7 +77,7 @@ typedef struct { bool memchunk_identical; } UndoReader; -/* actually only used writefile.c */ +/* Actually only used `writefile.c`. */ void BLO_memfile_write_init(MemFileWriteData *mem_data, MemFile *written_memfile, diff --git a/source/blender/blenloader/BLO_writefile.h b/source/blender/blenloader/BLO_writefile.h index bac0119a368..57f5b5de1f0 100644 --- a/source/blender/blenloader/BLO_writefile.h +++ b/source/blender/blenloader/BLO_writefile.h @@ -21,7 +21,7 @@ /** \file * \ingroup blenloader - * \brief external writefile function prototypes. + * \brief external `writefile.c` function prototypes. */ #ifdef __cplusplus diff --git a/source/blender/blenloader/intern/versioning_300.c b/source/blender/blenloader/intern/versioning_300.c index 822ef2cda8d..068541a5825 100644 --- a/source/blender/blenloader/intern/versioning_300.c +++ b/source/blender/blenloader/intern/versioning_300.c @@ -2376,8 +2376,8 @@ void blo_do_versions_300(FileData *fd, Library *UNUSED(lib), Main *bmain) } } - /* Special case to handle older in-dev 3.1 files, before change from 3.0 branch gets merged in - * master. */ + /* Special case to handle older in-development 3.1 files, before change from 3.0 branch gets + * merged in master. */ if (!MAIN_VERSION_ATLEAST(bmain, 300, 42) || (bmain->versionfile == 301 && !MAIN_VERSION_ATLEAST(bmain, 301, 3))) { /* Update LibOverride operations regarding insertions in RNA collections (i.e. modifiers, diff --git a/source/blender/depsgraph/intern/node/deg_node.h b/source/blender/depsgraph/intern/node/deg_node.h index 6274066ba25..01d49640053 100644 --- a/source/blender/depsgraph/intern/node/deg_node.h +++ b/source/blender/depsgraph/intern/node/deg_node.h @@ -106,7 +106,7 @@ enum class NodeType { /* Component which is used to define visibility relation between IDs, on the ID level. * * Consider two ID nodes NodeA and NodeB, with the relation between visibility components going - * as NodeA -> NodeB. If NodeB is considreed visible on screen, then the relation will ensure + * as NodeA -> NodeB. If NodeB is considered visible on screen, then the relation will ensure * that NodeA is also visible. The way how relation is oriented could be seen as a inverted from * visibility dependency point of view, but it follows the same direction as data dependency * which simplifies common algorithms which are dealing with relations and visibility. diff --git a/source/blender/editors/asset/intern/asset_indexer.cc b/source/blender/editors/asset/intern/asset_indexer.cc index 43951b4b714..8472b33d3af 100644 --- a/source/blender/editors/asset/intern/asset_indexer.cc +++ b/source/blender/editors/asset/intern/asset_indexer.cc @@ -532,11 +532,11 @@ struct AssetIndex { const int UNKNOWN_VERSION = -1; /** - * `blender::io::serialize::Value` represeting the contents of an index file. + * `blender::io::serialize::Value` representing the contents of an index file. * - * Value is used over ObjectValue as the contents of the index could be corrupted and doesn't + * Value is used over #ObjectValue as the contents of the index could be corrupted and doesn't * represent an object. In case corrupted files are detected the `get_version` would return - * UNKNOWN_VERSION.` + * `UNKNOWN_VERSION`. */ std::unique_ptr contents; diff --git a/source/blender/editors/asset/intern/asset_ops.cc b/source/blender/editors/asset/intern/asset_ops.cc index f182dcc1ad0..6e81908c24e 100644 --- a/source/blender/editors/asset/intern/asset_ops.cc +++ b/source/blender/editors/asset/intern/asset_ops.cc @@ -907,7 +907,7 @@ static bool has_external_files(Main *bmain, struct ReportList *reports) eBPathForeachFlag flag = static_cast( BKE_BPATH_FOREACH_PATH_SKIP_PACKED /* Packed files are fine. */ - | BKE_BPATH_FOREACH_PATH_SKIP_MULTIFILE); /* Only report multifiles once, it's enough. */ + | BKE_BPATH_FOREACH_PATH_SKIP_MULTIFILE); /* Only report multi-files once, it's enough. */ BPathForeachPathData bpath_data = { /* bmain */ bmain, diff --git a/source/blender/editors/include/ED_file_indexer.h b/source/blender/editors/include/ED_file_indexer.h index 12579283a62..0afa8819def 100644 --- a/source/blender/editors/include/ED_file_indexer.h +++ b/source/blender/editors/include/ED_file_indexer.h @@ -50,7 +50,7 @@ typedef enum eFileIndexerResult { FILE_INDEXER_ENTRIES_LOADED, /** - * Index isn't available or not upto date. Entries should be read from te blend file and + * Index isn't available or not up to date. Entries should be read from the blend file and * `update_index` must be called to update the index. */ FILE_INDEXER_NEEDS_UPDATE, @@ -103,7 +103,7 @@ typedef struct FileIndexerType { * Is called at the end of the file listing process (before the `free_user_data`) where indexes * can perform clean-ups. * - * This is an optinal callback. Called when listing files completed. + * This is an optional callback. Called when listing files completed. */ FileIndexerFinishedFunc filelist_finished; diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c index b9f68d8d83c..f1c207d7326 100644 --- a/source/blender/editors/interface/interface.c +++ b/source/blender/editors/interface/interface.c @@ -25,7 +25,7 @@ #include #include #include -#include /* offsetof() */ +#include /* `offsetof()` */ #include #include "MEM_guardedalloc.h" diff --git a/source/blender/editors/interface/interface_view.cc b/source/blender/editors/interface/interface_view.cc index 4e38f245155..0f0d1b1308e 100644 --- a/source/blender/editors/interface/interface_view.cc +++ b/source/blender/editors/interface/interface_view.cc @@ -46,7 +46,7 @@ struct ViewLink : public Link { using TreeViewPtr = std::unique_ptr; std::string idname; - /* Note: Can't use std::get() on this until minimum macOS deployment target is 10.14. */ + /* NOTE: Can't use std::get() on this until minimum macOS deployment target is 10.14. */ std::variant view; }; diff --git a/source/blender/editors/sculpt_paint/paint_intern.h b/source/blender/editors/sculpt_paint/paint_intern.h index 62320defbb3..30314742958 100644 --- a/source/blender/editors/sculpt_paint/paint_intern.h +++ b/source/blender/editors/sculpt_paint/paint_intern.h @@ -265,7 +265,7 @@ typedef struct CurveMaskCache { int last_curve_timestamp; /** - * \brief sampled version of the brush curvemapping. + * \brief sampled version of the brush curve-mapping. */ float *sampled_curve; @@ -414,4 +414,3 @@ void paint_delete_blur_kernel(BlurKernel *); #ifdef __cplusplus } #endif - diff --git a/source/blender/editors/space_file/asset_catalog_tree_view.cc b/source/blender/editors/space_file/asset_catalog_tree_view.cc index 39ea43264f5..1b1517b7289 100644 --- a/source/blender/editors/space_file/asset_catalog_tree_view.cc +++ b/source/blender/editors/space_file/asset_catalog_tree_view.cc @@ -376,7 +376,7 @@ bool AssetCatalogDropController::can_drop(const wmDrag &drag, const char **r_dis { if (drag.type == WM_DRAG_ASSET_CATALOG) { const AssetCatalog *drag_catalog = get_drag_catalog(drag, get_asset_library()); - /* Note: Technically it's not an issue to allow this (the catalog will just receive a new + /* NOTE: Technically it's not an issue to allow this (the catalog will just receive a new * path and the catalog system will generate missing parents from the path). But it does * appear broken to users, so disabling entirely. */ if (catalog_item_.catalog_path().is_contained_in(drag_catalog->path)) { diff --git a/source/blender/editors/space_file/filelist.c b/source/blender/editors/space_file/filelist.c index 3e48c2a5d87..6593894d9a6 100644 --- a/source/blender/editors/space_file/filelist.c +++ b/source/blender/editors/space_file/filelist.c @@ -3255,7 +3255,7 @@ static int filelist_readjob_list_lib(const char *root, /* Try read from indexer_runtime. */ /* Indexing returns all entries in a blend file. We should ignore the index when listing a group * inside a blend file, so the `entries` isn't filled with undesired entries. - * This happens when linking or appending data-blocks, where you can navigate into a group (fe + * This happens when linking or appending data-blocks, where you can navigate into a group (ie * Materials/Objects) where you only want to work with partial indexes. * * Adding support for partial reading/updating indexes would increase the complexity. diff --git a/source/blender/editors/space_file/filesel.c b/source/blender/editors/space_file/filesel.c index 37b1d3825d4..8d89fbbd80f 100644 --- a/source/blender/editors/space_file/filesel.c +++ b/source/blender/editors/space_file/filesel.c @@ -1385,8 +1385,8 @@ void file_params_renamefile_activate(SpaceFile *sfile, FileSelectParams *params) params->rename_flag = FILE_PARAMS_RENAME_ACTIVE; } else if ((params->rename_flag & FILE_PARAMS_RENAME_POSTSCROLL_PENDING) != 0) { - /* file_select_deselect_all() will resort and refilter, so idx will probably have changed. - * Need to get the correct FileDirEntry again. */ + /* file_select_deselect_all() will resort and re-filter, so `idx` will probably have changed. + * Need to get the correct #FileDirEntry again. */ file_select_deselect_all(sfile, FILE_SEL_SELECTED); idx = file_params_find_renamed(params, sfile->files); file = filelist_file(sfile->files, idx); diff --git a/source/blender/editors/undo/memfile_undo.c b/source/blender/editors/undo/memfile_undo.c index ee7221bd2a8..ad3b4162f89 100644 --- a/source/blender/editors/undo/memfile_undo.c +++ b/source/blender/editors/undo/memfile_undo.c @@ -147,7 +147,7 @@ static int memfile_undosys_step_id_reused_cb(LibraryIDLinkCallbackData *cb_data) /** * ID previews may be generated in a parallel job. So whatever operation generates the preview * likely does the undo push before the preview is actually done and stored in the ID. Hence they - * get some extra treatement here: + * get some extra treatment here: * When undoing back to the moment the preview generation was triggered, this function schedules * the preview for regeneration. */ diff --git a/source/blender/gpencil_modifiers/intern/lineart/lineart_cpu.c b/source/blender/gpencil_modifiers/intern/lineart/lineart_cpu.c index 3773af70498..1b31d672e3b 100644 --- a/source/blender/gpencil_modifiers/intern/lineart/lineart_cpu.c +++ b/source/blender/gpencil_modifiers/intern/lineart/lineart_cpu.c @@ -2332,9 +2332,9 @@ static bool lineart_edge_from_triangle(const LineartTriangle *tri, * if returns true, then from/to will carry the occluded segments * in ratio from `e->v1` to `e->v2`. The line is later cut with these two values. * - * TODO: (Yiming) This function uses a convoluted method that needs to be redesigned. + * TODO(@Yiming): This function uses a convoluted method that needs to be redesigned. * - * 1) The lineart_intersect_seg_seg() and lineart_point_triangle_relation() are separate calls, + * 1) The #lineart_intersect_seg_seg() and #lineart_point_triangle_relation() are separate calls, * which would potentially return results that doesn't agree, especially when it's an edge * extruding from one of the triangle's point. To get the information using one math process can * solve this problem. @@ -2346,7 +2346,7 @@ static bool lineart_edge_from_triangle(const LineartTriangle *tri, * I keep this function as-is because it's still fast, and more importantly the output value * threshold is already in tune with the cutting function in the next stage. * While current "edge aligned" fix isn't ideal, it does solve most of the precision issue - * especially in ortho camera mode. + * especially in orthographic camera mode. */ static bool lineart_triangle_edge_image_space_occlusion(SpinLock *UNUSED(spl), const LineartTriangle *tri, diff --git a/source/blender/makesdna/DNA_effect_types.h b/source/blender/makesdna/DNA_effect_types.h index 3de13169616..2e086a2834c 100644 --- a/source/blender/makesdna/DNA_effect_types.h +++ b/source/blender/makesdna/DNA_effect_types.h @@ -27,7 +27,7 @@ extern "C" { #endif -/* Don't forget, new effects also in writefile.c for DNA! */ +/* Don't forget, new effects also in `writefile.c` for DNA! */ #define PAF_MAXMULT 4 diff --git a/source/blender/makesdna/DNA_outliner_types.h b/source/blender/makesdna/DNA_outliner_types.h index ebf3d4a248c..a50d0524998 100644 --- a/source/blender/makesdna/DNA_outliner_types.h +++ b/source/blender/makesdna/DNA_outliner_types.h @@ -41,13 +41,13 @@ typedef struct TreeStoreElem { /** Used only to store data in blend files. */ typedef struct TreeStore { - /** Was previously used for memory preallocation. */ + /** Was previously used for memory pre-allocation. */ int totelem DNA_DEPRECATED; /** Number of elements in data array. */ int usedelem; /** - * Elements to be packed from mempool in writefile.c - * or extracted to mempool in readfile.c + * Elements to be packed from mempool in `writefile.c` + * or extracted to mempool in `readfile.c`. */ TreeStoreElem *data; } TreeStore; diff --git a/source/blender/makesdna/DNA_pointcache_types.h b/source/blender/makesdna/DNA_pointcache_types.h index 7de0bb29c46..2b6e1c4f7de 100644 --- a/source/blender/makesdna/DNA_pointcache_types.h +++ b/source/blender/makesdna/DNA_pointcache_types.h @@ -131,8 +131,8 @@ typedef struct PointCache { void (*free_edit)(struct PTCacheEdit *edit); } PointCache; +/** #PointCache.flag */ enum { - /* pointcache->flag */ PTCACHE_BAKED = 1 << 0, PTCACHE_OUTDATED = 1 << 1, PTCACHE_SIMULATION_VALID = 1 << 2, diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index 88c5ace9cb3..b4d373a5868 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -281,7 +281,7 @@ typedef struct SpaceOutliner { * Note that treestore may contain duplicate elements if element * is used multiple times in outliner tree (e. g. linked objects) * Also note that BLI_mempool can not be read/written in DNA directly, - * therefore readfile.c/writefile.c linearize treestore into TreeStore structure + * therefore `readfile.c/writefile.c` linearize treestore into TreeStore structure */ struct BLI_mempool *treestore; diff --git a/source/blender/modifiers/intern/MOD_solidify_nonmanifold.c b/source/blender/modifiers/intern/MOD_solidify_nonmanifold.c index 0cc1627afcd..997f5943060 100644 --- a/source/blender/modifiers/intern/MOD_solidify_nonmanifold.c +++ b/source/blender/modifiers/intern/MOD_solidify_nonmanifold.c @@ -186,7 +186,7 @@ Mesh *MOD_solidify_nonmanifold_modifyMesh(ModifierData *md, const float offset = fabsf(smd->offset) * smd->offset_clamp; const bool do_angle_clamp = smd->flag & MOD_SOLIDIFY_OFFSET_ANGLE_CLAMP; /* #do_flip, flips the normals of the result. This is inverted if negative thickness - * is used, since simple soldify with negative thickness keeps the faces facing outside. */ + * is used, since simple solidify with negative thickness keeps the faces facing outside. */ const bool do_flip = ((smd->flag & MOD_SOLIDIFY_FLIP) != 0) == (smd->offset > 0); const bool do_rim = smd->flag & MOD_SOLIDIFY_RIM; const bool do_shell = ((smd->flag & MOD_SOLIDIFY_RIM) && (smd->flag & MOD_SOLIDIFY_NOSHELL)) == diff --git a/source/blender/nodes/intern/derived_node_tree.cc b/source/blender/nodes/intern/derived_node_tree.cc index 8a9386c1137..b47b201cd8c 100644 --- a/source/blender/nodes/intern/derived_node_tree.cc +++ b/source/blender/nodes/intern/derived_node_tree.cc @@ -168,7 +168,7 @@ DInputSocket DOutputSocket::get_active_corresponding_group_output_socket() const const DTreeContext *child_context = context_->child_context(socket_ref_->node()); if (child_context == nullptr) { - /* Can happen when the group node references a non-existant group (e.g. when the group is + /* Can happen when the group node references a non-existent group (e.g. when the group is * linked but the original file is not found). */ return {}; } diff --git a/source/blender/python/bmesh/bmesh_py_types.c b/source/blender/python/bmesh/bmesh_py_types.c index cbebe4746e9..3dd8e58781e 100644 --- a/source/blender/python/bmesh/bmesh_py_types.c +++ b/source/blender/python/bmesh/bmesh_py_types.c @@ -3349,8 +3349,8 @@ static PyObject *bpy_bmiter_next(BPy_BMIter *self) return (PyObject *)BPy_BMElem_CreatePyObject(self->bm, ele); } -/* Dealloc Functions - * ================= */ +/* Deallocate Functions + * ==================== */ static void bpy_bmesh_dealloc(BPy_BMesh *self) { diff --git a/source/blender/python/gpu/gpu_py_offscreen.c b/source/blender/python/gpu/gpu_py_offscreen.c index 24192780a86..48fbe09f0ce 100644 --- a/source/blender/python/gpu/gpu_py_offscreen.c +++ b/source/blender/python/gpu/gpu_py_offscreen.c @@ -356,7 +356,7 @@ static PyObject *pygpu_offscreen_draw_view3d(BPyGPUOffScreen *self, PyObject *ar GPU_offscreen_bind(self->ofs, true); - /* Cache the GPUViewport so the framebuffers and associated textures are + /* Cache the #GPUViewport so the frame-buffers and associated textures are * not reallocated each time, see: T89204 */ if (!self->viewport) { self->viewport = GPU_viewport_create(); diff --git a/source/blender/windowmanager/message_bus/wm_message_bus.h b/source/blender/windowmanager/message_bus/wm_message_bus.h index 7ae356cf806..f923947c883 100644 --- a/source/blender/windowmanager/message_bus/wm_message_bus.h +++ b/source/blender/windowmanager/message_bus/wm_message_bus.h @@ -79,7 +79,7 @@ typedef struct wmMsg { } wmMsg; typedef struct wmMsgSubscribeKey { - /** Linked list for predicable ordering, otherwise we would depend on ghash bucketing. */ + /** Linked list for predicable ordering, otherwise we would depend on #GHash bucketing. */ struct wmMsgSubscribeKey *next, *prev; ListBase values; /* over-alloc, eg: wmMsgSubscribeKey_RNA */ -- cgit v1.2.3