sc/inc/dbdata.hxx | 18 +++++++++---------
sc/inc/detfunc.hxx | 24 ++++++++++++------------
sc/inc/dpdimsave.hxx | 26 ++++++++++++++------------
sc/inc/subtotalparam.hxx | 26 +++++++++++++-------------
sc/inc/tabprotection.hxx | 24 ++++++++++++------------
5 files changed, 60 insertions(+), 58 deletions(-)
New commits:
commit 3aea5e4c50d0b84e4e410856696eb0bf9101fbba
Author: Alaa.Bukhari <alloo.bukh...@gmail.com>
Date: Thu Jul 4 14:06:25 2013 +0300
Modifying comments to meet Doxygen standards
Change-Id: I98ee2cc34bae677e18f7a70a212677704c9c57c5
Reviewed-on: https://gerrit.libreoffice.org/4717
Reviewed-by: Fridrich Strba <fridr...@documentfoundation.org>
Tested-by: Fridrich Strba <fridr...@documentfoundation.org>
diff --git a/sc/inc/dbdata.hxx b/sc/inc/dbdata.hxx
index fcd5d49..c9ecdfb 100644
--- a/sc/inc/dbdata.hxx
+++ b/sc/inc/dbdata.hxx
@@ -43,7 +43,7 @@ private:
boost::scoped_ptr<ScSubTotalParam> mpSubTotal;
boost::scoped_ptr<ScImportParam> mpImportParam;
- // DBParam
+ /// DBParam
const OUString aName;
OUString aUpper;
SCTAB nTable;
@@ -57,15 +57,15 @@ private:
bool bKeepFmt;
bool bStripData;
- // QueryParam
- bool bIsAdvanced; // true if created by advanced filter
- ScRange aAdvSource; // source range
+ /// QueryParam
+ bool bIsAdvanced; ///< true if created by advanced filter
+ ScRange aAdvSource; ///< source range
- bool bDBSelection; // not in Param: if selection, block
update
+ bool bDBSelection; ///< not in Param: if selection, block
update
- sal_uInt16 nIndex; // unique index formulas
- bool bAutoFilter; // AutoFilter? (not saved)
- bool bModified; // is set/cleared for/by(?)
UpdateReference
+ sal_uInt16 nIndex; ///< unique index formulas
+ bool bAutoFilter; ///< AutoFilter? (not saved)
+ bool bModified; ///< is set/cleared for/by(?)
UpdateReference
using ScRefreshTimer::operator==;
@@ -211,7 +211,7 @@ public:
private:
Link aRefreshHandler;
ScDocument* pDoc;
- sal_uInt16 nEntryIndex; // counter for unique indices
+ sal_uInt16 nEntryIndex; ///< counter for unique indices
NamedDBs maNamedDBs;
AnonDBs maAnonDBs;
diff --git a/sc/inc/detfunc.hxx b/sc/inc/detfunc.hxx
index 0a63da3..7b6f75c 100644
--- a/sc/inc/detfunc.hxx
+++ b/sc/inc/detfunc.hxx
@@ -60,20 +60,20 @@ class SC_DLLPUBLIC ScDetectiveFunc
enum DrawPosMode
{
- DRAWPOS_TOPLEFT, /// Top-left edge of the cell.
- DRAWPOS_BOTTOMRIGHT, /// Bottom-right edge of the cell.
- DRAWPOS_DETARROW, /// Position inside cell for detective arrows.
- DRAWPOS_CAPTIONLEFT, /// Top-left edge of the cell for captions.
- DRAWPOS_CAPTIONRIGHT /// Top-right edge of the cell for captions
(incl. merged cells).
+ DRAWPOS_TOPLEFT, ///< Top-left edge of the cell.
+ DRAWPOS_BOTTOMRIGHT, ///< Bottom-right edge of the cell.
+ DRAWPOS_DETARROW, ///< Position inside cell for detective arrows.
+ DRAWPOS_CAPTIONLEFT, ///< Top-left edge of the cell for captions.
+ DRAWPOS_CAPTIONRIGHT ///< Top-right edge of the cell for captions
(incl. merged cells).
};
- /** Returns a drawing layer position for the passed cell address. */
+ /** @return a drawing layer position for the passed cell address. */
Point GetDrawPos( SCCOL nCol, SCROW nRow, DrawPosMode eMode ) const;
- /** Returns the drawing layer rectangle for the passed cell range. */
+ /** @return the drawing layer rectangle for the passed cell range. */
Rectangle GetDrawRect( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW
nRow2 ) const;
- /** Returns the drawing layer rectangle for the passed cell address. */
+ /** @return the drawing layer rectangle for the passed cell address. */
Rectangle GetDrawRect( SCCOL nCol, SCROW nRow ) const;
sal_Bool HasArrow( const ScAddress& rStart,
@@ -86,7 +86,7 @@ class SC_DLLPUBLIC ScDetectiveFunc
void FillAttributes( ScDetectiveData& rData );
- // called from DrawEntry/DrawAlienEntry and InsertObject
+ /// called from DrawEntry/DrawAlienEntry and InsertObject
sal_Bool InsertArrow( SCCOL nCol, SCROW nRow,
SCCOL nRefStartCol, SCROW nRefStartRow,
SCCOL nRefEndCol, SCROW nRefEndRow,
@@ -96,7 +96,7 @@ class SC_DLLPUBLIC ScDetectiveFunc
SCCOL nEndCol, SCROW nEndRow, sal_Bool bRed,
ScDetectiveData& rData );
- // DrawEntry / DrawAlienEntry check for existing arrows and
errors
+ /// DrawEntry / DrawAlienEntry check for existing arrows and
errors
sal_Bool DrawEntry( SCCOL nCol, SCROW nRow, const ScRange& rRef,
ScDetectiveData& rData );
sal_Bool DrawAlienEntry( const ScRange& rRef,
@@ -138,8 +138,8 @@ public:
void GetAllPreds(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW
nRow2, ::std::vector<ScTokenRef>& rRefTokens);
void GetAllSuccs(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW
nRow2, ::std::vector<ScTokenRef>& rRefTokens);
- static void UpdateAllComments( ScDocument& rDoc ); // on all tables
- void UpdateAllArrowColors(); // on all tables
+ static void UpdateAllComments( ScDocument& rDoc ); ///< on all
tables
+ void UpdateAllArrowColors(); ///< on all tables
static sal_Bool IsNonAlienArrow( SdrObject* pObject );
diff --git a/sc/inc/dpdimsave.hxx b/sc/inc/dpdimsave.hxx
index 488c08f..13d9faa 100644
--- a/sc/inc/dpdimsave.hxx
+++ b/sc/inc/dpdimsave.hxx
@@ -23,7 +23,7 @@
#include <vector>
#include <map>
#include <tools/string.hxx>
-#include "dpgroup.hxx" // for ScDPNumGroupInfo
+#include "dpgroup.hxx" ///< for ScDPNumGroupInfo
#include "scdllapi.h"
#include "dptypes.hxx"
@@ -35,16 +35,16 @@ class SvNumberFormatter;
class ScDPSaveGroupDimension;
-//
-// Classes to save Data Pilot settings that create new dimensions (fields).
-// These have to be applied before the other ScDPSaveData settings.
-//
+/**
+ * Classes to save Data Pilot settings that create new dimensions (fields).
+ * These have to be applied before the other ScDPSaveData settings.
+ */
class SC_DLLPUBLIC ScDPSaveGroupItem
{
- OUString aGroupName; // name of group
- std::vector<OUString> aElements; // names of items in original
dimension
- mutable std::vector<ScDPItemData> maItems; // items converted from the
strings.
+ OUString aGroupName; ///< name of group
+ std::vector<OUString> aElements; ///< names of items in
original dimension
+ mutable std::vector<ScDPItemData> maItems; ///< items converted from the
strings.
public:
ScDPSaveGroupItem( const OUString& rName );
@@ -55,7 +55,9 @@ public:
void AddElement( const OUString& rName );
void AddElementsFromGroup( const ScDPSaveGroupItem& rGroup );
const OUString& GetGroupName() const { return aGroupName; }
- bool RemoveElement( const OUString& rName ); // returns true if found
(removed)
+
+ /// @return true if found (removed)
+ bool RemoveElement( const OUString& rName );
bool IsEmpty() const;
size_t GetElementCount() const;
@@ -63,8 +65,8 @@ public:
void Rename( const OUString& rNewName );
- // remove this group's elements from their groups in rDimension
- // (rDimension must be a different dimension from the one which contains
this)
+ /** remove this group's elements from their groups in rDimension
+ (rDimension must be a different dimension from the one which contains
this)*/
void RemoveElementsFromGroups( ScDPSaveGroupDimension& rDimension )
const;
void ConvertElementsToItems(SvNumberFormatter* pFormatter) const;
@@ -79,7 +81,7 @@ typedef ::std::vector<ScDPSaveGroupItem> ScDPSaveGroupItemVec;
*/
class SC_DLLPUBLIC ScDPSaveGroupDimension
{
- OUString aSourceDim; // always the real source from the
original data
+ OUString aSourceDim; ///< always the real source from the
original data
OUString aGroupDimName;
ScDPSaveGroupItemVec aGroups;
mutable ScDPNumGroupInfo aDateInfo;
diff --git a/sc/inc/subtotalparam.hxx b/sc/inc/subtotalparam.hxx
index bbf2073..5105aed 100644
--- a/sc/inc/subtotalparam.hxx
+++ b/sc/inc/subtotalparam.hxx
@@ -15,24 +15,24 @@
struct SC_DLLPUBLIC ScSubTotalParam
{
- SCCOL nCol1; // selected area
+ SCCOL nCol1; ///< selected area
SCROW nRow1;
SCCOL nCol2;
SCROW nRow2;
- sal_uInt16 nUserIndex; // index into list
+ sal_uInt16 nUserIndex; ///< index into list
bool bRemoveOnly:1;
- bool bReplace:1; // replace existing results
- bool bPagebreak:1; // page break at change of
group
+ bool bReplace:1; ///< replace existing results
+ bool bPagebreak:1; ///< page break at change of
group
bool bCaseSens:1; //
- bool bDoSort:1; // presort
- bool bAscending:1; // sort ascending
- bool bUserDef:1; // sort user defined
- bool bIncludePattern:1; // sort formats
- bool bGroupActive[MAXSUBTOTAL]; // active groups
- SCCOL nField[MAXSUBTOTAL]; // associated field
- SCCOL nSubTotals[MAXSUBTOTAL]; // number of SubTotals
- SCCOL* pSubTotals[MAXSUBTOTAL]; // array of columns to be
calculated
- ScSubTotalFunc* pFunctions[MAXSUBTOTAL]; // array of associated
functions
+ bool bDoSort:1; ///< presort
+ bool bAscending:1; ///< sort ascending
+ bool bUserDef:1; ///< sort user defined
+ bool bIncludePattern:1; ///< sort formats
+ bool bGroupActive[MAXSUBTOTAL]; ///< active groups
+ SCCOL nField[MAXSUBTOTAL]; ///< associated field
+ SCCOL nSubTotals[MAXSUBTOTAL]; ///< number of SubTotals
+ SCCOL* pSubTotals[MAXSUBTOTAL]; ///< array of columns to be
calculated
+ ScSubTotalFunc* pFunctions[MAXSUBTOTAL]; ///< array of associated
functions
ScSubTotalParam();
ScSubTotalParam( const ScSubTotalParam& r );
diff --git a/sc/inc/tabprotection.hxx b/sc/inc/tabprotection.hxx
index f95f312..b8eb7ab 100644
--- a/sc/inc/tabprotection.hxx
+++ b/sc/inc/tabprotection.hxx
@@ -40,9 +40,9 @@ class ScPassHashHelper
{
public:
/** Check for the compatibility of all password hashes. If there is at
- least one hash that needs to be regenerated, it returns true. If all
- hash values are compatible with the specified hash type, then it
- returns false. */
+ * least one hash that needs to be regenerated, it returns true. If all
+ * hash values are compatible with the specified hash type, then it
+ * returns false. */
static bool needsPassHashRegen(const ScDocument& rDoc, ScPasswordHash
eHash1, ScPasswordHash eHash2 = PASSHASH_UNSPECIFIED);
static OUString getHashURI(ScPasswordHash eHash);
@@ -86,7 +86,7 @@ public:
STRUCTURE = 0,
WINDOWS,
CONTENT,
- NONE // last item - used to resize the vector
+ NONE ///< last item - used to resize the vector
};
explicit ScDocProtection();
@@ -117,13 +117,13 @@ private:
// ============================================================================
/** sheet protection state container
-
- This class stores sheet's protection state: 1) whether the protection
- is on, 2) password and/or password hash, and 3) any associated
- protection options. This class is also used as a protection state
- container for the undo/redo stack, in which case the password, hash and
- the options need to be preserved even when the protection flag is
- off. */
+ *
+ * This class stores sheet's protection state: 1) whether the protection
+ * is on, 2) password and/or password hash, and 3) any associated
+ * protection options. This class is also used as a protection state
+ * container for the undo/redo stack, in which case the password, hash and
+ * the options need to be preserved even when the protection flag is
+ * off. */
class SC_DLLPUBLIC ScTableProtection : public ScPassHashProtectable
{
public:
@@ -145,7 +145,7 @@ public:
SELECT_UNLOCKED_CELLS,
SHEET,
SORT,
- NONE // last item - used to resize the vector
+ NONE ///< last item - used to resize the vector
};
explicit ScTableProtection();
_______________________________________________
Libreoffice-commits mailing list
libreoffice-comm...@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
