[asterisk-commits] lathama: trunk r373330 - in /trunk: apps/ cdr/ cel/ channels/ channels/sip/ c...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Fri Sep 21 12:15:04 CDT 2012
Author: lathama
Date: Fri Sep 21 12:14:59 2012
New Revision: 373330
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373330
Log:
Doxygen updates including mistakes, misspellings, missing parameters, updates for Doxygen style. Some missing txt file links are removed but their content or essense will be included in some later updates. A majority of the txt files were removed in the 1.6 era but never noted. The HR and EXTREF are simple changes that make the documentation more compatable with more versions of Doxygen.
Further updates coming.
(issue ASTERISK-20259)
Modified:
trunk/apps/app_confbridge.c
trunk/apps/app_ices.c
trunk/apps/app_meetme.c
trunk/apps/app_skel.c
trunk/cdr/cdr_pgsql.c
trunk/cdr/cdr_radius.c
trunk/cdr/cdr_sqlite.c
trunk/cel/cel_pgsql.c
trunk/cel/cel_radius.c
trunk/channels/chan_console.c
trunk/channels/chan_h323.c
trunk/channels/chan_jingle.c
trunk/channels/chan_misdn.c
trunk/channels/chan_motif.c
trunk/channels/sip/include/sdp_crypto.h
trunk/channels/sip/reqresp_parser.c
trunk/codecs/codec_speex.c
trunk/funcs/func_speex.c
trunk/include/asterisk/acl.h
trunk/include/asterisk/app.h
trunk/include/asterisk/bridging_features.h
trunk/include/asterisk/doxygen/architecture.h
trunk/include/asterisk/doxygen/asterisk-git-howto.h
trunk/include/asterisk/doxygen/commits.h
trunk/include/asterisk/doxygen/mantisworkflow.h
trunk/include/asterisk/doxygen/releases.h
trunk/include/asterisk/doxygen/reviewboard.h
trunk/include/asterisk/doxyref.h
trunk/include/asterisk/jabber.h
trunk/include/asterisk/localtime.h
trunk/include/asterisk/res_odbc.h
trunk/include/asterisk/sip_api.h
trunk/include/asterisk/xmpp.h
trunk/main/acl.c
trunk/main/ast_expr2f.c
trunk/main/asterisk.c
trunk/main/ccss.c
trunk/main/http.c
trunk/main/manager.c
trunk/main/sha1.c
trunk/main/strings.c
trunk/main/tdd.c
trunk/main/xmldoc.c
trunk/res/res_config_curl.c
trunk/res/res_config_ldap.c
trunk/res/res_config_pgsql.c
trunk/res/res_crypto.c
trunk/res/res_curl.c
trunk/res/res_jabber.c
trunk/res/res_smdi.c
trunk/res/res_snmp.c
trunk/res/res_xmpp.c
Modified: trunk/apps/app_confbridge.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_confbridge.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/apps/app_confbridge.c (original)
+++ trunk/apps/app_confbridge.c Fri Sep 21 12:14:59 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: trunk/apps/app_ices.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_ices.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/apps/app_ices.c (original)
+++ trunk/apps/app_ices.c Fri Sep 21 12:14:59 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: trunk/apps/app_meetme.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_meetme.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/apps/app_meetme.c (original)
+++ trunk/apps/app_meetme.c Fri Sep 21 12:14:59 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: trunk/apps/app_skel.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_skel.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/apps/app_skel.c (original)
+++ trunk/apps/app_skel.c Fri Sep 21 12:14:59 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: trunk/cdr/cdr_pgsql.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cdr/cdr_pgsql.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/cdr/cdr_pgsql.c (original)
+++ trunk/cdr/cdr_pgsql.c Fri Sep 21 12:14:59 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: trunk/cdr/cdr_radius.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cdr/cdr_radius.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/cdr/cdr_radius.c (original)
+++ trunk/cdr/cdr_radius.c Fri Sep 21 12:14:59 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: trunk/cdr/cdr_sqlite.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cdr/cdr_sqlite.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/cdr/cdr_sqlite.c (original)
+++ trunk/cdr/cdr_sqlite.c Fri Sep 21 12:14:59 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: trunk/cel/cel_pgsql.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cel/cel_pgsql.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/cel/cel_pgsql.c (original)
+++ trunk/cel/cel_pgsql.c Fri Sep 21 12:14:59 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: trunk/cel/cel_radius.c
URL: http://svnview.digium.com/svn/asterisk/trunk/cel/cel_radius.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/cel/cel_radius.c (original)
+++ trunk/cel/cel_radius.c Fri Sep 21 12:14:59 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: trunk/channels/chan_console.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_console.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/chan_console.c (original)
+++ trunk/channels/chan_console.c Fri Sep 21 12:14:59 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: trunk/channels/chan_h323.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_h323.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/chan_h323.c (original)
+++ trunk/channels/chan_h323.c Fri Sep 21 12:14:59 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: trunk/channels/chan_jingle.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_jingle.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/chan_jingle.c (original)
+++ trunk/channels/chan_jingle.c Fri Sep 21 12:14:59 2012
@@ -22,7 +22,7 @@
*
* \brief Jingle Channel Driver
*
- * \extref Iksemel http://iksemel.jabberstudio.org/
+ * Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
*/
Modified: trunk/channels/chan_misdn.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_misdn.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/chan_misdn.c (original)
+++ trunk/channels/chan_misdn.c Fri Sep 21 12:14:59 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: trunk/channels/chan_motif.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_motif.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/chan_motif.c (original)
+++ trunk/channels/chan_motif.c Fri Sep 21 12:14:59 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: trunk/channels/sip/include/sdp_crypto.h
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sip/include/sdp_crypto.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/sip/include/sdp_crypto.h (original)
+++ trunk/channels/sip/include/sdp_crypto.h Fri Sep 21 12:14:59 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: trunk/channels/sip/reqresp_parser.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/sip/reqresp_parser.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/channels/sip/reqresp_parser.c (original)
+++ trunk/channels/sip/reqresp_parser.c Fri Sep 21 12:14:59 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: trunk/codecs/codec_speex.c
URL: http://svnview.digium.com/svn/asterisk/trunk/codecs/codec_speex.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/codecs/codec_speex.c (original)
+++ trunk/codecs/codec_speex.c Fri Sep 21 12:14:59 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: trunk/funcs/func_speex.c
URL: http://svnview.digium.com/svn/asterisk/trunk/funcs/func_speex.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/funcs/func_speex.c (original)
+++ trunk/funcs/func_speex.c Fri Sep 21 12:14:59 2012
@@ -26,7 +26,7 @@
*
* \ingroup functions
*
- * \extref The Speex 1.2 library - http://www.speex.org
+ * The Speex 1.2 library - http://www.speex.org
* \note Requires the 1.2 version of the Speex library (which might not be what you find in Linux packages)
*/
Modified: trunk/include/asterisk/acl.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/acl.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/acl.h (original)
+++ trunk/include/asterisk/acl.h Fri Sep 21 12:14:59 2012
@@ -189,7 +189,7 @@
* contained in the acl container. It will deny if any of the ast_ha lists
* fail, and it will pass only if all of the rules pass.
*
- * \param acl The head of the list of ACLs to evaluate
+ * \param acl_list The head of the list of ACLs to evaluate
* \param addr An ast_sockaddr whose address is considered when matching rules
* \param purpose Context for which the ACL is being applied - Establishes purpose of a notice when rejected
*
Modified: trunk/include/asterisk/app.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/app.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/app.h (original)
+++ trunk/include/asterisk/app.h Fri Sep 21 12:14:59 2012
@@ -331,6 +331,9 @@
/*!
* \brief Set voicemail function callbacks
+ *
+ * \param copy_recording_to_vm_func, vm_index_to_foldername, vm_mailbox_snapshot_create
+ * \param vm_mailbox_snapshot_destroy, vm_msg_move, vm_msg_remove, vm_msg_forward, vm_msg_play
* \param[in] has_voicemail_func set function pointer
* \param[in] inboxcount_func set function pointer
* \param[in] inboxcount2_func set function pointer
@@ -411,7 +414,10 @@
/*!
* \brief Determine number of new/old messages in a mailbox
* \since 1.0
- * \param[in] mailbox Mailbox specification in the format mbox[@context][&mbox2[@context2]][...]
+ * \param[in] mailbox Mailbox specification in the format
+ * /code
+ * mbox[\@context][&mbox2[\@context2]][...]
+ * /code
* \param[out] newmsgs Number of messages in the "INBOX" folder. Includes number of messages in the "Urgent" folder, if any.
* \param[out] oldmsgs Number of messages in the "Old" folder.
* \retval 0 Success
@@ -495,7 +501,7 @@
* \param context The voicemail context for the mailbox
* \param num_msgs The number of messages to move
* \param oldfolder The folder from where messages should be moved
- * \param old_msg_nums The message IDs of the messages to move
+ * \param old_msg_ids The message IDs of the messages to move
* \param newfolder The folder to which messages should be moved
* new folder. This array must be num_msgs sized.
*
@@ -557,10 +563,12 @@
/*!
* \brief Play a voicemail msg back on a channel.
*
+ * \param chan
* \param mailbox msg is in.
* \param context of mailbox.
- * \param voicemail folder to look in.
- * \param message number in the voicemailbox to playback to the channel.
+ * \param folder voicemail folder to look in.
+ * \param msg_num message number in the voicemailbox to playback to the channel.
+ * \param cb
*
* \retval 0 success
* \retval -1 failure
@@ -643,7 +651,7 @@
* \param chan
* \param file filename
* \param fwd, rev, stop, pause, restart, skipms, offsetms
- * \param waitstream callback to invoke when fastforward or rewind occurrs.
+ * \param cb waitstream callback to invoke when fastforward or rewind occurrs.
*
* Before calling this function, set this to be the number
* of ms to start from the beginning of the file. When the function
Modified: trunk/include/asterisk/bridging_features.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/bridging_features.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/bridging_features.h (original)
+++ trunk/include/asterisk/bridging_features.h Fri Sep 21 12:14:59 2012
@@ -197,7 +197,7 @@
* \param dtmf DTMF string to be activated upon
* \param callback Function to execute upon activation
* \param hook_pvt Unique data
- * \param Optional destructor callback for hook_pvt data
+ * \param destructor Optional destructor callback for hook_pvt data
*
* \retval 0 on success
* \retval -1 on failure
@@ -226,9 +226,9 @@
/*! \brief Set a callback on the features structure to receive talking notifications on.
*
* \param features Bridge features structure
- * \param talker_cb, Callback function to execute when talking events occur in the bridge core.
+ * \param talker_cb Callback function to execute when talking events occur in the bridge core.
* \param pvt_data Optional unique data that will be passed with the talking events.
- * \param Optional destructor callback for pvt data.
+ * \param talker_destructor Optional destructor callback for pvt data.
*
* \retval 0, success
* \retval -1, failure
Modified: trunk/include/asterisk/doxygen/architecture.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxygen/architecture.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxygen/architecture.h (original)
+++ trunk/include/asterisk/doxygen/architecture.h Fri Sep 21 12:14:59 2012
@@ -26,7 +26,7 @@
\author Russell Bryant <russell at digium.com>
\AsteriskTrunkWarning
-<hr/>
+<hr>
\section ArchTOC Table of Contents
@@ -64,7 +64,7 @@
-# \ref ArchThreadDebugging
-# \ref ArchMemoryDebugging
-<hr/>
+<hr>
\section ArchIntro Introduction
@@ -295,7 +295,7 @@
CEL modules typically live in the <code>cel/</code> directory in the source tree.
-For a list of CEL handlers, see \ref cel_drivers.
+For a list of CEL handlers, see cel_drivers.
For additional information about the CEL API, see
<code>include/asterisk/cel.h</code>.
@@ -407,7 +407,7 @@
outbound channel is created and bridged to the inbound channel once it answers.
Dialplan applications always execute in the context of a channel thread. Dialplan
-functions \i almost always do, as well. However, it is possible to read and write
+functions almost always do, as well. However, it is possible to read and write
dialplan functions from an asynchronous interface such as the Asterisk CLI or the
manager interface (AMI). However, it is still always the channel thread that is
the owner of the ast_channel data structure.
@@ -710,7 +710,7 @@
<code>main/astmm.c</code>.
-<hr/>
+<hr>
Return to the \ref ArchTOC
*/
Modified: trunk/include/asterisk/doxygen/asterisk-git-howto.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxygen/asterisk-git-howto.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxygen/asterisk-git-howto.h (original)
+++ trunk/include/asterisk/doxygen/asterisk-git-howto.h Fri Sep 21 12:14:59 2012
@@ -23,7 +23,7 @@
*
* \AsteriskTrunkWarning
*
- * <hr/>
+ * <hr>
*
* \section Introduction Introduction
* This document will instruct you how to setup a local git mirror of the
@@ -32,7 +32,7 @@
* Why would you want that? for starters, it's a fast repository browser
* and works well even when offline. More on why and why not at 'Pros and Cons'
* in the end of this document.
- * <hr/>
+ * <hr>
*
* \section Setup Setup
*
@@ -120,7 +120,7 @@
echo 'exclude res_snmp' >build_tools/conf
\endverbatim
*
- * <hr/>
+ * <hr>
*
* \section Update Update
* The main Asterisk repository tends to get new commits occasionally. I
@@ -133,7 +133,7 @@
\endverbatim
*
* Next, get all updates.
- * <hr/>
+ * <hr>
*
* \section Usage Usage
*
@@ -183,7 +183,7 @@
git svn rebase --fetch-all
\endverbatim
*
- * <hr/>
+ * <hr>
*
* \section ProsAndCons Pros and Cons
*
@@ -233,5 +233,5 @@
* to test that. Even if it will, it will require an extra step of manual
* editing.
*
- * <hr/>
+ * <hr>
*/
Modified: trunk/include/asterisk/doxygen/commits.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxygen/commits.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxygen/commits.h (original)
+++ trunk/include/asterisk/doxygen/commits.h Fri Sep 21 12:14:59 2012
@@ -23,23 +23,23 @@
*
* \AsteriskTrunkWarning
*
- * <hr/>
+ * <hr>
*
* \section CommitMsgFormatting Commit Message Formatting
*
* The following illustrates the basic outline for commit messages:
*
- \verbatim
- <One-liner summary of changes>
-
- <Empty Line>
-
- <Verbose description of the changes>
-
- <Empty Line>
-
- <Special Tags>
- \endverbatim
+ * \verbatim
+ * <One-liner summary of changes>
+ *
+ * <Empty Line>
+ *
+ * <Verbose description of the changes>
+ *
+ * <Empty Line>
+ *
+ * <Special Tags>
+ * \endverbatim
*
* Some commit history viewers treat the first line of commit messages as the
* summary for the commit. So, an effort should be made to format our commit
@@ -52,7 +52,7 @@
* \note For trivial commits, such as "fix the build", or "fix spelling mistake",
* the verbose description may not be necessary.
*
- * <hr/>
+ * <hr>
*
* \section CommitMsgTags Special Tags for Commit Messages
*
@@ -77,12 +77,12 @@
*
* Here is an example of what the template will generate for you:
*
- \verbatim
- (closes issue #1234)
- Reported by: SomeGuy
- Patches:
- fix_bug_1234.diff uploaded by SomeDeveloper (license 5678)
- \endverbatim
+ * \verbatim
+ * (closes issue #1234)
+ * Reported by: SomeGuy
+ * Patches:
+ * fix_bug_1234.diff uploaded by SomeDeveloper (license 5678)
+ * \endverbatim
*
* If the patch being committed was written by the person doing the commit,
* and is not available to reference as an upload to the issue, there is no
@@ -97,7 +97,7 @@
*
* \note The trailing slash in the review URL is required.
*
- * <hr/>
+ * <hr>
*
* \section CommitMsgSvnmerge Commit Messages with svnmerge
*
Modified: trunk/include/asterisk/doxygen/mantisworkflow.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxygen/mantisworkflow.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxygen/mantisworkflow.h (original)
+++ trunk/include/asterisk/doxygen/mantisworkflow.h Fri Sep 21 12:14:59 2012
@@ -23,7 +23,7 @@
*
* \AsteriskTrunkWarning
*
- * <hr/>
+ * <hr>
* \section WorkflowDescription Description of the Issue Tracker Workflow
*
* (This document is most beneficial for Asterisk bug marshals, however it is good
Modified: trunk/include/asterisk/doxygen/releases.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxygen/releases.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxygen/releases.h (original)
+++ trunk/include/asterisk/doxygen/releases.h Fri Sep 21 12:14:59 2012
@@ -133,7 +133,7 @@
*
* \arg \ref ReleaseStatus
*
- * <hr/>
+ * <hr>
*
* \section commitmonitoring Commit Monitoring
*
@@ -141,7 +141,7 @@
* <a href="http://lists.digium.com/">http://lists.digium.com</a>. The Digium
* mailing list server hosts a %number of mailing lists for commits.
*
- * <hr/>
+ * <hr>
*
* \section ast10policy Asterisk 1.0
*
@@ -154,7 +154,7 @@
*
* No commits should be made to the Asterisk 1.0 branch.
*
- * <hr/>
+ * <hr>
*
* \section ast12policy Asterisk 1.2
*
@@ -181,7 +181,7 @@
* - 1.2.X.Y - a release that contains fixes to the security patches released in
* version 1.2.X
*
- * <hr/>
+ * <hr>
*
* \section ast14policy Asterisk 1.4
*
@@ -208,7 +208,7 @@
* - 1.4.X.Y - a release that contains very few changes on top of 1.4.X. This
* may be for a security patch, or for a regression introduced in 1.4.X.
*
- * <hr/>
+ * <hr>
*
* \section ast16policy Asterisk 1.6
*
@@ -244,7 +244,7 @@
* - 1.6.X.Y - a release that contains fixes for bugs or security issues identified
* in the 1.6.X release series.
*
- * <hr/>
+ * <hr>
*
* \section asttrunk Asterisk Trunk
*
@@ -269,7 +269,7 @@
* tested and reviewed such that there is reasonable belief that the code
* is ready to go.
*
- * <hr/>
+ * <hr>
*
* \section astteam Asterisk Team Branches
*
Modified: trunk/include/asterisk/doxygen/reviewboard.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxygen/reviewboard.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxygen/reviewboard.h (original)
+++ trunk/include/asterisk/doxygen/reviewboard.h Fri Sep 21 12:14:59 2012
@@ -23,7 +23,7 @@
*
* \AsteriskTrunkWarning
*
- * <hr/>
+ * <hr>
*
* \section ReviewboardGuidelines Usage Guidelines
*
@@ -52,7 +52,7 @@
* testing and should not have blatant coding guidelines violations. Lack of
* these things is careless and shows disrespect for those reviewing your code.
*
- * <hr/>
+ * <hr>
*
* \section ReviewboardPosting Posting Code to Reviewboard
*
@@ -61,25 +61,25 @@
* The easiest way to post a patch to reviewboard is by using the
* post-review tool. We have post-review in our repotools svn repository.
*
- \verbatim
- $ svn co http://svn.digium.com/svn/repotools
- \endverbatim
+ * \verbatim
+ * $ svn co http://svn.digium.com/svn/repotools
+ * \endverbatim
*
* Essentially, post-review is a script that will take the output of "svn
* diff" and create a review request out of it for you. So, once you have
* a working copy with the changes you expect in the output of "svn diff",
* you just run the following command:
*
- \verbatim
- $ post-review
- \endverbatim
+ * \verbatim
+ * $ post-review
+ * \endverbatim
*
* If it complains about not knowing which reviewboard server to use, add
* the server option:
*
- \verbatim
- $ post-review --server=https://reviewboard.asterisk.org
- \endverbatim
+ * \verbatim
+ * $ post-review --server=https://reviewboard.asterisk.org
+ * \endverbatim
*
* \subsection postreviewnewfiles Dealing with New Files
*
@@ -90,15 +90,15 @@
*
* You would start by getting your changes applied to a trunk working copy:
*
- \verbatim
- $ cd .../trunk
- \endverbatim
+ * \verbatim
+ * $ cd .../trunk
+ * \endverbatim
*
* Then, apply the changes from your branch:
*
- \verbatim
- $ svn merge .../trunk .../team/group/my_new_code
- \endverbatim
+ * \verbatim
+ * $ svn merge .../trunk .../team/group/my_new_code
+ * \endverbatim
*
* Now, the code is merged into your working copy. However, for a new
* file, subversion treats it as a copy of existing content and not new
@@ -106,10 +106,10 @@
* it to show up in the diff, use the following commands so svn treats it
* as new content and publishes it in the diff:
*
- \verbatim
- $ svn revert my_new_file.c
- $ svn add my_new_file.c
- \endverbatim
+ * \verbatim
+ * $ svn revert my_new_file.c
+ * $ svn add my_new_file.c
+ * \endverbatim
*
* Now, it should work, and you can run "post-review" as usual.
*
@@ -121,7 +121,7 @@
* Apply the current version of the diff to a working copy as described above,
* and then run the following command:
*
- \verbatim
- $ post-review -r <review request number>
- \endverbatim
+ * \verbatim
+ * $ post-review -r <review request number>
+ * \endverbatim
*/
Modified: trunk/include/asterisk/doxyref.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/doxyref.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/doxyref.h (original)
+++ trunk/include/asterisk/doxyref.h Fri Sep 21 12:14:59 2012
@@ -68,7 +68,7 @@
* \arg \b Main: Asterisk Developer's website http://www.asterisk.org/developers/
* \arg \b Bugs: The Issue Tracker https://issues.asterisk.org
* \arg \b Lists: List Server http://lists.digium.com
- * \arg \b Wiki: The Asterisk Wiki http://www.voip-info.org
+ * \arg \b Wiki: The Asterisk Wiki http://wiki.asterisk..org
* \arg \b Docs: The Asterisk Documentation Project http://www.asteriskdocs.org
* \arg \b Digium: The Asterisk Company http://www.digium.com
*/
@@ -92,8 +92,6 @@
* \arg \ref AstExtState
* \arg \ref AstDataRetrieval
*
- * \subsection model_txt Generic Model
- * \verbinclude model.txt
* \subsection channel_txt Channels
* \arg See \ref Def_Channel
*/
@@ -224,7 +222,6 @@
* - \ref pbx_retrieve_variable()
* - \ref AstChanVar
*
- * \verbinclude channelvariables.tex
*/
/*!
@@ -281,7 +278,6 @@
* \arg \ref enum.c
* \arg \ref func_enum.c
*
- * \verbinclude enum.txt
*/
/*!
@@ -334,7 +330,6 @@
/*!
* \page Config_ast Asterisk.conf
- * \verbinclude asterisk-conf.txt
*/
/*!
@@ -373,11 +368,9 @@
* IAX2 is implemented in \ref chan_iax2.c
* \arg \link Config_iax iax.conf Configuration file example \endlink
* \section iaxreadme IAX readme file
- * \verbinclude iax.txt
* \section Config_iax IAX Configuration example
* \verbinclude iax.conf.sample
* \section iaxjitter IAX Jitterbuffer information
- * \verbinclude jitterbuffer.txt
*/
/*!
@@ -409,7 +402,6 @@
* \page README_misdn MISDN documentation
* \arg See \ref Config_misdn
* \section mISDN configuration
- * \verbinclude misdn.txt
*/
/*!
@@ -728,7 +720,6 @@
* \arg Configuration file:
* \verbinclude res_config_sqlite.conf
* \arg SQL tables:
- * \verbinclude res_config_sqlite.txt
* \arg See also:
* http://www.sqlite.org
*/
Modified: trunk/include/asterisk/jabber.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/jabber.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/jabber.h (original)
+++ trunk/include/asterisk/jabber.h Fri Sep 21 12:14:59 2012
@@ -21,7 +21,7 @@
* \arg \ref AJI_intro
* \ref res_jabber.c
* \author Matt O'Gorman <mogorman at digium.com>
- * \extref IKSEMEL http://iksemel.jabberstudio.org
+ * IKSEMEL http://iksemel.jabberstudio.org
*
* \page AJI_intro AJI - The Asterisk Jabber Interface
*
Modified: trunk/include/asterisk/localtime.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/localtime.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/localtime.h (original)
+++ trunk/include/asterisk/localtime.h Fri Sep 21 12:14:59 2012
@@ -75,7 +75,6 @@
* \param len Size of the chunk of memory buf.
* \param format A string specifying the format of time to be placed into buf.
* \param tm Pointer to the broken out time to be used for the format.
- * \param locale Text string specifying the locale to be used for language strings.
* \retval An integer value specifying the number of bytes placed into buf or -1 on error.
*/
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm);
@@ -87,7 +86,6 @@
* \param s A string specifying some portion of a date and time.
* \param format The format in which the string, s, is expected.
* \param tm The broken-out time structure into which the parsed data is expected.
- * \param locale Text string specifying the locale to be used for language strings.
* \retval A pointer to the first character within s not used to parse the date and time.
*/
char *ast_strptime(const char *s, const char *format, struct ast_tm *tm);
Modified: trunk/include/asterisk/res_odbc.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/res_odbc.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/res_odbc.h (original)
+++ trunk/include/asterisk/res_odbc.h Fri Sep 21 12:14:59 2012
@@ -104,9 +104,11 @@
* \brief Retrieves a connected ODBC object
* \param name The name of the ODBC class for which a connection is needed.
* \param flags One or more of the following flags:
- * \li RES_ODBC_SANITY_CHECK Whether to ensure that a connection is valid before returning the handle. Usually unnecessary.
- * \li RES_ODBC_INDEPENDENT_CONNECTION Return a handle which is independent from all others. Usually used when starting a transaction.
- * \li RES_ODBC_CONNECTED Only return a connected handle. Intended for use with peers which use idlecheck, which are checked periodically for reachability.
+ * \li RES_ODBC_SANITY_CHECK Whether to ensure that a connection is valid before returning the handle. Usually unnecessary.
+ * \li RES_ODBC_INDEPENDENT_CONNECTION Return a handle which is independent from all others. Usually used when starting a transaction.
+ * \li RES_ODBC_CONNECTED Only return a connected handle. Intended for use with peers which use idlecheck, which are checked periodically for reachability.
+ * \param file, function, lineno
+ *
* \return ODBC object
* \retval NULL if there is no connection available with the requested name.
*
Modified: trunk/include/asterisk/sip_api.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/sip_api.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/sip_api.h (original)
+++ trunk/include/asterisk/sip_api.h Fri Sep 21 12:14:59 2012
@@ -29,9 +29,10 @@
/*!
* \brief Send a customized SIP INFO request
*
+ * \param chan Channel
* \param headers The headers to add to the INFO request
* \param content_type The content type header to add
- * \param conten The body of the INFO request
+ * \param content The body of the INFO request
* \param useragent_filter If non-NULL, only send the INFO if the
* recipient's User-Agent contains useragent_filter as a substring
*
Modified: trunk/include/asterisk/xmpp.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/xmpp.h?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/include/asterisk/xmpp.h (original)
+++ trunk/include/asterisk/xmpp.h Fri Sep 21 12:14:59 2012
@@ -19,7 +19,7 @@
/*! \file
* \brief XMPP Interface
* \author Joshua Colp <jcolp at digium.com>
- * \extref IKSEMEL http://iksemel.jabberstudio.org
+ * IKSEMEL http://iksemel.jabberstudio.org
*/
#ifndef _ASTERISK_XMPP_H
Modified: trunk/main/acl.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/acl.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/main/acl.c (original)
+++ trunk/main/acl.c Fri Sep 21 12:14:59 2012
@@ -371,7 +371,7 @@
* \param netmask The netmask configured in the host access rule.
* \param result The resultant address after applying the netmask to the given address
* \retval 0 Successfully applied netmask
- * \reval -1 Failed to apply netmask
+ * \retval -1 Failed to apply netmask
*/
static int apply_netmask(const struct ast_sockaddr *addr, const struct ast_sockaddr *netmask,
struct ast_sockaddr *result)
Modified: trunk/main/ast_expr2f.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/ast_expr2f.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/main/ast_expr2f.c (original)
+++ trunk/main/ast_expr2f.c Fri Sep 21 12:14:59 2012
@@ -2142,8 +2142,8 @@
}
/** Set the current column.
- * @param line_number
- * @param yyscanner The scanner object.
+ * \param column_no line_number
+ * \param yyscanner The scanner object.
*/
void ast_yyset_column (int column_no , yyscan_t yyscanner)
{
Modified: trunk/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/trunk/main/asterisk.c?view=diff&rev=373330&r1=373329&r2=373330
==============================================================================
--- trunk/main/asterisk.c (original)
+++ trunk/main/asterisk.c Fri Sep 21 12:14:59 2012
@@ -21,6 +21,15 @@
/*!
* \mainpage Asterisk -- The Open Source Telephony Project
*
+ * \par Welcome
+ *
+ * This documentation created by the Doxygen project clearly explains the
+ * internals of the Asterisk software. This documentation contains basic
+ * examples, developer documentation, support information, and information
+ * for upgrading.
+ *
+ *
+ *
* \par Developer Documentation for Asterisk
*
* This is the main developer documentation for Asterisk. It is
@@ -44,19 +53,19 @@
* of <a href="http://www.digium.com">Digium, Inc</a>.
*
* \author Mark Spencer <markster at digium.com>
- * Also see \ref AstCREDITS
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists, and IRC
* channels for your use.
+ *
+ * \todo Add pages for mailinglists, IRC, etc...
*/
/*! \file
- \brief Top level source file for Asterisk - the Open Source PBX. Implementation
- of PBX core functions and CLI interface.
-
+ * \brief Top level source file for Asterisk - the Open Source PBX.
+ * Implementation of PBX core functions and CLI interface.
*/
/*** MODULEINFO
@@ -1024,7 +1033,8 @@
AST_MUTEX_DEFINE_STATIC(safe_system_lock);
[... 402 lines stripped ...]
More information about the asterisk-commits
mailing list