fix existing comments

Change-Id: I06dca63053dae5d3dceb49bf67adb0c100b56e8b

6 files changed, 71 insertions, 88 deletions

diff --git a/sw/source/core/txtnode/swfont.cxx b/sw/source/core/txtnode/swfont.cxx
index e2f3bae339f4..6f08a455fc08 100644
--- a/sw/source/core/txtnode/swfont.cxx
+++ b/sw/source/core/txtnode/swfont.cxx
@@ -1532,7 +1532,7 @@ SwUnderlineFont::~SwUnderlineFont()
      delete pFnt;
 }
 
-//Helper for filters to find true lineheight of a font
+/// Helper for filters to find true lineheight of a font
 long AttrSetToLineHeight( const IDocumentSettingAccess& rIDocumentSettingAccess,
                           const SwAttrSet &rSet,
                           const OutputDevice &rOut, sal_Int16 nScript)
diff --git a/sw/source/core/txtnode/txtedt.cxx b/sw/source/core/txtnode/txtedt.cxx
index 0f5dd17cccb4..dcb2b727a668 100644
--- a/sw/source/core/txtnode/txtedt.cxx
+++ b/sw/source/core/txtnode/txtedt.cxx
@@ -137,7 +137,7 @@ lcl_MaskRedlines( const SwTxtNode& rNode, OUStringBuffer& rText,
     return nNumOfMaskedRedlines;
 }
 
-/*
+/**
  * Used for spell checking. Deleted redlines and hidden characters are masked
  */
 static sal_uInt16
@@ -172,7 +172,7 @@ lcl_MaskRedlinesAndHiddenText( const SwTxtNode& rNode, OUStringBuffer& rText,
     return nRedlinesMasked + nHiddenCharsMasked;
 }
 
-/*
+/**
  * Used for spell checking. Calculates a rectangle for repaint.
  */
 static SwRect lcl_CalculateRepaintRect( SwTxtFrm& rTxtFrm, xub_StrLen nChgStart, xub_StrLen nChgEnd )
@@ -293,10 +293,9 @@ static SwRect lcl_CalculateRepaintRect( SwTxtFrm& rTxtFrm, xub_StrLen nChgStart,
     return aRect;
 }
 
-/*
+/**
  * Used for automatic styles. Used during RstAttr.
  */
-
 static bool lcl_HaveCommonAttributes( IStyleAccess& rStyleAccess,
                                       const SfxItemSet* pSet1,
                                       sal_uInt16 nWhichId,
@@ -347,13 +346,9 @@ static bool lcl_HaveCommonAttributes( IStyleAccess& rStyleAccess,
     return bRet;
 }
 
-/*
- * void SwTxtNode::RstAttr(const SwIndex &rIdx, sal_uInt16 nLen)
+/** Delete all attributes
  *
- * Deletes all attributes, starting at position rIdx, for length nLen.
- */
-
-/* 5 cases:
+ * 5 cases:
  * 1) The attribute is completely in the deletion range:
  *    -> delete it
  * 2) The end of the attribute is in the deletion range:
@@ -366,6 +361,12 @@ static bool lcl_HaveCommonAttributes( IStyleAccess& rStyleAccess,
  *    -> insert new attribute from end of deletion range to old end
  * 5) The attribute is outside the deletion range
  *    -> nothing to do
+ *
+ * @param rIdx starting position
+ * @param nLen length of the deletion
+ * @param nthat ???
+ * @param pSet ???
+ * @param bInclRefToxMark ???
  */
 void SwTxtNode::RstAttr(const SwIndex &rIdx, xub_StrLen nLen, sal_uInt16 nWhich,
                         const SfxItemSet* pSet, sal_Bool bInclRefToxMark )
@@ -388,7 +389,7 @@ void SwTxtNode::RstAttr(const SwIndex &rIdx, xub_StrLen nLen, sal_uInt16 nWhich,
 
     const bool bNoLen = !nMin;
 
-    // We have to remember the "new" attributes, which have
+    // We have to remember the "new" attributes, that have
     // been introduced by splitting surrounding attributes (case 4).
     // They may not be forgotten inside the "Forget" function
     //std::vector< const SwTxtAttr* > aNewAttributes;
@@ -1097,7 +1098,7 @@ sal_uInt16 SwTxtNode::Convert( SwConversionArgs &rArgs )
         SwLanguageIterator aIter( *this, nBegin );
 
         // Implicit changes require setting new attributes, which in turn destroys
-        // the attribute sequence on which aIter iterates. We store the necessary
+        // the attribute sequence on that aIter iterates. We store the necessary
         // coordinates and apply those changes after iterating through the text.
         typedef std::pair<xub_StrLen, xub_StrLen> ImplicitChangesRange;
         std::vector<ImplicitChangesRange> aImplicitChanges;
@@ -1111,7 +1112,7 @@ sal_uInt16 SwTxtNode::Convert( SwConversionArgs &rArgs )
 
             xub_StrLen nChPos = aIter.GetChgPos();
             // the position at the end of the paragraph returns -1
-            // which becomes 65535 when converted to xub_StrLen,
+            // that becomes 65535 when converted to xub_StrLen,
             // and thus must be cut to the end of the actual string.
             if (nChPos == (xub_StrLen) -1)
             {
@@ -1368,14 +1369,12 @@ SwRect SwTxtFrm::_AutoSpell( const SwCntntNode* pActNode, const SwViewOption& rV
 
     Function scans words in current text and checks them in the
     smarttag libraries. If the check returns true to bounds of the
-    recognized words are stored into a list which is used later for drawing
+    recognized words are stored into a list that is used later for drawing
     the underline.
 
-    @param SwCntntNode* pActNode
-
-    @param xub_StrLen nActPos
-
-    @return SwRect: Repaint area
+    @param pActNode ???
+    @param nActPos ???
+    @return SwRect Repaint area
 */
 SwRect SwTxtFrm::SmartTagScan( SwCntntNode* /*pActNode*/, xub_StrLen /*nActPos*/ )
 {
@@ -1619,12 +1618,12 @@ void SwTxtNode::TransliterateText(
         // proper thing to do.
         const sal_Int16 nWordType = WordType::ANYWORD_IGNOREWHITESPACES;
 
-        //! In order to have less trouble with changing text size, e.g. because
-        //! of ligatures or German small sz being resolved, we need to process
-        //! the text replacements from end to start.
-        //! This way the offsets for the yet to be changed words will be
-        //! left unchanged by the already replaced text.
-        //! For this we temporarily save the changes to be done in this vector
+        // In order to have less trouble with changing text size, e.g. because
+        // of ligatures or German small sz being resolved, we need to process
+        // the text replacements from end to start.
+        // This way the offsets for the yet to be changed words will be
+        // left unchanged by the already replaced text.
+        // For this we temporarily save the changes to be done in this vector
         std::vector< swTransliterationChgData >   aChanges;
         swTransliterationChgData                  aChgData;
 
diff --git a/sw/source/filter/html/parcss1.hxx b/sw/source/filter/html/parcss1.hxx
index 8497051773e7..36a78608bfc3 100644
--- a/sw/source/filter/html/parcss1.hxx
+++ b/sw/source/filter/html/parcss1.hxx
@@ -49,9 +49,7 @@ enum CSS1Token
     CSS1_HASH,
 
     CSS1_IMPORT_SYM,
-// Feature: PrintExt
-    CSS1_PAGE_SYM,
-// /Feature: PrintExt
+    CSS1_PAGE_SYM, // Feature: PrintExt
 
     CSS1_IMPORTANT_SYM,
 
@@ -74,10 +72,7 @@ enum CSS1SelectorType
     CSS1_SELTYPE_CLASS,
     CSS1_SELTYPE_ID,
     CSS1_SELTYPE_PSEUDO,
-// Feature: PrintExt
-    CSS1_SELTYPE_PAGE
-// /Feature: PrintExt
-
+    CSS1_SELTYPE_PAGE // Feature: PrintExt
 };
 
 // Die folegende Klasse beschreibt einen Simple-Selector, also
diff --git a/sw/source/filter/ww8/ww8scan.hxx b/sw/source/filter/ww8/ww8scan.hxx
index 301dfa8b2642..3d690792a361 100644
--- a/sw/source/filter/ww8/ww8scan.hxx
+++ b/sw/source/filter/ww8/ww8scan.hxx
@@ -1074,16 +1074,16 @@ public:
     sal_uInt16 csw;             // Count of fields in the array of "shorts"
 
     // Marke: "rgsw" Beginning of the array of shorts
-    sal_uInt16 wMagicCreated;                   // unique number Identifying the File's creator
-                                                                // 0x6A62 is the creator ID for Word and is reserved.
-                                                                // Other creators should choose a different value.
-    sal_uInt16 wMagicRevised;                   // identifies the File's last modifier
-    sal_uInt16 wMagicCreatedPrivate;  // private data
-    sal_uInt16 wMagicRevisedPrivate;    // private data
+    sal_uInt16 wMagicCreated;   // unique number Identifying the File's creator
+                                // 0x6A62 is the creator ID for Word and is reserved.
+                                // Other creators should choose a different value.
+    sal_uInt16 wMagicRevised;   // identifies the File's last modifier
+    sal_uInt16 wMagicCreatedPrivate; // private data
+    sal_uInt16 wMagicRevisedPrivate; // private data
 
-    sal_Int16  lidFE;                                   // Language id if document was written by Far East version
-                                                                // of Word (i.e. FIB.fFarEast is on)
-    sal_uInt16 clw;                                     // Number of fields in the array of longs
+    sal_Int16  lidFE; // Language id if document was written by Far East version
+                      // of Word (i.e. FIB.fFarEast is on)
+    sal_uInt16 clw; // Number of fields in the array of longs
 
     // Ende des Einschubs fuer WW8 *******************************************
 
@@ -1101,37 +1101,27 @@ public:
     WW8_CP ccpHdrTxbx;      // 0x50 length of header textbox subdocument text stream
 
     // Einschub fuer WW8 *****************************************************
-    sal_Int32  pnFbpChpFirst;   // when there was insufficient memory for Word to expand
-                                                // the PLCFbte at save time, the PLCFbte is written
-                                                // to the file in a linked list of 512-byte pieces
-                                                // starting with this pn.
-    /*
-    // folgende Felder existieren zwar so in der Datei,
-    // wir benutzen jedoch unten deklarierte General-Variablen
-    // fuer Ver67 und Ver8 gemeinsam.
-    sal_Int32  pnChpFirst;      // the page number of the lowest numbered page in the
-                                                        // document that records CHPX FKP information
-    sal_Int32  cpnBteChp;           // count of CHPX FKPs recorded in file. In non-complex
-                                                        // files if the number of entries in the PLCFbteChpx
-                                                        // is less than this, the PLCFbteChpx is incomplete.
-    */
-    sal_Int32  pnFbpPapFirst;   // when there was insufficient memory for Word to expand
-                                                // the PLCFbte at save time, the PLCFbte is written to
-                                                // the file in a linked list of 512-byte pieces
-                                                // starting with this pn
-
-    sal_Int32  pnFbpLvcFirst;   // when there was insufficient memory for Word to expand
-                                                // the PLCFbte at save time, the PLCFbte is written to
-                                                // the file in a linked list of 512-byte pieces
-                                                // starting with this pn
-    sal_Int32  pnLvcFirst;          // the page number of the lowest numbered page in the
-                                                // document that records LVC FKP information
-    sal_Int32  cpnBteLvc;           // count of LVC FKPs recorded in file. In non-complex
-                                                // files if the number of entries in the PLCFbtePapx is
-                                                // less than this, the PLCFbtePapx is incomplete.
+    sal_Int32  pnFbpChpFirst; // when there was insufficient memory for Word to expand
+                              // the PLCFbte at save time, the PLCFbte is written
+                              // to the file in a linked list of 512-byte pieces
+                              // starting with this pn.
+    sal_Int32  pnFbpPapFirst; // when there was insufficient memory for Word to expand
+                              // the PLCFbte at save time, the PLCFbte is written to
+                              // the file in a linked list of 512-byte pieces
+                              // starting with this pn
+
+    sal_Int32  pnFbpLvcFirst; // when there was insufficient memory for Word to expand
+                              // the PLCFbte at save time, the PLCFbte is written to
+                              // the file in a linked list of 512-byte pieces
+                              // starting with this pn
+    sal_Int32  pnLvcFirst; // the page number of the lowest numbered page in the
+                           // document that records LVC FKP information
+    sal_Int32  cpnBteLvc;  // count of LVC FKPs recorded in file. In non-complex
+                           // files if the number of entries in the PLCFbtePapx is
+                           // less than this, the PLCFbtePapx is incomplete.
     sal_Int32  fcIslandFirst;   // ?
     sal_Int32  fcIslandLim;     // ?
-    sal_uInt16 cfclcb;              // Number of fields in the array of FC/LCB pairs.
+    sal_uInt16 cfclcb; // Number of fields in the array of FC/LCB pairs.
 
     // Ende des Einschubs fuer WW8 *******************************************
 
@@ -1538,28 +1528,28 @@ public:
     sal_uInt16 copts_fSwapBordersFacingPgs : 1; //    when 1, swap left and right pages on odd facing pages
     sal_uInt16 copts_fExpShRtn : 1;             //    when 1, expand character spaces on the line ending SHIFT+RETURN  // #i56856#
 
-    sal_Int16  dxaTab;              // 720 twips    default tab width
+    sal_Int16  dxaTab;              //      720 twips - default tab width
     sal_uInt16 wSpare;              //
-    sal_uInt16 dxaHotZ;         //      width of hyphenation hot zone measured in twips
+    sal_uInt16 dxaHotZ;             //      width of hyphenation hot zone measured in twips
     sal_uInt16 cConsecHypLim;       //      number of lines allowed to have consecutive hyphens
-    sal_uInt16 wSpare2;         //      reserved
-    sal_Int32   dttmCreated;        // DTTM date and time document was created
-    sal_Int32   dttmRevised;        // DTTM date and time document was last revised
-    sal_Int32   dttmLastPrint;      // DTTM date and time document was last printed
-    sal_Int16   nRevision;          //      number of times document has been revised since its creation
-    sal_Int32   tmEdited;           //      time document was last edited
-    sal_Int32   cWords;             //      count of words tallied by last Word Count execution
-    sal_Int32   cCh;                //      count of characters tallied by last Word Count execution
-    sal_Int16   cPg;                //      count of pages tallied by last Word Count execution
-    sal_Int32   cParas;             //      count of paragraphs tallied by last Word Count execution
+    sal_uInt16 wSpare2;             //      reserved
+    sal_Int32  dttmCreated;         //      DTTM date and time document was created
+    sal_Int32  dttmRevised;         //      DTTM date and time document was last revised
+    sal_Int32  dttmLastPrint;       //      DTTM date and time document was last printed
+    sal_Int16  nRevision;           //      number of times document has been revised since its creation
+    sal_Int32  tmEdited;            //      time document was last edited
+    sal_Int32  cWords;              //      count of words tallied by last Word Count execution
+    sal_Int32  cCh;                 //      count of characters tallied by last Word Count execution
+    sal_Int16  cPg;                 //      count of pages tallied by last Word Count execution
+    sal_Int32  cParas;              //      count of paragraphs tallied by last Word Count execution
     sal_uInt16 rncEdn : 2;          //      restart endnote number code: 0 don't restart endnote numbering, 1 section, 2 page
     sal_uInt16 nEdn : 14;           //      beginning endnote number
-    sal_uInt16 epc : 2;         //      endnote position code: 0 at end of section, 3 at end of document
+    sal_uInt16 epc : 2;             //      endnote position code: 0 at end of section, 3 at end of document
 
     sal_uInt16 fPrintFormData : 1;  //      only print data inside of form fields
     sal_uInt16 fSaveFormData : 1;   //      only save document data that is inside of a form field.
     sal_uInt16 fShadeFormData : 1;  //      shade form fields
-    sal_uInt16 : 2;             //      reserved
+    sal_uInt16 : 2;                 //      reserved
     sal_uInt16 fWCFtnEdn : 1;       //      when 1, include footnotes and endnotes in word count
     sal_Int32   cLines;             //      count of lines tallied by last Word Count operation
     sal_Int32   cWordsFtnEnd;       //      count of words in footnotes and endnotes tallied by last Word Count operation
diff --git a/sw/source/ui/shells/grfsh.cxx b/sw/source/ui/shells/grfsh.cxx
index a24bae455889..9e2c7649c0aa 100644
--- a/sw/source/ui/shells/grfsh.cxx
+++ b/sw/source/ui/shells/grfsh.cxx
@@ -295,12 +295,12 @@ void SwGrfShell::Execute(SfxRequest &rReq)
             aSet.Put(SfxFrameItem( SID_DOCFRAME, &GetView().GetViewFrame()->GetTopFrame()));
 
             SwAbstractDialogFactory* pFact = SwAbstractDialogFactory::Create();
-            OSL_ENSURE(pFact, "Dialogdiet fail!");
+            OSL_ENSURE(pFact, "no dialog factory!");
             SfxAbstractTabDialog* pDlg = pFact->CreateFrmTabDialog("PictureDialog",
                                                     GetView().GetViewFrame(),
                                                     GetView().GetWindow(),
                                                     aSet, false);
-            OSL_ENSURE(pDlg, "Dialogdiet fail!");
+            OSL_ENSURE(pDlg, "no tab dialog!");
 
             if (nSlot == FN_DRAW_WRAP_DLG)
                 pDlg->SetCurPageId("wrap");
diff --git a/sw/source/ui/uiview/swcli.cxx b/sw/source/ui/uiview/swcli.cxx
index 817c660d7be0..3ee05fef848a 100644
--- a/sw/source/ui/uiview/swcli.cxx
+++ b/sw/source/ui/uiview/swcli.cxx
@@ -123,7 +123,6 @@ void SwOleClient::ViewChanged()
     }
     catch (const uno::Exception&)
     {
-        // this is an error
         OSL_FAIL( "Something goes wrong on requesting object size!\n" );
     }