openvpn/sample
Frank Lichtenheld ccdffc08f3 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>
2024-12-27 18:30:22 +01:00
..
sample-config-files Various typo fixes 2024-11-28 13:32:59 +01:00
sample-keys Update Copyright statements to 2024 2024-03-18 18:46:26 +01:00
sample-plugins Review doxygen warnings 2024-12-27 18:30:22 +01:00
sample-scripts Add example script demonstrating TOTP via auth-pending 2022-09-11 22:32:26 +02:00
sample-windows Persist-key: enable persist-key option by default 2024-03-07 15:06:36 +01:00
Makefile.am Update Copyright statements to 2024 2024-03-18 18:46:26 +01:00