and a few corrections to the docs.

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@260 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Michael Jerris 2006-01-03 00:48:52 +00:00
parent dc31a8ecd3
commit 900c08571b
7 changed files with 29 additions and 17 deletions

View 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
/** @} */

View 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);
/** @} */

View File

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

View File

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

View File

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

View File

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

View File

@ -28,8 +28,8 @@
* switch_sqlite.h -- Sqlite Header
*
*/
/*! \file switch_sqlite.h
\brief Sqlite Header
/*! \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
/** @} */