Doxygen updates and corrections
authorOlle Johansson <oej@edvina.net>
Sat, 24 Feb 2007 19:49:11 +0000 (19:49 +0000)
committerOlle Johansson <oej@edvina.net>
Sat, 24 Feb 2007 19:49:11 +0000 (19:49 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@56648 65c4cc65-6c06-0410-ace0-fbb531ad65f3

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

index 09b7ad6..f212a83 100644 (file)
@@ -637,7 +637,7 @@ static struct zt_pvt {
  * 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;
index d9daf41..fa4d1ac 100644 (file)
@@ -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/
index fa0b6f9..c0b9b33 100644 (file)
@@ -495,8 +495,9 @@ struct ast_frame *ast_smoother_read(struct ast_smoother *s);
 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
index a88de0c..b342e67 100644 (file)
@@ -22,6 +22,8 @@
  *
  * \author Mark Spencer <markster@digium.com>
  *
+ * \extref OpenSSL http://www.openssl.org - for AMI/SSL 
+ *
  * At the moment this file contains a number of functions, namely:
  *
  * - data structures storing AMI state
@@ -117,8 +119,10 @@ static int num_sessions;
 
 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 @@ struct mansession {
 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 @@ static int process_message(struct mansession *s, const struct message *m)
 
 /*!
  * 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)
 {