From 625210e9c7520b9da530c9136a4ead2353c2ca3f Mon Sep 17 00:00:00 2001 From: dickelbeck Date: Wed, 3 Mar 2010 06:19:27 +0000 Subject: [PATCH] comment --- include/richio.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/richio.h b/include/richio.h index 9fbbffebd2..d295de36c8 100644 --- a/include/richio.h +++ b/include/richio.h @@ -158,6 +158,13 @@ protected: size_t ndx; public: + + /** + * Constructor STRING_LINE_READER( const std::string& aString ) + * @param aString is a source string consisting of one or more lines + * of text, where multiple lines are separated with a '\n' character. + * The last line does not necessarily need a trailing '\n'. + */ STRING_LINE_READER( const std::string& aString ) : LINE_READER( 4096 ), source( aString ),