[Libreoffice-commits] core.git: writerfilter/inc writerfilter/source

[Mike Kaganski (via logerrit)]

 writerfilter/inc/dmapper/CommentProperties.hxx        |    8 ++++++++
 writerfilter/source/ooxml/OOXMLFastContextHandler.hxx |   12 ++++++++++++
 2 files changed, 20 insertions(+)

New commits:
commit f067e06c2ff1fa12e5a45c34186aae75a2aff3b1
Author:     Mike Kaganski <mike.kaganski at collabora.com>
AuthorDate: Tue Apr 20 14:34:19 2021 +0300
Commit:     Mike Kaganski <mike.kaganski at collabora.com>
CommitDate: Tue Apr 20 15:23:29 2021 +0200

    Document the new classes added in d8c0b63355af6caf3f0145dd1c10a93d63134a88
    
    Change-Id: Ib7421dd9dfe9245f3b6d98b772c74f22ab7f983f
    Reviewed-on: https://gerrit.libreoffice.org/c/core/+/114333
    Tested-by: Jenkins
    Reviewed-by: Mike Kaganski <mike.kaganski at collabora.com>

diff --git a/writerfilter/inc/dmapper/CommentProperties.hxx b/writerfilter/inc/dmapper/CommentProperties.hxx
index 1cba6930d4c6..d22a2f7261d3 100644
--- a/writerfilter/inc/dmapper/CommentProperties.hxx
+++ b/writerfilter/inc/dmapper/CommentProperties.hxx
@@ -11,6 +11,14 @@
 
 namespace writerfilter
 {
+/**
+ A container for the extended comment properties linked to the last paragraph of a comment
+
+ Corresponds to the data available in w15:commentEx elements from commentsExtended stream
+ ([MS-DOCX]): resolved state and parent (referring to comment that this one answers to; TODO).
+
+ @since 7.2
+*/
 struct CommentProperties
 {
     bool bDone;
diff --git a/writerfilter/source/ooxml/OOXMLFastContextHandler.hxx b/writerfilter/source/ooxml/OOXMLFastContextHandler.hxx
index 6aa2bd2ed6c2..dc5c369aa0fe 100644
--- a/writerfilter/source/ooxml/OOXMLFastContextHandler.hxx
+++ b/writerfilter/source/ooxml/OOXMLFastContextHandler.hxx
@@ -599,6 +599,18 @@ protected:
     virtual void process() override;
 };
 
+/**
+ A class that reads individual w15:commentEx elements from commentsExtended stream [MS-DOCX].
+
+ It is used to pre-populate the extended comment properties in domain mapper. The stream
+ contains information about resolved state of the comments ("done" attribute) and the parent
+ comment (the one that this comment answers to).
+
+ Note that the data is linked to paraId identifiers (also introduced in [MS-DOCX]), which
+ correspond to paragraphs, not directly to comment ids.
+
+ @since 7.2
+*/
 class OOXMLFastContextHandlerCommentEx : public OOXMLFastContextHandler
 {
 public: