doc-comments: fix some of the complaints from doxygen

There's still frequent issue that documenting some parameters would be
mainly noise but doxygen will warn when not doing it.
WARN_IF_UNDOCUMENTED apparently doesn't cover this and
WARN_IF_DOC_ERROR would probably remove even some useful warnings.

diff --git a/daemon/bindings/impl.h b/daemon/bindings/impl.h
index bb11e1b28ffb1c75642a94da87bc958dcaeb160e..f981614dd1610159beb378fe204e46a23e9be877 100644 (file)
--- a/daemon/bindings/impl.h
+++ b/daemon/bindings/impl.h
@@ -15,7 +15,7 @@
 #endif
 
 
-/** Useful to stringify #defines into error strings. */
+/** Useful to stringify macros into error strings. */
 #define STR(s) STRINGIFY_TOKEN(s)
 #define STRINGIFY_TOKEN(s) #s
 

diff --git a/lib/dnssec/signature.h b/lib/dnssec/signature.h
index 28271ee782c3763b0342d13b0f306c0185fe5171..9e71ad96b35c4ac282635117eabae9de22466867 100644 (file)
--- a/lib/dnssec/signature.h
+++ b/lib/dnssec/signature.h
@@ -18,8 +18,7 @@ int kr_authenticate_referral(const knot_rrset_t *ref, const dnssec_key_t *key);
 
 /**
  * Check the signature of the supplied RRSet.
- * @param rrsigs      RRSet containing signatures.
- * @param pos         Index of the signature record in the signature RRSet.
+ * @param rrsig       RRSet containing signatures.
  * @param key         Key to be used to validate the signature.
  * @param covered     The covered RRSet.
  * @param trim_labels Number of the leftmost labels to be removed and replaced with '*.'.

diff --git a/lib/generic/pack.h b/lib/generic/pack.h
index 229dfb10ef36c29888739720bc48958c06b8dcb8..463bb51ca6f8f7aacd197c5a9db5d5e8c1be93c7 100644 (file)
--- a/lib/generic/pack.h
+++ b/lib/generic/pack.h
@@ -11,7 +11,7 @@
  * backed by an array.
  *
  * @note Maximum object size is 2^16 bytes, see  ::pack_objlen_t
- * @TODO If some mistake happens somewhere, the access may end up in an infinite loop.
+ * @todo If some mistake happens somewhere, the access may end up in an infinite loop.
  *       (equality comparison on pointers)
  *
  * # Example usage:

diff --git a/lib/generic/trie.h b/lib/generic/trie.h
index 58e5c64ab8789cf7dd70214dd5c0c23ce24aea5a..dd9d3ebc1cd966640487ee69fc310b62359b91cb 100644 (file)
--- a/lib/generic/trie.h
+++ b/lib/generic/trie.h
@@ -20,7 +20,7 @@
  *
  * XXX EDITORS: trie.{h,c} are synced from
  * https://gitlab.nic.cz/knot/knot-dns/tree/68352fc969/src/contrib/qp-trie
- * only with tiny adjustments, mostly #includes and KR_EXPORT.
+ * only with tiny adjustments, mostly include lines and KR_EXPORT.
  */
 
 /*! \brief Element value. */

diff --git a/lib/utils.h b/lib/utils.h
index 55e280fdf233c741afd3e5cfedea2d4ff07c1522..48748d2bb5a61ffa3b32409f19a7c53b491c4ad9 100644 (file)
--- a/lib/utils.h
+++ b/lib/utils.h
@@ -76,7 +76,7 @@ void kr_log_req(const struct kr_request * const req, uint32_t qry_uid,
 /**
  * Log a message through the request log handler or stdout.
  * Caller is responsible for detecting verbose mode, use QRVERBOSE() macro.
- * @param  query current query
+ * @param  qry current query
  * @param  source message source
  * @param  fmt message format
  */
@@ -367,10 +367,10 @@ KR_EXPORT
 int kr_straddr_subnet(void *dst, const char *addr);
 
 /** Splits ip address specified as "addr@port" or "addr#port" into addr and port.
- * \param instr[in] zero-terminated input, e.g. "192.0.2.1#12345\0"
- * \param ipaddr[out] working buffer for the port-less prefix of instr;
+ * \param[in]  instr zero-terminated input, e.g. "192.0.2.1#12345\0"
+ * \param[out] ipaddr working buffer for the port-less prefix of instr;
  *                    length >= INET6_ADDRSTRLEN + 1.
- * \param port[out] written in case it's specified in instr
+ * \param[out] port written in case it's specified in instr
  * \return error code
  * \note Typically you follow this by kr_straddr_socket().
  * \note Only internet addresses are supported, i.e. no AF_UNIX sockets.
@@ -536,8 +536,8 @@ static inline int kr_dname_lf(uint8_t *dst, const knot_dname_t *src, bool add_wi
 
 /**
  * Difference between two calendar times specified as strings.
- * \param format[in] format for strptime
- * \param diff[out] result from C difftime(time1, time0)
+ * \param[in]  format format for strptime
+ * \param[out] diff result from C difftime(time1, time0)
  */
 KR_EXPORT
 const char *kr_strptime_diff(const char *format, const char *time1_str,