[asterisk-commits] dlee: branch dlee/endpoints r387478 - /team/dlee/endpoints/include/asterisk/

[SVN commits to the Asterisk project]

Author: dlee
Date: Thu May  2 14:00:44 2013
New Revision: 387478

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=387478
Log:
Comment fixups

Modified:
    team/dlee/endpoints/include/asterisk/stasis_test.h

Modified: team/dlee/endpoints/include/asterisk/stasis_test.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/endpoints/include/asterisk/stasis_test.h?view=diff&rev=387478&r1=387477&r2=387478
==============================================================================
--- team/dlee/endpoints/include/asterisk/stasis_test.h (original)
+++ team/dlee/endpoints/include/asterisk/stasis_test.h Thu May  2 14:00:44 2013
@@ -23,6 +23,15 @@
  * \file \brief Test infrastructure for dealing with Stasis.
  *
  * \author David M. Lee, II <dlee at digium.com>
+ *
+ * This file contains some helpful utilities for testing Stasis related topics
+ * and messages. The \ref stasis_message_sink is something you can subscribe to
+ * a topic which will receive all of the messages from the topic. This messages
+ * are accumulated in its \c messages field.
+ *
+ * There are a set of wait functions (stasis_message_sink_wait_for_count(),
+ * stasis_message_sink_wait_for(), etc.) which will block waiting for conditions
+ * to be met in the \ref stasis_message_sink.
  */
 
 #include "asterisk/lock.h"
@@ -112,6 +121,10 @@
 int stasis_message_sink_should_stay(struct stasis_message_sink *sink,
 	int num_messages, int timeout_millis);
 
+/*! \addtogroup StasisTopicsAndMessages
+ * @{
+ */
+
 /*!
  * \brief Creates a test message.
  */
@@ -122,4 +135,8 @@
  */
 struct stasis_message_type *stasis_test_message_type(void);
 
+/*!
+ * @}
+ */
+
 #endif /* _ASTERISK_STASIS_TEST_H */