[Libreoffice-commits] .: sc/inc
Libreoffice Gerrit user
logerrit at kemper.freedesktop.org
Mon Sep 10 07:29:30 PDT 2012
sc/inc/AccessibleFilterMenu.hxx | 2 -
sc/inc/AccessibleGlobal.hxx | 5 +--
sc/inc/addincol.hxx | 58 ++++++++++++++++++++--------------------
sc/inc/address.hxx | 18 ++++++------
sc/inc/attarray.hxx | 4 +-
sc/inc/attrib.hxx | 8 ++---
sc/inc/autonamecache.hxx | 7 +---
7 files changed, 49 insertions(+), 53 deletions(-)
New commits:
commit dc44bd0ef0fc59b5501faaa30f6d781d5143dccd
Author: Faisal M. Al-Otaibi <fmalotaibi at kacst.edu.sa>
Date: Sun Sep 9 12:06:07 2012 +0300
Change some comments to meet doxygen standards
Change-Id: I3e5a40237f2ec3ac884c50e34a1592a029d9050d
Reviewed-on: https://gerrit.libreoffice.org/591
Reviewed-by: Thomas Arnhold <thomas at arnhold.org>
Reviewed-by: Luboš Luňák <l.lunak at suse.cz>
Tested-by: Luboš Luňák <l.lunak at suse.cz>
diff --git a/sc/inc/AccessibleFilterMenu.hxx b/sc/inc/AccessibleFilterMenu.hxx
index b91cdd7..2b90cee 100644
--- a/sc/inc/AccessibleFilterMenu.hxx
+++ b/sc/inc/AccessibleFilterMenu.hxx
@@ -102,7 +102,7 @@ public:
::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
throw (com::sun::star::uno::RuntimeException);
- // Remove an existing event listener.
+ /// Remove an existing event listener.
virtual void SAL_CALL
removeEventListener(
const ::com::sun::star::uno::Reference<
diff --git a/sc/inc/AccessibleGlobal.hxx b/sc/inc/AccessibleGlobal.hxx
index 9468aac..f0eff8e 100644
--- a/sc/inc/AccessibleGlobal.hxx
+++ b/sc/inc/AccessibleGlobal.hxx
@@ -25,9 +25,8 @@
#include <set>
-/**
- * Generic XAccessibleStateSet implementation.
- */
+
+/// Generic XAccessibleStateSet implementation.
class ScAccessibleStateSet : public ::cppu::WeakImplHelper1< ::com::sun::star::accessibility::XAccessibleStateSet >
{
public:
diff --git a/sc/inc/addincol.hxx b/sc/inc/addincol.hxx
index 15c8c7f..57bac0a 100644
--- a/sc/inc/addincol.hxx
+++ b/sc/inc/addincol.hxx
@@ -58,25 +58,25 @@ typedef ::boost::unordered_map< ::rtl::OUString, const ScUnoAddInFuncData*, ScSt
enum ScAddInArgumentType
{
- SC_ADDINARG_NONE, // -
- SC_ADDINARG_INTEGER, // long
- SC_ADDINARG_DOUBLE, // double
- SC_ADDINARG_STRING, // string
- SC_ADDINARG_INTEGER_ARRAY, // sequence<sequence<long>>
- SC_ADDINARG_DOUBLE_ARRAY, // sequence<sequence<double>>
- SC_ADDINARG_STRING_ARRAY, // sequence<sequence<string>>
- SC_ADDINARG_MIXED_ARRAY, // sequence<sequence<any>>
- SC_ADDINARG_VALUE_OR_ARRAY, // any
- SC_ADDINARG_CELLRANGE, // XCellRange
- SC_ADDINARG_CALLER, // XPropertySet
- SC_ADDINARG_VARARGS // sequence<any>
+ SC_ADDINARG_NONE, ///< -
+ SC_ADDINARG_INTEGER, ///< long
+ SC_ADDINARG_DOUBLE, ///< double
+ SC_ADDINARG_STRING, ///< string
+ SC_ADDINARG_INTEGER_ARRAY, ///< sequence<sequence<long>>
+ SC_ADDINARG_DOUBLE_ARRAY, ///< sequence<sequence<double>>
+ SC_ADDINARG_STRING_ARRAY, ///< sequence<sequence<string>>
+ SC_ADDINARG_MIXED_ARRAY, ///< sequence<sequence<any>>
+ SC_ADDINARG_VALUE_OR_ARRAY, ///< any
+ SC_ADDINARG_CELLRANGE, ///< XCellRange
+ SC_ADDINARG_CALLER, ///< XPropertySet
+ SC_ADDINARG_VARARGS ///< sequence<any>
};
//------------------------------------------------------------------------
struct ScAddInArgDesc
{
- ::rtl::OUString aInternalName; // used to match configuration and reflection information
+ ::rtl::OUString aInternalName; ///< used to match configuration and reflection information
::rtl::OUString aName;
::rtl::OUString aDescription;
ScAddInArgumentType eType;
@@ -86,10 +86,10 @@ struct ScAddInArgDesc
class ScUnoAddInFuncData
{
private:
- ::rtl::OUString aOriginalName; // kept in formula
- ::rtl::OUString aLocalName; // for display
- ::rtl::OUString aUpperName; // for entering formulas
- ::rtl::OUString aUpperLocal; // for entering formulas
+ ::rtl::OUString aOriginalName; ///< kept in formula
+ ::rtl::OUString aLocalName; ///< for display
+ ::rtl::OUString aUpperName; ///< for entering formulas
+ ::rtl::OUString aUpperLocal; ///< for entering formulas
::rtl::OUString aDescription;
com::sun::star::uno::Reference< com::sun::star::reflection::XIdlMethod> xFunction;
com::sun::star::uno::Any aObject;
@@ -143,10 +143,10 @@ class SC_DLLPUBLIC ScUnoAddInCollection
private:
long nFuncCount;
ScUnoAddInFuncData** ppFuncData;
- ScAddInHashMap* pExactHashMap; // exact internal name
- ScAddInHashMap* pNameHashMap; // internal name upper
- ScAddInHashMap* pLocalHashMap; // localized name upper
- sal_Bool bInitialized;
+ ScAddInHashMap* pExactHashMap; ///< exact internal name
+ ScAddInHashMap* pNameHashMap; ///< internal name upper
+ ScAddInHashMap* pLocalHashMap; ///< localized name upper
+ sal_Bool bInitialized;
void Initialize();
void ReadConfiguration();
@@ -164,9 +164,9 @@ public:
/// User enetered name. rUpperName MUST already be upper case!
::rtl::OUString FindFunction( const ::rtl::OUString& rUpperName, sal_Bool bLocalFirst );
- // rName is the exact Name.
- // Only if bComplete is set, the function reference and argument types
- // are initialized (component may have to be loaded).
+ /** Only if bComplete is set, the function reference and argument types
+ are initialized (component may have to be loaded).
+ @param rName is the exact Name. */
const ScUnoAddInFuncData* GetFuncData( const ::rtl::OUString& rName, bool bComplete = false );
/** For enumeration in ScCompiler::OpCodeMap::getAvailableMappings().
@@ -177,16 +177,16 @@ public:
void Clear();
- void LocalizeString( ::rtl::OUString& rName ); // modify rName - input: exact name
+ void LocalizeString( ::rtl::OUString& rName ); ///< modify rName - input: exact name
long GetFuncCount();
- sal_Bool FillFunctionDesc( long nFunc, ScFuncDesc& rDesc );
-
- static sal_Bool FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc );
+ sal_Bool FillFunctionDesc( long nFunc, ScFuncDesc& rDesc );
+ static sal_Bool FillFunctionDescFromData( const ScUnoAddInFuncData& rFuncData, ScFuncDesc& rDesc );
+ /// leave rRetExcelName unchanged, if no matching name is found
sal_Bool GetExcelName( const ::rtl::OUString& rCalcName, LanguageType eDestLang, ::rtl::OUString& rRetExcelName );
+ /// leave rRetCalcName unchanged, if no matching name is found
sal_Bool GetCalcName( const ::rtl::OUString& rExcelName, ::rtl::OUString& rRetCalcName );
- // both leave rRet... unchanged, if no matching name is found
};
diff --git a/sc/inc/address.hxx b/sc/inc/address.hxx
index 526c9d5..b2685f4 100644
--- a/sc/inc/address.hxx
+++ b/sc/inc/address.hxx
@@ -53,7 +53,7 @@ class ScDocument;
typedef sal_Int32 SCROW;
typedef sal_Int16 SCCOL;
typedef sal_Int16 SCTAB;
-typedef sal_Int32 SCCOLROW; // a type capable of holding either SCCOL or SCROW
+typedef sal_Int32 SCCOLROW; ///< a type capable of holding either SCCOL or SCROW
// temporarily signed typedefs
typedef sal_Int32 SCsROW;
@@ -61,8 +61,8 @@ typedef sal_Int16 SCsCOL;
typedef sal_Int16 SCsTAB;
typedef sal_Int32 SCsCOLROW;
-// size_t typedef to be able to find places where code was changed from USHORT
-// to size_t and is used to read/write from/to streams.
+/** size_t typedef to be able to find places where code was changed from USHORT
+ to size_t and is used to read/write from/to streams. */
typedef size_t SCSIZE;
// Maximum possible value of data type, NOT maximum row value.
@@ -84,7 +84,7 @@ const SCSIZE SCSIZE_MAX = ::std::numeric_limits<SCSIZE>::max();
// Count values
const SCROW MAXROWCOUNT = MAXROWCOUNT_DEFINE;
const SCCOL MAXCOLCOUNT = MAXCOLCOUNT_DEFINE;
-// limiting to 10000 for now, problem with 32 bit builds for now
+/// limiting to 10000 for now, problem with 32 bit builds for now
const SCTAB MAXTABCOUNT = 10000;
const SCCOLROW MAXCOLROWCOUNT = MAXROWCOUNT;
// Maximum values
@@ -375,10 +375,10 @@ inline bool ScAddress::operator!=( const ScAddress& r ) const
return !operator==( r );
}
+/** Same behavior as the old sal_uInt32 nAddress < r.nAddress with encoded
+ tab|col|row bit fields. */
inline bool ScAddress::operator<( const ScAddress& r ) const
{
- // Same behavior as the old sal_uInt32 nAddress < r.nAddress with encoded
- // tab|col|row bit fields.
if (nTab == r.nTab)
{
if (nCol == r.nCol)
@@ -462,8 +462,8 @@ public:
{ aStart = aEnd = rPos; return *this; }
inline void SetInvalid() { aStart.SetInvalid(); aEnd.SetInvalid(); }
inline bool IsValid() const { return aStart.IsValid() && aEnd.IsValid(); }
- inline bool In( const ScAddress& ) const; // is Address& in Range?
- inline bool In( const ScRange& ) const; // is Range& in Range?
+ inline bool In( const ScAddress& ) const; ///< is Address& in Range?
+ inline bool In( const ScRange& ) const; ///< is Range& in Range?
sal_uInt16 Parse( const String&, ScDocument* = NULL,
const ScAddress::Details& rDetails = ScAddress::detailsOOOa1,
@@ -547,7 +547,7 @@ inline bool ScRange::operator!=( const ScRange& r ) const
return !operator==( r );
}
-// Sort on upper left corner, if equal then use lower right too.
+/// Sort on upper left corner, if equal then use lower right too.
inline bool ScRange::operator<( const ScRange& r ) const
{
return aStart < r.aStart || (aStart == r.aStart && aEnd < r.aEnd) ;
diff --git a/sc/inc/attarray.hxx b/sc/inc/attarray.hxx
index 9b81440..1f8d9f2 100644
--- a/sc/inc/attarray.hxx
+++ b/sc/inc/attarray.hxx
@@ -67,8 +67,8 @@ struct ScLineFlags
struct ScMergePatternState
{
- SfxItemSet* pItemSet; // allocated in MergePatternArea, used for resulting ScPatternAttr
- const ScPatternAttr* pOld1; // existing objects, temporary
+ SfxItemSet* pItemSet; ///< allocated in MergePatternArea, used for resulting ScPatternAttr
+ const ScPatternAttr* pOld1; ///< existing objects, temporary
const ScPatternAttr* pOld2;
ScMergePatternState() : pItemSet(NULL), pOld1(NULL), pOld2(NULL) {}
diff --git a/sc/inc/attrib.hxx b/sc/inc/attrib.hxx
index 1df6d5c..0418d78 100644
--- a/sc/inc/attrib.hxx
+++ b/sc/inc/attrib.hxx
@@ -112,10 +112,10 @@ public:
//------------------------------------------------------------------------
class SC_DLLPUBLIC ScProtectionAttr: public SfxPoolItem
{
- bool bProtection; // protect cell
- bool bHideFormula; // hide formula
- bool bHideCell; // hide cell
- bool bHidePrint; // don't print cell
+ bool bProtection; ///< protect cell
+ bool bHideFormula; ///< hide formula
+ bool bHideCell; ///< hide cell
+ bool bHidePrint; ///< don't print cell
public:
TYPEINFO();
ScProtectionAttr();
diff --git a/sc/inc/autonamecache.hxx b/sc/inc/autonamecache.hxx
index 6534a39..fea0355 100644
--- a/sc/inc/autonamecache.hxx
+++ b/sc/inc/autonamecache.hxx
@@ -37,11 +37,8 @@
typedef ::std::vector< ScAddress > ScAutoNameAddresses;
typedef ::boost::unordered_map< String, ScAutoNameAddresses, ScStringHashCode, ::std::equal_to< String > > ScAutoNameHashMap;
-//
-// Cache for faster lookup of automatic names during CompileXML
-// (during CompileXML, no document content is changed)
-//
-
+/** Cache for faster lookup of automatic names during CompileXML
+ (during CompileXML, no document content is changed). */
class SC_DLLPUBLIC ScAutoNameCache
{
ScAutoNameHashMap aNames;
More information about the Libreoffice-commits
mailing list