From 87837577a19bcee5c24315cf93f19a94f3e6db8d Mon Sep 17 00:00:00 2001
From: Bob Halley <source@isc.org>
Date: Tue, 18 Jan 2000 19:10:39 +0000
Subject: [PATCH] improve documentation

---
 lib/dns/include/dns/byaddr.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/dns/include/dns/byaddr.h b/lib/dns/include/dns/byaddr.h
index dd93886f4e..26cf3cdc0e 100644
--- a/lib/dns/include/dns/byaddr.h
+++ b/lib/dns/include/dns/byaddr.h
@@ -56,6 +56,13 @@
 
 ISC_LANG_BEGINDECLS
 
+/*
+ * A 'dns_byaddrevent_t' is returned when a byaddr completes.
+ * The sender field will be set to the byaddr that completed.  If 'result'
+ * is ISC_R_SUCCESS, then 'names' will contain a list of names associated
+ * with the address.  The recipient of the event must not change the list
+ * and must not refer to any of the name data after the event is freed.
+ */
 typedef struct dns_byaddrevent {
 	ISC_EVENT_COMMON(struct dns_byaddrevent);
 	isc_result_t			result;