sw: document SwDPage

That shared draw page means explicit clipping is needed at many places,
e.g. this is the reason SdrPageView::DrawLayer() has a page frame
parameter.

Change-Id: I6b36c977a30d44e449b8b3a46ac4368f34210887
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/144009
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>

1 files changed, 3 insertions, 0 deletions

diff --git a/sw/inc/dpage.hxx b/sw/inc/dpage.hxx
index c5a5c45a9813..16d5b4650169 100644
--- a/sw/inc/dpage.hxx
+++ b/sw/inc/dpage.hxx
@@ -27,6 +27,9 @@ class SdrPageGridFrameList;
 class SwDrawModel;
 class SwDoc;
 
+/// SwDPage is Writer's draw page: derives from SdrPage, but has a reference to the Writer document
+/// via SwDrawModel. One Writer document has 1 draw page, i.e. all Writer pages share the same draw
+/// page.
 class SwDPage final : public FmFormPage, public SdrObjUserCall
 {
     SwDPage &operator=(const SwDPage&) = delete;