Document Layout::read() and TextClass::read() return value. This should be fixed.

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

diff --git a/src/Layout.h b/src/Layout.h
index fa4bdc2da23f3f8da951ee5bf071e82ad0101689..a549557c590af520ad509269388d884468abb635 100644 (file)
--- a/src/Layout.h
+++ b/src/Layout.h
@@ -52,6 +52,7 @@ public:
        ///
        Layout();
        /// Reads a layout definition from file
+       /// \return false on success. FIXME: this is bad API, should return true!
        bool read(Lexer &, TextClass const &);
        ///
        void readAlign(Lexer &);

diff --git a/src/TextClass.h b/src/TextClass.h
index 644fb9c153cbed07a8de954cb5dded5f4d1eb1c1..c4c737afbfbb9af00ed187204022ad9c7d47a4a8 100644 (file)
--- a/src/TextClass.h
+++ b/src/TextClass.h
@@ -67,6 +67,7 @@ public:
                MODULE //>This is a layout module
        };
        /// Performs the read of the layout file.
+       /// \return false on success. FIXME: this is bad API, should return true!
        bool read(support::FileName const & filename, ReadType rt = BASECLASS);
        ///
        void readOutputType(Lexer &);