Clarify a few zonetree API comments

Replace a load-bearing semicolon with some more explanatory words,
and correct a couple of parameter names.
This commit is contained in:
Tony Finch
2022-04-05 10:09:38 +01:00
parent 9980c8ad76
commit db7487dd35

View 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