sw layout-level redline hiding: add more doxygen documentation

Thanks Michael Stahl for the conference talk that was the input for
these.

Change-Id: Ia48248f4739218ee7832559353aab06183a934d7
Reviewed-on: https://gerrit.libreoffice.org/61079Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk>
Tested-by: Jenkins

sw/source/core/inc/DocumentRedlineManager.hxx

@@ -33,6 +33,10 @@ class DocumentRedlineManager : public IDocumentRedlineAccess
 public:
     DocumentRedlineManager( SwDoc& i_rSwdoc );
 
+    /**
+     * Replaced by SwRootFrame::IsHideRedlines() (this is model-level redline
+     * hiding).
+     */
     virtual RedlineFlags GetRedlineFlags() const override;
 
     virtual void SetRedlineFlags_intern(/*[in]*/RedlineFlags eMode) override;

sw/source/core/inc/TextFrameIndex.hxx

@@ -16,6 +16,12 @@
 #if 0
 typedef o3tl::strong_int<sal_Int32, struct Tag_TextFrameIndex> TextFrameIndex;
 #else
+/**
+ * Denotes a character index in a text frame at a layout level, after extent
+ * mapping from a text node at a document model level.
+ *
+ * @see SwTextFrame::MapViewToModelPos().
+ */
 typedef sal_Int32 TextFrameIndex;
 #endif
 

sw/source/core/inc/rootfrm.hxx

@@ -403,6 +403,10 @@ public:
 
     void RemovePage( SwPageFrame **pDel, SwRemoveResult eResult );
 
+    /**
+     * Replacement for sw::DocumentRedlineManager::GetRedlineFlags()
+     * (this is layout-level redline hiding).
+     */
     bool IsHideRedlines() const { return mbHideRedlines; }
     void SetHideRedlines(bool);
 };