diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2015-05-20 05:54:45 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2015-05-20 07:12:22 +0300 |
| commit | 5d30c23c35aafba3a9bc772b4e66dd70b1ed84de (patch) | |
| tree | 0657f4c3878153e715d8bbc3cda20734655498ca /intern/memutil/MEM_CacheLimiter.h | |
| parent | 922d5ed939139d578d4f9fdc55e891e0a23f7709 (diff) | |
doxygen: corrections/updates
Also add depsgraph & physics
Diffstat (limited to 'intern/memutil/MEM_CacheLimiter.h')
| -rw-r--r-- | intern/memutil/MEM_CacheLimiter.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/intern/memutil/MEM_CacheLimiter.h b/intern/memutil/MEM_CacheLimiter.h index 3e8ae7e5a4d..d5a44375885 100644 --- a/intern/memutil/MEM_CacheLimiter.h +++ b/intern/memutil/MEM_CacheLimiter.h @@ -29,20 +29,22 @@ #define __MEM_CACHELIMITER_H__ /** - * @section MEM_CacheLimiter + * \section MEM_CacheLimiter * This class defines a generic memory cache management system * to limit memory usage to a fixed global maximum. * - * Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C. + * \note Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C. * * Usage example: * + * \code{.cpp} * class BigFatImage { * public: * ~BigFatImage() { tell_everyone_we_are_gone(this); } * }; * - * void doit() { + * void doit() + * { * MEM_Cache<BigFatImage> BigFatImages; * * MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage); @@ -50,11 +52,12 @@ * BigFatImages.enforce_limits(); * h->ref(); * - * work with image... + * // work with image... * * h->unref(); * - * leave image in cache. + * // leave image in cache. + * \endcode */ #include <list> |