This is modifying comments to meet doxygen standards

Change-Id: I73cd4c901aa003abec43f55948c184672d2e14ff
Reviewed-on: https://gerrit.libreoffice.org/338
Reviewed-by: Eike Rathke <erack@redhat.com>
Tested-by: Jan Holesovsky <kendy@suse.cz>
Reviewed-by: Jan Holesovsky <kendy@suse.cz>

11 files changed, 129 insertions, 129 deletions

diff --git a/sw/inc/IDocumentMarkAccess.hxx b/sw/inc/IDocumentMarkAccess.hxx
index acf83b486066..9b4bbb1d351b 100644
--- a/sw/inc/IDocumentMarkAccess.hxx
+++ b/sw/inc/IDocumentMarkAccess.hxx
@@ -234,7 +234,8 @@ class IDocumentMarkAccess
         virtual ::sw::mark::IFieldmark* getFieldmarkBefore(const SwPosition& pos) const =0;
         virtual ::sw::mark::IFieldmark* getFieldmarkAfter(const SwPosition& pos) const =0;
 
-        // Returns the MarkType used to create the mark
+        /** Returns the MarkType used to create the mark
+        */
         static MarkType SAL_DLLPUBLIC_EXPORT GetType(const ::sw::mark::IMark& rMark);
     protected:
         virtual ~IDocumentMarkAccess() {};
diff --git a/sw/inc/IDocumentRedlineAccess.hxx b/sw/inc/IDocumentRedlineAccess.hxx
index df2f4ca868d5..9c251b07a065 100644
--- a/sw/inc/IDocumentRedlineAccess.hxx
+++ b/sw/inc/IDocumentRedlineAccess.hxx
@@ -53,11 +53,11 @@
 typedef sal_uInt16 RedlineMode_t;
 namespace nsRedlineMode_t
 {
-    const RedlineMode_t REDLINE_NONE = 0; // no RedlineMode
-    const RedlineMode_t REDLINE_ON = 0x01;// RedlineMode on
-    const RedlineMode_t REDLINE_IGNORE = 0x02;// ignore Redlines
-    const RedlineMode_t REDLINE_SHOW_INSERT = 0x10;// show all inserts
-    const RedlineMode_t REDLINE_SHOW_DELETE = 0x20;// show all deletes
+    const RedlineMode_t REDLINE_NONE = 0; ///< no RedlineMode
+    const RedlineMode_t REDLINE_ON = 0x01;///< RedlineMode on
+    const RedlineMode_t REDLINE_IGNORE = 0x02;///< ignore Redlines
+    const RedlineMode_t REDLINE_SHOW_INSERT = 0x10;///< show all inserts
+    const RedlineMode_t REDLINE_SHOW_DELETE = 0x20;///< show all deletes
     const RedlineMode_t REDLINE_SHOW_MASK = REDLINE_SHOW_INSERT | REDLINE_SHOW_DELETE;
 
     // For internal management:
diff --git a/sw/inc/bparr.hxx b/sw/inc/bparr.hxx
index a2834d3bb06a..e5035a805547 100644
--- a/sw/inc/bparr.hxx
+++ b/sw/inc/bparr.hxx
@@ -67,24 +67,24 @@ typedef sal_Bool (*FnForEach)( const ElementPtr&, void* pArgs );
 #define COMPRESSLVL 80
 
 struct BlockInfo {                  // block info:
-    BigPtrArray* pBigArr;           // in this array the block is located
-    ElementPtr* pData;              // data block
-    sal_uLong nStart, nEnd;         // start- and end index
-    sal_uInt16 nElem;               // number of elements
+    BigPtrArray* pBigArr;           ///< in this array the block is located
+    ElementPtr* pData;              ///< data block
+    sal_uLong nStart, nEnd;         ///< start- and end index
+    sal_uInt16 nElem;               ///< number of elements
 };
 
 class SW_DLLPUBLIC BigPtrArray
 {
     BlockInfo** ppInf;              // block info
-    sal_uLong       nSize;              // number of elements
-    sal_uInt16      nMaxBlock;          // current max. number of blocks
-    sal_uInt16      nBlock;             // number of blocks
-    sal_uInt16      nCur;               // last block
-
-    sal_uInt16      Index2Block( sal_uLong ) const; // block search
-    BlockInfo*  InsBlock( sal_uInt16 );         // insert block
-    void        BlockDel( sal_uInt16 );         // some blocks were deleted
-    void        UpdIndex( sal_uInt16 );         // recalculate indices
+    sal_uLong       nSize;              ///< number of elements
+    sal_uInt16      nMaxBlock;          ///< current max. number of blocks
+    sal_uInt16      nBlock;             ///< number of blocks
+    sal_uInt16      nCur;               ///< last block
+
+    sal_uInt16      Index2Block( sal_uLong ) const; ///< block search
+    BlockInfo*  InsBlock( sal_uInt16 );         ///< insert block
+    void        BlockDel( sal_uInt16 );         ///< some blocks were deleted
+    void        UpdIndex( sal_uInt16 );         ///< recalculate indices
 
 protected:
     // fill all blocks
diff --git a/sw/inc/breakit.hxx b/sw/inc/breakit.hxx
index bc22897a49bb..4ed10f99b0f8 100644
--- a/sw/inc/breakit.hxx
+++ b/sw/inc/breakit.hxx
@@ -51,8 +51,8 @@ class SW_DLLPUBLIC SwBreakIt : private ::boost::noncopyable
     com::sun::star::lang::Locale * m_pLocale;
     com::sun::star::i18n::ForbiddenCharacters * m_pForbidden;
 
-    LanguageType aLast;          // language of the current locale
-    LanguageType aForbiddenLang; // language of the current forbiddenChar struct
+    LanguageType aLast;          ///< language of the current locale
+    LanguageType aForbiddenLang; ///< language of the current forbiddenChar struct
 
     void _GetLocale( const LanguageType aLang );
     void _GetForbidden( const LanguageType  aLang );
diff --git a/sw/inc/calbck.hxx b/sw/inc/calbck.hxx
index e962d568a120..d360c510dbaf 100644
--- a/sw/inc/calbck.hxx
+++ b/sw/inc/calbck.hxx
@@ -75,8 +75,8 @@ class SW_DLLPUBLIC SwClient : ::boost::noncopyable
     friend class SwModify;
     friend class SwClientIter;
 
-    SwClient *pLeft, *pRight;       // double-linked list of other clients
-    SwModify *pRegisteredIn;        // event source
+    SwClient *pLeft, *pRight;       ///< double-linked list of other clients
+    SwModify *pRegisteredIn;        ///< event source
 
     // in general clients should not be removed when their SwModify sends out Modify()
     // notifications; in some rare cases this is necessary, but only the concrete SwClient
@@ -198,9 +198,8 @@ public:
 
     SwClient* GetToTell() { return pToTell; }
 
-    // get Client information
+    /** get Client information */
     virtual sal_Bool GetInfo( SfxPoolItem & ) const;
-
 protected:
     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNewValue );
     virtual void SwClientNotify( const SwModify& rModify, const SfxHint& rHint );
@@ -209,8 +208,8 @@ protected:
 
 class SwClientIter
 {
-    friend SwClient* SwModify::Remove(SwClient *); // for pointer adjustments
-    friend void SwModify::Add(SwClient *pDepend);   // for pointer adjustments
+    friend SwClient* SwModify::Remove(SwClient *); ///< for pointer adjustments
+    friend void SwModify::Add(SwClient *pDepend);   ///< for pointer adjustments
 
     const SwModify& rRoot;
 
diff --git a/sw/inc/cellatr.hxx b/sw/inc/cellatr.hxx
index c147379e98e5..d60686623083 100644
--- a/sw/inc/cellatr.hxx
+++ b/sw/inc/cellatr.hxx
@@ -37,7 +37,7 @@
 
 class SW_DLLPUBLIC SwTblBoxNumFormat : public SfxUInt32Item
 {
-    sal_Bool bAuto;     // automatically given flag
+    sal_Bool bAuto;     ///< automatically given flag
 public:
     SwTblBoxNumFormat( sal_uInt32 nFormat = NUMBERFORMAT_TEXT,
                         sal_Bool bAuto = sal_False );
diff --git a/sw/inc/cellfml.hxx b/sw/inc/cellfml.hxx
index 837316271eff..6c020f155caf 100644
--- a/sw/inc/cellfml.hxx
+++ b/sw/inc/cellfml.hxx
@@ -47,9 +47,9 @@ class SwTblCalcPara
     sal_uInt16 nStackCnt, nMaxSize;
 
 public:
-    SwTableSortBoxes *pBoxStk;  // stack for recognizing recursion
-    SwCalc& rCalc;              // current Calculator
-    const SwTable* pTbl;        // current table
+    SwTableSortBoxes *pBoxStk;  ///< stack for recognizing recursion
+    SwCalc& rCalc;              ///< current Calculator
+    const SwTable* pTbl;        ///< current table
 
     SwTblCalcPara( SwCalc& rCalculator, const SwTable& rTable );
     ~SwTblCalcPara();
@@ -97,9 +97,9 @@ typedef void (SwTableFormula:: *FnScanFormel)( const SwTable&, String&,
 protected:
     enum NameType { EXTRNL_NAME, INTRNL_NAME, REL_NAME };
 
-    String      sFormel;            // current formula
-    NameType    eNmType;            // current display method
-    sal_Bool        bValidValue;        // sal_True: recalculate formula
+    String      sFormel;            ///< current formula
+    NameType    eNmType;            ///< current display method
+    sal_Bool        bValidValue;        ///< sal_True: recalculate formula
 
     // find the node in which the formula is located
     //  TextFeld    -> TextNode,
@@ -129,13 +129,13 @@ public:
                                     return *this;
         }
 
-    // create from the internal formula (for CORE) the external formula (for UI)
+    /// create from the internal formula (for CORE) the external formula (for UI)
     void PtrToBoxNm( const SwTable* pTbl );
-    // create from the external formula the internal
+    /// create from the external formula the internal
     void BoxNmToPtr( const SwTable* pTbl );
-    // create from the external/internal formula the relative formula
+    /// create from the external/internal formula the relative formula
     void ToRelBoxNm( const SwTable* pTbl );
-    // gets called before/after merging/splitting of tables
+    /// gets called before/after merging/splitting of tables
     void ToSplitMergeBoxNm( SwTableFmlUpdate& rTblUpd );
 
     bool IsIntrnlName() const                  { return eNmType == INTRNL_NAME; }
diff --git a/sw/inc/chpfld.hxx b/sw/inc/chpfld.hxx
index cf45a3412569..97effe55f9bb 100644
--- a/sw/inc/chpfld.hxx
+++ b/sw/inc/chpfld.hxx
@@ -39,11 +39,11 @@ class SwTxtNode;
 enum SwChapterFormat
 {
     CF_BEGIN,
-    CF_NUMBER = CF_BEGIN,       // only the chapter number
-    CF_TITLE,                   // only the title
-    CF_NUM_TITLE,               // number and title
-    CF_NUMBER_NOPREPST,         // only chapter number without post-/prefix
-    CF_NUM_NOPREPST_TITLE,      // chapter number without post-/prefix and title
+    CF_NUMBER = CF_BEGIN,       ///< only the chapter number
+    CF_TITLE,                   ///< only the title
+    CF_NUM_TITLE,               ///< number and title
+    CF_NUMBER_NOPREPST,         ///< only chapter number without post-/prefix
+    CF_NUM_NOPREPST_TITLE,      ///< chapter number without post-/prefix and title
     CF_END
 };
 
diff --git a/sw/inc/crsrsh.hxx b/sw/inc/crsrsh.hxx
index b3efdfcb69ba..173e227a718a 100644
--- a/sw/inc/crsrsh.hxx
+++ b/sw/inc/crsrsh.hxx
@@ -111,8 +111,8 @@ struct SwContentAtPos
         SW_SMARTTAG         = 0x0800,
         SW_FORMCTRL         = 0x1000
 #ifdef DBG_UTIL
-        ,SW_CURR_ATTRS      = 0x4000        // only for debugging
-        ,SW_TABLEBOXVALUE   = 0x8000        // only for debugging
+        ,SW_CURR_ATTRS      = 0x4000        ///< only for debugging
+        ,SW_TABLEBOXVALUE   = 0x8000        ///< only for debugging
 #endif
     } eCntntAtPos;
 
@@ -166,40 +166,40 @@ public:
 
     /* for calling UpdateCrsr */
     enum CrsrFlag {
-        UPDOWN      = (1 << 0),     // keep Up/Down on columns
-        SCROLLWIN   = (1 << 1),     // scroll window
-        CHKRANGE    = (1 << 2),     // check overlapping PaMs
-        NOCALRECT   = (1 << 3),     // don't recalculate CharRect
-        READONLY    = (1 << 4)      // make visible in spite of Readonly
+        UPDOWN      = (1 << 0),     ///< keep Up/Down on columns
+        SCROLLWIN   = (1 << 1),     ///< scroll window
+        CHKRANGE    = (1 << 2),     ///< check overlapping PaMs
+        NOCALRECT   = (1 << 3),     ///< don't recalculate CharRect
+        READONLY    = (1 << 4)      ///< make visible in spite of Readonly
     };
 
 private:
 
-    SwRect  aCharRect;          // Char-SRectangle on which the cursor is located
-    Point   aCrsrHeight;        // height & offset from visible Cursor
-    Point   aOldRBPos;          // Right/Bottom of last VisArea
+    SwRect  aCharRect;          ///< Char-SRectangle on which the cursor is located
+    Point   aCrsrHeight;        ///< height & offset from visible Cursor
+    Point   aOldRBPos;          ///< Right/Bottom of last VisArea
                                 // (used in Invalidate by Cursor)
 
-    Link aFlyMacroLnk;          // Link will be called, if the Crsr is set
-                                // into a fly. A macro can be then becalled
-    Link aChgLnk;               // link will be called by every attribut/
-                                // format changes at cursor position.
-    Link aGrfArrivedLnk;        // Link calls to UI if a graphic is arrived
+    Link aFlyMacroLnk;          /*!< Link will be called, if the Crsr is set
+                                   into a fly. A macro can be then becalled */
+    Link aChgLnk;               /*!< link will be called by every attribut/
+                                   format changes at cursor position.*/
+    Link aGrfArrivedLnk;        ///< Link calls to UI if a graphic is arrived
 
-    SwShellCrsr* pCurCrsr;      // current cursor
-    SwShellCrsr* pCrsrStk;      // stack for the cursor
-    SwVisCrsr *pVisCrsr;        // the visible cursor
+    SwShellCrsr* pCurCrsr;      ///< current cursor
+    SwShellCrsr* pCrsrStk;      ///< stack for the cursor
+    SwVisCrsr *pVisCrsr;        ///< the visible cursor
 
-    IBlockCursor *pBlockCrsr;   // interface of cursor for block (=rectangular) selection
+    IBlockCursor *pBlockCrsr;   ///< interface of cursor for block (=rectangular) selection
 
-    SwShellTableCrsr* pTblCrsr; // table Crsr; only in tables when the
-                                // selection lays over 2 columns
+    SwShellTableCrsr* pTblCrsr; /*!< table Crsr; only in tables when the
+                                   selection lays over 2 columns */
 
-    SwNodeIndex* pBoxIdx;       // for recognizing of the changed
-    SwTableBox* pBoxPtr;        // table row
+    SwNodeIndex* pBoxIdx;       ///< for recognizing of the changed
+    SwTableBox* pBoxPtr;        ///< table row
 
-    long nUpDownX;              // try to move the cursor on up/down always
-                                // in the same column
+    long nUpDownX;              /*!< try to move the cursor on up/down always
+                                   in the same column */
     long nLeftFrmPos;
     sal_uLong nAktNode;             // save CursorPos at Start-Action
     xub_StrLen nAktCntnt;
@@ -213,24 +213,24 @@ private:
      * (via Find()) can be realised.
      */
     sal_uInt16 nCrsrMove;
-    sal_uInt16 nBasicActionCnt;     // Actions which are parenthesized by Basic
-    CrsrMoveState eMvState;     // Status for Crsr-Travelling - GetCrsrOfst
+    sal_uInt16 nBasicActionCnt;     ///< Actions which are parenthesized by Basic
+    CrsrMoveState eMvState;     ///< Status for Crsr-Travelling - GetCrsrOfst
 
     String sMarkedListId;
     int nMarkedListLevel;
 
-    sal_Bool bHasFocus : 1;         // Shell is "active" in a window
-    sal_Bool bSVCrsrVis : 1;        // SV-Cursor visible/invisible
-    sal_Bool bChgCallFlag : 1;      // attribute change inside Start- and EndAction
-    sal_Bool bVisPortChgd : 1;      // in VisPortChg-Call
+    sal_Bool bHasFocus : 1;         ///< Shell is "active" in a window
+    sal_Bool bSVCrsrVis : 1;        ///< SV-Cursor visible/invisible
+    sal_Bool bChgCallFlag : 1;      ///< attribute change inside Start- and EndAction
+    sal_Bool bVisPortChgd : 1;      ///< in VisPortChg-Call
                                 // (used in Invalidate by the Cursor)
 
-    sal_Bool bCallChgLnk : 1;       // flag for derived classes
+    sal_Bool bCallChgLnk : 1;       ///< flag for derived classes
                                 // TRUE -> call ChgLnk
                                 // access only via SwChgLinkFlag
-    sal_Bool bAllProtect : 1;       // Flag for areas
+    sal_Bool bAllProtect : 1;       ///< Flag for areas
                                 // TRUE -> everything protected / hidden
-    sal_Bool bInCMvVisportChgd : 1; // Flag for CrsrMoves
+    sal_Bool bInCMvVisportChgd : 1; ///< Flag for CrsrMoves
                                 // TRUE -> view was moved
     sal_Bool bGCAttr : 1;           // TRUE -> non expanded attributes exist.
     sal_Bool bIgnoreReadonly : 1;   // TRUE -> make the cursor visible on next
@@ -322,13 +322,13 @@ public:
     virtual SwPaM & GetCurrentShellCursor();
 
     SwPaM * CreateCrsr();
-    // delete the current cursor and make the following into the current
+    ///< delete the current cursor and make the following into the current
     sal_Bool DestroyCrsr();
-    // transform TableCursor to normal cursor, nullify Tablemode
+    ///< transform TableCursor to normal cursor, nullify Tablemode
     void TblCrsrToCursor();
-    // enter block mode, change normal cursor into block cursor
+    ///< enter block mode, change normal cursor into block cursor
     void CrsrToBlockCrsr();
-    // leave block mode, change block cursor into normal cursor
+    ///< leave block mode, change block cursor into normal cursor
     void BlockCrsrToCrsr();
 
     // SelAll() selects the document body content
@@ -659,14 +659,14 @@ public:
     SwShellTableCrsr* GetTableCrsr() { return pTblCrsr; }
     sal_uInt16 UpdateTblSelBoxes();
 
-    sal_Bool GotoFtnTxt();      // jump from content to footnote
-    sal_Bool GotoFtnAnchor();   // jump from footnote to anchor
+    sal_Bool GotoFtnTxt();      ///< jump from content to footnote
+    sal_Bool GotoFtnAnchor();   ///< jump from footnote to anchor
     sal_Bool GotoPrevFtnAnchor();
     sal_Bool GotoNextFtnAnchor();
 
-    sal_Bool GotoFlyAnchor();       // jump from the frame to the anchor
-    sal_Bool GotoHeaderTxt();       // jump from the content to the header
-    sal_Bool GotoFooterTxt();       // jump from the content to the footer
+    sal_Bool GotoFlyAnchor();       ///< jump from the frame to the anchor
+    sal_Bool GotoHeaderTxt();       ///< jump from the content to the header
+    sal_Bool GotoFooterTxt();       ///< jump from the content to the footer
     // jump to the header/footer of the given or current PageDesc
     sal_Bool SetCrsrInHdFt( sal_uInt16 nDescNo = USHRT_MAX,
                             sal_Bool bInHeader = sal_True );
diff --git a/sw/inc/crstate.hxx b/sw/inc/crstate.hxx
index e8a518f7af22..b49a5e7137f0 100644
--- a/sw/inc/crstate.hxx
+++ b/sw/inc/crstate.hxx
@@ -36,21 +36,21 @@
 
 enum SwFillMode
 {
-    FILL_TAB,       // default, fill with tabs
-    FILL_SPACE,     // fill with spaces and tabs
-    FILL_MARGIN,    // only align left, center, right
-    FILL_INDENT     // by left paragraph indention
+    FILL_TAB,       ///< default, fill with tabs
+    FILL_SPACE,     ///< fill with spaces and tabs
+    FILL_MARGIN,    ///< only align left, center, right
+    FILL_INDENT     ///< by left paragraph indention
 };
 
 struct SwFillCrsrPos
 {
-    SwRect aCrsr;           // position and size of the ShadowCursor
-    sal_uInt16 nParaCnt;        // number of paragraphs to insert
-    sal_uInt16 nTabCnt;         // number of tabs respectively size of indentation
-    sal_uInt16 nSpaceCnt;       // number of spaces to insert
-    sal_uInt16 nColumnCnt;      // number of necessary column breaks
-    sal_Int16  eOrient;      // paragraph alignment
-    SwFillMode eMode;       // desired fill-up rule
+    SwRect aCrsr;           ///< position and size of the ShadowCursor
+    sal_uInt16 nParaCnt;        ///< number of paragraphs to insert
+    sal_uInt16 nTabCnt;         ///< number of tabs respectively size of indentation
+    sal_uInt16 nSpaceCnt;       ///< number of spaces to insert
+    sal_uInt16 nColumnCnt;      ///< number of necessary column breaks
+    sal_Int16  eOrient;      ///< paragraph alignment
+    SwFillMode eMode;       ///< desired fill-up rule
     SwFillCrsrPos( SwFillMode eMd = FILL_TAB ) :
         nParaCnt( 0 ), nTabCnt( 0 ), nSpaceCnt( 0 ), nColumnCnt( 0 ),
         eOrient( com::sun::star::text::HoriOrientation::NONE ), eMode( eMd )
@@ -67,10 +67,10 @@ struct SwFillCrsrPos
 
 struct Sw2LinesPos
 {
-    SwRect aLine;           // Position and size of the line
-    SwRect aPortion;        // Position and size of the multi portion
-    SwRect aPortion2;       // needed for nested multi portions
-    sal_uInt8 nMultiType;        // Multiportion type
+    SwRect aLine;           ///< Position and size of the line
+    SwRect aPortion;        ///< Position and size of the multi portion
+    SwRect aPortion2;       ///< needed for nested multi portions
+    sal_uInt8 nMultiType;        ///< Multiportion type
 };
 
 /**
@@ -123,38 +123,38 @@ struct SwSpecialPos
 // CrsrTravelling-States (for GetCrsrOfst)
 enum CrsrMoveState
 {
-    MV_NONE,            // default
-    MV_UPDOWN,          // Crsr Up/Down
-    MV_RIGHTMARGIN,     // at right margin
-    MV_LEFTMARGIN,      // at left margin
-    MV_SETONLYTEXT,     // stay with the cursor inside text
-    MV_TBLSEL           // not in repeated headlines
+    MV_NONE,            ///< default
+    MV_UPDOWN,          ///< Crsr Up/Down
+    MV_RIGHTMARGIN,     ///< at right margin
+    MV_LEFTMARGIN,      ///< at left margin
+    MV_SETONLYTEXT,     ///< stay with the cursor inside text
+    MV_TBLSEL           ///< not in repeated headlines
 };
 
 // struct for later extensions
 struct SwCrsrMoveState
 {
-    SwFillCrsrPos   *pFill;     // for automatic filling with tabs etc
-    Sw2LinesPos     *p2Lines;   // for selections inside/around 2line portions
-    SwSpecialPos*   pSpecialPos; // for positions inside fields
-    Point aRealHeight;          // contains then the position/height of the cursor
+    SwFillCrsrPos   *pFill;     ///< for automatic filling with tabs etc
+    Sw2LinesPos     *p2Lines;   ///< for selections inside/around 2line portions
+    SwSpecialPos*   pSpecialPos; ///< for positions inside fields
+    Point aRealHeight;          ///< contains then the position/height of the cursor
     CrsrMoveState eState;
     sal_uInt8            nCursorBidiLevel;
     sal_Bool bStop;
-    sal_Bool bRealHeight;           // should the real height be calculated?
-    sal_Bool bFieldInfo;            // should be fields recognized?
-    sal_Bool bPosCorr;              // Point had to be corrected
-    sal_Bool bFtnNoInfo;            // recognized footnote numbering
-    sal_Bool bExactOnly;            // let GetCrsrOfst look for exact matches only,
+    sal_Bool bRealHeight;           ///< should the real height be calculated?
+    sal_Bool bFieldInfo;            ///< should be fields recognized?
+    sal_Bool bPosCorr;              ///< Point had to be corrected
+    sal_Bool bFtnNoInfo;            ///< recognized footnote numbering
+    sal_Bool bExactOnly;            ///< let GetCrsrOfst look for exact matches only,
                                     // i.e. never let it run into GetCntntPos
-    sal_Bool bFillRet;              // only used temporary in FillMode
-    sal_Bool bSetInReadOnly;        // ReadOnly areas may be entered
-    sal_Bool bRealWidth;            // Calculation of the width required
-    sal_Bool b2Lines;               // Check 2line portions and fill p2Lines
-    sal_Bool bNoScroll;             // No scrolling of undersized textframes
-    sal_Bool bPosMatchesBounds;     // GetCrsrOfst should not return the next
-                                    // position if screen position is inside second
-                                    // have of bound rect
+    sal_Bool bFillRet;              ///< only used temporary in FillMode
+    sal_Bool bSetInReadOnly;        ///< ReadOnly areas may be entered
+    sal_Bool bRealWidth;            ///< Calculation of the width required
+    sal_Bool b2Lines;               ///< Check 2line portions and fill p2Lines
+    sal_Bool bNoScroll;             ///< No scrolling of undersized textframes
+    sal_Bool bPosMatchesBounds;     /*!< GetCrsrOfst should not return the next
+                                       position if screen position is inside second
+                                       have of bound rect */
 
     sal_Bool bCntntCheck;           // #i43742# Cursor position over content?
 
diff --git a/sw/inc/cshtyp.hxx b/sw/inc/cshtyp.hxx
index a28f146123a0..32e80dbdeec3 100644
--- a/sw/inc/cshtyp.hxx
+++ b/sw/inc/cshtyp.hxx
@@ -88,11 +88,11 @@ extern SwPosRegion fnRegionStart, fnRegionEnd;
  */
 enum FindRanges
 {
-    FND_IN_BODY     = 0x00,     // Find "one" only in body text.
-    FND_IN_OTHER    = 0x02,     // Find "all" in Footer/Header/Fly...
-    FND_IN_SEL      = 0x04,     // Find in selections.
-    FND_IN_BODYONLY = 0x08,     // Find only in body - only in combination with FND_IN_SELALL !!!
-    FND_IN_SELALL   = 0x01      // All (only in non-body and selections).
+    FND_IN_BODY     = 0x00,     ///< Find "one" only in body text.
+    FND_IN_OTHER    = 0x02,     ///< Find "all" in Footer/Header/Fly...
+    FND_IN_SEL      = 0x04,     ///< Find in selections.
+    FND_IN_BODYONLY = 0x08,     ///< Find only in body - only in combination with FND_IN_SELALL !!!
+    FND_IN_SELALL   = 0x01      ///< All (only in non-body and selections).
 };