From 8cfe1161cc4bb3b719e7a4acd97aa88385ab9a44 Mon Sep 17 00:00:00 2001 From: Brad House Date: Mon, 11 Mar 2024 07:36:42 -0400 Subject: [PATCH] Doxygen: fix typos Fix reported typos in doxygen-style comments. Fixes Issue: #722 Credit: @dzalyalov88 --- include/ares_dns_record.h | 4 ++-- src/lib/ares__buf.h | 4 ++-- src/lib/ares__htable.h | 2 +- src/lib/ares__htable_asvp.h | 2 +- src/lib/ares__llist.h | 8 ++++---- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/include/ares_dns_record.h b/include/ares_dns_record.h index 3f802aef..7ae2d2f9 100644 --- a/include/ares_dns_record.h +++ b/include/ares_dns_record.h @@ -396,7 +396,7 @@ typedef enum { ARES_DNS_PARSE_AN_EXT_RAW = 1 << 3, /*! Parse Authority from later RFCs (no name compression) as RAW */ ARES_DNS_PARSE_NS_EXT_RAW = 1 << 4, - /*< Parse Additional from later RFCs (no name compression) as RAW */ + /*! Parse Additional from later RFCs (no name compression) as RAW */ ARES_DNS_PARSE_AR_EXT_RAW = 1 << 5 } ares_dns_parse_flags_t; @@ -468,7 +468,7 @@ CARES_EXTERN const char *ares_dns_rcode_tostr(ares_dns_rcode_t rcode); * \param[in] ipaddr ASCII string form of the ip address * \param[in,out] addr Must set "family" member to one of AF_UNSPEC, * AF_INET, AF_INET6 on input. - * \param[out] ptr_len Length of binary form address + * \param[out] out_len Length of binary form address * \return Pointer to start of binary address or NULL on error. */ CARES_EXTERN const void *ares_dns_pton(const char *ipaddr, diff --git a/src/lib/ares__buf.h b/src/lib/ares__buf.h index 52054a0b..7c3b5971 100644 --- a/src/lib/ares__buf.h +++ b/src/lib/ares__buf.h @@ -177,7 +177,7 @@ void ares__buf_append_finish(ares__buf_t *buf, size_t len); * * \param[in] buf Initialized buffer object. * \param[in] data Data to hex dump - * \param[in] data_len Length of data to hexdump + * \param[in] len Length of data to hexdump * \return ARES_SUCCESS on success. */ ares_status_t ares__buf_hexdump(ares__buf_t *buf, const unsigned char *data, @@ -536,7 +536,7 @@ size_t ares__buf_get_position(const ares__buf_t *buf); * \param[in] remaining_len maximum length that should be used for parsing * the string, this is often less than the remaining * buffer and is based on the RR record length. - * \param[out] str Pointer passed by reference to be filled in with + * \param[out] name Pointer passed by reference to be filled in with * allocated string of the parsed that must be * ares_free()'d by the caller. * \param[in] allow_multiple ARES_TRUE if it should attempt to parse multiple diff --git a/src/lib/ares__htable.h b/src/lib/ares__htable.h index fd1c0a23..6a408e5a 100644 --- a/src/lib/ares__htable.h +++ b/src/lib/ares__htable.h @@ -86,7 +86,7 @@ typedef ares_bool_t (*ares__htable_key_eq_t)(const void *key1, /*! Destroy the initialized hashtable * - * \param[in] initialized hashtable + * \param[in] htable initialized hashtable */ void ares__htable_destroy(ares__htable_t *htable); diff --git a/src/lib/ares__htable_asvp.h b/src/lib/ares__htable_asvp.h index ee253455..254f8312 100644 --- a/src/lib/ares__htable_asvp.h +++ b/src/lib/ares__htable_asvp.h @@ -71,7 +71,7 @@ ares__htable_asvp_t * /*! Retrieve an array of keys from the hashtable. * * \param[in] htable Initialized hashtable - * \param[out] num_keys Count of returned keys + * \param[out] num Count of returned keys * \return Array of keys in the hashtable. Must be free'd with ares_free(). */ ares_socket_t *ares__htable_asvp_keys(const ares__htable_asvp_t *htable, diff --git a/src/lib/ares__llist.h b/src/lib/ares__llist.h index bd18bb9e..ef3bc431 100644 --- a/src/lib/ares__llist.h +++ b/src/lib/ares__llist.h @@ -201,8 +201,8 @@ void ares__llist_destroy(ares__llist_t *list); /*! Detach node from the current list and re-attach it to the new list as the * last entry. * - * \param[in] node node to move - * \param[in] parent new list + * \param[in] node node to move + * \param[in] new_parent new list */ void ares__llist_node_move_parent_last(ares__llist_node_t *node, ares__llist_t *new_parent); @@ -210,8 +210,8 @@ void ares__llist_node_move_parent_last(ares__llist_node_t *node, /*! Detach node from the current list and re-attach it to the new list as the * first entry. * - * \param[in] node node to move - * \param[in] parent new list + * \param[in] node node to move + * \param[in] new_parent new list */ void ares__llist_node_move_parent_first(ares__llist_node_t *node, ares__llist_t *new_parent);