]> git.ipfire.org Git - thirdparty/openvpn.git/commit
Review doxygen warnings
authorFrank Lichtenheld <frank@lichtenheld.com>
Fri, 27 Dec 2024 16:16:48 +0000 (17:16 +0100)
committerGert Doering <gert@greenie.muc.de>
Fri, 27 Dec 2024 17:30:22 +0000 (18:30 +0100)
commitccdffc08f3c9e672f68755876138e1f50468575f
treeceba98fd883367ee983bec18c601b2a530716b43
parent5bbf0aa484470486fcc2f491fba81605aa8649ed
Review doxygen warnings

We write doxygen comments but we do not verify them. So
quite some errors have crept in. Trying to reduce them
by reviewing the warnings output of doxygen and addressing
most of them.

Did generally ignore "The following parameter is not documented"
warnings (except those caused by typos). Fixing those will
require more work.

Usual errors fixed:
 - Wrong usage of @file
 - Wrong spellings of @param
 - Desync between function declaration and comment
   (usually param names)

Change-Id: I7a852eb5fafae3a0e85dd89ea6d4c91fcf2fab4e
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Arne Schwabe <arne-openvpn@rfc2549.org>
Message-Id: <20241227161648.3350-1-gert@greenie.muc.de>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg30256.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
49 files changed:
doc/doxygen/doc_compression.h
doc/doxygen/doc_protocol_overview.h
sample/sample-plugins/simple/base64.c
src/openvpn/argv.c
src/openvpn/buffer.h
src/openvpn/console.h
src/openvpn/console_builtin.c
src/openvpn/console_systemd.c
src/openvpn/crypto.h
src/openvpn/crypto_backend.h
src/openvpn/crypto_mbedtls.c
src/openvpn/crypto_mbedtls.h
src/openvpn/crypto_openssl.c
src/openvpn/crypto_openssl.h
src/openvpn/dns.c
src/openvpn/forward.h
src/openvpn/init.c
src/openvpn/lzo.c
src/openvpn/manage.c
src/openvpn/mbedtls_compat.h
src/openvpn/multi.h
src/openvpn/openssl_compat.h
src/openvpn/pkcs11_backend.h
src/openvpn/pkcs11_mbedtls.c
src/openvpn/pkcs11_openssl.c
src/openvpn/push.c
src/openvpn/ssl.c
src/openvpn/ssl.h
src/openvpn/ssl_backend.h
src/openvpn/ssl_common.h
src/openvpn/ssl_mbedtls.c
src/openvpn/ssl_mbedtls.h
src/openvpn/ssl_ncp.c
src/openvpn/ssl_ncp.h
src/openvpn/ssl_openssl.c
src/openvpn/ssl_openssl.h
src/openvpn/ssl_pkt.h
src/openvpn/ssl_util.h
src/openvpn/ssl_verify.c
src/openvpn/ssl_verify.h
src/openvpn/ssl_verify_backend.h
src/openvpn/ssl_verify_mbedtls.c
src/openvpn/ssl_verify_mbedtls.h
src/openvpn/ssl_verify_openssl.c
src/openvpn/ssl_verify_openssl.h
src/openvpn/tls_crypt.h
src/openvpn/tun.c
src/openvpn/tun.h
src/tapctl/tap.c