From b9d57e8e3ad400b6909e82e57330f3da36eabda2 Mon Sep 17 00:00:00 2001 From: Olle Johansson Date: Mon, 27 Nov 2006 06:59:20 +0000 Subject: [PATCH] Doxygen updates git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@48033 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/doxyref.h | 5 ++++- include/asterisk/threadstorage.h | 10 ++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/include/asterisk/doxyref.h b/include/asterisk/doxyref.h index 9211b12337..5d6716fae0 100644 --- a/include/asterisk/doxyref.h +++ b/include/asterisk/doxyref.h @@ -40,7 +40,6 @@ * \arg \ref AstENUM : The IETF way to redirect from phone numbers to VoIP calls * \arg \ref AstHTTP * \arg \ref AstSpeech - * \arg \ref DataStores * \arg \ref ConfigFiles * \arg \ref SoundFiles included in the Asterisk distribution * \arg \ref AstCREDITS : A Thank You to contributors @@ -65,6 +64,10 @@ /*! \page AstAPI Asterisk API * \section Asteriskapi Asterisk API * Some generic documents on the Asterisk architecture + * + * \arg \ref AstThreadStorage + * \arg \ref DataStores + * * \subsection model_txt Generic Model * \verbinclude model.txt * \subsection channel_txt Channels diff --git a/include/asterisk/threadstorage.h b/include/asterisk/threadstorage.h index 4886d35203..25bc24b71d 100644 --- a/include/asterisk/threadstorage.h +++ b/include/asterisk/threadstorage.h @@ -19,8 +19,12 @@ /*! * \file threadstorage.h * \author Russell Bryant - * * \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) \