From: Jean-Marc Lasgouttes <lasgouttes@lyx.org>
Date: Wed, 4 Feb 2009 09:52:10 +0000 (+0000)
Subject: fix faulty documentation
X-Git-Tag: 2.0.0~7317
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=9622577c60c0975b2fae3441382ca44b5cf5de87;p=features.git

fix faulty documentation

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@28344 a592a061-630c-0410-9148-cb99ea01b6c8
---

diff --git a/src/Buffer.cpp b/src/Buffer.cpp
index d2815373eb..080eee73ad 100644
--- a/src/Buffer.cpp
+++ b/src/Buffer.cpp
@@ -547,7 +547,7 @@ int Buffer::readHeader(Lexer & lex)
 
 // Uwe C. Schroeder
 // changed to be public and have one parameter
-// Returns false if "\end_document" is not read (Asger)
+// Returns true if "\end_document" is not read (Asger)
 bool Buffer::readDocument(Lexer & lex)
 {
 	ErrorList & errorList = d->errorLists["Parse"];
diff --git a/src/Buffer.h b/src/Buffer.h
index 96c0bae617..898be68ff8 100644
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -137,7 +137,7 @@ public:
 
 	/** Reads a file without header.
 	    \param par if != 0 insert the file.
-	    \return \c false if file is not completely read.
+	    \return \c true if file is not completely read.
 	*/
 	bool readDocument(Lexer &);
 
diff --git a/src/Text.h b/src/Text.h
index bc4e85c321..3beda155a5 100644
--- a/src/Text.h
+++ b/src/Text.h
@@ -276,7 +276,7 @@ public:
 
 	///
 	void write(Buffer const & buf, std::ostream & os) const;
-	/// returns whether we've seen our usual 'end' marker
+	/// returns true if \end_document has not been read
 	/// insetPtr is the containing Inset
 	bool read(Buffer const & buf, Lexer & lex, ErrorList & errorList, 
 	          InsetText * insetPtr);