From: Tony Finch <fanf@isc.org>
Date: Tue, 5 Apr 2022 09:09:38 +0000 (+0100)
Subject: Clarify a few zonetree API comments
X-Git-Tag: v9.19.1~18^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=db7487dd3579cf9e139323819db452b32e61f4e2;p=thirdparty%2Fbind9.git

Clarify a few zonetree API comments

Replace a load-bearing semicolon with some more explanatory words,
and correct a couple of parameter names.
---

diff --git a/lib/dns/include/dns/zt.h b/lib/dns/include/dns/zt.h
index 83d0fea136c..4b001234ba8 100644
--- a/lib/dns/include/dns/zt.h
+++ b/lib/dns/include/dns/zt.h
@@ -182,8 +182,8 @@ dns_zt_apply(dns_zt_t *zt, bool stop, isc_result_t *sub,
  * Returns:
  * \li	ISC_R_SUCCESS if action was applied to all nodes.  If 'stop' is
  *	false and 'sub' is non NULL then the first error (if any)
- *	reported by 'action' is returned in '*sub';
- *	any error code from 'action'.
+ *	reported by 'action' is returned in '*sub'. If 'stop' is true,
+ *	the first error code from 'action' is returned.
  */
 
 bool
@@ -203,7 +203,7 @@ dns_zt_setviewcommit(dns_zt_t *zt);
  * zone table.
  *
  * Requires:
- *\li	'view' to be valid.
+ *\li	'zt' to be valid.
  */
 
 void
@@ -213,7 +213,7 @@ dns_zt_setviewrevert(dns_zt_t *zt);
  * zone table.
  *
  * Requires:
- *\li	'view' to be valid.
+ *\li	'zt' to be valid.
  */
 
 ISC_LANG_ENDDECLS