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 d2815373eb6b9ca063184a39637c4495650a36cc..080eee73ad70f319121004566958fb456bb2dea7 100644 (file)
--- 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 96c0bae617eb7532c43498ddda21d496d6a8c6e6..898be68ff8cd8d57afbec8872223c3fb6f2d89b2 100644 (file)
--- 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 bc4e85c321c6adb8cdeb182b6c0140be5198c5ba..3beda155a5b9616e104d4028e0af3d24ec090b55 100644 (file)
--- 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);