[asterisk-commits] oej: trunk r48149 - in /trunk: agi/ contrib/ main/

[asterisk-commits at lists.digium.com]

Author: oej
Date: Thu Nov 30 12:22:10 2006
New Revision: 48149

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

Modified:
    trunk/agi/Makefile
    trunk/agi/eagi-sphinx-test.c
    trunk/agi/eagi-test.c
    trunk/contrib/asterisk-ng-doxygen
    trunk/main/devicestate.c

Modified: trunk/agi/Makefile
URL: http://svn.digium.com/view/asterisk/trunk/agi/Makefile?view=diff&rev=48149&r1=48148&r2=48149
==============================================================================
--- trunk/agi/Makefile (original)
+++ trunk/agi/Makefile Thu Nov 30 12:22:10 2006
@@ -21,7 +21,7 @@
 
 include $(ASTTOPDIR)/Makefile.rules
 
-all: $(AGIS)
+all: #$(AGIS)
 
 strcompat.c: ../main/strcompat.c
 	@cp $< $@

Modified: trunk/agi/eagi-sphinx-test.c
URL: http://svn.digium.com/view/asterisk/trunk/agi/eagi-sphinx-test.c?view=diff&rev=48149&r1=48148&r2=48149
==============================================================================
--- trunk/agi/eagi-sphinx-test.c (original)
+++ trunk/agi/eagi-sphinx-test.c Thu Nov 30 12:22:10 2006
@@ -4,6 +4,15 @@
  * This code is released into public domain
  * without any warranty of any kind.
  *
+ */
+
+/*! \file
+ * Extended AGI test application
+ *
+ * This code is released into public domain
+ * without any warranty of any kind.
+ *
+ *	\ingroup agi
  */
 
 #include <stdio.h>

Modified: trunk/agi/eagi-test.c
URL: http://svn.digium.com/view/asterisk/trunk/agi/eagi-test.c?view=diff&rev=48149&r1=48148&r2=48149
==============================================================================
--- trunk/agi/eagi-test.c (original)
+++ trunk/agi/eagi-test.c Thu Nov 30 12:22:10 2006
@@ -17,6 +17,15 @@
 #include "asterisk/compat.h"
 
 #define AUDIO_FILENO (STDERR_FILENO + 1)
+
+/*! \file
+ * Extended AGI test application
+ *
+ * This code is released into the public domain
+ * with no warranty of any kind
+ *
+ * \ingroup agi
+ */
 
 static int read_environment(void)
 {

Modified: trunk/contrib/asterisk-ng-doxygen
URL: http://svn.digium.com/view/asterisk/trunk/contrib/asterisk-ng-doxygen?view=diff&rev=48149&r1=48148&r2=48149
==============================================================================
--- trunk/contrib/asterisk-ng-doxygen (original)
+++ trunk/contrib/asterisk-ng-doxygen Thu Nov 30 12:22:10 2006
@@ -458,6 +458,7 @@
 			 codecs \
 			 formats \
 			 pbx \
+			 agi \
 			 res
 
 # If the value of the INPUT tag contains directories, you can use the 

Modified: trunk/main/devicestate.c
URL: http://svn.digium.com/view/asterisk/trunk/main/devicestate.c?view=diff&rev=48149&r1=48148&r2=48149
==============================================================================
--- trunk/main/devicestate.c (original)
+++ trunk/main/devicestate.c Thu Nov 30 12:22:10 2006
@@ -22,6 +22,8 @@
  *
  *
  * \author Mark Spencer <markster at digium.com> 
+ *
+ *	\arg \ref AstExtState
  */
 /*! \page AstExtState Extension and device states in Asterisk
  *
@@ -59,9 +61,25 @@
  *	- SIP subscriptions, a.k.a. "blinking lamps" or 
  *	  "buddy lists"
  *
- *	None of these handle user states, like an IM presense
+ *	The CLI command "show hints" show last known state
+ *
+ *	\note None of these handle user states, like an IM presense
  *	system. res_jabber.c can subscribe and watch such states
  *	in jabber/xmpp based systems.
+ *
+ *	\section AstExtStateARch Architecture
+ *
+ *	When a channel driver or asterisk app changes state for 
+ *	a watched object, it alerts the core. The core queues
+ *	a change. When the change is processed, there's a query
+ *	sent to the channel driver/provider if there's a function
+ *	to handle that, otherwise a channel walk is issued to find
+ *	a channel that involves the object.
+ *	
+ *	The changes are queued and processed by a separate thread.
+ *	This thread calls the watchers subscribing to status 
+ *	changes for the object. For manager, this results 
+ *	in events. For SIP, NOTIFY requests.
  *
  *	
  */