diff options
| author | Bastien Montagne <b.mont29@gmail.com> | 2020-02-10 17:05:54 +0300 |
|---|---|---|
| committer | Bastien Montagne <b.mont29@gmail.com> | 2020-02-10 17:05:54 +0300 |
| commit | cd48b132ffafc80347a668b3c1cf295abf399f10 (patch) | |
| tree | 05c64c6f130e07c3ac91281b120227a01c29f6e7 /source/blender/blenkernel/BKE_lib_remap.h | |
| parent | de09db6b4d132bddbd7c322c8853deeea38131a4 (diff) | |
Cleanup: Add basic doc about each `BKE_main` and `BKE_lib` files.
Including expected prefixes for functions in those files.
Part of T72604.
Diffstat (limited to 'source/blender/blenkernel/BKE_lib_remap.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_lib_remap.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/source/blender/blenkernel/BKE_lib_remap.h b/source/blender/blenkernel/BKE_lib_remap.h index 18480e7052b..0f39060f2f9 100644 --- a/source/blender/blenkernel/BKE_lib_remap.h +++ b/source/blender/blenkernel/BKE_lib_remap.h @@ -18,7 +18,21 @@ /** \file * \ingroup bke + * + * API to perform remapping from one data-block pointer to another. + * + * \note `BKE_lib_` files are for operations over data-blocks themselves, although they might + * alter Main as well (when creating/renaming/deleting an ID e.g.). + * + * \section Function Names + * + * \warning Descriptions below is ideal goal, current status of naming does not yet fully follow it + * (this is WIP). + * + * - `BKE_lib_remap_libblock_` should be used for functions performing remapping. + * - `BKE_lib_remap_callback_` should be used for functions managing remapping callbacks. */ + #ifdef __cplusplus extern "C" { #endif |