kenmirrors
/
freeswitch
mirror of https://github.com/signalwire/freeswitch.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doxygen cleanups\changes. 

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@319 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Michael Jerris 2006-01-10 20:10:38 +00:00
parent 1c0683f59a
commit ba43278132
6 changed files with 130 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
src/include/switch.h
View File

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

15
src/include/switch_buffer.h
View File

@ -29,13 +29,11 @@
* switch_buffer.h -- Data Buffering Code
*
*/
/*! \file switch_buffer.h
\brief Data Buffering Code
The purpose of this module is to make a plain buffering interface that can be used for read/write buffers
throughout the application. The first implementation was done to provide the functionality and the interface
and I think it can be optimized under the hood as we go using bucket brigades and/or ring buffering techniques.
*/
/**
* @file switch_buffer.h
* @brief Data Buffering Code
* @see switch_buffer
*/
#ifndef SWITCH_BUFFER_H
#define SWITCH_BUFFER_H
@ -49,6 +47,9 @@ extern "C" {
/**
* @defgroup switch_buffer Buffer Routines
* @ingroup FREESWITCH
* The purpose of this module is to make a plain buffering interface that can be used for read/write buffers
* throughout the application. The first implementation was done to provide the functionality and the interface
* and I think it can be optimized under the hood as we go using bucket brigades and/or ring buffering techniques.
* @{
*/

36
src/include/switch_caller.h
View File

@ -29,22 +29,26 @@
* switch_caller.h -- Caller Identification
*
*/
/*! \file switch_caller.h
\brief Caller Identification
This file implements a caller profile which is a group of information about a connected endpoint
such as common caller id and other useful information such as ip address and destination number.
A connected session's channel has up to 3 profiles: It's own, that of the session who spawned it
and that of the session it has spawned.
In addition, this file implements an abstract interface for extensions and applications.
A connected session's channel has one extension object which may have one or more applications
linked into a stack which will be executed in order by the session's state machine when the
current state is CS_EXECUTE.
/**
* @file switch_caller.h
* @brief Caller Identification
* @see caller
*/
///\defgroup caller Caller Identity / Dialplan
///\ingroup FREESWITCH
///\{
/**
* @defgroup caller Caller Identity / Dialplan
* @ingroup FREESWITCH
*
* This module implements a caller profile which is a group of information about a connected endpoint
* such as common caller id and other useful information such as ip address and destination number.
* A connected session's channel has up to 3 profiles: It's own, that of the session who spawned it
* and that of the session it has spawned.
*
* In addition, this module implements an abstract interface for extensions and applications.
* A connected session's channel has one extension object which may have one or more applications
* linked into a stack which will be executed in order by the session's state machine when the
* current state is CS_EXECUTE.
* @{
*/
#ifndef SWITCH_CALLER_H
#define SWITCH_CALLER_H
@ -168,7 +172,7 @@ extern "C" {
}
#endif
///\}
/** @} */
#endif

25
src/include/switch_channel.h
View File

@ -29,12 +29,11 @@
* switch_channel.h -- Media Channel Interface
*
*/
/*! \file switch_channel.h
\brief Media Channel Interface
The switch_channel object is a private entity that belongs to a session that contains the call
specific information such as the call state, variables, caller profiles and DTMF queue
*/
/**
* @file switch_channel.h
* @brief Media Channel Interface
* @see switch_channel
*/
#ifndef SWITCH_CHANNEL_H
#define SWITCH_CHANNEL_H
@ -45,11 +44,13 @@ extern "C" {
#include <switch.h>
/*!
\defgroup chans Channel Functions
\ingroup FREESWITCH
\{
*/
/**
* @defgroup switch_channel Channel Functions
* @ingroup FREESWITCH
* The switch_channel object is a private entity that belongs to a session that contains the call
* specific information such as the call state, variables, caller profiles and DTMF queue
* @{
*/
/*!
\brief Get the current state of a channel in the state engine
@ -283,7 +284,7 @@ SWITCH_DECLARE(void) switch_channel_event_set_data(switch_channel *channel, swit
// These may go away
SWITCH_DECLARE(switch_status) switch_channel_set_raw_mode (switch_channel *channel, int freq, int bits, int channels, int ms, int kbps);
SWITCH_DECLARE(switch_status) switch_channel_get_raw_mode (switch_channel *channel, int *freq, int *bits, int *channels, int *ms, int *kbps);
///\}
/** @} */
#ifdef __cplusplus
}

43
src/include/switch_config.h
View File

@ -29,26 +29,29 @@
* switch_config.h -- Configuration File Parser
*
*/
/*! \file switch_config.h
\brief Basic Configuration File Parser
/**
* @file switch_config.h
* @brief Basic Configuration File Parser
* @see config
*/
This module implements a basic interface and file format parser it may be depricated in favor of database entries
or expanded to tie to external handlers in the future as necessary.
<pre>
EXAMPLE
[category1]
var1 => val1
var2 => val2
\# lines that begin with \# are comments
\#var3 => val3
</pre>
*/
///\defgroup confg Config File Parser
///\ingroup FREESWITCH
///\{
/**
* @defgroup config Config File Parser
* @ingroup FREESWITCH
* This module implements a basic interface and file format parser it may be depricated in favor of database entries
* or expanded to tie to external handlers in the future as necessary.
* <pre>
*
* EXAMPLE
*
* [category1]
* var1 => val1
* var2 => val2
* \# lines that begin with \# are comments
* \#var3 => val3
* </pre>
* @{
*/
#ifndef SWITCH_CONFIG_H
#define SWITCH_CONFIG_H
@ -98,6 +101,6 @@ SWITCH_DECLARE(int) switch_config_next_pair(switch_config *cfg, char **var, char
#ifdef __cplusplus
}
#endif
///\}
/** @} */
#endif

69
src/include/switch_sqlite.h
View File

@ -127,14 +127,6 @@ DoxyDefine(int switch_core_db_bind_blob(sqlite3_stmt*, int, const void*, int n,
* the parameters name. If the same named parameter occurs more than
* once, it is assigned the same index each time.
*
* The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
* sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
* text after SQLite has finished with it. If the fifth argument is the
* special value SQLITE_STATIC, then the library assumes that the information
* is in static, unmanaged space and does not need to be freed. If the
* fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
* own private copy of the data.
*
* The sqlite3_bind_* routine must be called before switch_core_db_step() after
* an switch_core_db_prepare() or sqlite3_reset(). Unbound parameterss are
* interpreted as NULL.
@ -158,14 +150,6 @@ DoxyDefine(int switch_core_db_bind_double(sqlite3_stmt*, int, double);)
* the parameters name. If the same named parameter occurs more than
* once, it is assigned the same index each time.
*
* The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
* sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
* text after SQLite has finished with it. If the fifth argument is the
* special value SQLITE_STATIC, then the library assumes that the information
* is in static, unmanaged space and does not need to be freed. If the
* fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
* own private copy of the data.
*
* The sqlite3_bind_* routine must be called before switch_core_db_step() after
* an switch_core_db_prepare() or sqlite3_reset(). Unbound parameterss are
* interpreted as NULL.
@ -189,14 +173,6 @@ DoxyDefine(int switch_core_db_bind_int(sqlite3_stmt*, int, int);)
* the parameters name. If the same named parameter occurs more than
* once, it is assigned the same index each time.
*
* The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
* sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
* text after SQLite has finished with it. If the fifth argument is the
* special value SQLITE_STATIC, then the library assumes that the information
* is in static, unmanaged space and does not need to be freed. If the
* fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
* own private copy of the data.
*
* The sqlite3_bind_* routine must be called before switch_core_db_step() after
* an switch_core_db_prepare() or sqlite3_reset(). Unbound parameterss are
* interpreted as NULL.
@ -220,14 +196,6 @@ DoxyDefine(int switch_core_db_bind_int64(sqlite3_stmt*, int, sqlite_int64);)
* the parameters name. If the same named parameter occurs more than
* once, it is assigned the same index each time.
*
* The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
* sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
* text after SQLite has finished with it. If the fifth argument is the
* special value SQLITE_STATIC, then the library assumes that the information
* is in static, unmanaged space and does not need to be freed. If the
* fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
* own private copy of the data.
*
* The sqlite3_bind_* routine must be called before switch_core_db_step() after
* an switch_core_db_prepare() or sqlite3_reset(). Unbound parameterss are
* interpreted as NULL.
@ -313,14 +281,6 @@ DoxyDefine(int switch_core_db_bind_text16(sqlite3_stmt*, int, const void*, int,
* the parameters name. If the same named parameter occurs more than
* once, it is assigned the same index each time.
*
* The fifth parameter to sqlite3_bind_blob(), sqlite3_bind_text(), and
* sqlite3_bind_text16() is a destructor used to dispose of the BLOB or
* text after SQLite has finished with it. If the fifth argument is the
* special value SQLITE_STATIC, then the library assumes that the information
* is in static, unmanaged space and does not need to be freed. If the
* fifth argument has the value SQLITE_TRANSIENT, then SQLite makes its
* own private copy of the data.
*
* The sqlite3_bind_* routine must be called before switch_core_db_step() after
* an switch_core_db_prepare() or sqlite3_reset(). Unbound parameterss are
* interpreted as NULL.
@ -329,22 +289,23 @@ DoxyDefine(int switch_core_db_bind_value(sqlite3_stmt*, int, const sqlite3_value
#define switch_core_db_bind_value sqlite3_bind_value
/**
* Return the number of parameters in a compiled SQL statement. This
* routine was added to support DBD::SQLite.
* @return The number of parameters in a compiled SQL statement.
* @remark This routine was added to support DBD::SQLite.
*/
DoxyDefine(int switch_core_db_bind_parameter_count(sqlite3_stmt*);)
#define switch_core_db_bind_parameter_count sqlite3_bind_parameter_count
/**
* Return the index of a parameter with the given name. The name
* must match exactly. If no parameter with the given name is found,
* return 0.
* @return the index of a parameter with the given name. If no parameter with the
* given name is found, return 0.
* @remark The name must match exactly.
*/
DoxyDefine(int switch_core_db_bind_parameter_index(sqlite3_stmt*, const char *zName);)
#define switch_core_db_bind_parameter_index sqlite3_bind_parameter_index
/**
* Return the name of the i-th parameter. Ordinary parameters "?" are
* @return the name of the i-th parameter.
* @remark Ordinary parameters "?" are
* nameless and a NULL is returned. For parameters of the form :AAA or
* $VVV the complete text of the parameter name is returned, including
* the initial ":" or "$". NULL is returned if the index is out of range.
@ -455,14 +416,16 @@ DoxyDefine(int switch_core_db_collation_needed(
/**
* The next group of routines returns information about the information
* in a single column of the current result row of a query. In every
* case the first parameter is a pointer to the SQL statement that is being
* executed (the sqlite_stmt* that was returned from switch_core_db_prepare()) and
* the second argument is the index of the column for which information
* in a single column of the current result row of a query.
*
* @param stmt a pointer to the SQL statement that is being
* executed (the sqlite_stmt* that was returned from switch_core_db_prepare())
*
* @param iCol the index of the column for which information
* should be returned. iCol is zero-indexed. The left-most column as an
* index of 0.
*
* If the SQL statement is not currently point to a valid row, or if the
* @remark If the SQL statement is not currently point to a valid row, or if the
* the colulmn index is out of range, the result is undefined.
*
* These routines attempt to convert the value where appropriate. For
@ -490,9 +453,9 @@ DoxyDefine(int switch_core_db_collation_needed(
* BLOB FLOAT Convert to TEXT then use atof()
* BLOB TEXT Add a "\000" terminator if needed
*
* Return the value of a BLOB.
* @return the value of a BLOB.
*/
DoxyDefine(const void *switch_core_db_column_blob(sqlite3_stmt*, int iCol);)
DoxyDefine(const void *switch_core_db_column_blob(sqlite3_stmt *stmt, int iCol);)
#define switch_core_db_column_blob sqlite3_column_blob
/**