From 59c0485c5cfbae3036226f3f9d0bf768884c7c9a Mon Sep 17 00:00:00 2001 From: albert-github Date: Mon, 9 May 2022 16:35:44 +0200 Subject: [PATCH] Documentation problems Fixing some, obvious, documentation problems --- src/aopt.cpp | 6 +++--- src/aopt.h | 4 ++-- src/input_handlers.h | 4 ++-- src/message_parser.h | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/aopt.cpp b/src/aopt.cpp index 57953995..270a7b6b 100644 --- a/src/aopt.cpp +++ b/src/aopt.cpp @@ -303,7 +303,7 @@ const char *aopt_value(const AOPT_OBJECT *aopt_obj, int key) { * @brief * Return AOPT Description struct of option selected via key. * - * @param[in] desc Option description. + * @param[in] aopt_desc Option description. * @param[in] key Option key. * * @retval pointer to description struct - on success @@ -333,7 +333,7 @@ const AOPT_DESC *aopt_get_desc(const AOPT_DESC *aopt_desc, int key) { * @brief * Return long name of option description selected via key. * - * @param[in] desc Option description. + * @param[in] aopt_desc Option description. * @param[in] key Option key. * * @retval pointer to string - on success @@ -354,7 +354,7 @@ const char *aopt_get_long_name(const AOPT_DESC *aopt_desc, int key) { * aopt_help * * @brief - * This function form help informaion basing options description and + * This function form help information basing options description and * return string with one. The string should be freed using the free() * function when you are done with it. NULL is returned if the it would * produce an empty string or if the string cannot be allocated. diff --git a/src/aopt.h b/src/aopt.h index 2e29fec4..e1686449 100644 --- a/src/aopt.h +++ b/src/aopt.h @@ -166,7 +166,7 @@ const char *aopt_value(const AOPT_OBJECT *aopt_obj, int key); * @brief * Return AOPT Description struct of option selected via key. * - * @param[in] desc Option description. + * @param[in] aopt_desc Option description. * @param[in] key Option key. * * @retval pointer to description struct - on success @@ -180,7 +180,7 @@ const AOPT_DESC *aopt_get_desc(const AOPT_DESC *aopt_desc, int key); * @brief * Return long name of option description selected via key. * - * @param[in] desc Option description. + * @param[in] aopt_desc Option description. * @param[in] key Option key. * * @retval pointer to string - on success diff --git a/src/input_handlers.h b/src/input_handlers.h index 4103781c..4015d4ce 100644 --- a/src/input_handlers.h +++ b/src/input_handlers.h @@ -44,9 +44,9 @@ class RecvFromInputHandler : public MessageParser { {} /** Receive pending data from a socket - * @param [in] socket descriptor + * @param [in] fd socket descriptor * @param [out] recvfrom_addr address to save peer address into - * @param [inout] in - storage size, out - actual address size + * @param [inout] size in - storage size, out - actual address size * @return status code */ inline int receive_pending_data(int fd, struct sockaddr *recvfrom_addr, socklen_t &size) diff --git a/src/message_parser.h b/src/message_parser.h index 34fcab39..a7549337 100644 --- a/src/message_parser.h +++ b/src/message_parser.h @@ -45,7 +45,7 @@ class MessageParser { } /** Process next buffer - * @param [in/out] recv_data receive stream context + * @param [inout] recv_data receive stream context * @param [in] buf buffer start * @param [in] len buffer length * @return false on message parsing or processing error, otherwise true