]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[2506] updated part of lexer state doc to match the latest changes.
authorJINMEI Tatuya <jinmei@isc.org>
Wed, 28 Nov 2012 22:49:19 +0000 (14:49 -0800)
committerJINMEI Tatuya <jinmei@isc.org>
Thu, 29 Nov 2012 18:00:25 +0000 (10:00 -0800)
src/lib/dns/master_lexer_state.h

index 2a64c9d2279be5e53e26ba8b80f9d9c3aa05890d..9ddd68a5986f409b71eb05fc93a79a932893e06f 100644 (file)
@@ -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.