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>

1 files changed, 38 insertions, 38 deletions

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?