<p>Friendly Automation <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/17347">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Kevin Harwell: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">progdocs: Avoid 'name' with Doxygen \file.<br><br>Fixes four misuses of the parameter 'name'. Additionally, for<br>consistency and to avoid such an issue in future, those few other<br>places, which used '\file name', were changed just to '\file'. Then,<br>Doxygen uses the name of the current file.<br><br>ASTERISK-29733<br><br>Change-Id: I0c18b4c863c6988b138c77448057349a9ee7052d<br>---<br>M include/asterisk/calendar.h<br>M include/asterisk/dlinkedlists.h<br>M include/asterisk/enum.h<br>M include/asterisk/http.h<br>M include/asterisk/http_websocket.h<br>M include/asterisk/iostream.h<br>M include/asterisk/linkedlists.h<br>M include/asterisk/logger.h<br>M include/asterisk/res_prometheus.h<br>M include/asterisk/sdp_srtp.h<br>M include/asterisk/srv.h<br>M include/asterisk/stun.h<br>M include/asterisk/syslog.h<br>M include/asterisk/taskprocessor.h<br>M include/asterisk/tcptls.h<br>M include/asterisk/threadstorage.h<br>M include/asterisk/timing.h<br>M main/optional_api.c<br>M res/prometheus/prometheus_internal.h<br>M res/res_srtp.c<br>20 files changed, 47 insertions(+), 28 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/asterisk/calendar.h b/include/asterisk/calendar.h</span><br><span>index 7bb0c82..c21399e 100644</span><br><span>--- a/include/asterisk/calendar.h</span><br><span>+++ b/include/asterisk/calendar.h</span><br><span>@@ -27,7 +27,9 @@</span><br><span> #include "asterisk/dial.h"</span><br><span> #include "asterisk/module.h"</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \file calendar.h</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief A general API for managing calendar events with Asterisk</span><br><span> *</span><br><span> * \author Terry Wilson <twilson@digium.com></span><br><span>diff --git a/include/asterisk/dlinkedlists.h b/include/asterisk/dlinkedlists.h</span><br><span>index 0bfa232..0251f95 100644</span><br><span>--- a/include/asterisk/dlinkedlists.h</span><br><span>+++ b/include/asterisk/dlinkedlists.h</span><br><span>@@ -28,7 +28,8 @@</span><br><span> #include "asterisk/lock.h"</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file dlinkedlists.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief A set of macros to manage doubly-linked lists.</span><br><span> */</span><br><span> </span><br><span>diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h</span><br><span>index 2ce85cc..e62cddb 100644</span><br><span>--- a/include/asterisk/enum.h</span><br><span>+++ b/include/asterisk/enum.h</span><br><span>@@ -16,9 +16,11 @@</span><br><span> * at the top of the source tree.</span><br><span> */</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \file enum.h</span><br><span style="color: hsl(0, 100%, 40%);">- \brief DNS and ENUM functions</span><br><span style="color: hsl(0, 100%, 40%);">-*/</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief DNS and ENUM functions</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span> </span><br><span> #ifndef _ASTERISK_ENUM_H</span><br><span> #define _ASTERISK_ENUM_H</span><br><span>diff --git a/include/asterisk/http.h b/include/asterisk/http.h</span><br><span>index 63fb223..f35c7bc 100644</span><br><span>--- a/include/asterisk/http.h</span><br><span>+++ b/include/asterisk/http.h</span><br><span>@@ -24,8 +24,10 @@</span><br><span> #include "asterisk/linkedlists.h"</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file http.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief Support for Private Asterisk HTTP Servers.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \note Note: The Asterisk HTTP servers are extremely simple and minimal and</span><br><span> * only support the "GET" method.</span><br><span> *</span><br><span>diff --git a/include/asterisk/http_websocket.h b/include/asterisk/http_websocket.h</span><br><span>index 6fd2d0a..323bb9c 100644</span><br><span>--- a/include/asterisk/http_websocket.h</span><br><span>+++ b/include/asterisk/http_websocket.h</span><br><span>@@ -31,7 +31,8 @@</span><br><span> #define AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT_STR "100"</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file http_websocket.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief Support for WebSocket connections within the Asterisk HTTP server and client</span><br><span> * WebSocket connections to a server.</span><br><span> *</span><br><span>diff --git a/include/asterisk/iostream.h b/include/asterisk/iostream.h</span><br><span>index 602fefb..ed09041 100644</span><br><span>--- a/include/asterisk/iostream.h</span><br><span>+++ b/include/asterisk/iostream.h</span><br><span>@@ -20,7 +20,7 @@</span><br><span> #define _ASTERISK_IOSTREAM_H</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file iostream.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief Generic abstraction for input/output streams.</span><br><span> */</span><br><span>diff --git a/include/asterisk/linkedlists.h b/include/asterisk/linkedlists.h</span><br><span>index 5f50c75..ae08a00 100644</span><br><span>--- a/include/asterisk/linkedlists.h</span><br><span>+++ b/include/asterisk/linkedlists.h</span><br><span>@@ -23,7 +23,8 @@</span><br><span> #include "asterisk/lock.h"</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file linkedlists.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief A set of macros to manage forward-linked lists.</span><br><span> */</span><br><span> </span><br><span>diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h</span><br><span>index 170fb68..c1b023f 100644</span><br><span>--- a/include/asterisk/logger.h</span><br><span>+++ b/include/asterisk/logger.h</span><br><span>@@ -17,10 +17,11 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- \file logger.h</span><br><span style="color: hsl(0, 100%, 40%);">- \brief Support for logging to various files, console and syslog</span><br><span style="color: hsl(0, 100%, 40%);">- Configuration in file logger.conf</span><br><span style="color: hsl(0, 100%, 40%);">-*/</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Support for logging to various files, console and syslog</span><br><span style="color: hsl(120, 100%, 40%);">+ * Configuration in file logger.conf</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span> </span><br><span> #ifndef _ASTERISK_LOGGER_H</span><br><span> #define _ASTERISK_LOGGER_H</span><br><span>diff --git a/include/asterisk/res_prometheus.h b/include/asterisk/res_prometheus.h</span><br><span>index 5da60d6..cac9a44 100644</span><br><span>--- a/include/asterisk/res_prometheus.h</span><br><span>+++ b/include/asterisk/res_prometheus.h</span><br><span>@@ -20,7 +20,7 @@</span><br><span> #define RES_PROMETHEUS_H__</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file res_prometheus</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief Asterisk Prometheus Metrics</span><br><span> *</span><br><span>diff --git a/include/asterisk/sdp_srtp.h b/include/asterisk/sdp_srtp.h</span><br><span>index cf89fa9..333dec1 100644</span><br><span>--- a/include/asterisk/sdp_srtp.h</span><br><span>+++ b/include/asterisk/sdp_srtp.h</span><br><span>@@ -16,7 +16,8 @@</span><br><span> * at the top of the source tree.</span><br><span> */</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \file sdp_srtp.h</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief SRTP and SDP Security descriptions</span><br><span> *</span><br><span>diff --git a/include/asterisk/srv.h b/include/asterisk/srv.h</span><br><span>index 79c1126..26dab35 100644</span><br><span>--- a/include/asterisk/srv.h</span><br><span>+++ b/include/asterisk/srv.h</span><br><span>@@ -23,7 +23,8 @@</span><br><span> #ifndef _ASTERISK_SRV_H</span><br><span> #define _ASTERISK_SRV_H</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \file srv.h</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief Support for DNS SRV records, used in to locate SIP services.</span><br><span> *</span><br><span>diff --git a/include/asterisk/stun.h b/include/asterisk/stun.h</span><br><span>index 90c6ecc..d02859e 100644</span><br><span>--- a/include/asterisk/stun.h</span><br><span>+++ b/include/asterisk/stun.h</span><br><span>@@ -17,7 +17,8 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file stun.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief STUN support.</span><br><span> *</span><br><span> * STUN is defined in RFC 3489.</span><br><span>diff --git a/include/asterisk/syslog.h b/include/asterisk/syslog.h</span><br><span>index 45d351a..b14b4e1 100644</span><br><span>--- a/include/asterisk/syslog.h</span><br><span>+++ b/include/asterisk/syslog.h</span><br><span>@@ -17,7 +17,8 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file syslog.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief Syslog support functions for Asterisk logging.</span><br><span> */</span><br><span> </span><br><span>diff --git a/include/asterisk/taskprocessor.h b/include/asterisk/taskprocessor.h</span><br><span>index fca3edc..9943ae0 100644</span><br><span>--- a/include/asterisk/taskprocessor.h</span><br><span>+++ b/include/asterisk/taskprocessor.h</span><br><span>@@ -17,7 +17,8 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file taskprocessor.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief An API for managing task processing threads that can be shared across modules</span><br><span> *</span><br><span> * \author Dwayne M. Hubbard <dhubbard@digium.com></span><br><span>diff --git a/include/asterisk/tcptls.h b/include/asterisk/tcptls.h</span><br><span>index 0b943ce..66918c8 100644</span><br><span>--- a/include/asterisk/tcptls.h</span><br><span>+++ b/include/asterisk/tcptls.h</span><br><span>@@ -17,9 +17,10 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file tcptls.h</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief Generic support for tcp/tls servers in Asterisk.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \note In order to have TLS/SSL support, we need the openssl libraries.</span><br><span> * Still we can decide whether or not to use them by commenting</span><br><span> * in or out the DO_SSL macro.</span><br><span>diff --git a/include/asterisk/threadstorage.h b/include/asterisk/threadstorage.h</span><br><span>index 8c3ca00..aadb87c 100644</span><br><span>--- a/include/asterisk/threadstorage.h</span><br><span>+++ b/include/asterisk/threadstorage.h</span><br><span>@@ -17,10 +17,12 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file threadstorage.h</span><br><span style="color: hsl(0, 100%, 40%);">- * \author Russell Bryant <russell@digium.com></span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \brief Definitions to aid in the use of thread local storage</span><br><span> *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \author Russell Bryant <russell@digium.com></span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span> * \arg \ref AstThreadStorage</span><br><span> */</span><br><span> </span><br><span>diff --git a/include/asterisk/timing.h b/include/asterisk/timing.h</span><br><span>index 5dad850..e49777c 100644</span><br><span>--- a/include/asterisk/timing.h</span><br><span>+++ b/include/asterisk/timing.h</span><br><span>@@ -18,7 +18,7 @@</span><br><span> */</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- \file timing.h</span><br><span style="color: hsl(120, 100%, 40%);">+ \file</span><br><span> \brief Timing source management</span><br><span> \author Kevin P. Fleming <kpfleming@digium.com></span><br><span> \author Russell Bryant <russell@digium.com></span><br><span>diff --git a/main/optional_api.c b/main/optional_api.c</span><br><span>index d63129c..afa9661 100644</span><br><span>--- a/main/optional_api.c</span><br><span>+++ b/main/optional_api.c</span><br><span>@@ -24,8 +24,8 @@</span><br><span> </span><br><span> #if defined(OPTIONAL_API)</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*</span><br><span style="color: hsl(0, 100%, 40%);">- * \file Optional API innards.</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * The calls to ast_optional_api_*() happen implicitly from \c __constructor__</span><br><span> * calls which are defined in header files. This means that some number of them</span><br><span>diff --git a/res/prometheus/prometheus_internal.h b/res/prometheus/prometheus_internal.h</span><br><span>index ad6c528..6e2bff2 100644</span><br><span>--- a/res/prometheus/prometheus_internal.h</span><br><span>+++ b/res/prometheus/prometheus_internal.h</span><br><span>@@ -20,11 +20,11 @@</span><br><span> #define PROMETHEUS_INTERNAL_H__</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(0, 100%, 40%);">- * \file prometheus_internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief Prometheus Metric Internal API</span><br><span> *</span><br><span style="color: hsl(0, 100%, 40%);">- * This module provides internal APIs for \file res_prometheus.</span><br><span style="color: hsl(120, 100%, 40%);">+ * This module provides internal APIs for res_prometheus.</span><br><span> * It should not be used outsize of that module, and should</span><br><span> * typically only provide intialization functions for units that</span><br><span> * want to register metrics / handlers with the core API.</span><br><span>diff --git a/res/res_srtp.c b/res/res_srtp.c</span><br><span>index cdd95af..e10421c 100644</span><br><span>--- a/res/res_srtp.c</span><br><span>+++ b/res/res_srtp.c</span><br><span>@@ -18,7 +18,8 @@</span><br><span> * Builds on libSRTP http://srtp.sourceforge.net</span><br><span> */</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \file res_srtp.c</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span> *</span><br><span> * \brief Secure RTP (SRTP)</span><br><span> *</span><br><span></span><br></pre><div style="white-space:pre-wrap"></div><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/17347">change 17347</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/17347"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 19 </div>
<div style="display:none"> Gerrit-Change-Id: I0c18b4c863c6988b138c77448057349a9ee7052d </div>
<div style="display:none"> Gerrit-Change-Number: 17347 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: Alexander Traud <pabstraud@compuserve.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>