[asterisk-commits] file: branch file/audiohooks r78638 - /team/file/audiohooks/include/asterisk/

[SVN commits to the Asterisk project]

Author: file
Date: Wed Aug  8 14:11:39 2007
New Revision: 78638

URL: http://svn.digium.com/view/asterisk?view=rev&rev=78638
Log:
Add a bit more doxygen documentation.

Modified:
    team/file/audiohooks/include/asterisk/audiohook.h

Modified: team/file/audiohooks/include/asterisk/audiohook.h
URL: http://svn.digium.com/view/asterisk/team/file/audiohooks/include/asterisk/audiohook.h?view=diff&rev=78638&r1=78637&r2=78638
==============================================================================
--- team/file/audiohooks/include/asterisk/audiohook.h (original)
+++ team/file/audiohooks/include/asterisk/audiohook.h Wed Aug  8 14:11:39 2007
@@ -30,29 +30,29 @@
 #include "asterisk/slinfactory.h"
 
 enum ast_audiohook_type {
-	AST_AUDIOHOOK_TYPE_SPY = 0,
-	AST_AUDIOHOOK_TYPE_WHISPER,
-	AST_AUDIOHOOK_TYPE_MANIPULATE,
+	AST_AUDIOHOOK_TYPE_SPY = 0,    /*!< Audiohook wants to receive audio */
+	AST_AUDIOHOOK_TYPE_WHISPER,    /*!< Audiohook wants to provide audio to be mixed with existing audio */
+	AST_AUDIOHOOK_TYPE_MANIPULATE, /*!< Audiohook wants to manipulate the audio */
 };
 
 enum ast_audiohook_status {
-	AST_AUDIOHOOK_STATUS_NEW = 0,
-	AST_AUDIOHOOK_STATUS_RUNNING,
-	AST_AUDIOHOOK_STATUS_SHUTDOWN,
-	AST_AUDIOHOOK_STATUS_DONE,
+	AST_AUDIOHOOK_STATUS_NEW = 0,  /*!< Audiohook was just created, not in use yet */
+	AST_AUDIOHOOK_STATUS_RUNNING,  /*!< Audiohook is running on a channel */
+	AST_AUDIOHOOK_STATUS_SHUTDOWN, /*!< Audiohook is being shutdown */
+	AST_AUDIOHOOK_STATUS_DONE,     /*!< Audiohook has shutdown and is not running on a channel any longer */
 };
 
 enum ast_audiohook_direction {
-	AST_AUDIOHOOK_DIRECTION_READ = 0,
-	AST_AUDIOHOOK_DIRECTION_WRITE,
-	AST_AUDIOHOOK_DIRECTION_BOTH,
+	AST_AUDIOHOOK_DIRECTION_READ = 0, /*!< Reading audio in */
+	AST_AUDIOHOOK_DIRECTION_WRITE,    /*!< Writing audio out */
+	AST_AUDIOHOOK_DIRECTION_BOTH,     /*!< Both reading audio in and writing audio out */
 };
 
 enum ast_audiohook_flags {
-	AST_AUDIOHOOK_TRIGGER_MODE = (3 << 0),
-	AST_AUDIOHOOK_TRIGGER_READ = (1 << 0),
-	AST_AUDIOHOOK_TRIGGER_WRITE = (2 << 0),
-	AST_AUDIOHOOK_WANTS_DTMF = (1 << 1),
+	AST_AUDIOHOOK_TRIGGER_MODE = (3 << 0),  /*!< When audiohook should be triggered to do something */
+	AST_AUDIOHOOK_TRIGGER_READ = (1 << 0),  /*!< Audiohook wants to be triggered when reading audio in */
+	AST_AUDIOHOOK_TRIGGER_WRITE = (2 << 0), /*!< Audiohook wants to be triggered when writing audio out */
+	AST_AUDIOHOOK_WANTS_DTMF = (1 << 1),    /*!< Audiohook also wants to receive DTMF frames */
 };
 
 struct ast_audiohook;