comments and code reformat

Change-Id: Ib4e45cb85c9e5e5ffa6476c939300c6795412b1a
Reviewed-on: https://gerrit.libreoffice.org/3582
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
Tested-by: Caolán McNamara <caolanm@redhat.com>

2 files changed, 51 insertions, 34 deletions

diff --git a/include/xmloff/txtimp.hxx b/include/xmloff/txtimp.hxx
index 2ac668de2d5a..0fc68b529773 100644
--- a/include/xmloff/txtimp.hxx
+++ b/include/xmloff/txtimp.hxx
@@ -674,36 +674,53 @@ public:
     // (to be implemented in sw/filter/xml/txtparai.hxx)
 
     virtual void RedlineAdd(
-        const OUString& rType,       /// redline type (insert, del,... )
-        const OUString& rId,         /// use to identify this redline
-        const OUString& rAuthor,     /// name of the author
-        const OUString& rComment,    /// redline comment
-        const ::com::sun::star::util::DateTime& rDateTime,  /// date+time
-        sal_Bool bMergeLastParagraph);      /// merge last paras
+            /// redline type (insert, del,... )
+            const OUString& rType,
+            /// use to identify this redline
+            const OUString& rId,
+            /// name of the author
+            const OUString& rAuthor,
+            /// redline comment
+            const OUString& rComment,
+            /// date+time
+            const ::com::sun::star::util::DateTime& rDateTime,
+            /// merge last paras
+            sal_Bool bMergeLastParagraph);
+
     virtual ::com::sun::star::uno::Reference<
         ::com::sun::star::text::XTextCursor> RedlineCreateText(
-            ::com::sun::star::uno::Reference<   /// needed to get the document
-                    ::com::sun::star::text::XTextCursor> & rOldCursor,
-            const OUString& rId);    /// ID used to RedlineAdd() call
+            /// needed to get the document
+            ::com::sun::star::uno::Reference< ::com::sun::star::text::XTextCursor > & rOldCursor,
+            /// ID used to RedlineAdd() call
+            const OUString& rId);
+
     virtual void RedlineSetCursor(
-        const OUString& rId,         /// ID used to RedlineAdd() call
-        sal_Bool bStart,                    /// start or end Cursor
-        sal_Bool bIsOutsideOfParagraph);    /// range is not within <text:p>
-    virtual void RedlineAdjustStartNodeCursor(
-        sal_Bool bStart);
+        /// ID used to RedlineAdd() call
+        const OUString& rId,
+        /// start or end Cursor
+        sal_Bool bStart,
+        /// range is not within <text:p>
+        sal_Bool bIsOutsideOfParagraph);
+
+    virtual void RedlineAdjustStartNodeCursor( sal_Bool bStart );
     virtual void SetShowChanges( sal_Bool bShowChanges );
     virtual void SetRecordChanges( sal_Bool bRecordChanges );
     virtual void SetChangesProtectionKey(
         const ::com::sun::star::uno::Sequence<sal_Int8> & rProtectionKey );
 
-    // access to the last open redline ID:
+    /// get the last open redline ID
     OUString GetOpenRedlineId();
+    /// modify the last open redline ID
     void SetOpenRedlineId( OUString& rId);
+    /// reset the last open redline ID
     void ResetOpenRedlineId();
 
     // #107848#
-    // Access methods to the inside_deleted_section flag (redlining)
+    /** redlining : Setter to remember the fact we are inside/outside
+     * a <text:deletion> element (deleted redline section) */
     void SetInsideDeleteContext(bool const bNew);
+    /** redlining : Getter to know if we are inside
+     * a <text:deletion> element (deleted redline section) */
     bool IsInsideDeleteContext() const;
 
     SvXMLImport & GetXMLImport();
diff --git a/include/xmloff/xmlictxt.hxx b/include/xmloff/xmlictxt.hxx
index 37903e4b4f8a..2ed80c1ec7cf 100644
--- a/include/xmloff/xmlictxt.hxx
+++ b/include/xmloff/xmlictxt.hxx
@@ -58,37 +58,37 @@ public:
     sal_uInt16 GetPrefix() const { return mnPrefix; }
     const OUString& GetLocalName() const { return maLocalName; }
 
-    // A contexts constructor does anything that is required if an element
-    // starts. Namespace processing has been done already.
-    // Note that virtual methods cannot be used inside constructors. Use
-    // StartElement instead if this is required.
+    /** A contexts constructor does anything that is required if an element
+     * starts. Namespace processing has been done already.
+     * Note that virtual methods cannot be used inside constructors. Use
+     * StartElement instead if this is required. */
     SvXMLImportContext( SvXMLImport& rImport, sal_uInt16 nPrfx,
                         const OUString& rLName );
 
-    // A contexts destructor does anything that is required if an element
-    // ends. By default, nothing is done.
-    // Note that virtual methods cannot be used inside destructors. Use
-    // EndElement instead if this is required.
+    /** A contexts destructor does anything that is required if an element
+     * ends. By default, nothing is done.
+     * Note that virtual methods cannot be used inside destructors. Use
+     * EndElement instead if this is required. */
     virtual ~SvXMLImportContext();
 
-    // Create a children element context. By default, the import's
-    // CreateContext method is called to create a new default context.
+    /** Create a children element context. By default, the import's
+     * CreateContext method is called to create a new default context. */
     virtual SvXMLImportContext *CreateChildContext( sal_uInt16 nPrefix,
                                    const OUString& rLocalName,
                                    const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );
 
-    // StartElement is called after a context has been constructed and
-    // before a elements context is parsed. It may be used for actions that
-    // require virtual methods. The default is to do nothing.
+    /** StartElement is called after a context has been constructed and
+     * before a elements context is parsed. It may be used for actions that
+     * require virtual methods. The default is to do nothing. */
     virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );
 
-    // EndElement is called before a context will be destructed, but
-    // after a elements context has been parsed. It may be used for actions
-    // that require virtual methods. The default is to do nothing.
+    /** EndElement is called before a context will be destructed, but
+     * after a elements context has been parsed. It may be used for actions
+     * that require virtual methods. The default is to do nothing. */
     virtual void EndElement();
 
-    // This method is called for all characters that are contained in the
-    // current element. The default is to ignore them.
+    /** This method is called for all characters that are contained in the
+     * current element. The default is to ignore them. */
     virtual void Characters( const OUString& rChars );
 };