Browse Source

[2906] corrected trivial wording errors and typos in documentation.

JINMEI Tatuya 12 years ago
parent
commit
75235e6f7c

+ 3 - 3
src/lib/datasrc/zone_table_accessor.h

@@ -80,10 +80,10 @@ struct ZoneSpec {
 /// A concrete object of this class is created by specific derived
 /// implementation for the corresponding data source.  The implementation
 /// must ensure the iterator is located at the "beginning" of the zone table,
-/// and that subsequent calls to \c getCurrent() go through all the zones
-/// one by one, until \c isLast() returns false.  The implementation must
+/// and that subsequent calls to \c next() go through all the zones
+/// one by one, until \c isLast() returns \c true.  The implementation must
 /// support the concept of "empty table"; in that case \c isLast() will
-/// return \c false from the beginning.
+/// return \c true from the beginning.
 class ZoneTableIterator : boost::noncopyable {
 protected:
     /// \brief The constructor.

+ 1 - 1
src/lib/datasrc/zone_table_accessor_cache.h

@@ -55,7 +55,7 @@ public:
 
     /// \brief In-memory cache version of \c getIterator().
     ///
-    /// As returned from this version of iterator, `ZoneSpec::index`
+    /// As returned from this version of iterator, \c ZoneSpec::index
     /// will always be set to 0 at the moment.
     ///
     /// \throw None except std::bad_alloc in case of memory allocation failure