[Libreoffice-commits] core.git: sc/inc
Nourah.AlShoeibi
nourah.alshoeibi at gmail.com
Tue Jul 9 05:07:53 PDT 2013
sc/inc/mtvelements.hxx | 18 ++++++++--------
sc/inc/nameuno.hxx | 52 ++++++++++++++++++++++++-------------------------
sc/inc/notesuno.hxx | 12 +++++------
sc/inc/rangeutl.hxx | 20 +++++++++---------
sc/inc/refdata.hxx | 29 ++++++++++++++-------------
5 files changed, 66 insertions(+), 65 deletions(-)
New commits:
commit f77c986fb36a9b57465c93e6c9693ed973008985
Author: Nourah.AlShoeibi <nourah.alshoeibi at gmail.com>
Date: Mon Jul 8 13:34:25 2013 +0300
Modifying comments to meet Doxygen standards
Change-Id: I9c498c8c2147a19c5f97e48bc8a0e149e6858e23
Reviewed-on: https://gerrit.libreoffice.org/4769
Reviewed-by: Petr Mladek <pmladek at suse.cz>
Tested-by: Petr Mladek <pmladek at suse.cz>
diff --git a/sc/inc/mtvelements.hxx b/sc/inc/mtvelements.hxx
index ad65418..443eb6a 100644
--- a/sc/inc/mtvelements.hxx
+++ b/sc/inc/mtvelements.hxx
@@ -44,7 +44,7 @@ struct CellTextAttr
CellTextAttr(sal_uInt16 nTextWidth, sal_uInt8 nScriptType);
};
-// Custom element type IDs for multi_type_vector.
+/// Custom element type IDs for multi_type_vector.
const mdds::mtv::element_t element_type_broadcaster = mdds::mtv::element_type_user_start;
const mdds::mtv::element_t element_type_celltextattr = mdds::mtv::element_type_user_start + 1;
@@ -53,11 +53,11 @@ const mdds::mtv::element_t element_type_string = mdds::mtv::element_type_user_st
const mdds::mtv::element_t element_type_edittext = mdds::mtv::element_type_user_start + 3;
const mdds::mtv::element_t element_type_formula = mdds::mtv::element_type_user_start + 4;
-// Mapped standard element types (for convenience).
+/// Mapped standard element types (for convenience).
const mdds::mtv::element_t element_type_numeric = mdds::mtv::element_type_numeric;
const mdds::mtv::element_t element_type_empty = mdds::mtv::element_type_empty;
-// Custom element blocks.
+/// Custom element blocks.
typedef mdds::mtv::noncopyable_managed_element_block<element_type_broadcaster, SvtBroadcaster> broadcaster_block;
typedef mdds::mtv::default_element_block<element_type_celltextattr, CellTextAttr> celltextattr_block;
@@ -65,15 +65,15 @@ typedef mdds::mtv::default_element_block<element_type_string, rtl::OUString> str
typedef mdds::mtv::noncopyable_managed_element_block<element_type_edittext, EditTextObject> edittext_block;
typedef mdds::mtv::noncopyable_managed_element_block<element_type_formula, ScFormulaCell> formula_block;
-// Mapped standard element blocks (for convenience).
+/// Mapped standard element blocks (for convenience).
typedef mdds::mtv::numeric_element_block numeric_block;
-// This needs to be in the same namespace as CellTextAttr.
+/// This needs to be in the same namespace as CellTextAttr.
MDDS_MTV_DEFINE_ELEMENT_CALLBACKS(CellTextAttr, element_type_celltextattr, CellTextAttr(), celltextattr_block)
}
-// These need to be in global namespace just like their respective types are.
+/// These need to be in global namespace just like their respective types are.
MDDS_MTV_DEFINE_ELEMENT_CALLBACKS_PTR(SvtBroadcaster, sc::element_type_broadcaster, NULL, sc::broadcaster_block)
MDDS_MTV_DEFINE_ELEMENT_CALLBACKS_PTR(ScFormulaCell, sc::element_type_formula, NULL, sc::formula_block)
MDDS_MTV_DEFINE_ELEMENT_CALLBACKS_PTR(EditTextObject, sc::element_type_edittext, NULL, sc::edittext_block)
@@ -86,15 +86,15 @@ MDDS_MTV_DEFINE_ELEMENT_CALLBACKS(OUString, sc::element_type_string, OUString(),
namespace sc {
-// Broadcaster storage container
+/// Broadcaster storage container
typedef mdds::mtv::custom_block_func1<sc::broadcaster_block> BCBlkFunc;
typedef mdds::multi_type_vector<BCBlkFunc> BroadcasterStoreType;
-// Cell text attribute container.
+/// Cell text attribute container.
typedef mdds::mtv::custom_block_func1<sc::celltextattr_block> CTAttrFunc;
typedef mdds::multi_type_vector<CTAttrFunc> CellTextAttrStoreType;
-// Cell container
+/// Cell container
typedef mdds::mtv::custom_block_func3<sc::string_block, sc::edittext_block, sc::formula_block> CellFunc;
typedef mdds::multi_type_vector<CellFunc> CellStoreType;
diff --git a/sc/inc/nameuno.hxx b/sc/inc/nameuno.hxx
index 0536271..7a5c619 100644
--- a/sc/inc/nameuno.hxx
+++ b/sc/inc/nameuno.hxx
@@ -79,7 +79,7 @@ public:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
- // XNamedRange
+ /// XNamedRange
virtual OUString SAL_CALL getContent() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setContent( const OUString& aContent )
throw(::com::sun::star::uno::RuntimeException);
@@ -91,23 +91,23 @@ public:
virtual sal_Int32 SAL_CALL getType() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setType( sal_Int32 nType ) throw(::com::sun::star::uno::RuntimeException);
- // XFormulaTokens
+ /// XFormulaTokens
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::sheet::FormulaToken > SAL_CALL getTokens()
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setTokens( const ::com::sun::star::uno::Sequence<
::com::sun::star::sheet::FormulaToken >& aTokens )
throw (::com::sun::star::uno::RuntimeException);
- // XNamed
+ /// XNamed
virtual OUString SAL_CALL getName() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setName( const OUString& aName )
throw(::com::sun::star::uno::RuntimeException);
- // XCellRangeReferrer
+ /// XCellRangeReferrer
virtual ::com::sun::star::uno::Reference< ::com::sun::star::table::XCellRange > SAL_CALL
getReferredCells() throw(::com::sun::star::uno::RuntimeException);
- // XPropertySet
+ /// XPropertySet
virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
SAL_CALL getPropertySetInfo()
throw(::com::sun::star::uno::RuntimeException);
@@ -148,14 +148,14 @@ public:
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
- // XUnoTunnel
+ /// XUnoTunnel
virtual sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence<
sal_Int8 >& aIdentifier )
throw(::com::sun::star::uno::RuntimeException);
static const com::sun::star::uno::Sequence<sal_Int8>& getUnoTunnelId();
- // XServiceInfo
+ /// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName )
@@ -176,9 +176,9 @@ class ScNamedRangesObj : public ::cppu::WeakImplHelper6<
{
private:
- // if true, adding new name or modifying existing one will set the
- // document 'modified' and broadcast the change. We turn this off during
- // import.
+ /** if true, adding new name or modifying existing one will set the
+ document 'modified' and broadcast the change. We turn this off during
+ import. */
sal_Bool mbModifyAndBroadcast;
virtual ScNamedRangeObj* GetObjectByIndex_Impl(sal_uInt16 nIndex) = 0;
@@ -204,7 +204,7 @@ public:
bool IsModifyAndBroadcast() const;
- // XNamedRanges
+ /// XNamedRanges
virtual void SAL_CALL addNewByName( const OUString& aName, const OUString& aContent,
const ::com::sun::star::table::CellAddress& aPosition, sal_Int32 nType )
throw(::com::sun::star::uno::RuntimeException);
@@ -216,7 +216,7 @@ public:
virtual void SAL_CALL outputList( const ::com::sun::star::table::CellAddress& aOutputPosition )
throw(::com::sun::star::uno::RuntimeException);
- // XNameAccess
+ /// XNameAccess
virtual ::com::sun::star::uno::Any SAL_CALL getByName( const OUString& aName )
throw(::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::WrappedTargetException,
@@ -226,23 +226,23 @@ public:
virtual sal_Bool SAL_CALL hasByName( const OUString& aName )
throw(::com::sun::star::uno::RuntimeException);
- // XIndexAccess
+ /// XIndexAccess
virtual sal_Int32 SAL_CALL getCount() throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( sal_Int32 Index )
throw(::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
- // XEnumerationAccess
+ /// XEnumerationAccess
virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL
createEnumeration() throw(::com::sun::star::uno::RuntimeException);
- // XElementAccess
+ /// XElementAccess
virtual ::com::sun::star::uno::Type SAL_CALL getElementType()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL hasElements() throw(::com::sun::star::uno::RuntimeException);
- // XPropertySet
+ /// XPropertySet
virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
SAL_CALL getPropertySetInfo()
throw(::com::sun::star::uno::RuntimeException);
@@ -283,14 +283,14 @@ public:
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
- // XActionLockable
+ /// XActionLockable
virtual sal_Bool SAL_CALL isActionLocked() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addActionLock() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeActionLock() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setActionLocks( sal_Int16 nLock ) throw(::com::sun::star::uno::RuntimeException);
virtual sal_Int16 SAL_CALL resetActionLocks() throw(::com::sun::star::uno::RuntimeException);
- // XServiceInfo
+ /// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName )
@@ -339,7 +339,7 @@ class ScLabelRangeObj : public ::cppu::WeakImplHelper2<
private:
ScDocShell* pDocShell;
sal_Bool bColumn;
- ScRange aRange; // criterion to find range
+ ScRange aRange; ///< criterion to find range
private:
ScRangePair* GetData_Impl();
@@ -351,7 +351,7 @@ public:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
- // XLabelRange
+ /// XLabelRange
virtual ::com::sun::star::table::CellRangeAddress SAL_CALL getLabelArea()
throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setLabelArea( const ::com::sun::star::table::CellRangeAddress& aLabelArea )
@@ -361,7 +361,7 @@ public:
virtual void SAL_CALL setDataArea( const ::com::sun::star::table::CellRangeAddress& aDataArea )
throw(::com::sun::star::uno::RuntimeException);
- // XServiceInfo
+ /// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName )
@@ -389,30 +389,30 @@ public:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
- // XLabelRanges
+ /// XLabelRanges
virtual void SAL_CALL addNew( const ::com::sun::star::table::CellRangeAddress& aLabelArea,
const ::com::sun::star::table::CellRangeAddress& aDataArea )
throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeByIndex( sal_Int32 nIndex )
throw(::com::sun::star::uno::RuntimeException);
- // XIndexAccess
+ /// XIndexAccess
virtual sal_Int32 SAL_CALL getCount() throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( sal_Int32 Index )
throw(::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
- // XEnumerationAccess
+ /// XEnumerationAccess
virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL
createEnumeration() throw(::com::sun::star::uno::RuntimeException);
- // XElementAccess
+ /// XElementAccess
virtual ::com::sun::star::uno::Type SAL_CALL getElementType()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL hasElements() throw(::com::sun::star::uno::RuntimeException);
- // XServiceInfo
+ /// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName )
diff --git a/sc/inc/notesuno.hxx b/sc/inc/notesuno.hxx
index 68d3afc..992f196 100644
--- a/sc/inc/notesuno.hxx
+++ b/sc/inc/notesuno.hxx
@@ -48,7 +48,7 @@ public:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
- // XChild
+ /// XChild
virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL
getParent() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setParent( const ::com::sun::star::uno::Reference<
@@ -56,7 +56,7 @@ public:
throw(::com::sun::star::lang::NoSupportException,
::com::sun::star::uno::RuntimeException);
- // XSimpleText
+ /// XSimpleText
virtual ::com::sun::star::uno::Reference< ::com::sun::star::text::XTextCursor > SAL_CALL
createTextCursor() throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::text::XTextCursor > SAL_CALL
@@ -73,7 +73,7 @@ public:
throw(::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException);
- // XTextRange
+ /// XTextRange
virtual ::com::sun::star::uno::Reference< ::com::sun::star::text::XText > SAL_CALL
getText() throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::text::XTextRange > SAL_CALL
@@ -84,7 +84,7 @@ public:
virtual void SAL_CALL setString( const OUString& aString )
throw(::com::sun::star::uno::RuntimeException);
- // XSheetAnnotation
+ /// XSheetAnnotation
virtual ::com::sun::star::table::CellAddress SAL_CALL getPosition()
throw(::com::sun::star::uno::RuntimeException);
virtual OUString SAL_CALL getAuthor() throw(::com::sun::star::uno::RuntimeException);
@@ -93,12 +93,12 @@ public:
virtual void SAL_CALL setIsVisible( sal_Bool bIsVisible )
throw(::com::sun::star::uno::RuntimeException);
- // XSheetAnnotationShapeSupplier
+ /// XSheetAnnotationShapeSupplier
virtual ::com::sun::star::uno::Reference < ::com::sun::star::drawing::XShape > SAL_CALL
getAnnotationShape()
throw(::com::sun::star::uno::RuntimeException);
- // XServiceInfo
+ /// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName )
diff --git a/sc/inc/rangeutl.hxx b/sc/inc/rangeutl.hxx
index cf8c980..cca168d 100644
--- a/sc/inc/rangeutl.hxx
+++ b/sc/inc/rangeutl.hxx
@@ -102,7 +102,7 @@ class SC_DLLPUBLIC ScRangeStringConverter
{
public:
-// helper methods
+/// helper methods
static void AssignString(
OUString& rString,
const OUString& rNewStr,
@@ -137,7 +137,7 @@ public:
const OUString& rTabName,
sal_Unicode cQuote = '\'');
-// String to Range core
+/// String to Range core
static sal_Bool GetAddressFromString(
ScAddress& rAddress,
const OUString& rAddressStr,
@@ -171,7 +171,7 @@ public:
sal_Unicode cSeparator = ' ',
sal_Unicode cQuote = '\'');
-// String to Range API
+/// String to Range API
static sal_Bool GetAddressFromString(
::com::sun::star::table::CellAddress& rAddress,
const OUString& rAddressStr,
@@ -196,7 +196,7 @@ public:
sal_Unicode cSeparator = ' ',
sal_Unicode cQuote = '\'');
-// Range to String core
+/// Range to String core
static void GetStringFromAddress(
OUString& rString,
const ScAddress& rAddress,
@@ -230,7 +230,7 @@ public:
sal_Bool bAppendStr = false,
sal_uInt16 nFormatFlags = (SCA_VALID | SCA_TAB_3D) );
-// Range to String API
+/// Range to String API
static void GetStringFromAddress(
OUString& rString,
const ::com::sun::star::table::CellAddress& rAddress,
@@ -255,13 +255,13 @@ public:
sal_Unicode cSeparator = ' ',
sal_uInt16 nFormatFlags = (SCA_VALID | SCA_TAB_3D) );
-// XML Range to Calc Range
+/// XML Range to Calc Range
static void GetStringFromXMLRangeString(
OUString& rString,
const OUString& rXMLRange,
ScDocument* pDoc );
-// String to RangeData core
+/// String to RangeData core
static ScRangeData* GetRangeDataFromString(const OUString& rString, const SCTAB nTab, const ScDocument* pDoc);
};
@@ -290,9 +290,9 @@ public:
SCROW nRowEnd;
};
-//
-// returns areas with reference and all db-areas
-//
+///
+/// @return areas with reference and all db-areas
+///
class SC_DLLPUBLIC ScAreaNameIterator
{
diff --git a/sc/inc/refdata.hxx b/sc/inc/refdata.hxx
index 6d6fe79..c943c88 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;
More information about the Libreoffice-commits
mailing list