tdf#90834 Cleanup in-line version control history comments

Turn in-line version control history comments into
meaningful good comments: widorp.hxx txtfrm.cxx

Change-Id: I51e0d772afbe4b4e81ca3771bfbe4c0fd6d5b69d
Reviewed-on: https://gerrit.libreoffice.org/23431
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
Tested-by: Michael Meeks <michael.meeks@collabora.com>

2 files changed, 35 insertions, 47 deletions

diff --git a/sw/source/core/text/txtfrm.cxx b/sw/source/core/text/txtfrm.cxx
index dc33a520df47..14dab78600fd 100644
--- a/sw/source/core/text/txtfrm.cxx
+++ b/sw/source/core/text/txtfrm.cxx
@@ -355,7 +355,7 @@ SwTextFrame::SwTextFrame(SwTextNode * const pNode, SwFrame* pSib )
     , mnFlyAnchorOfst( 0 )
     , mnFlyAnchorOfstNoWrap( 0 )
     , mnFootnoteLine( 0 )
-    , mnHeightOfLastLine( 0 ) // OD 2004-03-17 #i11860#
+    , mnHeightOfLastLine( 0 )
     , mnAdditionalFirstLineOffset( 0 )
     , mnOffset( 0 )
     , mnCacheIndex( USHRT_MAX )
@@ -370,7 +370,7 @@ SwTextFrame::SwTextFrame(SwTextNode * const pNode, SwFrame* pSib )
     , mbFieldFollow( false )
     , mbHasAnimation( false )
     , mbIsSwapped( false )
-    , mbFollowFormatAllowed( true ) // OD 14.03.2003 #i11760#
+    , mbFollowFormatAllowed( true )
 {
     mnFrameType = FRM_TXT;
 }
@@ -466,7 +466,6 @@ void SwTextFrame::HideHidden()
 
     const sal_Int32 nEnd = COMPLETE_STRING;
     HideFootnotes( GetOfst(), nEnd );
-    // OD 2004-01-15 #110582#
     HideAndShowObjects();
 
     // format information is obsolete
@@ -500,7 +499,6 @@ void SwTextFrame::HideFootnotes( sal_Int32 nStart, sal_Int32 nEnd )
 }
 
 /**
- * #120729# - hotfix
  * as-character anchored graphics, which are used for a graphic bullet list.
  * As long as these graphic bullet list aren't imported, do not hide a
  * at-character anchored object, if
@@ -561,7 +559,6 @@ bool sw_HideObj( const SwTextFrame& _rFrame,
 
 /**
  * Hide/show objects
- * OD 2004-01-15 #110582#
  *
  * Method hides respectively shows objects, which are anchored at paragraph,
  * at/as a character of the paragraph, corresponding to the paragraph and
@@ -581,7 +578,6 @@ void SwTextFrame::HideAndShowObjects()
             {
                 SdrObject* pObj = (*GetDrawObjs())[i]->DrawObj();
                 SwContact* pContact = static_cast<SwContact*>(pObj->GetUserCall());
-                // #120729# - hotfix
                 // under certain conditions
                 const RndStdIds eAnchorType( pContact->GetAnchorId() );
                 const sal_Int32 nObjAnchorPos = pContact->GetContentAnchorIndex().GetIndex();
@@ -609,7 +605,7 @@ void SwTextFrame::HideAndShowObjects()
             {
                 SdrObject* pObj = (*GetDrawObjs())[i]->DrawObj();
                 SwContact* pContact = static_cast<SwContact*>(pObj->GetUserCall());
-                // #120729# - determine anchor type only once
+                // Determine anchor type only once
                 const RndStdIds eAnchorType( pContact->GetAnchorId() );
 
                 if (eAnchorType == FLY_AT_PARA)
@@ -623,8 +619,7 @@ void SwTextFrame::HideAndShowObjects()
                     sal_Int32 nHiddenEnd;
                     const sal_Int32 nObjAnchorPos = pContact->GetContentAnchorIndex().GetIndex();
                     SwScriptInfo::GetBoundsOfHiddenRange( rNode, nObjAnchorPos, nHiddenStart, nHiddenEnd );
-                    // #120729# - hotfix
-                    // under certain conditions
+                    // Under certain conditions
                     if ( nHiddenStart != COMPLETE_STRING && bShouldBeHidden &&
                          sw_HideObj( *this, eAnchorType, nObjAnchorPos, (*GetDrawObjs())[i] ) )
                         pContact->MoveObjToInvisibleLayer( pObj );
@@ -661,7 +656,7 @@ sal_Int32 SwTextFrame::FindBrk( const OUString &rText,
     sal_Int32 nFound = nStart;
     const sal_Int32 nEndLine = std::min( nEnd, rText.getLength() - 1 );
 
-    // skip all leading blanks (see bug #2235).
+    // Skip all leading blanks.
     while( nFound <= nEndLine && ' ' == rText[nFound] )
     {
          nFound++;
@@ -930,8 +925,7 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
             lcl_SetWrong( *this, 0, COMPLETE_STRING, false );
             SetDerivedR2L( false );
             CheckDirChange();
-            // OD 09.12.2002 #105576# - Force complete paint due to existing
-            // indents.
+            // Force complete paint due to existing indents.
             SetCompletePaint();
             InvalidateLineNum();
         }
@@ -1039,7 +1033,6 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
             if( isA11yRelevantAttribute( static_cast<const SwUpdateAttr*>(pNew)->getWhichAttr() ) &&
                     hasA11yRelevantAttribute( static_cast<const SwUpdateAttr*>(pNew)->getFormatAttr() ) )
             {
-                // #i104008#
                 SwViewShell* pViewSh = getRootFrame() ? getRootFrame()->GetCurrShell() : nullptr;
                 if ( pViewSh  )
                 {
@@ -1063,7 +1056,7 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
                         pSect->InvalidatePrt();
                 }
 
-                // OD 09.01.2004 #i11859# - correction:
+                // i#11859
                 //  (1) Also invalidate next frame on next page/column.
                 //  (2) Skip empty sections and hidden paragraphs
                 //  Thus, use method <InvalidateNextPrtArea()>
@@ -1151,7 +1144,7 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
                 InvalidateSize();
                 _InvalidatePrt();
 
-                // OD 09.01.2004 #i11859# - correction:
+                // i#11859
                 //  (1) Also invalidate next frame on next page/column.
                 //  (2) Skip empty sections and hidden paragraphs
                 //  Thus, use method <InvalidateNextPrtArea()>
@@ -1197,7 +1190,7 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
                         {
                             const SvxBrushItem &rBack =
                                 pFly->GetAttrSet()->GetBackground();
-                            // OD 20.08.2002 #99657# #GetTransChg#
+                            //     #GetTransChg#
                             //     following condition determines, if the fly frame
                             //     "inherites" the background color of text frame.
                             //     This is the case, if fly frame background
@@ -1241,8 +1234,7 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
             {
                 SetDerivedR2L( false );
                 CheckDirChange();
-                // OD 09.12.2002 #105576# - Force complete paint due to existing
-                // indents.
+                // Force complete paint due to existing indents.
                 SetCompletePaint();
             }
 
@@ -1295,7 +1287,6 @@ void SwTextFrame::Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew )
 
             if (isA11yRelevantAttribute(nWhich))
             {
-                // #i88069#
                 SwViewShell* pViewSh = getRootFrame() ? getRootFrame()->GetCurrShell() : nullptr;
                 if ( pViewSh  )
                 {
@@ -1500,7 +1491,7 @@ bool SwTextFrame::Prepare( const PrepareHint ePrep, const void* pVoid,
                 if ( pGrid && GetTextNode()->GetSwAttrSet().GetParaGrid().GetValue() )
                     break;
 
-                // #i28701# - consider anchored objects
+                // i#28701 - consider anchored objects
                 if ( GetDrawObjs() )
                     break;
 
@@ -1679,7 +1670,7 @@ bool SwTextFrame::Prepare( const PrepareHint ePrep, const void* pVoid,
                         for ( size_t i = 0; i < nCnt; ++i )
                         {
                             SwAnchoredObject* pAnchoredObj = (*GetDrawObjs())[i];
-                            // #i28701# - consider all
+                            // i#28701 - consider all
                             // to-character anchored objects
                             if ( pAnchoredObj->GetFrameFormat().GetAnchor().GetAnchorId()
                                     == FLY_AT_CHAR )
@@ -1942,7 +1933,7 @@ bool SwTextFrame::WouldFit( SwTwips &rMaxHeight, bool &bSplit, bool bTst )
     if( !IsEmpty() )
         GetFormatted();
 
-    // OD 2004-05-24 #i27801# - correction: 'short cut' for empty paragraph
+    // i#27801 - correction: 'short cut' for empty paragraph
     // can *not* be applied, if test format is in progress. The test format doesn't
     // adjust the frame and the printing area - see method <SwTextFrame::_Format(..)>,
     // which is called in <SwTextFrame::TestFormat(..)>
@@ -2054,7 +2045,6 @@ sal_uInt16 SwTextFrame::GetParHeight() const
     if( GetOfst() && !IsFollow() )
         nHeight *= 2;
 
-    // OD 2004-03-04 #115793#
     while ( pLineLayout && pLineLayout->GetNext() )
     {
         pLineLayout = pLineLayout->GetNext();
@@ -2094,7 +2084,7 @@ SwTextFrame* SwTextFrame::GetFormatted( bool bForceQuickFormat )
 
 SwTwips SwTextFrame::CalcFitToContent()
 {
-    // #i31490#
+    // i#31490
     // If we are currently locked, we better return with a
     // fairly reasonable value:
     if ( IsLocked() )
@@ -2115,11 +2105,10 @@ SwTwips SwTextFrame::CalcFitToContent()
     Frame().Width( nPageWidth );
     Prt().Width( nPageWidth );
 
-    // #i25422# objects anchored as character in RTL
+    // i#25422 objects anchored as character in RTL
     if ( IsRightToLeft() )
         Frame().Pos().X() += nOldFrameWidth - nPageWidth;
 
-    // #i31490#
     TextFrameLockGuard aLock( this );
 
     SwTextFormatInfo aInf( getRootFrame()->GetCurrShell()->GetOut(), this, false, true, true );
@@ -2127,14 +2116,14 @@ SwTwips SwTextFrame::CalcFitToContent()
     SwTextFormatter  aLine( this, &aInf );
     SwHookOut aHook( aInf );
 
-    // #i54031# - assure mininum of MINLAY twips.
+    // i#54031 - assure mininum of MINLAY twips.
     const SwTwips nMax = std::max( (SwTwips)MINLAY,
                               aLine._CalcFitToContent() + 1 );
 
     Frame().Width( nOldFrameWidth );
     Prt().Width( nOldPrtWidth );
 
-    // #i25422# objects anchored as character in RTL
+    // i#25422 objects anchored as character in RTL
     if ( IsRightToLeft() )
         Frame().Pos() = aOldFramePos;
 
@@ -2235,15 +2224,15 @@ void SwTextFrame::CalcAdditionalFirstLineOffset()
  */
 void SwTextFrame::_CalcHeightOfLastLine( const bool _bUseFont )
 {
-    // #i71281#
-    // invalidate printing area, if height of last line changes
+    // i#71281
+    // Invalidate printing area, if height of last line changes
     const SwTwips mnOldHeightOfLastLine( mnHeightOfLastLine );
 
     // determine output device
     SwViewShell* pVsh = getRootFrame()->GetCurrShell();
     OSL_ENSURE( pVsh, "<SwTextFrame::_GetHeightOfLastLineForPropLineSpacing()> - no SwViewShell" );
 
-    // #i78921# - make code robust, according to provided patch
+    // i#78921
     // There could be no <SwViewShell> instance in the case of loading a binary
     // StarOffice file format containing an embedded Writer document.
     if ( !pVsh )
@@ -2258,7 +2247,7 @@ void SwTextFrame::_CalcHeightOfLastLine( const bool _bUseFont )
         pOut = GetTextNode()->getIDocumentDeviceAccess().getReferenceDevice( true );
     }
     OSL_ENSURE( pOut, "<SwTextFrame::_GetHeightOfLastLineForPropLineSpacing()> - no OutputDevice" );
-    // #i78921# - make code robust, according to provided patch
+
     if ( !pOut )
     {
         return;
@@ -2300,7 +2289,7 @@ void SwTextFrame::_CalcHeightOfLastLine( const bool _bUseFont )
     else
     {
         // new determination of last line height - take actually height of last line
-        // #i89000#
+        // i#89000
         // assure same results, if paragraph is undersized
         if ( IsUndersized() )
         {
@@ -2328,18 +2317,18 @@ void SwTextFrame::_CalcHeightOfLastLine( const bool _bUseFont )
                 if ( pLineLayout )
                 {
                     SwTwips nAscent, nDescent, nDummy1, nDummy2;
-                    // #i47162# - suppress consideration of
+                    // i#47162 - suppress consideration of
                     // fly content portions and the line portion.
                     pLineLayout->MaxAscentDescent( nAscent, nDescent,
                                                    nDummy1, nDummy2,
                                                    nullptr, true );
-                    // #i71281#
+                    // i#71281
                     // Suppress wrong invalidation of printing area, if method is
                     // called recursive.
                     // Thus, member <mnHeightOfLastLine> is only set directly, if
                     // no recursive call is needed.
                     const SwTwips nNewHeightOfLastLine = nAscent + nDescent;
-                    // #i47162# - if last line only contains
+                    // i#47162 - if last line only contains
                     // fly content portions, <mnHeightOfLastLine> is zero.
                     // In this case determine height of last line by the font
                     if ( nNewHeightOfLastLine == 0 )
@@ -2354,7 +2343,7 @@ void SwTextFrame::_CalcHeightOfLastLine( const bool _bUseFont )
             }
         }
     }
-    // #i71281#
+    // i#71281
     // invalidate printing area, if height of last line changes
     if ( mnHeightOfLastLine != mnOldHeightOfLastLine )
     {
@@ -2382,13 +2371,13 @@ long SwTextFrame::GetLineSpace( const bool _bNoPropLineSpace ) const
     {
         case SVX_INTER_LINE_SPACE_PROP:
         {
-            // OD 07.01.2004 #i11859#
             if ( _bNoPropLineSpace )
             {
                 break;
             }
 
-            // OD 2004-03-17 #i11860# - use method GetHeightOfLastLine()
+            // i#11860 - adjust spacing implementation for object positioning
+            // - compatibility to MS Word
             nRet = GetHeightOfLastLine();
 
             long nTmp = nRet;
@@ -2532,7 +2521,7 @@ void SwTextFrame::RecalcAllLines()
                     (pPrv->IsInTab() || pPrv->IsInDocBody() != IsInDocBody()) )
                 pPrv = pPrv->GetPrevContentFrame();
 
-            // #i78254# Restart line numbering at page change
+            // i#78254 Restart line numbering at page change
             // First body content may be in table!
             if ( bRestart && pPrv && pPrv->FindPageFrame() != FindPageFrame() )
                 pPrv = nullptr;
@@ -2655,9 +2644,9 @@ void SwTextFrame::CalcBaseOfstForFly()
 
     SwRect aFlyRect( Frame().Pos() + Prt().Pos(), Prt().SSize() );
 
-    // Get first 'real' line and adjust position and height of line rectangle
-    // OD 08.09.2003 #110978#, #108749#, #110354# - correct behaviour,
-    // if no 'real' line exists (empty paragraph with and without a dummy portion)
+    // Get first 'real' line and adjust position and height of line rectangle.
+    // Correct behaviour if no 'real' line exists
+    // (empty paragraph with and without a dummy portion)
     {
         SwTwips nTop = (aFlyRect.*fnRect->fnGetTop)();
         const SwLineLayout* pLay = GetPara();
@@ -2677,7 +2666,7 @@ void SwTextFrame::CalcBaseOfstForFly()
     SwTextFly aTextFly( this );
     aTextFly.SetIgnoreCurrentFrame( true );
     aTextFly.SetIgnoreContour( true );
-    // #118809# - ignore objects in page header|footer for
+    // ignore objects in page header|footer for
     // text frames not in page header|footer
     aTextFly.SetIgnoreObjsInHeaderFooter( true );
     SwTwips nRet1 = lcl_CalcFlyBasePos( *this, aFlyRect, aTextFly );
diff --git a/sw/source/core/text/widorp.hxx b/sw/source/core/text/widorp.hxx
index 8b214a3f5e4f..0e655985a6d2 100644
--- a/sw/source/core/text/widorp.hxx
+++ b/sw/source/core/text/widorp.hxx
@@ -46,7 +46,6 @@ public:
     // to call TruncLines() without IsBreakNow() returning another value.
     // We assume that rLine is pointing to the last non-fitting line.
 
-    // OD 2004-02-27 #106629# - no longer inline
     void SetRstHeight( const SwTextMargin &rLine );
 };
 
@@ -67,8 +66,8 @@ public:
 
     bool FindBreak( SwTextFrame *pFrame, SwTextMargin &rLine, bool bHasToFit );
     bool WouldFit( SwTextMargin &rLine, SwTwips &rMaxHeight, bool bTest );
-    // OD 2004-02-25 #i16128# - rename method to avoid confusion with base class
-    // method <SwTextFrameBreak::IsBreakNow>, which isn't virtual.
+    // i#16128 - This method is named this way to avoid confusion with
+    // base class method <SwTextFrameBreak::IsBreakNow>, which isn't virtual.
     bool IsBreakNowWidAndOrp( SwTextMargin &rLine )
     {
         bool isOnFirstLine = (rLine.GetLineNr() == 1 && !rLine.GetPrev());