Skip to content

Commit fdbf96f

Browse files
committed
tlshd: Translate kernel-style Doxygen comments in src/tlshd/main.c
I started the ktls-utils project using the Linux kernel flavor of Doxygen commenting which user-space Doxygen does not recognize by default. Convert existing comments in main.c to what a normal user space Doxygen run expects to see. This will enable deployment of an automatically-generated documentation web site. Signed-off-by: Chuck Lever <[email protected]>
1 parent ff28f1f commit fdbf96f

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

src/tlshd/main.c

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
/*
2-
* Handle a request for a TLS handshake on behalf of an
3-
* in-kernel TLS consumer.
1+
/**
2+
* @file main.c
3+
* @brief Handle a request for a TLS handshake on behalf of an
4+
* in-kernel TLS consumer
45
*
6+
* @copyright
57
* Copyright (c) 2022 - 2023 Oracle and/or its affiliates.
6-
*
8+
*/
9+
10+
/*
711
* ktls-utils is free software; you can redistribute it and/or
812
* modify it under the terms of the GNU General Public License as
913
* published by the Free Software Foundation; version 2.
@@ -56,11 +60,23 @@ static const struct option longopts[] = {
5660
{ NULL, 0, NULL, 0 }
5761
};
5862

59-
static void usage(const char *progname)
63+
/**
64+
* @brief Emit a program usage message on stderr
65+
* @param[in] progname NUL-terminated C string containing program name
66+
*/
67+
static void usage(char *progname)
6068
{
6169
fprintf(stderr, "usage: %s [-chsv]\n", progname);
6270
}
6371

72+
/**
73+
* @brief tlshd program entry point
74+
* @param[in] argc Count of elements in "argv"
75+
* @param[in] argv Command line parameters
76+
*
77+
* @retval EXIT_SUCCESS Program terminated normally
78+
* @retval EXIT_FAILURE Program encountered an error
79+
*/
6480
int main(int argc, char **argv)
6581
{
6682
static gchar config_file[PATH_MAX + 1];

0 commit comments

Comments
 (0)