progdocs: Avoid 'name' with Doxygen \file.

Fixes one misuse 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: I1a915713d39223b03532549e6c16a98cefb4fc23
This commit is contained in:
Alexander Traud
2021-11-12 19:53:26 +01:00
committed by George Joseph
parent 94575f9a9a
commit 79cb1cdb65
18 changed files with 44 additions and 25 deletions

View File

@@ -27,7 +27,9 @@
#include "asterisk/dial.h" #include "asterisk/dial.h"
#include "asterisk/module.h" #include "asterisk/module.h"
/*! \file calendar.h /*!
* \file
*
* \brief A general API for managing calendar events with Asterisk * \brief A general API for managing calendar events with Asterisk
* *
* \author Terry Wilson <twilson@digium.com> * \author Terry Wilson <twilson@digium.com>

View File

@@ -28,7 +28,8 @@
#include "asterisk/lock.h" #include "asterisk/lock.h"
/*! /*!
* \file dlinkedlists.h * \file
*
* \brief A set of macros to manage doubly-linked lists. * \brief A set of macros to manage doubly-linked lists.
*/ */

View File

@@ -16,9 +16,11 @@
* at the top of the source tree. * 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 #ifndef _ASTERISK_ENUM_H
#define _ASTERISK_ENUM_H #define _ASTERISK_ENUM_H

View File

@@ -24,8 +24,10 @@
#include "asterisk/linkedlists.h" #include "asterisk/linkedlists.h"
/*! /*!
* \file http.h * \file
*
* \brief Support for Private Asterisk HTTP Servers. * \brief Support for Private Asterisk HTTP Servers.
*
* \note Note: The Asterisk HTTP servers are extremely simple and minimal and * \note Note: The Asterisk HTTP servers are extremely simple and minimal and
* only support the "GET" method. * only support the "GET" method.
* *

View File

@@ -31,7 +31,8 @@
#define AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT_STR "100" #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 * \brief Support for WebSocket connections within the Asterisk HTTP server and client
* WebSocket connections to a server. * WebSocket connections to a server.
* *

View File

@@ -20,7 +20,7 @@
#define _ASTERISK_IOSTREAM_H #define _ASTERISK_IOSTREAM_H
/*! /*!
* \file iostream.h * \file
* *
* \brief Generic abstraction for input/output streams. * \brief Generic abstraction for input/output streams.
*/ */

View File

@@ -23,7 +23,8 @@
#include "asterisk/lock.h" #include "asterisk/lock.h"
/*! /*!
* \file linkedlists.h * \file
*
* \brief A set of macros to manage forward-linked lists. * \brief A set of macros to manage forward-linked lists.
*/ */

View File

@@ -17,10 +17,11 @@
*/ */
/*! /*!
\file logger.h * \file
\brief Support for logging to various files, console and syslog *
Configuration in file logger.conf * \brief Support for logging to various files, console and syslog
*/ * Configuration in file logger.conf
*/
#ifndef _ASTERISK_LOGGER_H #ifndef _ASTERISK_LOGGER_H
#define _ASTERISK_LOGGER_H #define _ASTERISK_LOGGER_H

View File

@@ -16,7 +16,8 @@
* at the top of the source tree. * at the top of the source tree.
*/ */
/*! \file sdp_srtp.h /*!
* \file
* *
* \brief SRTP and SDP Security descriptions * \brief SRTP and SDP Security descriptions
* *

View File

@@ -23,7 +23,8 @@
#ifndef _ASTERISK_SRV_H #ifndef _ASTERISK_SRV_H
#define _ASTERISK_SRV_H #define _ASTERISK_SRV_H
/*! \file srv.h /*!
* \file
* *
* \brief Support for DNS SRV records, used in to locate SIP services. * \brief Support for DNS SRV records, used in to locate SIP services.
* *

View File

@@ -17,7 +17,8 @@
*/ */
/*! /*!
* \file stun.h * \file
*
* \brief STUN support. * \brief STUN support.
* *
* STUN is defined in RFC 3489. * STUN is defined in RFC 3489.

View File

@@ -17,7 +17,8 @@
*/ */
/*! /*!
* \file syslog.h * \file
*
* \brief Syslog support functions for Asterisk logging. * \brief Syslog support functions for Asterisk logging.
*/ */

View File

@@ -17,7 +17,8 @@
*/ */
/*! /*!
* \file taskprocessor.h * \file
*
* \brief An API for managing task processing threads that can be shared across modules * \brief An API for managing task processing threads that can be shared across modules
* *
* \author Dwayne M. Hubbard <dhubbard@digium.com> * \author Dwayne M. Hubbard <dhubbard@digium.com>

View File

@@ -17,9 +17,10 @@
*/ */
/*! /*!
* \file tcptls.h * \file
* *
* \brief Generic support for tcp/tls servers in Asterisk. * \brief Generic support for tcp/tls servers in Asterisk.
*
* \note In order to have TLS/SSL support, we need the openssl libraries. * \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 * Still we can decide whether or not to use them by commenting
* in or out the DO_SSL macro. * in or out the DO_SSL macro.

View File

@@ -17,10 +17,12 @@
*/ */
/*! /*!
* \file threadstorage.h * \file
* \author Russell Bryant <russell@digium.com> *
* \brief Definitions to aid in the use of thread local storage * \brief Definitions to aid in the use of thread local storage
* *
* \author Russell Bryant <russell@digium.com>
*
* \arg \ref AstThreadStorage * \arg \ref AstThreadStorage
*/ */

View File

@@ -18,7 +18,7 @@
*/ */
/*! /*!
\file timing.h \file
\brief Timing source management \brief Timing source management
\author Kevin P. Fleming <kpfleming@digium.com> \author Kevin P. Fleming <kpfleming@digium.com>
\author Russell Bryant <russell@digium.com> \author Russell Bryant <russell@digium.com>

View File

@@ -24,8 +24,8 @@
#if defined(OPTIONAL_API) #if defined(OPTIONAL_API)
/* /*!
* \file Optional API innards. * \file
* *
* The calls to ast_optional_api_*() happen implicitly from \c __constructor__ * 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 * calls which are defined in header files. This means that some number of them

View File

@@ -18,7 +18,8 @@
* Builds on libSRTP http://srtp.sourceforge.net * Builds on libSRTP http://srtp.sourceforge.net
*/ */
/*! \file res_srtp.c /*!
* \file
* *
* \brief Secure RTP (SRTP) * \brief Secure RTP (SRTP)
* *