[asterisk-commits] lathama: trunk r373384 - in /trunk: ./ addons/ apps/ cel/ channels/ codecs/sp...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Sat Sep 22 15:43:35 CDT 2012
Author: lathama
Date: Sat Sep 22 15:43:30 2012
New Revision: 373384
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373384
Log:
Doxygen Updates Janitor Work
* Whitespace, doc-blocks, spelling, case, missing and incorrect tags.
* Add cleanup to Makefile for the Doxygen configuration update
* Start updating Doxygen configuration for cleaner output
* Enable inclusion of configuration files into documentation
* remove mantisworkflow...
* update documentation README
* Add markup to Tilghman's email and talk with him about updating his email, he knows...
* no code changes on this commit other than the mentioned Makefile change
(issue ASTERISK-20259)
Removed:
trunk/include/asterisk/doxygen/mantisworkflow.h
Modified:
trunk/Makefile
trunk/addons/chan_mobile.c
trunk/apps/app_minivm.c
trunk/apps/app_queue.c
trunk/apps/app_voicemail.c
trunk/cel/cel_odbc.c
trunk/cel/cel_sqlite3_custom.c
trunk/channels/chan_agent.c
trunk/channels/chan_mgcp.c
trunk/channels/chan_sip.c
trunk/codecs/speex/speex_resampler.h
trunk/contrib/asterisk-ng-doxygen
trunk/doc/README.txt
trunk/include/asterisk/doxyref.h
trunk/include/asterisk/format.h
trunk/include/asterisk/pbx.h
trunk/include/asterisk/xmpp.h
trunk/main/asterisk.c
trunk/main/astfd.c
trunk/main/audiohook.c
trunk/main/ccss.c
trunk/main/manager.c
trunk/main/pbx.c
trunk/main/xmldoc.c
trunk/res/res_config_pgsql.c
trunk/res/res_config_sqlite.c
trunk/res/res_timing_kqueue.c
trunk/tests/test_gosub.c
trunk/utils/refcounter.c
Modified: trunk/Makefile
URL: http://svnview.digium.com/svn/asterisk/trunk/Makefile?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/Makefile (original)
+++ trunk/Makefile Sat Sep 22 15:43:30 2012
@@ -746,6 +746,7 @@
doxygen -u contrib/asterisk-ng-doxygen
(cat contrib/asterisk-ng-doxygen; echo "HAVE_DOT=$(HAVEDOT)"; \
echo "PROJECT_NUMBER=$(ASTERISKVERSION)") | doxygen -
+ rm -f contrib/asterisk-ng-doxygen.bak
install-logrotate:
if [ ! -d "$(DESTDIR)$(ASTETCDIR)/../logrotate.d" ]; then \
Modified: trunk/addons/chan_mobile.c
URL: http://svnview.digium.com/svn/asterisk/trunk/addons/chan_mobile.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/addons/chan_mobile.c (original)
+++ trunk/addons/chan_mobile.c Sat Sep 22 15:43:30 2012
@@ -1524,8 +1524,8 @@
}
/*!
- * \brief Read until '\r\n'.
- * This function consumes the '\r\n' but does not add it to buf.
+ * \brief Read until \verbatim '\r\n'. \endverbatim
+ * This function consumes the \verbatim'\r\n'\endverbatim but does not add it to buf.
*/
static int rfcomm_read_until_crlf(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1552,7 +1552,7 @@
/*!
* \brief Read the remainder of an AT SMS prompt.
- * \note the entire parsed string is '\r\n> '
+ * \note the entire parsed string is \verbatim '\r\n> ' \endverbatim
*
* By the time this function is executed, only a ' ' is left to read.
*/
@@ -1570,7 +1570,7 @@
}
/*!
- * \brief Read until a \r\nOK\r\n message.
+ * \brief Read until a \verbatim \r\nOK\r\n \endverbatim message.
*/
static int rfcomm_read_until_ok(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1667,7 +1667,7 @@
/*!
* \brief Read the remainder of a +CMGR message.
- * \note the entire parsed string is '+CMGR: ...\r\n...\r\n...\r\n...\r\nOK\r\n'
+ * \note the entire parsed string is \verbatim '+CMGR: ...\r\n...\r\n...\r\n...\r\nOK\r\n' \endverbatim
*/
static int rfcomm_read_cmgr(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1686,7 +1686,7 @@
/*!
* \brief Read and AT result code.
- * \note the entire parsed string is '\r\n<result code>\r\n'
+ * \note the entire parsed string is \verbatim '\r\n<result code>\r\n' \endverbatim
*/
static int rfcomm_read_result(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1724,7 +1724,7 @@
/*!
* \brief Read the remainder of an AT command.
- * \note the entire parsed string is '<at command>\r'
+ * \note the entire parsed string is \verbatim '<at command>\r' \endverbatim
*/
static int rfcomm_read_command(int rsock, char **buf, size_t count, size_t *in_count)
{
@@ -1758,8 +1758,8 @@
* \endverbatim
*
* These formats correspond to AT result codes, AT commands, and the AT SMS
- * prompt respectively. When messages are read the leading and trailing '\r'
- * and '\n' characters are discarded. If the given buffer is not large enough
+ * prompt respectively. When messages are read the leading and trailing \verbatim '\r' \endverbatim
+ * and \verbatim '\n' \endverbatim characters are discarded. If the given buffer is not large enough
* to hold the response, what does not fit in the buffer will be dropped.
*
* \note The rfcomm connection to the device is asynchronous, so there is no
@@ -2132,7 +2132,7 @@
* \brief Parse a CLIP event.
* \param hfp an hfp_pvt struct
* \param buf the buffer to parse (null terminated)
- * @note buf will be modified when the CID string is parsed
+ * \note buf will be modified when the CID string is parsed
* \return NULL on error (parse error) or a pointer to the caller id
* information in buf
*/
@@ -2178,7 +2178,7 @@
* \brief Parse a CMTI notification.
* \param hfp an hfp_pvt struct
* \param buf the buffer to parse (null terminated)
- * @note buf will be modified when the CMTI message is parsed
+ * \note buf will be modified when the CMTI message is parsed
* \return -1 on error (parse error) or the index of the new sms message
*/
static int hfp_parse_cmti(struct hfp_pvt *hfp, char *buf)
@@ -2203,7 +2203,7 @@
* \param from_number a pointer to a char pointer which will store the from
* number
* \param text a pointer to a char pointer which will store the message text
- * @note buf will be modified when the CMGR message is parsed
+ * \note buf will be modified when the CMGR message is parsed
* \retval -1 parse error
* \retval 0 success
*/
@@ -2266,7 +2266,7 @@
* \brief Parse a CUSD answer.
* \param hfp an hfp_pvt struct
* \param buf the buffer to parse (null terminated)
- * @note buf will be modified when the CUSD string is parsed
+ * \note buf will be modified when the CUSD string is parsed
* \return NULL on error (parse error) or a pointer to the cusd message
* information in buf
*/
Modified: trunk/apps/app_minivm.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_minivm.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/apps/app_minivm.c (original)
+++ trunk/apps/app_minivm.c Sat Sep 22 15:43:30 2012
@@ -26,7 +26,6 @@
* based on the Comedian Mail voicemail system (app_voicemail.c).
*
* \par See also
- * \arg \ref Config_minivm
* \arg \ref Config_minivm_examples
* \arg \ref App_minivm
*
Modified: trunk/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_queue.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/apps/app_queue.c (original)
+++ trunk/apps/app_queue.c Sat Sep 22 15:43:30 2012
@@ -5799,8 +5799,9 @@
/*! \brief Dump all members in a specific queue to the database
- *
+ * \code
* <pm_family>/<queuename> = <interface>;<penalty>;<paused>;<state_interface>[|...]
+ * \endcode
*/
static void dump_queue_members(struct call_queue *pm_queue)
{
Modified: trunk/apps/app_voicemail.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_voicemail.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/apps/app_voicemail.c (original)
+++ trunk/apps/app_voicemail.c Sat Sep 22 15:43:30 2012
@@ -21,18 +21,18 @@
* \author Mark Spencer <markster at digium.com>
* \brief Comedian Mail - Voicemail System
*
- * \extref unixODBC (http://www.unixodbc.org/)
- * \extref A source distribution of University of Washington's IMAP c-client
+ * unixODBC (http://www.unixodbc.org/)
+ * A source distribution of University of Washington's IMAP c-client
* (http://www.washington.edu/imap/)
*
* \par See also
* \arg \ref Config_vm
* \note For information about voicemail IMAP storage, https://wiki.asterisk.org/wiki/display/AST/IMAP+Voicemail+Storage
- * \ingroup applications
- * \note This module requires res_adsi to load. This needs to be optional
+ * \ingroup applications
+ * \todo This module requires res_adsi to load. This needs to be optional
* during compilation.
*
- * \note This file is now almost impossible to work with, due to all \#ifdefs.
+ * \todo This file is now almost impossible to work with, due to all \#ifdefs.
* Feels like the database code before realtime. Someone - please come up
* with a plan to clean this up.
*/
@@ -1053,7 +1053,7 @@
*
* \note the "move" parameter is only honored for IMAP voicemail presently
* \retval 0 Success
- * \revval other Failure
+ * \retval other Failure
*/
static int save_to_folder(struct ast_vm_user *vmu, struct vm_state *vms, int msg, int box, int *newmsg, int move);
@@ -4804,7 +4804,7 @@
* \param chan
* \param category
* \param imap if == 1, indicates the target folder for the email notification to be sent to will be an IMAP mailstore. This causes additional mailbox headers to be set, which would facilitate searching for the email in the destination IMAP folder.
- * \param flag
+ * \param flag, msg_id
*
* The email body, and base 64 encoded attachement (if any) are stored to the file identified by *p. This method does not actually send the email. That is done by invoking the configure 'mailcmd' and piping this generated file into it, or with the sendemail() function.
*/
@@ -5630,7 +5630,7 @@
* \param recip
* \param fmt
* \param dir
- * \param flag
+ * \param flag, dest_folder
*
* This is only used by file storage based mailboxes.
*
@@ -5746,7 +5746,7 @@
/**
* \brief Determines if the given folder has messages.
- * \param mailbox The @ delimited string for user at context. If no context is found, uses 'default' for the context.
+ * \param mailbox The \@ delimited string for user\@context. If no context is found, uses 'default' for the context.
* \param folder the folder to look in
*
* This function is used when the mailbox is stored in a filesystem back end.
@@ -15089,6 +15089,7 @@
* \param msg_ids An array of message identifiers
* \param num_msgs The number of identifiers in msg_ids
* \param msg_nums [out] The message indexes corresponding to the given
+ * \param vmu
* message IDs
* \pre vms must have open_mailbox() called on it prior to this function.
*
Modified: trunk/cel/cel_odbc.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cel/cel_odbc.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/cel/cel_odbc.c (original)
+++ trunk/cel/cel_odbc.c Sat Sep 22 15:43:30 2012
@@ -22,7 +22,7 @@
*
* \brief ODBC CEL backend
*
- * \author Tilghman Lesher <tlesher AT digium DOT com>
+ * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
* \ingroup cel_drivers
*/
Modified: trunk/cel/cel_sqlite3_custom.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cel/cel_sqlite3_custom.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/cel/cel_sqlite3_custom.c (original)
+++ trunk/cel/cel_sqlite3_custom.c Sat Sep 22 15:43:30 2012
@@ -65,7 +65,9 @@
static sqlite3 *db = NULL;
static char table[80];
-/*! XXX \bug Handling of this var is crash prone on reloads */
+/*!
+ * \bug Handling of this var is crash prone on reloads
+ */
static char *columns;
static struct ast_event_sub *event_sub = NULL;
Modified: trunk/channels/chan_agent.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_agent.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/channels/chan_agent.c (original)
+++ trunk/channels/chan_agent.c Sat Sep 22 15:43:30 2012
@@ -382,7 +382,7 @@
* unrefed once it is no longer needed.
*
* \param pvt Pointer to the LOCKED agent_pvt for which the owner is needed
- * \ref locked channel which owns the pvt at the time of completion. NULL if not available.
+ * locked channel which owns the pvt at the time of completion. NULL if not available.
*/
static struct ast_channel *agent_lock_owner(struct agent_pvt *pvt)
{
Modified: trunk/channels/chan_mgcp.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_mgcp.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/channels/chan_mgcp.c (original)
+++ trunk/channels/chan_mgcp.c Sat Sep 22 15:43:30 2012
@@ -24,7 +24,6 @@
*
* \par See also
* \arg \ref Config_mgcp
- * \arg \ref res_pktccops
*
* \ingroup channel_drivers
*/
Modified: trunk/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_sip.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/channels/chan_sip.c (original)
+++ trunk/channels/chan_sip.c Sat Sep 22 15:43:30 2012
@@ -40,7 +40,7 @@
* \todo Transaction support
*
* ******** Wishlist: Improvements
- * - Support of SIP domains for devices, so that we match on username at domain in the From: header
+ * - Support of SIP domains for devices, so that we match on username\@domain in the From: header
* - Connect registrations with a specific device on the incoming call. It's not done
* automatically in Asterisk
*
@@ -729,7 +729,6 @@
Default setttings are used as a channel setting and as a default when
configuring devices
*/
-/*@{*/
static char default_language[MAX_LANGUAGE]; /*!< Default language setting for new channels */
static char default_callerid[AST_MAX_EXTENSION]; /*!< Default caller ID for sip messages */
static char default_mwi_from[80]; /*!< Default caller ID for MWI updates */
@@ -749,7 +748,6 @@
static char default_zone[MAX_TONEZONE_COUNTRY]; /*!< Default tone zone for channels created from the SIP driver */
static unsigned int default_transports; /*!< Default Transports (enum sip_transport) that are acceptable */
static unsigned int default_primary_transport; /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
-/*@}*/
static struct sip_settings sip_cfg; /*!< SIP configuration data.
\note in the future we could have multiple of these (per domain, per device group etc) */
Modified: trunk/codecs/speex/speex_resampler.h
URL: http://svnview.digium.com/svn/asterisk/trunk/codecs/speex/speex_resampler.h?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/codecs/speex/speex_resampler.h (original)
+++ trunk/codecs/speex/speex_resampler.h Sat Sep 22 15:43:30 2012
@@ -113,14 +113,15 @@
struct SpeexResamplerState_;
typedef struct SpeexResamplerState_ SpeexResamplerState;
-/** Create a new resampler with integer input and output rates.
- * @param nb_channels Number of channels to be processed
- * @param in_rate Input sampling rate (integer number of Hz).
- * @param out_rate Output sampling rate (integer number of Hz).
- * @param quality Resampling quality between 0 and 10, where 0 has poor quality
- * and 10 has very high quality.
- * @return Newly created resampler state
- * @retval NULL Error: not enough memory
+/** \brief Create a new resampler with integer input and output rates.
+ * \param nb_channels Number of channels to be processed
+ * \param in_rate Input sampling rate (integer number of Hz).
+ * \param out_rate Output sampling rate (integer number of Hz).
+ * \param quality Resampling quality between 0 and 10, where 0 has poor quality
+ * and 10 has very high quality.
+ * \param err
+ * \return Newly created resampler state
+ * \retval NULL Error: not enough memory
*/
SpeexResamplerState *speex_resampler_init(spx_uint32_t nb_channels,
spx_uint32_t in_rate,
Modified: trunk/contrib/asterisk-ng-doxygen
URL: http://svnview.digium.com/svn/asterisk/trunk/contrib/asterisk-ng-doxygen?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/contrib/asterisk-ng-doxygen (original)
+++ trunk/contrib/asterisk-ng-doxygen Sat Sep 22 15:43:30 2012
@@ -38,7 +38,7 @@
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = doc/api
+OUTPUT_DIRECTORY = doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -47,7 +47,7 @@
# source files, where putting all generated files in the same directory would
# otherwise cause performance problems for the file system.
-CREATE_SUBDIRS = NO
+CREATE_SUBDIRS = YES
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
@@ -301,7 +301,7 @@
EXTRACT_ALL = YES
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = NO
@@ -548,12 +548,12 @@
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
-WARN_IF_DOC_ERROR = YES
-
-# This WARN_NO_PARAMDOC option can be abled to get warnings for
-# functions that are documented, but have no documentation for their parameters
-# or return value. If set to NO (the default) doxygen will only warn about
-# wrong or incomplete parameter documentation, but not about the absence of
+WARN_IF_DOC_ERROR = NO
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
# documentation.
WARN_NO_PARAMDOC = NO
@@ -571,7 +571,7 @@
# and error messages should be written. If left blank the output is written
# to stderr.
-WARN_LOGFILE =
+WARN_LOGFILE = doxygen.log
#---------------------------------------------------------------------------
# configuration options related to the input files
@@ -582,27 +582,7 @@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ./ \
- agi \
- apps \
- bridges \
- cdr \
- channels \
- channels/sip \
- channels/misdn \
- codecs \
- formats \
- funcs \
- include \
- include/asterisk \
- include/asterisk/doxygen \
- main \
- main/stdtime \
- pbx \
- res \
- res/ael \
- res/ais \
- res/snmp
+INPUT =
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -627,13 +607,16 @@
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
-RECURSIVE = NO
+RECURSIVE = yes
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE =
+EXCLUDE = doc/api \
+ menuselect \
+ res/pjproject \
+ addons/ooh323c/src
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -647,7 +630,9 @@
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = *.o \
+ *.o.d \
+ .*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -677,7 +662,7 @@
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
-EXAMPLE_RECURSIVE = NO
+EXAMPLE_RECURSIVE = YES
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
@@ -805,7 +790,7 @@
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
-HTML_OUTPUT =
+HTML_OUTPUT = api
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
@@ -817,7 +802,7 @@
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
-HTML_HEADER = contrib/asterisk-doxygen-header
+HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
@@ -1244,7 +1229,7 @@
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
-MAN_OUTPUT =
+MAN_OUTPUT =
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
@@ -1373,7 +1358,9 @@
# contain include files that are not input files but should be processed by
# the preprocessor.
-INCLUDE_PATH = include/ include/asterisk/
+INCLUDE_PATH = ./ \
+ include/ \
+ include/asterisk/
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -1390,9 +1377,8 @@
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
-PREDEFINED = \
- __GNUC__ \
- __attribute__(x)=
+PREDEFINED = __GNUC__ \
+ __attribute__(x)=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
Modified: trunk/doc/README.txt
URL: http://svnview.digium.com/svn/asterisk/trunk/doc/README.txt?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/doc/README.txt (original)
+++ trunk/doc/README.txt Sat Sep 22 15:43:30 2012
@@ -1,10 +1,14 @@
The vast majority of the Asterisk project documentation has been moved to the
project wiki:
- http://wiki.asterisk.org/
+ https://wiki.asterisk.org/
Asterisk release tarballs contain an export of the wiki in PDF and plain text
form, which you can find in:
doc/AST.pdf
doc/AST.txt
+
+Asterisk uses the Doxygen documentation software. Run "make progdocs" and open
+the resulting documentation index at doc/api/index.html in a webbrowser or copy
+the directory to a directory served by a webserver for remote access.
Modified: trunk/include/asterisk/doxyref.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxyref.h?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/include/asterisk/doxyref.h (original)
+++ trunk/include/asterisk/doxyref.h Sat Sep 22 15:43:30 2012
@@ -1,7 +1,7 @@
/*
* Asterisk -- An open source telephony toolkit.
*
- * Copyright (C) 1999 - 2009, Digium, Inc.
+ * Copyright (C) 1999 - 2012, Digium, Inc.
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
@@ -17,9 +17,9 @@
/*!
* \file
*
- * This is the main header file used for generating miscellaneous developer
- * documentation using doxygen. This also pulls in all of the documentation
- * that is in include/asterisk/doxygen/.
+ * This is the main header file used for generating miscellaneous documentation
+ * using Doxygen. This also utilizes the documentation in
+ * include/asterisk/doxygen/ header files.
*/
/*
@@ -133,19 +133,19 @@
/*!
* \page AstDebug Debugging
* \section debug Debugging
- * \verbinclude backtrace.txt
+ * \todo include backtrace txt that was removed
*/
/*!
* \page AstSpeech The Generic Speech Recognition API
* \section debug The Generic Speech Recognition API
- * \verbinclude speechrec.txt
+ * \todo include missing speechrec txt
*/
/*!
* \page DataStores Channel Data Stores
* \section debug Channel Data Stores
- * \verbinclude datastores.txt
+ * \todo include missing datastores txt
*/
/*!
@@ -153,7 +153,7 @@
* \section ami AMI - The manager Interface
* \arg \link Config_ami Configuration file \endlink
* \arg \ref manager.c
- * \verbinclude manager.txt
+ * \todo include missing manager txt
*/
/*!
@@ -161,8 +161,8 @@
* \section realtime ARA - a generic API to storage and retrieval
* Implemented in \ref config.c
* Implemented in \ref pbx_realtime.c
- * \verbinclude realtime.txt
- * \verbinclude extconfig.txt
+ * \todo include missing realtime txt
+ * \todo include missing extconfig txt
*/
/*!
@@ -191,7 +191,7 @@
* \arg \ref cdr_drivers
* \arg \ref Config_cdr CDR configuration files
*
- * \verbinclude cdrdriver.txt
+ * \todo include missing cdrdriver txt
*/
/*!
@@ -207,7 +207,7 @@
/*!
* \page AstVideo Video support in Asterisk
* \section sectAstVideo Video support in Asterisk
- * \verbinclude video.txt
+ * \todo include missing video txt
*/
/*!
@@ -486,7 +486,7 @@
* \par See also
* \arg \ref cdrconf
* \arg Implemented in \ref cdr_csv.c
- * \verbinclude cdr_csv.conf.sample
+ * \verbinclude cdr.conf.sample
*/
/*!
@@ -517,8 +517,7 @@
/*!
* \page cdr_odbc Adaptive ODBC CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg Implemented in \ref cdr_adaptive_odbc.c
+ * \li See also \ref cdrconf
* \verbinclude cdr_adaptive_odbc.conf.sample
* See also:
* \arg http://www.unixodbc.org
@@ -531,13 +530,6 @@
* See also:
* \arg http://www.postgresql.org
* \verbinclude cdr_pgsql.conf.sample
- */
-
-/*!
- * \page cdr_radius RADIUS CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg Implemented in \ref cdr_radius.c
- * \verbinclude cdr_radius.conf.sample
*/
/*!
@@ -649,6 +641,28 @@
*/
/*!
+ * \page AstHTTP AMI over HTTP support
+ * The http.c file includes support for manager transactions over
+ * http.
+ * \section ami AMI - The manager Interface
+ * \arg \link Config_ami Configuration file \endlink
+ */
+
+/*!
+ * \page res_config_sqlite SQLite Resource driver configuration
+ * \arg Implemented in \ref res_config_sqlite.c
+ * \arg Configuration file:
+ * \verbinclude res_config_sqlite.conf
+ * \arg SQL tables:
+ * \arg See also:
+ * http://www.sqlite.org
+ */
+
+/*
+ * Doxygen Groups
+ */
+
+/*!
* \addtogroup cdr_drivers Module: CDR Drivers
* \section CDR_generic Asterisk CDR Drivers
* \brief CDR drivers are loaded dynamically, each loaded CDR driver produce
@@ -656,7 +670,6 @@
* \arg \ref Config_mod "Modules Configuration"
* \arg \ref Config_cdr "CDR Configuration"
*/
-
/*!
* \addtogroup channel_drivers Module: Asterisk Channel Drivers
@@ -705,23 +718,3 @@
* \addtogroup rtp_engines Module: RTP Engines
* \section rtp_engine_blah Asterisk RTP Engines
*/
-
-/*!
- * \page AstHTTP AMI over HTTP support
- * The http.c file includes support for manager transactions over
- * http.
- * \section ami AMI - The manager Interface
- * \arg \link Config_ami Configuration file \endlink
- */
-
-/*!
- * \page res_config_sqlite SQLite Resource driver configuration
- * \arg Implemented in \ref res_config_sqlite.c
- * \arg Configuration file:
- * \verbinclude res_config_sqlite.conf
- * \arg SQL tables:
- * \arg See also:
- * http://www.sqlite.org
- */
-
-
Modified: trunk/include/asterisk/format.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/format.h?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/include/asterisk/format.h (original)
+++ trunk/include/asterisk/format.h Sat Sep 22 15:43:30 2012
@@ -265,7 +265,7 @@
*
* \param format to set
* \param id format id to set on format
- * \param set_attributes, are there attributes to set on this format. 0 == false, 1 == True.
+ * \param set_attributes are there attributes to set on this format. 0 == false, 1 == True.
* \param ... var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
*
* \details Example usage.
Modified: trunk/include/asterisk/pbx.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/pbx.h?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/include/asterisk/pbx.h (original)
+++ trunk/include/asterisk/pbx.h Sat Sep 22 15:43:30 2012
@@ -821,7 +821,7 @@
* \brief Add a context include
*
* \param con context to add the include to
- * \param value include include to add
+ * \param value include value to add
* \param registrar who registered the context
*
* Adds an include taking a struct ast_context as the first parameter
Modified: trunk/include/asterisk/xmpp.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/xmpp.h?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/include/asterisk/xmpp.h (original)
+++ trunk/include/asterisk/xmpp.h Sat Sep 22 15:43:30 2012
@@ -234,7 +234,7 @@
*
* \param client Pointer to the client
* \param nickname Nickname to use
- * \param Address Address of the room
+ * \param address Address of the room
* \param message Message itself
*
* \retval 0 on success
Modified: trunk/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/asterisk.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/asterisk.c (original)
+++ trunk/main/asterisk.c Sat Sep 22 15:43:30 2012
@@ -121,7 +121,8 @@
#endif /* HAVE_CAP */
#endif /* linux */
-#include "asterisk/paths.h" /* we define here the variables so better agree on the prototype */
+/* we define here the variables so to better agree on the prototype */
+#include "asterisk/paths.h"
#include "asterisk/network.h"
#include "asterisk/cli.h"
#include "asterisk/channel.h"
@@ -410,8 +411,6 @@
return iterator->version;
return NULL;
}
-
-
struct thread_list_t {
AST_RWLIST_ENTRY(thread_list_t) list;
Modified: trunk/main/astfd.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/astfd.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/astfd.c (original)
+++ trunk/main/astfd.c Sat Sep 22 15:43:30 2012
@@ -20,7 +20,7 @@
*
* \brief Debugging routines for file descriptor leaks
*
- * \author Tilghman Lesher <tlesher at digium.com>
+ * \author Tilghman Lesher \verbatim <tlesher at digium.com> \endverbatim
*/
/*** MODULEINFO
Modified: trunk/main/audiohook.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/audiohook.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/audiohook.c (original)
+++ trunk/main/audiohook.c Sat Sep 22 15:43:30 2012
@@ -97,9 +97,11 @@
}
/*! \brief Initialize an audiohook structure
+ *
* \param audiohook Audiohook structure
* \param type
- * \param init, source, init_flags
+ * \param source, init_flags
+ *
* \return Returns 0 on success, -1 on failure
*/
int ast_audiohook_init(struct ast_audiohook *audiohook, enum ast_audiohook_type type, const char *source, enum ast_audiohook_init_flags init_flags)
Modified: trunk/main/ccss.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/ccss.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/ccss.c (original)
+++ trunk/main/ccss.c Sat Sep 22 15:43:30 2012
@@ -565,7 +565,7 @@
};
/*!
- * \intenral
+ * \internal
* \brief lookup the ast_device_state mapped to cc_state
*
* \param state
Modified: trunk/main/manager.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/manager.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/manager.c (original)
+++ trunk/main/manager.c Sat Sep 22 15:43:30 2012
@@ -1112,7 +1112,7 @@
int authenticated; /*!< Authentication status */
int readperm; /*!< Authorization for reading */
int writeperm; /*!< Authorization for writing */
- char inbuf[1025]; /*!< Buffer - we use the extra byte to add a '\0' and simplify parsing */
+ char inbuf[1025]; /*!< Buffer - we use the extra byte to add a '\\0' and simplify parsing */
int inlen; /*!< number of buffered bytes */
struct ao2_container *whitefilters; /*!< Manager event filters - white list */
struct ao2_container *blackfilters; /*!< Manager event filters - black list */
Modified: trunk/main/pbx.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/pbx.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/pbx.c (original)
+++ trunk/main/pbx.c Sat Sep 22 15:43:30 2012
@@ -8799,7 +8799,7 @@
};
/*! /brief Build timing
*
- * /param i, info
+ * /param i info
* /param info_in
*
*/
Modified: trunk/main/xmldoc.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/xmldoc.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/main/xmldoc.c (original)
+++ trunk/main/xmldoc.c Sat Sep 22 15:43:30 2012
@@ -2014,13 +2014,14 @@
}
/*!
- * \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
- * \param type Type of element (application, function, ...).
- * \param name Name of element (Dial, Echo, Playback, ...).
- * \param var Name of field to return (synopsis, description, etc).
- * \param raw Field only contains text, no other elements inside it.
- * \retval NULL On error.
- * \retval Field text content on success.
+ * \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
+ * \param type Type of element (application, function, ...).
+ * \param name Name of element (Dial, Echo, Playback, ...).
+ * \param var Name of field to return (synopsis, description, etc).
+ * \param module
+ * \param raw Field only contains text, no other elements inside it.
+ * \retval NULL On error.
+ * \retval Field text content on success.
*/
static char *xmldoc_build_field(const char *type, const char *name, const char *module, const char *var, int raw)
{
Modified: trunk/res/res_config_pgsql.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_config_pgsql.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/res/res_config_pgsql.c (original)
+++ trunk/res/res_config_pgsql.c Sat Sep 22 15:43:30 2012
@@ -139,7 +139,7 @@
* \return -2 on query failure that resulted in disconnection
* \return 0 on success
*
- * \example see pgsql_exec for full example
+ * \note see pgsql_exec for full example
*/
static int _pgsql_exec(const char *database, const char *tablename, const char *sql, PGresult **result)
{
Modified: trunk/res/res_config_sqlite.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_config_sqlite.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/res/res_config_sqlite.c (original)
+++ trunk/res/res_config_sqlite.c Sat Sep 22 15:43:30 2012
@@ -36,7 +36,7 @@
*
* \section conf_sec Configuration
*
- * The main configuration file is res_config_sqlite.conf. It must be readable or
+ * The main configuration file is res_config_sqlite.conf.sample It must be readable or
* res_config_sqlite will fail to start. It is suggested to use the sample file
* in this package as a starting point. The file has only one section
* named <code>general</code>. Here are the supported parameters :
Modified: trunk/res/res_timing_kqueue.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_timing_kqueue.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/res/res_timing_kqueue.c (original)
+++ trunk/res/res_timing_kqueue.c Sat Sep 22 15:43:30 2012
@@ -18,7 +18,7 @@
/*!
* \file
- * \author Tilghman Lesher <tlesher AT digium DOT com>
+ * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
*
* \brief kqueue timing interface
*/
Modified: trunk/tests/test_gosub.c
URL: http://svnview.digium.com/svn/asterisk/trunk/tests/test_gosub.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/tests/test_gosub.c (original)
+++ trunk/tests/test_gosub.c Sat Sep 22 15:43:30 2012
@@ -20,7 +20,7 @@
* \file
* \brief Gosub tests
*
- * \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
+ * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
*
* \ingroup tests
*/
Modified: trunk/utils/refcounter.c
URL: http://svnview.digium.com/svn/asterisk/trunk/utils/refcounter.c?view=diff&rev=373384&r1=373383&r2=373384
==============================================================================
--- trunk/utils/refcounter.c (original)
+++ trunk/utils/refcounter.c Sat Sep 22 15:43:30 2012
@@ -15,9 +15,10 @@
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
+
/*! \file
*
- * \brief A program to read in the /tmp/refs file generated
+ * \brief A program to read in the /tmp/refs file generated
* by astobj2 code when the REF_DEBUG macro is defined.
* It will read in the file line by line, and
* sort the data out by object, and check to see
@@ -28,15 +29,15 @@
* this program reads in the /tmp/refs file and
* generates no output. No news is good news.
* The contents of the /tmp/refs file looks like this:
- *
-0x84fd718 -1 astobj2.c:926:cd_cb_debug (deref object via container destroy) [@1]
[... 20 lines stripped ...]
More information about the asterisk-commits
mailing list