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, 85 insertions, 85 deletions

diff --git a/sw/inc/ndtxt.hxx b/sw/inc/ndtxt.hxx
index 39565cf4a6fd..603522cd0583 100644
--- a/sw/inc/ndtxt.hxx
+++ b/sw/inc/ndtxt.hxx
@@ -56,14 +56,14 @@ namespace utl {
 
 class SwTxtFmtColl;
 class SwCntntFrm;
-class SwTxtFld;          // For GetTxtFld().
+class SwTxtFld;                 ///< For GetTxtFld().
 class SfxItemSet;
 class SwUndoTransliterate;
 
-struct SwSpellArgs;             // for Spell(), splargs.hxx
-struct SwConversionArgs;        // for Convert(), splargs.hxx
-class SwInterHyphInfo;          // for Hyphenate(), splargs.hxx
-class SwWrongList;      // For OnlineSpelling.
+struct SwSpellArgs;             ///< for Spell(), splargs.hxx
+struct SwConversionArgs;        ///< for Convert(), splargs.hxx
+class SwInterHyphInfo;          ///< for Hyphenate(), splargs.hxx
+class SwWrongList;              ///< For OnlineSpelling.
 class SwGrammarMarkUp;
 class OutputDevice;
 class SwScriptInfo;
@@ -83,42 +83,42 @@ typedef std::set< xub_StrLen > SwSoftPageBreakList;
 class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
 {
 
-    // For creating the first TextNode.
-    friend class SwDoc;         // CTOR and AppendTxtNode()
+    /// For creating the first TextNode.
+    friend class SwDoc;         ///< CTOR and AppendTxtNode()
     friend class SwNodes;
     friend class SwTxtFrm;
     friend class SwScriptInfo;
 
-    // May be 0. It is only then not 0 if it contains hard attributes.
-    // Therefore: never access directly!
+    /** May be 0. It is only then not 0 if it contains hard attributes.
+       Therefore: never access directly! */
     SwpHints    *m_pSwpHints;
 
-    mutable SwNodeNum* mpNodeNum;  // Numbering for this paragraph.
+    mutable SwNodeNum* mpNodeNum;  ///< Numbering for this paragraph.
 
     XubString   m_Text;
 
     SwParaIdleData_Impl* m_pParaIdleData_Impl;
 
-    // Some of the chars this para are hidden. Paragraph has to be reformatted
-    // on changing the view to print preview.
+    /** Some of the chars this para are hidden. Paragraph has to be reformatted
+       on changing the view to print preview. */
     mutable bool m_bContainsHiddenChars : 1;
-    // The whole paragraph is hidden because of the hidden text attribute
+    /// The whole paragraph is hidden because of the hidden text attribute
     mutable bool m_bHiddenCharsHidePara : 1;
-    // The last two flags have to be recalculated if this flag is set:
+    /// The last two flags have to be recalculated if this flag is set:
     mutable bool m_bRecalcHiddenCharFlags : 1;
 
     mutable bool m_bLastOutlineState : 1;
     bool m_bNotifiable;
 
-    // sal_uInt8 nOutlineLevel; //#outline level, removed by zhaojianwei.
+    /// sal_uInt8 nOutlineLevel; //#outline level, removed by zhaojianwei.
     bool mbEmptyListStyleSetDueToSetOutlineLevelAttr;
 
-    // boolean, indicating that a <SetAttr(..)> or <ResetAttr(..)> or
-    // <ResetAllAttr(..)> method is running.
-    // Needed to avoid duplicate handling of attribute change actions.
+    /** boolean, indicating that a <SetAttr(..)> or <ResetAttr(..)> or
+       <ResetAllAttr(..)> method is running.
+       Needed to avoid duplicate handling of attribute change actions. */
     bool mbInSetOrResetAttr;
 
-    // pointer to the list, to whose the text node is added to
+    /// pointer to the list, to whose the text node is added to
     SwList* mpList;
 
     ::std::auto_ptr< ::rtl::OUString > m_pNumStringCache;
@@ -129,7 +129,7 @@ class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
     SW_DLLPRIVATE SwTxtNode( const SwNodeIndex &rWhere, SwTxtFmtColl *pTxtColl,
                              const SfxItemSet* pAutoAttr = 0 );
 
-    // Copies the attributes at nStart to pDest.
+    /// Copies the attributes at nStart to pDest.
     SW_DLLPRIVATE void CopyAttr( SwTxtNode *pDest, const xub_StrLen nStart, const xub_StrLen nOldPos);
 
     SW_DLLPRIVATE SwTxtNode* _MakeNewTxtNode( const SwNodeIndex&, sal_Bool bNext = sal_True,
@@ -140,17 +140,17 @@ class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
           const SwIndex & rStart, /*const*/ xub_StrLen nLen,
           const bool bUpdate = true );
 
-    // Move all comprising hard attributes to the AttrSet of the paragraph.
+    /// Move all comprising hard attributes to the AttrSet of the paragraph.
     SW_DLLPRIVATE void MoveTxtAttr_To_AttrSet();  // Called by SplitNode.
 
-    // Create the specific AttrSet.
+    /// Create the specific AttrSet.
     SW_DLLPRIVATE virtual void NewAttrSet( SwAttrPool& );
 
     SW_DLLPRIVATE void Replace0xFF( XubString& rTxt, xub_StrLen& rTxtStt,
                         xub_StrLen nEndPos, sal_Bool bExpandFlds ) const;
 
-    // Optimization: Asking for information about hidden characters at SwScriptInfo
-    // updates these flags.
+    /// Optimization: Asking for information about hidden characters at SwScriptInfo
+    /// updates these flags.
     inline bool IsCalcHiddenCharFlags() const
         { return m_bRecalcHiddenCharFlags; }
     inline void SetHiddenCharAttribute( bool bNewHiddenCharsHidePara, bool bNewContainsHiddenChars ) const
@@ -168,9 +168,9 @@ class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
             LanguageType nLang, sal_uInt16 nLangWhichId,
             const Font *pFont,  sal_uInt16 nFontWhichId );
 
-    //
-    // Start: Data collected during idle time
-    //
+
+    /// Start: Data collected during idle time
+
     SW_DLLPRIVATE void SetParaNumberOfWords( sal_uLong nTmpWords ) const;
     SW_DLLPRIVATE sal_uLong GetParaNumberOfWords() const;
     SW_DLLPRIVATE void SetParaNumberOfAsianWords( sal_uLong nTmpAsianWords ) const;
@@ -195,27 +195,27 @@ public:
     bool IsWordCountDirty() const;
     bool IsWrongDirty() const;
     bool IsGrammarCheckDirty() const;
-    bool IsSmartTagDirty() const;   // SMARTTAGS
+    bool IsSmartTagDirty() const;   ///< SMARTTAGS
     bool IsAutoCompleteWordDirty() const;
     void SetWordCountDirty( bool bNew ) const;
     void SetWrongDirty( bool bNew ) const;
     void SetGrammarCheckDirty( bool bNew ) const;
-    void SetSmartTagDirty( bool bNew ) const;  // SMARTTAGS
+    void SetSmartTagDirty( bool bNew ) const;  ///< SMARTTAGS
     void SetAutoCompleteWordDirty( bool bNew ) const;
     void SetWrong( SwWrongList* pNew, bool bDelete = true );
     SwWrongList* GetWrong();
     const SwWrongList* GetWrong() const;
     void SetGrammarCheck( SwGrammarMarkUp* pNew, bool bDelete = true );
     SwGrammarMarkUp* GetGrammarCheck();
-    // SMARTTAGS
+    /// SMARTTAGS
     void SetSmartTags( SwWrongList* pNew, bool bDelete = true );
     SwWrongList* GetSmartTags();
 
-    //
-    // End: Data collected during idle time
-    //
+
+    /// End: Data collected during idle time
+
 protected:
-    // fuers Umhaengen der TxtFmtCollections (Outline-Nummerierung!!)
+    /// fuers Umhaengen der TxtFmtCollections (Outline-Nummerierung!!)
     virtual void Modify( const SfxPoolItem*, const SfxPoolItem* );
     virtual void SwClientNotify( const SwModify&, const SfxHint& );
 
@@ -224,7 +224,7 @@ public:
 
     const String& GetTxt() const { return m_Text; }
 
-    // getters for SwpHints
+    /// getters for SwpHints
     inline       SwpHints &GetSwpHints();
     inline const SwpHints &GetSwpHints() const;
     inline       SwpHints *GetpSwpHints()       { return m_pSwpHints; }
@@ -236,11 +236,11 @@ public:
 
     virtual xub_StrLen Len() const;
 
-    // Is in itratr.
+    /// Is in itratr.
     void GetMinMaxSize( sal_uLong nIndex, sal_uLong& rMin, sal_uLong &rMax, sal_uLong &rAbs,
                         OutputDevice* pOut = 0 ) const;
 
-    // overriding to handle change of certain paragraph attributes
+    /// overriding to handle change of certain paragraph attributes
     virtual sal_Bool SetAttr( const SfxPoolItem& );
     virtual sal_Bool SetAttr( const SfxItemSet& rSet );
     virtual sal_Bool ResetAttr( sal_uInt16 nWhich1, sal_uInt16 nWhich2 = 0 );
@@ -290,24 +290,24 @@ public:
                   const xub_StrLen nStart, const xub_StrLen nEnd,
                   const SetAttrMode nMode = nsSetAttrMode::SETATTR_DEFAULT );
 
-    // Set these attributes at TextNode. If the whole range is comprised
-    // set them only in AutoAttrSet (SwCntntNode::SetAttr).
+    /** Set these attributes at TextNode. If the whole range is comprised
+       set them only in AutoAttrSet (SwCntntNode::SetAttr). */
     sal_Bool SetAttr( const SfxItemSet& rSet,
                   xub_StrLen nStt, xub_StrLen nEnd,
                   const SetAttrMode nMode = nsSetAttrMode::SETATTR_DEFAULT );
-    // Query the attributes of textnode over the range.
-    // Introduce 4th optional parameter <bMergeIndentValuesOfNumRule>.
-    // If <bMergeIndentValuesOfNumRule> == sal_True, the indent attributes of
-    // the corresponding list level of an applied list style is merged into
-    // the requested item set as a LR-SPACE item, if <bOnlyTxtAttr> == sal_False,
-    // corresponding node has not its own indent attributes and the
-    // position-and-space mode of the list level is SvxNumberFormat::LABEL_ALIGNMENT.
+    /** Query the attributes of textnode over the range.
+       Introduce 4th optional parameter <bMergeIndentValuesOfNumRule>.
+       If <bMergeIndentValuesOfNumRule> == sal_True, the indent attributes of
+       the corresponding list level of an applied list style is merged into
+       the requested item set as a LR-SPACE item, if <bOnlyTxtAttr> == sal_False,
+       corresponding node has not its own indent attributes and the
+       position-and-space mode of the list level is SvxNumberFormat::LABEL_ALIGNMENT. */
     sal_Bool GetAttr( SfxItemSet& rSet, xub_StrLen nStt, xub_StrLen nEnd,
                   sal_Bool bOnlyTxtAttr  = sal_False,
                   sal_Bool bGetFromChrFmt = sal_True,
                   const bool bMergeIndentValuesOfNumRule = false ) const;
 
-    // Convey attributes of an AttrSet (AutoFmt) to SwpHintsArray.
+    /// Convey attributes of an AttrSet (AutoFmt) to SwpHintsArray.
     void FmtToTxtAttr( SwTxtNode* pNd );
 
     /// delete all attributes of type nWhich at nStart (opt. end nEnd)
@@ -316,8 +316,8 @@ public:
     /// delete the attribute pTxtAttr
     void DeleteAttribute ( SwTxtAttr * const pTxtAttr );
 
-    // Actions on text and attributes.
-    // introduce optional parameter to control, if all attributes have to be copied.
+    /** Actions on text and attributes.
+       introduce optional parameter to control, if all attributes have to be copied. */
     void CopyText( SwTxtNode * const pDest,
                const SwIndex &rStart,
                const xub_StrLen nLen,
@@ -339,7 +339,7 @@ public:
     void ReplaceTextOnly( xub_StrLen nPos, xub_StrLen nLen, const XubString& rText,
                     const ::com::sun::star::uno::Sequence<sal_Int32>& rOffsets );
 
-    // Virtual methods from CntntNode.
+    /// Virtual methods from CntntNode.
     virtual SwCntntFrm *MakeFrm( SwFrm* );
     virtual SwCntntNode *SplitCntntNode( const SwPosition & );
     virtual SwCntntNode *JoinNext();
@@ -347,7 +347,7 @@ public:
 
     SwCntntNode *AppendNode( const SwPosition & );
 
-    // When appropriate set DontExpand-flag at INet or character styles respectively.
+    /// When appropriate set DontExpand-flag at INet or character styles respectively.
     sal_Bool DontExpandFmt( const SwIndex& rIdx, bool bFlag = true,
                         sal_Bool bFmtToTxtAttributes = sal_True );
 
@@ -395,9 +395,9 @@ public:
     void _ChgTxtCollUpdateNum( const SwTxtFmtColl* pOld,
                                 const SwTxtFmtColl* pNew );
 
-    // Copy collection with all auto formats to dest-node.
-    // The latter might be in an other document!
-    // (Method in ndcopy.cxx!!).
+    /** Copy collection with all auto formats to dest-node.
+        The latter might be in an other document!
+       (Method in ndcopy.cxx!!). */
     void CopyCollFmt( SwTxtNode& rDestNd );
 
     //const SwNodeNum* _GetNodeNum() const { return pNdNum; }
@@ -675,20 +675,20 @@ public:
     sal_uInt16 GetLang( const xub_StrLen nBegin, const xub_StrLen nLen = 0,
                     sal_uInt16 nScript = 0 ) const;
 
-    // in ndcopy.cxx
+    /// in ndcopy.cxx
     sal_Bool IsSymbol( const xub_StrLen nBegin ) const; // In itratr.cxx.
     virtual SwCntntNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
 
-    // Interactive hyphenation: we find TxtFrm and call its CalcHyph.
+    /// Interactive hyphenation: we find TxtFrm and call its CalcHyph.
     sal_Bool Hyphenate( SwInterHyphInfo &rHyphInf );
     void DelSoftHyph( const xub_StrLen nStart, const xub_StrLen nEnd );
 
-    // add 4th optional parameter <bAddSpaceAfterListLabelStr> indicating,
-    // when <bWithNum = true> that a space is inserted after the string for
-    // the list label.
-    // add 5th optional parameter <bWithSpacesForLevel> indicating, if additional
-    // spaces are inserted in front of the expanded text string depending on
-    // the list level.
+    /** add 4th optional parameter <bAddSpaceAfterListLabelStr> indicating,
+       when <bWithNum = true> that a space is inserted after the string for
+       the list label.
+       add 5th optional parameter <bWithSpacesForLevel> indicating, if additional
+       spaces are inserted in front of the expanded text string depending on
+       the list level. */
     XubString GetExpandTxt( const xub_StrLen nIdx = 0,
                             const xub_StrLen nLen = STRING_LEN,
                             const bool bWithNum = false,
@@ -704,27 +704,27 @@ public:
                           sal_Bool bExpandFlds = sal_False,
                           sal_Bool bWithNum = sal_False ) const;
 
-    // Returns actual count of initial chars for initial-function.
-    // If nWishLen == 0 that of first word.
+    /** @return actual count of initial chars for initial-function.
+       If nWishLen == 0 that of first word. */
     sal_uInt16 GetDropLen( sal_uInt16 nWishLen) const;
 
-    // Passes back info needed on the dropcap dimensions
+    /// Passes back info needed on the dropcap dimensions
     bool GetDropSize(int& rFontHeight, int& rDropHeight, int& rDropDescent) const;
 
-    // Hidden Paragraph Field:
+    /// Hidden Paragraph Field:
     inline bool CalcHiddenParaField()
         { return m_pSwpHints ? m_pSwpHints->CalcHiddenParaField() : false; }
-    // set CalcVisible flags
+    /// set CalcVisible flags
     inline void SetCalcHiddenParaField()
         { if (m_pSwpHints) m_pSwpHints->SetCalcHiddenParaField(); }
 
-    // is the paragraph visible?
+    /// is the paragraph visible?
     inline bool HasHiddenParaField() const
         { return m_pSwpHints ? m_pSwpHints->HasHiddenParaField()  : false; }
 
-    //
-    // Hidden Paragraph Field:
-    //
+
+    /// Hidden Paragraph Field:
+
     inline bool HasHiddenCharAttribute( bool bWholePara ) const
     {
         if ( m_bRecalcHiddenCharFlags )
@@ -735,33 +735,33 @@ public:
     inline void SetCalcHiddenCharFlags() const
         { m_bRecalcHiddenCharFlags = true; }
 
-    //
-    // Returns if the node is hidden due to
-    // 1. HiddenParaField
-    // 2. HiddenCharAttribute
-    // 3. HiddenSection
-    //
+
+    /** @return if the node is hidden due to
+       1. HiddenParaField
+       2. HiddenCharAttribute
+       3. HiddenSection */
+
     bool IsHidden() const;
 
     TYPEINFO(); // fuer rtti
 
-    // override SwIndexReg
+    /// override SwIndexReg
     virtual void Update( SwIndex const & rPos, const xub_StrLen nChangeLen,
                  const bool bNegative = false, const bool bDelete = false );
 
-    // change text to Upper/Lower/Hiragana/Katagana/...
+    /// change text to Upper/Lower/Hiragana/Katagana/...
     void TransliterateText( utl::TransliterationWrapper& rTrans,
                             xub_StrLen nStart, xub_StrLen nEnd,
                             SwUndoTransliterate* pUndo = 0 );
 
-    // count words in given range
+    /// count words in given range
     void CountWords( SwDocStat& rStat, xub_StrLen nStart, xub_StrLen nEnd ) const;
 
-    // Checks some global conditions like loading or destruction of document
-    // to economize notifications
+    /** Checks some global conditions like loading or destruction of document
+       to economize notifications */
     bool IsNotificationEnabled() const;
 
-    // Checks a temporary notification blocker and the global conditons of IsNotificationEnabled()
+    /// Checks a temporary notification blocker and the global conditons of IsNotificationEnabled()
     bool IsNotifiable() const;
 
     void SetListRestart( bool bRestart );
@@ -790,7 +790,7 @@ public:
                     ::com::sun::star::text::XTextContent> const& xParagraph)
             { m_wXParagraph = xParagraph; }
 
-    // sfx2::Metadatable
+    /// sfx2::Metadatable
     virtual ::sfx2::IXmlIdRegistry& GetRegistry();
     virtual bool IsInClipboard() const;
     virtual bool IsInUndo() const;
@@ -847,7 +847,7 @@ inline SwTxtFmtColl* SwTxtNode::GetTxtColl() const
     return static_cast<SwTxtFmtColl*>(const_cast<SwModify*>(GetRegisteredIn()));
 }
 
-// Inline methods from Node.hxx
+/// Inline methods from Node.hxx
 inline SwTxtNode *SwNode::GetTxtNode()
 {
      return ND_TEXTNODE == nNodeType ? static_cast<SwTxtNode*>(this) : 0;