[prev in list] [next in list] [prev in thread] [next in thread] 

List:       lyx-cvs
Subject:    [LyX/master] Fix documentation of Row::splitAt
From:       Jean-Marc Lasgouttes <lasgouttes () lyx ! org>
Date:       2022-05-31 14:23:35
Message-ID: 20220531142335.A869328065D () lyx ! lyx ! org
[Download RAW message or body]

commit e82cead90f4d9b1ffb0d4d4cad7140807e49e382
Author: Jean-Marc Lasgouttes <lasgouttes@lyx.org>
Date:   Tue May 31 17:04:01 2022 +0200

    Fix documentation of Row::splitAt
---
 po/messages.mo |  Bin 627646 -> 0 bytes
 src/Row.h      |   12 +++++++-----
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/po/messages.mo b/po/messages.mo
deleted file mode 100644
index 59bfefa..0000000
Binary files a/po/messages.mo and /dev/null differ
diff --git a/src/Row.h b/src/Row.h
index 6583fb2..a4be0ad 100644
--- a/src/Row.h
+++ b/src/Row.h
@@ -89,14 +89,16 @@ public:
 		*/
 		pos_type x2pos(int &x) const;
 		/** Break the element in two if possible, so that its width is less
-		 * than \param w.
-		 * \return a vector of elements containing the remainder of
-		 *   the text (empty if nothing happened).
-		 * \param width maximum width of the row.
-		 * \param next_width available width on next row.
+		 * than the required values.
+		 * \return true if something has been done ; false if this is
+		 * not needed or not possible.
+		 * \param width: maximum width of the row.
+		 * \param next_width: available width on next rows.
 		 * \param force: if true, cut string at any place, even for
 		 *   languages that wrap at word delimiters; if false, do not
 		 *   break at all if first element would larger than \c width.
+		 * \param tail: a vector of elements where the remainder of
+		 *   the text will be appended (empty if nothing happened).
 		 */
 		// FIXME: ideally last parameter should be Elements&, but it is not possible.
 		bool splitAt(int width, int next_width, bool force, std::vector<Element> & tail);
-- 
lyx-cvs mailing list
lyx-cvs@lists.lyx.org
http://lists.lyx.org/mailman/listinfo/lyx-cvs
[prev in list] [next in list] [prev in thread] [next in thread]