From 78816a284ab31eb303fc9cf7baf53cbcccb67535 Mon Sep 17 00:00:00 2001 From: Stefan Sayer Date: Sat, 24 Nov 2007 12:26:17 +0000 Subject: [PATCH] updated doc git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@563 8eb893ce-cfd4-0310-b710-fb5ebe64c474 --- doc/CHANGELOG | 12 +++++++++++- doc/Readme.callback | 17 +++++++++++++++++ doc/doxyref.h | 41 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 doc/Readme.callback diff --git a/doc/CHANGELOG b/doc/CHANGELOG index 4dc111e8..65505ee9 100644 --- a/doc/CHANGELOG +++ b/doc/CHANGELOG @@ -1,5 +1,15 @@ Changelog for SEMS + - simple call generator application + + - fixed artifacts on wav files with extra chunks + + - support for spandsp DTMF detection + + - callback application + + - prepaid and click2dial applications + - support for extra headers in dialout sessions - support for setting the URI of a session in SDP @@ -16,7 +26,7 @@ Changelog for SEMS - outbound_proxy option sets next hop on outgoing dialogs and registrations - - b/f: don't reuse dialog for SIp authenticated re-sending of INVITE + - b/f: don't reuse dialog for SIP authenticated re-sending of INVITE Version 0.10.0 (final) - new module for exposing internal DI APIs via XMLRPC diff --git a/doc/Readme.callback b/doc/Readme.callback new file mode 100644 index 00000000..b9c8eb90 --- /dev/null +++ b/doc/Readme.callback @@ -0,0 +1,17 @@ +Callback application +-------------------- + +This application FRs the caller with 468 Busy, and calls back +after some time. If the callback call is established, the called +party may enter a number, to which the call is connected in B2BUA +mode with media relay. + +Both the callback call to the caller, and the outgoing call +to the callee) are made and authenticated using a configurable +account (From, domain and authentication). + +Allowed callback users may be specified with a regexp in the +configuration. + +Used together with reg-agent this app can greatly reduce your +mobile phone bill... diff --git a/doc/doxyref.h b/doc/doxyref.h index d667be11..0c8adfd2 100644 --- a/doc/doxyref.h +++ b/doc/doxyref.h @@ -143,6 +143,18 @@ * * * + * \section Prepaid + * + * This is a signalling-only prepaid engine. + * + * + * + * \section Click2Dial + * + * An xmlrpc-enabled way to initiate authenticated calls: + * + * + * * \section Scripting SEMS with Python * * There are two application modules which embed a python interpreted into @@ -171,6 +183,10 @@ * * * + * + * \section Various applications + * + * */ /*! \page AppDocExample Example Applications @@ -379,6 +395,31 @@ * Back to \ref AppDoc, to \ref AppDocExample. */ +/*! \page ModuleDoc_callback Module Documentation: callback application plugin + * \section Readme_callback Readme file + * \verbinclude Readme.callback + * + * \section Links + * Back to \ref AppDoc, to \ref AppDocExample. + */ + +/*! \page ModuleDoc_sw_prepaid_sip Module Documentation: prepaid_sip application plugin + * \section Readme_prepaid_sip Readme file + * \verbinclude Readme.sw_prepaid_sip + * + * \section Links + * Back to \ref AppDoc, to \ref AppDocExample. + */ + +/*! \page ModuleDoc_click2dial Module Documentation: click2dial application plugin + * \section Readme_click2dial Readme file + * \verbinclude Readme.click2dial + * + * \section Links + * Back to \ref AppDoc, to \ref AppDocExample. + */ + + // -------------------- example apps /*! \page ModuleDoc_conf_auth Module Documentation: conf_auth Application