Skip to content
Snippets Groups Projects
Commit f9967ea1 authored by David Vasek's avatar David Vasek Committed by Daniel Salzman
Browse files

zone-tree: clarify a function description

parent c7dcb13c
No related branches found
No related tags found
1 merge request!1726Add check for \0 bytes in QNAME labels
...@@ -155,18 +155,18 @@ zone_node_t *zone_tree_get(zone_tree_t *tree, const knot_dname_t *owner); ...@@ -155,18 +155,18 @@ zone_node_t *zone_tree_get(zone_tree_t *tree, const knot_dname_t *owner);
* \brief Tries to find the given domain name in the zone tree and returns the * \brief Tries to find the given domain name in the zone tree and returns the
* associated node and previous node in canonical order. * associated node and previous node in canonical order.
* *
* \param tree Zone to search in. * \param tree Zone to search in.
* \param owner Owner of the node to find. * \param owner Owner of the node to find.
* \param found Found node. * \param found Found node.
* \param previous Previous node in canonical order (i.e. the one directly * \param previous Previous node in canonical order (i.e. the one directly
* preceding \a owner in canonical order, regardless if the name * preceding \a owner in canonical order, regardless if the name
* is in the zone or not). * is in the zone or not).
* *
* \retval > 0 if the domain name was found. In such case \a found holds the * \retval 1 if the domain name was found. In such case \a found holds the
* zone node with \a owner as its owner. * zone node with \a owner as its owner.
* \a previous is set properly. * \a previous is set properly.
* \retval 0 if the domain name was not found. \a found may hold any (or none) * \retval 0 if the domain name was not found. \a found holds nothing.
* node. \a previous is set properly. * \a previous is set properly.
* \retval KNOT_EINVAL * \retval KNOT_EINVAL
* \retval KNOT_ENOMEM * \retval KNOT_ENOMEM
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment