From: JINMEI Tatuya <jinmei@isc.org>
Date: Fri, 20 Jan 2012 18:32:53 +0000 (-0800)
Subject: [1431] some more clarification in documentation based on review comments
X-Git-Tag: trac2351_base~275^2~10^2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2b16771b9cd34d55fe3916669b53531b29bdf0ce;p=thirdparty%2Fkea.git

[1431] some more clarification in documentation based on review comments
---

diff --git a/src/lib/datasrc/zone.h b/src/lib/datasrc/zone.h
index 6e53f6752d..9e832865c8 100644
--- a/src/lib/datasrc/zone.h
+++ b/src/lib/datasrc/zone.h
@@ -407,13 +407,16 @@ public:
     ///
     /// In general, this method expects the zone is properly signed with NSEC3
     /// RRs.  Specifically, it assumes at least the apex node has a matching
-    /// NSEC3 RR.  So the search must always succeed; if the assumption isn't
-    /// met, \c DataSourceError exception will be thrown.
+    /// NSEC3 RR (so the search in the recursive mode must always succeed);
+    /// it also assumes that it can retrieve NSEC parameters (iterations,
+    /// algorithm, and salt) from the zone as noted above.  If these
+    /// assumptions aren't met, \c DataSourceError exception will be thrown.
     ///
     /// \exception InvalidParameter name is not a subdomain of the zone origin;
     /// known_encloser does not meet the requirement (see above)
-    /// \exception DataSourceError The zone isn't properly signed with NSEC3
-    /// (NSEC3 parameters cannot be found; no NSEC3s are available, etc).
+    /// \exception DataSourceError Low-level or internal datasource errors
+    /// happened, or the zone isn't properly signed with NSEC3
+    /// (NSEC3 parameters cannot be found, no NSEC3s are available, etc).
     /// \exception std::bad_alloc The underlying implementation involves
     /// memory allocation and it fails
     ///