Author: derek Date: Sun Nov 19 22:28:58 2006 New Revision: 211 Modified: sofaswitch/trunk/allprograms.cxx sofaswitch/trunk/docs.cfg sofaswitch/trunk/message.cxx sofaswitch/trunk/server/docs.cfg sofaswitch/trunk/sound/audio.h sofaswitch/trunk/sound/docs.cfg Log: Add documentation tidyups to get it to work better. Put a link to call flow inside the list of sofa applications. Modified: sofaswitch/trunk/allprograms.cxx ============================================================================== --- sofaswitch/trunk/allprograms.cxx (original) +++ sofaswitch/trunk/allprograms.cxx Sun Nov 19 22:28:58 2006 @@ -30,11 +30,12 @@ /** \page pageSofaSwitchPrograms Current Programs in Sofa Switch -\li <a class="el" href="am/index.html"> answering machine</a> -\li <a class="el" href="mcu/index.html"> conference utility</a> -\li <a class="el" href="server/index.html"> message server</a> -\li <a class="el" href="sofa/index.html"> sofa library</a> -\li <a class="el" href="sound/index.html"> sound card utility</a> -\li <a class="el" href="voip/index.html"> voip handler</a> +\li <a class="el" href="am/index.html"> answering machine</a> +\li <a class="el" href="callflow/index.html"> call control</a> +\li <a class="el" href="mcu/index.html"> conference utility</a> +\li <a class="el" href="server/index.html"> message server</a> +\li <a class="el" href="sofa/index.html"> sofa library</a> +\li <a class="el" href="sound/index.html"> sound card utility</a> +\li <a class="el" href="voip/index.html"> voip handler</a> */ Modified: sofaswitch/trunk/docs.cfg ============================================================================== --- sofaswitch/trunk/docs.cfg (original) +++ sofaswitch/trunk/docs.cfg Sun Nov 19 22:28:58 2006 @@ -68,9 +68,9 @@ # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = . -FILE_PATTERNS = +FILE_PATTERNS = *.dxy *.cxx RECURSIVE = NO -EXCLUDE = +EXCLUDE = *.py EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = EXAMPLE_PATH = Modified: sofaswitch/trunk/message.cxx ============================================================================== --- sofaswitch/trunk/message.cxx (original) +++ sofaswitch/trunk/message.cxx Sun Nov 19 22:28:58 2006 @@ -247,25 +247,29 @@ <center> <table width="600"> <tr><td> - quitnow</td><td> Cause the server to end. On ending, every application + quitnow</td><td> + Cause the server to end. On ending, every application connected to the server will end also. </td></tr> -<tr><td> list</td><td> Cause the server to respond with a list of all the - currently connected nodes. The command "list" is - similar to the notion of presence as used in XMPP, - except that here, presence is driven by the client. +<tr><td> list</td><td> + Cause the server to respond with a list of all the currently + connected nodes. The command "list" is similar to the notion + of presence as used in XMPP, except that here, presence is + driven by the client. </td></tr> -<tr><td> whoami </td><td> A request to the server to advise us who we - are. This command is useful when we are some controller who - has connected to the server and asked the server to generate - a unique Id for us. It is also a debugging tool from the command - prompt case - we can enquire of the server to report our ID. +<tr><td> whoami </td><td> + A request to the server to advise us who we are. This command + is useful when we are some controller who has connected to + the server and asked the server to generate a unique Id for + us. It is also a debugging tool from the command prompt case + - we can enquire of the server to report our ID. </td></tr> -<tr><td>adviseontermination remNode</td><td>This commands the server to (on - this node terminating) send a message to the specified node - (remNode). The message will advise remNode that this this - node has died. Thus, the controller will get a message if the - box running the answer machine (for example) is unplugged. +<tr><td>adviseontermination remNode</td><td> + This commands the server to (on this node terminating) send a + message to the specified node (remNode). The message will + advise remNode that this this node has died. Thus, the + controller will get a message if the box running the answer + machine (for example) is unplugged. </td></tr> </table> </center> Modified: sofaswitch/trunk/server/docs.cfg ============================================================================== --- sofaswitch/trunk/server/docs.cfg (original) +++ sofaswitch/trunk/server/docs.cfg Sun Nov 19 22:28:58 2006 @@ -180,7 +180,7 @@ SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = +PREDEFINED = DOC_PLUS_PLUS EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- Modified: sofaswitch/trunk/sound/audio.h ============================================================================== --- sofaswitch/trunk/sound/audio.h (original) +++ sofaswitch/trunk/sound/audio.h Sun Nov 19 22:28:58 2006 @@ -17,8 +17,6 @@ /**The base class for reading and writing audio from/to the sound device. This class will take audio to/from the PUDPSocket, and transfer it to/from the sound device */ -class PQueueChannel; - class TestAudio : public PThread { PCLASSINFO(TestAudio, PThread); @@ -90,8 +88,7 @@ /**Constructor */ TestAudioWrite(PUDPSocket &_socket, PSoundChannel &_sound); - /**Destructor. This deletes the PQueueChannel we allocated in the - constructor */ + /**Destructor. This does any required tidy ups.*/ ~TestAudioWrite(); /**the main entry point, where this thread starts */ Modified: sofaswitch/trunk/sound/docs.cfg ============================================================================== --- sofaswitch/trunk/sound/docs.cfg (original) +++ sofaswitch/trunk/sound/docs.cfg Sun Nov 19 22:28:58 2006 @@ -109,7 +109,7 @@ HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = -HTML_STYLESHEET = YES +HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = @@ -180,7 +180,7 @@ SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = +PREDEFINED = DOC_PLUS_PLUS EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #---------------------------------------------------------------------------