Skip to content

C
core
Kaydet (Commit) 96111e25 authored tarafından Abdulmajeed Al-Abaulrazzaq's avatar Abdulmajeed Al-Abaulrazzaq Kaydeden (comit) Michael Stahl
Dosyalara gözat
Seçenekler

Modifying comments to meet doxygen standards 

Change-Id: Ibc60c20241b70492aaebcebccb738c7e11fdbb41
Reviewed-on: https://gerrit.libreoffice.org/638Reviewed-by: 's avatarMichael Stahl <mstahl@redhat.com>
Tested-by: 's avatarMichael Stahl <mstahl@redhat.com>
üst fe4c47e4
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 163 additions and 163 deletions
sw/inc/node.hxx
Dosyayı görüntüle @ 96111e25
This diff is collapsed.
sw/inc/numrule.hxx
Dosyayı görüntüle @ 96111e25
......@@ -52,7 +52,7 @@ class SwDoc;
class SwFmtVertOrient;
class SwTxtNode;
const sal_Unicode cBulletChar = 0x2022; // Character for lists.
const sal_Unicode cBulletChar = 0x2022; ///< Character for lists.
class SW_DLLPUBLIC SwNumFmt : public SvxNumberFormat, public SwClient
{
......@@ -116,7 +116,7 @@ private:
static SwNumFmt* aBaseFmts [ RULE_END ][ MAXLEVEL ];
static sal_uInt16 aDefNumIndents[ MAXLEVEL ];
// default list level properties for position-and-space mode LABEL_ALIGNMENT
/// default list level properties for position-and-space mode LABEL_ALIGNMENT
static SwNumFmt* aLabelAlignmentBaseFmts [ RULE_END ][ MAXLEVEL ];
static sal_uInt16 nRefCount;
static char* pDefOutlineName;
......@@ -134,20 +134,20 @@ private:
String sName;
SwNumRuleType eRuleType;
sal_uInt16 nPoolFmtId; // Id-for NumRules created "automatically"
sal_uInt16 nPoolHelpId; // HelpId for this Pool-style.
sal_uInt8 nPoolHlpFileId; // FilePos at Doc on style helps.
sal_uInt16 nPoolFmtId; ///< Id-for NumRules created "automatically"
sal_uInt16 nPoolHelpId; ///< HelpId for this Pool-style.
sal_uInt8 nPoolHlpFileId; ///< FilePos at Doc on style helps.
sal_Bool bAutoRuleFlag : 1;
sal_Bool bInvalidRuleFlag : 1;
sal_Bool bContinusNum : 1; // Continuous numbering without levels.
sal_Bool bAbsSpaces : 1; // Levels represent absolute indents.
sal_Bool bContinusNum : 1; ///< Continuous numbering without levels.
sal_Bool bAbsSpaces : 1; ///< Levels represent absolute indents.
bool mbCountPhantoms;
const SvxNumberFormat::SvxNumPositionAndSpaceMode meDefaultNumberFormatPositionAndSpaceMode;
String msDefaultListId;
public:
// add parameter <eDefaultNumberFormatPositionAndSpaceMode>
/// add parameter <eDefaultNumberFormatPositionAndSpaceMode>
SwNumRule( const String& rNm,
const SvxNumberFormat::SvxNumPositionAndSpaceMode eDefaultNumberFormatPositionAndSpaceMode,
SwNumRuleType = NUM_RULE,
......@@ -167,8 +167,8 @@ public:
void Set( sal_uInt16 i, const SwNumFmt& );
String MakeNumString( const SwNodeNum&, sal_Bool bInclStrings = sal_True,
sal_Bool bOnlyArabic = sal_False ) const;
// - add optional parameter <_nRestrictToThisLevel> in order to
// restrict returned string to this level.
/** - add optional parameter <_nRestrictToThisLevel> in order to
restrict returned string to this level. */
String MakeNumString( const SwNumberTree::tNumberVector & rNumVector,
const sal_Bool bInclStrings = sal_True,
const sal_Bool bOnlyArabic = sal_False,
......@@ -178,7 +178,7 @@ public:
const bool bInclSuperiorNumLabels = false,
const sal_uInt8 nRestrictInclToThisLevel = 0 ) const;
/** Returns list of associated text nodes.
/**
@return list of associated text nodes
*/
......@@ -217,13 +217,13 @@ public:
void SetRuleType( SwNumRuleType eNew ) { eRuleType = eNew;
bInvalidRuleFlag = sal_True; }
// A kind of copy-constructor to make sure the num formats are
// attached to the correctCharFormats of a document!!
// (Copies the NumFormats and returns itself).
/** A kind of copy-constructor to make sure the num formats are
attached to the correctCharFormats of a document!!
(Copies the NumFormats and returns itself). */
SwNumRule& CopyNumRule( SwDoc*, const SwNumRule& );
// Tests whether the CharFormats are from the given doc
// and copies them if appropriate.
/** Tests whether the CharFormats are from the given doc
and copies them if appropriate. */
void CheckCharFmts( SwDoc* pDoc );
const String& GetName() const { return sName; }
......@@ -248,11 +248,11 @@ public:
bool IsCountPhantoms() const;
void SetCountPhantoms(bool bCountPhantoms);
// Query and set PoolFormat IDs.
/// Query and set PoolFormat IDs.
sal_uInt16 GetPoolFmtId() const { return nPoolFmtId; }
void SetPoolFmtId( sal_uInt16 nId ) { nPoolFmtId = nId; }
// Query and set Help-IDs for document styles.
/// Query and set Help-IDs for document styles.
sal_uInt16 GetPoolHelpId() const { return nPoolHelpId; }
void SetPoolHelpId( sal_uInt16 nId ) { nPoolHelpId = nId; }
sal_uInt8 GetPoolHlpFileId() const { return nPoolHlpFileId; }
......@@ -261,19 +261,19 @@ public:
void SetSvxRule(const SvxNumRule&, SwDoc* pDoc);
SvxNumRule MakeSvxNumRule() const;
// change indent of all list levels by given difference
/// change indent of all list levels by given difference
void ChangeIndent( const short nDiff );
// set indent of certain list level to given value
/// set indent of certain list level to given value
void SetIndent( const short nNewIndent,
const sal_uInt16 nListLevel );
// 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 SetIndentOfFirstListLevelAndChangeOthers( const short nNewIndent );
void Validate();
};
// namespace for static functions and methods for numbering and bullets
/// namespace for static functions and methods for numbering and bullets
namespace numfunc
{
/** retrieve font family name used for the default bullet list characters
......
sw/inc/pagedesc.hxx
Dosyayı görüntüle @ 96111e25
......@@ -32,7 +32,7 @@
#include <tools/color.hxx>
#include <tools/string.hxx>
#include "swdllapi.h"
#include <swtypes.hxx> // For SwTwips.
#include <swtypes.hxx> ///< For SwTwips.
#include <frmfmt.hxx>
#include <editeng/numitem.hxx>
#include <editeng/borderline.hxx>
......@@ -41,7 +41,7 @@ class SfxPoolItem;
class SwTxtFmtColl;
class SwNode;
// Separator line adjustment.
/// Separator line adjustment.
enum SwFtnAdj
{
FTNADJ_LEFT,
......@@ -49,17 +49,17 @@ enum SwFtnAdj
FTNADJ_RIGHT
};
// Footnote information.
/// Footnote information.
class SW_DLLPUBLIC SwPageFtnInfo
{
SwTwips nMaxHeight; //maximum height of the footnote area.
sal_uLong nLineWidth; //width of separator line
editeng::SvxBorderStyle eLineStyle; // Style of the separator line
Color aLineColor; //color of the separator line
Fraction aWidth; //percentage width of the separator line.
SwFtnAdj eAdj; //line adjustment.
SwTwips nTopDist; //distance between body and separator.
SwTwips nBottomDist; //distance between separator and first footnote
SwTwips nMaxHeight; ///< maximum height of the footnote area.
sal_uLong nLineWidth; ///< width of separator line
editeng::SvxBorderStyle eLineStyle; ///< Style of the separator line
Color aLineColor; ///< color of the separator line
Fraction aWidth; ///< percentage width of the separator line.
SwFtnAdj eAdj; ///< line adjustment.
SwTwips nTopDist; ///< distance between body and separator.
SwTwips nBottomDist; ///< distance between separator and first footnote
public:
SwTwips GetHeight() const { return nMaxHeight; }
......@@ -124,7 +124,7 @@ public:
typedef sal_uInt16 UseOnPage;
namespace nsUseOnPage
{
const UseOnPage PD_NONE = 0x0000; // For internal use only.
const UseOnPage PD_NONE = 0x0000; ///< For internal use only.
const UseOnPage PD_LEFT = 0x0001;
const UseOnPage PD_RIGHT = 0x0002;
const UseOnPage PD_FIRST = 0x0004;
......@@ -132,8 +132,8 @@ namespace nsUseOnPage
const UseOnPage PD_MIRROR = 0x000F;
const UseOnPage PD_HEADERSHARE = 0x0040;
const UseOnPage PD_FOOTERSHARE = 0x0080;
const UseOnPage PD_NOHEADERSHARE = 0xFFBF; // For internal use only.
const UseOnPage PD_NOFOOTERSHARE = 0xFF7F; // For internal use only.
const UseOnPage PD_NOHEADERSHARE = 0xFFBF; ///< For internal use only.
const UseOnPage PD_NOFOOTERSHARE = 0xFF7F; ///< For internal use only.
const UseOnPage PD_FIRSTSHARE = 0x0100;
const UseOnPage PD_NOFIRSTSHARE = 0xFEFF;
}
......@@ -147,18 +147,18 @@ class SW_DLLPUBLIC SwPageDesc : public SwModify
SwFrmFmt aMaster;
SwFrmFmt aLeft;
SwFrmFmt aFirst;
SwDepend aDepend; // Because of grid alignment (Registerhaltigkeit).
SwDepend aDepend; ///< Because of grid alignment (Registerhaltigkeit).
SwPageDesc *pFollow;
sal_uInt16 nRegHeight; // Sentence spacing and fontascent of style.
sal_uInt16 nRegAscent; // For grid alignment (Registerhaltigkeit).
sal_uInt16 nRegHeight; ///< Sentence spacing and fontascent of style.
sal_uInt16 nRegAscent; ///< For grid alignment (Registerhaltigkeit).
UseOnPage eUse;
sal_Bool bLandscape;
// Footnote information.
/// Footnote information.
SwPageFtnInfo aFtnInfo;
// Called for mirroring of Chg (doc).
// No adjustment at any other place.
/** Called for mirroring of Chg (doc).
No adjustment at any other place. */
SW_DLLPRIVATE void Mirror();
SW_DLLPRIVATE void ResetAllAttr( sal_Bool bLeft );
......@@ -202,13 +202,13 @@ public:
const SwFrmFmt &GetLeft() const { return aLeft; }
const SwFrmFmt &GetFirst() const { return aFirst; }
// Reset all attrs of the format but keep the ones a pagedesc
// cannot live without.
/** Reset all attrs of the format but keep the ones a pagedesc
cannot live without. */
inline void ResetAllMasterAttr();
inline void ResetAllLeftAttr();
// Layout uses the following methods to obtain a format in order
// to be able to create a page.
/** Layout uses the following methods to obtain a format in order
to be able to create a page. */
inline SwFrmFmt *GetRightFmt();
inline const SwFrmFmt *GetRightFmt() const;
inline SwFrmFmt *GetLeftFmt();
......@@ -229,7 +229,7 @@ public:
const SwTxtFmtColl* GetRegisterFmtColl() const;
void RegisterChange();
// Query and set PoolFormat-Id.
/// Query and set PoolFormat-Id.
sal_uInt16 GetPoolFmtId() const { return aMaster.GetPoolFmtId(); }
void SetPoolFmtId( sal_uInt16 nId ) { aMaster.SetPoolFmtId( nId ); }
sal_uInt16 GetPoolHelpId() const { return aMaster.GetPoolHelpId(); }
......@@ -237,14 +237,14 @@ public:
sal_uInt8 GetPoolHlpFileId() const { return aMaster.GetPoolHlpFileId(); }
void SetPoolHlpFileId( sal_uInt8 nId ) { aMaster.SetPoolHlpFileId( nId ); }
// Query information from Client.
/// Query information from Client.
virtual sal_Bool GetInfo( SfxPoolItem& ) const;
const SwFrmFmt* GetPageFmtOfNode( const SwNode& rNd,
sal_Bool bCheckForThisPgDc = sal_True ) const;
sal_Bool IsFollowNextPageOfNode( const SwNode& rNd ) const;
//Given a SwNode return the pagedesc in use at that location.
/// Given a SwNode return the pagedesc in use at that location.
static const SwPageDesc* GetPageDescOfNode(const SwNode& rNd);
SwPageDesc& operator=( const SwPageDesc& );
......
sw/inc/pagepreviewlayout.hxx
Dosyayı görüntüle @ 96111e25
......@@ -27,26 +27,26 @@ class SwPagePreviewLayout
private:
friend class ViewShell;
// number of horizontal and vertical twips for spacing between the pages.
/// number of horizontal and vertical twips for spacing between the pages.
const SwTwips mnXFree;
const SwTwips mnYFree;
// view shell the print preview is generated for.
/// view shell the print preview is generated for.
ViewShell& mrParentViewShell;
// top layout frame of the layout for accessing the pages
/// top layout frame of the layout for accessing the pages
const SwRootFrm& mrLayoutRootFrm;
// boolean indicating, if the layout information (number of columns and rows)
// are valid.
/** boolean indicating, if the layout information (number of columns and rows)
are valid. */
bool mbLayoutInfoValid;
// boolean indicating, if the the calculated print preview layout sizes
// ( windows size in twips, maximal page size, column width, row height,
// width and height of a print preview page, size of the print preview
// document ) are valid
/** boolean indicating, if the the calculated print preview layout sizes
( windows size in twips, maximal page size, column width, row height,
width and height of a print preview page, size of the print preview
document ) are valid */
bool mbLayoutSizesValid;
// boolean indicating, if the the paint information ( physical number of
// start page, start column and row, paint offsets, rectangle visible of
// the print preview document.
/** boolean indicating, if the the paint information ( physical number of
start page, start column and row, paint offsets, rectangle visible of
the print preview document. */
bool mbPaintInfoValid;
Size maWinSize;
......@@ -78,8 +78,8 @@ private:
std::vector<PrevwPage*> maPrevwPages;
// #i22014# - internal booleans to indicate, that a new print
// preview layout has been created during a paint.
/** #i22014# - internal booleans to indicate, that a new print
preview layout has been created during a paint. */
mutable bool mbInPaint;
mutable bool mbNewLayoutDuringPaint;
......
sw/inc/pam.hxx
Dosyayı görüntüle @ 96111e25
......@@ -28,13 +28,13 @@
#ifndef _PAM_HXX
#define _PAM_HXX
#include <stddef.h> // For MemPool.
#include <stddef.h> ///< For MemPool.
#include <tools/gen.hxx>
#include <tools/mempool.hxx>
#include <cshtyp.hxx> // For function definitions.
#include <ring.hxx> // Super class.
#include <index.hxx> // For SwIndex.
#include <ndindex.hxx> // For SwNodeIndex.
#include <cshtyp.hxx> ///< For function definitions.
#include <ring.hxx> ///< Super class.
#include <index.hxx> ///< For SwIndex.
#include <ndindex.hxx> ///< For SwNodeIndex.
#include "swdllapi.h"
class SwFmt;
......@@ -85,15 +85,15 @@ struct SW_DLLPUBLIC SwPosition
// Result of comparing positions.
enum SwComparePosition {
POS_BEFORE, // Pos1 before Pos2.
POS_BEHIND, // Pos1 behind Pos2.
POS_INSIDE, // Pos1 completely contained in Pos2.
POS_OUTSIDE, // Pos2 completely contained in Pos1.
POS_EQUAL, // Pos1 is as large as Pos2.
POS_OVERLAP_BEFORE, // Pos1 overlaps Pos2 at the beginning.
POS_OVERLAP_BEHIND, // Pos1 overlaps Pos2 at the end.
POS_COLLIDE_START, // Pos1 start touches at Pos2 end.
POS_COLLIDE_END // Pos1 end touches at Pos2 start.
POS_BEFORE, ///< Pos1 before Pos2.
POS_BEHIND, ///< Pos1 behind Pos2.
POS_INSIDE, ///< Pos1 completely contained in Pos2.
POS_OUTSIDE, ///< Pos2 completely contained in Pos1.
POS_EQUAL, ///< Pos1 is as large as Pos2.
POS_OVERLAP_BEFORE, ///< Pos1 overlaps Pos2 at the beginning.
POS_OVERLAP_BEHIND, ///< Pos1 overlaps Pos2 at the end.
POS_COLLIDE_START, ///< Pos1 start touches at Pos2 end.
POS_COLLIDE_END ///< Pos1 end touches at Pos2 start.
};
template<typename T>
......@@ -141,17 +141,17 @@ SwComparePosition ComparePosition(
return nRet;
}
// SwPointAndMark / SwPaM
/// SwPointAndMark / SwPaM
struct SwMoveFnCollection;
typedef SwMoveFnCollection* SwMoveFn;
SW_DLLPUBLIC extern SwMoveFn fnMoveForward; // SwPam::Move()/Find() default argument.
SW_DLLPUBLIC extern SwMoveFn fnMoveForward; ///< SwPam::Move()/Find() default argument.
SW_DLLPUBLIC extern SwMoveFn fnMoveBackward;
typedef sal_Bool (*SwGoInDoc)( SwPaM& rPam, SwMoveFn fnMove );
SW_DLLPUBLIC extern SwGoInDoc fnGoDoc;
extern SwGoInDoc fnGoSection;
SW_DLLPUBLIC extern SwGoInDoc fnGoNode;
SW_DLLPUBLIC extern SwGoInDoc fnGoCntnt; // SwPam::Move() default argument.
SW_DLLPUBLIC extern SwGoInDoc fnGoCntnt; ///< SwPam::Move() default argument.
extern SwGoInDoc fnGoCntntCells;
extern SwGoInDoc fnGoCntntSkipHidden;
extern SwGoInDoc fnGoCntntCellsSkipHidden;
......@@ -163,8 +163,8 @@ class SW_DLLPUBLIC SwPaM : public Ring
{
SwPosition m_Bound1;
SwPosition m_Bound2;
SwPosition * m_pPoint; // points at either m_Bound1 or m_Bound2
SwPosition * m_pMark; // points at either m_Bound1 or m_Bound2
SwPosition * m_pPoint; ///< points at either m_Bound1 or m_Bound2
SwPosition * m_pMark; ///< points at either m_Bound1 or m_Bound2
bool m_bIsInFrontOfLabel;
SwPaM* MakeRegion( SwMoveFn fnMove, const SwPaM * pOrigRg = 0 );
......@@ -184,16 +184,16 @@ public:
SwPaM( const SwNodeIndex& rNd, xub_StrLen nCntnt = 0, SwPaM* pRing = 0 );
virtual ~SwPaM();
// @@@ semantic: no copy ctor.
/// @@@ semantic: no copy ctor.
SwPaM( SwPaM & );
// @@@ semantic: no copy assignment for super class Ring.
/// @@@ semantic: no copy assignment for super class Ring.
SwPaM& operator=( const SwPaM & );
// Movement of cursor.
/// Movement of cursor.
sal_Bool Move( SwMoveFn fnMove = fnMoveForward,
SwGoInDoc fnGo = fnGoCntnt );
// Search.
/// Search.
sal_uInt8 Find( const com::sun::star::util::SearchOptions& rSearchOpt,
sal_Bool bSearchInNotes,
utl::TextSearch& rSTxt,
......@@ -222,8 +222,8 @@ public:
{
if (m_pMark != m_pPoint)
{
// clear the mark position; this helps if mark's SwIndex is
// registered at some node, and that node is then deleted
/** clear the mark position; this helps if mark's SwIndex is
registered at some node, and that node is then deleted */
*m_pMark = SwPosition( SwNodeIndex( GetNode()->GetNodes() ) );
m_pMark = m_pPoint;
}
......@@ -291,11 +291,11 @@ public:
const SwPosition& GetBound( bool bOne = true ) const
{ return bOne ? m_Bound1 : m_Bound2; }
// Get number of page which contains cursor.
/// Get number of page which contains cursor.
sal_uInt16 GetPageNum( sal_Bool bAtPoint = sal_True, const Point* pLayPos = 0 );
// Is in something protected (readonly) or selection contains
// something protected.
/** Is in something protected (readonly) or selection contains
something protected. */
sal_Bool HasReadonlySel( bool bFormView ) const;
sal_Bool ContainsPosition(const SwPosition & rPos)
......
sw/inc/paratr.hxx
Dosyayı görüntüle @ 96111e25
......@@ -42,21 +42,21 @@ class IntlWrapper;
#define DROP_WHOLEWORD ((sal_uInt16)0x0001)
// If SwFmtDrop is a Client, it is the CharFmt that describes the font for the
// DropCaps. If it is not a Client, formating uses the CharFmt of the paragraph.
// If the CharFmt is modified, this change is propagated to the paragraphs
// via the Modify of SwFmtDrop.
/** If SwFmtDrop is a Client, it is the CharFmt that describes the font for the
DropCaps. If it is not a Client, formating uses the CharFmt of the paragraph.
If the CharFmt is modified, this change is propagated to the paragraphs
via the Modify of SwFmtDrop. */
class SW_DLLPUBLIC SwFmtDrop: public SfxPoolItem, public SwClient
{
SwModify* pDefinedIn; // Modify-Object, that contains DropCaps.
// Can only be TxtFmtCollection/TxtNode.
sal_uInt16 nDistance; // Distance to beginning of text.
sal_uInt16 nReadFmt; // For Sw3-Reader: CharFormat-Id (load Pool!).
sal_uInt8 nLines; // Line count.
sal_uInt8 nChars; // Character count.
sal_Bool bWholeWord; // First word with initials.
SwModify* pDefinedIn; /**< Modify-Object, that contains DropCaps.
Can only be TxtFmtCollection/TxtNode. */
sal_uInt16 nDistance; ///< Distance to beginning of text.
sal_uInt16 nReadFmt; ///< For Sw3-Reader: CharFormat-Id (load Pool!).
sal_uInt8 nLines; ///< Line count.
sal_uInt8 nChars; ///< Character count.
sal_Bool bWholeWord; ///< First word with initials.
public:
TYPEINFO(); // Already in base class SwClient.
TYPEINFO(); ///< Already in base class SwClient.
SwFmtDrop();
virtual ~SwFmtDrop();
......@@ -72,7 +72,7 @@ protected:
public:
// "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,
......@@ -98,10 +98,10 @@ public:
inline const SwCharFmt *GetCharFmt() const { return (SwCharFmt*)GetRegisteredIn(); }
inline SwCharFmt *GetCharFmt() { return (SwCharFmt*)GetRegisteredIn(); }
void SetCharFmt( SwCharFmt *pNew );
// Get information from Client.
/// Get information from Client.
virtual sal_Bool GetInfo( SfxPoolItem& ) const;
// Get and set Modify pointer.
/// Get and set Modify pointer.
inline const SwModify* GetDefinedIn() const { return pDefinedIn; }
inline void ChgDefinedIn( const SwModify* pNew )
{ pDefinedIn = (SwModify*)pNew; }
......@@ -114,10 +114,10 @@ public:
inline SwRegisterItem( const sal_Bool bRegister = sal_False );
// @@@ public copy assignment, but no copy ctor?
/// @@@ public copy assignment, but no copy ctor?
inline SwRegisterItem& operator=( const SwRegisterItem& rRegister );
// "pure virtual methods" of SfxPoolItem
/// "pure virtual methods" of SfxPoolItem
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
......@@ -154,7 +154,7 @@ public:
SwNumRuleItem& operator=( const SwNumRuleItem& rCpy )
{ SetValue( rCpy.GetValue() ); return *this; }
// "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,
......@@ -174,10 +174,10 @@ public:
inline SwParaConnectBorderItem( const sal_Bool bConnect = sal_True );
// @@@ public copy assignment, but no copy ctor?
/// @@@ public copy assignment, but no copy ctor?
inline SwParaConnectBorderItem& operator=( const SwParaConnectBorderItem& rConnect );
// "pure virtual methods" of SfxPoolItem
/// "pure virtual methods" of SfxPoolItem
virtual SfxPoolItem* Clone( SfxItemPool *pPool = 0 ) const;
virtual SfxItemPresentation GetPresentation( SfxItemPresentation ePres,
SfxMapUnit eCoreMetric,
......
sw/inc/poolfmt.hxx
Dosyayı görüntüle @ 96111e25
This diff is collapsed.
sw/inc/printdata.hxx
Dosyayı görüntüle @ 96111e25
......@@ -71,10 +71,10 @@ public:
bPrintLeftPages, bPrintRightPages, bPrintReverse, bPrintProspect,
bPrintProspectRTL,
bPrintSingleJobs, bPaperFromSetup,
// Print empty pages
/// Print empty pages
bPrintEmptyPages,
// #i56195# no field update while printing mail merge documents
/// #i56195# no field update while printing mail merge documents
bUpdateFieldsInPrinting,
bModified;
......@@ -135,8 +135,8 @@ public:
bPrintTextPlaceholder == rData.bPrintTextPlaceholder;
}
// Note: in the context where this class ist used the pointers should always be valid
// during the lifetime of this object
/** Note: in the context where this class ist used the pointers should always be valid
during the lifetime of this object */
const SwPrintUIOptions & GetPrintUIOptions() const { return *m_pPrintUIOptions; }
const SwRenderData & GetRenderData() const { return *m_pRenderData; }
void SetPrintUIOptions( const SwPrintUIOptions *pOpt ) { m_pPrintUIOptions = pOpt; }
......@@ -220,34 +220,34 @@ public:
////////////////////////////////////////////////////////////
// A class that stores temporary data that is needed for rendering the document.
// Usually this data is created when 'getRendererCount' is called and
// and it is used in the 'render' function of that same interface
/** A class that stores temporary data that is needed for rendering the document.
Usually this data is created when 'getRendererCount' is called and
and it is used in the 'render' function of that same interface */
class SwRenderData
{
// pages valid for printing (according to the current settings)
// This set of pages does NOT depend on the 'PageRange' that is used as a printing option!
std::set< sal_Int32 > m_aValidPages; // the set of possible pages (see StringRangeEnumerator::getRangesFromString )
/** pages valid for printing (according to the current settings)
This set of pages does NOT depend on the 'PageRange' that is used as a printing option! */
std::set< sal_Int32 > m_aValidPages; ///< the set of possible pages (see StringRangeEnumerator::getRangesFromString )
// printer paper tray to use for each of the m_aValidPages above
/// printer paper tray to use for each of the m_aValidPages above
std::map< sal_Int32, sal_Int32 > m_aPrinterPaperTrays;
// vector of pages and their order to be printed (duplicates and any order allowed!)
// (see 'render' in unotxdoc.cxx)
// negative entry indicates the page to be printed is from the post-it doc
/** vector of pages and their order to be printed (duplicates and any order allowed!)
(see 'render' in unotxdoc.cxx)
negative entry indicates the page to be printed is from the post-it doc */
std::vector< sal_Int32 > m_aPagesToPrint;
// for prospect printing: the pairs of pages to be printed together on a single prospect page.
// -1 indicates a half page to be left empty.
/** for prospect printing: the pairs of pages to be printed together on a single prospect page.
-1 indicates a half page to be left empty. */
std::vector< std::pair< sal_Int32, sal_Int32 > > m_aPagePairs;
rtl::OUString m_aPageRange;
// temp print document -- must live longer than m_pViewOptionAdjust!
// also this is a Lock and not a Ref because Ref does not delete the doc
/** temp print document -- must live longer than m_pViewOptionAdjust!
also this is a Lock and not a Ref because Ref does not delete the doc */
SfxObjectShellLock m_xTempDocShell;
// the view options to be applied for printing
/// the view options to be applied for printing
::boost::scoped_ptr<SwViewOptionAdjust_Impl> m_pViewOptionAdjust;
::boost::scoped_ptr<SwPrintData> m_pPrtOptions;
......@@ -289,18 +289,18 @@ public:
std::set< sal_Int32 > & GetValidPagesSet() { return m_aValidPages; }
const std::set< sal_Int32 > & GetValidPagesSet() const { return m_aValidPages; }
// a map for printer paper tray numbers to use for each document page
// a value of -1 for the tray means that there is no specific tray defined
/** a map for printer paper tray numbers to use for each document page
a value of -1 for the tray means that there is no specific tray defined */
std::map< sal_Int32, sal_Int32 >& GetPrinterPaperTrays() { return m_aPrinterPaperTrays; }
const std::map< sal_Int32, sal_Int32 >& GetPrinterPaperTrays() const { return m_aPrinterPaperTrays; }
// used for 'normal' printing
// A page value of 0 as entry indicates that this page is not from the document but
// from the post-it document. (See also GetPostItStartFrame below)
/** used for 'normal' printing
A page value of 0 as entry indicates that this page is not from the document but
from the post-it document. (See also GetPostItStartFrame below) */
std::vector< sal_Int32 > & GetPagesToPrint() { return m_aPagesToPrint; }
const std::vector< sal_Int32 > & GetPagesToPrint() const { return m_aPagesToPrint; }
// used for prospect printing only
/// used for prospect printing only
PagePairsVec_t & GetPagePairsForProspectPrinting() { return m_aPagePairs; }
const PagePairsVec_t & GetPagePairsForProspectPrinting() const { return m_aPagePairs; }
......@@ -311,7 +311,7 @@ public:
////////////////////////////////////////////////////////////
// last remnants of swprtopt.hxx:
/// last remnants of swprtopt.hxx:
#define POSTITS_NONE 0
#define POSTITS_ONLY 1
#define POSTITS_ENDDOC 2
......@@ -321,7 +321,7 @@ namespace sw {
void InitPrintOptionsFromApplication(SwPrintData & o_rData, bool const bWeb);
} // namespace sw
} ///< namespace sw
#endif // SW_PRINTDATA_HXX
......
sw/inc/reffld.hxx
Dosyayı görüntüle @ 96111e25
......@@ -48,30 +48,30 @@ enum REFERENCESUBTYPE
enum REFERENCEMARK
{
REF_BEGIN,
REF_PAGE = REF_BEGIN, // "Page"
REF_CHAPTER, // "Chapter"
REF_CONTENT, // "Reference"
REF_UPDOWN, // "Above/Below"
REF_PAGE_PGDESC, // "As Page Style"
REF_ONLYNUMBER, // "Category and Number"
REF_ONLYCAPTION, // "Caption Text"
REF_ONLYSEQNO, // "Numbering"
REF_PAGE = REF_BEGIN, ///< "Page"
REF_CHAPTER, ///< "Chapter"
REF_CONTENT, ///< "Reference"
REF_UPDOWN, ///< "Above/Below"
REF_PAGE_PGDESC, ///< "As Page Style"
REF_ONLYNUMBER, ///< "Category and Number"
REF_ONLYCAPTION, ///< "Caption Text"
REF_ONLYSEQNO, ///< "Numbering"
// --> #i81002#
// new reference format types for referencing bookmarks and set references
REF_NUMBER, // "Number"
REF_NUMBER_NO_CONTEXT, // "Number (no context)"
REF_NUMBER_FULL_CONTEXT, // "Number (full context)"
/// new reference format types for referencing bookmarks and set references
REF_NUMBER, ///< "Number"
REF_NUMBER_NO_CONTEXT, ///< "Number (no context)"
REF_NUMBER_FULL_CONTEXT, ///< "Number (full context)"
REF_END
};
// Get reference.
/// Get reference.
class SwGetRefFieldType : public SwFieldType
{
SwDoc* pDoc;
protected:
// Overlay in order to update all ref-fields.
/// Overlay in order to update all ref-fields.
virtual void Modify( const SfxPoolItem*, const SfxPoolItem* );
public:
SwGetRefFieldType(SwDoc* pDoc );
......@@ -114,17 +114,17 @@ public:
const rtl::OUString& GetSetRefName() const { return sSetRefName; }
// #i81002#
// The <SwTxtFld> instance, which represents the text attribute for the
// <SwGetRefField> instance, has to be passed to the method.
// This <SwTxtFld> instance is needed for the reference format type REF_UPDOWN
// and REF_NUMBER.
// Note: This instance may be NULL (field in Undo/Redo). This will cause
// no update for these reference format types.
/** The <SwTxtFld> instance, which represents the text attribute for the
<SwGetRefField> instance, has to be passed to the method.
This <SwTxtFld> instance is needed for the reference format type REF_UPDOWN
and REF_NUMBER.
Note: This instance may be NULL (field in Undo/Redo). This will cause
no update for these reference format types. */
void UpdateField( const SwTxtFld* pFldTxtAttr );
void SetExpand( const String& rStr ) { sTxt = rStr; }
// Get/set sub type.
/// Get/set sub type.
virtual sal_uInt16 GetSubType() const;
virtual void SetSubType( sal_uInt16 n );
......@@ -136,7 +136,7 @@ public:
String GetExpandedTxtOfReferencedTxtNode() const;
// Get/set SequenceNo (of interest only for REF_SEQUENCEFLD).
/// Get/set SequenceNo (of interest only for REF_SEQUENCEFLD).
sal_uInt16 GetSeqNo() const { return nSeqNo; }
void SetSeqNo( sal_uInt16 n ) { nSeqNo = n; }
......@@ -154,6 +154,6 @@ public:
};
#endif // SW_REFFLD_HXX
#endif /// SW_REFFLD_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sw/inc/ring.hxx
Dosyayı görüntüle @ 96111e25
......@@ -34,7 +34,7 @@
class SW_DLLPUBLIC Ring
{
Ring *pNext;
Ring* pPrev; // In order to speed up inserting and deleting.
Ring* pPrev; ///< In order to speed up inserting and deleting.
protected:
Ring() { pNext = this; pPrev = this; }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment