summaryrefslogtreecommitdiff
path: root/sc/inc/refdata.hxx
diff options
context:
space:
mode:
authorNourah.AlShoeibi <nourah.alshoeibi@gmail.com>2013-07-08 13:34:25 +0300
committerPetr Mladek <pmladek@suse.cz>2013-07-09 12:07:30 +0000
commitf77c986fb36a9b57465c93e6c9693ed973008985 (patch)
tree32b6c61f13a542ca8fcf1c7a35d606d923ff1c60 /sc/inc/refdata.hxx
parent3efeb27a83c8d90f1e951f673bae438a8508a0e3 (diff)
Modifying comments to meet Doxygen standards
Change-Id: I9c498c8c2147a19c5f97e48bc8a0e149e6858e23 Reviewed-on: https://gerrit.libreoffice.org/4769 Reviewed-by: Petr Mladek <pmladek@suse.cz> Tested-by: Petr Mladek <pmladek@suse.cz>
Diffstat (limited to 'sc/inc/refdata.hxx')
-rw-r--r--sc/inc/refdata.hxx29
1 files changed, 15 insertions, 14 deletions
diff --git a/sc/inc/refdata.hxx b/sc/inc/refdata.hxx
index 6d6fe79bdfb0..c943c88ee573 100644
--- a/sc/inc/refdata.hxx
+++ b/sc/inc/refdata.hxx
@@ -25,22 +25,23 @@
#include "scdllapi.h"
-// Ref-Flags for old (until release 3.1) documents
+/// Ref-Flags for old (until release 3.1) documents
struct OldSingleRefBools
{
- sal_uInt8 bRelCol; // Flag values (see further down), 2 bits each in file format
+ sal_uInt8 bRelCol; ///< Flag values (see further down), 2 bits each in file format
sal_uInt8 bRelRow;
sal_uInt8 bRelTab;
- sal_uInt8 bOldFlag3D; // two sal_Bool flags (see further down)
+ sal_uInt8 bOldFlag3D; ///< two sal_Bool flags (see further down)
};
-struct SC_DLLPUBLIC ScSingleRefData // Single reference (one address) into the sheet
+/// Single reference (one address) into the sheet
+struct SC_DLLPUBLIC ScSingleRefData
{
- SCsCOL nCol; // Absolute values
+ SCsCOL nCol; ///< Absolute values
SCsROW nRow;
SCsTAB nTab;
- SCsCOL nRelCol; // Values relative to the position
+ SCsCOL nRelCol; ///< Values relative to the position
SCsROW nRelRow;
SCsTAB nRelTab;
@@ -55,17 +56,17 @@ struct SC_DLLPUBLIC ScSingleRefData // Single reference (one address) int
sal_Bool bRowDeleted :1;
sal_Bool bTabRel :1;
sal_Bool bTabDeleted :1;
- sal_Bool bFlag3D :1; // 3D-Ref
- sal_Bool bRelName :1; // Reference derived from RangeName with relative values
+ sal_Bool bFlag3D :1; ///< 3D-Ref
+ sal_Bool bRelName :1; ///< Reference derived from RangeName with relative values
}Flags;
};
- // No default ctor, because used in ScRawToken union, set InitFlags!
- inline void InitFlags() { bFlags = 0; } // all FALSE
- // InitAddress: InitFlags and set address
+ /// No default ctor, because used in ScRawToken union, set InitFlags!
+ inline void InitFlags() { bFlags = 0; } ///< all FALSE
+ /// InitAddress: InitFlags and set address
inline void InitAddress( const ScAddress& rAdr );
inline void InitAddress( SCCOL nCol, SCROW nRow, SCTAB nTab );
- // InitAddressRel: InitFlags and set address, everything relative to rPos
+ /// InitAddressRel: InitFlags and set address, everything relative to rPos
inline void InitAddressRel( const ScAddress& rAdr, const ScAddress& rPos );
inline void SetColRel( sal_Bool bVal ) { Flags.bColRel = (bVal ? sal_True : false ); }
inline sal_Bool IsColRel() const { return Flags.bColRel; }
@@ -137,8 +138,8 @@ inline bool ScSingleRefData::ValidExternal() const
nTab == -1;
}
-
-struct ScComplexRefData // Complex reference (a range) into the sheet
+/// Complex reference (a range) into the sheet
+struct ScComplexRefData
{
ScSingleRefData Ref1;
ScSingleRefData Ref2;