[asterisk-commits] russell: branch 1.4 r52107 - /branches/1.4/include/asterisk/dial.h

[asterisk-commits at lists.digium.com]

Author: russell
Date: Wed Jan 24 15:42:47 2007
New Revision: 52107

URL: http://svn.digium.com/view/asterisk?view=rev&rev=52107
Log:
Fix the formatting of doxygen comments to properly indicate that the comment
documents the previous entity, as opposed to the next one.

Modified:
    branches/1.4/include/asterisk/dial.h

Modified: branches/1.4/include/asterisk/dial.h
URL: http://svn.digium.com/view/asterisk/branches/1.4/include/asterisk/dial.h?view=diff&rev=52107&r1=52106&r2=52107
==============================================================================
--- branches/1.4/include/asterisk/dial.h (original)
+++ branches/1.4/include/asterisk/dial.h Wed Jan 24 15:42:47 2007
@@ -35,23 +35,23 @@
 
 /*! \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