From: JINMEI Tatuya <jinmei@isc.org>
Date: Wed, 28 Nov 2012 22:49:19 +0000 (-0800)
Subject: [2506] updated part of lexer state doc to match the latest changes.
X-Git-Tag: bind10-1.0.0-beta-release~46^2~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ebea1d79bcd55536f89e250ce1be13a8369171f7;p=thirdparty%2Fkea.git

[2506] updated part of lexer state doc to match the latest changes.
---

diff --git a/src/lib/dns/master_lexer_state.h b/src/lib/dns/master_lexer_state.h
index 2a64c9d227..9ddd68a598 100644
--- a/src/lib/dns/master_lexer_state.h
+++ b/src/lib/dns/master_lexer_state.h
@@ -43,10 +43,10 @@ namespace master_lexer_internal {
 /// state, so it makes more sense to separate the interface for the transition
 /// from the initial state.
 ///
-/// When an object of a specific state class completes the session, it
-/// normally sets the identified token in the lexer, and returns NULL;
-/// if more transition is necessary, it returns a pointer to the next state
-/// object.
+/// If the whole lexer transition is completed within start(), it sets the
+/// identified token and returns NULL; otherwise it returns a pointer to
+/// an object of a specific state class that completes the session
+/// on the call of handle().
 ///
 /// As is usual in the state design pattern, the \c State class is made
 /// a friend class of \c MasterLexer and can refer to its internal details.