BIND 10 trac1177, updated. bc03b37015ab6ea23cbec70dbd299c74fb001aba [1177] Further doxygen tweaks

[BIND 10 source code commits]

The branch, trac1177 has been updated
       via  bc03b37015ab6ea23cbec70dbd299c74fb001aba (commit)
       via  e56e0f7d1ad206f1ebc26e285d82a8e7ff6390e1 (commit)
      from  688867daa34ade5075443c77535f80e1d2d76743 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit bc03b37015ab6ea23cbec70dbd299c74fb001aba
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date:   Tue Sep 27 12:12:50 2011 +0200

    [1177] Further doxygen tweaks

commit e56e0f7d1ad206f1ebc26e285d82a8e7ff6390e1
Author: JINMEI Tatuya <jinmei at isc.org>
Date:   Tue Sep 27 12:00:00 2011 +0200

    [1177] Examples for NSEC results.

-----------------------------------------------------------------------

Summary of changes:
 src/lib/datasrc/zone.h |   23 ++++++++++++++++++++---
 1 files changed, 20 insertions(+), 3 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/datasrc/zone.h b/src/lib/datasrc/zone.h
index 6b74b5a..36b2d42 100644
--- a/src/lib/datasrc/zone.h
+++ b/src/lib/datasrc/zone.h
@@ -67,10 +67,27 @@ public:
     /// belongs to the domain which would provide the result if it
     /// contained the correct type (in case of NXRRSET, it is the queried
     /// domain, in case of WILDCARD_NXRRSET, it is the wildcard domain
-    /// that matched the query name). In case of empty nonterminal cases,
+    /// that matched the query name). In case of an empty nonterminal,
     /// an NSEC is provided for the interval where the empty nonterminal
-    /// lives, which is the one ending in the subdomain of the empty
-    /// nonterminal.
+    /// lives. The end of the interval is the subdomain causing existence
+    /// of the empty nonterminal (if there's sub.x.example.com, and no
+    /// x.example.com, then x.example.com exists implicitly - is the empty
+    /// nonterminal and sub.x.example.com is the subdomain causing it).
+    ///
+    /// Examples: if zone "example.com" has the following
+    /// record:
+    /// \code
+    /// a.b.example.com. NSEC c.example.com.
+    /// \endcode
+    /// a call to \c find() for "b.example.com." will result in NXRRSET,
+    /// and if the FIND_DNSSEC option is set this NSEC will be returned.
+    /// Likewise, if zone "example.org" has the following record,
+    /// \code
+    /// x.*.example.org. NSEC a.example.org.
+    /// \endcode
+    /// a call to \c find() for "y.example.org" will result in
+    /// WILDCARD_NXRRSET (*.example.org is an empty nonterminal wildcard node),
+    /// and if the FIND_DNSSEC option is set this NSEC will be returned.
     ///
     /// In case of NXDOMAIN, the returned NSEC covers the queried domain.
     enum Result {