kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-07 02:18:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix a bunch of places where \arg was used instead of \param. Using \arg

Browse Source 
to document arguments seems logical, and does work, but is not the best
thing to use.

\arg in doxygen is simply for creating non-nested unordered lists.  \param is
the correct tag to use to document function parameters, and will come out
better in the generated documentation.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@127401 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2008-07-02 14:50:45 +00:00
parent 097ac98034
commit 3cf77c4c7f
10 changed files with 75 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/asterisk/dnsmgr.h
View File

@@ -40,8 +40,8 @@ struct ast_dnsmgr_entry;
/*!
* \brief Allocate a new DNS manager entry
*
* \arg name the hostname
* \arg result where the DNS manager should store the IP address as it refreshes it.
* \param name the hostname
* \param result where the DNS manager should store the IP address as it refreshes it.
* it.
*
* This function allocates a new DNS manager entry object, and fills it with the
@@ -56,7 +56,7 @@ struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct sockaddr_in *re
/*!
* \brief Free a DNS manager entry
*
* \arg entry the DNS manager entry to free
* \param entry the DNS manager entry to free
*
* \return nothing
*/
@@ -65,9 +65,9 @@ void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry);
/*!
* \brief Allocate and initialize a DNS manager entry
*
* \arg name the hostname
* \arg result where to store the IP address as the DNS manager refreshes it
* \arg dnsmgr Where to store the allocate DNS manager entry
* \param name the hostname
* \param result where to store the IP address as the DNS manager refreshes it
* \param dnsmgr Where to store the allocate DNS manager entry
*
* This function allocates a new DNS manager entry object, and fills it with
* the provided hostname and IP address. This function _does_ force an initial