- Fix doxygen and pydoc warnings.

This commit is contained in:
W.C.A. Wijngaards 2021-02-18 11:39:06 +01:00
parent bf0a91aa41
commit 3b24d845ff
6 changed files with 11 additions and 15 deletions

View File

@ -5,6 +5,7 @@
zonemd-permissive-mode that makes it log but not fail wrong zones. zonemd-permissive-mode that makes it log but not fail wrong zones.
With zonemd-reject-absence for an auth-zone the presence of a With zonemd-reject-absence for an auth-zone the presence of a
zonemd can be mandated for specific zones. zonemd can be mandated for specific zones.
- Fix doxygen and pydoc warnings.
15 February 2021: Wouter 15 February 2021: Wouter
- Fix #422: IPv6 fallback issues when IPv6 is not properly - Fix #422: IPv6 fallback issues when IPv6 is not properly

View File

@ -132,7 +132,7 @@ struct dns_msg* dns_copy_msg(struct dns_msg* from, struct regional* regional);
* can be prefetch-updates. * can be prefetch-updates.
* @param region: to copy modified (cache is better) rrs back to. * @param region: to copy modified (cache is better) rrs back to.
* @param flags: with BIT_CD for dns64 AAAA translated queries. * @param flags: with BIT_CD for dns64 AAAA translated queries.
* @return void, because we are not interested in alloc errors, * return void, because we are not interested in alloc errors,
* the iterator and validator can operate on the results in their * the iterator and validator can operate on the results in their
* scratch space (the qstate.region) and are not dependent on the cache. * scratch space (the qstate.region) and are not dependent on the cache.
* It is useful to log the alloc failure (for the server operator), * It is useful to log the alloc failure (for the server operator),

View File

@ -92,7 +92,7 @@ Inplace callbacks
.. function:: inplace_cb_reply(qinfo, qstate, rep, rcode, edns, opt_list_out, region, \*\*kwargs) .. function:: inplace_cb_reply(qinfo, qstate, rep, rcode, edns, opt_list_out, region, \*\*kwargs)
Function prototype for callback functions used in Function prototype for callback functions used in
`register_inplace_cb_reply`_, `register_inplace_cb_reply_cache`_, `register_inplace_cb_reply`, `register_inplace_cb_reply_cache`,
`register_inplace_cb_reply_local` and `register_inplace_cb_reply_servfail`. `register_inplace_cb_reply_local` and `register_inplace_cb_reply_servfail`.
:param qinfo: :class:`query_info` :param qinfo: :class:`query_info`
@ -109,7 +109,7 @@ Inplace callbacks
.. function:: inplace_cb_query(qinfo, flags, qstate, addr, zone, region) .. function:: inplace_cb_query(qinfo, flags, qstate, addr, zone, region)
Function prototype for callback functions used in Function prototype for callback functions used in
`register_inplace_cb_query`_. `register_inplace_cb_query`.
:param qinfo: :class:`query_info` :param qinfo: :class:`query_info`
:param flags: query flags (integer) :param flags: query flags (integer)
@ -122,7 +122,7 @@ Inplace callbacks
Register py_cb as an inplace reply callback function. Register py_cb as an inplace reply callback function.
:param py_cb: Python function that follows `inplace_cb_reply`_'s prototype. **Must** be callable. :param py_cb: Python function that follows `inplace_cb_reply`'s prototype. **Must** be callable.
:param env: :class:`module_env` :param env: :class:`module_env`
:param id: Module ID. :param id: Module ID.
:return: True on success, False otherwise :return: True on success, False otherwise
@ -132,7 +132,7 @@ Inplace callbacks
Register py_cb as an inplace reply_cache callback function. Register py_cb as an inplace reply_cache callback function.
:param py_cb: Python function that follows `inplace_cb_reply`_'s prototype. **Must** be callable. :param py_cb: Python function that follows `inplace_cb_reply`'s prototype. **Must** be callable.
:param env: :class:`module_env` :param env: :class:`module_env`
:param id: Module ID. :param id: Module ID.
:return: True on success, False otherwise :return: True on success, False otherwise
@ -142,7 +142,7 @@ Inplace callbacks
Register py_cb as an inplace reply_local callback function. Register py_cb as an inplace reply_local callback function.
:param py_cb: Python function that follows `inplace_cb_reply`_'s prototype. **Must** be callable. :param py_cb: Python function that follows `inplace_cb_reply`'s prototype. **Must** be callable.
:param env: :class:`module_env` :param env: :class:`module_env`
:param id: Module ID. :param id: Module ID.
:return: True on success, False otherwise :return: True on success, False otherwise
@ -152,7 +152,7 @@ Inplace callbacks
Register py_cb as an inplace reply_servfail callback function. Register py_cb as an inplace reply_servfail callback function.
:param py_cb: Python function that follows `inplace_cb_reply`_'s prototype. **Must** be callable. :param py_cb: Python function that follows `inplace_cb_reply`'s prototype. **Must** be callable.
:param env: :class:`module_env` :param env: :class:`module_env`
:param id: Module ID. :param id: Module ID.
:return: True on success, False otherwise :return: True on success, False otherwise
@ -162,7 +162,7 @@ Inplace callbacks
Register py_cb as an inplace query callback function. Register py_cb as an inplace query callback function.
:param py_cb: Python function that follows `inplace_cb_query`_'s prototype. **Must** be callable. :param py_cb: Python function that follows `inplace_cb_query`'s prototype. **Must** be callable.
:param env: :class:`module_env` :param env: :class:`module_env`
:param id: Module ID. :param id: Module ID.
:return: True on success, False otherwise :return: True on success, False otherwise

View File

@ -153,7 +153,6 @@ int sldns_bgetc(struct sldns_buffer *buffer);
* the position to the first character that is not in *s. * the position to the first character that is not in *s.
* \param[in] *buffer buffer to use * \param[in] *buffer buffer to use
* \param[in] *s characters to skip * \param[in] *s characters to skip
* \return void
*/ */
void sldns_bskipcs(struct sldns_buffer *buffer, const char *s); void sldns_bskipcs(struct sldns_buffer *buffer, const char *s);
@ -162,7 +161,6 @@ void sldns_bskipcs(struct sldns_buffer *buffer, const char *s);
* the position to the first character that is not in *s. * the position to the first character that is not in *s.
* \param[in] *fp file to use * \param[in] *fp file to use
* \param[in] *s characters to skip * \param[in] *s characters to skip
* \return void
*/ */
void sldns_fskipcs(FILE *fp, const char *s); void sldns_fskipcs(FILE *fp, const char *s);
@ -173,7 +171,6 @@ void sldns_fskipcs(FILE *fp, const char *s);
* \param[in] *fp file to use * \param[in] *fp file to use
* \param[in] *s characters to skip * \param[in] *s characters to skip
* \param[in] line_nr pointer to an integer containing the current line number (for debugging purposes) * \param[in] line_nr pointer to an integer containing the current line number (for debugging purposes)
* \return void
*/ */
void sldns_fskipcs_l(FILE *fp, const char *s, int *line_nr); void sldns_fskipcs_l(FILE *fp, const char *s, int *line_nr);

View File

@ -202,7 +202,6 @@ INLINE void sldns_buffer_clear(sldns_buffer *buffer)
* the position is set to 0. * the position is set to 0.
* *
* \param[in] buffer the buffer to flip * \param[in] buffer the buffer to flip
* \return void
*/ */
INLINE void sldns_buffer_flip(sldns_buffer *buffer) INLINE void sldns_buffer_flip(sldns_buffer *buffer)
{ {
@ -732,7 +731,6 @@ int sldns_buffer_printf(sldns_buffer *buffer, const char *format, ...)
/** /**
* frees the buffer. * frees the buffer.
* \param[in] *buffer the buffer to be freed * \param[in] *buffer the buffer to be freed
* \return void
*/ */
void sldns_buffer_free(sldns_buffer *buffer); void sldns_buffer_free(sldns_buffer *buffer);

View File

@ -261,7 +261,7 @@ int dname_is_root(uint8_t* dname);
* Snip off first label from a dname, returning the parent zone. * Snip off first label from a dname, returning the parent zone.
* @param dname: from what to strip off. uncompressed wireformat. * @param dname: from what to strip off. uncompressed wireformat.
* @param len: length, adjusted to become less. * @param len: length, adjusted to become less.
* @return stripped off, or "." if input was ".". * return stripped off, or "." if input was ".".
*/ */
void dname_remove_label(uint8_t** dname, size_t* len); void dname_remove_label(uint8_t** dname, size_t* len);
@ -271,7 +271,7 @@ void dname_remove_label(uint8_t** dname, size_t* len);
* @param len: length, adjusted to become less. * @param len: length, adjusted to become less.
* @param n: number of labels to strip off (from the left). * @param n: number of labels to strip off (from the left).
* if 0, nothing happens. * if 0, nothing happens.
* @return stripped off, or "." if input was ".". * return stripped off, or "." if input was ".".
*/ */
void dname_remove_labels(uint8_t** dname, size_t* len, int n); void dname_remove_labels(uint8_t** dname, size_t* len, int n);