summaryrefslogtreecommitdiff
path: root/sw/inc
diff options
context:
space:
mode:
authorAbdulmajeed Al-Abaulrazzaq <aalabdulrazzaq@kacst.edu.sa>2012-09-11 15:16:03 +0300
committerMichael Stahl <mstahl@redhat.com>2012-09-11 17:54:21 +0000
commit4ed62ddb01e4ecff9de01246ea4c040f007c1196 (patch)
treeea75c2b5e5ef8b01d6cc1aafdccc10f29a7e982c /sw/inc
parenta8a15bd95c4fda67c6785036bfbf50f94a749496 (diff)
Modifying comments to meet doxygen standards
Change-Id: I363ce532c7d11e798c2a5cc67b1b7893dcd0a389 Reviewed-on: https://gerrit.libreoffice.org/596 Reviewed-by: Michael Stahl <mstahl@redhat.com> Tested-by: Michael Stahl <mstahl@redhat.com>
Diffstat (limited to 'sw/inc')
-rw-r--r--sw/inc/fmtrfmrk.hxx4
-rw-r--r--sw/inc/fmtruby.hxx12
-rw-r--r--sw/inc/fmturl.hxx16
-rw-r--r--sw/inc/fmtwrapinfluenceonobjpos.hxx6
-rw-r--r--sw/inc/format.hxx80
-rw-r--r--sw/inc/frmfmt.hxx56
-rw-r--r--sw/inc/hhcwrp.hxx34
-rw-r--r--sw/inc/hints.hxx34
-rw-r--r--sw/inc/htmltbl.hxx162
-rw-r--r--sw/inc/iodetect.hxx36
-rw-r--r--sw/inc/istyleaccess.hxx10
-rw-r--r--sw/inc/lineinfo.hxx28
-rw-r--r--sw/inc/ndarr.hxx122
-rw-r--r--sw/inc/ndgrf.hxx46
-rw-r--r--sw/inc/ndhints.hxx56
-rw-r--r--sw/inc/ndole.hxx24
-rw-r--r--sw/inc/ndtxt.hxx170
17 files changed, 448 insertions, 448 deletions
diff --git a/sw/inc/fmtrfmrk.hxx b/sw/inc/fmtrfmrk.hxx
index 9c4ea3ca3104..0ed9344bd592 100644
--- a/sw/inc/fmtrfmrk.hxx
+++ b/sw/inc/fmtrfmrk.hxx
@@ -41,7 +41,7 @@ class SwFmtRefMark : public SfxPoolItem
friend class SwTxtRefMark;
SwTxtRefMark* pTxtAttr;
- // Protected CopyCtor.
+ /// Protected CopyCtor.
SwFmtRefMark& operator=(const SwFmtRefMark& rRefMark);
rtl::OUString aRefName;
@@ -50,7 +50,7 @@ public:
SwFmtRefMark( const SwFmtRefMark& rRefMark );
~SwFmtRefMark( );
- // "Pure virtual methods" of SfxPoolItem.
+ /// "Pure virtual methods" of SfxPoolItem.
virtual int operator==( const SfxPoolItem& ) const;
virtual SfxPoolItem* Clone( SfxItemPool* pPool = 0 ) const;
diff --git a/sw/inc/fmtruby.hxx b/sw/inc/fmtruby.hxx
index bee5b6a3137b..d8b7448810c8 100644
--- a/sw/inc/fmtruby.hxx
+++ b/sw/inc/fmtruby.hxx
@@ -38,12 +38,12 @@ class SW_DLLPUBLIC SwFmtRuby : public SfxPoolItem
{
friend class SwTxtRuby;
- String sRubyTxt; // The ruby txt.
- String sCharFmtName; // Name of the charformat.
- SwTxtRuby* pTxtAttr; // The TextAttribute.
- sal_uInt16 nCharFmtId; // PoolId of the charformat.
- sal_uInt16 nPosition; // Position of the Ruby-character.
- sal_uInt16 nAdjustment; // Specific adjustment of the Ruby-ch.
+ String sRubyTxt; ///< The ruby txt.
+ String sCharFmtName; ///< Name of the charformat.
+ SwTxtRuby* pTxtAttr; ///< The TextAttribute.
+ sal_uInt16 nCharFmtId; ///< PoolId of the charformat.
+ sal_uInt16 nPosition; ///< Position of the Ruby-character.
+ sal_uInt16 nAdjustment; ///< Specific adjustment of the Ruby-ch.
public:
SwFmtRuby( const String& rRubyTxt );
diff --git a/sw/inc/fmturl.hxx b/sw/inc/fmturl.hxx
index 667f0f1d8cac..fe9ba12de902 100644
--- a/sw/inc/fmturl.hxx
+++ b/sw/inc/fmturl.hxx
@@ -40,24 +40,24 @@ class IntlWrapper;
class SW_DLLPUBLIC SwFmtURL: public SfxPoolItem
{
- String sTargetFrameName; // Target frame for URL.
- String sURL; // Simple URL.
- String sName; // Name of the anchor.
- ImageMap *pMap; // ClientSide images.
+ String sTargetFrameName; ///< Target frame for URL.
+ String sURL; ///< Simple URL.
+ String sName; ///< Name of the anchor.
+ ImageMap *pMap; ///< ClientSide images.
- sal_Bool bIsServerMap; // A ServerSideImageMap with the URL.
+ sal_Bool bIsServerMap; ///< A ServerSideImageMap with the URL.
SwFmtURL& operator=( const SwFmtURL& );
public:
SwFmtURL();
- // @@@ copy construction allowed, but assigment is not? @@@
+ /// @@@ copy construction allowed, but assigment is not? @@@
SwFmtURL( const SwFmtURL& );
virtual ~SwFmtURL();
- // "Pure virtual methods" of SfxPoolItem.
+ /// "Pure virtual methods" of SfxPoolItem.
virtual int operator==( const SfxPoolItem& ) const;
virtual SfxPoolItem* Clone( SfxItemPool* pPool = 0 ) const;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
@@ -70,7 +70,7 @@ public:
void SetTargetFrameName( const String& rStr ) { sTargetFrameName = rStr; }
void SetURL( const String &rURL, sal_Bool bServerMap );
- void SetMap( const ImageMap *pM ); // Pointer will be copied.
+ void SetMap( const ImageMap *pM ); ///< Pointer will be copied.
const String &GetTargetFrameName()const { return sTargetFrameName; }
const String &GetURL() const { return sURL; }
diff --git a/sw/inc/fmtwrapinfluenceonobjpos.hxx b/sw/inc/fmtwrapinfluenceonobjpos.hxx
index 91418b49e24d..dc9480496d93 100644
--- a/sw/inc/fmtwrapinfluenceonobjpos.hxx
+++ b/sw/inc/fmtwrapinfluenceonobjpos.hxx
@@ -52,17 +52,17 @@ public:
SwFmtWrapInfluenceOnObjPos& operator=(
const SwFmtWrapInfluenceOnObjPos& _rSource );
- // pure virtual methods of class <SfxPoolItem>
+ /// pure virtual methods of class <SfxPoolItem>
virtual int operator==( const SfxPoolItem& _rAttr ) const;
virtual SfxPoolItem* Clone( SfxItemPool* pPool = 0 ) const;
virtual bool QueryValue( com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
virtual bool PutValue( const com::sun::star::uno::Any& rVal, sal_uInt8 nMemberId = 0 );
- // direct accessors to data
+ /// direct accessors to data
void SetWrapInfluenceOnObjPos( sal_Int16 _nWrapInfluenceOnPosition );
// #i35017# - add parameter <_bIterativeAsOnceConcurrent>
- // to control, if value <ITERATIVE> has to be treated as <ONCE_CONCURRENT>
+ /// to control, if value <ITERATIVE> has to be treated as <ONCE_CONCURRENT>
sal_Int16 GetWrapInfluenceOnObjPos(
const bool _bIterativeAsOnceConcurrent = false ) const;
};
diff --git a/sw/inc/format.hxx b/sw/inc/format.hxx
index 415cb3055b60..883165f62cf3 100644
--- a/sw/inc/format.hxx
+++ b/sw/inc/format.hxx
@@ -30,8 +30,8 @@
#include <tools/solar.h>
#include "swdllapi.h"
-#include <swatrset.hxx> // For SfxItemPool/-Set, Attr forward decl.
-#include <calbck.hxx> // For SwModify.
+#include <swatrset.hxx> ///< For SfxItemPool/-Set, Attr forward decl.
+#include <calbck.hxx> ///< For SwModify.
#include <hintids.hxx>
class IDocumentSettingAccess;
@@ -49,18 +49,18 @@ class SW_DLLPUBLIC SwFmt : public SwModify
SwAttrSet aSet;
sal_uInt16 nWhichId;
- sal_uInt16 nFmtId; // Format-ID for reading / writing.
- sal_uInt16 nPoolFmtId; // Id for "automatically" created formats.
- // (is not hard attribution!!!)
- sal_uInt16 nPoolHelpId; // HelpId for this Pool-style.
- sal_uInt8 nPoolHlpFileId; // FilePos to Doc to these style helps.
- sal_Bool bWritten : 1; // TRUE: already written.
- sal_Bool bAutoFmt : 1; // FALSE: it is a template.
- // default is true!
- sal_Bool bFmtInDTOR : 1; // TRUE: Format becomes deleted. In order to be able
- // to recognize this in FmtChg-message!!
- sal_Bool bAutoUpdateFmt : 1;// TRUE: Set attributes of a whole paragraph
- // at format (UI-side!).
+ sal_uInt16 nFmtId; ///< Format-ID for reading / writing.
+ sal_uInt16 nPoolFmtId; /**< Id for "automatically" created formats.
+ (is not hard attribution!!!) */
+ sal_uInt16 nPoolHelpId; ///< HelpId for this Pool-style.
+ sal_uInt8 nPoolHlpFileId; ///< FilePos to Doc to these style helps.
+ sal_Bool bWritten : 1; ///< TRUE: already written.
+ sal_Bool bAutoFmt : 1; /**< FALSE: it is a template.
+ default is true! */
+ sal_Bool bFmtInDTOR : 1; /**< TRUE: Format becomes deleted. In order to be able
+ to recognize this in FmtChg-message!! */
+ sal_Bool bAutoUpdateFmt : 1;/**< TRUE: Set attributes of a whole paragraph
+ at format (UI-side!). */
protected:
SwFmt( SwAttrPool& rPool, const sal_Char* pFmtNm,
@@ -71,29 +71,29 @@ protected:
virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem* pNewValue );
public:
- TYPEINFO(); // Already in base class Client.
+ TYPEINFO(); ///< Already in base class Client.
virtual ~SwFmt();
SwFmt &operator=(const SwFmt&);
- // for Querying of Writer-functions.
+ /// for Querying of Writer-functions.
sal_uInt16 Which() const { return nWhichId; }
- // Query format information.
+ /// Query format information.
virtual sal_Bool GetInfo( SfxPoolItem& ) const;
- // Copy attributes even among documents.
+ /// Copy attributes even among documents.
void CopyAttrs( const SwFmt&, sal_Bool bReplace=sal_True );
- // Delete all attributes that are not in rFmt.
+ /// Delete all attributes that are not in rFmt.
void DelDiffs( const SfxItemSet& rSet );
void DelDiffs( const SwFmt& rFmt ) { DelDiffs( rFmt.GetAttrSet() ); }
- // 0 is Default.
+ /// 0 is Default.
sal_Bool SetDerivedFrom(SwFmt *pDerivedFrom = 0);
- // If bInParents is FALSE, search only in this format for attribute.
+ /// If bInParents is FALSE, search only in this format for attribute.
inline const SfxPoolItem& GetFmtAttr( sal_uInt16 nWhich,
sal_Bool bInParents = sal_True ) const;
inline SfxItemState GetItemState( sal_uInt16 nWhich, sal_Bool bSrchInParent = sal_True,
@@ -102,8 +102,8 @@ public:
virtual sal_Bool SetFmtAttr( const SfxItemSet& rSet );
virtual sal_Bool ResetFmtAttr( sal_uInt16 nWhich1, sal_uInt16 nWhich2 = 0 );
- // Takes all hints from Delta-Array,
- // returns count of deleted hints.
+ /** Takes all hints from Delta-Array,
+ @return count of deleted hints. */
virtual sal_uInt16 ResetAllFmtAttr();
inline SwFmt* DerivedFrom() const { return (SwFmt*)GetRegisteredIn(); }
@@ -114,11 +114,11 @@ public:
inline void SetName( const sal_Char* pNewName,
sal_Bool bBroadcast=sal_False);
- // For querying the attribute array.
+ /// For querying the attribute array.
inline const SwAttrSet& GetAttrSet() const { return aSet; }
- // Das Doc wird jetzt am SwAttrPool gesetzt. Dadurch hat man es immer
- // im Zugriff.
+ /** Das Doc wird jetzt am SwAttrPool gesetzt. Dadurch hat man es immer
+ im Zugriff. */
const SwDoc *GetDoc() const { return aSet.GetDoc(); }
SwDoc *GetDoc() { return aSet.GetDoc(); }
@@ -142,39 +142,39 @@ public:
/// Gives access to the chart data-provider.
IDocumentChartDataProviderAccess* getIDocumentChartDataProviderAccess();
- // Get and set Pool style IDs.
+ /// Get and set Pool style IDs.
sal_uInt16 GetPoolFmtId() const { return nPoolFmtId; }
void SetPoolFmtId( sal_uInt16 nId ) { nPoolFmtId = nId; }
- // Get and set Help-IDs for document templates.
+ /// Get and set Help-IDs for document templates.
sal_uInt16 GetPoolHelpId() const { return nPoolHelpId; }
void SetPoolHelpId( sal_uInt16 nId ) { nPoolHelpId = nId; }
sal_uInt8 GetPoolHlpFileId() const { return nPoolHlpFileId; }
void SetPoolHlpFileId( sal_uInt8 nId ) { nPoolHlpFileId = nId; }
- // Get attribute-description. Returns passed string.
+ /// Get attribute-description. Returns passed string.
void GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric, SfxMapUnit ePresMetric, String &rText ) const
{ aSet.GetPresentation( ePres, eCoreMetric, ePresMetric, rText ); }
- // Format-ID for reading/writing:
+ /// Format-ID for reading/writing:
void ResetWritten() { bWritten = sal_False; }
- // Query / set AutoFmt-flag.
+ /// Query / set AutoFmt-flag.
sal_Bool IsAuto() const { return bAutoFmt; }
void SetAuto( sal_Bool bNew = sal_False ) { bAutoFmt = bNew; }
- // Query / set bAutoUpdateFmt-flag.
+ /// Query / set bAutoUpdateFmt-flag.
sal_Bool IsAutoUpdateFmt() const { return bAutoUpdateFmt; }
void SetAutoUpdateFmt( sal_Bool bNew = sal_True ) { bAutoUpdateFmt = bNew; }
sal_Bool IsFmtInDTOR() const { return bFmtInDTOR; }
- // GetMethods: Bool indicates whether to search only in Set (FALSE)
- // or also in Parents.
- // If nothing is found the defaulted attribute is returned.
+ /** GetMethods: Bool indicates whether to search only in Set (FALSE)
+ or also in Parents.
+ If nothing is found the defaulted attribute is returned. */
- // Character-attributes - implemented in charatr.hxx
+ /// Character-attributes - implemented in charatr.hxx
inline const SvxPostureItem &GetPosture( sal_Bool = sal_True ) const;
inline const SvxWeightItem &GetWeight( sal_Bool = sal_True ) const;
inline const SvxShadowedItem &GetShadowed( sal_Bool = sal_True ) const;
@@ -215,7 +215,7 @@ public:
inline const SvxCharReliefItem &GetCharRelief( sal_Bool = sal_True ) const;
inline const SvxCharHiddenItem &GetCharHidden( sal_Bool = sal_True ) const;
- // Frame-attributes - implemented in frmatr.hxx.
+ /// Frame-attributes - implemented in frmatr.hxx.
inline const SwFmtFillOrder &GetFillOrder( sal_Bool = sal_True ) const;
inline const SwFmtFrmSize &GetFrmSize( sal_Bool = sal_True ) const;
inline const SwFmtHeader &GetHeader( sal_Bool = sal_True ) const;
@@ -256,7 +256,7 @@ public:
// #i28701#
inline const SwFmtWrapInfluenceOnObjPos& GetWrapInfluenceOnObjPos(sal_Bool = sal_True) const;
- // Graphics-attributes - implemented in grfatr.hxx
+ /// Graphics-attributes - implemented in grfatr.hxx
inline const SwMirrorGrf &GetMirrorGrf( sal_Bool = sal_True ) const;
inline const SwCropGrf &GetCropGrf( sal_Bool = sal_True ) const;
inline const SwRotationGrf &GetRotationGrf(sal_Bool = sal_True ) const;
@@ -270,7 +270,7 @@ public:
inline const SwTransparencyGrf &GetTransparencyGrf(sal_Bool = sal_True ) const;
inline const SwDrawModeGrf &GetDrawModeGrf(sal_Bool = sal_True ) const;
- // Paragraph-attributes - implemented in paratr.hxx.
+ /// Paragraph-attributes - implemented in paratr.hxx.
inline const SvxLineSpacingItem &GetLineSpacing( sal_Bool = sal_True ) const;
inline const SvxAdjustItem &GetAdjust( sal_Bool = sal_True ) const;
inline const SvxFmtSplitItem &GetSplit( sal_Bool = sal_True ) const;
@@ -288,7 +288,7 @@ public:
inline const SvxParaGridItem &GetParaGrid(sal_Bool = sal_True) const;
inline const SwParaConnectBorderItem &GetParaConnectBorder(sal_Bool = sal_True ) const;
- // TableBox attributes - implemented in cellatr.hxx.
+ /// TableBox attributes - implemented in cellatr.hxx.
inline const SwTblBoxNumFormat &GetTblBoxNumFmt( sal_Bool = sal_True ) const;
inline const SwTblBoxFormula &GetTblBoxFormula( sal_Bool = sal_True ) const;
inline const SwTblBoxValue &GetTblBoxValue( sal_Bool = sal_True ) const;
diff --git a/sw/inc/frmfmt.hxx b/sw/inc/frmfmt.hxx
index d0be16da0cd7..0a139fc0f10a 100644
--- a/sw/inc/frmfmt.hxx
+++ b/sw/inc/frmfmt.hxx
@@ -48,7 +48,7 @@ class SdrObject;
class SW_DLLPUBLIC SwFrmFmt: public SwFmt
{
friend class SwDoc;
- friend class SwPageDesc; // Is allowed to call protected CTor.
+ friend class SwPageDesc; ///< Is allowed to call protected CTor.
::com::sun::star::uno::WeakReference<
::com::sun::star::uno::XInterface> m_wXObject;
@@ -71,41 +71,41 @@ protected:
virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem* pNewValue );
public:
- TYPEINFO(); // Already in base class Client.
+ TYPEINFO(); ///< Already in base class Client.
- // Destroys all Frms in aDepend (Frms are identified via PTR_CAST).
+ /// Destroys all Frms in aDepend (Frms are identified via PTR_CAST).
virtual void DelFrms();
- // Creates the views.
+ /// Creates the views.
virtual void MakeFrms();
virtual Graphic MakeGraphic( ImageMap* pMap = NULL );
- // Returns the IMapObject defined at format (Fly)
- // in the ImageMap at position Point.
- // rPoint - test on DocPosition.
- // pFly - optional FlyFrame, in case it is already known.
+ /** @return the IMapObject defined at format (Fly)
+ in the ImageMap at position Point.
+ rPoint - test on DocPosition.
+ pFly - optional FlyFrame, in case it is already known. */
IMapObject* GetIMapObject( const Point& rPoint,
const SwFlyFrm *pFly = 0 ) const;
- // Returns the real size of the frame - or an empty rectangle
- // if no layout exists.
- // If pPoint is given, look for the frame closest to it.
+ /** @return the real size of the frame - or an empty rectangle
+ if no layout exists.
+ If pPoint is given, look for the frame closest to it. */
SwRect FindLayoutRect( const sal_Bool bPrtArea = sal_False,
const Point* pPoint = 0,
const sal_Bool bCalcFrm = sal_False ) const;
- // Searches SdrObject. SdrObjUserCall is client of the format.
- // The UserCall knows its SdrObject.
+ /** Searches SdrObject. SdrObjUserCall is client of the format.
+ The UserCall knows its SdrObject. */
SwContact *FindContactObj();
const SwContact *FindContactObj() const
{ return ((SwFrmFmt*)this)->FindContactObj(); }
- // Returns the SdrObject, that ist connected to the ContactObject.
- // Only DrawFrmFmts are connected to the "real SdrObject". FlyFrmFmts
- // are connected to a Master and all FlyFrms has the "real SdrObject".
- // "Real SdrObject" has position and a Z-order.
+ /** @return the SdrObject, that ist connected to the ContactObject.
+ Only DrawFrmFmts are connected to the "real SdrObject". FlyFrmFmts
+ are connected to a Master and all FlyFrms has the "real SdrObject".
+ "Real SdrObject" has position and a Z-order. */
SdrObject *FindSdrObject();
const SdrObject *FindSdrObject() const
{ return ((SwFrmFmt*)this)->FindSdrObject(); }
@@ -121,7 +121,7 @@ public:
HORI_L2R,
HORI_R2L,
VERT_R2L,
- VERT_L2R // Not supported yet.
+ VERT_L2R ///< Not supported yet.
};
virtual SwFrmFmt::tLayoutDir GetLayoutDir() const;
@@ -149,10 +149,10 @@ class SW_DLLPUBLIC SwFlyFrmFmt: public SwFrmFmt
{
friend class SwDoc;
- // Both not existent.
- // it stores the previous position of Prt rectangle from RequestObjectResize
- // so it can be used to move frames of non-resizable objects to align them correctly
- // when they get borders (this is done in SwWrtShell::CalcAndGetScale)
+ /** Both not existent.
+ it stores the previous position of Prt rectangle from RequestObjectResize
+ so it can be used to move frames of non-resizable objects to align them correctly
+ when they get borders (this is done in SwWrtShell::CalcAndGetScale) */
Point m_aLastFlyFrmPrtRectPos;
SwFlyFrmFmt( const SwFlyFrmFmt &rCpy );
@@ -172,7 +172,7 @@ public:
TYPEINFO();
~SwFlyFrmFmt();
- // Creates the views.
+ /// Creates the views.
virtual void MakeFrms();
SwFlyFrm* GetFrm( const Point* pDocPos = 0,
@@ -233,7 +233,7 @@ class SW_DLLPUBLIC SwDrawFrmFmt: public SwFrmFmt
mutable const SdrObject * pSdrObjCached;
mutable String sSdrObjCachedComment;
- // Both not existent.
+ /// Both not existent.
SwDrawFrmFmt( const SwDrawFrmFmt &rCpy );
SwDrawFrmFmt &operator=( const SwDrawFrmFmt &rCpy );
@@ -271,12 +271,12 @@ public:
TYPEINFO();
~SwDrawFrmFmt();
- // DrawObjects are removed from the arrays at the layout.
- // The DrawObjects are marked as deleted.
+ /** DrawObjects are removed from the arrays at the layout.
+ The DrawObjects are marked as deleted. */
virtual void DelFrms();
- // Register DrawObjects in the arrays at layout.
- // Reset delete marks.
+ /** Register DrawObjects in the arrays at layout.
+ Reset delete marks. */
virtual void MakeFrms();
virtual Graphic MakeGraphic( ImageMap* pMap = NULL );
diff --git a/sw/inc/hhcwrp.hxx b/sw/inc/hhcwrp.hxx
index 2ce56e3d38ee..8f33df4e0217 100644
--- a/sw/inc/hhcwrp.hxx
+++ b/sw/inc/hhcwrp.hxx
@@ -35,36 +35,36 @@ class SwHHCWrapper : public editeng::HangulHanjaConversion
Window* pWin;
SwWrtShell &rWrtShell;
- SwConversionArgs *pConvArgs; // object for arguments (and results) needed
- // to find of next convertible text portion
+ SwConversionArgs *pConvArgs; /**< object for arguments (and results) needed
+ to find of next convertible text portion */
- xub_StrLen nLastPos; // starting position of the last found text part
- // (needs to be sth that gets not moved like
- // SwPaM or SwPosition by replace operations!)
+ xub_StrLen nLastPos; /**< starting position of the last found text part
+ (needs to be sth that gets not moved like
+ SwPaM or SwPosition by replace operations!) */
sal_Int32 nUnitOffset;
- sal_uInt16 nPageCount; // page count for progress bar
- sal_uInt16 nPageStart; // first checked page
+ sal_uInt16 nPageCount; ///< page count for progress bar
+ sal_uInt16 nPageStart; ///< first checked page
sal_Bool bIsDrawObj;
sal_Bool bIsStart;
sal_Bool bIsOtherCntnt;
sal_Bool bStartChk;
- sal_Bool bIsSelection; // true if only the selected text should be converted
- sal_Bool bInfoBox; // true if message should be displayed at the end
- sal_Bool bIsConvSpecial; // true if special regions: header, footer, ... should be converted
+ sal_Bool bIsSelection; ///< true if only the selected text should be converted
+ sal_Bool bInfoBox; ///< true if message should be displayed at the end
+ sal_Bool bIsConvSpecial; ///< true if special regions: header, footer, ... should be converted
sal_Bool bStartDone;
sal_Bool bEndDone;
- // from SvxSpellWrapper copied and modified
- sal_Bool ConvNext_impl(); // former SpellNext
- sal_Bool FindConvText_impl(); // former FindSpellError
+ /// from SvxSpellWrapper copied and modified
+ sal_Bool ConvNext_impl(); ///< former SpellNext
+ sal_Bool FindConvText_impl(); ///< former FindSpellError
- // from SwSpellWrapper copied and modified
+ /// from SwSpellWrapper copied and modified
sal_Bool HasOtherCnt_impl();
- void ConvStart_impl( SwConversionArgs *pConvArgs, SvxSpellArea eSpell ); // former SpellStart
- void ConvEnd_impl( SwConversionArgs *pConvArgs ); // former SpellEnd
- sal_Bool ConvContinue_impl( SwConversionArgs *pConvArgs ); // former SpellContinue
+ void ConvStart_impl( SwConversionArgs *pConvArgs, SvxSpellArea eSpell ); ///< former SpellStart
+ void ConvEnd_impl( SwConversionArgs *pConvArgs ); ///< former SpellEnd
+ sal_Bool ConvContinue_impl( SwConversionArgs *pConvArgs ); ///< former SpellContinue
void SelectNewUnit_impl( const sal_Int32 nUnitStart,
const sal_Int32 nUnitEnd );
diff --git a/sw/inc/hints.hxx b/sw/inc/hints.hxx
index 4f1bb283d50b..90434141e5fd 100644
--- a/sw/inc/hints.hxx
+++ b/sw/inc/hints.hxx
@@ -118,18 +118,18 @@ public:
};
-// SwRefMarkFldUpdate is sent when the referencemarks should be updated.
-// To determine Page- / chapternumbers the current frame has to be asked.
-// For this we need the current outputdevice
+/** SwRefMarkFldUpdate is sent when the referencemarks should be updated.
+ To determine Page- / chapternumbers the current frame has to be asked.
+ For this we need the current outputdevice */
class SwRefMarkFldUpdate : public SwMsgPoolItem
{
public:
- const OutputDevice* pOut; // pointer to the current output device
+ const OutputDevice* pOut; ///< pointer to the current output device
SwRefMarkFldUpdate( const OutputDevice* );
};
-// SwDocPosUpdate is sent to signal that only the frames from or to a specified document-global position
-// have to be updated. At the moment this is only needed when updating pagenumber fields.
+/** SwDocPosUpdate is sent to signal that only the frames from or to a specified document-global position
+ have to be updated. At the moment this is only needed when updating pagenumber fields. */
class SwDocPosUpdate : public SwMsgPoolItem
{
public:
@@ -137,7 +137,7 @@ public:
SwDocPosUpdate( const long nDocPos );
};
-// SwTableFmlUpdate is sent when the table has to be newly calculated or when a table itself is merged or splitted
+/// SwTableFmlUpdate is sent when the table has to be newly calculated or when a table itself is merged or splitted
enum TableFmlUpdtFlags { TBL_CALC = 0,
TBL_BOXNAME,
TBL_BOXPTR,
@@ -148,13 +148,13 @@ enum TableFmlUpdtFlags { TBL_CALC = 0,
class SwTableFmlUpdate : public SwMsgPoolItem
{
public:
- const SwTable* pTbl; // Pointer to the current table
+ const SwTable* pTbl; ///< Pointer to the current table
union {
- const SwTable* pDelTbl; // Merge: Pointer to the table to be removed
- const String* pNewTblNm; // Split: the name of the new table
+ const SwTable* pDelTbl; ///< Merge: Pointer to the table to be removed
+ const String* pNewTblNm; ///< Split: the name of the new table
} DATA;
SwHistory* pHistory;
- sal_uInt16 nSplitLine; // Split: from this BaseLine on will be splitted
+ sal_uInt16 nSplitLine; ///< Split: from this BaseLine on will be splitted
TableFmlUpdtFlags eFlags;
sal_Bool bModified : 1;
sal_Bool bBehindSplitLine : 1;
@@ -179,18 +179,18 @@ public:
class SwAttrSetChg: public SwMsgPoolItem
{
sal_Bool bDelSet;
- SwAttrSet* pChgSet; // what has changed
- const SwAttrSet* pTheChgdSet; // is only used to compare
+ SwAttrSet* pChgSet; ///< what has changed
+ const SwAttrSet* pTheChgdSet; ///< is only used to compare
public:
SwAttrSetChg( const SwAttrSet& rTheSet, SwAttrSet& rSet );
SwAttrSetChg( const SwAttrSetChg& );
~SwAttrSetChg();
- // What has changed
+ /// What has changed
const SwAttrSet* GetChgSet() const { return pChgSet; }
SwAttrSet* GetChgSet() { return pChgSet; }
- // Where it has changed
+ /// Where it has changed
const SwAttrSet* GetTheChgdSet() const { return pTheChgdSet; }
sal_uInt16 Count() const { return pChgSet->Count(); }
@@ -214,8 +214,8 @@ class SwVirtPageNumInfo: public SwMsgPoolItem
const SwPageFrm *pPage;
const SwPageFrm *pOrigPage;
const SwFrm *pFrm;
- // Multiple attributes can be attached to a single paragraph / table
- // The frame, in the end, has to decide which attribute takes effect and which physical page it involves
+ /** Multiple attributes can be attached to a single paragraph / table
+ The frame, in the end, has to decide which attribute takes effect and which physical page it involves */
public:
SwVirtPageNumInfo( const SwPageFrm *pPg );
diff --git a/sw/inc/htmltbl.hxx b/sw/inc/htmltbl.hxx
index 4016dba7f833..a3c06d2780c8 100644
--- a/sw/inc/htmltbl.hxx
+++ b/sw/inc/htmltbl.hxx
@@ -34,7 +34,7 @@
#include <editeng/svxenum.hxx>
#include "swtypes.hxx"
-#include "node.hxx" // For SwStartNode
+#include "node.hxx" ///< For SwStartNode
class SwTableBox;
@@ -47,24 +47,24 @@ class SwFrmFmt;
class SwHTMLTableLayoutCnts
{
- SwHTMLTableLayoutCnts *pNext; // The next content.
+ SwHTMLTableLayoutCnts *pNext; ///< The next content.
- // Only one of the following two pointers may be set!
- SwTableBox *pBox; // A Box.
- SwHTMLTableLayout *pTable; // A "table within a table".
+ /// Only one of the following two pointers may be set!
+ SwTableBox *pBox; ///< A Box.
+ SwHTMLTableLayout *pTable; ///< A "table within a table".
- // During first run there are still no boxes. In this case
- // pStartNode is used instead of pBox.
+ /** During first run there are still no boxes. In this case
+ pStartNode is used instead of pBox. */
const SwStartNode *pStartNode;
- // The following counters indicate how often a pass has been
- // done for this content. Therefore they are compared against
- // a reference value. If 255 is reached the continue with 0.
- // This avoids reinitialization on every resize.
- sal_uInt8 nPass1Done; // How many times has Pass 1 been called?
- sal_uInt8 nWidthSet; // How many times has the width been set?
+ /** The following counters indicate how often a pass has been
+ done for this content. Therefore they are compared against
+ a reference value. If 255 is reached the continue with 0.
+ This avoids reinitialization on every resize. */
+ sal_uInt8 nPass1Done; ///< How many times has Pass 1 been called?
+ sal_uInt8 nWidthSet; ///< How many times has the width been set?
- sal_Bool bNoBreakTag; // <NOBR>-Tag over complete content.
+ sal_Bool bNoBreakTag; ///< <NOBR>-Tag over complete content.
public:
@@ -80,7 +80,7 @@ public:
const SwStartNode *GetStartNode() const;
- // Calculation of next node.
+ /// Calculation of next node.
SwHTMLTableLayoutCnts *GetNext() const { return pNext; }
void SetWidthSet( sal_uInt8 nRef ) { nWidthSet = nRef; }
@@ -94,14 +94,14 @@ public:
class SwHTMLTableLayoutCell
{
- SwHTMLTableLayoutCnts *pContents; // Content of cell.
+ SwHTMLTableLayoutCnts *pContents; ///< Content of cell.
- sal_uInt16 nRowSpan; // ROWSPAN of cell.
- sal_uInt16 nColSpan; // COLSPAN of cell.
- sal_uInt16 nWidthOption;// Given width of cell in Twip or %.
+ sal_uInt16 nRowSpan; ///< ROWSPAN of cell.
+ sal_uInt16 nColSpan; ///< COLSPAN of cell.
+ sal_uInt16 nWidthOption; ///< Given width of cell in Twip or %.
- sal_Bool bPrcWidthOption : 1;// nWidth is %-value.
- sal_Bool bNoWrapOption : 1; // NOWRAP-option.
+ sal_Bool bPrcWidthOption : 1; ///< nWidth is %-value.
+ sal_Bool bNoWrapOption : 1; ///< NOWRAP-option.
public:
@@ -112,13 +112,13 @@ public:
~SwHTMLTableLayoutCell();
- // Set or get content of a cell.
+ /// Set or get content of a cell.
void SetContents( SwHTMLTableLayoutCnts *pCnts ) { pContents = pCnts; }
SwHTMLTableLayoutCnts *GetContents() const { return pContents; }
inline void SetProtected();
- // Set or get ROWSPAN/COLSPAN of cell.
+ /// Set or get ROWSPAN/COLSPAN of cell.
void SetRowSpan( sal_uInt16 nRSpan ) { nRowSpan = nRSpan; }
sal_uInt16 GetRowSpan() const { return nRowSpan; }
sal_uInt16 GetColSpan() const { return nColSpan; }
@@ -132,17 +132,17 @@ public:
class SwHTMLTableLayoutColumn
{
- // Interim values of AutoLayoutPass1,
+ /// Interim values of AutoLayoutPass1,
sal_uLong nMinNoAlign, nMaxNoAlign, nAbsMinNoAlign;
- // Results of AutoLayoutPass1
+ /// Results of AutoLayoutPass1
sal_uLong nMin, nMax;
- // Results of Pass 2.
- sal_uInt16 nAbsColWidth; // In Twips.
- sal_uInt16 nRelColWidth; // In Twips or relative to USHRT_MAX.
+ /// Results of Pass 2.
+ sal_uInt16 nAbsColWidth; ///< In Twips.
+ sal_uInt16 nRelColWidth; ///< In Twips or relative to USHRT_MAX.
- sal_uInt16 nWidthOption; // Options of <COL> or <TD>/<TH>.
+ sal_uInt16 nWidthOption; ///< Options of <COL> or <TD>/<TH>.
sal_Bool bRelWidthOption : 1;
sal_Bool bLeftBorder : 1;
@@ -184,37 +184,37 @@ public:
class SwHTMLTableLayout
{
- Timer aResizeTimer; // Timer for DelayedResize.
+ Timer aResizeTimer; ///< Timer for DelayedResize.
SwHTMLTableLayoutColumn **aColumns;
SwHTMLTableLayoutCell **aCells;
- const SwTable *pSwTable; // SwTable (Top-Table only).
- SwTableBox *pLeftFillerBox; // Left filler-box (table in table only).
- SwTableBox *pRightFillerBox; // Right filler-box (table in Table only).
+ const SwTable *pSwTable; ///< SwTable (Top-Table only).
+ SwTableBox *pLeftFillerBox; ///< Left filler-box (table in table only).
+ SwTableBox *pRightFillerBox; ///< Right filler-box (table in Table only).
- sal_uLong nMin; // Minimal width of table (Twips).
- sal_uLong nMax; // Maximal width of table (Twips).
+ sal_uLong nMin; ///< Minimal width of table (Twips).
+ sal_uLong nMax; ///< Maximal width of table (Twips).
- sal_uInt16 nRows; // Row count.
- sal_uInt16 nCols; // Column count.
+ sal_uInt16 nRows; ///< Row count.
+ sal_uInt16 nCols; ///< Column count.
- sal_uInt16 nLeftMargin; // Space to left margin (from paragraph).
- sal_uInt16 nRightMargin; // Space to left margin (from paragraph).
+ sal_uInt16 nLeftMargin; ///< Space to left margin (from paragraph).
+ sal_uInt16 nRightMargin; ///< Space to left margin (from paragraph).
- sal_uInt16 nInhAbsLeftSpace; // Space inherited from surrounding box
- sal_uInt16 nInhAbsRightSpace; // that was added to boxes.
+ sal_uInt16 nInhAbsLeftSpace; ///< Space inherited from surrounding box
+ sal_uInt16 nInhAbsRightSpace; ///< that was added to boxes.
- sal_uInt16 nRelLeftFill; // Width of boxes relative to alignment
- sal_uInt16 nRelRightFill; // of tables in tables.
+ sal_uInt16 nRelLeftFill; ///< Width of boxes relative to alignment
+ sal_uInt16 nRelRightFill; ///< of tables in tables.
- sal_uInt16 nRelTabWidth; // Relative width of table.
+ sal_uInt16 nRelTabWidth; ///< Relative width of table.
- sal_uInt16 nWidthOption; // Width of table (in Twips oder %).
- sal_uInt16 nCellPadding; // Space to contents (in Twips).
- sal_uInt16 nCellSpacing; // Cell spacing (in Twips).
- sal_uInt16 nBorder; // Line strength of outer border, or rather the
- // space needed for it as calculated by Netscape.
+ sal_uInt16 nWidthOption; ///< Width of table (in Twips oder %).
+ sal_uInt16 nCellPadding; ///< Space to contents (in Twips).
+ sal_uInt16 nCellSpacing; ///< Cell spacing (in Twips).
+ sal_uInt16 nBorder; /** Line strength of outer border, or rather the
+ space needed for it as calculated by Netscape. */
sal_uInt16 nLeftBorderWidth;
sal_uInt16 nRightBorderWidth;
@@ -222,27 +222,27 @@ class SwHTMLTableLayout
sal_uInt16 nInhRightBorderWidth;
sal_uInt16 nBorderWidth;
- sal_uInt16 nDelayedResizeAbsAvail; // Param for delayed Resize.
+ sal_uInt16 nDelayedResizeAbsAvail; ///< Param for delayed Resize.
sal_uInt16 nLastResizeAbsAvail;
- sal_uInt8 nPass1Done; // Reference-values for
- sal_uInt8 nWidthSet; // the runs through loop.
+ sal_uInt8 nPass1Done; ///< Reference-values for
+ sal_uInt8 nWidthSet; ///< the runs through loop.
- SvxAdjust eTableAdjust; // Alignment of table.
+ SvxAdjust eTableAdjust; ///< Alignment of table.
- sal_Bool bColsOption : 1; // Table has a COLS-option.
- sal_Bool bColTags : 1; // Tabelle has COL/COLGRP-tags.
- sal_Bool bPrcWidthOption : 1; // Width is given in percent.
- sal_Bool bUseRelWidth : 1; // SwTable gets relative width.
+ sal_Bool bColsOption : 1; ///< Table has a COLS-option.
+ sal_Bool bColTags : 1; ///< Tabelle has COL/COLGRP-tags.
+ sal_Bool bPrcWidthOption : 1; ///< Width is given in percent.
+ sal_Bool bUseRelWidth : 1; ///< SwTable gets relative width.
- sal_Bool bMustResize : 1; // Table width must be defined.
- sal_Bool bExportable : 1; // Layout may be used for export.
- sal_Bool bBordersChanged : 1; // Borders have been changed.
- sal_Bool bMayBeInFlyFrame : 1; // Table could be within frame.
+ sal_Bool bMustResize : 1; ///< Table width must be defined.
+ sal_Bool bExportable : 1; ///< Layout may be used for export.
+ sal_Bool bBordersChanged : 1; ///< Borders have been changed.
+ sal_Bool bMayBeInFlyFrame : 1; ///< Table could be within frame.
- sal_Bool bDelayedResizeRecalc : 1; // Param for delayed Resize.
- sal_Bool bMustNotResize : 1; // Table may not be resized.
- sal_Bool bMustNotRecalc : 1; // Table may not be adapted to its contents.
+ sal_Bool bDelayedResizeRecalc : 1; ///< Param for delayed Resize.
+ sal_Bool bMustNotResize : 1; ///< Table may not be resized.
+ sal_Bool bMustNotRecalc : 1; ///< Table may not be adapted to its contents.
void AddBorderWidth( sal_uLong &rMin, sal_uLong &rMax, sal_uLong& rAbsMin,
sal_uInt16 nCol, sal_uInt16 nColSpan,
@@ -318,34 +318,34 @@ public:
void SetMustNotResize( sal_Bool bSet ) { bMustNotResize = bSet; }
void SetMustNotRecalc( sal_Bool bSet ) { bMustNotRecalc = bSet; }
- // Recalculation of table widths for available width that has been passed.
- // - If bRecalc is set, contents of boxes are included into calculation.
- // - If bForce is set, table will be recalculated even if this was
- // disallowed by SetMustNotResize.
- // - If nDelay > 0 the calculation is delayed accordingly. Resizing calls
- // occuring during delay-time are ignored, but the delay may be counted
- // under certain circumstances.
- // - If nDelay == HTMLTABLE_RESIZE_NOW, resize immediately and do not
- // consider any resize-calls that might possibly be in order.
- // - The return value indicates whether the table has been changed.
+ /** Recalculation of table widths for available width that has been passed.
+ - If bRecalc is set, contents of boxes are included into calculation.
+ - If bForce is set, table will be recalculated even if this was
+ disallowed by SetMustNotResize.
+ - If nDelay > 0 the calculation is delayed accordingly. Resizing calls
+ occuring during delay-time are ignored, but the delay may be counted
+ under certain circumstances.
+ - If nDelay == HTMLTABLE_RESIZE_NOW, resize immediately and do not
+ consider any resize-calls that might possibly be in order.
+ - The return value indicates whether the table has been changed. */
sal_Bool Resize( sal_uInt16 nAbsAvail, sal_Bool bRecalc=sal_False, sal_Bool bForce=sal_False,
sal_uLong nDelay=0 );
void BordersChanged( sal_uInt16 nAbsAvail, sal_Bool bRecalc=sal_False );
- // Calculate available width. This works only if a layout or a
- // ViewShell exists. Otherwise returns 0.
- // This is needed by HTML-filter because it doesn't have access to the layout.)
+ /** Calculate available width. This works only if a layout or a
+ ViewShell exists. Otherwise returns 0.
+ This is needed by HTML-filter because it doesn't have access to the layout.) */
static sal_uInt16 GetBrowseWidth( const SwDoc& rDoc );
- // Calculates available width by table-frame.
+ /// Calculates available width by table-frame.
sal_uInt16 GetBrowseWidthByTabFrm( const SwTabFrm& rTabFrm ) const;
- // Calculates available width by the table-frame or
- // static GetBrowseWidth if no layout exists.
+ /** Calculates available width by the table-frame or
+ static GetBrowseWidth if no layout exists. */
sal_uInt16 GetBrowseWidthByTable( const SwDoc& rDoc ) const;
- // For Export.
+ /// For Export.
sal_uInt16 GetWidthOption() const { return nWidthOption; }
sal_Bool HasPrcWidthOption() const { return bPrcWidthOption; }
diff --git a/sw/inc/iodetect.hxx b/sw/inc/iodetect.hxx
index cc58b29a24b3..73bde8c3bffc 100644
--- a/sw/inc/iodetect.hxx
+++ b/sw/inc/iodetect.hxx
@@ -36,15 +36,15 @@
#include <tools/string.hxx>
#include <swddllapi.h>
-#define FILTER_RTF "RTF" // RTF filter
+#define FILTER_RTF "RTF" ///< RTF filter
#define sRtfWH "WH_RTF"
-#define FILTER_TEXT "TEXT" // text filter with default codeset
-#define FILTER_BAS "BAS" // StarBasic (identical to ANSI)
-#define FILTER_WW8 "CWW8" // WinWord 97 filter
-#define FILTER_TEXT_DLG "TEXT_DLG" // text filter with encoding dialog
-#define FILTER_XML "CXML" // XML filter
-#define FILTER_XMLV "CXMLV" // XML filter
-#define FILTER_XMLVW "CXMLVWEB" // XML filter
+#define FILTER_TEXT "TEXT" ///< text filter with default codeset
+#define FILTER_BAS "BAS" ///< StarBasic (identical to ANSI)
+#define FILTER_WW8 "CWW8" ///< WinWord 97 filter
+#define FILTER_TEXT_DLG "TEXT_DLG" ///< text filter with encoding dialog
+#define FILTER_XML "CXML" ///< XML filter
+#define FILTER_XMLV "CXMLV" ///< XML filter
+#define FILTER_XMLVW "CXMLVWEB" ///< XML filter
#define sHTML "HTML"
#define sWW1 "WW1"
#define sWW5 "WW6"
@@ -88,29 +88,29 @@ enum ReaderWriterEnum {
extern SWD_DLLPUBLIC SwIoDetect aFilterDetect[];
-// The following class is a wrapper for basic i/o functions of Writer 3.0.
-// Everything is static. All filter names mentioned are Writer-internal
-// names, i.e. the names in front of the equality sign in INSTALL.INI, like SWG
-// or ASCII.
+/** The following class is a wrapper for basic i/o functions of Writer 3.0.
+ Everything is static. All filter names mentioned are Writer-internal
+ names, i.e. the names in front of the equality sign in INSTALL.INI, like SWG
+ or ASCII.*/
class SwIoSystem
{
public:
- // find for an internal format name the corresponding filter entry
+ /// find for an internal format name the corresponding filter entry
SWD_DLLPUBLIC static const SfxFilter*
GetFilterOfFormat( const String& rFormat,
const SfxFilterContainer* pCnt = 0 );
- // Detect for the given file which filter should be used. The filter name
- // is returned. If no filter could be found, the name of the ASCII filter
- // is returned!
+ /** Detect for the given file which filter should be used. The filter name
+ is returned. If no filter could be found, the name of the ASCII filter
+ is returned! */
SWD_DLLPUBLIC static const SfxFilter*
GetFileFilter( const String& rFileName,
const String& rPrefFltName,
SfxMedium* pMedium = 0 );
- // Detect whether the given file is in the given format.
- // For now, only our own filters are supported!
+ /** Detect whether the given file is in the given format.
+ For now, only our own filters are supported! */
static sal_Bool IsFileFilter( SfxMedium& rMedium, const String& rFmtName,
const SfxFilter** ppFlt = 0 );
diff --git a/sw/inc/istyleaccess.hxx b/sw/inc/istyleaccess.hxx
index 0fd66bf85d36..cbd54511b127 100644
--- a/sw/inc/istyleaccess.hxx
+++ b/sw/inc/istyleaccess.hxx
@@ -44,15 +44,15 @@ public:
SwAutoStyleFamily eFamily ) = 0;
virtual void getAllStyles( std::vector<StylePool::SfxItemSet_Pointer_t> &rStyles,
SwAutoStyleFamily eFamily ) = 0;
- // It's slow to iterate through a stylepool looking for a special name, but if
- // the style has been inserted via "cacheAutomaticStyle" instead of "getAutomaticStyle",
- // it's faster
+ /** It's slow to iterate through a stylepool looking for a special name, but if
+ the style has been inserted via "cacheAutomaticStyle" instead of "getAutomaticStyle",
+ it's faster */
virtual StylePool::SfxItemSet_Pointer_t getByName( const rtl::OUString& rName,
SwAutoStyleFamily eFamily ) = 0;
- // insert the style to the pool and the cache (used during import)
+ /// insert the style to the pool and the cache (used during import)
virtual StylePool::SfxItemSet_Pointer_t cacheAutomaticStyle( const SfxItemSet& rSet,
SwAutoStyleFamily eFamily ) = 0;
- // To release the cached styles (shared_pointer!)
+ /// To release the cached styles (shared_pointer!)
virtual void clearCaches() = 0;
};
diff --git a/sw/inc/lineinfo.hxx b/sw/inc/lineinfo.hxx
index ec7b1c48985e..8dcb73255bc6 100644
--- a/sw/inc/lineinfo.hxx
+++ b/sw/inc/lineinfo.hxx
@@ -34,21 +34,21 @@ enum LineNumberPosition
LINENUMBER_POS_OUTSIDE
};
-class SW_DLLPUBLIC SwLineNumberInfo : public SwClient //purpose of derivation from SwClient:
- //character style for displaying the numbers.
+class SW_DLLPUBLIC SwLineNumberInfo : public SwClient /**< purpose of derivation from SwClient:
+ character style for displaying the numbers. */
{
- SvxNumberType aType; //e.g. roman linenumbers
- String aDivider; //String for aditional interval (vert. lines user defined)
- sal_uInt16 nPosFromLeft; //Position for paint
- sal_uInt16 nCountBy; //Paint only for every n line
- sal_uInt16 nDividerCountBy; //Interval for display of an user defined
- //string every n lines
- LineNumberPosition ePos; //Where should the display occur (number and divicer)
- sal_Bool bPaintLineNumbers; //Should anything be displayed?
- sal_Bool bCountBlankLines; //Count empty lines?
- sal_Bool bCountInFlys; //Count also within FlyFrames?
- sal_Bool bRestartEachPage; //Restart counting at the first paragraph of each page
- //(even on follows when paragraphs are splitted)
+ SvxNumberType aType; ///< e.g. roman linenumbers
+ String aDivider; ///< String for aditional interval (vert. lines user defined)
+ sal_uInt16 nPosFromLeft; ///< Position for paint
+ sal_uInt16 nCountBy; ///< Paint only for every n line
+ sal_uInt16 nDividerCountBy; /**< Interval for display of an user defined
+ string every n lines */
+ LineNumberPosition ePos; ///< Where should the display occur (number and divicer)
+ sal_Bool bPaintLineNumbers; ///< Should anything be displayed?
+ sal_Bool bCountBlankLines; ///< Count empty lines?
+ sal_Bool bCountInFlys; ///< Count also within FlyFrames?
+ sal_Bool bRestartEachPage; /**< Restart counting at the first paragraph of each page
+ (even on follows when paragraphs are splitted) */
protected:
virtual void Modify( const SfxPoolItem*, const SfxPoolItem* );
diff --git a/sw/inc/ndarr.hxx b/sw/inc/ndarr.hxx
index 051476856231..2f393af73bd0 100644
--- a/sw/inc/ndarr.hxx
+++ b/sw/inc/ndarr.hxx
@@ -101,27 +101,27 @@ class SW_DLLPUBLIC SwNodes
friend class SwNode;
friend class SwNodeIndex;
- SwNodeIndex* pRoot; // List of all indices on nodes.
+ SwNodeIndex* pRoot; ///< List of all indices on nodes.
void InsertNode( const SwNodePtr pNode,
const SwNodeIndex& rPos );
void InsertNode( const SwNodePtr pNode,
sal_uLong nPos );
- SwDoc* pMyDoc; // This Doc contains the nodes-array.
+ SwDoc* pMyDoc; ///< This Doc contains the nodes-array.
- SwNode *pEndOfPostIts, *pEndOfInserts, // These are the fixed ranges.
+ SwNode *pEndOfPostIts, *pEndOfInserts, ///< These are the fixed ranges.
*pEndOfAutotext, *pEndOfRedlines,
*pEndOfContent;
- mutable SwOutlineNodes* pOutlineNds; // Array of all outline nodes.
+ mutable SwOutlineNodes* pOutlineNds; ///< Array of all outline nodes.
- sal_Bool bInNodesDel : 1; // In Case of recursive calling.
- // Do not update Num/Outline.
- sal_Bool bInDelUpdOutl : 1; // Flag for updating of Outline.
- sal_Bool bInDelUpdNum : 1; // Flag for updating of Outline.
+ sal_Bool bInNodesDel : 1; /**< In Case of recursive calling.
+ Do not update Num/Outline. */
+ sal_Bool bInDelUpdOutl : 1; ///< Flag for updating of Outline.
+ sal_Bool bInDelUpdNum : 1; ///< Flag for updating of Outline.
- // For administering indices.
+ /// For administering indices.
void RegisterIndex( SwNodeIndex& rIdx );
void DeRegisterIndex( SwNodeIndex& rIdx );
void RemoveNode( sal_uLong nDelPos, sal_uLong nLen, sal_Bool bDel );
@@ -133,7 +133,7 @@ class SW_DLLPUBLIC SwNodes
void ChgNode( SwNodeIndex& rDelPos, sal_uLong nSize,
SwNodeIndex& rInsPos, sal_Bool bNewFrms );
- void UpdtOutlineIdx( const SwNode& ); // Update all OutlineNodes starting from Node.
+ void UpdtOutlineIdx( const SwNode& ); ///< Update all OutlineNodes starting from Node.
void _CopyNodes( const SwNodeRange&, const SwNodeIndex&,
sal_Bool bNewFrms = sal_True, sal_Bool bTblInsDummyNode = sal_False ) const;
@@ -164,22 +164,22 @@ public:
void ForEach( const SwNodeIndex& rStart, const SwNodeIndex& rEnd,
FnForEach_SwNodes fnForEach, void* pArgs = 0 );
- // A still empty section.
+ /// A still empty section.
SwNode& GetEndOfPostIts() const { return *pEndOfPostIts; }
- // Section fpr all footnotes.
+ /// Section fpr all footnotes.
SwNode& GetEndOfInserts() const { return *pEndOfInserts; }
- // Section for all Flys/Header/Footers.
+ /// Section for all Flys/Header/Footers.
SwNode& GetEndOfAutotext() const { return *pEndOfAutotext; }
- // Section for all Redlines.
+ /// Section for all Redlines.
SwNode& GetEndOfRedlines() const { return *pEndOfRedlines; }
- // This is the last EndNode of a special section. After it
- // there is only the regular ContentSection (i.e. the BodyText).
+ /** This is the last EndNode of a special section. After it
+ there is only the regular ContentSection (i.e. the BodyText). */
SwNode& GetEndOfExtras() const { return *pEndOfRedlines; }
- // Regular ContentSection (i.e. the BodyText).
+ /// Regular ContentSection (i.e. the BodyText).
SwNode& GetEndOfContent() const { return *pEndOfContent; }
- // Is the NodesArray the regular one of Doc? (and not the UndoNds, ...)
- // Implementation in doc.hxx (because one needs to know Doc for it) !
+ /** Is the NodesArray the regular one of Doc? (and not the UndoNds, ...)
+ Implementation in doc.hxx (because one needs to know Doc for it) ! */
sal_Bool IsDocNodes() const;
sal_uInt16 GetSectionLevel(const SwNodeIndex &rIndex) const;
@@ -204,28 +204,28 @@ public:
SwCntntNode* GoNext(SwNodeIndex *) const;
SwCntntNode* GoPrevious(SwNodeIndex *) const;
- // Go to next/previous Cntnt/Table-node for which LayoutFrames exist.
- // While doing this do not leave Header/Footer/Frame etc.
+ /** Go to next/previous Cntnt/Table-node for which LayoutFrames exist.
+ While doing this do not leave Header/Footer/Frame etc. */
SwNode* GoNextWithFrm(SwNodeIndex *) const;
SwNode* GoPreviousWithFrm(SwNodeIndex *) const;
- // Go to next content-node that is not protected or hidden
- // (Both set FALSE ==> GoNext/GoPrevious!!!).
+ /** Go to next content-node that is not protected or hidden
+ (Both set FALSE ==> GoNext/GoPrevious!!!). */
SwCntntNode* GoNextSection( SwNodeIndex *, int bSkipHidden = sal_True,
int bSkipProtect = sal_True ) const;
SwCntntNode* GoPrevSection( SwNodeIndex *, int bSkipHidden = sal_True,
int bSkipProtect = sal_True ) const;
- // Create an empty section of Start- and EndNote. It may be called
- // only if a new section with content is to be created,
- // e.g. at filters/Undo/...
+ /** Create an empty section of Start- and EndNote. It may be called
+ only if a new section with content is to be created,
+ e.g. at filters/Undo/... */
SwStartNode* MakeEmptySection( const SwNodeIndex& rIdx,
SwStartNodeType = SwNormalStartNode );
- // Implementations of "Make...Node" are in the given .cxx-files.
+ /// Implementations of "Make...Node" are in the given .cxx-files.
SwTxtNode *MakeTxtNode( const SwNodeIndex & rWhere,
SwTxtFmtColl *pColl,
- SwAttrSet* pAutoAttr = 0 ); // in ndtxt.cxx
+ SwAttrSet* pAutoAttr = 0 ); ///< in ndtxt.cxx
SwStartNode* MakeTextSection( const SwNodeIndex & rWhere,
SwStartNodeType eSttNdTyp,
SwTxtFmtColl *pColl,
@@ -237,38 +237,38 @@ public:
const Graphic* pGraphic,
SwGrfFmtColl *pColl,
SwAttrSet* pAutoAttr = 0,
- sal_Bool bDelayed = sal_False ); // in ndgrf.cxx
+ sal_Bool bDelayed = sal_False ); ///< in ndgrf.cxx
SwGrfNode *MakeGrfNode( const SwNodeIndex & rWhere,
const GraphicObject& rGrfObj,
SwGrfFmtColl *pColl,
- SwAttrSet* pAutoAttr = 0 ); // in ndgrf.cxx
+ SwAttrSet* pAutoAttr = 0 ); ///< in ndgrf.cxx
SwOLENode *MakeOLENode( const SwNodeIndex & rWhere,
const svt::EmbeddedObjectRef&,
SwGrfFmtColl *pColl,
- SwAttrSet* pAutoAttr = 0 ); // in ndole.cxx
+ SwAttrSet* pAutoAttr = 0 ); ///< in ndole.cxx
SwOLENode *MakeOLENode( const SwNodeIndex & rWhere,
const String &rName,
sal_Int64 nAspect,
SwGrfFmtColl *pColl,
- SwAttrSet* pAutoAttr ); // in ndole.cxx
+ SwAttrSet* pAutoAttr ); ///< in ndole.cxx
- // Array of all OutlineNodes.
+ /// Array of all OutlineNodes.
const SwOutlineNodes& GetOutLineNds() const;
//void UpdateOutlineNode( const SwNode&, sal_uInt8 nOldLevel, sal_uInt8 nNewLevel );//#outline level,removed by zhaojianwei
- // Update all Nodes - Rule/Format-Change.
+ /// Update all Nodes - Rule/Format-Change.
void UpdateOutlineNode(SwNode & rNd);
- // Insert nodes for tables. If Lines is given, create the matrix
- // from lines and boxes, else only the count of boxes.
+ /** Insert nodes for tables. If Lines is given, create the matrix
+ from lines and boxes, else only the count of boxes.
- // New parameter pAttrSet: If pAttrSet is non-null and contains an
- // adjust item it is propagated to the table cells. If there is an
- // adjust in pCntntTxtColl or pHeadlineTxtColl this adjust item
- // overrides the item in pAttrSet.
+ New parameter pAttrSet: If pAttrSet is non-null and contains an
+ adjust item it is propagated to the table cells. If there is an
+ adjust in pCntntTxtColl or pHeadlineTxtColl this adjust item
+ overrides the item in pAttrSet. */
SwTableNode* InsertTable( const SwNodeIndex& rNdIdx,
sal_uInt16 nBoxes, SwTxtFmtColl* pCntntTxtColl,
@@ -276,7 +276,7 @@ public:
SwTxtFmtColl* pHeadlineTxtColl = 0,
const SwAttrSet * pAttrSet = 0);
- // Create balanced table from selected range.
+ /// Create balanced table from selected range.
SwTableNode* TextToTable( const SwNodeRange& rRange, sal_Unicode cCh,
SwTableFmt* pTblFmt,
SwTableLineFmt* pLineFmt,
@@ -286,7 +286,7 @@ public:
SwNodeRange * ExpandRangeForTableBox(const SwNodeRange & rRange);
- //create a table from a vector of NodeRanges - API support
+ /// create a table from a vector of NodeRanges - API support
SwTableNode* TextToTable( const TableRanges_t& rTableNodes,
SwTableFmt* pTblFmt,
SwTableLineFmt* pLineFmt,
@@ -295,33 +295,33 @@ public:
/*, SwUndo... pUndo*/ );
- // Create regular text from what was table.
+ /// Create regular text from what was table.
sal_Bool TableToText( const SwNodeRange& rRange, sal_Unicode cCh,
SwUndoTblToTxt* = 0 );
- // Is in untbl.cxx and may called only by Undo-object.
+ /// Is in untbl.cxx and may called only by Undo-object.
SwTableNode* UndoTableToText( sal_uLong nStt, sal_uLong nEnd,
const SwTblToTxtSaves& rSavedData );
- // Insert a new box in the line before InsPos. Its format
- // is taken from the following one (or from the previous one if we are
- // at the end). In the line there must be a box already.
+ /** Insert a new box in the line before InsPos. Its format
+ is taken from the following one (or from the previous one if we are
+ at the end). In the line there must be a box already. */
sal_Bool InsBoxen( SwTableNode*, SwTableLine*, SwTableBoxFmt*,
- // Formats for TextNode of box.
+ /// Formats for TextNode of box.
SwTxtFmtColl*, const SfxItemSet* pAutoAttr,
sal_uInt16 nInsPos, sal_uInt16 nCnt = 1 );
- // Splits a table at the base-line which contains the index.
- // All base lines behind it are moved to a new table/ -node.
- // Is the flag bCalcNewSize set to TRUE, the new SSize for both
- // tables is calculated from the Maximum of the boxes, provided
- // SSize is set "absolute" (LONG_MAX).
- // (Momentarily this is needed only for the RTF-parser.)
+ /** Splits a table at the base-line which contains the index.
+ All base lines behind it are moved to a new table/ -node.
+ Is the flag bCalcNewSize set to TRUE, the new SSize for both
+ tables is calculated from the Maximum of the boxes, provided
+ SSize is set "absolute" (LONG_MAX).
+ (Momentarily this is needed only for the RTF-parser.) */
SwTableNode* SplitTable( const SwNodeIndex& rPos, sal_Bool bAfter = sal_True,
sal_Bool bCalcNewSize = sal_False );
- // Two Tables that are following one another are merged.
+ /// Two Tables that are following one another are merged.
sal_Bool MergeTable( const SwNodeIndex& rPos, sal_Bool bWithPrev = sal_True,
sal_uInt16 nMode = 0, SwHistory* pHistory = 0 );
- // Insert a new SwSection.
+ /// Insert a new SwSection.
SwSectionNode* InsertTextSection(SwNodeIndex const& rNdIdx,
SwSectionFmt& rSectionFmt,
SwSectionData const&,
@@ -330,14 +330,14 @@ public:
bool const bInsAtStart = true,
bool const bCreateFrms = true);
- // Which Doc contains the nodes-array?
+ /// Which Doc contains the nodes-array?
SwDoc* GetDoc() { return pMyDoc; }
const SwDoc* GetDoc() const { return pMyDoc; }
- // Search previous / next content node or table node with frames.
- // If no end is given begin with the FrameIndex, else start search
- // with that before rFrmIdx and pEnd at the back.
- // If no valid node is found, return 0. rFrmIdx points to the node with frames.
+ /** Search previous / next content node or table node with frames.
+ If no end is given begin with the FrameIndex, else start search
+ with that before rFrmIdx and pEnd at the back.
+ If no valid node is found, return 0. rFrmIdx points to the node with frames. **/
SwNode* FindPrvNxtFrmNode( SwNodeIndex& rFrmIdx,
const SwNode* pEnd = 0 ) const;
diff --git a/sw/inc/ndgrf.hxx b/sw/inc/ndgrf.hxx
index 2dbcdea62697..ddb859bc69ba 100644
--- a/sw/inc/ndgrf.hxx
+++ b/sw/inc/ndgrf.hxx
@@ -46,11 +46,11 @@ class SW_DLLPUBLIC SwGrfNode: public SwNoTxtNode
friend class SwNodes;
GraphicObject aGrfObj;
- ::sfx2::SvBaseLinkRef refLink; // If graphics only as link then pointer is set.
+ ::sfx2::SvBaseLinkRef refLink; ///< If graphics only as link then pointer is set.
Size nGrfSize;
- String aNewStrmName; // SW3/XML: new stream name (either SW3 stream
- // name or package url)
- String aLowResGrf; // HTML: LowRes graphics (substitute until regular HighRes graphics is loaded).
+ String aNewStrmName; /**< SW3/XML: new stream name (either SW3 stream
+ // name or package url) */
+ String aLowResGrf; ///< HTML: LowRes graphics (substitute until regular HighRes graphics is loaded).
sal_Bool bTransparentFlagValid :1;
sal_Bool bInSwapIn :1;
@@ -58,8 +58,8 @@ class SW_DLLPUBLIC SwGrfNode: public SwNoTxtNode
sal_Bool bChgTwipSize :1;
sal_Bool bChgTwipSizeFromPixel :1;
sal_Bool bLoadLowResGrf :1;
- sal_Bool bFrameInPaint :1; // To avoid Start-/EndActions in Paint via SwapIn.
- sal_Bool bScaleImageMap :1; // Scale image map in SetTwipSize.
+ sal_Bool bFrameInPaint :1; ///< To avoid Start-/EndActions in Paint via SwapIn.
+ sal_Bool bScaleImageMap :1; ///< Scale image map in SetTwipSize.
boost::shared_ptr< SwAsyncRetrieveInputStreamThreadConsumer > mpThreadConsumer;
bool mbLinkedInputStreamReady;
@@ -71,7 +71,7 @@ class SW_DLLPUBLIC SwGrfNode: public SwNoTxtNode
const Graphic* pGraphic,
SwGrfFmtColl* pGrfColl,
SwAttrSet* pAutoAttr = 0 );
- // Ctor for reading (SW/G) without graphics.
+ ///< Ctor for reading (SW/G) without graphics.
SwGrfNode( const SwNodeIndex& rWhere,
const String& rGrfName, const String& rFltName,
SwGrfFmtColl* pGrfColl,
@@ -84,11 +84,11 @@ class SW_DLLPUBLIC SwGrfNode: public SwNoTxtNode
void InsertLink( const String& rGrfName, const String& rFltName );
sal_Bool ImportGraphic( SvStream& rStrm );
sal_Bool HasStreamName() const { return aGrfObj.HasUserData(); }
- // adjust return type and rename method to
- // indicate that its an private one.
+ /** adjust return type and rename method to
+ indicate that its an private one. */
- // embedded graphic stream couldn't be inside a 3.1 - 5.2 storage any more.
- // Thus, return value isn't needed any more.
+ /** embedded graphic stream couldn't be inside a 3.1 - 5.2 storage any more.
+ Thus, return value isn't needed any more. */
void _GetStreamStorageNames( String& rStrmName, String& rStgName ) const;
void DelStreamName();
@@ -162,34 +162,34 @@ public:
inline sal_Bool IsScaleImageMap() const { return bScaleImageMap; }
inline void SetScaleImageMap( sal_Bool b ) { bScaleImageMap = b; }
#endif
- // in ndcopy.cxx
+ /// in ndcopy.cxx
virtual SwCntntNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
#ifndef _FESHVIEW_ONLY_INLINE_NEEDED
- // Re-read in case graphic was not OK. The current one
- // gets replaced by the new one.
+ /** Re-read in case graphic was not OK. The current one
+ gets replaced by the new one. */
sal_Bool ReRead( const String& rGrfName, const String& rFltName,
const Graphic* pGraphic = 0,
const GraphicObject* pGrfObj = 0,
sal_Bool bModify = sal_True );
- // Loading of graphic immediately before displaying.
+ /// Loading of graphic immediately before displaying.
short SwapIn( sal_Bool bWaitForData = sal_False );
- // Remove graphic in order to free memory.
+ /// Remove graphic in order to free memory.
short SwapOut();
- // Access to storage stream-name.
+ /// Access to storage stream-name.
void SetStreamName( const String& r ) { aGrfObj.SetUserData( r ); }
void SetNewStreamName( const String& r ) { aNewStrmName = r; }
- // Is this node selected by any shell?
+ /// Is this node selected by any shell?
sal_Bool IsSelected() const;
#endif
- // Communicate to graphic that node is in Undo-range.
+ /// Communicate to graphic that node is in Undo-range.
virtual sal_Bool SavePersistentData();
virtual sal_Bool RestorePersistentData();
#ifndef _FESHVIEW_ONLY_INLINE_NEEDED
- // Query link-data.
+ /// Query link-data.
sal_Bool IsGrfLink() const { return refLink.Is(); }
inline sal_Bool IsLinkedFile() const;
inline sal_Bool IsLinkedDDE() const;
@@ -197,11 +197,11 @@ public:
sal_Bool GetFileFilterNms( String* pFileNm, String* pFilterNm ) const;
void ReleaseLink();
- // Scale an image-map: the image-map becomes zoomed in / out by
- // factor between graphic-size and border-size.
+ /** Scale an image-map: the image-map becomes zoomed in / out by
+ factor between graphic-size and border-size. */
void ScaleImageMap();
- // Returns the with our graphic attributes filled Graphic-Attr-Structure.
+ /// Returns the with our graphic attributes filled Graphic-Attr-Structure.
GraphicAttr& GetGraphicAttr( GraphicAttr&, const SwFrm* pFrm ) const;
#endif
diff --git a/sw/inc/ndhints.hxx b/sw/inc/ndhints.hxx
index 773bb1f4bfaa..e0d8bda4eb3d 100644
--- a/sw/inc/ndhints.hxx
+++ b/sw/inc/ndhints.hxx
@@ -48,7 +48,7 @@ typedef enum {
NEW = false,
} CopyOrNew_t;
-// if COPY then pTxtNode must be given!
+/// if COPY then pTxtNode must be given!
SW_DLLPRIVATE SwTxtAttr *
MakeTxtAttr( SwDoc & rDoc, SfxPoolItem & rNew,
xub_StrLen const nStt, xub_StrLen const nEnd,
@@ -57,19 +57,19 @@ SW_DLLPRIVATE SwTxtAttr *
MakeTxtAttr( SwDoc & rDoc, const SfxItemSet & rSet,
xub_StrLen nStt, xub_StrLen nEnd );
-// create redline dummy text hint that must not be inserted into hints array
+/// create redline dummy text hint that must not be inserted into hints array
SW_DLLPRIVATE SwTxtAttr*
MakeRedlineTxtAttr( SwDoc & rDoc, SfxPoolItem& rAttr );
-// Class SwpHints is derived indirectly via SwpHts, because only the
-// class SwTxtNode should be allowed to insert and remove attributes.
-// Other classes like the Frames are given only reading access via
-// the index-operator.
-// Size when created is 1 because an array is created only if
-// also a hint is inserted.
+/** Class SwpHints is derived indirectly via SwpHts, because only the
+ class SwTxtNode should be allowed to insert and remove attributes.
+ Other classes like the Frames are given only reading access via
+ the index-operator.
+ Size when created is 1 because an array is created only if
+ also a hint is inserted. */
- // Class SwpHtStart/End
+ /// Class SwpHtStart/End
struct CompareSwpHtStart
{
@@ -85,7 +85,7 @@ struct CompareSwpHtEnd
class SwpHtEnd : public o3tl::sorted_vector<SwTxtAttr*, CompareSwpHtEnd,
o3tl::find_partialorder_ptrequals> {};
-// Class SwpHintsArr
+/// Class SwpHintsArr
/// the Hints array
@@ -133,32 +133,32 @@ public:
// Class SwpHints
-// public interface
+/// public interface
class SwpHints : public SwpHintsArray
{
private:
- SwRegHistory* m_pHistory; // for Undo
+ SwRegHistory* m_pHistory; ///< for Undo
- bool m_bFontChange : 1; // font change
- // true: the Node is in Split and Frames are moved
+ bool m_bFontChange : 1; ///< font change
+ /// true: the Node is in Split and Frames are moved
bool m_bInSplitNode : 1;
- // m_bHasHiddenParaField is invalid, call CalcHiddenParaField()
+ /// m_bHasHiddenParaField is invalid, call CalcHiddenParaField()
bool m_bCalcHiddenParaField : 1;
- bool m_bHasHiddenParaField : 1; // HiddenParaFld
- bool m_bFootnote : 1; // footnotes
- bool m_bDDEFields : 1; // the TextNode has DDE fields
+ bool m_bHasHiddenParaField : 1; ///< HiddenParaFld
+ bool m_bFootnote : 1; ///< footnotes
+ bool m_bDDEFields : 1; ///< the TextNode has DDE fields
- // records a new attibute in m_pHistory.
+ /// records a new attibute in m_pHistory.
void NoteInHistory( SwTxtAttr *pAttr, const bool bNew = false );
void CalcFlags( );
- // Delete methods may only be called by the TextNode!
- // Because the TextNode also guarantees removal of the Character for
- // attributes without an end.
+ /** Delete methods may only be called by the TextNode!
+ Because the TextNode also guarantees removal of the Character for
+ attributes without an end. */
friend class SwTxtNode;
void DeleteAtPos( const sal_uInt16 nPos );
- // Delete the given Hint. The Hint must actually be in the array!
+ /// Delete the given Hint. The Hint must actually be in the array!
void Delete( SwTxtAttr* pTxtHt );
inline void SetInSplitNode(bool bInSplit) { m_bInSplitNode = bInSplit; }
@@ -185,9 +185,9 @@ public:
inline bool CanBeDeleted() const { return !Count(); }
- // register a History, which receives all attribute changes (for Undo)
+ /// register a History, which receives all attribute changes (for Undo)
void Register( SwRegHistory* pHist ) { m_pHistory = pHist; }
- // deregister the currently registered History
+ /// deregister the currently registered History
void DeRegister() { Register(0); }
SwRegHistory* GetHistory() const { return m_pHistory; }
@@ -199,17 +199,17 @@ public:
inline bool HasFtn() const { return m_bFootnote; }
inline bool IsInSplitNode() const { return m_bInSplitNode; }
- // calc current value of m_bHasHiddenParaField, returns true iff changed
+ /// calc current value of m_bHasHiddenParaField, returns true iff changed
bool CalcHiddenParaField();
DECL_FIXEDMEMPOOL_NEWDEL(SwpHints)
};
-// Output operator for text hints.
+/// Output operator for text hints.
SvStream &operator<<(SvStream &aS, const SwpHints &rHints); //$ ostream
-// Inline Implementations
+/// Inline Implementations
inline sal_uInt16 SwpHintsArray::GetStartOf( const SwTxtAttr *pHt ) const
diff --git a/sw/inc/ndole.hxx b/sw/inc/ndole.hxx
index f09f39ef1d89..bcad138592e9 100644
--- a/sw/inc/ndole.hxx
+++ b/sw/inc/ndole.hxx
@@ -45,12 +45,12 @@ class SW_DLLPUBLIC SwOLEObj
const SwOLENode* pOLENd;
SwOLEListener_Impl* pListener;
- // Either ref or name are known. If only name is known, ref is obtained
- // on demand by GetOleRef() from Sfx.
+ /** Either ref or name are known. If only name is known, ref is obtained
+ on demand by GetOleRef() from Sfx. */
svt::EmbeddedObjectRef xOLERef;
String aName;
- SwOLEObj( const SwOLEObj& rObj ); // Not allowed.
+ SwOLEObj( const SwOLEObj& rObj ); /// Not allowed.
SwOLEObj();
void SetNode( SwOLENode* pNode );
@@ -71,7 +71,7 @@ public:
const com::sun::star::uno::Reference < com::sun::star::embed::XEmbeddedObject > GetOleRef();
svt::EmbeddedObjectRef& GetObject();
const String& GetCurrentPersistName() const { return aName; }
- sal_Bool IsOleRef() const; // To avoid unneccessary loading of object.
+ sal_Bool IsOleRef() const; ///< To avoid unneccessary loading of object.
#endif
};
@@ -84,9 +84,9 @@ class SW_DLLPUBLIC SwOLENode: public SwNoTxtNode
friend class SwNodes;
mutable SwOLEObj aOLEObj;
Graphic* pGraphic;
- String sChartTblName; // with chart objects: name of referenced table.
- sal_Bool bOLESizeInvalid; // Should be considered at SwDoc::PrtOLENotify
- // (e.g. copied). Is not persistent.
+ String sChartTblName; ///< with chart objects: name of referenced table.
+ sal_Bool bOLESizeInvalid; /**< Should be considered at SwDoc::PrtOLENotify
+ (e.g. copied). Is not persistent. */
SwEmbedObjectLink* mpObjectLink;
String maLinkURL;
@@ -102,7 +102,7 @@ class SW_DLLPUBLIC SwOLENode: public SwNoTxtNode
SwGrfFmtColl *pGrfColl,
SwAttrSet* pAutoAttr = 0 );
- // aOLEObj has a private Copy-Ctor. We need one too:
+ /// aOLEObj has a private Copy-Ctor. We need one too:
SwOLENode( const SwOLENode & );
using SwNoTxtNode::GetGraphic;
@@ -114,7 +114,7 @@ public:
virtual SwCntntNode *SplitCntntNode( const SwPosition & );
- // Is in ndcopy.cxx.
+ /// Is in ndcopy.cxx.
virtual SwCntntNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
virtual Size GetTwipSize() const;
@@ -135,8 +135,8 @@ public:
sal_Int64 GetAspect() const { return aOLEObj.GetObject().GetViewAspect(); }
void SetAspect( sal_Int64 nAspect) { aOLEObj.GetObject().SetViewAspect( nAspect ); }
- // Remove OLE-object from "memory".
- // inline void Unload() { aOLEObj.Unload(); }
+ /** Remove OLE-object from "memory".
+ inline void Unload() { aOLEObj.Unload(); } */
String GetDescription() const { return aOLEObj.GetDescription(); }
sal_Bool UpdateLinkURL_Impl();
@@ -156,7 +156,7 @@ public:
};
-// Inline methods from Node.hxx
+/// Inline methods from Node.hxx
inline SwOLENode *SwNode::GetOLENode()
{
return ND_OLENODE == nNodeType ? (SwOLENode*)this : 0;
diff --git a/sw/inc/ndtxt.hxx b/sw/inc/ndtxt.hxx
index 39565cf4a6fd..603522cd0583 100644
--- a/sw/inc/ndtxt.hxx
+++ b/sw/inc/ndtxt.hxx
@@ -56,14 +56,14 @@ namespace utl {
class SwTxtFmtColl;
class SwCntntFrm;
-class SwTxtFld; // For GetTxtFld().
+class SwTxtFld; ///< For GetTxtFld().
class SfxItemSet;
class SwUndoTransliterate;
-struct SwSpellArgs; // for Spell(), splargs.hxx
-struct SwConversionArgs; // for Convert(), splargs.hxx
-class SwInterHyphInfo; // for Hyphenate(), splargs.hxx
-class SwWrongList; // For OnlineSpelling.
+struct SwSpellArgs; ///< for Spell(), splargs.hxx
+struct SwConversionArgs; ///< for Convert(), splargs.hxx
+class SwInterHyphInfo; ///< for Hyphenate(), splargs.hxx
+class SwWrongList; ///< For OnlineSpelling.
class SwGrammarMarkUp;
class OutputDevice;
class SwScriptInfo;
@@ -83,42 +83,42 @@ typedef std::set< xub_StrLen > SwSoftPageBreakList;
class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
{
- // For creating the first TextNode.
- friend class SwDoc; // CTOR and AppendTxtNode()
+ /// For creating the first TextNode.
+ friend class SwDoc; ///< CTOR and AppendTxtNode()
friend class SwNodes;
friend class SwTxtFrm;
friend class SwScriptInfo;
- // May be 0. It is only then not 0 if it contains hard attributes.
- // Therefore: never access directly!
+ /** May be 0. It is only then not 0 if it contains hard attributes.
+ Therefore: never access directly! */
SwpHints *m_pSwpHints;
- mutable SwNodeNum* mpNodeNum; // Numbering for this paragraph.
+ mutable SwNodeNum* mpNodeNum; ///< Numbering for this paragraph.
XubString m_Text;
SwParaIdleData_Impl* m_pParaIdleData_Impl;
- // Some of the chars this para are hidden. Paragraph has to be reformatted
- // on changing the view to print preview.
+ /** Some of the chars this para are hidden. Paragraph has to be reformatted
+ on changing the view to print preview. */
mutable bool m_bContainsHiddenChars : 1;
- // The whole paragraph is hidden because of the hidden text attribute
+ /// The whole paragraph is hidden because of the hidden text attribute
mutable bool m_bHiddenCharsHidePara : 1;
- // The last two flags have to be recalculated if this flag is set:
+ /// The last two flags have to be recalculated if this flag is set:
mutable bool m_bRecalcHiddenCharFlags : 1;
mutable bool m_bLastOutlineState : 1;
bool m_bNotifiable;
- // sal_uInt8 nOutlineLevel; //#outline level, removed by zhaojianwei.
+ /// sal_uInt8 nOutlineLevel; //#outline level, removed by zhaojianwei.
bool mbEmptyListStyleSetDueToSetOutlineLevelAttr;
- // boolean, indicating that a <SetAttr(..)> or <ResetAttr(..)> or
- // <ResetAllAttr(..)> method is running.
- // Needed to avoid duplicate handling of attribute change actions.
+ /** boolean, indicating that a <SetAttr(..)> or <ResetAttr(..)> or
+ <ResetAllAttr(..)> method is running.
+ Needed to avoid duplicate handling of attribute change actions. */
bool mbInSetOrResetAttr;
- // pointer to the list, to whose the text node is added to
+ /// pointer to the list, to whose the text node is added to
SwList* mpList;
::std::auto_ptr< ::rtl::OUString > m_pNumStringCache;
@@ -129,7 +129,7 @@ class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
SW_DLLPRIVATE SwTxtNode( const SwNodeIndex &rWhere, SwTxtFmtColl *pTxtColl,
const SfxItemSet* pAutoAttr = 0 );
- // Copies the attributes at nStart to pDest.
+ /// Copies the attributes at nStart to pDest.
SW_DLLPRIVATE void CopyAttr( SwTxtNode *pDest, const xub_StrLen nStart, const xub_StrLen nOldPos);
SW_DLLPRIVATE SwTxtNode* _MakeNewTxtNode( const SwNodeIndex&, sal_Bool bNext = sal_True,
@@ -140,17 +140,17 @@ class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
const SwIndex & rStart, /*const*/ xub_StrLen nLen,
const bool bUpdate = true );
- // Move all comprising hard attributes to the AttrSet of the paragraph.
+ /// Move all comprising hard attributes to the AttrSet of the paragraph.
SW_DLLPRIVATE void MoveTxtAttr_To_AttrSet(); // Called by SplitNode.
- // Create the specific AttrSet.
+ /// Create the specific AttrSet.
SW_DLLPRIVATE virtual void NewAttrSet( SwAttrPool& );
SW_DLLPRIVATE void Replace0xFF( XubString& rTxt, xub_StrLen& rTxtStt,
xub_StrLen nEndPos, sal_Bool bExpandFlds ) const;
- // Optimization: Asking for information about hidden characters at SwScriptInfo
- // updates these flags.
+ /// Optimization: Asking for information about hidden characters at SwScriptInfo
+ /// updates these flags.
inline bool IsCalcHiddenCharFlags() const
{ return m_bRecalcHiddenCharFlags; }
inline void SetHiddenCharAttribute( bool bNewHiddenCharsHidePara, bool bNewContainsHiddenChars ) const
@@ -168,9 +168,9 @@ class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
LanguageType nLang, sal_uInt16 nLangWhichId,
const Font *pFont, sal_uInt16 nFontWhichId );
- //
- // Start: Data collected during idle time
- //
+
+ /// Start: Data collected during idle time
+
SW_DLLPRIVATE void SetParaNumberOfWords( sal_uLong nTmpWords ) const;
SW_DLLPRIVATE sal_uLong GetParaNumberOfWords() const;
SW_DLLPRIVATE void SetParaNumberOfAsianWords( sal_uLong nTmpAsianWords ) const;
@@ -195,27 +195,27 @@ public:
bool IsWordCountDirty() const;
bool IsWrongDirty() const;
bool IsGrammarCheckDirty() const;
- bool IsSmartTagDirty() const; // SMARTTAGS
+ bool IsSmartTagDirty() const; ///< SMARTTAGS
bool IsAutoCompleteWordDirty() const;
void SetWordCountDirty( bool bNew ) const;
void SetWrongDirty( bool bNew ) const;
void SetGrammarCheckDirty( bool bNew ) const;
- void SetSmartTagDirty( bool bNew ) const; // SMARTTAGS
+ void SetSmartTagDirty( bool bNew ) const; ///< SMARTTAGS
void SetAutoCompleteWordDirty( bool bNew ) const;
void SetWrong( SwWrongList* pNew, bool bDelete = true );
SwWrongList* GetWrong();
const SwWrongList* GetWrong() const;
void SetGrammarCheck( SwGrammarMarkUp* pNew, bool bDelete = true );
SwGrammarMarkUp* GetGrammarCheck();
- // SMARTTAGS
+ /// SMARTTAGS
void SetSmartTags( SwWrongList* pNew, bool bDelete = true );
SwWrongList* GetSmartTags();
- //
- // End: Data collected during idle time
- //
+
+ /// End: Data collected during idle time
+
protected:
- // fuers Umhaengen der TxtFmtCollections (Outline-Nummerierung!!)
+ /// fuers Umhaengen der TxtFmtCollections (Outline-Nummerierung!!)
virtual void Modify( const SfxPoolItem*, const SfxPoolItem* );
virtual void SwClientNotify( const SwModify&, const SfxHint& );
@@ -224,7 +224,7 @@ public:
const String& GetTxt() const { return m_Text; }
- // getters for SwpHints
+ /// getters for SwpHints
inline SwpHints &GetSwpHints();
inline const SwpHints &GetSwpHints() const;
inline SwpHints *GetpSwpHints() { return m_pSwpHints; }
@@ -236,11 +236,11 @@ public:
virtual xub_StrLen Len() const;
- // Is in itratr.
+ /// Is in itratr.
void GetMinMaxSize( sal_uLong nIndex, sal_uLong& rMin, sal_uLong &rMax, sal_uLong &rAbs,
OutputDevice* pOut = 0 ) const;
- // overriding to handle change of certain paragraph attributes
+ /// overriding to handle change of certain paragraph attributes
virtual sal_Bool SetAttr( const SfxPoolItem& );
virtual sal_Bool SetAttr( const SfxItemSet& rSet );
virtual sal_Bool ResetAttr( sal_uInt16 nWhich1, sal_uInt16 nWhich2 = 0 );
@@ -290,24 +290,24 @@ public:
const xub_StrLen nStart, const xub_StrLen nEnd,
const SetAttrMode nMode = nsSetAttrMode::SETATTR_DEFAULT );
- // Set these attributes at TextNode. If the whole range is comprised
- // set them only in AutoAttrSet (SwCntntNode::SetAttr).
+ /** Set these attributes at TextNode. If the whole range is comprised
+ set them only in AutoAttrSet (SwCntntNode::SetAttr). */
sal_Bool SetAttr( const SfxItemSet& rSet,
xub_StrLen nStt, xub_StrLen nEnd,
const SetAttrMode nMode = nsSetAttrMode::SETATTR_DEFAULT );
- // Query the attributes of textnode over the range.
- // Introduce 4th optional parameter <bMergeIndentValuesOfNumRule>.
- // If <bMergeIndentValuesOfNumRule> == sal_True, the indent attributes of
- // the corresponding list level of an applied list style is merged into
- // the requested item set as a LR-SPACE item, if <bOnlyTxtAttr> == sal_False,
- // corresponding node has not its own indent attributes and the
- // position-and-space mode of the list level is SvxNumberFormat::LABEL_ALIGNMENT.
+ /** Query the attributes of textnode over the range.
+ Introduce 4th optional parameter <bMergeIndentValuesOfNumRule>.
+ If <bMergeIndentValuesOfNumRule> == sal_True, the indent attributes of
+ the corresponding list level of an applied list style is merged into
+ the requested item set as a LR-SPACE item, if <bOnlyTxtAttr> == sal_False,
+ corresponding node has not its own indent attributes and the
+ position-and-space mode of the list level is SvxNumberFormat::LABEL_ALIGNMENT. */
sal_Bool GetAttr( SfxItemSet& rSet, xub_StrLen nStt, xub_StrLen nEnd,
sal_Bool bOnlyTxtAttr = sal_False,
sal_Bool bGetFromChrFmt = sal_True,
const bool bMergeIndentValuesOfNumRule = false ) const;
- // Convey attributes of an AttrSet (AutoFmt) to SwpHintsArray.
+ /// Convey attributes of an AttrSet (AutoFmt) to SwpHintsArray.
void FmtToTxtAttr( SwTxtNode* pNd );
/// delete all attributes of type nWhich at nStart (opt. end nEnd)
@@ -316,8 +316,8 @@ public:
/// delete the attribute pTxtAttr
void DeleteAttribute ( SwTxtAttr * const pTxtAttr );
- // Actions on text and attributes.
- // introduce optional parameter to control, if all attributes have to be copied.
+ /** Actions on text and attributes.
+ introduce optional parameter to control, if all attributes have to be copied. */
void CopyText( SwTxtNode * const pDest,
const SwIndex &rStart,
const xub_StrLen nLen,
@@ -339,7 +339,7 @@ public:
void ReplaceTextOnly( xub_StrLen nPos, xub_StrLen nLen, const XubString& rText,
const ::com::sun::star::uno::Sequence<sal_Int32>& rOffsets );
- // Virtual methods from CntntNode.
+ /// Virtual methods from CntntNode.
virtual SwCntntFrm *MakeFrm( SwFrm* );
virtual SwCntntNode *SplitCntntNode( const SwPosition & );
virtual SwCntntNode *JoinNext();
@@ -347,7 +347,7 @@ public:
SwCntntNode *AppendNode( const SwPosition & );
- // When appropriate set DontExpand-flag at INet or character styles respectively.
+ /// When appropriate set DontExpand-flag at INet or character styles respectively.
sal_Bool DontExpandFmt( const SwIndex& rIdx, bool bFlag = true,
sal_Bool bFmtToTxtAttributes = sal_True );
@@ -395,9 +395,9 @@ public:
void _ChgTxtCollUpdateNum( const SwTxtFmtColl* pOld,
const SwTxtFmtColl* pNew );
- // Copy collection with all auto formats to dest-node.
- // The latter might be in an other document!
- // (Method in ndcopy.cxx!!).
+ /** Copy collection with all auto formats to dest-node.
+ The latter might be in an other document!
+ (Method in ndcopy.cxx!!). */
void CopyCollFmt( SwTxtNode& rDestNd );
//const SwNodeNum* _GetNodeNum() const { return pNdNum; }
@@ -675,20 +675,20 @@ public:
sal_uInt16 GetLang( const xub_StrLen nBegin, const xub_StrLen nLen = 0,
sal_uInt16 nScript = 0 ) const;
- // in ndcopy.cxx
+ /// in ndcopy.cxx
sal_Bool IsSymbol( const xub_StrLen nBegin ) const; // In itratr.cxx.
virtual SwCntntNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
- // Interactive hyphenation: we find TxtFrm and call its CalcHyph.
+ /// Interactive hyphenation: we find TxtFrm and call its CalcHyph.
sal_Bool Hyphenate( SwInterHyphInfo &rHyphInf );
void DelSoftHyph( const xub_StrLen nStart, const xub_StrLen nEnd );
- // add 4th optional parameter <bAddSpaceAfterListLabelStr> indicating,
- // when <bWithNum = true> that a space is inserted after the string for
- // the list label.
- // add 5th optional parameter <bWithSpacesForLevel> indicating, if additional
- // spaces are inserted in front of the expanded text string depending on
- // the list level.
+ /** add 4th optional parameter <bAddSpaceAfterListLabelStr> indicating,
+ when <bWithNum = true> that a space is inserted after the string for
+ the list label.
+ add 5th optional parameter <bWithSpacesForLevel> indicating, if additional
+ spaces are inserted in front of the expanded text string depending on
+ the list level. */
XubString GetExpandTxt( const xub_StrLen nIdx = 0,
const xub_StrLen nLen = STRING_LEN,
const bool bWithNum = false,
@@ -704,27 +704,27 @@ public:
sal_Bool bExpandFlds = sal_False,
sal_Bool bWithNum = sal_False ) const;
- // Returns actual count of initial chars for initial-function.
- // If nWishLen == 0 that of first word.
+ /** @return actual count of initial chars for initial-function.
+ If nWishLen == 0 that of first word. */
sal_uInt16 GetDropLen( sal_uInt16 nWishLen) const;
- // Passes back info needed on the dropcap dimensions
+ /// Passes back info needed on the dropcap dimensions
bool GetDropSize(int& rFontHeight, int& rDropHeight, int& rDropDescent) const;
- // Hidden Paragraph Field:
+ /// Hidden Paragraph Field:
inline bool CalcHiddenParaField()
{ return m_pSwpHints ? m_pSwpHints->CalcHiddenParaField() : false; }
- // set CalcVisible flags
+ /// set CalcVisible flags
inline void SetCalcHiddenParaField()
{ if (m_pSwpHints) m_pSwpHints->SetCalcHiddenParaField(); }
- // is the paragraph visible?
+ /// is the paragraph visible?
inline bool HasHiddenParaField() const
{ return m_pSwpHints ? m_pSwpHints->HasHiddenParaField() : false; }
- //
- // Hidden Paragraph Field:
- //
+
+ /// Hidden Paragraph Field:
+
inline bool HasHiddenCharAttribute( bool bWholePara ) const
{
if ( m_bRecalcHiddenCharFlags )
@@ -735,33 +735,33 @@ public:
inline void SetCalcHiddenCharFlags() const
{ m_bRecalcHiddenCharFlags = true; }
- //
- // Returns if the node is hidden due to
- // 1. HiddenParaField
- // 2. HiddenCharAttribute
- // 3. HiddenSection
- //
+
+ /** @return if the node is hidden due to
+ 1. HiddenParaField
+ 2. HiddenCharAttribute
+ 3. HiddenSection */
+
bool IsHidden() const;
TYPEINFO(); // fuer rtti
- // override SwIndexReg
+ /// override SwIndexReg
virtual void Update( SwIndex const & rPos, const xub_StrLen nChangeLen,
const bool bNegative = false, const bool bDelete = false );
- // change text to Upper/Lower/Hiragana/Katagana/...
+ /// change text to Upper/Lower/Hiragana/Katagana/...
void TransliterateText( utl::TransliterationWrapper& rTrans,
xub_StrLen nStart, xub_StrLen nEnd,
SwUndoTransliterate* pUndo = 0 );
- // count words in given range
+ /// count words in given range
void CountWords( SwDocStat& rStat, xub_StrLen nStart, xub_StrLen nEnd ) const;
- // Checks some global conditions like loading or destruction of document
- // to economize notifications
+ /** Checks some global conditions like loading or destruction of document
+ to economize notifications */
bool IsNotificationEnabled() const;
- // Checks a temporary notification blocker and the global conditons of IsNotificationEnabled()
+ /// Checks a temporary notification blocker and the global conditons of IsNotificationEnabled()
bool IsNotifiable() const;
void SetListRestart( bool bRestart );
@@ -790,7 +790,7 @@ public:
::com::sun::star::text::XTextContent> const& xParagraph)
{ m_wXParagraph = xParagraph; }
- // sfx2::Metadatable
+ /// sfx2::Metadatable
virtual ::sfx2::IXmlIdRegistry& GetRegistry();
virtual bool IsInClipboard() const;
virtual bool IsInUndo() const;
@@ -847,7 +847,7 @@ inline SwTxtFmtColl* SwTxtNode::GetTxtColl() const
return static_cast<SwTxtFmtColl*>(const_cast<SwModify*>(GetRegisteredIn()));
}
-// Inline methods from Node.hxx
+/// Inline methods from Node.hxx
inline SwTxtNode *SwNode::GetTxtNode()
{
return ND_TEXTNODE == nNodeType ? static_cast<SwTxtNode*>(this) : 0;
generated by cgit (git 2.34.1) at 2024-12-28 07:01:45 +0000