From edd4f79b4b27c29fbd9403a5b19248e3c85699fc Mon Sep 17 00:00:00 2001 From: Michael Graff Date: Wed, 27 Jan 1999 05:54:05 +0000 Subject: [PATCH] fill in documentation on dns_rdata_towire() --- lib/dns/include/dns/rdataset.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/lib/dns/include/dns/rdataset.h b/lib/dns/include/dns/rdataset.h index 0b8aafe464..4f2729b016 100644 --- a/lib/dns/include/dns/rdataset.h +++ b/lib/dns/include/dns/rdataset.h @@ -218,7 +218,17 @@ dns_rdataset_towire(dns_rdataset_t *rdataset, * * 'rdataset' is not empty. * - * XXX Supply Requires and Ensures XXX + * Ensures: + * On a return of DNS_R_SUCCESS, 'target' contains a wire format + * for the data contained in 'rdataset'. Any error return leaves + * the buffer in an undefined state. + * + * Returns: + * DNS_R_SUCCESS - all ok + * DNS_R_NOSPACE - 'target' doesn't have enough room + * + * Any error returned by dns_rdata_towire(), dns_rdataset_next(), + * dns_name_towire(). */ #endif /* DNS_RDATASET_H */