initial doxygen. Much, much more to go.

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

diff --git a/Makefile.am b/Makefile.am
index ab063c5f3a1fb5c8038103acf22937d999cd2337..59bb3774e90e63db4a5b74e9b816f6c723a9bd6e 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -119,6 +119,8 @@ install_mod: modules
        @/bin/cp -f src/mod/*/mod_*.so $(PREFIX)/mod >/dev/null 2<&1 || echo No modules to copy.
        @echo done
 
+dox:
+       doxygen $(PWD)/docs/Doxygen.conf
 
 eclean: clean
        rm -f `find . -type f -name \*~`

diff --git a/docs/Doxygen.conf b/docs/Doxygen.conf
new file mode 100644 (file)
index 0000000..b415278
--- /dev/null
+++ b/docs/Doxygen.conf
@@ -0,0 +1,259 @@
+# Doxyfile 1.4.6
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME           = FreeSwitch
+PROJECT_NUMBER         = 
+OUTPUT_DIRECTORY       = .
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+USE_WINDOWS_ENCODING   = YES
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ABBREVIATE_BRIEF       = "The $name class" \
+                         "The $name widget" \
+                         "The $name file" \
+                         is \
+                         provides \
+                         specifies \
+                         contains \
+                         represents \
+                         a \
+                         an \
+                         the
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = NO
+STRIP_FROM_PATH        = 
+STRIP_FROM_INC_PATH    = 
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = NO
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP         = NO
+INHERIT_DOCS           = YES
+SEPARATE_MEMBER_PAGES  = NO
+TAB_SIZE               = 8
+ALIASES                = 
+OPTIMIZE_OUTPUT_FOR_C  = YES
+OPTIMIZE_OUTPUT_JAVA   = NO
+BUILTIN_STL_SUPPORT    = NO
+DISTRIBUTE_GROUP_DOC   = NO
+SUBGROUPING            = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = NO
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_METHODS  = NO
+HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_CLASSES     = YES
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = NO
+CASE_SENSE_NAMES       = NO
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+SORT_BRIEF_DOCS        = NO
+SORT_BY_SCOPE_NAME     = NO
+GENERATE_TODOLIST      = YES
+GENERATE_TESTLIST      = YES
+GENERATE_BUGLIST       = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS       = 
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+SHOW_DIRECTORIES       = NO
+FILE_VERSION_FILTER    = 
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           = 
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = ../src
+FILE_PATTERNS          = *.c \
+                         *.cc \
+                         *.cxx \
+                         *.cpp \
+                         *.c++ \
+                         *.d \
+                         *.java \
+                         *.ii \
+                         *.ixx \
+                         *.ipp \
+                         *.i++ \
+                         *.inl \
+                         *.h \
+                         *.hh \
+                         *.hxx \
+                         *.hpp \
+                         *.h++ \
+                         *.idl \
+                         *.odl \
+                         *.cs \
+                         *.php \
+                         *.php3 \
+                         *.inc \
+                         *.m \
+                         *.mm \
+                         *.dox \
+                         *.py
+RECURSIVE              = YES
+EXCLUDE                = 
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       = 
+EXAMPLE_PATH           = 
+EXAMPLE_PATTERNS       = *
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             = 
+INPUT_FILTER           = 
+FILTER_PATTERNS        = 
+FILTER_SOURCE_FILES    = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = NO
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = NO
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          = 
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            = 
+HTML_FOOTER            = 
+HTML_STYLESHEET        = 
+HTML_ALIGN_MEMBERS     = YES
+GENERATE_HTMLHELP      = NO
+CHM_FILE               = 
+HHC_LOCATION           = 
+GENERATE_CHI           = NO
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+DISABLE_INDEX          = NO
+ENUM_VALUES_PER_LINE   = 4
+GENERATE_TREEVIEW      = YES
+TREEVIEW_WIDTH         = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = a4wide
+EXTRA_PACKAGES         = 
+LATEX_HEADER           = 
+PDF_HYPERLINKS         = NO
+USE_PDFLATEX           = NO
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    = 
+RTF_EXTENSIONS_FILE    = 
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_SCHEMA             = 
+XML_DTD                = 
+XML_PROGRAMLISTING     = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX = 
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor   
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           = 
+INCLUDE_FILE_PATTERNS  = 
+PREDEFINED             = SWITCH_DECLARE(x)=x
+EXPAND_AS_DEFINED      = YES
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references   
+#---------------------------------------------------------------------------
+TAGFILES               = 
+GENERATE_TAGFILE       = 
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool   
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = YES
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = NO
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+GROUP_GRAPHS           = YES
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = NO
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = NO
+GRAPHICAL_HIERARCHY    = YES
+DIRECTORY_GRAPH        = YES
+DOT_IMAGE_FORMAT       = png
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MAX_DOT_GRAPH_WIDTH    = 1024
+MAX_DOT_GRAPH_HEIGHT   = 1024
+MAX_DOT_GRAPH_DEPTH    = 1000
+DOT_TRANSPARENT        = NO
+DOT_MULTI_TARGETS      = NO
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine   
+#---------------------------------------------------------------------------
+SEARCHENGINE           = NO

diff --git a/src/include/switch.h b/src/include/switch.h
index b08cd3329c34a9d78f5c0cc3b9545788b17e4c51..7808b57bea2945c90249a7784129d5335ef6cea8 100644 (file)
--- a/src/include/switch.h
+++ b/src/include/switch.h
@@ -28,6 +28,10 @@
  * switch.h -- Main Library Header
  *
  */
+/*! \file switch.h\r
+    \brief Main Library Header\r
+*/\r
+
 #ifndef SWITCH_H
 #define SWITCH_H
 

diff --git a/src/include/switch_apr.h b/src/include/switch_apr.h
index d451789000606a766d980cea97945b855f9af327..b19082dc90f6c29442fb1e280211f68db4ec0545 100644 (file)
--- a/src/include/switch_apr.h
+++ b/src/include/switch_apr.h
@@ -25,9 +25,12 @@
  * 
  * Anthony Minessale II <anthmct@yahoo.com>
  *
- * switch_apr.h -- APR Header
+ * switch_apr.h -- APR includes header
  *
  */
+/*! \file switch_apr.h\r
+    \brief APR includes header\r
+*/
 #ifndef SWITCH_APR_H
 #define SWITCH_APR_H
 

diff --git a/src/include/switch_buffer.h b/src/include/switch_buffer.h
index 3b97defdaaa42865171718799ced8865c85180a9..255093e0366f9e8a763217ca87619600edf007a2 100644 (file)
--- a/src/include/switch_buffer.h
+++ b/src/include/switch_buffer.h
@@ -29,6 +29,10 @@
  * switch_buffer.h -- Data Buffering Code
  *
  */
+/*! \file switch_buffer.h
+    \brief Data Buffering Code
+*/
+
 #ifndef SWITCH_BUFFER_H
 #define SWITCH_BUFFER_H
 
@@ -40,12 +44,53 @@ extern "C" {
 
 struct switch_buffer;
 
+/*! \brief Allocate a new switch_buffer \r
+ * \param pool Pool to allocate the buffer from\r
+ * \param buffer returned pointer to the new buffer\r
+ * \param max_len length required by the buffer\r
+ * \return status\r
+ */\r
 SWITCH_DECLARE(switch_status) switch_buffer_create(switch_memory_pool *pool, switch_buffer **buffer, size_t max_len);
+
+/*! \brief Get the length of a switch_buffer \r
+ * \param buffer any buffer of type switch_buffer\r
+ * \return int size of the buffer.\r
+ */\r
 SWITCH_DECLARE(int) switch_buffer_len(switch_buffer *buffer);
+
+/*! \brief Get the freespace of a switch_buffer \r
+ * \param buffer any buffer of type switch_buffer\r
+ * \return int freespace in the buffer.\r
+ */\r
 SWITCH_DECLARE(int) switch_buffer_freespace(switch_buffer *buffer);
+
+/*! \brief Get the in use amount of a switch_buffer \r
+ * \param buffer any buffer of type switch_buffer\r
+ * \return int size of buffer curently in use\r
+ */\r
 SWITCH_DECLARE(int) switch_buffer_inuse(switch_buffer *buffer);
+
+/*! \brief Read data from a switch_buffer up to the ammount of datalen if it is available.  Remove read data from buffer. \r
+ * \param buffer any buffer of type switch_buffer\r
+ * \param data pointer to the read data to be returned\r
+ * \param datalen amount of data to be returned\r
+ * \return int ammount of data actually read\r
+ */\r
 SWITCH_DECLARE(int) switch_buffer_read(switch_buffer *buffer, void *data, size_t datalen);
+
+/*! \brief Write data into a switch_buffer up to the length of datalen\r
+ * \param buffer any buffer of type switch_buffer\r
+ * \param data pointer to the data to be written\r
+ * \param datalen amount of data to be written\r
+ * \return int ammount of buffer used after the write, or 0 if no space available\r
+ */\r
 SWITCH_DECLARE(int) switch_buffer_write(switch_buffer *buffer, void *data, size_t datalen);
+
+/*! \brief Remove data from the buffer\r
+ * \param buffer any buffer of type switch_buffer\r
+ * \param datalen amount of data to be returned\r
+ * \return int ammount of buffer used after the toss, or 0 if unable to toss that much data\r
+ */\r
 SWITCH_DECLARE(int) switch_buffer_toss(switch_buffer *buffer, size_t datalen);
 
 

diff --git a/src/include/switch_caller.h b/src/include/switch_caller.h
index d3983042a3359544da6cd4b8b3db80a3f8a86236..811259425ae39f0e9eb5a80174a2d8cfb2ba7c07 100644 (file)
--- a/src/include/switch_caller.h
+++ b/src/include/switch_caller.h
@@ -29,6 +29,10 @@
  * switch_caller.h -- Caller Identification
  *
  */
+/*! \file switch_caller.h\r
+    \brief Caller Identification\r
+*/
+
 #ifndef SWITCH_CALLER_H
 #define SWITCH_CALLER_H
 

diff --git a/src/include/switch_channel.h b/src/include/switch_channel.h
index b78493666aa473f51fe773f221fe90ea8890ec12..09ce976304563365be0a048578281de2189af853 100644 (file)
--- a/src/include/switch_channel.h
+++ b/src/include/switch_channel.h
@@ -29,6 +29,10 @@
  * switch_channel.h -- Media Channel Interface
  *
  */
+/*! \file switch_channel.h\r
+    \brief Media Channel Interface\r
+*/
+
 #ifndef SWITCH_CHANNEL_H
 #define SWITCH_CHANNEL_H
 

diff --git a/src/include/switch_config.h b/src/include/switch_config.h
index 19774e0a4ae26968d096ff7aa26f3e1cb7be462a..be60b2f8e4512d5976627c289a3beef278f9ea36 100644 (file)
--- a/src/include/switch_config.h
+++ b/src/include/switch_config.h
@@ -29,6 +29,10 @@
  * switch_config.h -- Configuration File Parser
  *
  */
+/*! \file switch_config.h\r
+    \brief Configuration File Parser\r
+*/
+
 #ifndef SWITCH_CONFIG_H
 #define SWITCH_CONFIG_H
 

diff --git a/src/include/switch_console.h b/src/include/switch_console.h
index 8a70cdc91f8f6cb3d7a42a7c07bafe48bae24407..8220d99ed2bf3878588dc8fff0043f6e03fa39d0 100644 (file)
--- a/src/include/switch_console.h
+++ b/src/include/switch_console.h
@@ -29,6 +29,10 @@
  * switch_console.h -- Simple Console
  *
  */
+/*! \file switch_console.h\r
+    \brief Simple Console\r
+*/
+
 #ifndef SWITCH_CONSOLE_H
 #define SWITCH_CONSOLE_H
 

diff --git a/src/include/switch_core.h b/src/include/switch_core.h
index 0afc61d85d1044fe4276d34eddd3108306b31429..a0c50d79111f081054f3fd6d4ad9800001d088ae 100644 (file)
--- a/src/include/switch_core.h
+++ b/src/include/switch_core.h
@@ -29,6 +29,10 @@
  * switch_core.h -- Core Library
  *
  */
+/*! \file switch_core.h\r
+    \brief Core Library\r
+*/
+
 #ifndef SWITCH_CORE_H
 #define SWITCH_CORE_H
 

diff --git a/src/include/switch_event.h b/src/include/switch_event.h
index 92229fc9904330a0872a807890debfd4fcf853b5..9ef76d9f8fe6e752ceed8158e41ccd7f23650b4b 100644 (file)
--- a/src/include/switch_event.h
+++ b/src/include/switch_event.h
@@ -29,6 +29,10 @@
  * switch_event.h -- Event System
  *
  */
+/*! \file switch_event.h\r
+    \brief Event System\r
+*/
+
 #ifndef SWITCH_EVENT_H
 #define SWITCH_EVENT_H
 

diff --git a/src/include/switch_frame.h b/src/include/switch_frame.h
index ee8b78a98e7b6cc10318296f451d1b7f6f627788..5eb3c793df22d5e4ae64cd41f1dd27bae1cb0083 100644 (file)
--- a/src/include/switch_frame.h
+++ b/src/include/switch_frame.h
@@ -29,6 +29,10 @@
  * switch_frame.h -- Media Frame Structure
  *
  */
+/*! \file switch_frame.h\r
+    \brief Media Frame Structure\r
+*/
+
 #ifndef SWITCH_FRAME_H
 #define SWITCH_FRAME_H
 

diff --git a/src/include/switch_loadable_module.h b/src/include/switch_loadable_module.h
index b35c6d3c5a5aca46ff3da5bbef9cd3d6fcafad75..41a61fd6502c0fdc55fbc7ebcdc4dffc5ebdb7cf 100644 (file)
--- a/src/include/switch_loadable_module.h
+++ b/src/include/switch_loadable_module.h
@@ -29,6 +29,10 @@
  * switch_loadable_module.h -- Loadable Modules
  *
  */
+/*! \file switch_loadable_module.h\r
+    \brief Loadable Modules\r
+*/
+
 #ifndef SWITCH_LOADABLE_MODULE_H
 #define SWITCH_LOADABLE_MODULE_H
 

diff --git a/src/include/switch_module_interfaces.h b/src/include/switch_module_interfaces.h
index ac4cb3b07cfb33acd7e4d578d5d2cc19742d2b0f..4ce264e3f3262895172c756976e08f0393c0c0bb 100644 (file)
--- a/src/include/switch_module_interfaces.h
+++ b/src/include/switch_module_interfaces.h
@@ -29,6 +29,9 @@
  * switch_module_interfaces.h -- Module Interface Definitions
  *
  */
+/*! \file switch_module_interfaces.h\r
+    \brief Module Interface Definitions\r
+*/
 #ifndef SWITCH_MODULE_INTERFACES_H
 #define SWITCH_MODULE_INTERFACES_H
 

diff --git a/src/include/switch_mutex.h b/src/include/switch_mutex.h
index db6455b284145b4fa9e883907c9e92797af05c7c..54c725d00e8c02dfccdb6d739c26528cd6cf6f95 100644 (file)
--- a/src/include/switch_mutex.h
+++ b/src/include/switch_mutex.h
@@ -29,6 +29,9 @@
  * switch_mutex.h -- Mutex Locking
  *
  */
+/*! \file switch_mutex.h\r
+    \brief Mutex Locking\r
+*/
 #ifndef SWITCH_MUTEX_H
 #define SWITCH_MUTEX_H
 

diff --git a/src/include/switch_platform.h b/src/include/switch_platform.h
index b44935b45481e1b895e983840632b7e4c736cb05..2cbf64a69e1e6d4b0659315d51ed4f42cfa60d91 100644 (file)
--- a/src/include/switch_platform.h
+++ b/src/include/switch_platform.h
@@ -28,6 +28,9 @@
  * switch_platform.h -- Platform Specific Header
  *
  */
+/*! \file switch_platform.h\r
+    \brief Platform Specific Header\r
+*/
 #ifndef SWITCH_PLATFORM_H
 #define SWITCH_PLATFORM_H
 

diff --git a/src/include/switch_sqlite.h b/src/include/switch_sqlite.h
index dd0fe3b8aa0a98a460f908abd9214f13ad7f54a1..49328b1d61ce4abcd86a28fc8298d955237f47aa 100644 (file)
--- a/src/include/switch_sqlite.h
+++ b/src/include/switch_sqlite.h
@@ -28,6 +28,9 @@
  * switch_sqlite.h -- Sqlite Header
  *
  */
+/*! \file switch_sqlite.h\r
+    \brief Sqlite Header\r
+*/
 #ifndef SWITCH_SQLITE_H
 #define SWITCH_SQLITE_H
 

diff --git a/src/include/switch_types.h b/src/include/switch_types.h
index c37d9f434fc115d8f71576a833b407f555a33401..ac66fe0b4d977cb3f42ba4dbba54284d98d37a11 100644 (file)
--- a/src/include/switch_types.h
+++ b/src/include/switch_types.h
@@ -28,6 +28,9 @@
  * switch_types.h -- Data Types
  *
  */
+/*! \file switch_types.h\r
+    \brief Data Types\r
+*/
 #ifndef SWITCH_TYPES_H
 #define SWITCH_TYPES_H
 

diff --git a/src/include/switch_utils.h b/src/include/switch_utils.h
index cb9ac59eac6b0d51f8576220edf44701888c1873..cfe186defdba70bdb3692c6b348520e3d9d8994d 100644 (file)
--- a/src/include/switch_utils.h
+++ b/src/include/switch_utils.h
@@ -29,6 +29,9 @@
  * switch_utils.h -- Compatability and Helper Code
  *
  */
+/*! \file switch_utils.h\r
+    \brief Compatability and Helper Code\r
+*/
 #ifndef SWITCH_UTILS_H
 #define SWITCH_UTILS_H