diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-02-18 10:19:41 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-02-18 10:21:08 +0300 |
commit | c83099e987816ba87105cc997ac667d21897d52b (patch) | |
tree | bdfdbdf7ec6619ca7a85c75e26689d6237280ecc /source/blender/blenkernel/intern/bpath.c | |
parent | d0c159ae974596652296bb89fa7cf72f12801d66 (diff) |
Cleanup: use doxy sections for BLI_bpath API
Diffstat (limited to 'source/blender/blenkernel/intern/bpath.c')
-rw-r--r-- | source/blender/blenkernel/intern/bpath.c | 52 |
1 files changed, 45 insertions, 7 deletions
diff --git a/source/blender/blenkernel/intern/bpath.c b/source/blender/blenkernel/intern/bpath.c index 3743a340a53..9bfa604a597 100644 --- a/source/blender/blenkernel/intern/bpath.c +++ b/source/blender/blenkernel/intern/bpath.c @@ -84,6 +84,10 @@ static CLG_LogRef LOG = {"bke.bpath"}; +/* -------------------------------------------------------------------- */ +/** \name Check Missing Files + * \{ */ + static bool checkMissingFiles_visit_cb(void *userdata, char *UNUSED(path_dst), const char *path_src) @@ -106,6 +110,12 @@ void BKE_bpath_missing_files_check(Main *bmain, ReportList *reports) reports); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Make Paths Relative + * \{ */ + typedef struct BPathRemap_Data { const char *basedir; ReportList *reports; @@ -161,6 +171,12 @@ void BKE_bpath_relative_convert(Main *bmain, const char *basedir, ReportList *re data.count_failed); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Make Paths Absolute + * \{ */ + static bool bpath_absolute_convert_visit_cb(void *userdata, char *path_dst, const char *path_src) { BPathRemap_Data *data = (BPathRemap_Data *)userdata; @@ -208,6 +224,12 @@ void BKE_bpath_absolute_convert(Main *bmain, const char *basedir, ReportList *re data.count_failed); } +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Find Missing Files + * \{ */ + /** * find this file recursively, use the biggest file so thumbnails don't get used by mistake * \param filename_new: the path will be copied here, caller must initialize as empty string. @@ -350,7 +372,15 @@ void BKE_bpath_missing_files_find(Main *bmain, BKE_bpath_traverse_main(bmain, missing_files_find__visit_cb, flag, (void *)&data); } -/* Run a visitor on a string, replacing the contents of the string as needed. */ +/** \} */ + +/* -------------------------------------------------------------------- */ +/** \name Generic File Path Traversal API + * \{ */ + +/** + * Run a visitor on a string, replacing the contents of the string as needed. + */ static bool rewrite_path_fixed(char *path, BPathVisitor visit_cb, const char *absbase, @@ -436,7 +466,9 @@ static bool rewrite_path_alloc(char **path, } } -/* Run visitor function 'visit' on all paths contained in 'id'. */ +/** + * Run visitor function 'visit' on all paths contained in 'id'. + */ void BKE_bpath_traverse_id( Main *bmain, ID *id, BPathVisitor visit_cb, const int flag, void *bpath_user_data) { @@ -683,8 +715,10 @@ void BKE_bpath_traverse_main(Main *bmain, } } -/* Rewrites a relative path to be relative to the main file - unless the path is - * absolute, in which case it is not altered. */ +/** + * Rewrites a relative path to be relative to the main file - unless the path is + * absolute, in which case it is not altered. + */ bool BKE_bpath_relocate_visitor(void *pathbase_v, char *path_dst, const char *path_src) { /* be sure there is low chance of the path being too short */ @@ -715,11 +749,13 @@ bool BKE_bpath_relocate_visitor(void *pathbase_v, char *path_dst, const char *pa } } +/** \} */ + /* -------------------------------------------------------------------- */ -/** - * Backup/Restore/Free functions, +/** \name Backup/Restore/Free functions, + * * \note These functions assume the data won't change order. - */ + * \{ */ struct PathStore { struct PathStore *next, *prev; @@ -783,3 +819,5 @@ void BKE_bpath_list_free(void *ls_handle) BLI_freelistN(ls); MEM_freeN(ls); } + +/** \} */ |