diff --git a/apps/app_queue.c b/apps/app_queue.c
index 761d0cff0ad7ded52e42999fc103d270a69ee55b..fa22cbeff95f54c8b33bc68c822fa8c21eef0897 100644
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -2975,6 +2975,7 @@ static void send_agent_complete(const struct queue_ent *qe, const char *queuenam
*
* \param[in] qe the queue_ent structure which corresponds to the caller attempting to reach members
* \param[in] options the options passed as the third parameter to the Queue() application
+ * \param[in] announceoverride filename to play to user when waiting
* \param[in] url the url passed as the fourth parameter to the Queue() application
* \param[in,out] tries the number of times we have tried calling queue members
* \param[out] noption set if the call to Queue() has the 'n' option set.
diff --git a/channels/chan_sip.c b/channels/chan_sip.c
index ea05c88fde7b4440d12b501cf0dc5f66c15f9bc1..55f63d2d250334d6cfd23e715393abf913033cca 100644
--- a/channels/chan_sip.c
+++ b/channels/chan_sip.c
@@ -360,7 +360,7 @@ enum check_auth_result {
/*! \brief States for outbound registrations (with register= lines in sip.conf */
enum sipregistrystate {
REG_STATE_UNREGISTERED = 0, /*!< We are not registred
- * \noteInitial state. We should have a timeout scheduled for the initial
+ * \note Initial state. We should have a timeout scheduled for the initial
* (or next) registration transmission, calling sip_reregister
*/
@@ -580,7 +580,7 @@ static const struct cfsip_options {
/*! \brief Standard SIP and TLS port from RFC 3261. DO NOT CHANGE THIS */
#define STANDARD_SIP_PORT 5060
#define STANDARD_TLS_PORT 5061
-/* Note: in many SIP headers, absence of a port number implies port 5060,
+/*! \note in many SIP headers, absence of a port number implies port 5060,
* and this is why we cannot change the above constant.
* There is a limited number of places in asterisk where we could,
* in principle, use a different "default" port number, but
@@ -724,8 +724,8 @@ static int global_max_se; /*!< Highest threshold for session
/*@}*/
-/*! Object counters @{
- * \bug These counters are not handled in a thread-safe way. ast_atomic_fetchadd_int()
+/*! \name Object counters @{
+ * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
* should be used to modify these values. */
static int suserobjs = 0; /*!< Static users */
static int ruserobjs = 0; /*!< Realtime users */
@@ -1671,8 +1671,8 @@ enum t38_action_flag {
};
/*---------------------------- Forward declarations of functions in chan_sip.c */
-/*! \note This is added to help splitting up chan_sip.c into several files
- in coming releases */
+/* Note: This is added to help splitting up chan_sip.c into several files
+ in coming releases. */
/*--- PBX interface functions */
static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
@@ -18477,7 +18477,8 @@ static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp)
/*! \brief Get Max or Min SE (session timer expiry)
- \param max if true, get max se, otherwise min se
+ * \param p pointer to the SIP dialog
+ * \param max if true, get max se, otherwise min se
*/
int st_get_se(struct sip_pvt *p, int max)
{
@@ -18528,7 +18529,7 @@ int st_get_se(struct sip_pvt *p, int max)
/*! \brief Get the entity (UAC or UAS) that's acting as the session-timer refresher
- \param sip_pvt pointer to the SIP dialog
+ * \param p pointer to the SIP dialog
*/
enum st_refresher st_get_refresher(struct sip_pvt *p)
{
@@ -18557,7 +18558,7 @@ enum st_refresher st_get_refresher(struct sip_pvt *p)
/*! \brief Get the session-timer mode
- \param sip_pvt pointer to the SIP dialog
+ * \param p pointer to the SIP dialog
*/
enum st_mode st_get_mode(struct sip_pvt *p)
{
@@ -18769,12 +18770,14 @@ static int sip_devicestate(void *data)
}
/*! \brief PBX interface function -build SIP pvt structure
- SIP calls initiated by the PBX arrive here
-
- SIP Dial string syntax
- SIP/exten@host!dnid
- or SIP/host/exten!dnid
- or SIP/host!dnid
+ * SIP calls initiated by the PBX arrive here.
+ *
+ * \verbatim
+ * SIP Dial string syntax
+ * SIP/exten@host!dnid
+ * or SIP/host/exten!dnid
+ * or SIP/host!dnid
+ * \endverbatim
*/
static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause)
{
diff --git a/channels/chan_zap.c b/channels/chan_zap.c
index 58516e73bdf50d9370c739bb2e7dc39eaad24017..d7676b3598dfb8bfcfaa6b0cd09051cd232aa80a 100644
--- a/channels/chan_zap.c
+++ b/channels/chan_zap.c
@@ -6041,15 +6041,14 @@ static int zt_wink(struct zt_pvt *p, int index)
return 0;
}
-/*! enable or disable the chan_zap Do-Not-Disturb mode for a Zaptel channel
- * @zapchan "Physical" Zaptel channel (e.g: Zap/5)
- * @on: 1 to enable, 0 to disable
+/*! \brief enable or disable the chan_zap Do-Not-Disturb mode for a Zaptel channel
+ * \param zapchan "Physical" Zaptel channel (e.g: Zap/5)
+ * \param on 1 to enable, 0 to disable
*
* chan_zap has a DND (Do Not Disturb) mode for each zapchan (physical
* zaptel channel). Use this to enable or disable it.
*
- * \fixme the use of the word "channel" for those zapchans is really
- * confusing.
+ * \bug the use of the word "channel" for those zapchans is really confusing.
*/
static void zap_dnd(struct zt_pvt *zapchan, int on)
{
diff --git a/channels/misdn/chan_misdn_config.h b/channels/misdn/chan_misdn_config.h
index 8c27f4f245b2e5c1cd9b4c1fccf7a826382938ca..06e23478332e614e7de29a67773b83b962b4ba4a 100644
--- a/channels/misdn/chan_misdn_config.h
+++ b/channels/misdn/chan_misdn_config.h
@@ -11,8 +11,8 @@
* the GNU General Public License
*/
-/*! \file \brief
- * Interface to mISDN - Config
+/*! \file
+ * \brief Interface to mISDN - Config
* \author Christian Richter <crich@beronet.com>
*/
diff --git a/channels/misdn/ie.c b/channels/misdn/ie.c
index 817e3d8cb4e02ab19a096a06045ee2027dfaa3da..fbd06d1636a61d5d5e057c0d14fd215f3e6eff81 100644
--- a/channels/misdn/ie.c
+++ b/channels/misdn/ie.c
@@ -15,8 +15,8 @@
* the GNU General Public License
*/
-/*! \file \brief
- * Interface to mISDN
+/*! \file
+ * \brief Interface to mISDN
* \author Christian Richter <crich@beronet.com>
*/
diff --git a/channels/misdn/isdn_lib.c b/channels/misdn/isdn_lib.c
index 67ecb47faef5c0be3323006276c297cd671a16b7..b951e2ea815530142f131e4a5fb03d8a8b412918 100644
--- a/channels/misdn/isdn_lib.c
+++ b/channels/misdn/isdn_lib.c
@@ -11,8 +11,8 @@
* the GNU General Public License
*/
-/*! \file \brief
- * Interface to mISDN
+/*! \file
+ * \brief Interface to mISDN
* \author Christian Richter <crich@beronet.com>
*/
diff --git a/channels/misdn/isdn_lib.h b/channels/misdn/isdn_lib.h
index 731d497b3bab4ed54a9b884e6b2484fe87675062..85922c6309264ef957392d2fdb84d762e64e23e2 100644
--- a/channels/misdn/isdn_lib.h
+++ b/channels/misdn/isdn_lib.h
@@ -11,9 +11,8 @@
* the GNU General Public License
*/
-/*! \file \brief
- *
- * Interface to mISDN
+/*! \file
+ * \brief Interface to mISDN
*
* \author Christian Richter <crich@beronet.com>
*/
diff --git a/channels/misdn/isdn_msg_parser.c b/channels/misdn/isdn_msg_parser.c
index ebaf6a92f41b7619d16a01b561adc21f527a9b9c..dc2f74e9d2d13259497e8ebe756711f0e9127937 100644
--- a/channels/misdn/isdn_msg_parser.c
+++ b/channels/misdn/isdn_msg_parser.c
@@ -11,8 +11,8 @@
* the GNU General Public License
*/
-/*! \file \brief
- * Interface to mISDN - message parser
+/*! \file
+ * \brief Interface to mISDN - message parser
* \author Christian Richter <crich@beronet.com>
*/
diff --git a/channels/misdn/portinfo.c b/channels/misdn/portinfo.c
index 8223164e54ed9854759f1767b46eee9d748d8959..6d5f2154d61797ad6c4323be539e213cada648d8 100644
--- a/channels/misdn/portinfo.c
+++ b/channels/misdn/portinfo.c
@@ -1,5 +1,5 @@
-/*! \file \brief
- * Interface to mISDN - ???
+/*! \file
+ * \brief Interface to mISDN - port info
* \author Christian Richter <crich@beronet.com>
*/
diff --git a/include/asterisk/extconf.h b/include/asterisk/extconf.h
index 9439450313a2128ae657ff6efa639ae6cd1a2951..7f248d912daafb2fb487ba713074637b18f84914 100644
--- a/include/asterisk/extconf.h
+++ b/include/asterisk/extconf.h
@@ -15,8 +15,9 @@
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
-/*! \file External configuration handlers (realtime and static configuration)
- * \author Steve Murphy <murf@digium.com>
+/*! \file
+ * \brief External configuration handlers (realtime and static configuration)
+ * \author Steve Murphy <murf@digium.com>
*
*/
diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h
index 9646e94c2e19a91ad2545ebb2ed4373babcbb5a0..2c49cc054718e1e1e5a0a4eae20a99a9bafcbb0a 100644
--- a/include/asterisk/strings.h
+++ b/include/asterisk/strings.h
@@ -148,16 +148,15 @@ char *ast_strip(char *s),
char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
/*!
- \brief Strip backslash for "escaped" semicolons.
- \brief s The string to be stripped (will be modified).
+ \brief Strip backslash for "escaped" semicolons,
+ the string to be stripped (will be modified).
\return The stripped string.
*/
char *ast_unescape_semicolon(char *s);
/*!
- \brief Convert some C escape sequences (\b\f\n\r\t) into the
- equivalent characters.
- \brief s The string to be converted (will be modified).
+ \brief Convert some C escape sequences \verbatim (\b\f\n\r\t) \endverbatim into the
+ equivalent characters. The string to be converted (will be modified).
\return The converted string.
*/
char *ast_unescape_c(char *s);
diff --git a/include/asterisk/time.h b/include/asterisk/time.h
index 4b7ca00ff94832ad4f7013cde2f2deddc29766d4..8abce667ddb7ac0f3acb3fa8200a98b5d675f827 100644
--- a/include/asterisk/time.h
+++ b/include/asterisk/time.h
@@ -57,8 +57,9 @@ int ast_tvdiff_sec(struct timeval end, struct timeval start),
/*!
* \brief Computes the difference (in microseconds) between two \c struct \c timeval instances.
- * \param end the end of the time period
- * \param start the beginning of the time period
+ * \param ast_tvdiff_sec
+ * \arg end the end of the time period
+ * \arg start the beginning of the time period
* \return the difference in microseconds
*/
AST_INLINE_API(
diff --git a/main/ast_expr2f.c b/main/ast_expr2f.c
index 770b8d1a581833fc5e85fb12438d7f18c1f42718..19aa0f6d688337a186ffa1eb41c564ea6d681d50 100644
--- a/main/ast_expr2f.c
+++ b/main/ast_expr2f.c
@@ -1301,12 +1301,13 @@ case YY_STATE_EOF(var):
} /* end of scanning one token */
} /* end of ast_yylex */
-/* yy_get_next_buffer - try to read in a new buffer
+/*!
+ * \brief yy_get_next_buffer - try to read in a new buffer
*
* Returns a code representing an action:
- * EOB_ACT_LAST_MATCH -
- * EOB_ACT_CONTINUE_SCAN - continue scanning from current position
- * EOB_ACT_END_OF_FILE - end of file
+ * \retval EOB_ACT_LAST_MATCH -
+ * \retval EOB_ACT_CONTINUE_SCAN - continue scanning from current position
+ * \retval EOB_ACT_END_OF_FILE - end of file
*/
static int yy_get_next_buffer (yyscan_t yyscanner)
{
@@ -1433,7 +1434,7 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
return ret_val;
}
-/* yy_get_previous_state - get the state just before the EOB char was reached */
+/*! \brief yy_get_previous_state - get the state just before the EOB char was reached */
static yy_state_type yy_get_previous_state (yyscan_t yyscanner)
{
@@ -1463,7 +1464,7 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
return yy_current_state;
}
-/* yy_try_NUL_trans - try to make a transition on the NUL character
+/*! \brief yy_try_NUL_trans - try to make a transition on the NUL character.
*
* synopsis
* next_state = yy_try_NUL_trans( current_state );
@@ -1605,10 +1606,11 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
}
#endif /* ifndef YY_NO_INPUT */
-/** Immediately switch to a different input stream.
- * @param input_file A readable stream.
- * @param yyscanner The scanner object.
- * @note This function does not reset the start condition to @c INITIAL .
+/*!
+ * \brief Immediately switch to a different input stream.
+ * \param input_file A readable stream.
+ * \param yyscanner The scanner object.
+ * \note This function does not reset the start condition to @c INITIAL .
*/
void ast_yyrestart (FILE * input_file , yyscan_t yyscanner)
{
@@ -1624,9 +1626,10 @@ static int yy_get_next_buffer (yyscan_t yyscanner)
ast_yy_load_buffer_state(yyscanner );
}
-/** Switch to a different input buffer.
- * @param new_buffer The new input buffer.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Switch to a different input buffer.
+ * \param new_buffer The new input buffer.
+ * \param yyscanner The scanner object.
*/
void ast_yy_switch_to_buffer (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
{
@@ -1669,11 +1672,12 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner)
yyg->yy_hold_char = *yyg->yy_c_buf_p;
}
-/** Allocate and initialize an input buffer state.
- * @param file A readable stream.
- * @param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE.
- * @param yyscanner The scanner object.
- * @return the allocated buffer state.
+/*!
+ * \brief Allocate and initialize an input buffer state.
+ * \param file A readable stream.
+ * \param size The character buffer size in bytes. When in doubt, use @c YY_BUF_SIZE.
+ * \param yyscanner The scanner object.
+ * \return the allocated buffer state.
*/
YY_BUFFER_STATE ast_yy_create_buffer (FILE * file, int size , yyscan_t yyscanner)
{
@@ -1699,9 +1703,10 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner)
return b;
}
-/** Destroy the buffer.
- * @param b a buffer created with ast_yy_create_buffer()
- * @param yyscanner The scanner object.
+/*!
+ * \brief Destroy the buffer.
+ * \param b a buffer created with ast_yy_create_buffer()
+ * \param yyscanner The scanner object.
*/
void ast_yy_delete_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner)
{
@@ -1723,8 +1728,9 @@ static void ast_yy_load_buffer_state (yyscan_t yyscanner)
extern int isatty (int );
#endif /* __cplusplus */
-/* Initializes or reinitializes a buffer.
- * This function is sometimes called more than once on the same buffer,
+/*!
+ * \brief Initializes or reinitializes a buffer.
+ * \note This function is sometimes called more than once on the same buffer,
* such as during a ast_yyrestart() or at EOF.
*/
static void ast_yy_init_buffer (YY_BUFFER_STATE b, FILE * file , yyscan_t yyscanner)
@@ -1752,9 +1758,10 @@ extern int isatty (int );
errno = oerrno;
}
-/** Discard all buffered characters. On the next scan, YY_INPUT will be called.
- * @param b the buffer state to be flushed, usually @c YY_CURRENT_BUFFER.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Discard all buffered characters. On the next scan, YY_INPUT will be called.
+ * \param b the buffer state to be flushed, usually @c YY_CURRENT_BUFFER.
+ * \param yyscanner The scanner object.
*/
void ast_yy_flush_buffer (YY_BUFFER_STATE b , yyscan_t yyscanner)
{
@@ -1780,11 +1787,12 @@ extern int isatty (int );
ast_yy_load_buffer_state(yyscanner );
}
-/** Pushes the new state onto the stack. The new state becomes
+/*!
+ * \brief Pushes the new state onto the stack. The new state becomes
* the current state. This function will allocate the stack
* if necessary.
- * @param new_buffer The new state.
- * @param yyscanner The scanner object.
+ * \param new_buffer The new state.
+ * \param yyscanner The scanner object.
*/
void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
{
@@ -1813,9 +1821,10 @@ void ast_yypush_buffer_state (YY_BUFFER_STATE new_buffer , yyscan_t yyscanner)
yyg->yy_did_buffer_switch_on_eof = 1;
}
-/** Removes and deletes the top of the stack, if present.
+/*!
+ * \brief Removes and deletes the top of the stack, if present.
* The next element becomes the new top.
- * @param yyscanner The scanner object.
+ * \param yyscanner The scanner object.
*/
void ast_yypop_buffer_state (yyscan_t yyscanner)
{
@@ -1877,11 +1886,12 @@ static void ast_yyensure_buffer_stack (yyscan_t yyscanner)
}
}
-/** Setup the input buffer state to scan directly from a user-specified character buffer.
- * @param base the character buffer
- * @param size the size in bytes of the character buffer
- * @param yyscanner The scanner object.
- * @return the newly allocated buffer state object.
+/*!
+ * \brief Setup the input buffer state to scan directly from a user-specified character buffer.
+ * \param base the character buffer
+ * \param size the size in bytes of the character buffer
+ * \param yyscanner The scanner object.
+ * \return the newly allocated buffer state object.
*/
YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yyscanner)
{
@@ -1912,12 +1922,13 @@ YY_BUFFER_STATE ast_yy_scan_buffer (char * base, yy_size_t size , yyscan_t yys
return b;
}
-/** Setup the input buffer state to scan a string. The next call to ast_yylex() will
- * scan from a @e copy of @a str.
- * @param str a NUL-terminated string to scan
- * @param yyscanner The scanner object.
- * @return the newly allocated buffer state object.
- * @note If you want to scan bytes that may contain NUL values, then use
+/*!
+ * \brief Setup the input buffer state to scan a string. The next call to ast_yylex() will
+ * scan from a \e copy of \a str.
+ * \param yystr a NUL-terminated string to scan
+ * \param yyscanner The scanner object.
+ * \return the newly allocated buffer state object.
+ * \note If you want to scan bytes that may contain NUL values, then use
* ast_yy_scan_bytes() instead.
*/
YY_BUFFER_STATE ast_yy_scan_string (yyconst char * yystr , yyscan_t yyscanner)
@@ -1926,12 +1937,13 @@ YY_BUFFER_STATE ast_yy_scan_string (yyconst char * yystr , yyscan_t yyscanner)
return ast_yy_scan_bytes(yystr,strlen(yystr) ,yyscanner);
}
-/** Setup the input buffer state to scan the given bytes. The next call to ast_yylex() will
- * scan from a @e copy of @a bytes.
- * @param bytes the byte buffer to scan
- * @param len the number of bytes in the buffer pointed to by @a bytes.
- * @param yyscanner The scanner object.
- * @return the newly allocated buffer state object.
+/*!
+ * \brief Setup the input buffer state to scan the given bytes. The next call to ast_yylex() will
+ * scan from a \e copy of \a bytes.
+ * \param yybytes the byte buffer to scan
+ * \param _yybytes_len the number of bytes in the buffer pointed to by \a bytes.
+ * \param yyscanner The scanner object.
+ * \return the newly allocated buffer state object.
*/
YY_BUFFER_STATE ast_yy_scan_bytes (yyconst char * yybytes, int _yybytes_len , yyscan_t yyscanner)
{
@@ -1992,8 +2004,9 @@ static void yy_fatal_error (yyconst char* msg , yyscan_t yyscanner)
/* Accessor methods (get/set functions) to struct members. */
-/** Get the user-defined data for this scanner.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the user-defined data for this scanner.
+ * \param yyscanner The scanner object.
*/
YY_EXTRA_TYPE ast_yyget_extra (yyscan_t yyscanner)
{
@@ -2001,8 +2014,9 @@ YY_EXTRA_TYPE ast_yyget_extra (yyscan_t yyscanner)
return yyextra;
}
-/** Get the current line number.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the current line number.
+ * \param yyscanner The scanner object.
*/
int ast_yyget_lineno (yyscan_t yyscanner)
{
@@ -2014,8 +2028,9 @@ int ast_yyget_lineno (yyscan_t yyscanner)
return yylineno;
}
-/** Get the current column number.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the current column number.
+ * \param yyscanner The scanner object.
*/
int ast_yyget_column (yyscan_t yyscanner)
{
@@ -2027,8 +2042,9 @@ int ast_yyget_column (yyscan_t yyscanner)
return yycolumn;
}
-/** Get the input stream.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the input stream.
+ * \param yyscanner The scanner object.
*/
FILE *ast_yyget_in (yyscan_t yyscanner)
{
@@ -2036,8 +2052,9 @@ FILE *ast_yyget_in (yyscan_t yyscanner)
return yyin;
}
-/** Get the output stream.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the output stream.
+ * \param yyscanner The scanner object.
*/
FILE *ast_yyget_out (yyscan_t yyscanner)
{
@@ -2045,8 +2062,9 @@ FILE *ast_yyget_out (yyscan_t yyscanner)
return yyout;
}
-/** Get the length of the current token.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the length of the current token.
+ * \param yyscanner The scanner object.
*/
int ast_yyget_leng (yyscan_t yyscanner)
{
@@ -2054,8 +2072,9 @@ int ast_yyget_leng (yyscan_t yyscanner)
return yyleng;
}
-/** Get the current token.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Get the current token.
+ * \param yyscanner The scanner object.
*/
char *ast_yyget_text (yyscan_t yyscanner)
@@ -2064,9 +2083,10 @@ char *ast_yyget_text (yyscan_t yyscanner)
return yytext;
}
-/** Set the user-defined data. This data is never touched by the scanner.
- * @param user_defined The data to be associated with this scanner.
- * @param yyscanner The scanner object.
+/*!
+ * \brief Set the user-defined data. This data is never touched by the scanner.
+ * \param user_defined The data to be associated with this scanner.
+ * \param yyscanner The scanner object.
*/
void ast_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner)
{
@@ -2074,9 +2094,10 @@ void ast_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner)
yyextra = user_defined ;
}
-/** Set the current line number.
- * @param line_number
- * @param yyscanner The scanner object.
+/*!
+ * \brief Set the current line number.
+ * \param line_number
+ * \param yyscanner The scanner object.
*/
void ast_yyset_lineno (int line_number , yyscan_t yyscanner)
{
@@ -2089,9 +2110,10 @@ void ast_yyset_lineno (int line_number , yyscan_t yyscanner)
yylineno = line_number;
}
-/** Set the current column.
- * @param line_number
- * @param yyscanner The scanner object.
+/*!
+ * \brief Set the current column.
+ * \param column_no
+ * \param yyscanner The scanner object.
*/
void ast_yyset_column (int column_no , yyscan_t yyscanner)
{
@@ -2104,11 +2126,12 @@ void ast_yyset_column (int column_no , yyscan_t yyscanner)
yycolumn = column_no;
}
-/** Set the input stream. This does not discard the current
+/*!
+ * \brief Set the input stream. This does not discard the current
* input buffer.
- * @param in_str A readable stream.
- * @param yyscanner The scanner object.
- * @see ast_yy_switch_to_buffer
+ * \param in_str A readable stream.
+ * \param yyscanner The scanner object.
+ * \see ast_yy_switch_to_buffer
*/
void ast_yyset_in (FILE * in_str , yyscan_t yyscanner)
{
@@ -2162,9 +2185,10 @@ void ast_yyset_lloc (YYLTYPE * yylloc_param , yyscan_t yyscanner)
/* User-visible API */
-/* ast_yylex_init is special because it creates the scanner itself, so it is
- * the ONLY reentrant function that doesn't take the scanner as the last argument.
- * That's why we explicitly handle the declaration, instead of using our macros.
+/*! \brief ast_yylex_init is special because it creates the scanner itself.
+ *
+ * It is the ONLY reentrant function that doesn't take the scanner as the last argument.
+ * \note That's why we explicitly handle the declaration, instead of using our macros.
*/
int ast_yylex_init(yyscan_t* ptr_yy_globals)
diff --git a/main/channel.c b/main/channel.c
index d6710ccc3dfd5d8b5469a5b2cba3f971e433a84d..05f54ffdf83f49e2520a0e753d2b5530c31d8edd 100644
--- a/main/channel.c
+++ b/main/channel.c
@@ -4059,7 +4059,10 @@ int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1)
}
/*! \brief Send manager event for bridge link and unlink events.
- \param type 1 for core, 2 for native
+ * \param onoff Link/Unlinked
+ * \param type 1 for core, 2 for native
+ * \param c0 first channel in bridge
+ * \param c1 second channel in bridge
*/
static void manager_bridge_event(int onoff, int type, struct ast_channel *c0, struct ast_channel *c1)
{
diff --git a/main/config.c b/main/config.c
index ce7bb50b276ff3dbb79d7244b77ab3ccc537f12d..bedaa80ddf0f02db113539cae97c9ae1f992e622 100644
--- a/main/config.c
+++ b/main/config.c
@@ -907,9 +907,11 @@ static void config_cache_attribute(const char *configfile, enum config_cache_att
}
/*! \brief parse one line in the configuration.
+ * \verbatim
* We can have a category header [foo](...)
* a directive #include / #exec
* or a regular line name = value
+ * \endverbatim
*/
static int process_text_line(struct ast_config *cfg, struct ast_category **cat,
char *buf, int lineno, const char *configfile, struct ast_flags flags,
diff --git a/res/res_config_curl.c b/res/res_config_curl.c
index 69e448dd75ea88eeff015a78b29f0002342b27e5..7556a70661f1fe083b50a953c4925cf3cf5276b4 100644
--- a/res/res_config_curl.c
+++ b/res/res_config_curl.c
@@ -277,8 +277,8 @@ static int update_curl(const char *url, const char *unused, const char *keyfield
/*!
* \brief Execute an INSERT query
- * \param database
- * \param table
+ * \param url
+ * \param unused
* \param ap list containing one or more field/value set(s)
*
* Insert a new record into database table, prepare the sql statement.
diff --git a/res/res_config_ldap.c b/res/res_config_ldap.c
index 99de94c82a2ff780df43c78a1010a1237e74ab4b..ab71d8b7ee5a7a8ea2c32bce7056de6d2c18de86 100644
--- a/res/res_config_ldap.c
+++ b/res/res_config_ldap.c
@@ -652,7 +652,7 @@ static char *cleaned_basedn(struct ast_channel *channel, const char *basedn)
return cbasedn;
}
-/*! \brief Replace <search> by <by> in string. No check is done on string allocated size ! */
+/*! \brief Replace \<search\> by \<by\> in string. No check is done on string allocated size ! */
static int replace_string_in_string(char *string, const char *search, const char *by)
{
int search_len = strlen(search);
@@ -967,10 +967,12 @@ static struct ast_config *realtime_multi_ldap(const char *basedn,
/*!
* \brief Sorting alogrithm for qsort to find the order of the variables \a a and \a b
- * \param \a a pointer to category_and_metric struct
- * \param \a b pointer to category_and_metric struct
+ * \param a pointer to category_and_metric struct
+ * \param b pointer to category_and_metric struct
*
- * \return the -1,0,1 (zero for equal, -1 for if b is greater, and 1 if a is greater)
+ * \retval -1 for if b is greater
+ * \retval 0 zero for equal
+ * \retval 1 if a is greater
*/
static int compare_categories(const void *a, const void *b)
{
diff --git a/res/res_phoneprov.c b/res/res_phoneprov.c
index febf2ed056943d12f9b2476dea687ac6502d348d..acbe99a64c85dfc521624cb40b9ff670349d44cf 100644
--- a/res/res_phoneprov.c
+++ b/res/res_phoneprov.c
@@ -20,7 +20,7 @@
/*! \file
*
- * \Phone provisioning application for the asterisk internal http server
+ * \brief Phone provisioning application for the asterisk internal http server
*
* \author Matthew Brooks <mbrooks@digium.com>
* \author Terry Wilson <twilson@digium.com>