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

diff --git a/include/asterisk/calendar.h b/include/asterisk/calendar.h
index 7bb0c820f35bd60155d3f63f92da341083eb81cc..c21399e351bd9805db858ce214c5458a2103dd63 100644 (file)
--- 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@digium.com>

diff --git a/include/asterisk/dlinkedlists.h b/include/asterisk/dlinkedlists.h
index 0bfa232dcedf07a52096a4342e6026e843baa62b..0251f957460ce787e8df0aa59baa9092f27f8448 100644 (file)
--- 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 2ce85ccb3a5827c1cbe3756aec0a18e812f6e0fb..e62cddb6d017adad540a36e745c23d5b8d63e0ad 100644 (file)
--- 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 63fb223bf9afedb51035ea620c1188c1f1f20a45..f35c7bcb93d480ddfeedad4362c063c3607dae91 100644 (file)
--- 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 6fd2d0a6c572b7e6a17b1c0da0c50d538ef6bd30..323bb9cae8eed7a04182501476f7131d7f000d6d 100644 (file)
--- 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 602fefbab34b7ae44a6f55948aeb306b274ff883..ed09041701da035d99bd67fa830a6d59dcc374b4 100644 (file)
--- 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 5f50c75354c02826f2303e9a691e9b6b1ffd7775..ae08a009f72660d9fe5873731099bfc79184ebb1 100644 (file)
--- 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 76d63671bea7db43e31d0a52227050182ba5f22e..08e90bbe422f38f71f0ea08715d35ca6d3f160e3 100644 (file)
--- 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 5da60d6a80814e18a877ad2494926f1bf596bf5e..cac9a448422b6ad1b4b6af71e659879a4ad41b9e 100644 (file)
--- 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 cf89fa9e08c7ff590a7c3f2c2cf28ac44a169219..333dec1c749eff6fb35ddf9e23b9353efbf7e943 100644 (file)
--- 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 79c11268072de0b262cd2b38feb42d13b93fdf4f..26dab358431465fdee8ea616bf841be615dd52f7 100644 (file)
--- 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 90c6ecc2579c042c74d02243ae80b362968b6acd..d02859eee1ebc711564cdff908cb66bc6eba4eae 100644 (file)
--- 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 45d351a73194a9b231e99614d2fa0ddcf2b28942..b14b4e1ea0e8d1e84dc11a303dbea706fd16cf3e 100644 (file)
--- 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 fca3edc02a7567a7d3fb4d302d217b1a1ec8e379..9943ae00b6ae803db5f80197c55bb544efeb567e 100644 (file)
--- 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@digium.com>

diff --git a/include/asterisk/tcptls.h b/include/asterisk/tcptls.h
index 0b943ce8081a6bba2f5b044bf31a2533e80cfbfe..66918c86456f01f52072175c80d0b5c96c64389c 100644 (file)
--- 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 8c3ca0045da93956c7c685c1c396c1645c269981..aadb87c50ce6f53fcefae5c19dc4e9fecac880fe 100644 (file)
--- a/include/asterisk/threadstorage.h
+++ b/include/asterisk/threadstorage.h
@@ -17,10 +17,12 @@
  */
 
 /*!
- * \file threadstorage.h
- * \author Russell Bryant <russell@digium.com>
+ * \file
+ *
  * \brief Definitions to aid in the use of thread local storage
  *
+ * \author Russell Bryant <russell@digium.com>
+ *
  * \arg \ref AstThreadStorage
  */
 

diff --git a/include/asterisk/timing.h b/include/asterisk/timing.h
index 5dad850e12a1497ae25d197a59b3623aceb65fb9..e49777cccf0e4e22e1a1f425d185b889c6fd3564 100644 (file)
--- 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@digium.com>
        \author Russell Bryant <russell@digium.com>

diff --git a/main/optional_api.c b/main/optional_api.c
index d63129cdd07330491cd8e5756f9ab4f83a750af7..afa96616c16663180dbb745afa5f4543bc9c3358 100644 (file)
--- 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 ad6c5282c2e0977dfac88ed90c3c9aea8d870a4b..6e2bff20fa720898569c79db2530396150b37bf5 100644 (file)
--- 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 cdd95af3a3f3445539c160bffed76d8ed7702bb9..e10421cbb4c8b4d2801180eece88278a87b44d47 100644 (file)
--- 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)
  *