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

[SVN commits to the Asterisk project]

Author: russell
Date: Tue Jun 10 08:47:21 2008
New Revision: 121500

URL: http://svn.digium.com/view/asterisk?view=rev&rev=121500
Log:
Document the API that allows you to take a bunch of device states and determine
what the aggregate device state is

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=121500&r1=121499&r2=121500
==============================================================================
--- team/russell/events/include/asterisk/devicestate.h (original)
+++ team/russell/events/include/asterisk/devicestate.h Tue Jun 10 08:47:21 2008
@@ -196,15 +196,44 @@
  */ 
 int ast_devstate_prov_del(const char *label);
 
+/*!
+ * \brief An object to hold state when calculating aggregate device state
+ */
 struct ast_devstate_aggregate;
 
+/*!
+ * \brief Initialize aggregate device state
+ *
+ * \arg agg the state object
+ *
+ * \return nothing
+ */
 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg);
 
+/*!
+ * \brief Add a device state to the aggregate device state
+ *
+ * \arg agg the state object
+ * \arg state the state to add
+ *
+ * \return nothing
+ */
 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state);
 
+/*!
+ * \brief Get the aggregate device state result
+ *
+ * \arg agg the state object
+ *
+ * \return the aggregate device state after adding some number of device states.
+ */
 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg);
 
-/*! \brief You shouldn't care about the contents of this struct */
+/*! 
+ * \brief You shouldn't care about the contents of this struct 
+ *
+ * This struct is only here so that it can be easily declared on the stack.
+ */
 struct ast_devstate_aggregate {
 	unsigned int all_unavail:1;
 	unsigned int all_busy:1;