summaryrefslogtreecommitdiff
path: root/sw/source/core/inc/rootfrm.hxx
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.co.uk>2017-11-15 09:04:29 +0100
committerMiklos Vajna <vmiklos@collabora.co.uk>2017-11-15 11:04:30 +0100
commite9d6db80177bdaab527de516b53544aeae380d0e (patch)
tree7146f4016244931f07dd4a764851048575c9bf45 /sw/source/core/inc/rootfrm.hxx
parent3813dd13157f022320b5835856b70e0e2ede03bc (diff)
sw: document SwRootFrame -> SwLinePortion encapsulation chain
Change-Id: I4c8b7ce0375c97b6947f201aa2389c00089b8f5a Reviewed-on: https://gerrit.libreoffice.org/44751 Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk> Tested-by: Jenkins <ci@libreoffice.org>
Diffstat (limited to 'sw/source/core/inc/rootfrm.hxx')
-rw-r--r--sw/source/core/inc/rootfrm.hxx3
1 files changed, 2 insertions, 1 deletions
diff --git a/sw/source/core/inc/rootfrm.hxx b/sw/source/core/inc/rootfrm.hxx
index 73c020e8e9a8..1767a0814e0e 100644
--- a/sw/source/core/inc/rootfrm.hxx
+++ b/sw/source/core/inc/rootfrm.hxx
@@ -68,7 +68,8 @@ using SwCurrShells = std::set<CurrShell*>;
class SwSectionFrame;
using SwDestroyList = std::set<SwSectionFrame*>;
-/// The root element of a Writer document layout.
+/// The root element of a Writer document layout. Lower frames are expected to
+/// be SwPageFrame instances.
class SwRootFrame: public SwLayoutFrame
{
// Needs to disable the Superfluous temporarily