From ccd07a7fb4fbfa0cf43912713b61b94dcefc1b74 Mon Sep 17 00:00:00 2001
From: Abdelrazak Younes <younes@lyx.org>
Date: Sun, 21 Jan 2007 16:55:41 +0000
Subject: [PATCH] add comment.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16797 a592a061-630c-0410-9148-cb99ea01b6c8
---
 src/lyxtext.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/lyxtext.h b/src/lyxtext.h
index 9a03033cf9..a69e4b4320 100644
--- a/src/lyxtext.h
+++ b/src/lyxtext.h
@@ -338,7 +338,8 @@ public:
 	int cursorY(BufferView const & bv, CursorSlice const & cursor,
 		bool boundary) const;
 
-	/// delete double space or empty paragraphs around old cursor
+	/// delete double space or empty paragraphs around old cursor.
+	/// \retval true if a change has happened and we need a redraw.
 	/// FIXME: replace LCursor with DocIterator. This is not possible right
 	/// now because recordUndo() is called which needs a LCursor.
 	bool deleteEmptyParagraphMechanism(LCursor & cur,