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_main_idmap.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_main_idmap.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_main_idmap.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/source/blender/blenkernel/BKE_main_idmap.h b/source/blender/blenkernel/BKE_main_idmap.h index d95f32b162a..b411d34be47 100644 --- a/source/blender/blenkernel/BKE_main_idmap.h +++ b/source/blender/blenkernel/BKE_main_idmap.h @@ -18,6 +18,16 @@ /** \file * \ingroup bke + * + * API to generate and use a mapping from [ID type & name] to [id pointer], within a given Main + * data-base. + * + * \note `BKE_main` files are for operations over the Main database itself, or generating extra + * temp data to help working with it. Those should typically not affect the data-blocks themselves. + * + * \section Function Names + * + * - `BKE_main_idmap_` Should be used for functions in that file. */ #include "BLI_compiler_attrs.h" |