From 1c0683f59ad99f92cd66a953b5784cab42fcfdff Mon Sep 17 00:00:00 2001 From: Michael Jerris Date: Tue, 10 Jan 2006 16:00:40 +0000 Subject: [PATCH] add main page to the doxygen docs. git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@318 d0543943-73ff-0310-b7d9-9358b9ac24b2 --- src/include/switch.h | 52 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/src/include/switch.h b/src/include/switch.h index e33787e9a1..8d5193d2fa 100644 --- a/src/include/switch.h +++ b/src/include/switch.h @@ -68,5 +68,55 @@ extern "C" { #ifdef __cplusplus } #endif - + +/** \mainpage FreeSWITCH + * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application + + * \section intro Introduction + * + * \section supports Supported Platforms + * Freeswitch has been built on the following platforms: + * + * - Linux (x86) + * - Windows (MSVC 2005) + * - Mac OS X + * - FreeBSD + * + * \section depends Dependencies + * Freeswitch makes heavy use of external libraries. + * + * libFreeSwitch: + * APR (http://apr.apache.org) + * SQLite (http://www.sqlite.org) + * libresample (http://ccrma-www.stanford.edu/~jos/resample/Free_Resampling_Software.html) + * + * Additionally, the experimental external modules make use of several external modules: + * + * mod_Exosip: + * JRTPlib (http://research.edm.luc.ac.be/jori/jrtplib/jrtplib.html) + * eXoSIP (http://savannah.nongnu.org/projects/exosip/) + * + * mod_iaxchan: + * libiax2 (forked from http://iaxclient.sourceforge.net/) + * + * mod_speexcodec + * libspeex (http://www.speex.org/) + * + * mod_portaudio + * portaudio (http://www.portaudio.com/) + * + * mod_woomerachan + * openh323\woomera (http://www.voxgratia.org/) + * + * mod_xmpp_event + * iksemel (http://iksemel.jabberstudio.org/) + * + * mod_sndfile + * libsndfile (http://www.mega-nerd.com/libsndfile/) + * + * \section license Licensing + * + * Freeswitch is licensed under the terms of the MPL 1.1 + * + */ #endif