[svn-commits] lathama: branch lathama/doxygencleanups r373379 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Fri Sep 21 19:47:37 CDT 2012
Author: lathama
Date: Fri Sep 21 19:47:32 2012
New Revision: 373379
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373379
Log:
Syncing from old tree
Modified:
team/lathama/doxygencleanups/Makefile
team/lathama/doxygencleanups/apps/app_queue.c
team/lathama/doxygencleanups/channels/chan_agent.c
team/lathama/doxygencleanups/channels/chan_sip.c
team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen
team/lathama/doxygencleanups/include/asterisk/channel.h
team/lathama/doxygencleanups/include/asterisk/doxyref.h
team/lathama/doxygencleanups/include/asterisk/time.h
team/lathama/doxygencleanups/main/asterisk.c
team/lathama/doxygencleanups/main/audiohook.c
team/lathama/doxygencleanups/main/ccss.c
team/lathama/doxygencleanups/main/channel.c
team/lathama/doxygencleanups/main/manager.c
team/lathama/doxygencleanups/main/xmldoc.c
Modified: team/lathama/doxygencleanups/Makefile
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/Makefile?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/Makefile (original)
+++ team/lathama/doxygencleanups/Makefile Fri Sep 21 19:47:32 2012
@@ -446,7 +446,7 @@
rm -rf autom4te.cache
rm -f include/asterisk/autoconfig.h
rm -f include/asterisk/buildopts.h
- rm -rf doc/doxygen
+ rm -rf doc/api
rm -f build_tools/menuselect-deps
datafiles: _cleantest_all doc/core-en_US.xml
Modified: team/lathama/doxygencleanups/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_queue.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/apps/app_queue.c (original)
+++ team/lathama/doxygencleanups/apps/app_queue.c Fri Sep 21 19:47:32 2012
@@ -1197,8 +1197,8 @@
#define ANNOUNCEPOSITION_YES 1 /*!< We announce position */
#define ANNOUNCEPOSITION_NO 2 /*!< We don't announce position */
-#define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than @limit" */
-#define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than @limit */
+#define ANNOUNCEPOSITION_MORE_THAN 3 /*!< We say "Currently there are more than \<limit\>" */
+#define ANNOUNCEPOSITION_LIMIT 4 /*!< We not announce position more than \<limit\> */
struct call_queue {
AST_DECLARE_STRING_FIELDS(
Modified: team/lathama/doxygencleanups/channels/chan_agent.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_agent.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_agent.c (original)
+++ team/lathama/doxygencleanups/channels/chan_agent.c Fri Sep 21 19:47:32 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: team/lathama/doxygencleanups/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_sip.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_sip.c (original)
+++ team/lathama/doxygencleanups/channels/chan_sip.c Fri Sep 21 19:47:32 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
*
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=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen (original)
+++ team/lathama/doxygencleanups/contrib/asterisk-ng-doxygen Fri Sep 21 19:47:32 2012
@@ -179,7 +179,7 @@
# 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 =
+ALIASES = "extref=\xrefitem extref \"ExtRef\" \"External references\""
# 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.
@@ -1376,7 +1376,9 @@
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
-PREDEFINED =
+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: team/lathama/doxygencleanups/include/asterisk/channel.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/channel.h?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/channel.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/channel.h Fri Sep 21 19:47:32 2012
@@ -1383,7 +1383,7 @@
* \brief Softly hangup up a channel
*
* \param chan channel to be soft-hung-up
- * \param reason an AST_SOFTHANGUP_* reason code
+ * \param cause Reason an AST_SOFTHANGUP_* reason code
*
* \details
* Call the protocol layer, but don't destroy the channel structure
@@ -2036,8 +2036,8 @@
/*!
* \brief Gives the string form of a given cause code.
*
- * \param state cause to get the description of
- * \return the text form of the binary cause code given
+ * \param cause State cause to get the description of
+ * return the text form of the binary cause code given
*/
const char *ast_cause2str(int state) attribute_pure;
@@ -2292,7 +2292,7 @@
* the clone channel into the original channel. Start by killing off the original
* channel's backend. I'm not sure we're going to keep this function, because
* while the features are nice, the cost is very high in terms of pure nastiness. XXX
- * \param chan Channel to masquerade
+ * \param original Channel to masquerade
*/
int ast_do_masquerade(struct ast_channel *chan);
Modified: team/lathama/doxygencleanups/include/asterisk/doxyref.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/doxyref.h?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/doxyref.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/doxyref.h Fri Sep 21 19:47:32 2012
@@ -59,7 +59,7 @@
*
* \section debugconfig Debugging and Configuration References
* \arg \ref AstDebug : Hints on debugging
- * \arg \ref
+ * \arg \ref extref
* \arg \ref ConfigFiles
* \arg \ref SoundFiles included in the Asterisk distribution
*
@@ -77,6 +77,7 @@
* \section Coding Guidelines
* This file is in the /doc directory in your Asterisk source tree.
* Make sure to stay up to date with the latest guidelines.
+ * \verbinclude CODING-GUIDELINES
*/
/*!
@@ -312,6 +313,7 @@
*
* If you want your non res_* module to export functions to other modules
* you have to include it in the [global] section.
+ * \verbinclude modules.conf.sample
*/
/*!
@@ -319,17 +321,20 @@
* \par See also
* \arg \ref features.c : Call feature implementation
* \section featconf features.conf
+ * \verbinclude features.conf.sample
*/
/*!
* \page Config_followme Followme: An application for simple follow-me calls
* \section followmeconf Followme.conf
* - See app_followme.c
+ * \verbinclude followme.conf.sample
*/
/*!
* \page Config_ext Extensions.conf - the Dial Plan
* \section dialplan Extensions.conf
+ * \verbinclude extensions.conf.sample
*/
/*!
@@ -338,6 +343,7 @@
* \arg \link Config_iax iax.conf Configuration file example \endlink
* \section iaxreadme IAX readme file
* \section Config_iax IAX Configuration example
+ * \verbinclude iax.conf.sample
* \section iaxjitter IAX Jitterbuffer information
*/
@@ -345,6 +351,7 @@
* \page Config_iax IAX configuration
* \arg Implemented in \ref chan_iax2.c
* \section iaxconf iax.conf
+ * \verbinclude iax.conf.sample
*/
/*!
@@ -352,6 +359,7 @@
* Also see \ref Config_rtp RTP configuration
* \arg Implemented in \ref chan_sip.c
* \section sipconf sip.conf
+ * \verbinclude sip.conf.sample
*
* \arg \b Back \ref chanconf
*/
@@ -361,6 +369,7 @@
* Also see \ref Config_rtp RTP configuration
* \arg Implemented in \ref chan_mgcp.c
* \section mgcpconf mgcp.conf
+ * \verbinclude mgcp.conf.sample
*/
/*!
@@ -375,18 +384,21 @@
* \arg \ref README_misdn
* \arg See the mISDN home page: http://www.isdn4linux.de/mISDN/
* \section misdnconf misdn.conf
+ * \verbinclude misdn.conf.sample
*/
/*!
* \page Config_vm VoiceMail configuration
* \section vmconf voicemail.conf
* \arg Implemented in \ref app_voicemail.c
+ * \verbinclude voicemail.conf.sample
*/
/*!
* \page Config_dahdi DAHDI configuration
* \section dahdiconf dahdi.conf
* \arg Implemented in \ref chan_dahdi.c
+ * \verbinclude dahdi.conf.sample
*/
/*!
@@ -402,12 +414,14 @@
* \page Config_oss OSS configuration
* \section ossconf oss.conf
* \arg Implemented in \ref chan_oss.c
+ * \verbinclude oss.conf.sample
*/
/*!
* \page Config_alsa ALSA configuration
* \section alsaconf alsa.conf
* \arg Implemented in \ref chan_alsa.c
+ * \verbinclude alsa.conf.sample
*/
/*!
@@ -415,6 +429,7 @@
* \section agentconf agents.conf
* The agent channel is a proxy channel for queues
* \arg Implemented in \ref chan_agent.c
+ * \verbinclude agents.conf.sample
*/
/*!
@@ -422,12 +437,14 @@
* \arg Implemented in \ref rtp.c
* Used in \ref chan_sip.c and \ref chan_mgcp.c (and various H.323 channels)
* \section rtpconf rtp.conf
+ * \verbinclude rtp.conf.sample
*/
/*!
* \page Config_dun DUNDi Configuration
* \arg See also \ref AstDUNDi
* \section dundiconf dundi.conf
+ * \verbinclude dundi.conf.sample
*/
/*!
@@ -435,6 +452,7 @@
* \section enumconf enum.conf
* \arg See also \ref enumreadme
* \arg Implemented in \ref func_enum.c and \ref enum.c
+ * \verbinclude enum.conf.sample
*/
/*!
@@ -442,6 +460,7 @@
* \par See also
* \arg \ref cdrconf
* \arg Implemented in \ref cdr_csv.c
+ * \verbinclude cdr.conf.sample
*/
/*!
@@ -449,6 +468,7 @@
* \par See also
* \arg \ref cdrconf
* \arg Implemented in \ref cdr_custom.c
+ * \verbinclude cdr_custom.conf.sample
*/
/*!
@@ -457,20 +477,14 @@
* \arg \ref cdrconf
* \arg \ref AstAMI
* \arg Implemented in \ref cdr_manager.c
+ * \verbinclude cdr_manager.conf.sample
*/
/*!
* \page cdr_odbc ODBC CDR driver configuration
* \arg See also \ref cdrconf
* \arg Implemented in \ref cdr_odbc.c
- * See also:
- * \arg http://www.unixodbc.org
- */
-
-/*!
- * \page cdr_odbc Adaptive ODBC CDR driver configuration
- * \arg See also \ref cdrconf
- * \arg Implemented in \ref cdr_adaptive_odbc.c
+ * \verbinclude cdr_odbc.conf.sample
* See also:
* \arg http://www.unixodbc.org
*/
@@ -481,6 +495,7 @@
* \arg Implemented in \ref cdr_pgsql.c
* See also:
* \arg http://www.postgresql.org
+ * \verbinclude cdr_pgsql.conf.sample
*/
/*!
@@ -497,12 +512,14 @@
* \arg Implemented in \ref cdr_sqlite3_custom.c
* See also:
* \arg http://www.sqlite.org
+ * \verbinclude cdr_sqlite3_custom.conf.sample
*/
/*!
* \page cdr_syslog Syslog CDR driver configuration
* \arg See also \ref cdrconf
* \arg \ref cdr_syslog.c
+ * \verbinclude cdr_syslog.conf.sample
*/
/*!
@@ -510,6 +527,7 @@
* \arg See also \ref cdrconf
* See also:
* \arg http://www.freetds.org
+ * \verbinclude cdr_tds.conf.sample
*/
/*!
@@ -526,46 +544,54 @@
* \arg \link cdr_sqlite3_custom SQLite 3 CDR driver configuration \endlink
* \arg \link cdr_syslog Syslog CDR driver configuration \endlink
* \arg \link cdr_tds FreeTDS CDR driver configuration (Microsoft SQL Server) \endlink
+ * \verbinclude cdr.conf.sample
*/
/*!
* \page Config_moh Music on Hold Configuration
* \arg Implemented in \ref res_musiconhold.c
* \section mohconf musiconhold.conf
+ * \verbinclude musiconhold.conf.sample
*/
/*!
* \page Config_adsi ADSI Configuration
* \section adsiconf adsi.conf
+ * \verbinclude adsi.conf.sample
*/
/*!
* \page Config_codec CODEC Configuration
* \section codecsconf codecs.conf
+ * \verbinclude codecs.conf.sample
*/
/*!
* \page Config_ara REALTIME Configuration
* \arg See also: \arg \link AstARA \endlink
* \section extconf extconfig.conf
+ * \verbinclude extconfig.conf.sample
*/
/*!
* \page Config_ami AMI configuration
* \arg See also: \arg \link AstAMI \endlink
* \section amiconf manager.conf
+ * \verbinclude manager.conf.sample
*/
/*!
* \page Config_qu ACD - Queue system configuration
* \arg Implemented in \ref app_queue.c
* \section quconf queues.conf
+ * \verbinclude queues.conf.sample
*/
/*!
* \page Config_mm Meetme - The conference bridge configuration
* \arg Implemented in \ref app_meetme.c
* \section mmconf meetme.conf
+ * \verbinclude meetme.conf.sample
*/
/*!
Modified: team/lathama/doxygencleanups/include/asterisk/time.h
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/include/asterisk/time.h?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/include/asterisk/time.h (original)
+++ team/lathama/doxygencleanups/include/asterisk/time.h Fri Sep 21 19:47:32 2012
@@ -57,8 +57,8 @@
/*!
* \brief Computes the difference (in microseconds) between two \c struct \c timeval instances.
- * \par end the end of the time period
- * \par start the beginning of the time period
+ * \param end the end of the time period
+ * \param start the beginning of the time period
* \return the difference in microseconds
*/
AST_INLINE_API(
@@ -71,8 +71,8 @@
/*!
* \brief Computes the difference (in milliseconds) between two \c struct \c timeval instances.
- * \par end end of the time period
- * \par start beginning of the time period
+ * \param end end of the time period
+ * \param start beginning of the time period
* \return the difference in milliseconds
*/
AST_INLINE_API(
Modified: team/lathama/doxygencleanups/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/asterisk.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/main/asterisk.c (original)
+++ team/lathama/doxygencleanups/main/asterisk.c Fri Sep 21 19:47:32 2012
@@ -16,9 +16,9 @@
* at the top of the source tree.
*/
-/* Doxygen Documentation */
+/* Begin Doxygen Documentation */
/*!
- * \mainpage Asterisk - The Open Source Telephony Project
+ * \mainpage Asterisk -- The Open Source Telephony Project
*
* \par Welcome
*
Modified: team/lathama/doxygencleanups/main/audiohook.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/audiohook.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/main/audiohook.c (original)
+++ team/lathama/doxygencleanups/main/audiohook.c Fri Sep 21 19:47:32 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: team/lathama/doxygencleanups/main/ccss.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/ccss.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/main/ccss.c (original)
+++ team/lathama/doxygencleanups/main/ccss.c Fri Sep 21 19:47:32 2012
@@ -565,7 +565,7 @@
};
/*!
- * \intenral
+ * \internal
* \brief lookup the ast_device_state mapped to cc_state
*
* \param state
Modified: team/lathama/doxygencleanups/main/channel.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/channel.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/main/channel.c (original)
+++ team/lathama/doxygencleanups/main/channel.c Fri Sep 21 19:47:32 2012
@@ -814,7 +814,7 @@
*
* \note This function is not reentrant.
*
- * \param state
+ * \param ast_channel_state state state
*/
const char *ast_state2str(enum ast_channel_state state)
{
Modified: team/lathama/doxygencleanups/main/manager.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/manager.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/main/manager.c (original)
+++ team/lathama/doxygencleanups/main/manager.c Fri Sep 21 19:47:32 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 */
@@ -1130,7 +1130,7 @@
};
/*! \brief In case you didn't read that giant block of text above the mansession_session struct, the
- * \ref struct mansession is named this solely to keep the API the same in Asterisk. This structure really
+ * struct mansession is named this solely to keep the API the same in Asterisk. This structure really
* represents data that is different from Manager action to Manager action. The mansession_session pointer
* contained within points to session-specific data.
*/
Modified: team/lathama/doxygencleanups/main/xmldoc.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/xmldoc.c?view=diff&rev=373379&r1=373378&r2=373379
==============================================================================
--- team/lathama/doxygencleanups/main/xmldoc.c (original)
+++ team/lathama/doxygencleanups/main/xmldoc.c Fri Sep 21 19:47:32 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)
{
More information about the svn-commits
mailing list