[asterisk-commits] dlee: branch dlee/stasis-forward-optimization r399980 - /team/dlee/stasis-for...

[SVN commits to the Asterisk project]

Author: dlee
Date: Fri Sep 27 13:09:03 2013
New Revision: 399980

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=399980
Log:
Review feedback: doc comments for stasis_forward

Modified:
    team/dlee/stasis-forward-optimization/main/stasis.c

Modified: team/dlee/stasis-forward-optimization/main/stasis.c
URL: http://svnview.digium.com/svn/asterisk/team/dlee/stasis-forward-optimization/main/stasis.c?view=diff&rev=399980&r1=399979&r2=399980
==============================================================================
--- team/dlee/stasis-forward-optimization/main/stasis.c (original)
+++ team/dlee/stasis-forward-optimization/main/stasis.c Fri Sep 27 13:09:03 2013
@@ -589,8 +589,18 @@
 	stasis_forward_message(topic, topic, message);
 }
 
+/*!
+ * \brief Forwarding information
+ *
+ * Any message posted to \a from_topic is forwarded to \a to_topic.
+ *
+ * In cases where both the \a from_topic and \a to_topic need to be locked,
+ * always lock the \a to_topic first, then the \a from_topic. Lest you deadlock.
+ */
 struct stasis_forward {
+	/*! Originating topic */
 	struct stasis_topic *from_topic;
+	/*! Destination topic */
 	struct stasis_topic *to_topic;
 };