From: Mukund Sivaraman <muks@isc.org>
Date: Wed, 1 May 2013 12:25:59 +0000 (+0530)
Subject: [2906] Make some more minor comment updates
X-Git-Tag: bind10-1.1.0beta2-release~8^2~7^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4f3776c2b1d06bca0e7e02feeba79caba01ac865;p=thirdparty%2Fkea.git

[2906] Make some more minor comment updates
---

diff --git a/src/lib/datasrc/tests/zone_table_accessor_unittest.cc b/src/lib/datasrc/tests/zone_table_accessor_unittest.cc
index ace376f146..b0e67dd7ea 100644
--- a/src/lib/datasrc/tests/zone_table_accessor_unittest.cc
+++ b/src/lib/datasrc/tests/zone_table_accessor_unittest.cc
@@ -40,7 +40,7 @@ namespace {
 class ZoneTableAccessorTest : public ::testing::Test {
 protected:
     ZoneTableAccessorTest() :
-        // The paths of the zone files are dummy and wouldn't even exist,
+        // The paths of the zone files are dummy and don't even exist,
         // but it doesn't matter in this test.
         config_spec_(Element::fromJSON(
                          "{\"cache-enable\": true,"
diff --git a/src/lib/datasrc/zone_table_accessor_cache.h b/src/lib/datasrc/zone_table_accessor_cache.h
index fadaffb286..1286293b7b 100644
--- a/src/lib/datasrc/zone_table_accessor_cache.h
+++ b/src/lib/datasrc/zone_table_accessor_cache.h
@@ -30,32 +30,33 @@ class CacheConfig;
 /// cache.  Its conceptual table consists of the zones that are specified
 /// to be loaded into memory in configuration.  Note that these zones
 /// may or may not actually be loaded in memory.  In fact, this class object
-/// is intended to be used by applications that load these zones into memory
-/// so the application can get a list of zones to be loaded.  Also, even
+/// is intended to be used by applications that load these zones into memory,
+/// so that the application can get a list of zones to be loaded.  Also, even
 /// after loading, some zone may still not be loaded, e.g., due to an error
-/// of the corresponding zone file.
+/// in the corresponding zone file.
 ///
 /// An object of this class is expected to be returned by
 /// \c ConfigurableClientList.  Normal applications shouldn't instantiate
-/// it directly.  It's still defined publicly visibly for testing purpose,
-/// but to clarify the intent it's hidden in the "internal" namespace.
+/// this class directly.  It's still defined to be publicly visible for
+/// testing purposes but, to clarify the intent, it's hidden in the
+/// "internal" namespace.
 class ZoneTableAccessorCache : public ZoneTableAccessor {
 public:
     /// \brief Constructor.
     ///
     /// This class takes a \c CacheConfig object and holds it throughout
-    /// its lifetime.  The caller must ensure the configuration is valid
-    /// throughout the lifetime of this accessor object.
+    /// its lifetime.  The caller must ensure that the configuration is
+    /// valid throughout the lifetime of this accessor object.
     ///
     /// \throw None
     ///
     /// \param config The cache configuration that the accessor refers to.
     ZoneTableAccessorCache(const CacheConfig& config) : config_(config) {}
 
-    /// \brief in-memmory cache version of getIterator().
+    /// \brief In-memory cache version of \c getIterator().
     ///
-    /// From this version of iterator, `ZoneSpec::index` will always be set
-    /// to 0 at the moment.
+    /// As returned from this version of iterator, `ZoneSpec::index`
+    /// will always be set to 0 at the moment.
     ///
     /// \throw None except std::bad_alloc in case of memory allocation failure
     virtual IteratorPtr getIterator() const;