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