[svn-commits] lathama: branch lathama/doxygencleanups r373317 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Fri Sep 21 10:28:12 CDT 2012
Author: lathama
Date: Fri Sep 21 10:28:01 2012
New Revision: 373317
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373317
Log:
Start pushing my local changes up for the development cycle. Doxygen config is specific to my testing.
(issue ASTERISK-20259)
Modified:
team/lathama/doxygencleanups/Makefile
team/lathama/doxygencleanups/apps/app_confbridge.c
team/lathama/doxygencleanups/apps/app_ices.c
team/lathama/doxygencleanups/apps/app_meetme.c
team/lathama/doxygencleanups/apps/app_skel.c
team/lathama/doxygencleanups/cdr/cdr_pgsql.c
team/lathama/doxygencleanups/cdr/cdr_radius.c
team/lathama/doxygencleanups/cdr/cdr_sqlite.c
team/lathama/doxygencleanups/cel/cel_pgsql.c
team/lathama/doxygencleanups/cel/cel_radius.c
team/lathama/doxygencleanups/channels/chan_console.c
team/lathama/doxygencleanups/channels/chan_h323.c
team/lathama/doxygencleanups/channels/chan_jingle.c
team/lathama/doxygencleanups/channels/chan_mgcp.c
team/lathama/doxygencleanups/channels/chan_misdn.c
team/lathama/doxygencleanups/channels/chan_motif.c
team/lathama/doxygencleanups/channels/sip/include/sdp_crypto.h
team/lathama/doxygencleanups/channels/sip/reqresp_parser.c
team/lathama/doxygencleanups/codecs/codec_speex.c
team/lathama/doxygencleanups/contrib/asterisk-doxygen-header
team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
team/lathama/doxygencleanups/funcs/func_speex.c
team/lathama/doxygencleanups/include/asterisk/acl.h
team/lathama/doxygencleanups/include/asterisk/agi.h
team/lathama/doxygencleanups/include/asterisk/app.h
team/lathama/doxygencleanups/include/asterisk/bridging_features.h
team/lathama/doxygencleanups/include/asterisk/doxygen/architecture.h
team/lathama/doxygencleanups/include/asterisk/doxygen/asterisk-git-howto.h
team/lathama/doxygencleanups/include/asterisk/doxygen/commits.h
team/lathama/doxygencleanups/include/asterisk/doxygen/mantisworkflow.h
team/lathama/doxygencleanups/include/asterisk/doxygen/releases.h
team/lathama/doxygencleanups/include/asterisk/doxygen/reviewboard.h
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/include/asterisk/jabber.h
team/lathama/doxygencleanups/include/asterisk/localtime.h
team/lathama/doxygencleanups/include/asterisk/res_odbc.h
team/lathama/doxygencleanups/include/asterisk/sip_api.h
team/lathama/doxygencleanups/include/asterisk/time.h
team/lathama/doxygencleanups/include/asterisk/xmpp.h
team/lathama/doxygencleanups/main/acl.c
team/lathama/doxygencleanups/main/ast_expr2f.c
team/lathama/doxygencleanups/main/asterisk.c
team/lathama/doxygencleanups/main/ccss.c
team/lathama/doxygencleanups/main/http.c
team/lathama/doxygencleanups/main/manager.c
team/lathama/doxygencleanups/main/sha1.c
team/lathama/doxygencleanups/main/strings.c
team/lathama/doxygencleanups/main/tdd.c
team/lathama/doxygencleanups/main/xmldoc.c
team/lathama/doxygencleanups/res/res_config_curl.c
team/lathama/doxygencleanups/res/res_config_ldap.c
team/lathama/doxygencleanups/res/res_config_pgsql.c
team/lathama/doxygencleanups/res/res_crypto.c
team/lathama/doxygencleanups/res/res_curl.c
team/lathama/doxygencleanups/res/res_jabber.c
team/lathama/doxygencleanups/res/res_smdi.c
team/lathama/doxygencleanups/res/res_snmp.c
team/lathama/doxygencleanups/res/res_timing_kqueue.c
team/lathama/doxygencleanups/res/res_xmpp.c
Modified: team/lathama/doxygencleanups/Makefile
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/Makefile?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/Makefile (original)
+++ team/lathama/doxygencleanups/Makefile Fri Sep 21 10:28:01 2012
@@ -446,7 +446,7 @@
rm -rf autom4te.cache
rm -f include/asterisk/autoconfig.h
rm -f include/asterisk/buildopts.h
- rm -rf doc/api
+ rm -rf doc/doxygen
rm -f build_tools/menuselect-deps
datafiles: _cleantest_all doc/core-en_US.xml
Modified: team/lathama/doxygencleanups/apps/app_confbridge.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_confbridge.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/apps/app_confbridge.c (original)
+++ team/lathama/doxygencleanups/apps/app_confbridge.c Fri Sep 21 10:28:01 2012
@@ -621,7 +621,7 @@
* \brief Announce number of users in the conference bridge to the caller
*
* \param conference_bridge Conference bridge to peek at
- * \param (OPTIONAL) conference_bridge_user Caller
+ * \param conference_bridge_user Optional Caller
*
* \note if caller is NULL, the announcment will be sent to all participants in the conference.
* \return Returns 0 on success, -1 if the user hung up
@@ -1258,7 +1258,7 @@
* \brief Play number into the conference bridge
*
* \param conference_bridge The conference bridge to say the number into
- * \param number to say
+ * \param say_number number to say
*
* \retval 0 success
* \retval -1 failure
Modified: team/lathama/doxygencleanups/apps/app_ices.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_ices.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/apps/app_ices.c (original)
+++ team/lathama/doxygencleanups/apps/app_ices.c Fri Sep 21 10:28:01 2012
@@ -22,7 +22,7 @@
*
* \author Mark Spencer <markster at digium.com>
*
- * \extref ICES - http://www.icecast.org/ices.php
+ * ICES - http://www.icecast.org/ices.php
*
* \ingroup applications
*/
Modified: team/lathama/doxygencleanups/apps/app_meetme.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_meetme.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/apps/app_meetme.c (original)
+++ team/lathama/doxygencleanups/apps/app_meetme.c Fri Sep 21 10:28:01 2012
@@ -1217,6 +1217,7 @@
* \param dynamic Mark the newly created conference as dynamic
* \param refcount How many references to mark on the conference
* \param chan The asterisk channel
+ * \param test
*
* \return A pointer to the conference struct, or NULL if it wasn't found and
* make or dynamic were not set.
Modified: team/lathama/doxygencleanups/apps/app_skel.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_skel.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/apps/app_skel.c (original)
+++ team/lathama/doxygencleanups/apps/app_skel.c Fri Sep 21 10:28:01 2012
@@ -178,7 +178,7 @@
* internally by the Config Options code to check if an level has already been added to the
* container that will be swapped for the live container on a successul reload.
*
- * \param container A non-active container to search for a level
+ * \param tmp_container A non-active container to search for a level
* \param category The category associated with the level to check for
* \retval non-NULL The level from the container
* \retval NULL The level does not exist in the container
@@ -648,6 +648,14 @@
return ast_unregister_application(app);
}
+/*!
+ * \brief Load the module
+ *
+ * \par The configuration file
+ *
+ * The application app_skel uses a configuration file.
+ * \verbinclude app_skel.conf.sample
+ */
static int load_module(void)
{
if (aco_info_init(&cfg_info)) {
Modified: team/lathama/doxygencleanups/cdr/cdr_pgsql.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/cdr/cdr_pgsql.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/cdr/cdr_pgsql.c (original)
+++ team/lathama/doxygencleanups/cdr/cdr_pgsql.c Fri Sep 21 10:28:01 2012
@@ -25,11 +25,11 @@
* \brief PostgreSQL CDR logger
*
* \author Matthew D. Hardeman <mhardemn at papersoft.com>
- * \extref PostgreSQL http://www.postgresql.org/
+ * PostgreSQL http://www.postgresql.org/
*
* See also
* \arg \ref Config_cdr
- * \extref PostgreSQL http://www.postgresql.org/
+ * PostgreSQL http://www.postgresql.org/
* \ingroup cdr_drivers
*/
Modified: team/lathama/doxygencleanups/cdr/cdr_radius.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/cdr/cdr_radius.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/cdr/cdr_radius.c (original)
+++ team/lathama/doxygencleanups/cdr/cdr_radius.c Fri Sep 21 10:28:01 2012
@@ -21,7 +21,8 @@
* \brief RADIUS CDR Support
*
* \author Philippe Sultan
- * \extref The Radius Client Library - http://developer.berlios.de/projects/radiusclient-ng/
+ * The Radius Client Library
+ * http://developer.berlios.de/projects/radiusclient-ng/
*
* \arg See also \ref AstCDR
* \ingroup cdr_drivers
@@ -187,7 +188,8 @@
}
/* Setting Acct-Session-Id & User-Name attributes for proper generation
- of Acct-Unique-Session-Id on server side */
+ * of Acct-Unique-Session-Id on server side
+ */
/* Channel */
if (!rc_avpair_add(rh, tosend, PW_USER_NAME, &cdr->channel, strlen(cdr->channel), 0))
return -1;
Modified: team/lathama/doxygencleanups/cdr/cdr_sqlite.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/cdr/cdr_sqlite.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/cdr/cdr_sqlite.c (original)
+++ team/lathama/doxygencleanups/cdr/cdr_sqlite.c Fri Sep 21 10:28:01 2012
@@ -22,7 +22,7 @@
* \brief Store CDR records in a SQLite database.
*
* \author Holger Schurig <hs4233 at mail.mn-solutions.de>
- * \extref SQLite http://www.sqlite.org/
+ * SQLite http://www.sqlite.org/
*
* See also
* \arg \ref Config_cdr
Modified: team/lathama/doxygencleanups/cel/cel_pgsql.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/cel/cel_pgsql.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/cel/cel_pgsql.c (original)
+++ team/lathama/doxygencleanups/cel/cel_pgsql.c Fri Sep 21 10:28:01 2012
@@ -29,11 +29,11 @@
* \brief PostgreSQL CEL logger
*
* \author Steve Murphy <murf at digium.com>
- * \extref PostgreSQL http://www.postgresql.org/
+ * PostgreSQL http://www.postgresql.org/
*
* See also
* \arg \ref Config_cel
- * \extref PostgreSQL http://www.postgresql.org/
+ * PostgreSQL http://www.postgresql.org/
* \ingroup cel_drivers
*/
Modified: team/lathama/doxygencleanups/cel/cel_radius.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/cel/cel_radius.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/cel/cel_radius.c (original)
+++ team/lathama/doxygencleanups/cel/cel_radius.c Fri Sep 21 10:28:01 2012
@@ -20,7 +20,7 @@
*
* \brief RADIUS CEL Support
* \author Philippe Sultan
- * \extref The Radius Client Library - http://developer.berlios.de/projects/radiusclient-ng/
+ * The Radius Client Library - http://developer.berlios.de/projects/radiusclient-ng/
*
* \arg See also \ref AstCEL
* \ingroup cel_drivers
Modified: team/lathama/doxygencleanups/channels/chan_console.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_console.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_console.c (original)
+++ team/lathama/doxygencleanups/channels/chan_console.c Fri Sep 21 10:28:01 2012
@@ -29,7 +29,7 @@
*
* \ingroup channel_drivers
*
- * \extref Portaudio http://www.portaudio.com/
+ * Portaudio http://www.portaudio.com/
*
* To install portaudio v19 from svn, check it out using the following command:
* - svn co https://www.portaudio.com/repos/portaudio/branches/v19-devel
Modified: team/lathama/doxygencleanups/channels/chan_h323.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_h323.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_h323.c (original)
+++ team/lathama/doxygencleanups/channels/chan_h323.c Fri Sep 21 10:28:01 2012
@@ -29,7 +29,7 @@
*
* \par See also
* \arg Config_h323
- * \extref OpenH323 http://www.voxgratia.org/
+ * OpenH323 http://www.voxgratia.org/
*
* \ingroup channel_drivers
*/
Modified: team/lathama/doxygencleanups/channels/chan_jingle.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_jingle.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_jingle.c (original)
+++ team/lathama/doxygencleanups/channels/chan_jingle.c Fri Sep 21 10:28:01 2012
@@ -22,7 +22,7 @@
*
* \brief Jingle Channel Driver
*
- * \extref Iksemel http://iksemel.jabberstudio.org/
+ * Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
*/
Modified: team/lathama/doxygencleanups/channels/chan_mgcp.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_mgcp.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_mgcp.c (original)
+++ team/lathama/doxygencleanups/channels/chan_mgcp.c Fri Sep 21 10:28:01 2012
@@ -24,7 +24,6 @@
*
* \par See also
* \arg \ref Config_mgcp
- * \arg \ref res_pktccops
*
* \ingroup channel_drivers
*/
Modified: team/lathama/doxygencleanups/channels/chan_misdn.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_misdn.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_misdn.c (original)
+++ team/lathama/doxygencleanups/channels/chan_misdn.c Fri Sep 21 10:28:01 2012
@@ -24,7 +24,7 @@
*
* \author Christian Richter <crich at beronet.com>
*
- * \extref MISDN http://www.misdn.org/
+ * MISDN http://www.misdn.org/
*
* \ingroup channel_drivers
*/
Modified: team/lathama/doxygencleanups/channels/chan_motif.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_motif.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_motif.c (original)
+++ team/lathama/doxygencleanups/channels/chan_motif.c Fri Sep 21 10:28:01 2012
@@ -22,7 +22,7 @@
*
* \brief Motif Jingle Channel Driver
*
- * \extref Iksemel http://iksemel.jabberstudio.org/
+ * Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
*/
Modified: team/lathama/doxygencleanups/channels/sip/include/sdp_crypto.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/sip/include/sdp_crypto.h?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/sip/include/sdp_crypto.h (original)
+++ team/lathama/doxygencleanups/channels/sip/include/sdp_crypto.h Fri Sep 21 10:28:01 2012
@@ -65,7 +65,8 @@
* \details
* The offer is stored on the sdp_crypto struct in a_crypto
*
- * \param A valid sdp_crypto struct
+ * \param p A valid sdp_crypto struct
+ * \param taglen Length
*
* \retval 0 success
* \retval nonzero failure
Modified: team/lathama/doxygencleanups/channels/sip/reqresp_parser.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/sip/reqresp_parser.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/channels/sip/reqresp_parser.c (original)
+++ team/lathama/doxygencleanups/channels/sip/reqresp_parser.c Fri Sep 21 10:28:01 2012
@@ -1523,9 +1523,9 @@
* item is found that is not supported, it is copied to the unsupported
* out buffer.
*
- * \param option list
+ * \param options list
* \param unsupported out buffer (optional)
- * \param unsupported out buffer length (optional)
+ * \param unsupported_len out buffer length (optional)
*/
unsigned int parse_sip_options(const char *options, char *unsupported, size_t unsupported_len)
{
Modified: team/lathama/doxygencleanups/codecs/codec_speex.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/codecs/codec_speex.c?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/codecs/codec_speex.c (original)
+++ team/lathama/doxygencleanups/codecs/codec_speex.c Fri Sep 21 10:28:01 2012
@@ -26,7 +26,7 @@
*
* \ingroup codecs
*
- * \extref The Speex library - http://www.speex.org
+ * The Speex library - http://www.speex.org
*
*/
@@ -44,7 +44,8 @@
#include <speex/speex.h>
/* We require a post 1.1.8 version of Speex to enable preprocessing
- and better type handling */
+ * and better type handling
+ */
#ifdef _SPEEX_TYPES_H
#include <speex/speex_preprocess.h>
#endif
Modified: team/lathama/doxygencleanups/contrib/asterisk-doxygen-header
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/contrib/asterisk-doxygen-header?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-doxygen-header (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-doxygen-header Fri Sep 21 10:28:01 2012
@@ -1,10 +1,0 @@
-<HTML>
- <HEAD>
- <TITLE>Asterisk.org: Developer Documentation ($date)</TITLE>
- <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
- </HEAD>
- <BODY BGCOLOR="#FFFFFF">
-<div><font size="2" align="right">$datetime</font></div>
-
-<h2>Asterisk developer's documentation</h2>
-<hr/>
Modified: team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen?view=diff&rev=373317&r1=373316&r2=373317
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen Fri Sep 21 10:28:01 2012
@@ -1,4 +1,4 @@
-# Doxyfile 1.5.2
+# Doxyfile 1.7.1
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
@@ -14,191 +14,216 @@
# Project related configuration options
#---------------------------------------------------------------------------
-# This tag specifies the encoding used for all characters in the config file that
-# follow. The default is UTF-8 which is also the encoding used for all text before
-# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
-# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
-# possible encodings.
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "Asterisk - The Open Source Telephony Project"
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
+PROJECT_NUMBER =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# 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
-
-# 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
-# format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of
-# source files, where putting all generated files in the same directory would
+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
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
# otherwise cause performance problems for the file system.
-CREATE_SUBDIRS = NO
-
-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all constant output in the proper language.
-# The default language is English, other supported languages are:
-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
-# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
-# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
-# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
-# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
+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
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
-# include brief member descriptions after the members that are listed in
-# the file and class documentation (similar to JavaDoc).
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
-# the brief description of a member or function before the detailed description.
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
-# This tag implements a quasi-intelligent brief description abbreviator
-# that is used to form the text in various listings. Each string
-# in this list, if found as the leading text of the brief description, will be
-# stripped from the text and the result after processing the whole list, is
-# used as the annotated text. Otherwise, the brief description is used as-is.
-# If left blank, the following values are used ("$name" is automatically
-# replaced with the name of the entity): "The $name class" "The $name widget"
-# "The $name file" "is" "provides" "specifies" "contains"
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
# "represents" "a" "an" "the"
-ABBREVIATE_BRIEF =
-
-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# Doxygen will generate a detailed section even if there is only a brief
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
# description.
ALWAYS_DETAILED_SEC = NO
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
-# inherited members of a class in the documentation of that class as if those
-# members were ordinary class members. Constructors, destructors and assignment
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
INLINE_INHERITED_MEMB = NO
-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
-# path before files name in the file list and in the header files. If set
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
FULL_PATH_NAMES = NO
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
-# can be used to strip a user-defined part of the path. Stripping is
-# only done if one of the specified strings matches the left-hand part of
-# the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH =
-
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
-# the path mentioned in the documentation of a class, which tells
-# the reader which header file to include in order to use a class.
-# If left blank only the name of the header file containing the class
-# definition is used. Otherwise one should specify the include paths that
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
# are normally passed to the compiler using the -I flag.
-STRIP_FROM_INC_PATH =
-
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
-# (but less readable) file names. This can be useful is your file systems
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
-# will interpret the first line (until the first dot) of a JavaDoc-style
-# comment as the brief description. If set to NO, the JavaDoc
-# comments will behave just like the Qt-style comments (thus requiring an
-# explicit @brief command for a brief description.
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
-# comments) as a brief description. This used to be the default behaviour.
-# The new default is to treat a multi-line C++ comment block as a detailed
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member
-# documentation.
-
-DETAILS_AT_TOP = NO
-
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
-# member inherits the documentation from any documented member that it
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
# re-implements.
INHERIT_DOCS = YES
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
-# a new page for each member. If set to NO, the documentation of a member will
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
# be part of the file/class/namespace that contains it.
SEPARATE_MEMBER_PAGES = NO
-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
-TAB_SIZE = 3
-
-# This tag can be used to specify a number of aliases that acts
-# as commands in the documentation. An alias has the form "name=value".
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
-# put the command \sideeffect (or @sideeffect) in the documentation, which
-# will result in a user-defined paragraph with heading "Side Effects:".
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
-ALIASES = "extref=\xrefitem extref \"ExtRef\" \"External references\""
-ALIASES += "AsteriskTrunkWarning=\note The information contained on this page may be out of date. To make sure you get the most current information, please make sure that you are using the documentation generated from Asterisk trunk."
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# sources only. Doxygen will then generate output that is more tailored for C.
-# For instance, some of the names that are used will be different. The list
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = YES
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
-# sources only. Doxygen will then generate output that is more tailored for Java.
-# For instance, namespaces will be presented as packages, qualified scopes
-# will look different, etc.
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
-# include (a tag file for) the STL sources as input, then you should
-# set this tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
-# func(std::string) {}). This also make the inheritance and collaboration
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this
+# tag. The format is ext=language, where ext is a file extension, and language
+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
@@ -208,382 +233,466 @@
CPP_CLI_SUPPORT = NO
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES, then doxygen will reuse the documentation of the first
-# member in the group (if any) for the other members of the group. By default
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
-# the same type (for instance a group of public functions) to be put as a
-# subgroup of that type (e.g. under the Public Functions section). Set it to
-# NO to prevent subgrouping. Alternatively, this can be done per class using
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
# the \nosubgrouping command.
SUBGROUPING = YES
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penality.
+# If the system has enough physical memory increasing the cache will improve the
[... 3596 lines stripped ...]
More information about the svn-commits
mailing list