Commit 4f3776c2 authored by Mukund Sivaraman's avatar Mukund Sivaraman
Browse files

[2906] Make some more minor comment updates

parent bf4f7d8e
......@@ -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,"
......
......@@ -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;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment