Merged revisions 52107 via svnmerge from
authorRussell Bryant <russell@russellbryant.com>
Wed, 24 Jan 2007 21:43:22 +0000 (21:43 +0000)
committerRussell Bryant <russell@russellbryant.com>
Wed, 24 Jan 2007 21:43:22 +0000 (21:43 +0000)
https://origsvn.digium.com/svn/asterisk/branches/1.4

........
r52107 | russell | 2007-01-24 15:42:47 -0600 (Wed, 24 Jan 2007) | 3 lines

Fix the formatting of doxygen comments to properly indicate that the comment
documents the previous entity, as opposed to the next one.

........

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@52108 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/dial.h

index f8393ab..71ce6cf 100644 (file)
@@ -35,23 +35,23 @@ struct ast_dial_channel;
 
 /*! \brief List of options that are applicable either globally or per dialed channel */
 enum ast_dial_option {
-       AST_DIAL_OPTION_RINGING,     /*! Always indicate ringing to caller */
-       AST_DIAL_OPTION_ANSWER_EXEC, /*! Execute application upon answer in async mode */
-       AST_DIAL_OPTION_MAX,         /*! End terminator -- must always remain last */
+       AST_DIAL_OPTION_RINGING,     /*!< Always indicate ringing to caller */
+       AST_DIAL_OPTION_ANSWER_EXEC, /*!< Execute application upon answer in async mode */
+       AST_DIAL_OPTION_MAX,         /*!< End terminator -- must always remain last */
 };
 
 /*! \brief List of return codes for dial run API calls */
 enum ast_dial_result {
-       AST_DIAL_RESULT_INVALID = 0, /*! Invalid options were passed to run function */
-       AST_DIAL_RESULT_FAILED,      /*! Attempts to dial failed before reaching critical state */
-       AST_DIAL_RESULT_TRYING,      /*! Currently trying to dial */
-       AST_DIAL_RESULT_RINGING,     /*! Dial is presently ringing */
-       AST_DIAL_RESULT_PROGRESS,    /*! Dial is presently progressing */
-       AST_DIAL_RESULT_PROCEEDING,  /*! Dial is presently proceeding */
-       AST_DIAL_RESULT_ANSWERED,    /*! A channel was answered */
-       AST_DIAL_RESULT_TIMEOUT,     /*! Timeout was tripped, nobody answered */
-       AST_DIAL_RESULT_HANGUP,      /*! Caller hung up */
-       AST_DIAL_RESULT_UNANSWERED,  /*! Nobody answered */
+       AST_DIAL_RESULT_INVALID = 0, /*!< Invalid options were passed to run function */
+       AST_DIAL_RESULT_FAILED,      /*!< Attempts to dial failed before reaching critical state */
+       AST_DIAL_RESULT_TRYING,      /*!< Currently trying to dial */
+       AST_DIAL_RESULT_RINGING,     /*!< Dial is presently ringing */
+       AST_DIAL_RESULT_PROGRESS,    /*!< Dial is presently progressing */
+       AST_DIAL_RESULT_PROCEEDING,  /*!< Dial is presently proceeding */
+       AST_DIAL_RESULT_ANSWERED,    /*!< A channel was answered */
+       AST_DIAL_RESULT_TIMEOUT,     /*!< Timeout was tripped, nobody answered */
+       AST_DIAL_RESULT_HANGUP,      /*!< Caller hung up */
+       AST_DIAL_RESULT_UNANSWERED,  /*!< Nobody answered */
 };
 
 /*! \brief New dialing structure