[Asterisk-code-review] chan_iax2: Fix for Doxygen. (asterisk[16])

[George Joseph]

George Joseph has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/17380 )

Change subject: chan_iax2: Fix for Doxygen.
......................................................................

chan_iax2: Fix for Doxygen.

ASTERISK-29737

Change-Id: I282003cc553989fd5c19ceeac9e478fa4ee06cec
---
M channels/chan_iax2.c
M channels/iax2/include/iax2.h
2 files changed, 11 insertions(+), 14 deletions(-)

Approvals:
  Kevin Harwell: Looks good to me, but someone else must approve
  George Joseph: Looks good to me, approved; Approved for Submit



diff --git a/channels/chan_iax2.c b/channels/chan_iax2.c
index 13ba090..5233aef 100644
--- a/channels/chan_iax2.c
+++ b/channels/chan_iax2.c
@@ -23,9 +23,6 @@
  *
  * \author Mark Spencer <markster at digium.com>
  *
- * \par See also
- * \arg \ref Config_iax
- *
  * \ingroup channel_drivers
  *
  * \todo Implement musicclass settings for IAX2 devices
@@ -1164,9 +1161,9 @@
 static ast_mutex_t iaxsl[ARRAY_LEN(iaxs)];
 
 /*!
- *  * \brief Another container of iax2_pvt structures
+ * \brief Another container of iax2_pvt structures
  *
- *  Active IAX2 pvt structs used during transfering a call are stored here.
+ * Active IAX2 pvt structs used during transfering a call are stored here.
  */
 static struct ao2_container *iax_transfercallno_pvts;
 
@@ -1330,8 +1327,6 @@
  * valid after calling it.  This function may unlock and lock
  * the mutex associated with this callno, meaning that another
  * thread may grab it and destroy the call.
- *
- * \return Nothing
  */
 static void iax2_lock_owner(int callno)
 {
@@ -1691,10 +1686,11 @@
 	return ast_sched_add(con, when, callback, data);
 }
 
-/*
+/*!
  * \brief Acquire the iaxsl[callno] if call exists and not having ongoing hangup.
  * \param callno Call number to lock.
- * \return 0 If call disappeared or has ongoing hangup procedure. 1 If call found and mutex is locked.
+ * \retval 0 If call disappeared or has ongoing hangup procedure.
+ * \retval 1 If call found and mutex is locked.
  */
 static int iax2_lock_callno_unless_destroyed(int callno)
 {
@@ -5019,7 +5015,6 @@
  * \brief Parses an IAX dial string into its component parts.
  * \param data the string to be parsed
  * \param pds pointer to a \c struct \c parsed_dial_string to be filled in
- * \return nothing
  *
  * This function parses the string and fills the structure
  * with pointers to its component parts. The input string
@@ -5031,7 +5026,7 @@
  * password field will be set to NULL.
  *
  * \note The dial string format is:
- *       [username[:password]@]peer[:port][/exten[@context]][/options]
+ * \verbatim [username[:password]@]peer[:port][/exten[@context]][/options] \endverbatim
  */
 static void parse_dial_string(char *data, struct parsed_dial_string *pds)
 {
@@ -12725,7 +12720,9 @@
 
 
 /*! \brief Check if address can be used as packet source.
- \return 0  address available, 1  address unavailable, -1  error
+ \retval  0 address available
+ \retval  1 address unavailable
+ \retval -1 error
 */
 static int check_srcaddr(struct ast_sockaddr *addr)
 {
diff --git a/channels/iax2/include/iax2.h b/channels/iax2/include/iax2.h
index a661858..e9dc967 100644
--- a/channels/iax2/include/iax2.h
+++ b/channels/iax2/include/iax2.h
@@ -15,8 +15,8 @@
  * \brief
  *
  * Implementation of Inter-Asterisk eXchange, version 2
- * \ref iax2-parser.c
- * \ref iax2-parser.h
+ * \ref parser.c
+ * \ref parser.h
  * \ref chan_iax2.c
  */
 

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17380
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I282003cc553989fd5c19ceeac9e478fa4ee06cec
Gerrit-Change-Number: 17380
Gerrit-PatchSet: 3
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211118/fddc3121/attachment-0001.html>