Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation problems #181

Open
wants to merge 1 commit into
base: sockperf_v2
Choose a base branch
from
Open

Documentation problems #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/aopt.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/aopt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/input_handlers.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ class RecvFromInputHandler : public MessageParser<InPlaceAccumulation> {
{}

/** 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)
Expand Down
2 changes: 1 addition & 1 deletion src/message_parser.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down