Modifying comments to meet doxygen standards

Change-Id: I363ce532c7d11e798c2a5cc67b1b7893dcd0a389
Reviewed-on: https://gerrit.libreoffice.org/596
Reviewed-by: Michael Stahl <mstahl@redhat.com>
Tested-by: Michael Stahl <mstahl@redhat.com>

1 files changed, 61 insertions, 61 deletions

diff --git a/sw/inc/ndarr.hxx b/sw/inc/ndarr.hxx
index 051476856231..2f393af73bd0 100644
--- a/sw/inc/ndarr.hxx
+++ b/sw/inc/ndarr.hxx
@@ -101,27 +101,27 @@ class SW_DLLPUBLIC SwNodes
     friend class SwNode;
     friend class SwNodeIndex;
 
-    SwNodeIndex* pRoot;                 // List of all indices on nodes.
+    SwNodeIndex* pRoot;                 ///< List of all indices on nodes.
 
     void InsertNode( const SwNodePtr pNode,
                      const SwNodeIndex& rPos );
     void InsertNode( const SwNodePtr pNode,
                      sal_uLong nPos );
 
-    SwDoc* pMyDoc;                      // This Doc contains the nodes-array.
+    SwDoc* pMyDoc;                      ///< This Doc contains the nodes-array.
 
-    SwNode *pEndOfPostIts, *pEndOfInserts,  // These are the fixed ranges.
+    SwNode *pEndOfPostIts, *pEndOfInserts,  ///< These are the fixed ranges.
            *pEndOfAutotext, *pEndOfRedlines,
            *pEndOfContent;
 
-    mutable SwOutlineNodes* pOutlineNds;        // Array of all outline nodes.
+    mutable SwOutlineNodes* pOutlineNds;        ///< Array of all outline nodes.
 
-    sal_Bool bInNodesDel : 1;           // In Case of recursive calling.
-                                        // Do not update Num/Outline.
-    sal_Bool bInDelUpdOutl : 1;         // Flag for updating of Outline.
-    sal_Bool bInDelUpdNum : 1;          // Flag for updating of Outline.
+    sal_Bool bInNodesDel : 1;           /**< In Case of recursive calling.
+                                           Do not update Num/Outline. */
+    sal_Bool bInDelUpdOutl : 1;         ///< Flag for updating of Outline.
+    sal_Bool bInDelUpdNum : 1;          ///< Flag for updating of Outline.
 
-    // For administering indices.
+    /// For administering indices.
     void RegisterIndex( SwNodeIndex& rIdx );
     void DeRegisterIndex( SwNodeIndex& rIdx );
     void RemoveNode( sal_uLong nDelPos, sal_uLong nLen, sal_Bool bDel );
@@ -133,7 +133,7 @@ class SW_DLLPUBLIC SwNodes
     void ChgNode( SwNodeIndex& rDelPos, sal_uLong nSize,
                   SwNodeIndex& rInsPos, sal_Bool bNewFrms );
 
-    void UpdtOutlineIdx( const SwNode& );   // Update all OutlineNodes starting from Node.
+    void UpdtOutlineIdx( const SwNode& );   ///< Update all OutlineNodes starting from Node.
 
     void _CopyNodes( const SwNodeRange&, const SwNodeIndex&,
                     sal_Bool bNewFrms = sal_True, sal_Bool bTblInsDummyNode = sal_False ) const;
@@ -164,22 +164,22 @@ public:
     void ForEach( const SwNodeIndex& rStart, const SwNodeIndex& rEnd,
                     FnForEach_SwNodes fnForEach, void* pArgs = 0 );
 
-    // A still empty section.
+    /// A still empty section.
     SwNode& GetEndOfPostIts() const     { return *pEndOfPostIts; }
-    // Section fpr all footnotes.
+    /// Section fpr all footnotes.
     SwNode& GetEndOfInserts() const     { return *pEndOfInserts; }
-    // Section for all Flys/Header/Footers.
+    /// Section for all Flys/Header/Footers.
     SwNode& GetEndOfAutotext() const    { return *pEndOfAutotext; }
-    // Section for all Redlines.
+    /// Section for all Redlines.
     SwNode& GetEndOfRedlines() const    { return *pEndOfRedlines; }
-    // This is the last EndNode of a special section. After it
-    // there is only the regular ContentSection (i.e. the BodyText).
+    /** This is the last EndNode of a special section. After it
+       there is only the regular ContentSection (i.e. the BodyText). */
     SwNode& GetEndOfExtras() const      { return *pEndOfRedlines; }
-    // Regular ContentSection (i.e. the BodyText).
+    /// Regular ContentSection (i.e. the BodyText).
     SwNode& GetEndOfContent() const     { return *pEndOfContent; }
 
-    // Is the NodesArray the regular one of Doc? (and not the UndoNds, ...)
-    // Implementation in doc.hxx (because one needs to know Doc for it) !
+    /** Is the NodesArray the regular one of Doc? (and not the UndoNds, ...)
+       Implementation in doc.hxx (because one needs to know Doc for it) ! */
     sal_Bool IsDocNodes() const;
 
     sal_uInt16 GetSectionLevel(const SwNodeIndex &rIndex) const;
@@ -204,28 +204,28 @@ public:
     SwCntntNode* GoNext(SwNodeIndex *) const;
     SwCntntNode* GoPrevious(SwNodeIndex *) const;
 
-    // Go to next/previous Cntnt/Table-node for which LayoutFrames exist.
-    // While doing this do not leave Header/Footer/Frame etc.
+    /** Go to next/previous Cntnt/Table-node for which LayoutFrames exist.
+     While doing this do not leave Header/Footer/Frame etc. */
     SwNode* GoNextWithFrm(SwNodeIndex *) const;
     SwNode* GoPreviousWithFrm(SwNodeIndex *) const;
 
-    // Go to next content-node that is not protected or hidden
-    // (Both set FALSE ==> GoNext/GoPrevious!!!).
+    /** Go to next content-node that is not protected or hidden
+       (Both set FALSE ==> GoNext/GoPrevious!!!). */
     SwCntntNode* GoNextSection( SwNodeIndex *, int bSkipHidden  = sal_True,
                                            int bSkipProtect = sal_True ) const;
     SwCntntNode* GoPrevSection( SwNodeIndex *, int bSkipHidden  = sal_True,
                                            int bSkipProtect = sal_True ) const;
 
-    // Create an empty section of Start- and EndNote. It may be called
-    // only if a new section with content is to be created,
-    // e.g. at filters/Undo/...
+    /** Create an empty section of Start- and EndNote. It may be called
+       only if a new section with content is to be created,
+       e.g. at filters/Undo/... */
     SwStartNode* MakeEmptySection( const SwNodeIndex& rIdx,
                                     SwStartNodeType = SwNormalStartNode );
 
-    // Implementations of "Make...Node" are in the given .cxx-files.
+    /// Implementations of "Make...Node" are in the given .cxx-files.
     SwTxtNode *MakeTxtNode( const SwNodeIndex & rWhere,
                             SwTxtFmtColl *pColl,
-                            SwAttrSet* pAutoAttr = 0 ); // in ndtxt.cxx
+                            SwAttrSet* pAutoAttr = 0 ); ///< in ndtxt.cxx
     SwStartNode* MakeTextSection( const SwNodeIndex & rWhere,
                             SwStartNodeType eSttNdTyp,
                             SwTxtFmtColl *pColl,
@@ -237,38 +237,38 @@ public:
                             const Graphic* pGraphic,
                             SwGrfFmtColl *pColl,
                             SwAttrSet* pAutoAttr = 0,
-                            sal_Bool bDelayed = sal_False );    // in ndgrf.cxx
+                            sal_Bool bDelayed = sal_False );    ///< in ndgrf.cxx
 
     SwGrfNode *MakeGrfNode( const SwNodeIndex & rWhere,
                             const GraphicObject& rGrfObj,
                             SwGrfFmtColl *pColl,
-                            SwAttrSet* pAutoAttr = 0 ); // in ndgrf.cxx
+                            SwAttrSet* pAutoAttr = 0 ); ///< in ndgrf.cxx
 
     SwOLENode *MakeOLENode( const SwNodeIndex & rWhere,
                             const svt::EmbeddedObjectRef&,
                             SwGrfFmtColl *pColl,
-                            SwAttrSet* pAutoAttr = 0 ); // in ndole.cxx
+                            SwAttrSet* pAutoAttr = 0 ); ///< in ndole.cxx
     SwOLENode *MakeOLENode( const SwNodeIndex & rWhere,
                             const String &rName,
                             sal_Int64 nAspect,
                             SwGrfFmtColl *pColl,
-                            SwAttrSet* pAutoAttr ); // in ndole.cxx
+                            SwAttrSet* pAutoAttr ); ///< in ndole.cxx
 
-    // Array of all OutlineNodes.
+    /// Array of all OutlineNodes.
     const SwOutlineNodes& GetOutLineNds() const;
 
     //void UpdateOutlineNode( const SwNode&, sal_uInt8 nOldLevel, sal_uInt8 nNewLevel );//#outline level,removed by zhaojianwei
 
-    // Update all Nodes - Rule/Format-Change.
+    /// Update all Nodes - Rule/Format-Change.
     void UpdateOutlineNode(SwNode & rNd);
 
-    // Insert nodes for tables. If Lines is given, create the matrix
-    // from lines and boxes, else only the count of boxes.
+    /** Insert nodes for tables. If Lines is given, create the matrix
+       from lines and boxes, else only the count of boxes.
 
-    // New parameter pAttrSet: If pAttrSet is non-null and contains an
-    // adjust item it is propagated to the table cells. If there is an
-    // adjust in pCntntTxtColl or pHeadlineTxtColl this adjust item
-    // overrides the item in pAttrSet.
+       New parameter pAttrSet: If pAttrSet is non-null and contains an
+       adjust item it is propagated to the table cells. If there is an
+       adjust in pCntntTxtColl or pHeadlineTxtColl this adjust item
+       overrides the item in pAttrSet. */
 
     SwTableNode* InsertTable( const SwNodeIndex& rNdIdx,
                         sal_uInt16 nBoxes, SwTxtFmtColl* pCntntTxtColl,
@@ -276,7 +276,7 @@ public:
                         SwTxtFmtColl* pHeadlineTxtColl = 0,
                         const SwAttrSet * pAttrSet = 0);
 
-    // Create balanced table from selected range.
+    /// Create balanced table from selected range.
     SwTableNode* TextToTable( const SwNodeRange& rRange, sal_Unicode cCh,
                                 SwTableFmt* pTblFmt,
                                 SwTableLineFmt* pLineFmt,
@@ -286,7 +286,7 @@ public:
 
     SwNodeRange * ExpandRangeForTableBox(const SwNodeRange & rRange);
 
-    //create a table from a vector of NodeRanges - API support
+    /// create a table from a vector of NodeRanges - API support
     SwTableNode* TextToTable( const TableRanges_t& rTableNodes,
                                 SwTableFmt* pTblFmt,
                                 SwTableLineFmt* pLineFmt,
@@ -295,33 +295,33 @@ public:
                                 /*, SwUndo... pUndo*/ );
 
 
-    // Create regular text from what was table.
+    /// Create regular text from what was table.
     sal_Bool TableToText( const SwNodeRange& rRange, sal_Unicode cCh,
                         SwUndoTblToTxt* = 0 );
-    // Is in untbl.cxx and may called only by Undo-object.
+    /// Is in untbl.cxx and may called only by Undo-object.
     SwTableNode* UndoTableToText( sal_uLong nStt, sal_uLong nEnd,
                         const SwTblToTxtSaves& rSavedData );
 
-    // Insert a new box in the line before InsPos. Its format
-    // is taken from the following one (or from the previous one if we are
-    // at the end). In the line there must be a box already.
+    /** Insert a new box in the line before InsPos. Its format
+       is taken from the following one (or from the previous one if we are
+       at the end). In the line there must be a box already. */
     sal_Bool InsBoxen( SwTableNode*, SwTableLine*, SwTableBoxFmt*,
-                        // Formats for TextNode of box.
+                        /// Formats for TextNode of box.
                         SwTxtFmtColl*, const SfxItemSet* pAutoAttr,
                         sal_uInt16 nInsPos, sal_uInt16 nCnt = 1 );
-    // Splits a table at the base-line which contains the index.
-    // All base lines behind it are moved to a new table/ -node.
-    // Is the flag bCalcNewSize set to TRUE, the new SSize for both
-    // tables is calculated from the Maximum of the boxes, provided
-    // SSize is set "absolute" (LONG_MAX).
-    // (Momentarily this is needed only for the RTF-parser.)
+    /** Splits a table at the base-line which contains the index.
+       All base lines behind it are moved to a new table/ -node.
+       Is the flag bCalcNewSize set to TRUE, the new SSize for both
+       tables is calculated from the Maximum of the boxes, provided
+       SSize is set "absolute" (LONG_MAX).
+       (Momentarily this is needed only for the RTF-parser.) */
     SwTableNode* SplitTable( const SwNodeIndex& rPos, sal_Bool bAfter = sal_True,
                                 sal_Bool bCalcNewSize = sal_False );
-    // Two Tables that are following one another are merged.
+    /// Two Tables that are following one another are merged.
     sal_Bool MergeTable( const SwNodeIndex& rPos, sal_Bool bWithPrev = sal_True,
                     sal_uInt16 nMode = 0, SwHistory* pHistory = 0 );
 
-    // Insert a new SwSection.
+    /// Insert a new SwSection.
     SwSectionNode* InsertTextSection(SwNodeIndex const& rNdIdx,
                                 SwSectionFmt& rSectionFmt,
                                 SwSectionData const&,
@@ -330,14 +330,14 @@ public:
                                 bool const bInsAtStart = true,
                                 bool const bCreateFrms = true);
 
-    // Which Doc contains the nodes-array?
+    /// Which Doc contains the nodes-array?
             SwDoc* GetDoc()         { return pMyDoc; }
     const   SwDoc* GetDoc() const   { return pMyDoc; }
 
-    // Search previous / next content node or table node with frames.
-    // If no end is given begin with the FrameIndex, else start search
-    // with that before rFrmIdx and pEnd at the back.
-    // If no valid node is found, return 0. rFrmIdx points to the node with frames.
+    /** Search previous / next content node or table node with frames.
+     If no end is given begin with the FrameIndex, else start search
+     with that before rFrmIdx and pEnd at the back.
+     If no valid node is found, return 0. rFrmIdx points to the node with frames. **/
     SwNode* FindPrvNxtFrmNode( SwNodeIndex& rFrmIdx,
                                 const SwNode* pEnd = 0 ) const;