include/editeng/orphitem.hxx | 11 ++++-------
include/editeng/widwitem.hxx | 11 ++++-------
2 files changed, 8 insertions(+), 14 deletions(-)
New commits:
commit 98cf5157d69d9f1692be7f2cac958b1dfb387ca9
Author: Miklos Vajna <vmik...@collabora.com>
AuthorDate: Mon Mar 27 21:58:10 2023 +0100
Commit: Miklos Vajna <vmik...@collabora.com>
CommitDate: Tue Mar 28 07:48:45 2023 +0000
editeng: document SvxOrphansItem and SvxWidowsItem
Replace boilerplate with something that actually helps remembering which
one is which.
Change-Id: Ia74b69d756cd31006b6f56726aeb37dc86880238
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/149636
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmik...@collabora.com>
diff --git a/include/editeng/orphitem.hxx b/include/editeng/orphitem.hxx
index 4181e7c741eb..251dc5150dc0 100644
--- a/include/editeng/orphitem.hxx
+++ b/include/editeng/orphitem.hxx
@@ -22,13 +22,10 @@
#include <svl/intitem.hxx>
#include <editeng/editengdllapi.h>
-// class SvxOrphansItem --------------------------------------------------
-
-/* [Description]
-
- This item describes the number of lines for the orphans system.
-*/
-
+/// An orphan line is a paragraph-starting line that is still on the previous
page or column (has
+/// future, but no past).
+///
+/// nL specifies the minimum number of lines, to prevent orphans.
class EDITENG_DLLPUBLIC SvxOrphansItem final : public SfxByteItem
{
public:
diff --git a/include/editeng/widwitem.hxx b/include/editeng/widwitem.hxx
index 5d64962d32ef..0bb6138fd082 100644
--- a/include/editeng/widwitem.hxx
+++ b/include/editeng/widwitem.hxx
@@ -22,13 +22,10 @@
#include <svl/intitem.hxx>
#include <editeng/editengdllapi.h>
-// class SvxWidowsItem ---------------------------------------------------
-
-/* [Description]
-
- This item describes the number of lines for the widows control.
-*/
-
+/// A widow line is a paragraph-ending line that goes to the following page or
column (has past, but
+/// no future).
+///
+/// nL specifies the minimum number of lines, to prevent widows.
class EDITENG_DLLPUBLIC SvxWidowsItem final : public SfxByteItem
{
public:
