From e1fbf578dbc6d898ea36d4228eb0f6c1f425a137 Mon Sep 17 00:00:00 2001 From: Gernot Date: Mon, 14 Feb 2022 11:34:40 +0100 Subject: [PATCH] some file level doc fixed --- src/Doxyfile | 2 +- src/group.c | 2 +- src/growing_buf.c | 2 +- src/message_codec.c | 2 +- src/timestamp.c | 2 +- src/trans_auto.c | 2 +- src/transport.c | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Doxyfile b/src/Doxyfile index c3414725..a5a44d89 100644 --- a/src/Doxyfile +++ b/src/Doxyfile @@ -60,7 +60,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY ="../doc/" +OUTPUT_DIRECTORY ="../doc/api" # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and diff --git a/src/group.c b/src/group.c index 1e90f6d8..158ac5e7 100644 --- a/src/group.c +++ b/src/group.c @@ -1,6 +1,6 @@ /** * @file group.c - * @brief Description for doxygen is missing (TODO) + * @brief Implementation of in-memory objects and functions for representation of groups * @license This file is under GNU General Public License 3.0 - see LICENSE.txt */ diff --git a/src/growing_buf.c b/src/growing_buf.c index d7565e0e..e776bfab 100644 --- a/src/growing_buf.c +++ b/src/growing_buf.c @@ -1,4 +1,4 @@ -/* +/** * @file growing_buf.c * @brief implementation of growing buffer, which is needed by the ASN.1 implementation * i.e. for encoding to XER diff --git a/src/message_codec.c b/src/message_codec.c index 0ea3f96f..50c6511d 100644 --- a/src/message_codec.c +++ b/src/message_codec.c @@ -1,5 +1,5 @@ /** - * @file ASN1Message_codec.c + * @file message_codec.c * @brief Implementation for ASN1Message encode and decode functions which transform message payloads to * and from PER-encoded data, and XER text to and from PER * diff --git a/src/timestamp.c b/src/timestamp.c index a428084f..0333327c 100644 --- a/src/timestamp.c +++ b/src/timestamp.c @@ -1,6 +1,6 @@ /** * @file timestamp.c - * @brief File description for doxygen missing. FIXME + * @brief Implementation of timestamp creation, conversion, and manipulation functions * @license This file is under GNU General Public License 3.0 - see LICENSE.txt */ diff --git a/src/trans_auto.c b/src/trans_auto.c index 73cca9d5..ffe287d5 100644 --- a/src/trans_auto.c +++ b/src/trans_auto.c @@ -1,7 +1,7 @@ /** * @file trans_auto.c * @brief File description for doxygen missing. FIXME - * This file is under GNU General Public License 3.0 - see LICENSE.txt + * @license This file is under GNU General Public License 3.0 - see LICENSE.txt */ #include "trans_auto.h" diff --git a/src/transport.c b/src/transport.c index 0970aeaf..7f57fc33 100644 --- a/src/transport.c +++ b/src/transport.c @@ -1,7 +1,7 @@ /** * @file transport.c * @brief File description for doxygen missing. FIXME - * This file is under GNU General Public License 3.0 - see LICENSE.txt + * @license This file is under GNU General Public License 3.0 - see LICENSE.txt */ #include "pEp_internal.h"