[asterisk-commits] russell: branch russell/events r73842 - /team/russell/events/include/asterisk/

[SVN commits to the Asterisk project]

Author: russell
Date: Sat Jul  7 21:18:32 2007
New Revision: 73842

URL: http://svn.digium.com/view/asterisk?view=rev&rev=73842
Log:
doxygen updates

Modified:
    team/russell/events/include/asterisk/devicestate.h

Modified: team/russell/events/include/asterisk/devicestate.h
URL: http://svn.digium.com/view/asterisk/team/russell/events/include/asterisk/devicestate.h?view=diff&rev=73842&r1=73841&r2=73842
==============================================================================
--- team/russell/events/include/asterisk/devicestate.h (original)
+++ team/russell/events/include/asterisk/devicestate.h Sat Jul  7 21:18:32 2007
@@ -79,38 +79,41 @@
 enum ast_device_state ast_devstate_val(const char *val);
 
 /*! \brief Search the Channels by Name
- * \param device like a dialstring
- * Search the Device in active channels by compare the channelname against 
- * the devicename. Compared are only the first chars to the first '-' char.
- * Returns an AST_DEVICE_UNKNOWN if no channel found or
- * AST_DEVICE_INUSE if a channel is found
+ * \param device like a dial string
+ * Search the Device in active channels by compare the channel name against 
+ * the device name. Compared are only the first chars to the first '-' char.
+ * \retval AST_DEVICE_UNKNOWN if no channel found
+ * \retval AST_DEVICE_INUSE if a channel is found
  */
 enum ast_device_state ast_parse_device_state(const char *device);
 
 /*! \brief Asks a channel for device state
- * \param device like a dialstring
- * Asks a channel for device state, data is  normaly a number from dialstring
+ * \param device like a dial string
+ * Asks a channel for device state, data is normally a number from a dial string
  * used by the low level module
- * Trys the channel devicestate callback if not supported search in the
+ * Tries the channel device state callback if not supported search in the
  * active channels list for the device.
- * Returns an AST_DEVICE_??? state -1 on failure
+ * \retval an AST_DEVICE_??? state 
+ * \retval -1 on failure
  */
 enum ast_device_state ast_device_state(const char *device);
 
 /*! \brief Tells Asterisk the State for Device is changed
- * \param fmt devicename like a dialstring with format parameters
- * Asterisk polls the new extensionstates and calls the registered
+ * \param fmt device name like a dial string with format parameters
+ * Asterisk polls the new extension states and calls the registered
  * callbacks for the changed extensions
- * Returns 0 on success, -1 on failure
+ * \retval 0 on success 
+ * \retval -1 on failure
  */
 int ast_device_state_changed(const char *fmt, ...)
 	__attribute__ ((format (printf, 1, 2)));
 
 /*! \brief Tells Asterisk the State for Device is changed 
- * \param device devicename like a dialstring
- * Asterisk polls the new extensionstates and calls the registered
+ * \param device device name like a dial string
+ * Asterisk polls the new extension states and calls the registered
  * callbacks for the changed extensions
- * Returns 0 on success, -1 on failure
+ * \retval 0 on success 
+ * \retval -1 on failure
  */
 int ast_device_state_changed_literal(const char *device);
 
@@ -124,7 +127,8 @@
 
 /*! \brief Remove device state provider 
  * \param label to use in hint, like label:object
- * Return -1 on failure, 0 on success
+ * \retval -1 on failure 
+ * \retval 0 on success
  */ 
 int ast_devstate_prov_del(const char *label);