From e30cefeb5f7f8b90938bb88659d7d900c1917a6b Mon Sep 17 00:00:00 2001
From: Abdelrazak Younes <younes@lyx.org>
Date: Wed, 13 Feb 2008 14:46:19 +0000
Subject: [PATCH] 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
---
 src/Layout.h    | 1 +
 src/TextClass.h | 1 +
 2 files changed, 2 insertions(+)

diff --git a/src/Layout.h b/src/Layout.h
index fa4bdc2da2..a549557c59 100644
--- 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 644fb9c153..c4c737afbf 100644
--- 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 &);