[PATCH] work on existing comments in sw/source/core/edit
Philipp Riemer (via Code Review)
gerrit at gerrit.libreoffice.org
Sat Jun 8 15:51:26 PDT 2013
Hi,
I have submitted a patch for review:
https://gerrit.libreoffice.org/4204
To pull it, you can do:
git pull ssh://gerrit.libreoffice.org:29418/core refs/changes/04/4204/1
work on existing comments in sw/source/core/edit
Change-Id: I32b249971ac6ac540d816c38e00321befb181901
---
M sw/source/core/edit/acorrect.cxx
M sw/source/core/edit/autofmt.cxx
M sw/source/core/edit/edatmisc.cxx
M sw/source/core/edit/edattr.cxx
M sw/source/core/edit/edfmt.cxx
M sw/source/core/edit/editsh.cxx
M sw/source/core/edit/edlingu.cxx
M sw/source/core/edit/ednumber.cxx
M sw/source/core/edit/edredln.cxx
M sw/source/core/edit/edsect.cxx
M sw/source/core/edit/edtab.cxx
M sw/source/core/layout/wsfrm.cxx
12 files changed, 201 insertions(+), 271 deletions(-)
diff --git a/sw/source/core/edit/acorrect.cxx b/sw/source/core/edit/acorrect.cxx
index afcf9ee..12f4efc 100644
--- a/sw/source/core/edit/acorrect.cxx
+++ b/sw/source/core/edit/acorrect.cxx
@@ -271,13 +271,14 @@
return sal_True;
}
- // Return the text of a previous paragraph
- // This must not be empty!
- // Does this not exists or there are only blankness, then return 0
- // The Flag specifies:
- // sal_True: that, before the normal insert position
- //sal_False: that, in which the corrected word was inserted.
- // (Doesn't need to be the same paragraph!!!!)
+/** Return the text of a previous paragraph
+ *
+ * This must not be empty!
+ *
+ * @param bAtNormalPos If <true> before the normal insert position; if <false> in which the
+ * corrected word was inserted. (Doesn't need to be the same paragraph!)
+ * @return text or 0, if previous paragraph does not exists or there are only blankness
+ */
const String* SwAutoCorrDoc::GetPrevPara( sal_Bool bAtNormalPos )
{
const String* pStr = 0;
diff --git a/sw/source/core/edit/autofmt.cxx b/sw/source/core/edit/autofmt.cxx
index eb6e8cf..2ffc015 100644
--- a/sw/source/core/edit/autofmt.cxx
+++ b/sw/source/core/edit/autofmt.cxx
@@ -47,7 +47,7 @@
#include <pam.hxx>
#include <edimp.hxx>
#include <fesh.hxx>
-#include <swundo.hxx> // for the UndoId's
+#include <swundo.hxx> // for the UndoIds
#include <poolfmt.hxx>
#include <ndtxt.hxx>
#include <txtfrm.hxx>
@@ -99,7 +99,7 @@
SwTxtNode* pAktTxtNd; // the current TextNode
SwTxtFrm* pAktTxtFrm; // frame of the current TextNode
CharClass* pCharClass; // Character classification
- sal_uLong nEndNdIdx; // for the percentage-display
+ sal_uLong nEndNdIdx; // for the percentage-display
LanguageType eCharClassLang;
sal_uInt16 nLastHeadLvl, nLastCalcHeadLvl;
@@ -182,7 +182,7 @@
sal_uInt16 GetDigitLevel( const SwTxtNode& rTxtNd, xub_StrLen& rPos,
String* pPreFix = 0, String* pPostFix = 0,
String* pNumTypes = 0 ) const;
- // get the FORMATED TextFrame
+ /// get the FORMATED TextFrame
SwTxtFrm* GetFrm( const SwTxtNode& rTxtNd ) const;
void BuildIndent();
@@ -196,15 +196,15 @@
bool HasBreakAttr( const SwTxtNode& ) const;
void DeleteSel( SwPaM& rPam );
bool DeleteAktNxtPara( const String& rNxtPara );
- // delete in the node start and/or end
+ /// delete in the node start and/or end
void DeleteAktPara( bool bStart = true, bool nEnd = true );
void DelEmptyLine( bool bTstNextPara = true );
- // when using multiline paragraphs delete the "left" and/or
- // "right" margins
+ /// when using multiline paragraphs delete the "left" and/or
+ /// "right" margins
void DelMoreLinesBlanks( bool bWithLineBreaks = false );
- // delete the previous paragraph
+ /// delete the previous paragraph
void DelPrevPara();
- // execute AutoCorrect on current TextNode
+ /// execute AutoCorrect on current TextNode
void AutoCorrect( xub_StrLen nSttPos = 0 );
bool CanJoin( const SwTxtNode* pTxtNd ) const
@@ -218,7 +218,7 @@
!HasBreakAttr( *pTxtNd );
}
- // is a dot at the end ??
+ /// is a dot at the end ??
bool IsSentenceAtEnd( const SwTxtNode& rTxtNd ) const;
bool DoUnderline();
@@ -281,7 +281,7 @@
case STR_AUTOFMTREDL_SET_NUMBULET:
case STR_AUTOFMTREDL_DEL_MORELINES:
- // AutoCorrect-Actions
+ // AutoCorrect actions
case STR_AUTOFMTREDL_USE_REPLACE:
case STR_AUTOFMTREDL_CPTL_STT_WORD:
case STR_AUTOFMTREDL_CPTL_STT_SENT:
@@ -308,7 +308,7 @@
{
SwNode* pNewNd = 0;
do {
- //has to be checed twice before and after incrementation
+ // has to be checked twice before and after incrementation
if( aNdIdx.GetIndex() >= aEndNdIdx.GetIndex() )
{
bEnde = true;
@@ -772,7 +772,7 @@
sal_uInt16 nStart = 0;
sal_uInt8 nDigitLvl = 0, nDigitCnt = 0;
- //count number of parenthesis to assure a sensible order is found
+ // count number of parenthesis to assure a sensible order is found
sal_uInt16 nOpeningParentheses = 0;
sal_uInt16 nClosingParentheses = 0;
@@ -823,7 +823,7 @@
// Roman numbers are "mdclxvi". Since we want to start numbering with c or d more often,
// convert first to characters and later to roman numbers if needed.
#ifdef WITH_ALPHANUM_AS_NUMFMT
- //detection of 'c' and 'd' a ROMAN numbering should not be done here
+ // detection of 'c' and 'd' a ROMAN numbering should not be done here
if( 256 > cLow &&( (eScan & (LOWER_ROMAN|UPPER_ROMAN))
? strchr( "mdclxvi", cLow )
: strchr( "mlxvi", cLow ) ))
diff --git a/sw/source/core/edit/edatmisc.cxx b/sw/source/core/edit/edatmisc.cxx
index f51dbb3..616a01e 100644
--- a/sw/source/core/edit/edatmisc.cxx
+++ b/sw/source/core/edit/edatmisc.cxx
@@ -28,7 +28,7 @@
-/**
+/*
* hard formatting (Attribute)
*/
@@ -87,9 +87,7 @@
FOREACHPAM_END()
}
-// Set the attribute as new default attribute in the document.
-
-
+/// Set the attribute as new default attribute in the document.
void SwEditShell::SetDefault( const SfxPoolItem& rFmtHint )
{
// 7502: Action-Parenthesis
@@ -98,8 +96,7 @@
EndAllAction();
}
-// Inquire the Default Attribut in this document.
-
+/// request the default attribute in this document.
const SfxPoolItem& SwEditShell::GetDefault( sal_uInt16 nFmtHint ) const
{
return GetDoc()->GetDefault( nFmtHint );
diff --git a/sw/source/core/edit/edattr.cxx b/sw/source/core/edit/edattr.cxx
index 740c9c4..e0dd05e 100644
--- a/sw/source/core/edit/edattr.cxx
+++ b/sw/source/core/edit/edattr.cxx
@@ -47,7 +47,7 @@
#include <algorithm>
-/**
+/*
* hard Formatting (Attributes)
*/
@@ -327,7 +327,7 @@
}
- // Give a List of all footnotes and their beginning texts
+/// Give a List of all footnotes and their beginning texts
sal_uInt16 SwEditShell::GetSeqFtnList( SwSeqFldList& rList, bool bEndNotes )
{
rList.Clear();
@@ -368,7 +368,7 @@
}
-// Adjust left margin via object bar (similar to adjustment of numerations).
+/// Adjust left margin via object bar (similar to adjustment of numerations).
bool SwEditShell::IsMoveLeftMargin( bool bRight, bool bModulus ) const
{
bool bRet = true;
@@ -525,7 +525,7 @@
}
-// returns the scripttpye of the selection
+/// returns the script type of the selection
sal_uInt16 SwEditShell::GetScriptType() const
{
sal_uInt16 nRet = 0;
diff --git a/sw/source/core/edit/edfmt.cxx b/sw/source/core/edit/edfmt.cxx
index 3e2e035..f85243c 100644
--- a/sw/source/core/edit/edfmt.cxx
+++ b/sw/source/core/edit/edfmt.cxx
@@ -150,7 +150,7 @@
}
- // return the demanded automatic format - base-class !
+/// return the requested automatic format - base-class !
SwFmt* SwEditShell::GetFmtFromPool( sal_uInt16 nId )
{
return GetDoc()->GetFmtFromPool( nId );
diff --git a/sw/source/core/edit/editsh.cxx b/sw/source/core/edit/editsh.cxx
index a335ba5..cad1fd9 100644
--- a/sw/source/core/edit/editsh.cxx
+++ b/sw/source/core/edit/editsh.cxx
@@ -491,7 +491,7 @@
String SwEditShell::GetDropTxt( const sal_uInt16 nChars ) const
{
- /**
+ /*
* pb: made changes for #i74939#
*
* always return a string even though there is a selection
@@ -806,14 +806,14 @@
{
StartAllAction();
Push();
- //iterate over all text contents - body, frames, header, footer, footnote text
+ // iterate over all text contents - body, frames, header, footer, footnote text
SwPaM* pCrsr = GetCrsr();
for(sal_uInt16 i = 0; i < 2; i++)
{
if(!i)
- MakeFindRange(DOCPOS_START, DOCPOS_END, pCrsr); //body content
+ MakeFindRange(DOCPOS_START, DOCPOS_END, pCrsr); // body content
else
- MakeFindRange(DOCPOS_OTHERSTART, DOCPOS_OTHEREND, pCrsr); //extra content
+ MakeFindRange(DOCPOS_OTHERSTART, DOCPOS_OTHEREND, pCrsr); // extra content
SwPosition* pSttPos = pCrsr->Start(), *pEndPos = pCrsr->End();
sal_uLong nCurrNd = pSttPos->nNode.GetIndex();
sal_uLong nEndNd = pEndPos->nNode.GetIndex();
@@ -821,7 +821,7 @@
{
SwCntntFrm* pCntFrm;
bool bGoOn = true;
- //iterate over all paragraphs
+ // iterate over all paragraphs
while( bGoOn )
{
SwNode* pNd = GetDoc()->GetNodes()[ nCurrNd ];
@@ -830,13 +830,13 @@
case ND_TEXTNODE:
if( 0 != ( pCntFrm = ((SwTxtNode*)pNd)->getLayoutFrm( GetLayout() )) )
{
- //jump over hidden frames - ignore protection!
+ // skip hidden frames - ignore protection!
if( !((SwTxtFrm*)pCntFrm)->IsHiddenNow() )
{
- //if the node is numbered and the starting value of the numbering equals the
- //start value of the numbering rule then set this value as hard starting value
+ // if the node is numbered and the starting value of the numbering equals the
+ // start value of the numbering rule then set this value as hard starting value
- //get the node num
+ // get the node num
// OD 2005-11-09
SwTxtNode* pTxtNd( static_cast<SwTxtNode*>(pNd) );
SwNumRule* pNumRule( pTxtNd->GetNumRule() );
@@ -848,7 +848,7 @@
pTxtNd->GetNum()->GetNumber() ==
pNumRule->Get( static_cast<sal_uInt16>(pTxtNd->GetActualListLevel()) ).GetStart() )
{
- //now set a the start value as attribute
+ // now set a the start value as attribute
SwPosition aCurrentNode(*pNd);
GetDoc()->SetNumRuleStart( aCurrentNode, sal_True );
}
@@ -856,7 +856,7 @@
}
break;
case ND_SECTIONNODE:
- // jump over hidden sections - ignore protection!
+ // skip hidden sections - ignore protection!
if(((SwSectionNode*)pNd)->GetSection().IsHidden() )
nCurrNd = pNd->EndOfSectionIndex();
break;
diff --git a/sw/source/core/edit/edlingu.cxx b/sw/source/core/edit/edlingu.cxx
index 0101486..d36fa39 100644
--- a/sw/source/core/edit/edlingu.cxx
+++ b/sw/source/core/edit/edlingu.cxx
@@ -145,11 +145,7 @@
void ContinueAfterThisSentence() { bMoveToEndOfSentence = true; }
};
-/*************************************************************************
- * class SwConvIter
- * used for text conversion
- *************************************************************************/
-
+/// used for text conversion
class SwConvIter : public SwLinguIter
{
SwConversionArgs &rArgs;
@@ -492,11 +488,11 @@
// robust
if( GetSh() || GetEnd() )
{
- OSL_ENSURE( !GetSh(), "+SwEditShell::HyphStart: missing HyphEnd()" );
+ OSL_ENSURE( !GetSh(), "SwHyphIter::Start: missing HyphEnd()" );
return;
}
-// nothing to be done (at least not in the way as in the "else" part)
+ // nothing to do (at least not in the way as in the "else" part)
bOldIdle = pShell->GetViewOptions()->IsIdle();
((SwViewOption*)pShell->GetViewOptions())->SetIdle( sal_False );
_Start( pShell, eStart, eEnd );
@@ -606,7 +602,7 @@
void SwHyphIter::InsertSoftHyph( const xub_StrLen nHyphPos )
{
SwEditShell *pMySh = GetSh();
- OSL_ENSURE( pMySh, "+SwEditShell::InsertSoftHyph: missing HyphStart()");
+ OSL_ENSURE( pMySh, "SwHyphIter::InsertSoftHyph: missing HyphStart()");
if( !pMySh )
return;
@@ -620,8 +616,8 @@
if( pSttPos->nNode != pEndPos->nNode || !nLastHyphLen )
{
OSL_ENSURE( pSttPos->nNode == pEndPos->nNode,
- "+SwEditShell::InsertSoftHyph: node warp during hyphenation" );
- OSL_ENSURE(nLastHyphLen, "+SwEditShell::InsertSoftHyph: missing HyphContinue()");
+ "SwHyphIter::InsertSoftHyph: node warp during hyphenation" );
+ OSL_ENSURE(nLastHyphLen, "SwHyphIter::InsertSoftHyph: missing HyphContinue()");
*pSttPos = *pEndPos;
return;
}
@@ -996,9 +992,9 @@
*pCrsr->GetPoint() = aPos;
pCrsr->SetMark();
ExtendSelection( sal_True, nLen - nLeft - nRight );
- //no determine the rectangle in the current line
+ // don't determine the rectangle in the current line
xub_StrLen nWordStart = (nBegin + nLeft) < nLineStart ? nLineStart : nBegin + nLeft;
- //take one less than the line end - otherwise the next line would be calculated
+ // take one less than the line end - otherwise the next line would be calculated
xub_StrLen nWordEnd = (nBegin + nLen - nLeft - nRight) > nLineEnd ? nLineEnd: (nBegin + nLen - nLeft - nRight);
Push();
pCrsr->DeleteMark();
@@ -1025,10 +1021,10 @@
bool SwEditShell::GetGrammarCorrection(
- linguistic2::ProofreadingResult /*out*/ &rResult, // the complete result
- sal_Int32 /*out*/ &rErrorPosInText, // offset of error position in string that was grammar checked...
- sal_Int32 /*out*/ &rErrorIndexInResult, // index of error in rResult.aGrammarErrors
- uno::Sequence< OUString > /*out*/ &rSuggestions, // suggestions to be used for the error found
+ linguistic2::ProofreadingResult /*out*/ &rResult, // the complete result
+ sal_Int32 /*out*/ &rErrorPosInText, // offset of error position in string that was grammar checked...
+ sal_Int32 /*out*/ &rErrorIndexInResult, // index of error in rResult.aGrammarErrors
+ uno::Sequence< OUString > /*out*/ &rSuggestions, // suggestions to be used for the error found
const Point *pPt, SwRect &rSelectRect )
{
bool bRes = false;
@@ -1098,7 +1094,7 @@
if (rResult.aErrors.getLength() > 0) // error found?
{
- //save the start and end positons of the line and the starting point
+ // save the start and end positons of the line and the starting point
Push();
LeftMargin();
xub_StrLen nLineStart = GetCrsr()->GetPoint()->nContent.GetIndex();
@@ -1124,9 +1120,9 @@
*pCrsr->GetPoint() = aPos;
pCrsr->SetMark();
ExtendSelection( sal_True, nLen - nLeft - nRight );
- //no determine the rectangle in the current line
+ // don't determine the rectangle in the current line
xub_StrLen nWordStart = (nBegin + nLeft) < nLineStart ? nLineStart : nBegin + nLeft;
- //take one less than the line end - otherwise the next line would be calculated
+ // take one less than the line end - otherwise the next line would be calculated
xub_StrLen nWordEnd = (nBegin + nLen - nLeft - nRight) > nLineEnd ? nLineEnd: (nBegin + nLen - nLeft - nRight);
Push();
pCrsr->DeleteMark();
@@ -1164,9 +1160,8 @@
EndAction();
return bRet;
}
-/*-------------------------------------------------------------------------
- make SpellIter start with the current sentence when called next time
- -----------------------------------------------------------------------*/
+
+///make SpellIter start with the current sentence when called next time
void SwEditShell::PutSpellingToSentenceStart()
{
OSL_ENSURE( pSpellIter, "SpellIter missing" );
@@ -1233,8 +1228,8 @@
OSL_ENSURE( !rLastPortions.empty(), "rLastPortions should not be empty here" );
OSL_ENSURE( !rLastPositions.empty(), "rLastPositions should not be empty here" );
- //the simple case: the same number of elements on both sides
- //each changed element has to be applied to the corresponding source element
+ // the simple case: the same number of elements on both sides
+ // each changed element has to be applied to the corresponding source element
svx::SpellPortions::const_iterator aCurrentNewPortion = rNewPortions.end();
SpellPortions::const_iterator aCurrentOldPortion = rLastPortions.end();
SpellContentPositions::const_iterator aCurrentOldPosition = rLastPositions.end();
@@ -1271,7 +1266,7 @@
}
if(aCurrentNewPortion->sText != aCurrentOldPortion->sText)
{
- //change text ...
+ // change text ...
mpDoc->DeleteAndJoin(*pCrsr);
// ... and apply language if necessary
if(aCurrentNewPortion->eLanguage != aCurrentOldPortion->eLanguage)
@@ -1280,12 +1275,12 @@
}
else if(aCurrentNewPortion->eLanguage != aCurrentOldPortion->eLanguage)
{
- //apply language
+ // apply language
SetAttr( SvxLanguageItem(aCurrentNewPortion->eLanguage, nLangWhichId), nLangWhichId );
}
else if( aCurrentNewPortion->bIgnoreThisError )
{
- //add the 'ignore' markup to the TextNode's grammar ignore markup list
+ // add the 'ignore' markup to the TextNode's grammar ignore markup list
IgnoreGrammarErrorAt( *pCrsr );
OSL_FAIL("TODO: add ignore mark to text node");
}
@@ -1298,19 +1293,19 @@
{
OSL_ENSURE( !rLastPositions.empty(), "rLastPositions should not be empty here" );
- //select the complete sentence
+ // select the complete sentence
SpellContentPositions::const_iterator aCurrentEndPosition = rLastPositions.end();
--aCurrentEndPosition;
SpellContentPositions::const_iterator aCurrentStartPosition = rLastPositions.begin();
pCrsr->GetPoint()->nContent = aCurrentStartPosition->nLeft;
pCrsr->GetMark()->nContent = aCurrentEndPosition->nRight;
- //delete the sentence completely
+ // delete the sentence completely
mpDoc->DeleteAndJoin(*pCrsr);
svx::SpellPortions::const_iterator aCurrentNewPortion = rNewPortions.begin();
while(aCurrentNewPortion != rNewPortions.end())
{
- //set the language attribute
+ // set the language attribute
sal_uInt16 nScriptType = GetScriptType();
sal_uInt16 nLangWhichId = RES_CHRATR_LANGUAGE;
switch(nScriptType)
@@ -1323,10 +1318,10 @@
const SvxLanguageItem& rLang = static_cast<const SvxLanguageItem& >(aSet.Get(nLangWhichId));
if(rLang.GetLanguage() != aCurrentNewPortion->eLanguage)
SetAttr( SvxLanguageItem(aCurrentNewPortion->eLanguage, nLangWhichId) );
- //insert the new string
+ // insert the new string
mpDoc->InsertString(*pCrsr, aCurrentNewPortion->sText);
- //set the cursor to the end of the inserted string
+ // set the cursor to the end of the inserted string
*pCrsr->Start() = *pCrsr->End();
++aCurrentNewPortion;
}
@@ -1341,7 +1336,7 @@
*pCrsr->Start() = *pCrsr->End();
if (bRecheck)
{
- //in grammar check the current sentence has to be checked again
+ // in grammar check the current sentence has to be checked again
GoStartSentence();
}
// set continuation position for spell/grammar checking to the end of this sentence
@@ -1351,10 +1346,9 @@
EndAction();
}
}
-/*-------------------------------------------------------------------------
- collect all deleted redlines of the current text node beginning at the
- start of the cursor position
- -----------------------------------------------------------------------*/
+/** Collect all deleted redlines of the current text node
+ * beginning at the start of the cursor position
+ */
static SpellContentPositions lcl_CollectDeletedRedlines(SwEditShell* pSh)
{
SpellContentPositions aRedlines;
@@ -1391,9 +1385,8 @@
}
return aRedlines;
}
-/*-------------------------------------------------------------------------
- remove the redline positions after the current selection
- -----------------------------------------------------------------------*/
+
+/// remove the redline positions after the current selection
static void lcl_CutRedlines( SpellContentPositions& aDeletedRedlines, SwEditShell* pSh )
{
if(!aDeletedRedlines.empty())
@@ -1495,34 +1488,33 @@
while ( bGoOn );
if(xSpellRet.is() || bGrammarErrorFound)
{
- //an error has been found
- //To fill the spell portions the beginning of the sentence has to be found
+ // an error has been found
+ // To fill the spell portions the beginning of the sentence has to be found
SwPaM *pCrsr = pMySh->GetCrsr();
- //set the mark to the right if necessary
+ // set the mark to the right if necessary
if ( *pCrsr->GetPoint() > *pCrsr->GetMark() )
pCrsr->Exchange();
- //the cursor has to be collapsed on the left to go to the start of the sentence - if sentence ends inside of the error
+ // the cursor has to be collapsed on the left to go to the start of the sentence - if sentence ends inside of the error
pCrsr->DeleteMark();
pCrsr->SetMark();
bool bStartSent = 0 != pMySh->GoStartSentence();
SpellContentPositions aDeletedRedlines = lcl_CollectDeletedRedlines(pMySh);
if(bStartSent)
{
- //create a portion from the start part
+ // create a portion from the start part
AddPortion(0, 0, aDeletedRedlines);
}
- //Set the cursor to the error already found
+ // Set the cursor to the error already found
*pCrsr->GetPoint() = *GetCurrX();
*pCrsr->GetMark() = *GetCurr();
AddPortion(xSpellRet, &aGrammarResult, aDeletedRedlines);
-
- //save the end position of the error to continue from here
+ // save the end position of the error to continue from here
SwPosition aSaveStartPos = *pCrsr->End();
- //determine the end of the current sentence
+ // determine the end of the current sentence
if ( *pCrsr->GetPoint() < *pCrsr->GetMark() )
pCrsr->Exchange();
- //again collapse to start marking after the end of the error
+ // again collapse to start marking after the end of the error
pCrsr->DeleteMark();
pCrsr->SetMark();
@@ -1543,14 +1535,14 @@
}
lcl_CutRedlines( aDeletedRedlines, pMySh );
- //save the 'global' end of the spellchecking
+ // save the 'global' end of the spellchecking
const SwPosition aSaveEndPos = *GetEnd();
- //set the sentence end as 'local' end
+ // set the sentence end as 'local' end
SetEnd( new SwPosition( *pCrsr->End() ));
*pCrsr->GetPoint() = aSaveStartPos;
*pCrsr->GetMark() = *GetEnd();
- //now the rest of the sentence has to be searched for errors
+ // now the rest of the sentence has to be searched for errors
// for each error the non-error text between the current and the last error has
// to be added to the portions - if necessary broken into same-language-portions
if( !bGrammarErrorFound ) //in grammar check there's only one error returned
@@ -1566,14 +1558,13 @@
SetCurr( new SwPosition( *pCrsr->GetPoint() ));
SetCurrX( new SwPosition( *pCrsr->GetMark() ));
- //if an error has been found go back to the text
- //preceeding the error
+ // if an error has been found go back to the text preceeding the error
if(xSpellRet.is())
{
*pCrsr->GetPoint() = aSaveStartPos;
*pCrsr->GetMark() = *GetCurr();
}
- //add the portion
+ // add the portion
AddPortion(0, 0, aDeletedRedlines);
if(xSpellRet.is())
@@ -1581,11 +1572,11 @@
*pCrsr->GetPoint() = *GetCurr();
*pCrsr->GetMark() = *GetCurrX();
AddPortion(xSpellRet, 0, aDeletedRedlines);
- //move the cursor to the end of the error string
+ // move the cursor to the end of the error string
*pCrsr->GetPoint() = *GetCurrX();
- //and save the end of the error as new start position
+ // and save the end of the error as new start position
aSaveStartPos = *GetCurrX();
- //and the end of the sentence
+ // and the end of the sentence
*pCrsr->GetMark() = *GetEnd();
}
// if the end of the sentence has already been reached then break here
@@ -1596,7 +1587,7 @@
}
else
{
- //go to the end of sentence as the grammar check returned it
+ // go to the end of sentence as the grammar check returned it
// at this time the Point is behind the grammar error
// and the mark points to the sentence end as
if ( *pCrsr->GetPoint() < *pCrsr->GetMark() )
@@ -1609,21 +1600,21 @@
{
AddPortion(0, 0, aDeletedRedlines);
}
- //set the shell cursor to the end of the sentence to prevent a visible selection
+ // set the shell cursor to the end of the sentence to prevent a visible selection
*pCrsr->GetMark() = *GetEnd();
if( !bIsGrammarCheck )
{
- //set the current position to the end of the sentence
+ // set the current position to the end of the sentence
SetCurr( new SwPosition(*GetEnd()) );
}
- //restore the 'global' end
+ // restore the 'global' end
SetEnd( new SwPosition(aSaveEndPos) );
rPortions = aLastPortions;
bRet = true;
}
else
{
- //if no error could be found the selection has to be corrected - at least if it's not in the body
+ // if no error could be found the selection has to be corrected - at least if it's not in the body
*pMySh->GetCrsr()->GetPoint() = *GetEnd();
pMySh->GetCrsr()->DeleteMark();
}
@@ -1651,9 +1642,8 @@
const SvxLanguageItem& rLang = static_cast<const SvxLanguageItem& >(aSet.Get(nLangWhichId));
return rLang.GetLanguage();
}
-/*-------------------------------------------------------------------------
- create a text portion at the given position
- -----------------------------------------------------------------------*/
+
+/// create a text portion at the given position
void SwSpellIter::CreatePortion(uno::Reference< XSpellAlternatives > xAlt,
linguistic2::ProofreadingResult* pGrammarResult,
bool bIsField, bool bIsHidden)
@@ -1663,8 +1653,7 @@
GetSh()->GetSelectedText( sText );
if(sText.Len())
{
- //in case of redlined deletions the selection of an error is not
- //the same as the _real_ word
+ // in case of redlined deletions the selection of an error is not the same as the _real_ word
if(xAlt.is())
aPortion.sText = xAlt->getWord();
else if(pGrammarResult)
@@ -1719,11 +1708,11 @@
SwPaM *pCrsr = GetSh()->GetCrsr();
if ( *pCrsr->GetPoint() > *pCrsr->GetMark() )
pCrsr->Exchange();
- //save the start and end positions
+ // save the start and end positions
SwPosition aStart(*pCrsr->GetPoint());
SwPosition aEnd(*pCrsr->GetMark());
- //iterate over the text to find changes in language
- //set the mark equal to the point
+ // iterate over the text to find changes in language
+ // set the mark equal to the point
*pCrsr->GetMark() = aStart;
SwTxtNode* pTxtNode = pCrsr->GetNode()->GetTxtNode();
LanguageType eStartLanguage = lcl_GetLanguage(*GetSh());
@@ -1731,24 +1720,24 @@
rDeletedRedlines, aStart.nContent.GetIndex() );
if( aNextRedline.nLeft == aStart.nContent.GetIndex() )
{
- //select until the end of the current redline
+ // select until the end of the current redline
xub_StrLen nEnd = aEnd.nContent.GetIndex() < aNextRedline.nRight ?
aEnd.nContent.GetIndex() : aNextRedline.nRight;
pCrsr->GetPoint()->nContent.Assign( pTxtNode, nEnd );
CreatePortion(xAlt, pGrammarResult, false, true);
aStart = *pCrsr->End();
- //search for next redline
+ // search for next redline
aNextRedline = lcl_FindNextDeletedRedline(
rDeletedRedlines, aStart.nContent.GetIndex() );
}
while(*pCrsr->GetPoint() < aEnd)
{
- //#125786 in table cell with fixed row height the cursor might not move forward
+ // #125786 in table cell with fixed row height the cursor might not move forward
if(!GetSh()->Right(1, CRSR_SKIP_CELLS))
break;
bool bField = false;
- //read the character at the current position to check if it's a field
+ // read the character at the current position to check if it's a field
sal_Unicode const cChar =
pTxtNode->GetTxt()[pCrsr->GetMark()->nContent.GetIndex()];
if( CH_TXTATR_BREAKWORD == cChar || CH_TXTATR_INWORD == cChar)
@@ -1777,19 +1766,19 @@
if(bField || bRedline || eCurLanguage != eStartLanguage)
{
eStartLanguage = eCurLanguage;
- //go one step back - the cursor currently selects the first character
- //with a different language
- //in the case of redlining it's different
+ // go one step back - the cursor currently selects the first character
+ // with a different language
+ // in the case of redlining it's different
if(eCurLanguage != eStartLanguage || bField)
*pCrsr->GetPoint() = *pCrsr->GetMark();
- //set to the last start
+ // set to the last start
*pCrsr->GetMark() = aStart;
- //create portion should only be called if a selection exists
- //there's no selection if there's a field at the beginning
+ // create portion should only be called if a selection exists
+ // there's no selection if there's a field at the beginning
if(*pCrsr->Start() != *pCrsr->End())
CreatePortion(xAlt, pGrammarResult, false, false);
aStart = *pCrsr->End();
- //now export the field - if there is any
+ // now export the field - if there is any
if(bField)
{
*pCrsr->GetMark() = *pCrsr->GetPoint();
@@ -1802,13 +1791,13 @@
if(bRedline)
{
*pCrsr->GetMark() = *pCrsr->GetPoint();
- //select until the end of the current redline
+ // select until the end of the current redline
xub_StrLen nEnd = aEnd.nContent.GetIndex() < aNextRedline.nRight ?
aEnd.nContent.GetIndex() : aNextRedline.nRight;
pCrsr->GetPoint()->nContent.Assign( pTxtNode, nEnd );
CreatePortion(xAlt, pGrammarResult, false, true);
aStart = *pCrsr->End();
- //search for next redline
+ // search for next redline
aNextRedline = lcl_FindNextDeletedRedline(
rDeletedRedlines, aStart.nContent.GetIndex() );
}
diff --git a/sw/source/core/edit/ednumber.cxx b/sw/source/core/edit/ednumber.cxx
index 4566903..8c5eeda 100644
--- a/sw/source/core/edit/ednumber.cxx
+++ b/sw/source/core/edit/ednumber.cxx
@@ -178,8 +178,7 @@
{
bResult = pTxtNd->HasNumber();
- // --> OD 2005-10-26 #b6340308#
- // special case: outline numbered, not counted paragraph
+ // #b6340308# special case: outline numbered, not counted paragraph
if ( bResult &&
pTxtNd->GetNumRule() == GetDoc()->GetOutlineNumRule() &&
!pTxtNd->IsCountedInList() )
@@ -189,7 +188,6 @@
if (bResult==sal_False) {
break;
}
- // <--
}
}
}
@@ -199,7 +197,8 @@
return bResult;
}
-//Sym3_879 add a new function to determine number on/off status
+
+// add a new function to determine number on/off status
sal_Bool SwEditShell::SelectionHasBullet() const
{
sal_Bool bResult = HasBullet();
diff --git a/sw/source/core/edit/edredln.cxx b/sw/source/core/edit/edredln.cxx
index dbefb53..4165e4c 100644
--- a/sw/source/core/edit/edredln.cxx
+++ b/sw/source/core/edit/edredln.cxx
@@ -122,8 +122,10 @@
}
}
- // Search the Redline of this data and return the Pos of the Array
- // return USHRT_MAX if not present
+/** Search the Redline of the data given
+ *
+ * @return Returns the Pos of the Array, or USHRT_MAX if not present
+ */
sal_uInt16 SwEditShell::FindRedlineOfData( const SwRedlineData& rData ) const
{
const SwRedlineTbl& rTbl = GetDoc()->GetRedlineTbl();
diff --git a/sw/source/core/edit/edsect.cxx b/sw/source/core/edit/edsect.cxx
index c7c3f920..f767c4d 100644
--- a/sw/source/core/edit/edsect.cxx
+++ b/sw/source/core/edit/edsect.cxx
@@ -78,10 +78,9 @@
return GetDoc()->GetCurrSection( *GetCrsr()->GetPoint() );
}
-/**
- * SwEditShell::GetAnySection delivers the responsible area
- * of the columns, in footnotes it may not be the
- * area within the footnote.
+/** Deliver the responsible area of the columns.
+ *
+ * In footnotes it may not be the area within the footnote.
*/
const SwSection* SwEditShell::GetAnySection( sal_Bool bOutOfTab, const Point* pPt ) const
@@ -254,9 +253,10 @@
EndAllAction();
}
-// search inside the cursor selection for full selected sections.
-// if any part of section in the selection return 0.
-// if more than one in the selection return the count
+/** Search inside the cursor selection for full selected sections.
+ *
+ * @return If any part of section in the selection return 0, if more than one return the count.
+ */
sal_uInt16 SwEditShell::GetFullSelectedSectionCount() const
{
sal_uInt16 nRet = 0;
@@ -298,8 +298,8 @@
}
-/**
- * Find the suitable node for a special insert (alt-enter).
+/** Find the suitable node for a special insert (alt-enter).
+ *
* This should enable inserting text before/after sections and tables.
*
* A node is found if:
@@ -407,8 +407,7 @@
return NULL != lcl_SpecialInsertNode( GetCrsr()->GetPoint() );
}
-
-/** check whether a node cen be special-inserted (alt-Enter), and do so. Return
+/** check whether a node can be special-inserted (alt-Enter), and do so. Return
whether insertion was possible.
*/
bool SwEditShell::DoSpecialInsert()
diff --git a/sw/source/core/edit/edtab.cxx b/sw/source/core/edit/edtab.cxx
index 97e999e..1c6dbef 100644
--- a/sw/source/core/edit/edtab.cxx
+++ b/sw/source/core/edit/edtab.cxx
@@ -103,9 +103,8 @@
GetDoc()->SplitNode( *pPos, false );
}
- /* If called from a shell the adjust item is propagated
- from pPos to the new content nodes in the table.
- */
+ // If called from a shell the adjust item is propagated
+ // from pPos to the new content nodes in the table.
const SwTable *pTable = GetDoc()->InsertTable( rInsTblOpts, *pPos,
nRows, nCols,
eAdj, pTAFmt,
diff --git a/sw/source/core/layout/wsfrm.cxx b/sw/source/core/layout/wsfrm.cxx
index de45f50..13fc678 100644
--- a/sw/source/core/layout/wsfrm.cxx
+++ b/sw/source/core/layout/wsfrm.cxx
@@ -92,7 +92,7 @@
mbInfFtn ( sal_False ),
mbInfSct ( sal_False )
{
- OSL_ENSURE( pMod, "No frame format passed." );
+ OSL_ENSURE( pMod, "No frame format given." );
mbInvalidR2L = mbInvalidVert = 1;
//Badaa: 2008-04-18 * Support for Classical Mongolian Script (SCMS) joint with Jiayanmin
mbDerivedR2L = mbDerivedVert = mbRightToLeft = mbVertical = mbReverse = mbVertLR = 0;
@@ -362,14 +362,10 @@
/* Do nothing */
}
-/*************************************************************************
-|*
-|* SwFrm::InvalidatePage()
-|* Description: Invalidates the page in which the Frm is placed
-|* currently. The page is invalidated depending on the type (Layout,
-|* Cntnt, FlyFrm)
-|*
-|*************************************************************************/
+/**
+ * Invalidates the page in which the Frm is currently placed.
+ * The page is invalidated depending on the type (Layout, Cntnt, FlyFrm)
+ */
void SwFrm::InvalidatePage( const SwPageFrm *pPage ) const
{
if ( !pPage )
@@ -407,9 +403,7 @@
{
if ( pRoot->IsTurboAllowed() )
{
- // JP 21.09.95: it can still be a TurboAction if the
- // ContentFrame wants to register a second time.
- // RIGHT????
+ // If a ContentFrame wants to register for a second time, make it a TurboAction.
if ( !pRoot->GetTurbo() || this == pRoot->GetTurbo() )
pRoot->SetTurbo( (const SwCntntFrm*)this );
else
@@ -556,15 +550,11 @@
return maFrm.SSize();
}
-/*************************************************************************
-|*
-|* SwFrm::InsertBefore()
-|*
-|* Description SwFrm is inserted into an existing structure.
-|* Insertion is done below the parent and either before
-|* pBehind or at the end of the chain if pBehind is empty.
-|*
-|*************************************************************************/
+/** Insert SwFrm into existing structure.
+ *
+ * Insertion is done below the parent either before pBehind or
+ * at the end of the chain if pBehind is empty.
+ */
void SwFrm::InsertBefore( SwLayoutFrm* pParent, SwFrm* pBehind )
{
OSL_ENSURE( pParent, "No parent for insert." );
@@ -595,16 +585,11 @@
}
}
-/*************************************************************************
-|*
-|* SwFrm::InsertBehind()
-|*
-|* Description SwFrm is inserted in an existing structure.
-|* Insertion is done below the parent and either behind
-|* pBefore or at the beginning of the chain if pBefore is
-|* empty.
-|*
-|*************************************************************************/
+/** Insert SwFrm into existing structure.
+ *
+ * Insertion is done below the parent either after pBehind or
+ * at the beginning of the chain if pBehind is empty.
+ */
void SwFrm::InsertBehind( SwLayoutFrm *pParent, SwFrm *pBefore )
{
OSL_ENSURE( pParent, "No Parent for Insert." );
@@ -630,27 +615,19 @@
}
}
-/*************************************************************************
-|*
-|* SwFrm::InsertGroup()
-|*
-|* Description A chain of SwFrms gets inserted in an existing structure
-|*
-|* Until now this is used to insert a SectionFrame (which may have some
-|* siblings) into an existing structure.
-|*
-|* If the third parameter is NULL, this method is (besides handling the
-|* siblings) equal to SwFrm::InsertBefore(..)
-|*
-|* If the third parameter is passed, the following happens:
-|* - this becomes mpNext of pParent
-|* - pSct becomes mpNext of the last one in the this-chain
-|* - pBehind is reconnected from pParent to pSct
-|* The purpose is: a SectionFrm (this) won't become a child of another
-|* SectionFrm (pParent), but pParent gets split into two siblings
-|* (pParent+pSect) and this is inserted between.
-|*
-|*************************************************************************/
+/** Insert a chain of SwFrms into an existing struction
+ *
+ * Currently, this method is used to insert a SectionFrame (which may have some siblings) into an
+ * existing structure. If the third parameter is NULL, this method is (besides handling the
+ * siblings) equal to SwFrm::InsertBefore(..).
+ *
+ * If the third parameter is passed, the following happens:
+ * - this becomes mpNext of pParent
+ * - pSct becomes mpNext of the last one in the this-chain
+ * - pBehind is reconnected from pParent to pSct
+ * The purpose is: a SectionFrm (this) won't become a child of another SectionFrm (pParent), but
+ * pParent gets split into two siblings (pParent+pSect) and this is inserted between.
+ */
void SwFrm::InsertGroupBefore( SwFrm* pParent, SwFrm* pBehind, SwFrm* pSct )
{
OSL_ENSURE( pParent, "No parent for insert." );
@@ -1325,30 +1302,26 @@
return 0L;
}
-/*************************************************************************
-|*
-|* SwFrm::AdjustNeighbourhood()
-|*
-|* Description A Frm needs "normalization" if it is directly placed
-|* below a footnote boss (page/column) and its size changed.
-|* There's always a frame which takes the maximum possible space (the
-|* frame which contains the Body.Text) and zero or more frames which
-|* only take the space needed (header/footer area, footnote container).
-|* If one of these frames changes, the body-text-frame has to grow or
-|* shrink accordingly, even tough it's fixed.
-|* !! Is it possible to do this in a generic way and not restrict it to
-|* the page and a distinct frame which takes the maximum space (controlled
-|* using the FrmSize attribute)? Problems: What if multiple frames taking
-|* the maximum space are placed next to each other?
-|* How is the maximum space calculated?
-|* How small can those frames become?
-|*
-|* In any case, only a certain amount of space is allowed, so we
-|* never go below a minimum value for the height of the body.
-|*
-|* Parameter: nDiff is the value around which the space has to be allocated
-|*
-|*************************************************************************/
+/** Adjust surrounding neighbourhood after insertion
+ *
+ * A Frm needs "normalization" if it is directly placed below a footnote boss (page/column) and its
+ * size changes. There is always a frame that takes the maximum possible space (the frame that
+ * contains the Body text) and zero or more frames which only take the space needed (header/footer
+ * area, footnote container). If one of these frames changes, the body-text-frame has to grow or
+ * shrink accordingly, even tough it's fixed.
+ *
+ * !! Is it possible to do this in a generic way and not restrict it to the page and a distinct
+ * frame which takes the maximum space (controlled using the FrmSize attribute)?
+ * Problems:
+ * - What if multiple frames taking the maximum space are placed next to each other?
+ * - How is the maximum space calculated?
+ * - How small can those frames become?
+ *
+ * In any case, only a certain amount of space is allowed, so we never go below a minimum value for
+ * the height of the body.
+ *
+ * @param nDiff the value around which the space has to be allocated
+ */
SwTwips SwFrm::AdjustNeighbourhood( SwTwips nDiff, sal_Bool bTst )
{
PROTOCOL_ENTER( this, PROT_ADJUSTN, 0, &nDiff );
@@ -1642,29 +1615,13 @@
return (nBrowseAdd + nReal + nAdd);
}
-/*************************************************************************
-|*
-|* SwFrm::ImplInvalidateSize(), ImplInvalidatePrt(), ImplInvalidatePos(),
-|* ImplInvalidateLineNum()
-|*
-|*************************************************************************/
-/** method to perform additional actions on an invalidation
-
- OD 2004-05-19 #i28701#
-
- @author OD
-*/
+/** method to perform additional actions on an invalidation (2004-05-19 #i28701#) */
void SwFrm::_ActionOnInvalidation( const InvalidationType )
{
// default behaviour is to perform no additional action
}
-/** method to determine, if an invalidation is allowed.
-
- OD 2004-05-19 #i28701#
-
- @author OD
-*/
+/** method to determine, if an invalidation is allowed (2004-05-19 #i28701#) */
bool SwFrm::_InvalidationAllowed( const InvalidationType ) const
{
// default behaviour is to allow invalidation
@@ -2681,17 +2638,13 @@
}
return nReal;
}
-/*************************************************************************
-|*
-|* SwLayoutFrm::ChgLowersProp()
-|*
-|* Description Changes the size of the directly subsidiary Frm's
-|* which have a fixed size, proportionally to the size change of the
-|* PrtArea of the Frm's.
-|* The variable Frms are also proportionally adapted; they will
-|* grow/shrink again by themselves.
-|*
-|*************************************************************************/
+
+/**
+ * Changes the size of the directly subsidiary Frm's that have a fixed size, proportionally to the
+ * size change of the PrtArea of the Frm's.
+ *
+ * The variable Frms are also proportionally adapted; they will grow/shrink again by themselves.
+ */
void SwLayoutFrm::ChgLowersProp( const Size& rOldSize )
{
// no change of lower properties for root frame or if no lower exists.
@@ -3081,14 +3034,10 @@
}
}
-/*************************************************************************
-|*
-|* SwLayoutFrm::Format()
-|*
-|* Description: "Formats" the Frame; Frm and PrtArea.
-|* The Fixsize is not set here.
-|*
-|*************************************************************************/
+/** "Formats" the Frame; Frm and PrtArea.
+ *
+ * The Fixsize is not set here.
+ */
void SwLayoutFrm::Format( const SwBorderAttrs *pAttrs )
{
OSL_ENSURE( pAttrs, "LayoutFrm::Format, pAttrs ist 0." );
@@ -3273,9 +3222,8 @@
return nRet;
}
-/*************************************************************************
-|* Local helpers for SwLayoutFrm::FormatWidthCols()
-|*************************************************************************/
+// Local helpers for SwLayoutFrm::FormatWidthCols()
+
static long lcl_CalcMinColDiff( SwLayoutFrm *pLayFrm )
{
long nDiff = 0, nFirstDiff = 0;
@@ -3866,14 +3814,10 @@
}
}
-/** method to invalidate/re-calculate the position of all floating
- screen objects (Writer fly frames and drawing objects), which are
- anchored to paragraph or to character.
-
- OD 2004-03-16 #i11860#
-
- @author OD
-*/
+/**
+ * Invalidate/re-calculate the position of all floating screen objects (Writer fly frames and
+ * drawing objects), that are anchored to paragraph or to character. (2004-03-16 #i11860#)
+ */
void SwRootFrm::InvalidateAllObjPos()
{
const SwPageFrm* pPageFrm = static_cast<const SwPageFrm*>(Lower());
--
To view, visit https://gerrit.libreoffice.org/4204
To unsubscribe, visit https://gerrit.libreoffice.org/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I32b249971ac6ac540d816c38e00321befb181901
Gerrit-PatchSet: 1
Gerrit-Project: core
Gerrit-Branch: master
Gerrit-Owner: Philipp Riemer <ruderphilipp at gmail.com>
More information about the LibreOffice
mailing list