channels: Fix for Doxygen.

ASTERISK-29762

Change-Id: Ia8811ac12b93ff8c18164699c6fbc604cb0a23f7

channels/sip/config_parser.c

@@ -90,7 +90,8 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 
 	ast_copy_string(buf, value, sizeof(buf));
 
-	/*! register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
+	/*
+	 * register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
 	 * becomes
 	 *   userpart => [peer?][transport://]user[@domain][:secret[:authuser]]
 	 *   hostpart => host[:port][/extension][~expiry]
@@ -105,7 +106,7 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 		return -1;
 	}
 
-	/*!
+	/*
 	 * pre1.peer => peer
 	 * pre1.userpart => [transport://]user[@domain][:secret[:authuser]]
 	 * hostpart => host[:port][/extension][~expiry]
@@ -116,7 +117,7 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 		pre1.peer = NULL;
 	}
 
-	/*!
+	/*
 	 * pre1.peer => peer
 	 * pre2.transport = transport
 	 * pre2.userpart => user[@domain][:secret[:authuser]]
@@ -135,7 +136,7 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 		return -1;
 	}
 
-	/*!
+	/*
 	 * pre1.peer => peer
 	 * pre2.transport = transport
 	 * user1.userpart => user[@domain]
@@ -145,7 +146,7 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 	 */
 	AST_NONSTANDARD_RAW_ARGS(user1, pre2.userpart, ':');
 
-	/*!
+	/*
 	 * pre1.peer => peer
 	 * pre2.transport = transport
 	 * user1.userpart => user[@domain]
@@ -156,7 +157,7 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 	 */
 	AST_NONSTANDARD_RAW_ARGS(host1, hostpart, '~');
 
-	/*!
+	/*
 	 * pre1.peer => peer
 	 * pre2.transport = transport
 	 * user1.userpart => user[@domain]
@@ -168,7 +169,7 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 	 */
 	AST_NONSTANDARD_RAW_ARGS(host2, host1.hostpart, '/');
 
-	/*!
+	/*
 	 * pre1.peer => peer
 	 * pre2.transport = transport
 	 * user1.userpart => user[@domain]
@@ -181,32 +182,32 @@ int sip_parse_register_line(struct sip_registry *reg, int default_expiry, const
 	 */
 	AST_NONSTANDARD_RAW_ARGS(host3, host2.hostpart, ':');
 
-	/*!
-	  * pre1.peer => peer
-	  * pre2.transport = transport
-	  * user2.user => user
-	  * user2.domain => domain
-	  * user1.secret => secret
-	  * user1.authuser => authuser
-	  * host3.host => host
-	  * host3.port => port
-	  * host2.extension => extension
-	  * host1.expiry => expiry
+	/*
+	 * pre1.peer => peer
+	 * pre2.transport = transport
+	 * user2.user => user
+	 * user2.domain => domain
+	 * user1.secret => secret
+	 * user1.authuser => authuser
+	 * host3.host => host
+	 * host3.port => port
+	 * host2.extension => extension
+	 * host1.expiry => expiry
 	 */
 	AST_NONSTANDARD_RAW_ARGS(user2, user1.userpart, '@');
 
-	/*!
-	  * pre1.peer => peer
-	  * pre2.transport = transport
-	  * user2.user => user
-	  * user2.domain => domain
-	  * user1.secret => secret
-	  * user3.authuser => authuser
-	  * user3.domainport => domainport
-	  * host3.host => host
-	  * host3.port => port
-	  * host2.extension => extension
-	  * host1.expiry => expiry
+	/*
+	 * pre1.peer => peer
+	 * pre2.transport = transport
+	 * user2.user => user
+	 * user2.domain => domain
+	 * user1.secret => secret
+	 * user3.authuser => authuser
+	 * user3.domainport => domainport
+	 * host3.host => host
+	 * host3.port => port
+	 * host2.extension => extension
+	 * host1.expiry => expiry
 	 */
 	AST_NONSTANDARD_RAW_ARGS(user3, user1.authuser, ':');
 

channels/sip/include/reqresp_parser.h

@@ -85,7 +85,7 @@ int parse_uri_full(char *uri, const char *scheme, char **user, char **pass,
 /*!
  * \brief  Get caller id name from SIP headers, copy into output buffer
  *
- * \retval input string pointer placed after display-name field if possible
+ * \return input string pointer placed after display-name field if possible
  */
 const char *get_calleridname(const char *input, char *output, size_t outputsize);
 
@@ -173,9 +173,9 @@ void sip_request_parser_unregister_tests(void);
  * item is found that is not supported, it is copied to the unsupported
  * out buffer.
  *
- * \param option list
- * \param unsupported out buffer (optional)
- * \param unsupported out buffer length (optional)
+ * \param options list
+ * \param[in,out] unsupported buffer (optional)
+ * \param[in,out] unsupported_len buffer length
  *
  * \note Because this function can be called multiple times, it will append
  * whatever options are specified in \c options to \c unsupported. Callers
@@ -242,7 +242,7 @@ void sip_reqresp_parser_exit(void);
  */
 struct sip_via *parse_via(const char *header);
 
-/*
+/*!
  * \brief Free parsed Via data.
  */
 void free_via(struct sip_via *v);

channels/sip/include/route.h

@@ -57,7 +57,7 @@ struct sip_route {
  * \param len Length of hop not including null terminator
  * \param inserthead If true then inserted the new route to the top of the list
  *
- * \retval Pointer to null terminated copy of URI on success
+ * \return Pointer to null terminated copy of URI on success
  * \retval NULL on error
  */
 const char *sip_route_add(struct sip_route *route, const char *uri, size_t len, int inserthead);
@@ -65,15 +65,12 @@ const char *sip_route_add(struct sip_route *route, const char *uri, size_t len,
 /*!
  * \brief Add routes from header
  *
- * \note This procedure is for headers that require use of <brackets>.
+ * \note This procedure is for headers that require use of \<brackets\>.
  */
 void sip_route_process_header(struct sip_route *route, const char *header, int inserthead);
 
 /*!
  * \brief copy route-set
- *
- * \retval non-zero on failure
- * \retval 0 on success
  */
 void sip_route_copy(struct sip_route *dst, const struct sip_route *src);
 
@@ -94,7 +91,7 @@ void sip_route_dump(const struct sip_route *route);
  * \param formatcli Add's space after comma's, print's N/A if list is empty.
  * \param skip Number of hops to skip
  *
- * \retval an allocated struct ast_str on success
+ * \return an allocated struct ast_str on success
  * \retval NULL on failure
  */
 struct ast_str *sip_route_list(const struct sip_route *route, int formatcli, int skip)

channels/sip/include/sip.h

@@ -841,7 +841,7 @@ struct sip_request {
 	unsigned int reqsipoptions; /*!< Items needed for Required header in responses */
 };
 
-/* \brief given a sip_request and an offset, return the char * that resides there
+/*! \brief given a sip_request and an offset, return the char * that resides there
  *
  * It used to be that rlpart1, rlpart2, and the header and line arrays were character
  * pointers. They are now offsets into the ast_str portion of the sip_request structure.

channels/sip/reqresp_parser.c

@@ -690,7 +690,7 @@ AST_TEST_DEFINE(sip_parse_uri_test)
 
 /*! \brief  Get caller id name from SIP headers, copy into output buffer
  *
- *  \retval input string pointer placed after display-name field if possible
+ *  \return input string pointer placed after display-name field if possible
  */
 const char *get_calleridname(const char *input, char *output, size_t outputsize)
 {
@@ -1685,10 +1685,6 @@ AST_TEST_DEFINE(parse_contact_header_test)
  * builds a bit field representing all the SIP options in that field. When an
  * item is found that is not supported, it is copied to the unsupported
  * out buffer.
- *
- * \param options list
- * \param unsupported out buffer (optional)
- * \param unsupported_len out buffer length (optional)
  */
 unsigned int parse_sip_options(const char *options, char *unsupported, size_t unsupported_len)
 {