add main page to the doxygen docs.

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@318 d0543943-73ff-0310-b7d9-9358b9ac24b2

diff --git a/src/include/switch.h b/src/include/switch.h
index e33787e9a1196d668a26db05e5a697b4a33ffa58..8d5193d2fa9562195d0b464dd9598ed87bc65a5e 100644 (file)
--- a/src/include/switch.h
+++ b/src/include/switch.h
@@ -68,5 +68,55 @@ extern "C" {
 #ifdef __cplusplus
 }
 #endif
-
+\r
+/** \mainpage FreeSWITCH\r
+ * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application\r
+\r
+ * \section intro Introduction\r
+ *\r
+ * \section supports Supported Platforms\r
+ * Freeswitch has been built on the following platforms:\r
+ *\r
+ *  - Linux (x86)\r
+ *  - Windows (MSVC 2005)\r
+ *  - Mac OS X\r
+ *  - FreeBSD\r
+ *\r
+ * \section depends Dependencies\r
+ *  Freeswitch makes heavy use of external libraries.  \r
+ *\r
+ *  libFreeSwitch:\r
+ *             APR (http://apr.apache.org)\r
+ *             SQLite (http://www.sqlite.org)\r
+ *             libresample (http://ccrma-www.stanford.edu/~jos/resample/Free_Resampling_Software.html)\r
+ *\r
+ *     Additionally, the experimental external modules make use of several external modules:\r
+ *\r
+ *     mod_Exosip:\r
+ *             JRTPlib (http://research.edm.luc.ac.be/jori/jrtplib/jrtplib.html)\r
+ *             eXoSIP (http://savannah.nongnu.org/projects/exosip/)\r
+ *\r
+ *     mod_iaxchan:\r
+ *             libiax2 (forked from http://iaxclient.sourceforge.net/)\r
+ *\r
+ *     mod_speexcodec\r
+ *             libspeex (http://www.speex.org/)\r
+ *\r
+ *     mod_portaudio\r
+ *             portaudio (http://www.portaudio.com/)\r
+ *\r
+ *     mod_woomerachan\r
+ *             openh323\woomera (http://www.voxgratia.org/)\r
+ *\r
+ *     mod_xmpp_event\r
+ *             iksemel (http://iksemel.jabberstudio.org/)\r
+ *\r
+ *     mod_sndfile\r
+ *             libsndfile (http://www.mega-nerd.com/libsndfile/)\r
+ *\r
+ * \section license Licensing\r
+ *\r
+ * Freeswitch is licensed under the terms of the MPL 1.1\r
+ *\r
+ */
 #endif