diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-07-03 16:08:40 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-07-03 17:43:40 +0300 |
commit | 9b89de2571b0c3fa2276b5c2ae589e0ec831d1f5 (patch) | |
tree | 63f1007a5262b4d6f1c1a96734c521d836eb6fc6 /source/blender/blenloader/intern | |
parent | 05f970847e12ce30e8c4c624677d94ae239ce2bc (diff) |
Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX
Also use doxy style function reference `#` prefix chars when
referencing identifiers.
Diffstat (limited to 'source/blender/blenloader/intern')
-rw-r--r-- | source/blender/blenloader/intern/readfile.c | 12 | ||||
-rw-r--r-- | source/blender/blenloader/intern/undofile.c | 2 | ||||
-rw-r--r-- | source/blender/blenloader/intern/versioning_250.c | 2 | ||||
-rw-r--r-- | source/blender/blenloader/intern/versioning_260.c | 6 | ||||
-rw-r--r-- | source/blender/blenloader/intern/versioning_280.c | 2 | ||||
-rw-r--r-- | source/blender/blenloader/intern/versioning_legacy.c | 6 | ||||
-rw-r--r-- | source/blender/blenloader/intern/writefile.c | 7 |
7 files changed, 19 insertions, 18 deletions
diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c index 5b668bf12eb..03fb4149d7b 100644 --- a/source/blender/blenloader/intern/readfile.c +++ b/source/blender/blenloader/intern/readfile.c @@ -2311,7 +2311,7 @@ static void lib_link_id_embedded_id(BlendLibReader *reader, ID *id) static void lib_link_id(BlendLibReader *reader, ID *id) { - /* Note: WM IDProperties are never written to file, hence they should always be NULL here. */ + /* NOTE: WM IDProperties are never written to file, hence they should always be NULL here. */ BLI_assert((GS(id->name) != ID_WM) || id->properties == NULL); IDP_BlendReadLib(reader, id->properties); @@ -2728,7 +2728,7 @@ static int lib_link_main_data_restore_cb(LibraryIDLinkCallbackData *cb_data) struct IDNameLib_Map *id_map = cb_data->user_data; - /* Note: Handling of usercount here is really bad, defining its own system... + /* NOTE: Handling of usercount here is really bad, defining its own system... * Will have to be refactored at some point, but that is not top priority task for now. * And all user-counts are properly recomputed at the end of the undo management code anyway. */ *id_pointer = restore_pointer_by_name( @@ -3067,7 +3067,7 @@ void blo_lib_link_restore(Main *oldmain, /* keep cursor location through undo */ memcpy(&win->scene->cursor, &oldscene->cursor, sizeof(win->scene->cursor)); - /* Note: even though that function seems to redo part of what is done by + /* NOTE: even though that function seems to redo part of what is done by * `lib_link_workspace_layout_restore()` above, it seems to have a slightly different scope: * while the former updates the whole UI pointers from Main db (going over all layouts of * all workspaces), that one only focuses one current active screen, takes care of @@ -3780,7 +3780,7 @@ BHead *blo_read_asset_data_block(FileData *fd, BHead *bhead, AssetMetaData **r_a /** \name Read Global Data * \{ */ -/* note, this has to be kept for reading older files... */ +/* NOTE: this has to be kept for reading older files... */ /* also version info is written here */ static BHead *read_global(BlendFileData *bfd, FileData *fd, BHead *bhead) { @@ -3828,7 +3828,7 @@ static BHead *read_global(BlendFileData *bfd, FileData *fd, BHead *bhead) return blo_bhead_next(fd, bhead); } -/* note, this has to be kept for reading older files... */ +/* NOTE: this has to be kept for reading older files... */ static void link_global(FileData *fd, BlendFileData *bfd) { bfd->cur_view_layer = blo_read_get_new_globaldata_address(fd, bfd->cur_view_layer); @@ -5611,7 +5611,7 @@ static void read_libraries(FileData *basefd, ListBase *mainlist) lib_link_all(mainptr->curlib->filedata, mainptr); } - /* Note: No need to call #do_versions_after_linking() or #BKE_main_id_refcount_recompute() + /* NOTE: No need to call #do_versions_after_linking() or #BKE_main_id_refcount_recompute() * here, as this function is only called for library 'subset' data handling, as part of * either full blendfile reading (#blo_read_file_internal()), or library-data linking * (#library_link_end()). */ diff --git a/source/blender/blenloader/intern/undofile.c b/source/blender/blenloader/intern/undofile.c index d1f69d35fe5..2eeeac2e8d7 100644 --- a/source/blender/blenloader/intern/undofile.c +++ b/source/blender/blenloader/intern/undofile.c @@ -225,7 +225,7 @@ bool BLO_memfile_write_file(struct MemFile *memfile, const char *filename) MemFileChunk *chunk; int file, oflags; - /* note: This is currently used for autosave and 'quit.blend', + /* NOTE: This is currently used for autosave and 'quit.blend', * where _not_ following symlinks is OK, * however if this is ever executed explicitly by the user, * we may want to allow writing to symlinks. diff --git a/source/blender/blenloader/intern/versioning_250.c b/source/blender/blenloader/intern/versioning_250.c index 9399af5eb11..8a7bc375ea9 100644 --- a/source/blender/blenloader/intern/versioning_250.c +++ b/source/blender/blenloader/intern/versioning_250.c @@ -1274,7 +1274,7 @@ void blo_do_versions_250(FileData *fd, Library *lib, Main *bmain) */ if (ob->pose && ob->data) { bArmature *arm = blo_do_versions_newlibadr(fd, lib, ob->data); - if (arm) { /* XXX - why does this fail in some cases? */ + if (arm) { /* XXX: why does this fail in some cases? */ bAnimVizSettings *avs = &ob->pose->avs; /* path settings --------------------- */ diff --git a/source/blender/blenloader/intern/versioning_260.c b/source/blender/blenloader/intern/versioning_260.c index 070dd181509..5bf4d3b68b5 100644 --- a/source/blender/blenloader/intern/versioning_260.c +++ b/source/blender/blenloader/intern/versioning_260.c @@ -169,7 +169,7 @@ static void do_versions_image_settings_2_60(Scene *sce) R_JPEG2K_CINE_48FPS = (1 << 9), }; - /* note: rd->subimtype is moved into individual settings now and no longer + /* NOTE: rd->subimtype is moved into individual settings now and no longer * exists */ RenderData *rd = &sce->r; ImageFormatData *imf = &sce->r.im_format; @@ -2594,11 +2594,11 @@ void do_versions_after_linking_260(Main *bmain) * * This assumes valid typeinfo pointers, as set in lib_link_ntree. * - * Note: theoretically only needed in node groups (main->nodetree), + * NOTE: theoretically only needed in node groups (main->nodetree), * but due to a temporary bug such links could have been added in all trees, * so have to clean up all of them ... * - * Note: this always runs, without it links with NULL fromnode and tonode remain + * NOTE: this always runs, without it links with NULL fromnode and tonode remain * which causes problems. */ if (!MAIN_VERSION_ATLEAST(bmain, 266, 3)) { diff --git a/source/blender/blenloader/intern/versioning_280.c b/source/blender/blenloader/intern/versioning_280.c index 399761ead8d..82c4709f187 100644 --- a/source/blender/blenloader/intern/versioning_280.c +++ b/source/blender/blenloader/intern/versioning_280.c @@ -1268,7 +1268,7 @@ void do_versions_after_linking_280(Main *bmain, ReportList *UNUSED(reports)) /* We need to assign lib pointer to generated hidden collections *after* all have been * created, otherwise we'll end up with several data-blocks sharing same name/library, - * which is FORBIDDEN! Note: we need this to be recursive, since a child collection may be + * which is FORBIDDEN! NOTE: we need this to be recursive, since a child collection may be * sorted before its parent in bmain. */ for (Collection *collection = bmain->collections.first; collection != NULL; collection = collection->id.next) { diff --git a/source/blender/blenloader/intern/versioning_legacy.c b/source/blender/blenloader/intern/versioning_legacy.c index 46e25251fd4..95cfc9975d7 100644 --- a/source/blender/blenloader/intern/versioning_legacy.c +++ b/source/blender/blenloader/intern/versioning_legacy.c @@ -1311,7 +1311,7 @@ void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain) } } - /* Note: #BKE_pose_rebuild is further only called on leave edit-mode. */ + /* NOTE: #BKE_pose_rebuild is further only called on leave edit-mode. */ if (ob->type == OB_ARMATURE) { if (ob->pose) { BKE_pose_tag_recalc(bmain, ob->pose); @@ -1436,7 +1436,7 @@ void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain) bPoseChannel *pchan; bConstraint *con; for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) { - /* note, pchan->bone is also lib-link stuff */ + /* NOTE: pchan->bone is also lib-link stuff. */ if (pchan->limitmin[0] == 0.0f && pchan->limitmax[0] == 0.0f) { pchan->limitmin[0] = pchan->limitmin[1] = pchan->limitmin[2] = -180.0f; pchan->limitmax[0] = pchan->limitmax[1] = pchan->limitmax[2] = 180.0f; @@ -2501,7 +2501,7 @@ void blo_do_versions_pre250(FileData *fd, Library *lib, Main *bmain) if (!MAIN_VERSION_ATLEAST(bmain, 248, 2)) { Scene *sce; - /* Note, these will need to be added for painting */ + /* NOTE: these will need to be added for painting. */ for (sce = bmain->scenes.first; sce; sce = sce->id.next) { sce->toolsettings->imapaint.seam_bleed = 2; sce->toolsettings->imapaint.normal_angle = 80; diff --git a/source/blender/blenloader/intern/writefile.c b/source/blender/blenloader/intern/writefile.c index 930ce0ba06f..4802c495ef2 100644 --- a/source/blender/blenloader/intern/writefile.c +++ b/source/blender/blenloader/intern/writefile.c @@ -896,9 +896,10 @@ static void write_global(WriteData *wd, int fileflags, Main *mainvar) writestruct(wd, GLOB, FileGlobal, 1, &fg); } -/* preview image, first 2 values are width and height - * second are an RGBA image (uchar) - * note, this uses 'TEST' since new types will segfault on file load for older blender versions. +/** + * Preview image, first 2 values are width and height + * second are an RGBA image (uchar). + * \note this uses 'TEST' since new types will segfault on file load for older blender versions. */ static void write_thumb(WriteData *wd, const BlendThumbnail *thumb) { |