From 57fef28dc9c7dec0096a74cab808905362a8d675 Mon Sep 17 00:00:00 2001 From: Alexander Traud Date: Fri, 12 Nov 2021 19:41:09 +0100 Subject: [PATCH] progdocs: Avoid 'name' with Doxygen \file. Fixes four misuses of the parameter 'name'. Additionally, for consistency and to avoid such an issue in future, those few other places, which used '\file name', were changed just to '\file'. Then, Doxygen uses the name of the current file. ASTERISK-29733 Change-Id: I0c18b4c863c6988b138c77448057349a9ee7052d --- include/asterisk/calendar.h | 4 +++- include/asterisk/dlinkedlists.h | 3 ++- include/asterisk/enum.h | 8 +++++--- include/asterisk/http.h | 4 +++- include/asterisk/http_websocket.h | 3 ++- include/asterisk/iostream.h | 2 +- include/asterisk/linkedlists.h | 3 ++- include/asterisk/logger.h | 9 +++++---- include/asterisk/res_prometheus.h | 2 +- include/asterisk/sdp_srtp.h | 3 ++- include/asterisk/srv.h | 3 ++- include/asterisk/stun.h | 3 ++- include/asterisk/syslog.h | 3 ++- include/asterisk/taskprocessor.h | 3 ++- include/asterisk/tcptls.h | 3 ++- include/asterisk/threadstorage.h | 6 ++++-- include/asterisk/timing.h | 2 +- main/optional_api.c | 4 ++-- res/prometheus/prometheus_internal.h | 4 ++-- res/res_srtp.c | 3 ++- 20 files changed, 47 insertions(+), 28 deletions(-) diff --git a/include/asterisk/calendar.h b/include/asterisk/calendar.h index 7bb0c820f3..c21399e351 100644 --- a/include/asterisk/calendar.h +++ b/include/asterisk/calendar.h @@ -27,7 +27,9 @@ #include "asterisk/dial.h" #include "asterisk/module.h" -/*! \file calendar.h +/*! + * \file + * * \brief A general API for managing calendar events with Asterisk * * \author Terry Wilson diff --git a/include/asterisk/dlinkedlists.h b/include/asterisk/dlinkedlists.h index 0bfa232dce..0251f95746 100644 --- a/include/asterisk/dlinkedlists.h +++ b/include/asterisk/dlinkedlists.h @@ -28,7 +28,8 @@ #include "asterisk/lock.h" /*! - * \file dlinkedlists.h + * \file + * * \brief A set of macros to manage doubly-linked lists. */ diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h index 2ce85ccb3a..e62cddb6d0 100644 --- a/include/asterisk/enum.h +++ b/include/asterisk/enum.h @@ -16,9 +16,11 @@ * at the top of the source tree. */ -/*! \file enum.h - \brief DNS and ENUM functions -*/ +/*! + * \file + * + * \brief DNS and ENUM functions + */ #ifndef _ASTERISK_ENUM_H #define _ASTERISK_ENUM_H diff --git a/include/asterisk/http.h b/include/asterisk/http.h index 63fb223bf9..f35c7bcb93 100644 --- a/include/asterisk/http.h +++ b/include/asterisk/http.h @@ -24,8 +24,10 @@ #include "asterisk/linkedlists.h" /*! - * \file http.h + * \file + * * \brief Support for Private Asterisk HTTP Servers. + * * \note Note: The Asterisk HTTP servers are extremely simple and minimal and * only support the "GET" method. * diff --git a/include/asterisk/http_websocket.h b/include/asterisk/http_websocket.h index 6fd2d0a6c5..323bb9cae8 100644 --- a/include/asterisk/http_websocket.h +++ b/include/asterisk/http_websocket.h @@ -31,7 +31,8 @@ #define AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT_STR "100" /*! - * \file http_websocket.h + * \file + * * \brief Support for WebSocket connections within the Asterisk HTTP server and client * WebSocket connections to a server. * diff --git a/include/asterisk/iostream.h b/include/asterisk/iostream.h index 602fefbab3..ed09041701 100644 --- a/include/asterisk/iostream.h +++ b/include/asterisk/iostream.h @@ -20,7 +20,7 @@ #define _ASTERISK_IOSTREAM_H /*! - * \file iostream.h + * \file * * \brief Generic abstraction for input/output streams. */ diff --git a/include/asterisk/linkedlists.h b/include/asterisk/linkedlists.h index 5f50c75354..ae08a009f7 100644 --- a/include/asterisk/linkedlists.h +++ b/include/asterisk/linkedlists.h @@ -23,7 +23,8 @@ #include "asterisk/lock.h" /*! - * \file linkedlists.h + * \file + * * \brief A set of macros to manage forward-linked lists. */ diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h index 170fb68fd7..c1b023ff73 100644 --- a/include/asterisk/logger.h +++ b/include/asterisk/logger.h @@ -17,10 +17,11 @@ */ /*! - \file logger.h - \brief Support for logging to various files, console and syslog - Configuration in file logger.conf -*/ + * \file + * + * \brief Support for logging to various files, console and syslog + * Configuration in file logger.conf + */ #ifndef _ASTERISK_LOGGER_H #define _ASTERISK_LOGGER_H diff --git a/include/asterisk/res_prometheus.h b/include/asterisk/res_prometheus.h index 5da60d6a80..cac9a44842 100644 --- a/include/asterisk/res_prometheus.h +++ b/include/asterisk/res_prometheus.h @@ -20,7 +20,7 @@ #define RES_PROMETHEUS_H__ /*! - * \file res_prometheus + * \file * * \brief Asterisk Prometheus Metrics * diff --git a/include/asterisk/sdp_srtp.h b/include/asterisk/sdp_srtp.h index cf89fa9e08..333dec1c74 100644 --- a/include/asterisk/sdp_srtp.h +++ b/include/asterisk/sdp_srtp.h @@ -16,7 +16,8 @@ * at the top of the source tree. */ -/*! \file sdp_srtp.h +/*! + * \file * * \brief SRTP and SDP Security descriptions * diff --git a/include/asterisk/srv.h b/include/asterisk/srv.h index 79c1126807..26dab35843 100644 --- a/include/asterisk/srv.h +++ b/include/asterisk/srv.h @@ -23,7 +23,8 @@ #ifndef _ASTERISK_SRV_H #define _ASTERISK_SRV_H -/*! \file srv.h +/*! + * \file * * \brief Support for DNS SRV records, used in to locate SIP services. * diff --git a/include/asterisk/stun.h b/include/asterisk/stun.h index 90c6ecc257..d02859eee1 100644 --- a/include/asterisk/stun.h +++ b/include/asterisk/stun.h @@ -17,7 +17,8 @@ */ /*! - * \file stun.h + * \file + * * \brief STUN support. * * STUN is defined in RFC 3489. diff --git a/include/asterisk/syslog.h b/include/asterisk/syslog.h index 45d351a731..b14b4e1ea0 100644 --- a/include/asterisk/syslog.h +++ b/include/asterisk/syslog.h @@ -17,7 +17,8 @@ */ /*! - * \file syslog.h + * \file + * * \brief Syslog support functions for Asterisk logging. */ diff --git a/include/asterisk/taskprocessor.h b/include/asterisk/taskprocessor.h index fca3edc02a..9943ae00b6 100644 --- a/include/asterisk/taskprocessor.h +++ b/include/asterisk/taskprocessor.h @@ -17,7 +17,8 @@ */ /*! - * \file taskprocessor.h + * \file + * * \brief An API for managing task processing threads that can be shared across modules * * \author Dwayne M. Hubbard diff --git a/include/asterisk/tcptls.h b/include/asterisk/tcptls.h index 0b943ce808..66918c8645 100644 --- a/include/asterisk/tcptls.h +++ b/include/asterisk/tcptls.h @@ -17,9 +17,10 @@ */ /*! - * \file tcptls.h + * \file * * \brief Generic support for tcp/tls servers in Asterisk. + * * \note In order to have TLS/SSL support, we need the openssl libraries. * Still we can decide whether or not to use them by commenting * in or out the DO_SSL macro. diff --git a/include/asterisk/threadstorage.h b/include/asterisk/threadstorage.h index 8c3ca0045d..aadb87c50c 100644 --- a/include/asterisk/threadstorage.h +++ b/include/asterisk/threadstorage.h @@ -17,10 +17,12 @@ */ /*! - * \file threadstorage.h - * \author Russell Bryant + * \file + * * \brief Definitions to aid in the use of thread local storage * + * \author Russell Bryant + * * \arg \ref AstThreadStorage */ diff --git a/include/asterisk/timing.h b/include/asterisk/timing.h index 5dad850e12..e49777cccf 100644 --- a/include/asterisk/timing.h +++ b/include/asterisk/timing.h @@ -18,7 +18,7 @@ */ /*! - \file timing.h + \file \brief Timing source management \author Kevin P. Fleming \author Russell Bryant diff --git a/main/optional_api.c b/main/optional_api.c index d63129cdd0..afa96616c1 100644 --- a/main/optional_api.c +++ b/main/optional_api.c @@ -24,8 +24,8 @@ #if defined(OPTIONAL_API) -/* - * \file Optional API innards. +/*! + * \file * * The calls to ast_optional_api_*() happen implicitly from \c __constructor__ * calls which are defined in header files. This means that some number of them diff --git a/res/prometheus/prometheus_internal.h b/res/prometheus/prometheus_internal.h index ad6c5282c2..6e2bff20fa 100644 --- a/res/prometheus/prometheus_internal.h +++ b/res/prometheus/prometheus_internal.h @@ -20,11 +20,11 @@ #define PROMETHEUS_INTERNAL_H__ /*! - * \file prometheus_internal + * \file * * \brief Prometheus Metric Internal API * - * This module provides internal APIs for \file res_prometheus. + * This module provides internal APIs for res_prometheus. * It should not be used outsize of that module, and should * typically only provide intialization functions for units that * want to register metrics / handlers with the core API. diff --git a/res/res_srtp.c b/res/res_srtp.c index cdd95af3a3..e10421cbb4 100644 --- a/res/res_srtp.c +++ b/res/res_srtp.c @@ -18,7 +18,8 @@ * Builds on libSRTP http://srtp.sourceforge.net */ -/*! \file res_srtp.c +/*! + * \file * * \brief Secure RTP (SRTP) *