Browse Source

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

JINMEI Tatuya 13 years ago
parent
commit
2b16771b9c
1 changed files with 7 additions and 4 deletions
  1. 7 4
      src/lib/datasrc/zone.h

+ 7 - 4
src/lib/datasrc/zone.h

@@ -407,13 +407,16 @@ public:
     ///
     ///
     /// In general, this method expects the zone is properly signed with NSEC3
     /// In general, this method expects the zone is properly signed with NSEC3
     /// RRs.  Specifically, it assumes at least the apex node has a matching
     /// 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;
     /// \exception InvalidParameter name is not a subdomain of the zone origin;
     /// known_encloser does not meet the requirement (see above)
     /// 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
     /// \exception std::bad_alloc The underlying implementation involves
     /// memory allocation and it fails
     /// memory allocation and it fails
     ///
     ///