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.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.h')
-rw-r--r-- | source/blender/blenkernel/BKE_main.h | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/source/blender/blenkernel/BKE_main.h b/source/blender/blenkernel/BKE_main.h index 744c58401a6..66cbe6d838f 100644 --- a/source/blender/blenkernel/BKE_main.h +++ b/source/blender/blenkernel/BKE_main.h @@ -22,13 +22,20 @@ /** \file * \ingroup bke * \section aboutmain Main struct - * Main is the root of the 'database' of a Blender context. All data - * is stuffed into lists, and all these lists are knotted to here. A - * Blender file is not much more but a binary dump of these - * lists. This list of lists is not serialized itself. + * Main is the root of the 'data-base' of a Blender context. All data is put into lists, and all + * these lists are stored here. * - * Oops... this should be a _types.h file. + * \note A Blender file is not much more than a binary dump of these lists. This list of lists is + * not serialized itself. + * + * \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_` should be used for functions in that file. */ + #include "DNA_listBase.h" #include "BLI_compiler_attrs.h" |