initial doxygen. Much, much more to go.

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

src/include/switch.h

@@ -28,6 +28,10 @@
  * switch.h -- Main Library Header
  *
  */
+/*! \file switch.h
+    \brief Main Library Header
+*/
+
 #ifndef SWITCH_H
 #define SWITCH_H
 

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
+    \brief APR includes header
+*/
 #ifndef SWITCH_APR_H
 #define SWITCH_APR_H
 

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 
+ * \param pool Pool to allocate the buffer from
+ * \param buffer returned pointer to the new buffer
+ * \param max_len length required by the buffer
+ * \return status
+ */
 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 
+ * \param buffer any buffer of type switch_buffer
+ * \return int size of the buffer.
+ */
 SWITCH_DECLARE(int) switch_buffer_len(switch_buffer *buffer);
+
+/*! \brief Get the freespace of a switch_buffer 
+ * \param buffer any buffer of type switch_buffer
+ * \return int freespace in the buffer.
+ */
 SWITCH_DECLARE(int) switch_buffer_freespace(switch_buffer *buffer);
+
+/*! \brief Get the in use amount of a switch_buffer 
+ * \param buffer any buffer of type switch_buffer
+ * \return int size of buffer curently in use
+ */
 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. 
+ * \param buffer any buffer of type switch_buffer
+ * \param data pointer to the read data to be returned
+ * \param datalen amount of data to be returned
+ * \return int ammount of data actually read
+ */
 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
+ * \param buffer any buffer of type switch_buffer
+ * \param data pointer to the data to be written
+ * \param datalen amount of data to be written
+ * \return int ammount of buffer used after the write, or 0 if no space available
+ */
 SWITCH_DECLARE(int) switch_buffer_write(switch_buffer *buffer, void *data, size_t datalen);
+
+/*! \brief Remove data from the buffer
+ * \param buffer any buffer of type switch_buffer
+ * \param datalen amount of data to be returned
+ * \return int ammount of buffer used after the toss, or 0 if unable to toss that much data
+ */
 SWITCH_DECLARE(int) switch_buffer_toss(switch_buffer *buffer, size_t datalen);
 
 

src/include/switch_caller.h

@@ -29,6 +29,10 @@
  * switch_caller.h -- Caller Identification
  *
  */
+/*! \file switch_caller.h
+    \brief Caller Identification
+*/
+
 #ifndef SWITCH_CALLER_H
 #define SWITCH_CALLER_H
 

src/include/switch_channel.h

@@ -29,6 +29,10 @@
  * switch_channel.h -- Media Channel Interface
  *
  */
+/*! \file switch_channel.h
+    \brief Media Channel Interface
+*/
+
 #ifndef SWITCH_CHANNEL_H
 #define SWITCH_CHANNEL_H
 

src/include/switch_config.h

@@ -29,6 +29,10 @@
  * switch_config.h -- Configuration File Parser
  *
  */
+/*! \file switch_config.h
+    \brief Configuration File Parser
+*/
+
 #ifndef SWITCH_CONFIG_H
 #define SWITCH_CONFIG_H
 

src/include/switch_console.h

@@ -29,6 +29,10 @@
  * switch_console.h -- Simple Console
  *
  */
+/*! \file switch_console.h
+    \brief Simple Console
+*/
+
 #ifndef SWITCH_CONSOLE_H
 #define SWITCH_CONSOLE_H
 

src/include/switch_core.h

@@ -29,6 +29,10 @@
  * switch_core.h -- Core Library
  *
  */
+/*! \file switch_core.h
+    \brief Core Library
+*/
+
 #ifndef SWITCH_CORE_H
 #define SWITCH_CORE_H
 

src/include/switch_event.h

@@ -29,6 +29,10 @@
  * switch_event.h -- Event System
  *
  */
+/*! \file switch_event.h
+    \brief Event System
+*/
+
 #ifndef SWITCH_EVENT_H
 #define SWITCH_EVENT_H
 

src/include/switch_frame.h

@@ -29,6 +29,10 @@
  * switch_frame.h -- Media Frame Structure
  *
  */
+/*! \file switch_frame.h
+    \brief Media Frame Structure
+*/
+
 #ifndef SWITCH_FRAME_H
 #define SWITCH_FRAME_H
 

src/include/switch_loadable_module.h

@@ -29,6 +29,10 @@
  * switch_loadable_module.h -- Loadable Modules
  *
  */
+/*! \file switch_loadable_module.h
+    \brief Loadable Modules
+*/
+
 #ifndef SWITCH_LOADABLE_MODULE_H
 #define SWITCH_LOADABLE_MODULE_H
 

src/include/switch_module_interfaces.h

@@ -29,6 +29,9 @@
  * switch_module_interfaces.h -- Module Interface Definitions
  *
  */
+/*! \file switch_module_interfaces.h
+    \brief Module Interface Definitions
+*/
 #ifndef SWITCH_MODULE_INTERFACES_H
 #define SWITCH_MODULE_INTERFACES_H
 

src/include/switch_mutex.h

@@ -29,6 +29,9 @@
  * switch_mutex.h -- Mutex Locking
  *
  */
+/*! \file switch_mutex.h
+    \brief Mutex Locking
+*/
 #ifndef SWITCH_MUTEX_H
 #define SWITCH_MUTEX_H
 

src/include/switch_platform.h

@@ -28,6 +28,9 @@
  * switch_platform.h -- Platform Specific Header
  *
  */
+/*! \file switch_platform.h
+    \brief Platform Specific Header
+*/
 #ifndef SWITCH_PLATFORM_H
 #define SWITCH_PLATFORM_H
 

src/include/switch_sqlite.h

@@ -28,6 +28,9 @@
  * switch_sqlite.h -- Sqlite Header
  *
  */
+/*! \file switch_sqlite.h
+    \brief Sqlite Header
+*/
 #ifndef SWITCH_SQLITE_H
 #define SWITCH_SQLITE_H
 

src/include/switch_types.h

@@ -28,6 +28,9 @@
  * switch_types.h -- Data Types
  *
  */
+/*! \file switch_types.h
+    \brief Data Types
+*/
 #ifndef SWITCH_TYPES_H
 #define SWITCH_TYPES_H
 

src/include/switch_utils.h

@@ -29,6 +29,9 @@
  * switch_utils.h -- Compatability and Helper Code
  *
  */
+/*! \file switch_utils.h
+    \brief Compatability and Helper Code
+*/
 #ifndef SWITCH_UTILS_H
 #define SWITCH_UTILS_H