]> git.ipfire.org Git - thirdparty/freeswitch.git/commitdiff
and a few corrections to the docs.
authorMichael Jerris <mike@jerris.com>
Tue, 3 Jan 2006 00:48:52 +0000 (00:48 +0000)
committerMichael Jerris <mike@jerris.com>
Tue, 3 Jan 2006 00:48:52 +0000 (00:48 +0000)
git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@260 d0543943-73ff-0310-b7d9-9358b9ac24b2

src/include/switch_apr.h
src/include/switch_buffer.h
src/include/switch_config.h
src/include/switch_console.h
src/include/switch_event.h
src/include/switch_loadable_module.h
src/include/switch_sqlite.h

index 14c5fe0ab4616d97b42946b65e371d738ce80134..0193193305604e11106a9a89380f629a79c2c2ff 100644 (file)
@@ -964,7 +964,7 @@ typedef apr_pollset_t switch_pollset_t;
  * platforms; the apr_pollset_create() call will fail with
  * APR_ENOTIMPL on platforms where it is not supported.
  */
-DoxyDefine(apr_status_t apr_pollset_create(switch_pollset_t **pollset,
+DoxyDefine(apr_status_t switch_pollset_create(switch_pollset_t **pollset,
                                              apr_uint32_t size,
                                              switch_memory_pool_t *p,
                                              apr_uint32_t flags);)
@@ -987,7 +987,7 @@ DoxyDefine(apr_status_t apr_pollset_create(switch_pollset_t **pollset,
  *         allowed for implementations where option (1) is impossible
  *         or impractical.
  */
-DoxyDefine(apr_status_t apr_pollset_add(switch_pollset_t *pollset,
+DoxyDefine(apr_status_t switch_pollset_add(switch_pollset_t *pollset,
                                           const switch_pollfd_t *descriptor);)
 #define switch_pollset_add apr_pollset_add
 
@@ -1090,7 +1090,7 @@ DoxyDefine(apr_status_t switch_time_exp_lt(switch_time_exp_t *result,
  * @param t desired amount of time to sleep.
  * @warning May sleep for longer than the specified time. 
  */
-DoxyDefine(void apr_sleep(apr_interval_time_t t);)
+DoxyDefine(void switch_sleep(apr_interval_time_t t);)
 #define switch_sleep apr_sleep
 
 /** @} */
index 644209f2a72acb9d98a4923569454ac72658c006..076e3c3ae3d755e881c6d07a552e7197f73d9f57 100644 (file)
@@ -42,14 +42,15 @@ extern "C" {
 
 #include <switch.h>
 
-struct switch_buffer;
-
 /**
  * @defgroup switch_buffer Buffer Routines
  * @ingroup FREESWITCH 
  * @{
  */
 
+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
@@ -72,7 +73,7 @@ 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
+ * \return int ammount of buffer curently in use
  */
 SWITCH_DECLARE(int) switch_buffer_inuse(switch_buffer *buffer);
 
@@ -95,7 +96,7 @@ SWITCH_DECLARE(int) switch_buffer_write(switch_buffer *buffer, void *data, size_
 /*! \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
+ * \return int size of buffer, or 0 if unable to toss that much data
  */
 SWITCH_DECLARE(int) switch_buffer_toss(switch_buffer *buffer, size_t datalen);
 /** @} */
index be60b2f8e4512d5976627c289a3beef278f9ea36..105892fc0936d9367e649ad610cb5396536bfd95 100644 (file)
@@ -29,8 +29,8 @@
  * switch_config.h -- Configuration File Parser
  *
  */
-/*! \file switch_config.h\r
-    \brief Configuration File Parser\r
+/*! \file switch_config.h
+    \brief Configuration File Parser
 */
 
 #ifndef SWITCH_CONFIG_H
index 8220d99ed2bf3878588dc8fff0043f6e03fa39d0..350ba5a2a8027b5e3544505de965549905a57352 100644 (file)
@@ -29,8 +29,8 @@
  * switch_console.h -- Simple Console
  *
  */
-/*! \file switch_console.h\r
-    \brief Simple Console\r
+/*! \file switch_console.h
+    \brief Simple Console
 */
 
 #ifndef SWITCH_CONSOLE_H
index 9ef76d9f8fe6e752ceed8158e41ccd7f23650b4b..c4fd22865ca99b26b03515af091ea7d215cbcc50 100644 (file)
@@ -29,8 +29,8 @@
  * switch_event.h -- Event System
  *
  */
-/*! \file switch_event.h\r
-    \brief Event System\r
+/*! \file switch_event.h
+    \brief Event System
 */
 
 #ifndef SWITCH_EVENT_H
index 41a61fd6502c0fdc55fbc7ebcdc4dffc5ebdb7cf..b8819b49046be536718358d37742889d348e324e 100644 (file)
@@ -29,8 +29,8 @@
  * switch_loadable_module.h -- Loadable Modules
  *
  */
-/*! \file switch_loadable_module.h\r
-    \brief Loadable Modules\r
+/*! \file switch_loadable_module.h
+    \brief Loadable Modules
 */
 
 #ifndef SWITCH_LOADABLE_MODULE_H
index 49328b1d61ce4abcd86a28fc8298d955237f47aa..6472f7a1dc01764aa9cef973e39253e82da85c06 100644 (file)
@@ -28,8 +28,8 @@
  * switch_sqlite.h -- Sqlite Header
  *
  */
-/*! \file switch_sqlite.h\r
-    \brief Sqlite Header\r
+/*! \file switch_sqlite.h
+    \brief Sqlite Header
 */
 #ifndef SWITCH_SQLITE_H
 #define SWITCH_SQLITE_H
@@ -40,6 +40,16 @@ extern "C" {
 
 #include <sqlite3.h>
 
+/**
+ * @defgroup switch_sqlite Database Routines
+ * @ingroup FREESWITCH 
+ * @{
+ */
+
+/**
+ * Each open sqlite database is represented by an instance of the
+ * following opaque structure.
+*/
 typedef sqlite3 switch_core_db;
 
 #define switch_core_db_aggregate_context sqlite3_aggregate_context
@@ -150,6 +160,7 @@ typedef sqlite3 switch_core_db;
 #define switch_core_db_version sqlite3_version
 #define switch_core_db_vmprintf sqlite3_vmprintf
 
+/** @} */