From: Mukund Sivaraman <muks@isc.org>
Date: Thu, 1 Nov 2012 07:14:11 +0000 (+0530)
Subject: [2371] Make minor comment updates
X-Git-Tag: trac2487_base~1^2~21^2~30^2~8
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=29a6cb5fb2ceebdd45c343619e9d49fbd9d75558;p=thirdparty%2Fkea.git

[2371] Make minor comment updates
---

diff --git a/src/lib/dns/master_lexer.h b/src/lib/dns/master_lexer.h
index 133efcd162..34c131341c 100644
--- a/src/lib/dns/master_lexer.h
+++ b/src/lib/dns/master_lexer.h
@@ -29,7 +29,7 @@ namespace dns {
 ///
 /// The \c MasterLexer class provides tokenize interfaces for parsing DNS
 /// master files.  It understands some special rules of master files as
-/// defined in RFC 1035, such as comments, character escaping, or multi-line
+/// defined in RFC 1035, such as comments, character escaping, and multi-line
 /// data, and provides the user application with the actual data in a
 /// more convenient form such as a std::string object.
 ///
@@ -92,12 +92,12 @@ public:
     /// \throw isc::InvalidOperation Called with no opened source.
     void close();
 
-    /// \brief Return a name of the current input source name.
+    /// \brief Return the name of the current input source name.
     ///
     /// If it's a file, it will be the C string given at the corresponding
-    /// \c open() call, that is, its file name.  If it's a stream, it will
-    /// be formatted as "stream-%p" where %p is hex representation of the
-    /// address of the stream object.
+    /// \c open() call, that is, its filename.  If it's a stream, it will
+    /// be formatted as \c "stream-%p" where \c %p is hex representation
+    /// of the address of the stream object.
     ///
     /// If there is no opened source at the time of the call, this method
     /// returns an empty string.
diff --git a/src/lib/dns/tests/master_lexer_unittest.cc b/src/lib/dns/tests/master_lexer_unittest.cc
index 7d8e9c7630..edff5578e4 100644
--- a/src/lib/dns/tests/master_lexer_unittest.cc
+++ b/src/lib/dns/tests/master_lexer_unittest.cc
@@ -90,7 +90,7 @@ TEST_F(MasterLexerTest, nestedOpen) {
     lexer.open(TEST_DATA_SRCDIR "/masterload.txt");
     EXPECT_EQ(TEST_DATA_SRCDIR "/masterload.txt", lexer.getSourceName());
 
-    // Close works on the "topmost" (opened last) source
+    // Close works on the "topmost" (last-opened) source
     lexer.close();
     EXPECT_EQ(expected_stream_name, lexer.getSourceName());