diff options
Diffstat (limited to 'sw')
-rw-r--r-- | sw/source/core/doc/acmplwrd.cxx | 16 | ||||
-rw-r--r-- | sw/source/core/doc/doc.cxx | 38 | ||||
-rw-r--r-- | sw/source/core/doc/doccomp.cxx | 16 | ||||
-rw-r--r-- | sw/source/core/doc/doccorr.cxx | 4 | ||||
-rw-r--r-- | sw/source/core/doc/docdesc.cxx | 10 | ||||
-rw-r--r-- | sw/source/core/doc/docdraw.cxx | 39 | ||||
-rw-r--r-- | sw/source/core/doc/docedt.cxx | 10 | ||||
-rw-r--r-- | sw/source/core/doc/docfld.cxx | 35 | ||||
-rw-r--r-- | sw/source/core/doc/docfly.cxx | 2 | ||||
-rw-r--r-- | sw/source/core/doc/docfmt.cxx | 59 | ||||
-rw-r--r-- | sw/source/core/doc/docglos.cxx | 4 | ||||
-rw-r--r-- | sw/source/core/doc/doclay.cxx | 42 | ||||
-rw-r--r-- | sw/source/core/doc/docnew.cxx | 6 | ||||
-rw-r--r-- | sw/source/core/doc/docredln.cxx | 30 | ||||
-rw-r--r-- | sw/source/core/doc/docsort.cxx | 65 | ||||
-rw-r--r-- | sw/source/core/doc/doctxm.cxx | 78 | ||||
-rw-r--r-- | sw/source/core/doc/htmltbl.cxx | 12 | ||||
-rw-r--r-- | sw/source/core/doc/notxtfrm.cxx | 66 | ||||
-rw-r--r-- | sw/source/core/doc/number.cxx | 71 | ||||
-rw-r--r-- | sw/source/core/doc/poolfmt.cxx | 24 | ||||
-rw-r--r-- | sw/source/core/doc/tblcpy.cxx | 26 |
21 files changed, 221 insertions, 432 deletions
diff --git a/sw/source/core/doc/acmplwrd.cxx b/sw/source/core/doc/acmplwrd.cxx index 80c657d06d4f..0e8c2aee46de 100644 --- a/sw/source/core/doc/acmplwrd.cxx +++ b/sw/source/core/doc/acmplwrd.cxx @@ -346,32 +346,36 @@ void SwAutoCompleteWord::SetMinWordLen( sal_uInt16 n ) nMinWrdLen = n; } -// Resets the current position within the tree to its root node. +/// Reset the current position within the tree to its root node. void SwAutoCompleteWord::returnToRoot() { m_LookupTree->returnToRoot(); } -// Advances to a given node within the AutoComplete tree. +/// Advance to a given node within the AutoComplete tree. void SwAutoCompleteWord::gotoNode(OUString sNode) { m_LookupTree->gotoNode( sNode ); } -// Advances from the current position towards the node keyed with cKey. +/// Advance from the current position towards the node keyed with cKey. void SwAutoCompleteWord::advance(const sal_Unicode cKey) { m_LookupTree->advance( cKey ); } -// Goes back one char within the tree, except if the current node is already the root node. +/// Go back one char within the tree, except if the current node is already the root node. void SwAutoCompleteWord::goBack() { m_LookupTree->goBack(); } -// Returns all words matching a given prefix aMatch. If bIgnoreCurrentPos is set, the current -// position within the tree is ignored and replaced by aMatch. +/** Return all words matching a given prefix + * + * @param aMatch the prefix to search for + * @param aWords the words to search in + * @param bIgnoreCurrentPos if set, the current position within the tree is ignored and replaced by aMatch + */ bool SwAutoCompleteWord::GetWordsMatching(String aMatch, std::vector<String>& aWords, bool bIgnoreCurrentPos) const { OUString aStringRoot = OUString( aMatch ); diff --git a/sw/source/core/doc/doc.cxx b/sw/source/core/doc/doc.cxx index 7ca4fa9eae72..a337f57a231f 100644 --- a/sw/source/core/doc/doc.cxx +++ b/sw/source/core/doc/doc.cxx @@ -1106,10 +1106,7 @@ SwFlyFrmFmt* SwDoc::InsertOLE(const SwPaM &rRg, const String& rObjName, pFrmFmt ); } -/************************************************************************* -|* SwDoc::GetFldType() -|* Description: returns the field type of the Doc -*************************************************************************/ +/// @returns the field type of the Doc SwFieldType *SwDoc::GetSysFldType( const sal_uInt16 eWhich ) const { for( sal_uInt16 i = 0; i < INIT_FLDTYPES; ++i ) @@ -1118,7 +1115,7 @@ SwFieldType *SwDoc::GetSysFldType( const sal_uInt16 eWhich ) const return 0; } -// Set the rsid from nStt to nEnd of pTxtNode to the current session number +/// Set the rsid from nStt to nEnd of pTxtNode to the current session number bool SwDoc::UpdateRsid( SwTxtNode *pTxtNode, xub_StrLen nStt, xub_StrLen nEnd ) { if ( !pTxtNode ) @@ -1131,7 +1128,7 @@ bool SwDoc::UpdateRsid( SwTxtNode *pTxtNode, xub_StrLen nStt, xub_StrLen nEnd ) return pTxtNode->InsertHint( pAttr, INS_DEFAULT ); } -// Set the rsid of the next nLen symbols of rRg to the current session number +/// Set the rsid of the next nLen symbols of rRg to the current session number bool SwDoc::UpdateRsid( const SwPaM &rRg, const xub_StrLen nLen ) { const SwPosition* pPos = rRg.GetPoint(); @@ -1303,8 +1300,8 @@ static void lcl_FormatPostIt( pIDCO->InsertString( aPam, aStr ); } -// provide the paper tray to use according to the page style in use, -// but do that only if the respective item is NOT just the default item +/// provide the paper tray to use according to the page style in use, +/// but do that only if the respective item is NOT just the default item static sal_Int32 lcl_GetPaperBin( const SwPageFrm *pStartFrm ) { sal_Int32 nRes = -1; @@ -1813,7 +1810,7 @@ void SwDoc::DocInfoChgd( ) SetModified(); } -// Return the reference in the doc for the name +/// @return the reference in the doc for the name const SwFmtRefMark* SwDoc::GetRefMark( const String& rName ) const { const SfxPoolItem* pItem; @@ -1832,7 +1829,7 @@ const SwFmtRefMark* SwDoc::GetRefMark( const String& rName ) const return 0; } -// Return the RefMark per index - for Uno +/// @return the RefMark per index - for Uno const SwFmtRefMark* SwDoc::GetRefMark( sal_uInt16 nIndex ) const { const SfxPoolItem* pItem; @@ -1856,7 +1853,7 @@ const SwFmtRefMark* SwDoc::GetRefMark( sal_uInt16 nIndex ) const return pRet; } -// Return the names of all set references in the Doc +/// @return the names of all set references in the Doc //JP 24.06.96: If the array pointer is 0, then just return whether a RefMark is set in the Doc // OS 25.06.96: From now on we always return the reference count sal_uInt16 SwDoc::GetRefMarks( std::vector<OUString>* pNames ) const @@ -2045,11 +2042,13 @@ static bool lcl_CheckSmartTagsAgain( const SwNodePtr& rpNd, void* ) return true; } -/************************************************************************* - * Re-triggers spelling in the idle handler. - * If bInvalid is passed with true, the WrongLists in all nodes are invalidated - * and the SpellInvalid flag is set on all pages. - * bOnlyWrong controls whether only the areas with wrong words are checked or the whole area. +/** Re-trigger spelling in the idle handler. + * + * @param bInvalid if <true>, the WrongLists in all nodes are invalidated + * and the SpellInvalid flag is set on all pages. + * @param bOnlyWrong controls whether only the areas with wrong words are + * checked or the whole area. + * @param bSmartTags ??? ************************************************************************/ void SwDoc::SpellItAgainSam( bool bInvalid, bool bOnlyWrong, bool bSmartTags ) { @@ -2177,7 +2176,7 @@ void SwDoc::Summary( SwDoc* pExtDoc, sal_uInt8 nLevel, sal_uInt8 nPara, bool bIm } } -// Remove the invisible content from the document e.g. hidden areas, hidden paragraphs +/// Remove the invisible content from the document e.g. hidden areas, hidden paragraphs bool SwDoc::RemoveInvisibleContent() { bool bRet = false; @@ -2517,7 +2516,6 @@ bool SwDoc::LinksUpdated() const return mbLinksUpdated; } -// embedded all local links (Areas/Graphics) static ::sfx2::SvBaseLink* lcl_FindNextRemovableLink( const ::sfx2::SvBaseLinks& rLinks, sfx2::LinkManager& rLnkMgr ) { for( sal_uInt16 n = 0; n < rLinks.size(); ++n ) @@ -2541,6 +2539,8 @@ static ::sfx2::SvBaseLink* lcl_FindNextRemovableLink( const ::sfx2::SvBaseLinks& } return 0; } + +/// embedded all local links (Areas/Graphics) bool SwDoc::EmbedAllLinks() { bool bRet = false; @@ -2585,7 +2585,7 @@ sal_Bool SwDoc::IsInsTblAlignNum() const return SW_MOD()->IsInsTblAlignNum(get(IDocumentSettingAccess::HTML_MODE)); } -// Set up the InsertDB as Undo table +/// Set up the InsertDB as Undo table void SwDoc::AppendUndoForInsertFromDB( const SwPaM& rPam, sal_Bool bIsTable ) { if( bIsTable ) diff --git a/sw/source/core/doc/doccomp.cxx b/sw/source/core/doc/doccomp.cxx index 3fd38389ba66..c1f753abbf41 100644 --- a/sw/source/core/doc/doccomp.cxx +++ b/sw/source/core/doc/doccomp.cxx @@ -157,7 +157,7 @@ public: }; private: - // Look for the moved lines + /// Look for the moved lines class CompareSequence { CompareData &rData1, &rData2; @@ -194,8 +194,8 @@ public: virtual ~ArrayComparator() {} }; -// Consider two lines equal if similar enough (e.g. look like different -// versions of the same paragraph) +/// Consider two lines equal if similar enough (e.g. look like different +/// versions of the same paragraph) class LineArrayComparator : public ArrayComparator { private: @@ -248,7 +248,7 @@ public: virtual int GetLen2() const { return pTxtNd2->GetTxt().getLength(); } }; -// Options set in Tools->Options->Writer->Comparison +/// Options set in Tools->Options->Writer->Comparison struct CmpOptionsContainer { SvxCompareMode eCmpMode; @@ -284,7 +284,7 @@ public: int nLcsLen, int nPieceLen ); }; -// Use Hirschberg's algrithm to find LCS in linear space +/// Use Hirschberg's algrithm to find LCS in linear space class LgstCommonSubseq: public CommonSubseq { private: @@ -304,7 +304,7 @@ public: int Find( int *pSubseq1, int *pSubseq2 ); }; -// Find a common subsequence in linear time +/// Find a common subsequence in linear time class FastCommonSubseq: private CommonSubseq { private: @@ -736,7 +736,7 @@ Compare::MovedData::~MovedData() delete [] pLineNum; } -// Find the differing lines +/// Find the differing lines Compare::CompareSequence::CompareSequence( CompareData& rD1, CompareData& rD2, const MovedData& rMD1, const MovedData& rMD2 ) @@ -2009,7 +2009,7 @@ sal_uInt16 _SaveMergeRedlines::InsertRedline() return nIns; } -// Merge two documents +/// Merge two documents long SwDoc::MergeDoc( const SwDoc& rDoc ) { if( &rDoc == this ) diff --git a/sw/source/core/doc/doccorr.cxx b/sw/source/core/doc/doccorr.cxx index d7537fee7d14..392524a3a76c 100644 --- a/sw/source/core/doc/doccorr.cxx +++ b/sw/source/core/doc/doccorr.cxx @@ -59,8 +59,8 @@ namespace { - // find the relevant section in which the SwUnoCrsr may wander. - // returns NULL if no restrictions apply + /// find the relevant section in which the SwUnoCrsr may wander. + /// returns NULL if no restrictions apply static const SwStartNode* lcl_FindUnoCrsrSection( const SwNode& rNode ) { const SwStartNode* pStartNode = rNode.StartOfSectionNode(); diff --git a/sw/source/core/doc/docdesc.cxx b/sw/source/core/doc/docdesc.cxx index f27acb91c57e..9f3fa78e6103 100644 --- a/sw/source/core/doc/docdesc.cxx +++ b/sw/source/core/doc/docdesc.cxx @@ -425,15 +425,7 @@ void SwDoc::ChgPageDesc( sal_uInt16 i, const SwPageDesc &rChged ) } } -/************************************************************************* -|* -|* SwDoc::DelPageDesc() -|* -|* Description: All descriptors whose Follow point to the to-be-deleted -|* have to be adapted. -|* -|*************************************************************************/ - +/// All descriptors whose Follow point to the to-be-deleted have to be adapted. // #i7983# void SwDoc::PreDelPageDesc(SwPageDesc * pDel) { diff --git a/sw/source/core/doc/docdraw.cxx b/sw/source/core/doc/docdraw.cxx index bcd931ebd77e..c172e1f1c2b1 100644 --- a/sw/source/core/doc/docdraw.cxx +++ b/sw/source/core/doc/docdraw.cxx @@ -67,15 +67,12 @@ using namespace ::com::sun::star; using namespace ::com::sun::star::linguistic2; -/************************************************************************* -|* -|* SwDoc::GroupSelection / SwDoc::UnGroupSelection -|* -|*************************************************************************/ -// local method to determine positioning and -// alignment attributes for a drawing object, which is newly connected to -// the layout. Used for a newly formed group object <SwDoc::GroupSelection(..)> -// and the members of a destroyed group <SwDoc::UnGroupSelection(..)> +/** local method to determine positioning and alignment attributes for a drawing + * object, which is newly connected to the layout. + * + * Used for a newly formed group object <SwDoc::GroupSelection(..)> + * and the members of a destroyed group <SwDoc::UnGroupSelection(..)> + */ static void lcl_AdjustPositioningAttr( SwDrawFrmFmt* _pFrmFmt, const SdrObject& _rSdrObj ) { @@ -664,7 +661,7 @@ void SwDoc::NotifyInvisibleLayers( SdrPageView& _rSdrPageView ) /** method to determine, if a layer ID belongs to the visible ones. - Note: If given layer ID is unknown, method asserts and returns <false>. + @note If given layer ID is unknown, method asserts and returns <false>. */ bool SwDoc::IsVisibleLayerId( const SdrLayerID& _nLayerId ) const { @@ -693,8 +690,8 @@ bool SwDoc::IsVisibleLayerId( const SdrLayerID& _nLayerId ) const /** method to determine, if the corresponding visible layer ID for a invisible one. - Note: If given layer ID is a visible one, method returns given layer ID. - Note: If given layer ID is unknown, method returns given layer ID. + @note If given layer ID is a visible one, method returns given layer ID. + @note If given layer ID is unknown, method returns given layer ID. */ SdrLayerID SwDoc::GetVisibleLayerIdByInvisibleOne( const SdrLayerID& _nInvisibleLayerId ) { @@ -730,8 +727,8 @@ SdrLayerID SwDoc::GetVisibleLayerIdByInvisibleOne( const SdrLayerID& _nInvisible /** method to determine, if the corresponding invisible layer ID for a visible one. - Note: If given layer ID is a invisible one, method returns given layer ID. - Note: If given layer ID is unknown, method returns given layer ID. + @note If given layer ID is a invisible one, method returns given layer ID. + @note If given layer ID is unknown, method returns given layer ID. */ SdrLayerID SwDoc::GetInvisibleLayerIdByVisibleOne( const SdrLayerID& _nVisibleLayerId ) { @@ -822,23 +819,13 @@ void SwDoc::DrawNotifyUndoHdl() mpDrawModel->SetNotifyUndoActionHdl( Link() ); } -/************************************************************************* -* -* In the Outliner, set a link to the method for field display in edit objects. -* -*************************************************************************/ - +/// In the Outliner, set a link to the method for field display in edit objects. void SwDoc::SetCalcFieldValueHdl(Outliner* pOutliner) { pOutliner->SetCalcFieldValueHdl(LINK(this, SwDoc, CalcFieldValueHdl)); } -/************************************************************************* -|* -|* Recognise fields/URLs in the Outliner and set how they are displayed. -|* -\************************************************************************/ - +/// Recognise fields/URLs in the Outliner and set how they are displayed. IMPL_LINK(SwDoc, CalcFieldValueHdl, EditFieldInfo*, pInfo) { if (pInfo) diff --git a/sw/source/core/doc/docedt.cxx b/sw/source/core/doc/docedt.cxx index 7351b1dcb447..7a9c89084f60 100644 --- a/sw/source/core/doc/docedt.cxx +++ b/sw/source/core/doc/docedt.cxx @@ -273,8 +273,8 @@ void _SaveFlyInRange( const SwPaM& rPam, const SwNodeIndex& rInsPos, } } -// Delete and move all Flys at the paragraph, that are within the selection. -// If there is a Fly at the SPoint, it is moved onto the Mark. +/// Delete and move all Flys at the paragraph, that are within the selection. +/// If there is a Fly at the SPoint, it is moved onto the Mark. void DelFlyInRange( const SwNodeIndex& rMkNdIdx, const SwNodeIndex& rPtNdIdx ) { @@ -674,8 +674,8 @@ void _SaveRedlEndPosForRestore::_Restore() } } -// Delete a full Section of the NodeArray. -// The passed Node is located somewhere in the designated Section. +/// Delete a full Section of the NodeArray. +/// The passed Node is located somewhere in the designated Section. void SwDoc::DeleteSection( SwNode *pNode ) { OSL_ENSURE( pNode, "Didn't pass a Node." ); @@ -1206,7 +1206,7 @@ bool SwDoc::MoveNodeRange( SwNodeRange& rRange, SwNodeIndex& rPos, return sal_True; } -// Convert list of ranges of whichIds to a corresponding list of whichIds +/// Convert list of ranges of whichIds to a corresponding list of whichIds static std::vector<sal_uInt16> * lcl_RangesToVector(sal_uInt16 * pRanges) { std::vector<sal_uInt16> * pResult = new std::vector<sal_uInt16>(); diff --git a/sw/source/core/doc/docfld.cxx b/sw/source/core/doc/docfld.cxx index a4539972320e..477bc5d96363 100644 --- a/sw/source/core/doc/docfld.cxx +++ b/sw/source/core/doc/docfld.cxx @@ -64,12 +64,10 @@ using namespace ::com::sun::star::uno; extern bool IsFrameBehind( const SwTxtNode& rMyNd, sal_uInt16 nMySttPos, const SwTxtNode& rBehindNd, sal_uInt16 nSttPos ); -/*-------------------------------------------------------------------- - Description: Insert field types - --------------------------------------------------------------------*/ -/* - * Implementation of field methods at the Doc - * Always returns a pointer to the type, if it's new or already added. +/** Insert field types + * + * @param rFldTyp ??? + * @return Always returns a pointer to the type, if it's new or already added. */ SwFieldType* SwDoc::InsertFldType(const SwFieldType &rFldTyp) { @@ -144,6 +142,7 @@ SwFieldType* SwDoc::InsertFldType(const SwFieldType &rFldTyp) return (*mpFldTypes)[ nSize ]; } +/// Insert field type that was marked as deleted void SwDoc::InsDeletedFldType( SwFieldType& rFldTyp ) { // The FldType was marked as deleted and removed from the array. @@ -202,9 +201,7 @@ void SwDoc::InsDeletedFldType( SwFieldType& rFldTyp ) } } -/*-------------------------------------------------------------------- - Description: Remove field type - --------------------------------------------------------------------*/ +/// Remove field type void SwDoc::RemoveFldType(sal_uInt16 nFld) { OSL_ENSURE( INIT_FLDTYPES <= nFld, "don't remove InitFlds" ); @@ -254,9 +251,7 @@ const SwFldTypes* SwDoc::GetFldTypes() const return mpFldTypes; } -/*-------------------------------------------------------------------- - Description: Find first type with ResId and name - --------------------------------------------------------------------*/ +/// Find first type with ResId and name SwFieldType* SwDoc::GetFldType( sal_uInt16 nResId, const String& rName, bool bDbFieldMatching // used in some UNO calls for RES_DBFLD // to use different string matching code @@ -389,9 +384,7 @@ void SwDoc::UpdateUsrFlds() } } -/*-------------------------------------------------------------------- - Description: Update reference and table fields - --------------------------------------------------------------------*/ +/// Update reference and table fields void SwDoc::UpdateRefFlds( SfxPoolItem* pHt ) { SwFieldType* pFldType; @@ -400,8 +393,8 @@ void SwDoc::UpdateRefFlds( SfxPoolItem* pHt ) pFldType->ModifyNotification( 0, pHt ); } -//For simplicity assume that all field types have updatable contents so -//optimization currently only available when no fields exist. +/// @note For simplicity assume that all field types have updatable contents so +/// optimization currently only available when no fields exist. bool SwDoc::containsUpdatableFields() { for (sal_uInt16 i = 0; i < mpFldTypes->size(); ++i) @@ -688,7 +681,7 @@ void SwDoc::UpdatePageFlds( SfxPoolItem* pMsgHnt ) SetNewFldLst(true); } -// ---- Remove all unreferenced field types of a document -- +/// Remove all unreferenced field types of a document void SwDoc::GCFieldTypes() { for( sal_uInt16 n = mpFldTypes->size(); n > INIT_FLDTYPES; ) @@ -999,7 +992,7 @@ _HashStr::_HashStr( const String& rName, const String& rText, pNext = pNxt; } -// Look up the Name, if it is present, return it's String, otherwise return an empty String +/// Look up the Name, if it is present, return it's String, otherwise return an empty String void LookString( SwHash** ppTbl, sal_uInt16 nSize, const String& rName, String& rRet, sal_uInt16* pPos ) { @@ -1676,9 +1669,7 @@ void SwDoc::SetInitDBFields( sal_Bool b ) GetNewDBMgr()->SetInitDBFields( b ); } -/*-------------------------------------------------------------------- - Description: Get all databases that are used by fields - --------------------------------------------------------------------*/ +/// Get all databases that are used by fields static String lcl_DBDataToString(const SwDBData& rData) { String sRet = rData.sDataSource; diff --git a/sw/source/core/doc/docfly.cxx b/sw/source/core/doc/docfly.cxx index 11ad91022cdd..7ac644eaf610 100644 --- a/sw/source/core/doc/docfly.cxx +++ b/sw/source/core/doc/docfly.cxx @@ -103,7 +103,7 @@ sal_uInt16 SwDoc::GetFlyCount( FlyCntType eType ) const return nCount; } -// If you change this, also update SwXFrameEnumeration in unocoll. +/// @attention If you change this, also update SwXFrameEnumeration in unocoll. SwFrmFmt* SwDoc::GetFlyNum( sal_uInt16 nIdx, FlyCntType eType ) { SwFrmFmts& rFmts = *GetSpzFrmFmts(); diff --git a/sw/source/core/doc/docfmt.cxx b/sw/source/core/doc/docfmt.cxx index c855e901bb03..719fb5a200b0 100644 --- a/sw/source/core/doc/docfmt.cxx +++ b/sw/source/core/doc/docfmt.cxx @@ -85,7 +85,7 @@ static void SetTxtFmtCollNext( SwTxtFmtColl* pTxtColl, const SwTxtFmtColl* pDel * Reset the text's hard formatting */ -// Parameters for _Rst and lcl_SetTxtFmtColl +/// Parameters for _Rst and lcl_SetTxtFmtColl struct ParaRstFmt { SwFmtColl* pFmtColl; @@ -130,10 +130,9 @@ struct ParaRstFmt {} }; -/* pArgs contains the document's ChrFmtTable - * Is need for selections at the beginning/end and with no SSelection. +/** @params pArgs contains the document's ChrFmtTable + * Is need for selections at the beginning/end and with no SSelection. */ - static bool lcl_RstTxtAttr( const SwNodePtr& rpNd, void* pArgs ) { ParaRstFmt* pPara = (ParaRstFmt*)pArgs; @@ -490,9 +489,8 @@ void SwDoc::ResetAttrs( const SwPaM &rRg, #define DELETECHARSETS if ( bDelete ) { delete pCharSet; delete pOtherSet; } -// Insert Hints according to content types; +/// Insert Hints according to content types; // Is used in SwDoc::Insert(..., SwFmtHint &rHt) - static bool lcl_InsAttr(SwDoc *const pDoc, const SwPaM &rRg, const SfxItemSet& rChgSet, const SetAttrMode nFlags, SwUndoAttr *const pUndo,bool bExpandCharToPara=false) @@ -1052,7 +1050,7 @@ lcl_InsAttr(SwDoc *const pDoc, const SwPaM &rRg, const SfxItemSet& rChgSet, return (nNodes != 0) || bRet; } -//Add a para for the char attribute exp... +///Add a para for the char attribute exp... bool SwDoc::InsertPoolItem( const SwPaM &rRg, const SfxPoolItem &rHt, const SetAttrMode nFlags, bool bExpandCharToPara) { @@ -1101,9 +1099,8 @@ bool SwDoc::InsertItemSet ( const SwPaM &rRg, const SfxItemSet &rSet, return bRet; } - - // Set the attribute according to the stated format. If Undo is enabled, the old values is - // added to the Undo history. +/// Set the attribute according to the stated format. +/// If Undo is enabled, the old values is added to the Undo history. void SwDoc::SetAttr( const SfxPoolItem& rAttr, SwFmt& rFmt ) { SfxItemSet aSet( GetAttrPool(), rAttr.Which(), rAttr.Which() ); @@ -1111,9 +1108,8 @@ void SwDoc::SetAttr( const SfxPoolItem& rAttr, SwFmt& rFmt ) SetAttr( aSet, rFmt ); } - - // Set the attribute according to the stated format. If Undo is enabled, the old values is - // added to the Undo history. +/// Set the attribute according to the stated format. +/// If Undo is enabled, the old values is added to the Undo history. void SwDoc::SetAttr( const SfxItemSet& rSet, SwFmt& rFmt ) { if (GetIDocumentUndoRedo().DoesUndo()) @@ -1181,8 +1177,8 @@ static int lcl_SetNewDefTabStops( SwTwips nOldWidth, SwTwips nNewWidth, return sal_True; } -// Set the attribute as new default attribute in this document. -// If Undi is enabled, the old value is added to the Undo history. +/// Set the attribute as new default attribute in this document. +/// If Undo is enabled, the old value is added to the Undo history. void SwDoc::SetDefault( const SfxPoolItem& rAttr ) { SfxItemSet aSet( GetAttrPool(), rAttr.Which(), rAttr.Which() ); @@ -1310,15 +1306,13 @@ void SwDoc::SetDefault( const SfxItemSet& rSet ) SetModified(); } -// Get the default attribute in this document +/// Get the default attribute in this document const SfxPoolItem& SwDoc::GetDefault( sal_uInt16 nFmtHint ) const { return GetAttrPool().GetDefaultItem( nFmtHint ); } -/* - * Delete the formats - */ +/// Delete the formats void SwDoc::DelCharFmt(sal_uInt16 nFmt, bool bBroadcast) { SwCharFmt * pDel = (*mpCharFmtTbl)[nFmt]; @@ -1399,9 +1393,7 @@ void SwDoc::DelTblFrmFmt( SwTableFmt *pFmt ) mpTblFrmFmtTbl->erase(it); } -/* - * Create the formats - */ +/// Create the formats SwFlyFrmFmt *SwDoc::MakeFlyFrmFmt( const String &rFmtName, SwFrmFmt *pDerivedFrom ) { @@ -1538,12 +1530,7 @@ SwFmt *SwDoc::_MakeCharFmt(const String &rFmtName, return dynamic_cast<SwFmt*>(pCharFmt); } - -/* - * Create the FormatCollections - */ -// TXT -// #i40550# - add parameter <bAuto> - not relevant +/// Create the FormatCollections SwTxtFmtColl* SwDoc::MakeTxtFmtColl( const String &rFmtName, SwTxtFmtColl *pDerivedFrom, bool bBroadcast, @@ -1756,9 +1743,7 @@ bool SwDoc::SetTxtFmtColl( const SwPaM &rRg, return bRet; } - -// ---- Copy the formats to itself (SwDoc) ---------------------- - +/// Copy the formats to itself SwFmt* SwDoc::CopyFmt( const SwFmt& rFmt, const SwFmtsBase& rFmtArr, FNCopyFmt fnCopyFmt, const SwFmt& rDfltFmt ) @@ -1794,8 +1779,7 @@ SwFmt* SwDoc::CopyFmt( const SwFmt& rFmt, return pNewFmt; } - -// ---- copy the frame format -------- +/// copy the frame format SwFrmFmt* SwDoc::CopyFrmFmt( const SwFrmFmt& rFmt ) { @@ -1803,7 +1787,7 @@ SwFrmFmt* SwDoc::CopyFrmFmt( const SwFrmFmt& rFmt ) *GetDfltFrmFmt() ); } -// ---- copy the char format -------- +/// copy the char format SwCharFmt* SwDoc::CopyCharFmt( const SwCharFmt& rFmt ) { return (SwCharFmt*)CopyFmt( rFmt, *GetCharFmts(), @@ -1811,9 +1795,7 @@ SwCharFmt* SwDoc::CopyCharFmt( const SwCharFmt& rFmt ) *GetDfltCharFmt() ); } - -// --- copy TextNodes ---- - +/// copy TextNodes SwTxtFmtColl* SwDoc::CopyTxtColl( const SwTxtFmtColl& rColl ) { SwTxtFmtColl* pNewColl = FindTxtFmtCollByName( rColl.GetName() ); @@ -1882,8 +1864,7 @@ SwTxtFmtColl* SwDoc::CopyTxtColl( const SwTxtFmtColl& rColl ) return pNewColl; } -// --- copy the graphic nodes ---- - +/// copy the graphic nodes SwGrfFmtColl* SwDoc::CopyGrfColl( const SwGrfFmtColl& rColl ) { SwGrfFmtColl* pNewColl = FindGrfFmtCollByName( rColl.GetName() ); diff --git a/sw/source/core/doc/docglos.cxx b/sw/source/core/doc/docglos.cxx index 9593bf8039c8..801ed5bbc1f9 100644 --- a/sw/source/core/doc/docglos.cxx +++ b/sw/source/core/doc/docglos.cxx @@ -95,9 +95,7 @@ static void lcl_copyDocumentProperties( } } -/* -------------------------------------------------- - Description: inserts an AutoText block - --------------------------------------------------*/ +/// inserts an AutoText block bool SwDoc::InsertGlossary( SwTextBlocks& rBlock, const String& rEntry, SwPaM& rPaM, SwCrsrShell* pShell ) { diff --git a/sw/source/core/doc/doclay.cxx b/sw/source/core/doc/doclay.cxx index 6a5de2b48f2b..0f509a1d2861 100644 --- a/sw/source/core/doc/doclay.cxx +++ b/sw/source/core/doc/doclay.cxx @@ -110,15 +110,10 @@ static bool lcl_IsItemSet(const SwCntntNode & rNode, sal_uInt16 which) return bResult; } -/************************************************************************* -|* -|* SwDoc::MakeLayoutFmt() -|* -|* Description: Create a new format whose settings fit to the Request by -|* default. -|* The format is put into the respective format array. -|* If there already is a fitting format, it is returned instead. -|*************************************************************************/ +/** Create a new format whose settings fit to the Request by default. + + The format is put into the respective format array. + If there already is a fitting format, it is returned instead. */ SwFrmFmt *SwDoc::MakeLayoutFmt( RndStdIds eRequest, const SfxItemSet* pSet ) { SwFrmFmt *pFmt = 0; @@ -203,13 +198,7 @@ SwFrmFmt *SwDoc::MakeLayoutFmt( RndStdIds eRequest, const SfxItemSet* pSet ) return pFmt; } -/************************************************************************* -|* -|* SwDoc::DelLayoutFmt() -|* -|* Description: Deletes the denoted format and its content. -|* -|*************************************************************************/ +/// Deletes the denoted format and its content. void SwDoc::DelLayoutFmt( SwFrmFmt *pFmt ) { // A chain of frames needs to be merged, if necessary, @@ -337,17 +326,12 @@ void SwDoc::DelLayoutFmt( SwFrmFmt *pFmt ) SetModified(); } -/************************************************************************* -|* -|* SwDoc::CopyLayoutFmt() -|* -|* Copies the stated format (pSrc) to pDest and returns pDest. -|* If there's no pDest, it is created. -|* If the source format is located in another document, also copy correctly -|* in this case. -|* The Anchor attribute's position is always set to 0! -|* -|*************************************************************************/ +/** Copies the stated format (pSrc) to pDest and returns pDest. + + If there's no pDest, it is created. + If the source format is located in another document, also copy correctly + in this case. + The Anchor attribute's position is always set to 0! */ SwFrmFmt *SwDoc::CopyLayoutFmt( const SwFrmFmt& rSource, const SwFmtAnchor& rNewAnchor, bool bSetTxtFlyAtt, bool bMakeFrms ) @@ -872,8 +856,8 @@ SwFlyFrmFmt* SwDoc::MakeFlyAndMove( const SwPaM& rPam, const SfxItemSet& rSet, return pFmt; } -// Insert a DrawObject. -// The Object has to be already registered in the DrawModel. +/// Insert a DrawObject. +/// The Object has to be already registered in the DrawModel. SwDrawFrmFmt* SwDoc::Insert( const SwPaM &rRg, SdrObject& rDrawObj, const SfxItemSet* pFlyAttrSet, diff --git a/sw/source/core/doc/docnew.cxx b/sw/source/core/doc/docnew.cxx index 44428daa386d..b4e65b75687c 100644 --- a/sw/source/core/doc/docnew.cxx +++ b/sw/source/core/doc/docnew.cxx @@ -466,7 +466,7 @@ static void DeleteAndDestroy(SwGrfFmtColls& rFmts, int aStartIdx, int aEndIdx) rFmts.erase( rFmts.begin() + aStartIdx, rFmts.begin() + aEndIdx); } -/* +/** * Speciality: a member of the class SwDoc is located at * position 0 in the array of the Format and GDI objects. * This MUST not be destroyed using 'delete' in any case! @@ -928,9 +928,7 @@ SwModify* SwDoc::GetUnoCallBack() const } -/** SwDoc: - * Reading and writing of the layout cache. - *--------------------------------------------------*/ +/** SwDoc: Reading and writing of the layout cache. */ void SwDoc::ReadLayoutCache( SvStream& rStream ) { if( !mpLayoutCache ) diff --git a/sw/source/core/doc/docredln.cxx b/sw/source/core/doc/docredln.cxx index 5c492667ca36..5c2cdf00bfad 100644 --- a/sw/source/core/doc/docredln.cxx +++ b/sw/source/core/doc/docredln.cxx @@ -2523,7 +2523,7 @@ sal_uInt16 SwDoc::GetRedlineAuthor() return SW_MOD()->GetRedlineAuthor(); } -// Insert new author into the Table for the Readers etc. +/// Insert new author into the Table for the Readers etc. sal_uInt16 SwDoc::InsertRedlineAuthor( const String& rNew ) { return SW_MOD()->InsertRedlineAuthor(rNew); @@ -2540,10 +2540,10 @@ void SwDoc::UpdateRedlineAttr() } } -// Set comment text for the Redline, which is inserted later on via -// AppendRedline. Is used by Autoformat. -// A null pointer resets the mode. The pointer is not copied, so it -// needs to stay valid! +/// Set comment text for the Redline, which is inserted later on via +/// AppendRedline. Is used by Autoformat. +/// A null pointer resets the mode. The pointer is not copied, so it +/// needs to stay valid! void SwDoc::SetAutoFmtRedlineComment( const String* pTxt, sal_uInt16 nSeqNo ) { mbIsAutoFmtRedline = 0 != pTxt; @@ -2774,9 +2774,9 @@ void SwRedlineTbl::DeleteAndDestroy( sal_uInt16 nP, sal_uInt16 nL ) pSh->InvalidateWindows( SwRect( 0, 0, LONG_MAX, LONG_MAX ) ); } -// Find the next or preceding Redline with the same seq.no. -// We can limit the search using look ahead. -// 0 or USHRT_MAX searches the whole array. +/// Find the next or preceding Redline with the same seq.no. +/// We can limit the search using look ahead. +/// 0 or USHRT_MAX searches the whole array. sal_uInt16 SwRedlineTbl::FindNextOfSeqNo( sal_uInt16 nSttPos, sal_uInt16 nLookahead ) const { return nSttPos + 1 < (sal_uInt16)size() @@ -3020,8 +3020,8 @@ SwRedlineData::~SwRedlineData() delete pNext; } -// ExtraData is copied. The Pointer's ownership is thus NOT transferred -// to the Redline Object! +/// ExtraData is copied. The Pointer's ownership is thus NOT transferred +/// to the Redline Object! void SwRedlineData::SetExtraData( const SwRedlineExtraData* pData ) { delete pExtraData; @@ -3095,7 +3095,7 @@ SwRedline::~SwRedline() delete pRedlineData; } -// Do we have a valid Selection? +/// Do we have a valid Selection? sal_Bool SwRedline::HasValidRange() const { const SwNode* pPtNd = &GetPoint()->nNode.GetNode(), @@ -3267,12 +3267,8 @@ void SwRedline::InvalidateRange() // trigger the Layout } } -/************************************************************************* - * SwRedline::CalcStartEnd() - * Calculates the start and end position of the intersection rTmp and - * text node nNdIdx - *************************************************************************/ - +/** Calculates the start and end position of the intersection rTmp and + text node nNdIdx */ void SwRedline::CalcStartEnd( sal_uLong nNdIdx, sal_uInt16& nStart, sal_uInt16& nEnd ) const { const SwPosition *pRStt = Start(), *pREnd = End(); diff --git a/sw/source/core/doc/docsort.cxx b/sw/source/core/doc/docsort.cxx index 8be21d80ee92..9f8a11f3c29b 100644 --- a/sw/source/core/doc/docsort.cxx +++ b/sw/source/core/doc/docsort.cxx @@ -65,9 +65,7 @@ typedef SwSortElement* SwSortElementPtr; typedef ::boost::ptr_multiset<SwSortTxtElement> SwSortTxtElements; typedef ::boost::ptr_multiset<SwSortBoxElement> SwSortBoxElements; -/*-------------------------------------------------------------------- - Description: Construct a SortElement for the Sort - --------------------------------------------------------------------*/ +/// Construct a SortElement for the Sort void SwSortElement::Init( SwDoc* pD, const SwSortOptions& rOpt, FlatFndBox* pFltBx ) { @@ -191,9 +189,7 @@ double SwSortElement::GetValue( sal_uInt16 nKey ) const return StrToDouble( GetKey( nKey )); } -/*-------------------------------------------------------------------- - Description: SortingElement for Text - --------------------------------------------------------------------*/ +/// SortingElement for Text SwSortTxtElement::SwSortTxtElement(const SwNodeIndex& rPos) : nOrg(rPos.GetIndex()), aPos(rPos) { @@ -233,9 +229,7 @@ String SwSortTxtElement::GetKey(sal_uInt16 nId) const return rStr.Copy( nStart, nEnd-nStart ); } -/*-------------------------------------------------------------------- - Description: SortingElement for Tables - --------------------------------------------------------------------*/ +/// SortingElement for Tables SwSortBoxElement::SwSortBoxElement( sal_uInt16 nRC ) : nRow( nRC ) { @@ -245,9 +239,7 @@ SwSortBoxElement::~SwSortBoxElement() { } -/*-------------------------------------------------------------------- - Description: Get Key for a cell - --------------------------------------------------------------------*/ +/// Get Key for a cell String SwSortBoxElement::GetKey(sal_uInt16 nKey) const { const _FndBox* pFndBox; @@ -303,9 +295,7 @@ double SwSortBoxElement::GetValue( sal_uInt16 nKey ) const return nVal; } -/*-------------------------------------------------------------------- - Description: Sort Text in the Document - --------------------------------------------------------------------*/ +/// Sort Text in the Document bool SwDoc::SortText(const SwPaM& rPaM, const SwSortOptions& rOpt) { // Check if Frame is in the Text @@ -489,9 +479,7 @@ bool SwDoc::SortText(const SwPaM& rPaM, const SwSortOptions& rOpt) return true; } -/*-------------------------------------------------------------------- - Description: Sort Table in the Document - --------------------------------------------------------------------*/ +/// Sort Table in the Document bool SwDoc::SortTbl(const SwSelBoxes& rBoxes, const SwSortOptions& rOpt) { // Via SwDoc for Undo! @@ -620,9 +608,7 @@ bool SwDoc::SortTbl(const SwSelBoxes& rBoxes, const SwSortOptions& rOpt) return true; } -/*-------------------------------------------------------------------- - Description: Move a row - --------------------------------------------------------------------*/ +/// Move a row void MoveRow(SwDoc* pDoc, const FlatFndBox& rBox, sal_uInt16 nS, sal_uInt16 nT, SwMovedBoxes& rMovedList, SwUndoSort* pUD) { @@ -666,9 +652,7 @@ void MoveRow(SwDoc* pDoc, const FlatFndBox& rBox, sal_uInt16 nS, sal_uInt16 nT, } } -/*-------------------------------------------------------------------- - Description: Move a column - --------------------------------------------------------------------*/ +/// Move a column void MoveCol(SwDoc* pDoc, const FlatFndBox& rBox, sal_uInt16 nS, sal_uInt16 nT, SwMovedBoxes& rMovedList, SwUndoSort* pUD) { @@ -712,9 +696,7 @@ void MoveCol(SwDoc* pDoc, const FlatFndBox& rBox, sal_uInt16 nS, sal_uInt16 nT, } } -/*-------------------------------------------------------------------- - Description: Move a single Cell - --------------------------------------------------------------------*/ +/// Move a single Cell void MoveCell(SwDoc* pDoc, const SwTableBox* pSource, const SwTableBox* pTar, bool bMovedBefore, SwUndoSort* pUD) { @@ -767,9 +749,7 @@ void MoveCell(SwDoc* pDoc, const SwTableBox* pSource, const SwTableBox* pTar, pDoc->GetNodes().Delete( aTar, 1 ); } -/*-------------------------------------------------------------------- - Description: Generate two-dimensional array of FndBoxes - --------------------------------------------------------------------*/ +/// Generate two-dimensional array of FndBoxes FlatFndBox::FlatFndBox(SwDoc* pDocPtr, const _FndBox& rBox) : pDoc(pDocPtr), rBoxRef(rBox), @@ -803,9 +783,7 @@ FlatFndBox::~FlatFndBox() delete [] ppItemSets; } -/*-------------------------------------------------------------------- - Description: All Lines of a Box need to have same number of Boxes - --------------------------------------------------------------------*/ +/// All Lines of a Box need to have same number of Boxes bool FlatFndBox::CheckLineSymmetry(const _FndBox& rBox) { const _FndLines &rLines = rBox.GetLines(); @@ -827,10 +805,7 @@ bool FlatFndBox::CheckLineSymmetry(const _FndBox& rBox) return true; } -/*-------------------------------------------------------------------- - Description: Check Box for symmetry - All Boxes of a Line need to have same number of Lines - --------------------------------------------------------------------*/ +/// Check Box for symmetry (All Boxes of a Line need to have same number of Lines) bool FlatFndBox::CheckBoxSymmetry(const _FndLine& rLn) { const _FndBoxes &rBoxes = rLn.GetBoxes(); @@ -852,9 +827,7 @@ bool FlatFndBox::CheckBoxSymmetry(const _FndLine& rLn) return true; } -/*-------------------------------------------------------------------- - Description: Maximum count of Columns (Boxes) - --------------------------------------------------------------------*/ +/// Maximum count of Columns (Boxes) sal_uInt16 FlatFndBox::GetColCount(const _FndBox& rBox) { const _FndLines& rLines = rBox.GetLines(); @@ -879,9 +852,7 @@ sal_uInt16 FlatFndBox::GetColCount(const _FndBox& rBox) return nSum; } -/*-------------------------------------------------------------------- - Description: Maximum count of Rows (Lines) - --------------------------------------------------------------------*/ +/// Maximum count of Rows (Lines) sal_uInt16 FlatFndBox::GetRowCount(const _FndBox& rBox) { const _FndLines& rLines = rBox.GetLines(); @@ -903,9 +874,7 @@ sal_uInt16 FlatFndBox::GetRowCount(const _FndBox& rBox) return nLines; } -/*-------------------------------------------------------------------- - Description: Create a linear array of atmoic FndBoxes - --------------------------------------------------------------------*/ +/// Create a linear array of atmoic FndBoxes void FlatFndBox::FillFlat(const _FndBox& rBox, bool bLastBox) { bool bModRow = false; @@ -964,9 +933,7 @@ void FlatFndBox::FillFlat(const _FndBox& rBox, bool bLastBox) nRow = nOldRow; } -/*-------------------------------------------------------------------- - Description: Access a specific Cell - --------------------------------------------------------------------*/ +/// Access a specific Cell const _FndBox* FlatFndBox::GetBox(sal_uInt16 n_Col, sal_uInt16 n_Row) const { sal_uInt16 nOff = n_Row * nCols + n_Col; diff --git a/sw/source/core/doc/doctxm.cxx b/sw/source/core/doc/doctxm.cxx index a706b180f349..ad3d8375d348 100644 --- a/sw/source/core/doc/doctxm.cxx +++ b/sw/source/core/doc/doctxm.cxx @@ -115,9 +115,7 @@ sal_uInt16 SwDoc::GetTOIKeys( SwTOIKeyType eTyp, std::vector<String>& rArr ) con return rArr.size(); } -/*-------------------------------------------------------------------- - Description: Get current table of contents Mark. - --------------------------------------------------------------------*/ +/// Get current table of contents Mark. sal_uInt16 SwDoc::GetCurTOXMark( const SwPosition& rPos, SwTOXMarks& rArr ) const { @@ -155,9 +153,7 @@ sal_uInt16 SwDoc::GetCurTOXMark( const SwPosition& rPos, return rArr.size(); } -/*-------------------------------------------------------------------- - Description: Delete table of contents Mark - --------------------------------------------------------------------*/ +/// Delete table of contents Mark void SwDoc::DeleteTOXMark( const SwTOXMark* pTOXMark ) { // hole den TextNode und @@ -189,9 +185,7 @@ void SwDoc::DeleteTOXMark( const SwTOXMark* pTOXMark ) SetModified(); } -/*-------------------------------------------------------------------- - Description: Travel between table of content Marks - --------------------------------------------------------------------*/ +/// Travel between table of content Marks class CompareNodeCntnt { sal_uLong nNode; @@ -426,9 +420,7 @@ const SwTOXBaseSection* SwDoc::InsertTableOf( sal_uLong nSttNd, sal_uLong nEndNd return pNewSection; } -/*-------------------------------------------------------------------- - Description: Get current table of contents - --------------------------------------------------------------------*/ +/// Get current table of contents const SwTOXBase* SwDoc::GetCurTOX( const SwPosition& rPos ) const { const SwNode& rNd = rPos.nNode.GetNode(); @@ -498,9 +490,7 @@ void SwDoc::SetDefaultTOXBase(const SwTOXBase& rBase) (*prBase) = new SwTOXBase(rBase); } -/*-------------------------------------------------------------------- - Description: Delete table of contents - --------------------------------------------------------------------*/ +/// Delete table of contents bool SwDoc::DeleteTOX( const SwTOXBase& rTOXBase, bool bDelNodes ) { // We only delete the TOX, not the Nodes @@ -589,9 +579,7 @@ bool SwDoc::DeleteTOX( const SwTOXBase& rTOXBase, bool bDelNodes ) return bRet; } -/*-------------------------------------------------------------------- - Description: Manage table of content types - --------------------------------------------------------------------*/ +/// Manage table of content types sal_uInt16 SwDoc::GetTOXTypeCount(TOXTypes eTyp) const { sal_uInt16 nCnt = 0; @@ -748,9 +736,7 @@ bool SwTOXBaseSection::SetPosAtStartEnd( SwPosition& rPos, bool bAtStart ) const return bRet; } -/*-------------------------------------------------------------------- - Description: Collect table of contents content - --------------------------------------------------------------------*/ +/// Collect table of contents content void SwTOXBaseSection::Update(const SfxItemSet* pAttr, const bool _bNewTOX )//swmodtest 080307 { @@ -1070,9 +1056,7 @@ void SwTOXBaseSection::InsertAlphaDelimitter( const SwTOXInternational& rIntl ) } } -/*-------------------------------------------------------------------- - Description: Evaluate Template - --------------------------------------------------------------------*/ +/// Evaluate Template SwTxtFmtColl* SwTOXBaseSection::GetTxtFmtColl( sal_uInt16 nLevel ) { SwDoc* pDoc = (SwDoc*)GetFmt()->GetDoc(); @@ -1120,9 +1104,7 @@ SwTxtFmtColl* SwTOXBaseSection::GetTxtFmtColl( sal_uInt16 nLevel ) return pColl; } -/*-------------------------------------------------------------------- - Description: Create from Marks - --------------------------------------------------------------------*/ +/// Create from Marks void SwTOXBaseSection::UpdateMarks( const SwTOXInternational& rIntl, const SwTxtNode* pOwnChapterNode ) { @@ -1195,9 +1177,7 @@ void SwTOXBaseSection::UpdateMarks( const SwTOXInternational& rIntl, } } -/*-------------------------------------------------------------------- - Description: Generate table of contents from outline - --------------------------------------------------------------------*/ +/// Generate table of contents from outline void SwTOXBaseSection::UpdateOutline( const SwTxtNode* pOwnChapterNode ) { SwDoc* pDoc = (SwDoc*)GetFmt()->GetDoc(); @@ -1222,9 +1202,7 @@ void SwTOXBaseSection::UpdateOutline( const SwTxtNode* pOwnChapterNode ) } } -/*-------------------------------------------------------------------- - Description: Generate table of contents from template areas - --------------------------------------------------------------------*/ +/// Generate table of contents from template areas void SwTOXBaseSection::UpdateTemplate( const SwTxtNode* pOwnChapterNode ) { SwDoc* pDoc = (SwDoc*)GetFmt()->GetDoc(); @@ -1263,9 +1241,7 @@ void SwTOXBaseSection::UpdateTemplate( const SwTxtNode* pOwnChapterNode ) } } -/* -------------------------------------------------- - Description: Generate content from sequence fields - --------------------------------------------------*/ +/// Generate content from sequence fields void SwTOXBaseSection::UpdateSequence( const SwTxtNode* pOwnChapterNode ) { SwDoc* pDoc = (SwDoc*)GetFmt()->GetDoc(); @@ -1487,9 +1463,7 @@ void SwTOXBaseSection::UpdateCntnt( SwTOXElement eMyType, } } -/*-------------------------------------------------------------------- - Description: Collect table entries - --------------------------------------------------------------------*/ +/// Collect table entries void SwTOXBaseSection::UpdateTable( const SwTxtNode* pOwnChapterNode ) { SwDoc* pDoc = (SwDoc*)GetFmt()->GetDoc(); @@ -1537,10 +1511,8 @@ void SwTOXBaseSection::UpdateTable( const SwTxtNode* pOwnChapterNode ) } } -/*-------------------------------------------------------------------- - Description: Generate String according to the Form and remove the - special characters 0-31 and 255 - --------------------------------------------------------------------*/ +/// Generate String according to the Form and remove the +/// special characters 0-31 and 255. static String lcl_GetNumString( const SwTOXSortTabBase& rBase, bool bUsePrefix, sal_uInt8 nLevel ) { String sRet; @@ -1559,10 +1531,8 @@ static String lcl_GetNumString( const SwTOXSortTabBase& rBase, bool bUsePrefix, return sRet; } -/*-------------------------------------------------------------------- - Description: Generate String with newlines changed to spaces, - consecutive spaces changed to a single space, and trailing space removed. - --------------------------------------------------------------------*/ +/// Generate String with newlines changed to spaces, consecutive spaces changed +/// to a single space, and trailing space removed. String lcl_RemoveLineBreaks( String sRet ) { xub_StrLen nOffset = 0; @@ -1869,9 +1839,7 @@ void SwTOXBaseSection::GenerateText( sal_uInt16 nArrayIdx, } } -/*-------------------------------------------------------------------- - Description: Calculate PageNumber and insert after formatting - --------------------------------------------------------------------*/ +/// Calculate PageNumber and insert after formatting void SwTOXBaseSection::UpdatePageNum() { if( aSortArr.empty() ) @@ -1984,10 +1952,8 @@ void SwTOXBaseSection::UpdatePageNum() aSortArr.clear(); } -/*-------------------------------------------------------------------- - Description: Replace the PageNumber place holders - --------------------------------------------------------------------*/ -// search for the page no in the array of main entry page numbers +/// Replace the PageNumber place holders. Search for the page no. in the array +/// of main entry page numbers. static bool lcl_HasMainEntry( const std::vector<sal_uInt16>* pMainEntryNums, sal_uInt16 nToFind ) { for(sal_uInt16 i = 0; pMainEntryNums && i < pMainEntryNums->size(); ++i) @@ -2255,9 +2221,7 @@ void SwTOXBaseSection::InsertSorted(SwTOXSortTabBase* pNew) aSortArr.insert(aSortArr.begin()+i, pNew); } -/*-------------------------------------------------------------------- - Description: Find Key Range and insert if possible - --------------------------------------------------------------------*/ +/// Find Key Range and insert if possible Range SwTOXBaseSection::GetKeyRange(const String& rStr, const String& rStrReading, const SwTOXSortTabBase& rNew, sal_uInt16 nLevel, const Range& rRange ) diff --git a/sw/source/core/doc/htmltbl.cxx b/sw/source/core/doc/htmltbl.cxx index 6260ec317f90..53be8e01a11d 100644 --- a/sw/source/core/doc/htmltbl.cxx +++ b/sw/source/core/doc/htmltbl.cxx @@ -1050,10 +1050,14 @@ void SwHTMLTableLayout::AutoLayoutPass1() delete pConstraints; } -// nAbsAvail is the available space in TWIPS. -// nRelAvail is the available space related to USHRT_MAX or 0 -// nAbsSpace is the fraction of nAbsAvail, which is reserved by the surrounding -// cell for the border and the distance to the paragraph. +//TODO: provide documentation +/** + + @param nAbsAvail available space in TWIPS. + @param nRelAvail available space related to USHRT_MAX or 0 + @param nAbsSpace fraction of nAbsAvail, which is reserved by the surrounding + cell for the border and the distance to the paragraph. +*/ void SwHTMLTableLayout::AutoLayoutPass2( sal_uInt16 nAbsAvail, sal_uInt16 nRelAvail, sal_uInt16 nAbsLeftSpace, sal_uInt16 nAbsRightSpace, diff --git a/sw/source/core/doc/notxtfrm.cxx b/sw/source/core/doc/notxtfrm.cxx index 23252d6ebe07..84e9b9a2d0ef 100644 --- a/sw/source/core/doc/notxtfrm.cxx +++ b/sw/source/core/doc/notxtfrm.cxx @@ -151,9 +151,7 @@ SwNoTxtFrm::SwNoTxtFrm(SwNoTxtNode * const pNode, SwFrm* pSib ) InitCtor(); } -// Initialization: Currently add the Frame to the Cache - - +/// Initialization: Currently add the Frame to the Cache void SwNoTxtFrm::InitCtor() { mnType = FRMC_NOTXT; @@ -330,21 +328,13 @@ void SwNoTxtFrm::Paint(SwRect const& rRect, SwPrintData const*const) const SfxProgress::LeaveLock(); } -/************************************************************************* -|* -|* void lcl_CalcRect( Point & aPt, Size & aDim, -|* sal_uInt16 nMirror ) -|* -|* Calculate the position and the size of the graphic in the Frame, -|* corresponding to the current graphic attributes -|* -|* Point& the position in the Frame (also returned) -|* Size& the graphic's size (also returned) -|* nMirror the current mirror attribute -|* -*************************************************************************/ - +/** Calculate the position and the size of the graphic in the Frame, + corresponding to the current graphic attributes + @param Point the position in the Frame (also returned) + @param Size the graphic's size (also returned) + @param nMirror the current mirror attribute +*/ static void lcl_CalcRect( Point& rPt, Size& rDim, sal_uInt16 nMirror ) { if( nMirror == RES_MIRROR_GRAPH_VERT || nMirror == RES_MIRROR_GRAPH_BOTH ) @@ -360,14 +350,7 @@ static void lcl_CalcRect( Point& rPt, Size& rDim, sal_uInt16 nMirror ) } } -/************************************************************************* -|* -|* void SwNoTxtFrm::GetGrfArea() -|* -|* Calculate the Bitmap's position and the size within the passed rectangle -|* -*************************************************************************/ - +/** Calculate the Bitmap's position and the size within the passed rectangle */ void SwNoTxtFrm::GetGrfArea( SwRect &rRect, SwRect* pOrigRect, bool ) const { @@ -485,15 +468,7 @@ void SwNoTxtFrm::GetGrfArea( SwRect &rRect, SwRect* pOrigRect, } } -/************************************************************************* -|* -|* Size SwNoTxtFrm::GetSize() -|* -|* By returning the surrounding Fly's size which equals the graphic's size -|* -*************************************************************************/ - - +/** By returning the surrounding Fly's size which equals the graphic's size */ const Size& SwNoTxtFrm::GetSize() const { // Return the Frame's size @@ -532,15 +507,7 @@ void SwNoTxtFrm::MakeAll() } } -/************************************************************************* -|* -|* SwNoTxtFrm::Format() -|* -|* Calculate the Bitmap's site, if needed -|* -*************************************************************************/ - - +/** Calculate the Bitmap's site, if needed */ void SwNoTxtFrm::Format( const SwBorderAttrs * ) { const Size aNewSize( GetSize() ); @@ -856,12 +823,13 @@ bool paintUsingPrimitivesHelper( return false; } -// Paint the graphic. -// We require either a QuickDraw-Bitmap or a graphic here. If we do not have -// either, we return a replacement. -// delete unused 3rd parameter. -// use aligned rectangle for drawing graphic. -// pixel-align coordinations for drawing graphic. +/** Paint the graphic. + + We require either a QuickDraw-Bitmap or a graphic here. If we do not have + either, we return a replacement. + + @todo use aligned rectangle for drawing graphic. + @todo pixel-align coordinations for drawing graphic. */ void SwNoTxtFrm::PaintPicture( OutputDevice* pOut, const SwRect &rGrfArea ) const { ViewShell* pShell = getRootFrm()->GetCurrShell(); diff --git a/sw/source/core/doc/number.cxx b/sw/source/core/doc/number.cxx index 6efe572e9a96..c85ec4180c0d 100644 --- a/sw/source/core/doc/number.cxx +++ b/sw/source/core/doc/number.cxx @@ -841,11 +841,11 @@ String SwNumRule::MakeRefNumString( const SwNodeNum& rNodeNum, return aRefNumStr; } -// ----- Copy method of SwNumRule ------ +/** Copy method of SwNumRule - // A kind of copy constructor, so that the num formats are attached - // to the right CharFormats of a Document. - // Copies the NumFormats and returns itself. + A kind of copy constructor, so that the num formats are attached to the + right CharFormats of a Document. + Copies the NumFormats and returns itself. */ SwNumRule& SwNumRule::CopyNumRule( SwDoc* pDoc, const SwNumRule& rNumRule ) { for( sal_uInt16 n = 0; n < MAXLEVEL; ++n ) @@ -924,8 +924,7 @@ void SwNumRule::SetInvalidRule(sal_Bool bFlag) bInvalidRuleFlag = bFlag; } - -// change indent of all list levels by given difference +/// change indent of all list levels by given difference void SwNumRule::ChangeIndent( const short nDiff ) { for ( sal_uInt16 i = 0; i < MAXLEVEL; ++i ) @@ -964,7 +963,7 @@ void SwNumRule::ChangeIndent( const short nDiff ) SetInvalidRule( sal_True ); } -// set indent of certain list level to given value +/// set indent of certain list level to given value void SwNumRule::SetIndent( const short nNewIndent, const sal_uInt16 nListLevel ) { @@ -992,8 +991,8 @@ void SwNumRule::SetIndent( const short nNewIndent, SetInvalidRule( sal_True ); } -// set indent of first list level to given value and change other list level's -// indents accordingly +/// set indent of first list level to given value and change other list level's +/// indents accordingly void SwNumRule::SetIndentOfFirstListLevelAndChangeOthers( const short nNewIndent ) { SwNumFmt aTmpNumFmt( Get(0) ); @@ -1080,10 +1079,7 @@ void SwNumRule::RemoveParagraphStyle( SwTxtFmtColl& rTxtFmtColl ) namespace numfunc { - /** class containing default bullet list configuration data - - @author OD - */ + /** class containing default bullet list configuration data */ class SwDefBulletConfig : private utl::ConfigItem { public: @@ -1116,37 +1112,22 @@ namespace numfunc SwDefBulletConfig(); ~SwDefBulletConfig(); - private: - /** sets internal default bullet configuration data to default values - - @author OD - */ + private: + /** sets internal default bullet configuration data to default values */ void SetToDefault(); - /** returns sequence of default bullet configuration property names - - @author OD - */ + /** returns sequence of default bullet configuration property names */ uno::Sequence<OUString> GetPropNames() const; /** loads default bullet configuration properties and applies - values to internal data - - @author OD - */ + values to internal data */ void LoadConfig(); - /** initialize font instance for default bullet list - - @author OD - */ + /** initialize font instance for default bullet list */ void InitFont(); - /** catches notification about changed default bullet configuration data - - @author OD - */ + /** catches notification about changed default bullet configuration data */ virtual void Notify( const uno::Sequence<OUString>& aPropertyNames ); virtual void Commit(); @@ -1336,8 +1317,6 @@ namespace numfunc regarding lists and list items. configuration item about behavior of <TAB>/<SHIFT-TAB>-key at first position of first list item - - @author OD */ class SwNumberingUIBehaviorConfig : private utl::ConfigItem { @@ -1353,28 +1332,16 @@ namespace numfunc private: - /** sets internal configuration data to default values - - @author OD - */ + /** sets internal configuration data to default values */ void SetToDefault(); - /** returns sequence of configuration property names - - @author OD - */ + /** returns sequence of configuration property names */ com::sun::star::uno::Sequence<OUString> GetPropNames() const; - /** loads configuration properties and applies values to internal data - - @author OD - */ + /** loads configuration properties and applies values to internal data */ void LoadConfig(); - /** catches notification about changed configuration data - - @author OD - */ + /** catches notification about changed configuration data */ virtual void Notify( const com::sun::star::uno::Sequence<OUString>& aPropertyNames ); virtual void Commit(); diff --git a/sw/source/core/doc/poolfmt.cxx b/sw/source/core/doc/poolfmt.cxx index 6d4a0ea1584a..245efdb95be0 100644 --- a/sw/source/core/doc/poolfmt.cxx +++ b/sw/source/core/doc/poolfmt.cxx @@ -289,12 +289,10 @@ static void lcl_SetNumBul( SwDoc* pDoc, SwTxtFmtColl* pColl, pColl->SetNextTxtFmtColl( *pDoc->GetTxtCollFromPool( nNxt )); } - - -// Return the AutoCollection by it's Id. If it doesn't -// exist yet, create it. -// If the String pointer is defined, then only query for -// the Attribute descriptions. It doesn't create a style! +/// Return the AutoCollection by it's Id. If it doesn't +/// exist yet, create it. +/// If the String pointer is defined, then only query for +/// the Attribute descriptions. It doesn't create a style! SvxFrameDirection GetDefaultFrameDirection(sal_uLong nLanguage) { SvxFrameDirection eResult = (MsLangId::isRightToLeft( static_cast<LanguageType>(nLanguage)) ? @@ -1036,9 +1034,7 @@ SwTxtFmtColl* SwDoc::GetTxtCollFromPool( sal_uInt16 nId, bool bRegardLanguage ) return pNewColl; } - - -// Check if this AutoCollection is already/still in use in this Document +/// Check if this AutoCollection is already/still in use in this Document bool SwDoc::IsPoolTxtCollUsed( sal_uInt16 nId ) const { OSL_ENSURE( @@ -1066,8 +1062,8 @@ bool SwDoc::IsPoolTxtCollUsed( sal_uInt16 nId ) const return !pNewColl->GetInfo( aGetHt ); } -// Return the AutomaticFormat with the supplied Id. If it doesn't -// exist, create it. +/// Return the AutomaticFormat with the supplied Id. If it doesn't +/// exist, create it. SwFmt* SwDoc::GetFmtFromPool( sal_uInt16 nId ) { SwFmt *pNewFmt = 0; @@ -1357,7 +1353,7 @@ SwCharFmt* SwDoc::GetCharFmtFromPool( sal_uInt16 nId ) return (SwCharFmt*)GetFmtFromPool( nId ); } -// Check if this AutoCollection is already/still in use +/// Check if this AutoCollection is already/still in use bool SwDoc::IsPoolFmtUsed( sal_uInt16 nId ) const { SwFmt *pNewFmt = 0; @@ -2260,9 +2256,7 @@ SwNumRule* SwDoc::GetNumRuleFromPool( sal_uInt16 nId ) return pNewRule; } - - -// Check if this AutoCollection is already/still in use in this Document +/// Check if this AutoCollection is already/still in use in this Document bool SwDoc::IsPoolPageDescUsed( sal_uInt16 nId ) const { OSL_ENSURE( RES_POOLPAGE_BEGIN <= nId && nId < RES_POOLPAGE_END, diff --git a/sw/source/core/doc/tblcpy.cxx b/sw/source/core/doc/tblcpy.cxx index dd22b600ed9f..f66faa9c2d7a 100644 --- a/sw/source/core/doc/tblcpy.cxx +++ b/sw/source/core/doc/tblcpy.cxx @@ -499,15 +499,11 @@ namespace } } -// --------------------------------------------------------------- - -// Copy Table into this Box. -// Copy all Boxes of a Line into the corresponding Boxes. The old -// content is deleted by doing this. -// If no Box is left the remaining content goes to the Box of -// a "BaseLine". -// If there's no Line anymore, put it also into the last Box -// of a "BaseLine". +/** Copy Table into this Box. + Copy all Boxes of a Line into the corresponding Boxes. The old content + is deleted by doing this. + If no Box is left the remaining content goes to the Box of a "BaseLine". + If there's no Line anymore, put it also into the last Box of a "BaseLine". */ static void lcl_CpyBox( const SwTable& rCpyTbl, const SwTableBox* pCpyBox, SwTable& rDstTbl, SwTableBox* pDstBox, bool bDelCntnt, SwUndoTblCpyTbl* pUndo ) @@ -718,13 +714,11 @@ sal_Bool SwTable::InsNewTable( const SwTable& rCpyTbl, const SwSelBoxes& rSelBox return sal_True; } -// Copy Table into this Box. -// Copy all Boxes of a Line into the corresponding Boxes. The old -// content is deleted by doing this. -// If no Box is left the remaining content goes to the Box of -// a "BaseLine". -// If there's no Line anymore, put it also into the last Box -// of a "BaseLine". +/** Copy Table into this Box. + Copy all Boxes of a Line into the corresponding Boxes. The old content is + deleted by doing this. + If no Box is left the remaining content goes to the Box of a "BaseLine". + If there's no Line anymore, put it also into the last Box of a "BaseLine". */ sal_Bool SwTable::InsTable( const SwTable& rCpyTbl, const SwNodeIndex& rSttBox, SwUndoTblCpyTbl* pUndo ) { |