[asterisk-commits] oej: trunk r56648 - in /trunk: channels/ include/asterisk/ main/

[asterisk-commits at lists.digium.com]

Author: oej
Date: Sat Feb 24 13:49:11 2007
New Revision: 56648

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

Modified:
    trunk/channels/chan_zap.c
    trunk/include/asterisk/doxyref.h
    trunk/include/asterisk/frame.h
    trunk/main/manager.c

Modified: trunk/channels/chan_zap.c
URL: http://svn.digium.com/view/asterisk/trunk/channels/chan_zap.c?view=diff&rev=56648&r1=56647&r2=56648
==============================================================================
--- trunk/channels/chan_zap.c (original)
+++ trunk/channels/chan_zap.c Sat Feb 24 13:49:11 2007
@@ -637,7 +637,7 @@
  * statement is reached, the current zt_chan_conf is used to configure the 
  * channel (struct zt_pvt)
  *
- * @seealso zt_chan_init for the default values.
+ * \see zt_chan_init for the default values.
  */
 struct zt_chan_conf {
 	struct zt_pvt chan;

Modified: trunk/include/asterisk/doxyref.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/doxyref.h?view=diff&rev=56648&r1=56647&r2=56648
==============================================================================
--- trunk/include/asterisk/doxyref.h (original)
+++ trunk/include/asterisk/doxyref.h Sat Feb 24 13:49:11 2007
@@ -44,6 +44,7 @@
  *  \arg \ref ConfigFiles
  *  \arg \ref SoundFiles included in the Asterisk distribution
  *  \arg \ref AstCREDITS : A Thank You to contributors
+ *  \arg \ref extref 
  \n\n
  * \section weblinks Web sites
  * \arg \b Main:  Asterisk Developer's website http://www.asterisk.org/developers/

Modified: trunk/include/asterisk/frame.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/frame.h?view=diff&rev=56648&r1=56647&r2=56648
==============================================================================
--- trunk/include/asterisk/frame.h (original)
+++ trunk/include/asterisk/frame.h Sat Feb 24 13:49:11 2007
@@ -495,8 +495,9 @@
 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix);
 
 /*! \page AudioCodecPref Audio Codec Preferences
+
 	In order to negotiate audio codecs in the order they are configured
-	in <channel>.conf for a device, we set up codec preference lists
+	in \<channel\>.conf for a device, we set up codec preference lists
 	in addition to the codec capabilities setting. The capabilities
 	setting is a bitmask of audio and video codecs with no internal
 	order. This will reflect the offer given to the other side, where

Modified: trunk/main/manager.c
URL: http://svn.digium.com/view/asterisk/trunk/main/manager.c?view=diff&rev=56648&r1=56647&r2=56648
==============================================================================
--- trunk/main/manager.c (original)
+++ trunk/main/manager.c Sat Feb 24 13:49:11 2007
@@ -21,6 +21,8 @@
  * \brief The Asterisk Management Interface - AMI
  *
  * \author Mark Spencer <markster at digium.com>
+ *
+ * \extref OpenSSL http://www.openssl.org - for AMI/SSL 
  *
  * At the moment this file contains a number of functions, namely:
  *
@@ -117,8 +119,10 @@
 
 static int manager_debug;	/*!< enable some debugging code in the manager */
 
-/*!
+/*! \brief
  * Descriptor for a manager session, either on the AMI socket or over HTTP.
+ *
+ * \note
  * AMI session have managerid == 0; the entry is created upon a connect,
  * and destroyed with the socket.
  * HTTP sessions have managerid != 0, the value is used as a search key
@@ -155,6 +159,7 @@
 static AST_LIST_HEAD_STATIC(sessions, mansession);
 
 /*! \brief user descriptor, as read from the config file.
+ *
  * \note It is still missing some fields -- e.g. we can have multiple permit and deny
  * lines which are not supported here, and readperm/writeperm/writetimeout
  * are not stored.
@@ -2157,10 +2162,12 @@
 
 /*!
  * Read one full line (including crlf) from the manager socket.
+ * \note \verbatim
  * \r\n is the only valid terminator for the line.
  * (Note that, later, '\0' will be considered as the end-of-line marker,
  * so everything between the '\0' and the '\r\n' will not be used).
  * Also note that we assume output to have at least "maxlen" space.
+ * \endverbatim
  */
 static int get_input(struct mansession *s, char *output)
 {