sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
Alexander Traud 2021-11-12 19:41:09 +01:00 committed by George Joseph
parent ad67f6966e
commit 57fef28dc9
20 changed files with 47 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/asterisk/calendar.h
View File

@ -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>

3
include/asterisk/dlinkedlists.h
View File

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

8
include/asterisk/enum.h
View File

@ -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

4
include/asterisk/http.h
View File

@ -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.
*

3
include/asterisk/http_websocket.h
View File

@ -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.
*

2
include/asterisk/iostream.h
View File

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

3
include/asterisk/linkedlists.h
View File

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

9
include/asterisk/logger.h
View File

@ -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

2
include/asterisk/res_prometheus.h
View File

@ -20,7 +20,7 @@
#define RES_PROMETHEUS_H__
/*!
* \file res_prometheus
* \file
*
* \brief Asterisk Prometheus Metrics
*

3
include/asterisk/sdp_srtp.h
View File

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

3
include/asterisk/srv.h
View File

@ -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.
*

3
include/asterisk/stun.h
View File

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

3
include/asterisk/syslog.h
View File

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

3
include/asterisk/taskprocessor.h
View File

@ -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>

3
include/asterisk/tcptls.h
View File

@ -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.

6
include/asterisk/threadstorage.h
View File

@ -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
*/

2
include/asterisk/timing.h
View File

@ -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>

4
main/optional_api.c
View File

@ -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

4
res/prometheus/prometheus_internal.h
View File

@ -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.

3
res/res_srtp.c
View File

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