[Asterisk-code-review] progdocs: Avoid 'name' with Doxygen \file. (asterisk[19])
Friendly Automation
asteriskteam at digium.com
Thu Nov 18 08:20:43 CST 2021
Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/17347 )
Change subject: progdocs: Avoid 'name' with Doxygen \file.
......................................................................
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
---
M include/asterisk/calendar.h
M include/asterisk/dlinkedlists.h
M include/asterisk/enum.h
M include/asterisk/http.h
M include/asterisk/http_websocket.h
M include/asterisk/iostream.h
M include/asterisk/linkedlists.h
M include/asterisk/logger.h
M include/asterisk/res_prometheus.h
M include/asterisk/sdp_srtp.h
M include/asterisk/srv.h
M include/asterisk/stun.h
M include/asterisk/syslog.h
M include/asterisk/taskprocessor.h
M include/asterisk/tcptls.h
M include/asterisk/threadstorage.h
M include/asterisk/timing.h
M main/optional_api.c
M res/prometheus/prometheus_internal.h
M res/res_srtp.c
20 files changed, 47 insertions(+), 28 deletions(-)
Approvals:
Kevin Harwell: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
diff --git a/include/asterisk/calendar.h b/include/asterisk/calendar.h
index 7bb0c82..c21399e 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 <twilson at digium.com>
diff --git a/include/asterisk/dlinkedlists.h b/include/asterisk/dlinkedlists.h
index 0bfa232..0251f95 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 2ce85cc..e62cddb 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 63fb223..f35c7bc 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 6fd2d0a..323bb9c 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 602fefb..ed09041 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 5f50c75..ae08a00 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 170fb68..c1b023f 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 5da60d6..cac9a44 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 cf89fa9..333dec1 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 79c1126..26dab35 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 90c6ecc..d02859e 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 45d351a..b14b4e1 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 fca3edc..9943ae0 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 <dhubbard at digium.com>
diff --git a/include/asterisk/tcptls.h b/include/asterisk/tcptls.h
index 0b943ce..66918c8 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 8c3ca00..aadb87c 100644
--- a/include/asterisk/threadstorage.h
+++ b/include/asterisk/threadstorage.h
@@ -17,10 +17,12 @@
*/
/*!
- * \file threadstorage.h
- * \author Russell Bryant <russell at digium.com>
+ * \file
+ *
* \brief Definitions to aid in the use of thread local storage
*
+ * \author Russell Bryant <russell at digium.com>
+ *
* \arg \ref AstThreadStorage
*/
diff --git a/include/asterisk/timing.h b/include/asterisk/timing.h
index 5dad850..e49777c 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 <kpfleming at digium.com>
\author Russell Bryant <russell at digium.com>
diff --git a/main/optional_api.c b/main/optional_api.c
index d63129c..afa9661 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 ad6c528..6e2bff2 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 cdd95af..e10421c 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)
*
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17347
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: 19
Gerrit-Change-Id: I0c18b4c863c6988b138c77448057349a9ee7052d
Gerrit-Change-Number: 17347
Gerrit-PatchSet: 2
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/251f8c55/attachment-0001.html>
More information about the asterisk-code-review
mailing list