r24164 by craig - Add some comments about use of Pages/Items pointers

[scribus-commit]

Author: craig
Date: Tue Nov  3 16:12:36 2020
New Revision: 24164

URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=24164
Log:
Add some comments about use of Pages/Items pointers

Modified:
    trunk/Scribus/scribus/scribusdoc.h

Modified: trunk/Scribus/scribus/scribusdoc.h
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=24164&path=/trunk/Scribus/scribus/scribusdoc.h
==============================================================================
--- trunk/Scribus/scribus/scribusdoc.h	(original)
+++ trunk/Scribus/scribus/scribusdoc.h	Tue Nov  3 16:12:36 2020
@@ -1309,7 +1309,7 @@
 	FPoint maxCanvasCoordinate;
 	double rulerXoffset {0.0};
 	double rulerYoffset {0.0};
-	/** \brief List of Pages */
+	//! Page is a pointer to the lists of pages that exist in a document. In Normal mode, it points to DocPages. In Master Page mode it points to MasterPages. See ScribusDoc::assignPageModeLists()
 	QList<ScPage*>* Pages {nullptr};
 	/** \brief List of Master Pages */
 	QList<ScPage*> MasterPages;
@@ -1320,8 +1320,11 @@
 	/** \brief Mapping Master Page Name to Master Page numbers */
 	QMap<QString,int> MasterNames;
 	/** \brief List of Objects */
+	//! Items is a pointer to the lists of items that exist in a document. In Normal mode, it points to DocItems. In Master Page mode it points to MasterItems. See ScribusDoc::assignPageModeLists()
 	QList<PageItem*>* Items {nullptr};
+	//! The list of master page items
 	QList<PageItem*> MasterItems;
+	//! The list of page items
 	QList<PageItem*> DocItems;
 	QHash<int, PageItem*> FrameItems;
 	QList<PageItem*> EditFrameItems;