diff options
| author | Olle Johansson <oej@edvina.net> | 2006-11-27 06:59:20 +0000 |
|---|---|---|
| committer | Olle Johansson <oej@edvina.net> | 2006-11-27 06:59:20 +0000 |
| commit | b9d57e8e3ad400b6909e82e57330f3da36eabda2 (patch) | |
| tree | b443be86899998c6d7639f252504a4edec21ab87 /include/asterisk/threadstorage.h | |
| parent | 42fb13417141ba983c83965b51fa803f20e6a1cc (diff) | |
Doxygen updates
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48033 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/threadstorage.h')
| -rw-r--r-- | include/asterisk/threadstorage.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/include/asterisk/threadstorage.h b/include/asterisk/threadstorage.h index 4886d3520..25bc24b71 100644 --- a/include/asterisk/threadstorage.h +++ b/include/asterisk/threadstorage.h @@ -19,8 +19,12 @@ /*! * \file threadstorage.h * \author Russell Bryant <russell@digium.com> - * * \brief Definitions to aid in the use of thread local storage + */ + +/*! + * \page AstThreadStorage The Asterisk Thread Storage API + * * * The POSIX threads (pthreads) API provides the ability to define thread * specific data. The functions and structures defined here are intended @@ -34,6 +38,8 @@ * 200 times a second). Instead of doing the equivalent of that many calls * to malloc() and free() per second, thread local storage is used to keep a * list of unused frame structures so that they can be continuously reused. + * + * - \ref threadstorage.h */ #ifndef ASTERISK_THREADSTORAGE_H @@ -86,7 +92,7 @@ struct ast_threadstorage { * * Example usage: * \code - * AST_THREADSTORAGE(my_buf, my_init, my_cleanup); + * AST_THREADSTORAGE_CUSTOM(my_buf, my_init, my_cleanup); * \endcode */ #define AST_THREADSTORAGE_CUSTOM(name, c_init, c_cleanup) \ |