[asterisk-commits] oej: trunk r48033 - in /trunk/include/asterisk: doxyref.h threadstorage.h

[asterisk-commits at lists.digium.com]

Author: oej
Date: Mon Nov 27 00:59:20 2006
New Revision: 48033

URL: http://svn.digium.com/view/asterisk?view=rev&rev=48033
Log:
Doxygen updates

Modified:
    trunk/include/asterisk/doxyref.h
    trunk/include/asterisk/threadstorage.h

Modified: trunk/include/asterisk/doxyref.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/doxyref.h?view=diff&rev=48033&r1=48032&r2=48033
==============================================================================
--- trunk/include/asterisk/doxyref.h (original)
+++ trunk/include/asterisk/doxyref.h Mon Nov 27 00:59:20 2006
@@ -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

Modified: trunk/include/asterisk/threadstorage.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/threadstorage.h?view=diff&rev=48033&r1=48032&r2=48033
==============================================================================
--- trunk/include/asterisk/threadstorage.h (original)
+++ trunk/include/asterisk/threadstorage.h Mon Nov 27 00:59:20 2006
@@ -19,8 +19,12 @@
 /*!
  * \file threadstorage.h
  * \author Russell Bryant <russell at 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 @@
  *
  * 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) \