[Libreoffice-commits] .: sw/inc
Libreoffice Gerrit user
logerrit at kemper.freedesktop.org
Tue Sep 18 09:34:47 PDT 2012
sw/inc/node.hxx | 164 ++++++++--------
sw/inc/numrule.hxx | 46 ++--
sw/inc/pagedesc.hxx | 54 ++---
sw/inc/pagepreviewlayout.hxx | 28 +-
sw/inc/pam.hxx | 56 ++---
sw/inc/paratr.hxx | 40 +--
sw/inc/poolfmt.hxx | 436 +++++++++++++++++++++----------------------
sw/inc/printdata.hxx | 54 ++---
sw/inc/reffld.hxx | 46 ++--
sw/inc/ring.hxx | 2
10 files changed, 463 insertions(+), 463 deletions(-)
New commits:
commit 96111e25e16aac27e919eedec98f945a6f0f1f61
Author: Abdulmajeed Al-Abaulrazzaq <aalabdulrazzaq at kacst.edu.sa>
Date: Tue Sep 18 14:22:27 2012 +0300
Modifying comments to meet doxygen standards
Change-Id: Ibc60c20241b70492aaebcebccb738c7e11fdbb41
Reviewed-on: https://gerrit.libreoffice.org/638
Reviewed-by: Michael Stahl <mstahl at redhat.com>
Tested-by: Michael Stahl <mstahl at redhat.com>
diff --git a/sw/inc/node.hxx b/sw/inc/node.hxx
index fa2736c..a0fed72 100644
--- a/sw/inc/node.hxx
+++ b/sw/inc/node.hxx
@@ -98,22 +98,22 @@ class SW_DLLPUBLIC SwNode
sal_uInt8 nNodeType;
- // For text nodes: level of auto format. Was put here because we had still free bits.
+ /// For text nodes: level of auto format. Was put here because we had still free bits.
sal_uInt8 nAFmtNumLvl : 3;
- sal_Bool bSetNumLSpace : 1; // For numbering: TRUE: set indent.
- sal_Bool bIgnoreDontExpand : 1; // for Text Attributes - ignore the flag
+ sal_Bool bSetNumLSpace : 1; ///< For numbering: TRUE: set indent.
+ sal_Bool bIgnoreDontExpand : 1; ///< for Text Attributes - ignore the flag
protected:
SwStartNode* pStartOfSection;
SwNode( const SwNodeIndex &rWhere, const sal_uInt8 nNodeId );
- // for the initial StartNode
+ /// for the initial StartNode
SwNode( SwNodes& rNodes, sal_uLong nPos, const sal_uInt8 nNodeId );
public:
- // the = 0 forces the class to be an abstract base class, but the dtor can be still called
- // from subclasses
+ /** the = 0 forces the class to be an abstract base class, but the dtor can be still called
+ from subclasses */
virtual ~SwNode() = 0;
#ifdef DBG_UTIL
@@ -178,13 +178,13 @@ public:
*/
sal_Bool IsInRedlines() const;
- // Search table node, in which it is. If it is in no table
- // return 0.
+ /** Search table node, in which it is. If it is in no table
+ @return 0. */
SwTableNode *FindTableNode();
inline const SwTableNode *FindTableNode() const;
- // Search section node, in which it is. If it is in no section
- // return 0.
+ /** Search section node, in which it is. If it is in no section
+ @return 0. */
SwSectionNode *FindSectionNode();
inline const SwSectionNode *FindSectionNode() const;
@@ -202,7 +202,7 @@ public:
const SwStartNode* FindFooterStartNode() const
{ return FindSttNodeByType( SwFooterStartNode ); }
- // Node is in which nodes-array/doc?
+ /// Node is in which nodes-array/doc?
inline SwNodes& GetNodes();
inline const SwNodes& GetNodes() const;
inline SwDoc* GetDoc();
@@ -265,23 +265,23 @@ public:
*/
IDocumentListItems& getIDocumentListItems();
- // Is node in the visible area of the Shell?
+ /// Is node in the visible area of the Shell?
sal_Bool IsInVisibleArea( ViewShell* pSh = 0 ) const;
- // Is node in an protected area?
+ /// Is node in an protected area?
sal_Bool IsInProtectSect() const;
- // Is node in something that is protected (range, frame,
- // table cells ... including anchor in case of frames or footnotes)?
+ /** Is node in something that is protected (range, frame,
+ table cells ... including anchor in case of frames or footnotes)? */
sal_Bool IsProtect() const;
- // Search PageDesc with which this node is formated. If layout is existent
- // search over layout, else only the hard way is left: search over the nodes
- // to the front!!
+ /** Search PageDesc with which this node is formated. If layout is existent
+ search over layout, else only the hard way is left: search over the nodes
+ to the front!! */
const SwPageDesc* FindPageDesc( sal_Bool bCalcLay, sal_uInt32* pPgDescNdIdx = 0 ) const;
- // If node is in a fly return the respective format.
+ /// If node is in a fly return the respective format.
SwFrmFmt* GetFlyFmt() const;
- // If node is in a table return the respective table box.
+ /// If node is in a table return the respective table box.
SwTableBox* GetTblBox() const;
inline sal_uLong GetIndex() const { return GetPos(); }
@@ -297,7 +297,7 @@ public:
virtual void dumpAsXml( xmlTextWriterPtr writer = NULL );
private:
- // Private constructor because copying is never allowed!!
+ /// Private constructor because copying is never allowed!!
SwNode( const SwNode & rNodes );
SwNode & operator= ( const SwNode & rNodes );
};
@@ -307,12 +307,12 @@ class SwStartNode: public SwNode
{
friend class SwNode;
friend class SwNodes;
- friend class SwEndNode; // to set the theEndOfSection !!
+ friend class SwEndNode; ///< to set the theEndOfSection !!
SwEndNode* pEndOfSection;
SwStartNodeType eSttNdTyp;
- // for the initial StartNode
+ /// for the initial StartNode
SwStartNode( SwNodes& rNodes, sal_uLong nPos );
protected:
@@ -324,13 +324,13 @@ public:
SwStartNodeType GetStartNodeType() const { return eSttNdTyp; }
- // Call ChkCondcoll to all ContentNodes of section.
+ /// Call ChkCondcoll to all ContentNodes of section.
void CheckSectionCondColl() const;
virtual void dumpAsXml( xmlTextWriterPtr writer = NULL );
private:
- // Private constructor because copying is never allowed!!
+ /// Private constructor because copying is never allowed!!
SwStartNode( const SwStartNode & rNode );
SwStartNode & operator= ( const SwStartNode & rNode );
};
@@ -340,10 +340,10 @@ private:
class SwEndNode : public SwNode
{
friend class SwNodes;
- friend class SwTableNode; // To enable creation of its EndNote.
- friend class SwSectionNode; // To enable creation of its EndNote.
+ friend class SwTableNode; ///< To enable creation of its EndNote.
+ friend class SwSectionNode; ///< To enable creation of its EndNote.
- // for the initial StartNode
+ /// for the initial StartNode
SwEndNode( SwNodes& rNodes, sal_uLong nPos, SwStartNode& rSttNd );
protected:
@@ -352,7 +352,7 @@ protected:
DECL_FIXEDMEMPOOL_NEWDEL(SwEndNode)
private:
- // Private constructor because copying is never allowed!!
+ /// Private constructor because copying is never allowed!!
SwEndNode( const SwEndNode & rNode );
SwEndNode & operator= ( const SwEndNode & rNode );
};
@@ -372,36 +372,36 @@ class SW_DLLPUBLIC SwCntntNode: public SwModify, public SwNode, public SwIndexRe
protected:
SwCntntNode( const SwNodeIndex &rWhere, const sal_uInt8 nNodeType,
SwFmtColl *pFmtColl );
- // the = 0 forces the class to be an abstract base class, but the dtor can be still called
- // from subclasses
+ /** the = 0 forces the class to be an abstract base class, but the dtor can be still called
+ from subclasses */
virtual ~SwCntntNode() = 0;
- // Attribute-set for all auto attributes of a CntntNode.
- // (e.g. TxtNode or NoTxtNode).
+ /** Attribute-set for all auto attributes of a CntntNode.
+ (e.g. TxtNode or NoTxtNode). */
boost::shared_ptr<const SfxItemSet> mpAttrSet;
- // Make respective nodes create the specific AttrSets.
+ /// Make respective nodes create the specific AttrSets.
virtual void NewAttrSet( SwAttrPool& ) = 0;
- // There some functions that like to remove items from the internal
- // SwAttrSet (handle):
+ /** There some functions that like to remove items from the internal
+ SwAttrSet (handle): */
sal_uInt16 ClearItemsFromAttrSet( const std::vector<sal_uInt16>& rWhichIds );
virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew);
public:
- TYPEINFO(); //Already contained in base class Client.
+ TYPEINFO(); /// Already contained in base class Client.
- // MakeFrm will be called for a certain layout
- // pSib is another SwFrm of the same layout (e.g. the SwRootFrm itself, a sibling, the parent)
+ /** MakeFrm will be called for a certain layout
+ pSib is another SwFrm of the same layout (e.g. the SwRootFrm itself, a sibling, the parent) */
virtual SwCntntFrm *MakeFrm( SwFrm* pSib ) = 0;
virtual SwCntntNode *SplitCntntNode(const SwPosition & ) = 0;
virtual SwCntntNode *JoinNext();
virtual SwCntntNode *JoinPrev();
- // Is it possible to join two nodes?
- // In pIdx the second position can be returned.
+ /** Is it possible to join two nodes?
+ In pIdx the second position can be returned. */
int CanJoinNext( SwNodeIndex* pIdx =0 ) const;
int CanJoinPrev( SwNodeIndex* pIdx =0 ) const;
@@ -411,13 +411,13 @@ public:
sal_Bool GoNext(SwIndex *, sal_uInt16 nMode ) const;
sal_Bool GoPrevious(SwIndex *, sal_uInt16 nMode ) const;
- // Replacement for good old GetFrm(..):
+ /// Replacement for good old GetFrm(..):
SwCntntFrm *getLayoutFrm( const SwRootFrm*,
const Point* pDocPos = 0,
const SwPosition *pPos = 0,
const sal_Bool bCalcFrm = sal_True ) const;
- // Returns the real size of the frame or an empty rectangle if
- // no layout exists. Needed for export filters.
+ /** @return the real size of the frame or an empty rectangle if
+ no layout exists. Needed for export filters. */
SwRect FindLayoutRect( const sal_Bool bPrtArea = sal_False,
const Point* pPoint = 0,
const sal_Bool bCalcFrm = sal_False ) const;
@@ -425,40 +425,40 @@ public:
const Point* pPoint = 0,
const sal_Bool bCalcFrm = sal_False ) const;
- // Method creates all views of document for given node. The content
- // frames that are created are put in the respective layout.
+ /** Method creates all views of document for given node. The content
+ frames that are created are put in the respective layout. */
void MakeFrms( SwCntntNode& rNode );
- // Method deletes all vies of document for the node. The content-
- // frames are removed from the respective layout.
+ /** Method deletes all views of document for the node. The content-
+ frames are removed from the respective layout. */
void DelFrms();
- // Returns count of elements of node content. Default is 1.
- // There are differences between text node and formula node.
+ /** @return count of elements of node content. Default is 1.
+ There are differences between text node and formula node. */
virtual xub_StrLen Len() const;
virtual SwCntntNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const = 0;
- // Get information from Client.
+ /// Get information from Client.
virtual sal_Bool GetInfo( SfxPoolItem& ) const;
- // SS for PoolItems: hard attributation.
+ /// SS for PoolItems: hard attributation.
- // If bInParent is FALSE search for attribute only in this node.
+ /// If bInParent is FALSE search for attribute only in this node.
const SfxPoolItem& GetAttr( sal_uInt16 nWhich, sal_Bool bInParent=sal_True ) const;
sal_Bool GetAttr( SfxItemSet& rSet, sal_Bool bInParent=sal_True ) const;
- // made virtual
+ /// made virtual
virtual sal_Bool SetAttr( const SfxPoolItem& );
virtual sal_Bool SetAttr( const SfxItemSet& rSet );
virtual sal_Bool ResetAttr( sal_uInt16 nWhich1, sal_uInt16 nWhich2 = 0 );
virtual sal_Bool ResetAttr( const std::vector<sal_uInt16>& rWhichArr );
virtual sal_uInt16 ResetAllAttr();
- // Obtains attribute that is not delivered via conditional style!
+ /// Obtains attribute that is not delivered via conditional style!
const SfxPoolItem* GetNoCondAttr( sal_uInt16 nWhich, sal_Bool bInParents ) const;
- // Does node has already its own auto-attributes?
- // Access to SwAttrSet.
+ /** Does node has already its own auto-attributes?
+ Access to SwAttrSet. */
inline const SwAttrSet &GetSwAttrSet() const;
inline const SwAttrSet *GetpSwAttrSet() const { return static_cast<const SwAttrSet*>(mpAttrSet.get()); }
inline sal_Bool HasSwAttrSet() const { return mpAttrSet ? sal_True : sal_False; }
@@ -475,12 +475,12 @@ public:
void ChkCondColl();
//FEATURE::CONDCOLL
- // Invalidates NumRule at the node. NumRule is updated
- // on EndAction of a Shell at the latest.
+ /** Invalidates NumRule at the node. NumRule is updated
+ on EndAction of a Shell at the latest. */
sal_Bool InvalidateNumRule();
- // determines the text direction for a certain
- // position. Return -1, if text direction could *not* be determined.
+ /** determines the text direction for a certain
+ position. @return -1, if text direction could *not* be determined. */
short GetTextDirection( const SwPosition& rPos,
const Point* pPt ) const;
@@ -490,7 +490,7 @@ public:
static SwOLENodes* CreateOLENodesArray( const SwFmtColl& rColl, bool bOnlyWithInvalidSize );
private:
- // Private constructor because copying is never allowed!!
+ /// Private constructor because copying is never allowed!!
SwCntntNode( const SwCntntNode & rNode );
SwCntntNode & operator= ( const SwCntntNode & rNode );
};
@@ -514,22 +514,22 @@ public:
SwTable& GetTable() { return *pTable; }
SwTabFrm *MakeFrm( SwFrm* );
- // Creates the frms for the table node (i.e. the TabFrms).
+ /// Creates the frms for the table node (i.e. the TabFrms).
void MakeFrms( SwNodeIndex* pIdxBehind );
- // Method deletes all views of document for the node.
- // The content frames are removed from the respective layout.
+ /** Method deletes all views of document for the node.
+ The content frames are removed from the respective layout. */
void DelFrms();
- // Method creates all views of the document for the previous node.
- // The content frames that are created are put into the respective layout.
+ /** Method creates all views of the document for the previous node.
+ The content frames that are created are put into the respective layout. */
void MakeFrms( const SwNodeIndex & rIdx );
SwTableNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
void SetNewTable( SwTable* , sal_Bool bNewFrames=sal_True );
private:
- // Private constructor because copying is never allowed!!
+ /// Private constructor because copying is never allowed!!
SwTableNode( const SwTableNode & rNode );
SwTableNode & operator= ( const SwTableNode & rNode );
};
@@ -559,29 +559,29 @@ public:
SwFrm *MakeFrm( SwFrm* );
- // Creates the frms for the SectionNode (i.e. the SectionFrms).
- // On default the frames are created until the end of the range.
- // When another NodeIndex pEnd is passed a MakeFrms is called up to it.
- // Used by TableToText.
+ /** Creates the frms for the SectionNode (i.e. the SectionFrms).
+ On default the frames are created until the end of the range.
+ When another NodeIndex pEnd is passed a MakeFrms is called up to it.
+ Used by TableToText. */
void MakeFrms( SwNodeIndex* pIdxBehind, SwNodeIndex* pEnd = NULL );
- // Method deletes all views of document for the node. The
- // content frames are removed from the respective layout.
+ /** Method deletes all views of document for the node. The
+ content frames are removed from the respective layout. */
void DelFrms();
- // Method creates all views of document for the previous node.
- // The content frames created are put into the respective layout.
+ /** Method creates all views of document for the previous node.
+ The content frames created are put into the respective layout. */
void MakeFrms( const SwNodeIndex & rIdx );
SwSectionNode* MakeCopy( SwDoc*, const SwNodeIndex& ) const;
- // Set pointer in format of section on itself.
+ /// Set pointer in format of section on itself.
void NodesArrChgd();
// ueberprueft bei _nicht_ versteckten Bereichen, ob es Inhalt gibt, der
// _nicht_ in einem versteckten (Unter-)Bereich liegt
- // Check for not hidden areas whether there is content that is not in
- // a hidden sub-area.
+ /** Check for not hidden areas whether there is content that is not in
+ a hidden sub-area. */
sal_Bool IsCntntHidden() const;
@@ -592,9 +592,9 @@ public:
// SwDummySectionNode
//----------------
-// This class is internal. And quite frankly I don't know what ND_SECTIONDUMMY is for,
-// the class has been merely created to replace "SwNode( ND_SECTIONDUMMY )", the only case
-// of instantiating SwNode directly. Now SwNode can be an abstract base class.
+/** This class is internal. And quite frankly I don't know what ND_SECTIONDUMMY is for,
+ the class has been merely created to replace "SwNode( ND_SECTIONDUMMY )", the only case
+ of instantiating SwNode directly. Now SwNode can be an abstract base class. */
class SwDummySectionNode
: private SwNode
{
diff --git a/sw/inc/numrule.hxx b/sw/inc/numrule.hxx
index 84c060e..2c0ab75 100644
--- a/sw/inc/numrule.hxx
+++ b/sw/inc/numrule.hxx
@@ -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
diff --git a/sw/inc/pagedesc.hxx b/sw/inc/pagedesc.hxx
index 4e21c55..a7f8f3b 100644
--- a/sw/inc/pagedesc.hxx
+++ b/sw/inc/pagedesc.hxx
@@ -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& );
diff --git a/sw/inc/pagepreviewlayout.hxx b/sw/inc/pagepreviewlayout.hxx
index 200ad61..2063718 100644
--- a/sw/inc/pagepreviewlayout.hxx
+++ b/sw/inc/pagepreviewlayout.hxx
@@ -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;
diff --git a/sw/inc/pam.hxx b/sw/inc/pam.hxx
index 1ca3905..3f49310 100644
--- a/sw/inc/pam.hxx
+++ b/sw/inc/pam.hxx
@@ -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)
diff --git a/sw/inc/paratr.hxx b/sw/inc/paratr.hxx
index 7714c83..f03b39b 100644
--- a/sw/inc/paratr.hxx
+++ b/sw/inc/paratr.hxx
@@ -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,
diff --git a/sw/inc/poolfmt.hxx b/sw/inc/poolfmt.hxx
index cd85962..3420e83 100644
--- a/sw/inc/poolfmt.hxx
+++ b/sw/inc/poolfmt.hxx
@@ -32,7 +32,7 @@
#include <tools/solar.h>
#include <editeng/frmdir.hxx>
-// POOLCOLL-IDs:
+/** POOLCOLL-IDs:
// +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
// !User! Range ! 0 ! Offset !
// +----+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
@@ -57,18 +57,18 @@
// For all IDs we have:
// Origin: 0 -pool
// 1 -user
-// Offset: within the group
+// Offset: within the group */
-// Attention: New IDs can only be added to the ends of the groups.
-// These IDs are read and written by the Reader/Writer.
-// They are only aware of the Offset to Start.
+/** Attention: New IDs can only be added to the ends of the groups.
+ These IDs are read and written by the Reader/Writer.
+ They are only aware of the Offset to Start. */
-// Mask for recognition of COLLPOOL-IDs:
+/// Mask for recognition of COLLPOOL-IDs:
const sal_uInt16 POOLGRP_NOCOLLID = (1 << 10);
-// POLLCOLL-groups:
+/// POLLCOLL-groups:
const sal_uInt16 USER_FMT = (1 << 15);
const sal_uInt16 POOL_FMT = (0 << 15);
@@ -81,14 +81,14 @@ const sal_uInt16 COLL_DOC_BITS = (5 << 11);
const sal_uInt16 COLL_HTML_BITS = (6 << 11);
const sal_uInt16 COLL_GET_RANGE_BITS = (15 << 11);
-// Other groups:
+/// Other groups:
const sal_uInt16 POOLGRP_CHARFMT = (0 << 11) + POOLGRP_NOCOLLID;
const sal_uInt16 POOLGRP_FRAMEFMT = (1 << 11) + POOLGRP_NOCOLLID;
const sal_uInt16 POOLGRP_PAGEDESC = (2 << 11) + POOLGRP_NOCOLLID;
const sal_uInt16 POOLGRP_NUMRULE = (3 << 11) + POOLGRP_NOCOLLID;
-// Recognize whether it's a user defined style or not:
+/// Recognize whether it's a user defined style or not:
const sal_uInt16 POOL_IDUSER_FMT =
USHRT_MAX & ~(COLL_GET_RANGE_BITS + POOLGRP_NOCOLLID);
@@ -101,7 +101,7 @@ inline sal_Bool IsPoolUserFmt( sal_uInt16 nId )
-// IDs for the ranges.
+/// IDs for the ranges.
enum RES_POOLFMT
{
RES_POOLFMT_BEGIN = 1,
@@ -115,36 +115,36 @@ RES_POOL_GRFFMT,
RES_POOLFMT_END
};
-// Ranges for the IDs of the formats.
+/// Ranges for the IDs of the formats.
-// IDs for character styles.
+/// IDs for character styles.
enum RES_POOL_CHRFMT_TYPE
{
RES_POOLCHR_BEGIN = POOLGRP_CHARFMT,
RES_POOLCHR_NORMAL_BEGIN = POOLGRP_CHARFMT,
-RES_POOLCHR_FOOTNOTE = RES_POOLCHR_NORMAL_BEGIN, // Footnote.
-RES_POOLCHR_PAGENO, // Pages/field.
-RES_POOLCHR_LABEL, // Label.
-RES_POOLCHR_DROPCAPS, // Dropcaps.
-RES_POOLCHR_NUM_LEVEL, // Numbering symbols
-RES_POOLCHR_BUL_LEVEL, // Bullets.
-
-RES_POOLCHR_INET_NORMAL, // Internet normal.
-RES_POOLCHR_INET_VISIT, // Internet visited.
-RES_POOLCHR_JUMPEDIT, // Placeholder.
-RES_POOLCHR_TOXJUMP, // Jump from index.
-RES_POOLCHR_ENDNOTE, // Endnote.
-RES_POOLCHR_LINENUM, // Line numbering.
-RES_POOLCHR_IDX_MAIN_ENTRY, // Main entry in indices.
-RES_POOLCHR_FOOTNOTE_ANCHOR, // Footnote anchor.
-RES_POOLCHR_ENDNOTE_ANCHOR, // Endnote anchor.
-RES_POOLCHR_RUBYTEXT, // Rubytext.
-RES_POOLCHR_VERT_NUM, // Vertical numbering symbols.
+RES_POOLCHR_FOOTNOTE = RES_POOLCHR_NORMAL_BEGIN, ///< Footnote.
+RES_POOLCHR_PAGENO, ///< Pages/field.
+RES_POOLCHR_LABEL, ///< Label.
+RES_POOLCHR_DROPCAPS, ///< Dropcaps.
+RES_POOLCHR_NUM_LEVEL, ///< Numbering symbols
+RES_POOLCHR_BUL_LEVEL, ///< Bullets.
+
+RES_POOLCHR_INET_NORMAL, ///< Internet normal.
+RES_POOLCHR_INET_VISIT, ///< Internet visited.
+RES_POOLCHR_JUMPEDIT, ///< Placeholder.
+RES_POOLCHR_TOXJUMP, ///< Jump from index.
+RES_POOLCHR_ENDNOTE, ///< Endnote.
+RES_POOLCHR_LINENUM, ///< Line numbering.
+RES_POOLCHR_IDX_MAIN_ENTRY, ///< Main entry in indices.
+RES_POOLCHR_FOOTNOTE_ANCHOR, ///< Footnote anchor.
+RES_POOLCHR_ENDNOTE_ANCHOR, ///< Endnote anchor.
+RES_POOLCHR_RUBYTEXT, ///< Rubytext.
+RES_POOLCHR_VERT_NUM, ///< Vertical numbering symbols.
RES_POOLCHR_NORMAL_END,
-RES_POOLCHR_HTML_BEGIN = RES_POOLCHR_BEGIN + 50, // HTML-styles.
+RES_POOLCHR_HTML_BEGIN = RES_POOLCHR_BEGIN + 50, ///< HTML-styles.
RES_POOLCHR_HTML_EMPHASIS= RES_POOLCHR_HTML_BEGIN,
RES_POOLCHR_HTML_CITIATION,
RES_POOLCHR_HTML_STRONG,
@@ -160,37 +160,37 @@ RES_POOLCHR_END = RES_POOLCHR_HTML_END
};
-// IDs for frame styles.
+/// IDs for frame styles.
enum RES_POOL_FRMFMT_TYPE
{
RES_POOLFRM_BEGIN = POOLGRP_FRAMEFMT,
-RES_POOLFRM_FRAME = RES_POOLFRM_BEGIN, // Frame.
-RES_POOLFRM_GRAPHIC, // Graphics.
-RES_POOLFRM_OLE, // OLE.
-RES_POOLFRM_FORMEL, // Formula.
-RES_POOLFRM_MARGINAL, // Marginalia.
-RES_POOLFRM_WATERSIGN, // Watermark.
-RES_POOLFRM_LABEL, // Labels.
+RES_POOLFRM_FRAME = RES_POOLFRM_BEGIN, ///< Frame.
+RES_POOLFRM_GRAPHIC, ///< Graphics.
+RES_POOLFRM_OLE, ///< OLE.
+RES_POOLFRM_FORMEL, ///< Formula.
+RES_POOLFRM_MARGINAL, ///< Marginalia.
+RES_POOLFRM_WATERSIGN, ///< Watermark.
+RES_POOLFRM_LABEL, ///< Labels.
RES_POOLFRM_END
};
-// IDs for page styles.
+/// IDs for page styles.
enum RES_POOL_PAGEFMT_TYPE
{
RES_POOLPAGE_BEGIN = POOLGRP_PAGEDESC,
-RES_POOLPAGE_STANDARD = RES_POOLPAGE_BEGIN, // Standard page.
-RES_POOLPAGE_FIRST, // First page.
-RES_POOLPAGE_LEFT, // Left page.
-RES_POOLPAGE_RIGHT, // Right page.
-RES_POOLPAGE_JAKET, // Envelope.
-RES_POOLPAGE_REGISTER, // Index.
-RES_POOLPAGE_HTML, // HTML.
-RES_POOLPAGE_FOOTNOTE, // Footnote at end of document.
-RES_POOLPAGE_ENDNOTE, // Endnote page.
-RES_POOLPAGE_LANDSCAPE, // Landscape page style.
+RES_POOLPAGE_STANDARD = RES_POOLPAGE_BEGIN, ///< Standard page.
+RES_POOLPAGE_FIRST, ///< First page.
+RES_POOLPAGE_LEFT, ///< Left page.
+RES_POOLPAGE_RIGHT, ///< Right page.
+RES_POOLPAGE_JAKET, ///< Envelope.
+RES_POOLPAGE_REGISTER, ///< Index.
+RES_POOLPAGE_HTML, ///< HTML.
+RES_POOLPAGE_FOOTNOTE, ///< Footnote at end of document.
+RES_POOLPAGE_ENDNOTE, ///< Endnote page.
+RES_POOLPAGE_LANDSCAPE, ///< Landscape page style.
RES_POOLPAGE_END
};
@@ -199,16 +199,16 @@ RES_POOLPAGE_END
enum RES_POOL_NUMRULE_TYPE
{
RES_POOLNUMRULE_BEGIN = POOLGRP_NUMRULE,
-RES_POOLNUMRULE_NUM1 = RES_POOLNUMRULE_BEGIN, // NumRule Numbering 1.
-RES_POOLNUMRULE_NUM2, // NumRule Numbering 2.
-RES_POOLNUMRULE_NUM3, // NumRule Numbering 3.
-RES_POOLNUMRULE_NUM4, // NumRule Numbering 4.
-RES_POOLNUMRULE_NUM5, // NumRule Numbering 5.
-RES_POOLNUMRULE_BUL1, // NumRule Bullets 1.
-RES_POOLNUMRULE_BUL2, // NumRule Bullets 2.
-RES_POOLNUMRULE_BUL3, // NumRule Bullets 3.
-RES_POOLNUMRULE_BUL4, // NumRule Bullets 4.
-RES_POOLNUMRULE_BUL5, // NumRule Bullets 5.
+RES_POOLNUMRULE_NUM1 = RES_POOLNUMRULE_BEGIN, ///< NumRule Numbering 1.
+RES_POOLNUMRULE_NUM2, ///< NumRule Numbering 2.
+RES_POOLNUMRULE_NUM3, ///< NumRule Numbering 3.
+RES_POOLNUMRULE_NUM4, ///< NumRule Numbering 4.
+RES_POOLNUMRULE_NUM5, ///< NumRule Numbering 5.
+RES_POOLNUMRULE_BUL1, ///< NumRule Bullets 1.
+RES_POOLNUMRULE_BUL2, ///< NumRule Bullets 2.
+RES_POOLNUMRULE_BUL3, ///< NumRule Bullets 3.
+RES_POOLNUMRULE_BUL4, ///< NumRule Bullets 4.
+RES_POOLNUMRULE_BUL5, ///< NumRule Bullets 5.
RES_POOLNUMRULE_END
};
@@ -218,191 +218,191 @@ enum RES_POOL_COLLFMT_TYPE
// Group text.
RES_POOLCOLL_TEXT_BEGIN = COLL_TEXT_BITS,
-RES_POOLCOLL_STANDARD = RES_POOLCOLL_TEXT_BEGIN, // Standard.
-RES_POOLCOLL_TEXT, // Text body.
-RES_POOLCOLL_TEXT_IDENT, // Text body first line indent.
-RES_POOLCOLL_TEXT_NEGIDENT, // Text body hanging indent.
-RES_POOLCOLL_TEXT_MOVE, // Text body indent.
-RES_POOLCOLL_GREETING, // Complimentary close.
-RES_POOLCOLL_SIGNATURE, // Signature.
-RES_POOLCOLL_CONFRONTATION, // List indent.
-RES_POOLCOLL_MARGINAL, // Marginalia.
-
-// Subgroup headings.
-RES_POOLCOLL_HEADLINE_BASE, // Base heading.
-RES_POOLCOLL_HEADLINE1, // Heading 1.
-RES_POOLCOLL_HEADLINE2, // Heading 2.
-RES_POOLCOLL_HEADLINE3, // Heading 3.
-RES_POOLCOLL_HEADLINE4, // Heading 4.
-RES_POOLCOLL_HEADLINE5, // Heading 5.
-RES_POOLCOLL_HEADLINE6, // Heading 6.
-RES_POOLCOLL_HEADLINE7, // Heading 7.
-RES_POOLCOLL_HEADLINE8, // Heading 8.
-RES_POOLCOLL_HEADLINE9, // Heading 9.
-RES_POOLCOLL_HEADLINE10, // Heading 10.
+RES_POOLCOLL_STANDARD = RES_POOLCOLL_TEXT_BEGIN, ///< Standard.
+RES_POOLCOLL_TEXT, ///< Text body.
+RES_POOLCOLL_TEXT_IDENT, ///< Text body first line indent.
+RES_POOLCOLL_TEXT_NEGIDENT, ///< Text body hanging indent.
+RES_POOLCOLL_TEXT_MOVE, ///< Text body indent.
+RES_POOLCOLL_GREETING, ///< Complimentary close.
+RES_POOLCOLL_SIGNATURE, ///< Signature.
+RES_POOLCOLL_CONFRONTATION, ///< List indent.
+RES_POOLCOLL_MARGINAL, ///< Marginalia.
+
+/// Subgroup headings.
+RES_POOLCOLL_HEADLINE_BASE, ///< Base heading.
+RES_POOLCOLL_HEADLINE1, ///< Heading 1.
+RES_POOLCOLL_HEADLINE2, ///< Heading 2.
+RES_POOLCOLL_HEADLINE3, ///< Heading 3.
+RES_POOLCOLL_HEADLINE4, ///< Heading 4.
+RES_POOLCOLL_HEADLINE5, ///< Heading 5.
+RES_POOLCOLL_HEADLINE6, ///< Heading 6.
+RES_POOLCOLL_HEADLINE7, ///< Heading 7.
+RES_POOLCOLL_HEADLINE8, ///< Heading 8.
+RES_POOLCOLL_HEADLINE9, ///< Heading 9.
+RES_POOLCOLL_HEADLINE10, ///< Heading 10.
RES_POOLCOLL_TEXT_END,
-// Group lists.
+/// Group lists.
RES_POOLCOLL_LISTS_BEGIN = COLL_LISTS_BITS,
-RES_POOLCOLL_NUMBUL_BASE = RES_POOLCOLL_LISTS_BEGIN, // Base list.
-
-// Subgroup numberings.
-RES_POOLCOLL_NUM_LEVEL1S, // Start 1st level.
-RES_POOLCOLL_NUM_LEVEL1, // 1st level.
-RES_POOLCOLL_NUM_LEVEL1E, // End 1st level.
-RES_POOLCOLL_NUM_NONUM1, // No numbering.
-RES_POOLCOLL_NUM_LEVEL2S, // Start 2nd level.
-RES_POOLCOLL_NUM_LEVEL2, // 2nd level.
-RES_POOLCOLL_NUM_LEVEL2E, // End 2nd level.
-RES_POOLCOLL_NUM_NONUM2, // No numbering.
-RES_POOLCOLL_NUM_LEVEL3S, // Start 3rd level.
-RES_POOLCOLL_NUM_LEVEL3, // 3rd level.
-RES_POOLCOLL_NUM_LEVEL3E, // End 3rd level.
-RES_POOLCOLL_NUM_NONUM3, // No numbering.
-RES_POOLCOLL_NUM_LEVEL4S, // Start 4th level.
-RES_POOLCOLL_NUM_LEVEL4, // 4th level.
-RES_POOLCOLL_NUM_LEVEL4E, // End 4th level.
-RES_POOLCOLL_NUM_NONUM4, // No numbering.
-RES_POOLCOLL_NUM_LEVEL5S, // Start 5th level.
-RES_POOLCOLL_NUM_LEVEL5, // 5th level.
-RES_POOLCOLL_NUM_LEVEL5E, // End 5th level.
-RES_POOLCOLL_NUM_NONUM5, // No numbering.
-
-
-//Subgroup bullets.
-RES_POOLCOLL_BUL_LEVEL1S, // Start 1st level.
-RES_POOLCOLL_BUL_LEVEL1, // 1st level.
-RES_POOLCOLL_BUL_LEVEL1E, // End 1st level
-RES_POOLCOLL_BUL_NONUM1, // No numbering.
-RES_POOLCOLL_BUL_LEVEL2S, // Start 2nd level.
-RES_POOLCOLL_BUL_LEVEL2, // 2nd level.
-RES_POOLCOLL_BUL_LEVEL2E, // End 2nd level.
-RES_POOLCOLL_BUL_NONUM2, // No numbering.
-RES_POOLCOLL_BUL_LEVEL3S, // Start 3rd level.
-RES_POOLCOLL_BUL_LEVEL3, // 3rd Level.
-RES_POOLCOLL_BUL_LEVEL3E, // End 3rd level.
-RES_POOLCOLL_BUL_NONUM3, // No numbering.
-RES_POOLCOLL_BUL_LEVEL4S, // Start 4th level.
-RES_POOLCOLL_BUL_LEVEL4, // 4th level.
-RES_POOLCOLL_BUL_LEVEL4E, // End 4th level.
-RES_POOLCOLL_BUL_NONUM4, // No numbering.
-RES_POOLCOLL_BUL_LEVEL5S, // Start 5th level.
-RES_POOLCOLL_BUL_LEVEL5, // 5th level.
-RES_POOLCOLL_BUL_LEVEL5E, // End 5th Level.
-RES_POOLCOLL_BUL_NONUM5, // No numbering.
+RES_POOLCOLL_NUMBUL_BASE = RES_POOLCOLL_LISTS_BEGIN, ///< Base list.
+
+/// Subgroup numberings.
+RES_POOLCOLL_NUM_LEVEL1S, ///< Start 1st level.
+RES_POOLCOLL_NUM_LEVEL1, ///< 1st level.
+RES_POOLCOLL_NUM_LEVEL1E, ///< End 1st level.
+RES_POOLCOLL_NUM_NONUM1, ///< No numbering.
+RES_POOLCOLL_NUM_LEVEL2S, ///< Start 2nd level.
+RES_POOLCOLL_NUM_LEVEL2, ///< 2nd level.
+RES_POOLCOLL_NUM_LEVEL2E, ///< End 2nd level.
+RES_POOLCOLL_NUM_NONUM2, ///< No numbering.
+RES_POOLCOLL_NUM_LEVEL3S, ///< Start 3rd level.
+RES_POOLCOLL_NUM_LEVEL3, ///< 3rd level.
+RES_POOLCOLL_NUM_LEVEL3E, ///< End 3rd level.
+RES_POOLCOLL_NUM_NONUM3, ///< No numbering.
+RES_POOLCOLL_NUM_LEVEL4S, ///< Start 4th level.
+RES_POOLCOLL_NUM_LEVEL4, ///< 4th level.
+RES_POOLCOLL_NUM_LEVEL4E, ///< End 4th level.
+RES_POOLCOLL_NUM_NONUM4, ///< No numbering.
+RES_POOLCOLL_NUM_LEVEL5S, ///< Start 5th level.
+RES_POOLCOLL_NUM_LEVEL5, ///< 5th level.
+RES_POOLCOLL_NUM_LEVEL5E, ///< End 5th level.
+RES_POOLCOLL_NUM_NONUM5, ///< No numbering.
+
+
+///Subgroup bullets.
+RES_POOLCOLL_BUL_LEVEL1S, ///< Start 1st level.
+RES_POOLCOLL_BUL_LEVEL1, ///< 1st level.
+RES_POOLCOLL_BUL_LEVEL1E, ///< End 1st level
+RES_POOLCOLL_BUL_NONUM1, ///< No numbering.
+RES_POOLCOLL_BUL_LEVEL2S, ///< Start 2nd level.
+RES_POOLCOLL_BUL_LEVEL2, ///< 2nd level.
+RES_POOLCOLL_BUL_LEVEL2E, ///< End 2nd level.
+RES_POOLCOLL_BUL_NONUM2, ///< No numbering.
+RES_POOLCOLL_BUL_LEVEL3S, ///< Start 3rd level.
+RES_POOLCOLL_BUL_LEVEL3, ///< 3rd Level.
+RES_POOLCOLL_BUL_LEVEL3E, ///< End 3rd level.
+RES_POOLCOLL_BUL_NONUM3, ///< No numbering.
+RES_POOLCOLL_BUL_LEVEL4S, ///< Start 4th level.
+RES_POOLCOLL_BUL_LEVEL4, ///< 4th level.
+RES_POOLCOLL_BUL_LEVEL4E, ///< End 4th level.
+RES_POOLCOLL_BUL_NONUM4, ///< No numbering.
+RES_POOLCOLL_BUL_LEVEL5S, ///< Start 5th level.
+RES_POOLCOLL_BUL_LEVEL5, ///< 5th level.
+RES_POOLCOLL_BUL_LEVEL5E, ///< End 5th Level.
+RES_POOLCOLL_BUL_NONUM5, ///< No numbering.
RES_POOLCOLL_LISTS_END,
-// Special ranges.
+/// Special ranges.
RES_POOLCOLL_EXTRA_BEGIN = COLL_EXTRA_BITS,
-// Subgroup header.
-RES_POOLCOLL_HEADER = RES_POOLCOLL_EXTRA_BEGIN, // Header Left&Right.
-RES_POOLCOLL_HEADERL, // Header Left.
-RES_POOLCOLL_HEADERR, // Header Right.
+/// Subgroup header.
+RES_POOLCOLL_HEADER = RES_POOLCOLL_EXTRA_BEGIN, ///< Header Left&Right.
+RES_POOLCOLL_HEADERL, ///< Header Left.
+RES_POOLCOLL_HEADERR, ///< Header Right.
-// Subgroup footer.
-RES_POOLCOLL_FOOTER, // Footer Left&Right.
-RES_POOLCOLL_FOOTERL, // Footer Left.
-RES_POOLCOLL_FOOTERR, // Footer Right.
+/// Subgroup footer.
+RES_POOLCOLL_FOOTER, ///< Footer Left&Right.
+RES_POOLCOLL_FOOTERL, ///< Footer Left.
+RES_POOLCOLL_FOOTERR, ///< Footer Right.
-// Subgroup table.
-RES_POOLCOLL_TABLE, // Table of Contents.
-RES_POOLCOLL_TABLE_HDLN, // Table of Contents - heading.
+/// Subgroup table.
+RES_POOLCOLL_TABLE, ///< Table of Contents.
+RES_POOLCOLL_TABLE_HDLN, ///< Table of Contents - heading.
-// Subgroup labels.
-RES_POOLCOLL_LABEL, // Base labels.
-RES_POOLCOLL_LABEL_ABB, // Label illustration.
-RES_POOLCOLL_LABEL_TABLE, // Label table.
-RES_POOLCOLL_LABEL_FRAME, // Label frame.
+/// Subgroup labels.
+RES_POOLCOLL_LABEL, ///< Base labels.
+RES_POOLCOLL_LABEL_ABB, ///< Label illustration.
+RES_POOLCOLL_LABEL_TABLE, ///< Label table.
+RES_POOLCOLL_LABEL_FRAME, ///< Label frame.
-// Other stuff.
-RES_POOLCOLL_FRAME, // Frames.
-RES_POOLCOLL_FOOTNOTE, // Footnotes.
-RES_POOLCOLL_JAKETADRESS, // Addressee.
-RES_POOLCOLL_SENDADRESS, // Sender.
-RES_POOLCOLL_ENDNOTE, // Endnotes.
+/// Other stuff.
+RES_POOLCOLL_FRAME, ///< Frames.
+RES_POOLCOLL_FOOTNOTE, ///< Footnotes.
+RES_POOLCOLL_JAKETADRESS, ///< Addressee.
+RES_POOLCOLL_SENDADRESS, ///< Sender.
+RES_POOLCOLL_ENDNOTE, ///< Endnotes.
-RES_POOLCOLL_LABEL_DRAWING, // Label drawing objects.
+RES_POOLCOLL_LABEL_DRAWING, ///< Label drawing objects.
RES_POOLCOLL_EXTRA_END,
-// Group indices.
+/// Group indices.
RES_POOLCOLL_REGISTER_BEGIN = COLL_REGISTER_BITS,
-RES_POOLCOLL_REGISTER_BASE = RES_POOLCOLL_REGISTER_BEGIN, // Base index.
-
-// Subgroup index tables.
-RES_POOLCOLL_TOX_IDXH, // Header.
-RES_POOLCOLL_TOX_IDX1, // 1st level.
-RES_POOLCOLL_TOX_IDX2, // 2nd level.
-RES_POOLCOLL_TOX_IDX3, // 3rd level.
-RES_POOLCOLL_TOX_IDXBREAK, // Separator.
-
-// Subgroup table of contents.
-RES_POOLCOLL_TOX_CNTNTH, // Header.
-RES_POOLCOLL_TOX_CNTNT1, // Content 1st level.
-RES_POOLCOLL_TOX_CNTNT2, // Content 2nd level.
-RES_POOLCOLL_TOX_CNTNT3, // Content 3rd level.
-RES_POOLCOLL_TOX_CNTNT4, // Content 4th level.
-RES_POOLCOLL_TOX_CNTNT5, // Content 5th level.
-
-
-// Subgroup user indices.
-RES_POOLCOLL_TOX_USERH, // Header.
-RES_POOLCOLL_TOX_USER1, // 1st level.
-RES_POOLCOLL_TOX_USER2, // 2nd level.
-RES_POOLCOLL_TOX_USER3, // 3rd level.
-RES_POOLCOLL_TOX_USER4, // 4th level.
-RES_POOLCOLL_TOX_USER5, // 5th level.
-
-
-RES_POOLCOLL_TOX_CNTNT6, // Content 6th level.
-RES_POOLCOLL_TOX_CNTNT7, // Content 7th level.
-RES_POOLCOLL_TOX_CNTNT8, // Content 8th level.
-RES_POOLCOLL_TOX_CNTNT9, // Content 9th level.
-RES_POOLCOLL_TOX_CNTNT10, // Content 10th level.
-
-// illustrations index.
-RES_POOLCOLL_TOX_ILLUSH, // Illustrations header.
-RES_POOLCOLL_TOX_ILLUS1, // Illustrations all levels.
-
-// object index.
-RES_POOLCOLL_TOX_OBJECTH, // Objects header.
-RES_POOLCOLL_TOX_OBJECT1, // Objects all levels.
-
-// tables index.
-RES_POOLCOLL_TOX_TABLESH, // Tables header.
-RES_POOLCOLL_TOX_TABLES1, // Tables all levels.
-
-// index of authorities.
-RES_POOLCOLL_TOX_AUTHORITIESH, // Authorities header.
-RES_POOLCOLL_TOX_AUTHORITIES1, // Authorities all levels.
-
-// user index 6..10.
-RES_POOLCOLL_TOX_USER6, // 6th level.
-RES_POOLCOLL_TOX_USER7, // 7th level.
-RES_POOLCOLL_TOX_USER8, // 8th level.
-RES_POOLCOLL_TOX_USER9, // 9th level.
-RES_POOLCOLL_TOX_USER10, // 10th level.
+RES_POOLCOLL_REGISTER_BASE = RES_POOLCOLL_REGISTER_BEGIN, ///< Base index.
+
+/// Subgroup index tables.
+RES_POOLCOLL_TOX_IDXH, ///< Header.
+RES_POOLCOLL_TOX_IDX1, ///< 1st level.
+RES_POOLCOLL_TOX_IDX2, ///< 2nd level.
+RES_POOLCOLL_TOX_IDX3, ///< 3rd level.
+RES_POOLCOLL_TOX_IDXBREAK, ///< Separator.
+
+/// Subgroup table of contents.
+RES_POOLCOLL_TOX_CNTNTH, ///< Header.
+RES_POOLCOLL_TOX_CNTNT1, ///< Content 1st level.
+RES_POOLCOLL_TOX_CNTNT2, ///< Content 2nd level.
+RES_POOLCOLL_TOX_CNTNT3, ///< Content 3rd level.
+RES_POOLCOLL_TOX_CNTNT4, ///< Content 4th level.
+RES_POOLCOLL_TOX_CNTNT5, ///< Content 5th level.
+
+
+/// Subgroup user indices.
+RES_POOLCOLL_TOX_USERH, ///< Header.
+RES_POOLCOLL_TOX_USER1, ///< 1st level.
+RES_POOLCOLL_TOX_USER2, ///< 2nd level.
+RES_POOLCOLL_TOX_USER3, ///< 3rd level.
+RES_POOLCOLL_TOX_USER4, ///< 4th level.
+RES_POOLCOLL_TOX_USER5, ///< 5th level.
+
+
+RES_POOLCOLL_TOX_CNTNT6, ///< Content 6th level.
+RES_POOLCOLL_TOX_CNTNT7, ///< Content 7th level.
+RES_POOLCOLL_TOX_CNTNT8, ///< Content 8th level.
+RES_POOLCOLL_TOX_CNTNT9, ///< Content 9th level.
+RES_POOLCOLL_TOX_CNTNT10, ///< Content 10th level.
+
+/// illustrations index.
+RES_POOLCOLL_TOX_ILLUSH, ///< Illustrations header.
+RES_POOLCOLL_TOX_ILLUS1, ///< Illustrations all levels.
+
+/// object index.
+RES_POOLCOLL_TOX_OBJECTH, ///< Objects header.
+RES_POOLCOLL_TOX_OBJECT1, ///< Objects all levels.
+
+/// tables index.
+RES_POOLCOLL_TOX_TABLESH, ///< Tables header.
+RES_POOLCOLL_TOX_TABLES1, ///< Tables all levels.
+
+/// index of authorities.
+RES_POOLCOLL_TOX_AUTHORITIESH, ///< Authorities header.
+RES_POOLCOLL_TOX_AUTHORITIES1, ///< Authorities all levels.
+
+/// user index 6..10.
+RES_POOLCOLL_TOX_USER6, ///< 6th level.
+RES_POOLCOLL_TOX_USER7, ///< 7th level.
+RES_POOLCOLL_TOX_USER8, ///< 8th level.
+RES_POOLCOLL_TOX_USER9, ///< 9th level.
+RES_POOLCOLL_TOX_USER10, ///< 10th level.
RES_POOLCOLL_REGISTER_END,
-// Group chapter / document.
+/// Group chapter / document.
RES_POOLCOLL_DOC_BEGIN = COLL_DOC_BITS,
-RES_POOLCOLL_DOC_TITEL = RES_POOLCOLL_DOC_BEGIN, // Doc. titel.
-RES_POOLCOLL_DOC_SUBTITEL, // Doc. subtitel.
+RES_POOLCOLL_DOC_TITEL = RES_POOLCOLL_DOC_BEGIN, ///< Doc. titel.
+RES_POOLCOLL_DOC_SUBTITEL, ///< Doc. subtitel.
RES_POOLCOLL_DOC_END,
-// Group HTML-styles.
+/// Group HTML-styles.
RES_POOLCOLL_HTML_BEGIN = COLL_HTML_BITS,
RES_POOLCOLL_HTML_BLOCKQUOTE = RES_POOLCOLL_HTML_BEGIN,
@@ -413,14 +413,14 @@ RES_POOLCOLL_HTML_DT,
RES_POOLCOLL_HTML_END
-// End of text styles collection.
+/// End of text styles collection.
};
-// Query defined parent of a POOL-ID
-// Returns 0 if standard
-// USHRT_MAX if no parent
-// the parent in all other cases.
+/** Query defined parent of a POOL-ID
+ Returns 0 if standard
+ USHRT_MAX if no parent
+ the parent in all other cases. */
sal_uInt16 GetPoolParent( sal_uInt16 nId );
SvxFrameDirection GetDefaultFrameDirection(sal_uLong nLanguage);
diff --git a/sw/inc/printdata.hxx b/sw/inc/printdata.hxx
index b041305..00e7fe5 100644
--- a/sw/inc/printdata.hxx
+++ b/sw/inc/printdata.hxx
@@ -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
diff --git a/sw/inc/reffld.hxx b/sw/inc/reffld.hxx
index 6daf7f6..4ddb645 100644
--- a/sw/inc/reffld.hxx
+++ b/sw/inc/reffld.hxx
@@ -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: */
diff --git a/sw/inc/ring.hxx b/sw/inc/ring.hxx
index 2eebf2e..8c7c6b9 100644
--- a/sw/inc/ring.hxx
+++ b/sw/inc/ring.hxx
@@ -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; }
More information about the Libreoffice-commits
mailing list