kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-05 12:42:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix some doxygen, typos and whitespace

Browse Source
This commit is contained in:
Bastian Triller
2025-09-21 11:59:48 +02:00
parent bd156f5f66
commit f68cfae069
12 changed files with 35 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
agi/eagi-sphinx-test.c
View File

@@ -12,7 +12,7 @@
* This code is released into public domain
* without any warranty of any kind.
*
* \ingroup agi
* \ingroup agi
*/
#include <stdio.h>

2
apps/app_dial.c
View File

@@ -214,7 +214,7 @@
and <emphasis>start</emphasis> execution at that location.</para>
<para>NOTE: Any channel variables you want the called channel to inherit from the caller channel must be
prefixed with one or two underbars ('_').</para>
<para>NOTE: Using this option from a GoSub() might not make sense as there would be no return points.</para>
<para>NOTE: Using this option from a Gosub() might not make sense as there would be no return points.</para>
</option>
<option name="g">
<para>Proceed with dialplan execution at the next priority in the current extension if the

2
apps/app_queue.c
View File

@@ -174,7 +174,7 @@
to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
<para>NOTE: Any channel variables you want the called channel to inherit from the caller channel must be
prefixed with one or two underbars ('_').</para>
<para>NOTE: Using this option from a GoSub() might not make sense as there would be no return points.</para>
<para>NOTE: Using this option from a Gosub() might not make sense as there would be no return points.</para>
</option>
<option name="h">
<para>Allow <emphasis>callee</emphasis> to hang up by pressing <literal>*</literal>.</para>

2
channels/chan_pjsip.c
View File

@@ -2463,7 +2463,7 @@ static int hangup_cause2sip(int cause)
case AST_CAUSE_NO_USER_RESPONSE: /* 18 */
return 408;
case AST_CAUSE_NO_ANSWER: /* 19 */
case AST_CAUSE_UNREGISTERED: /* 20 */
case AST_CAUSE_UNREGISTERED: /* 20 */
return 480;
case AST_CAUSE_CALL_REJECTED: /* 21 */
return 403;

2
configs/samples/manager.conf.sample
View File

@@ -90,7 +90,7 @@ bindaddr = 0.0.0.0
; events from being received in a stream (as opposed to this option which
; would prevent specified events from being generated at all).
;disabledevents = Newexten,Varset
;disabledevents = Newexten,VarSet
;[mark]
;secret = mysecret

10
include/asterisk/config_options.h
View File

@@ -167,12 +167,12 @@ struct aco_file {
};
struct aco_info {
const char *module; /*!< The name of the module whose config is being processed */
unsigned int hidden:1; /*!< If enabled, this config item is hidden from users */
aco_pre_apply_config pre_apply_config; /*!< A callback called after processing, but before changes are applied */
const char *module; /*!< The name of the module whose config is being processed */
unsigned int hidden:1; /*!< If enabled, this config item is hidden from users */
aco_pre_apply_config pre_apply_config; /*!< A callback called after processing, but before changes are applied */
aco_post_apply_config post_apply_config;/*!< A callback called after changes are applied */
aco_snapshot_alloc snapshot_alloc; /*!< Allocate an object to hold all global configs and item containers */
struct ao2_global_obj *global_obj; /*!< The global object array that holds the user-defined config object */
aco_snapshot_alloc snapshot_alloc; /*!< Allocate an object to hold all global configs and item containers */
struct ao2_global_obj *global_obj; /*!< The global object array that holds the user-defined config object */
struct aco_info_internal *internal;
struct aco_file *files[]; /*!< An array of aco_files to process */
};

16
include/asterisk/logger.h
View File

@@ -33,7 +33,7 @@ extern "C" {
#endif
#define EVENTLOG "event_log"
#define QUEUELOG "queue_log"
#define QUEUELOG "queue_log"
#define DEBUG_M(a) { \
a; \
@@ -55,7 +55,7 @@ extern "C" {
#define AST_CALLID_BUFFER_LENGTH 13
enum ast_logger_results {
AST_LOGGER_SUCCESS = 0, /*!< Log channel was created or deleted successfully*/
AST_LOGGER_SUCCESS = 0, /*!< Log channel was created or deleted successfully */
AST_LOGGER_FAILURE = 1, /*!< Log channel already exists for create or doesn't exist for deletion of log channel */
AST_LOGGER_DECLINE = -1, /*!< Log channel request was not accepted */
AST_LOGGER_ALLOC_ERROR = -2 /*!< filename allocation error */
@@ -68,7 +68,7 @@ enum ast_logger_results {
on which log you wish to output to. These are implemented as macros, that
will provide the function with the needed arguments.
\param level Type of log event
\param level Type of log event
\param file Will be provided by the AST_LOG_* macro
\param line Will be provided by the AST_LOG_* macro
\param function Will be provided by the AST_LOG_* macro
@@ -162,7 +162,9 @@ void __attribute__((format(printf, 5, 6))) ast_queue_log(const char *queuename,
*
* \details This works like ast_log, but prints verbose messages to the console depending on verbosity level set.
*
* \code
* ast_verbose(VERBOSE_PREFIX_3 "Whatever %s is happening\n", "nothing");
* \endcode
*
* This will print the message to the console if the verbose level is set to a level >= 3
*
@@ -224,9 +226,9 @@ void ast_console_toggle_mute(int fd, int silent);
/*!
* \brief enables or disables logging of a specified level to the console
* fd specifies the index of the console receiving the level change
* level specifies the index of the logging level being toggled
* state indicates whether logging will be on or off (0 for off, 1 for on)
* \param fd specifies the index of the console receiving the level change
* \param level specifies the index of the logging level being toggled
* \param state indicates whether logging will be on or off (0 for off, 1 for on)
*/
void ast_console_toggle_loglevel(int fd, int level, int state);
@@ -365,7 +367,7 @@ const char *ast_logger_get_dateformat(void);
ast_callid ast_create_callid(void);
/*!
* \brief extracts the callerid from the thread
* \brief extracts the callid from the thread
*
* \retval Non-zero Call id related to the thread
* \retval 0 if no call_id is present in the thread

4
include/asterisk/refer.h
View File

@@ -340,10 +340,6 @@ int ast_refer_notify_transfer_request(struct ast_channel *originating_chan, cons
const char *protocol_id, struct ast_channel *dest, struct ast_refer_params *params,
enum ast_control_transfer state);
/*!
* @}
*/
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif

22
main/config_options.c
View File

@@ -83,19 +83,19 @@ static struct ao2_container *xmldocs;
/*! \brief Value of the aco_option_type enum as strings */
static char *aco_option_type_string[] = {
"ACL", /* OPT_ACL_T, */
"Boolean", /* OPT_BOOL_T, */
"Boolean", /* OPT_BOOLFLAG_T, */
"String", /* OPT_CHAR_ARRAY_T, */
"Codec", /* OPT_CODEC_T, */
"Custom", /* OPT_CUSTOM_T, */
"Double", /* OPT_DOUBLE_T, */
"Integer", /* OPT_INT_T, */
"None", /* OPT_NOOP_T, */
"ACL", /* OPT_ACL_T, */
"Boolean", /* OPT_BOOL_T, */
"Boolean", /* OPT_BOOLFLAG_T, */
"String", /* OPT_CHAR_ARRAY_T, */
"Codec", /* OPT_CODEC_T, */
"Custom", /* OPT_CUSTOM_T, */
"Double", /* OPT_DOUBLE_T, */
"Integer", /* OPT_INT_T, */
"None", /* OPT_NOOP_T, */
"IP Address", /* OPT_SOCKADDR_T, */
"String", /* OPT_STRINGFIELD_T, */
"String", /* OPT_STRINGFIELD_T, */
"Unsigned Integer", /* OPT_UINT_T, */
"Boolean", /* OPT_YESNO_T, */
"Boolean", /* OPT_YESNO_T, */
"Time Length", /* OPT_TIMELEN_T, */
};
#endif /* AST_XML_DOCS */

2
main/features.c
View File

@@ -120,7 +120,7 @@
prefixed with one or two underbars ('_').</para>
</note>
<note>
<para>Using this option from a or GoSub() might not make sense as there would be no return points.</para>
<para>Using this option from a or Gosub() might not make sense as there would be no return points.</para>
</note>
<note>
<para>This option will override the 'x' option</para>

4
res/res_fax.c
View File

@@ -119,7 +119,7 @@
<description>
<para>This application is provided by res_fax, which is a FAX technology agnostic module
that utilizes FAX technology resource modules to complete a FAX transmission.</para>
<para>Session arguments can be set by the FAXOPT function and to check results of the ReceiveFAX() application.</para>
<para>Session arguments can be set by the FAXOPT function and to check results of the ReceiveFAX() application.</para>
</description>
<see-also>
<ref type="function">FAXOPT</ref>
@@ -161,7 +161,7 @@
<description>
<para>This application is provided by res_fax, which is a FAX technology agnostic module
that utilizes FAX technology resource modules to complete a FAX transmission.</para>
<para>Session arguments can be set by the FAXOPT function and to check results of the SendFAX() application.</para>
<para>Session arguments can be set by the FAXOPT function and to check results of the SendFAX() application.</para>
</description>
<see-also>
<ref type="function">FAXOPT</ref>

4
res/res_pjsip_session.c
View File

@@ -1836,8 +1836,8 @@ end:
* \brief Merge media states for a delayed session refresh
*
* \param session_name For log messages
* \param delayed_pending_state The pending media state at the time the resuest was queued
* \param delayed_active_state The active media state at the time the resuest was queued
* \param delayed_pending_state The pending media state at the time the request was queued
* \param delayed_active_state The active media state at the time the request was queued
* \param current_active_state The current active media state
* \param run_post_validation Whether to run validation on the resulting media state or not
*