]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Clarify a few zonetree API comments
authorTony Finch <fanf@isc.org>
Tue, 5 Apr 2022 09:09:38 +0000 (10:09 +0100)
committerTony Finch <fanf@isc.org>
Mon, 2 May 2022 21:48:55 +0000 (22:48 +0100)
Replace a load-bearing semicolon with some more explanatory words,
and correct a couple of parameter names.

lib/dns/include/dns/zt.h

index 83d0fea136c9323e07d8317d5e6baec62cf40c33..4b001234ba8adb3432fc038e0f4199d4853b4e37 100644 (file)
@@ -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