Skip to content

C
core
Kaydet (Commit) 59db0c24 authored tarafından Nourah.AlShoeibi's avatar Nourah.AlShoeibi Kaydeden (comit) Petr Mladek
Dosyalara gözat
Seçenekler

Modifying comments to meet Doxygen standards 

Change-Id: I5626478f75a95a47493689db73b2886e316edb5d
Reviewed-on: https://gerrit.libreoffice.org/4788Reviewed-by: 's avatarPetr Mladek <pmladek@suse.cz>
Tested-by: 's avatarPetr Mladek <pmladek@suse.cz>
üst b45118b6
Hide whitespace changes
Inline Side-by-side
Showing with 63 additions and 63 deletions
sc/inc/AccessibleFilterMenu.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -52,7 +52,7 @@ public: ...@@ -52,7 +52,7 @@ public:
ScMenuFloatingWindow* pWin, const OUString& rName, size_t nMenuPos); ScMenuFloatingWindow* pWin, const OUString& rName, size_t nMenuPos);
virtual ~ScAccessibleFilterMenu(); virtual ~ScAccessibleFilterMenu();
// XAccessibleComponent /// XAccessibleComponent
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >
SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint ) SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint )
...@@ -70,7 +70,7 @@ public: ...@@ -70,7 +70,7 @@ public:
virtual sal_Int32 SAL_CALL getBackground() virtual sal_Int32 SAL_CALL getBackground()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
// XAccessibleContext /// XAccessibleContext
virtual OUString SAL_CALL getAccessibleName() virtual OUString SAL_CALL getAccessibleName()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
...@@ -90,7 +90,7 @@ public: ...@@ -90,7 +90,7 @@ public:
virtual OUString SAL_CALL getImplementationName() virtual OUString SAL_CALL getImplementationName()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
// XAccessibleEventBroadcaster /// XAccessibleEventBroadcaster
virtual void SAL_CALL virtual void SAL_CALL
addAccessibleEventListener( addAccessibleEventListener(
const ::com::sun::star::uno::Reference< const ::com::sun::star::uno::Reference<
...@@ -104,7 +104,7 @@ public: ...@@ -104,7 +104,7 @@ public:
::com::sun::star::accessibility::XAccessibleEventListener>& xListener) ::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
throw (com::sun::star::uno::RuntimeException); throw (com::sun::star::uno::RuntimeException);
// XAccessibleSelection /// XAccessibleSelection
virtual void SAL_CALL selectAccessibleChild(sal_Int32 nChildIndex) virtual void SAL_CALL selectAccessibleChild(sal_Int32 nChildIndex)
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
...@@ -128,7 +128,7 @@ public: ...@@ -128,7 +128,7 @@ public:
virtual void SAL_CALL deselectAccessibleChild(sal_Int32 nChildIndex) virtual void SAL_CALL deselectAccessibleChild(sal_Int32 nChildIndex)
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
// XInterface /// XInterface
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
::com::sun::star::uno::Type const & rType ) ::com::sun::star::uno::Type const & rType )
...@@ -137,12 +137,12 @@ public: ...@@ -137,12 +137,12 @@ public:
virtual void SAL_CALL acquire() throw (); virtual void SAL_CALL acquire() throw ();
virtual void SAL_CALL release() throw (); virtual void SAL_CALL release() throw ();
// XTypeProvider /// XTypeProvider
virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
// non-UNO methods /// non-UNO methods
void appendMenuItem(const OUString& rName, bool bEnabled, size_t nMenuPos); void appendMenuItem(const OUString& rName, bool bEnabled, size_t nMenuPos);
void setMenuPos(size_t nMenuPos); void setMenuPos(size_t nMenuPos);
......
sc/inc/AccessibleFilterMenuItem.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -41,7 +41,7 @@ public: ...@@ -41,7 +41,7 @@ public:
virtual ~ScAccessibleFilterMenuItem(); virtual ~ScAccessibleFilterMenuItem();
// XAccessibleContext /// XAccessibleContext
virtual sal_Int32 SAL_CALL getAccessibleChildCount() virtual sal_Int32 SAL_CALL getAccessibleChildCount()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
...@@ -59,7 +59,7 @@ public: ...@@ -59,7 +59,7 @@ public:
virtual OUString SAL_CALL getImplementationName() virtual OUString SAL_CALL getImplementationName()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
// XAccessibleAction /// XAccessibleAction
virtual ::sal_Int32 SAL_CALL getAccessibleActionCount() virtual ::sal_Int32 SAL_CALL getAccessibleActionCount()
throw (::com::sun::star::uno::RuntimeException); throw (::com::sun::star::uno::RuntimeException);
...@@ -75,7 +75,7 @@ public: ...@@ -75,7 +75,7 @@ public:
getAccessibleActionKeyBinding(sal_Int32 nIndex) getAccessibleActionKeyBinding(sal_Int32 nIndex)
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
// XInterface /// XInterface
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
::com::sun::star::uno::Type const & rType ) ::com::sun::star::uno::Type const & rType )
...@@ -84,7 +84,7 @@ public: ...@@ -84,7 +84,7 @@ public:
virtual void SAL_CALL acquire() throw (); virtual void SAL_CALL acquire() throw ();
virtual void SAL_CALL release() throw (); virtual void SAL_CALL release() throw ();
// Non-UNO Methods /// Non-UNO Methods
void setEnabled(bool bEnabled); void setEnabled(bool bEnabled);
......
sc/inc/bigrange.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -185,9 +185,9 @@ public: ...@@ -185,9 +185,9 @@ public:
{ return ScRange( aStart.MakeAddress(), { return ScRange( aStart.MakeAddress(),
aEnd.MakeAddress() ); } aEnd.MakeAddress() ); }
inline sal_Bool In( const ScBigAddress& ) const; // is Address& in range? inline sal_Bool In( const ScBigAddress& ) const; ///< is Address& in range?
inline sal_Bool In( const ScBigRange& ) const; // is Range& in range? inline sal_Bool In( const ScBigRange& ) const; ///< is Range& in range?
inline sal_Bool Intersects( const ScBigRange& ) const; // do two ranges overlap? inline sal_Bool Intersects( const ScBigRange& ) const; ///< do two ranges overlap?
ScBigRange& operator=( const ScBigRange& r ) ScBigRange& operator=( const ScBigRange& r )
{ aStart = r.aStart; aEnd = r.aEnd; return *this; } { aStart = r.aStart; aEnd = r.aEnd; return *this; }
......
sc/inc/callform.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -80,9 +80,9 @@ public: ...@@ -80,9 +80,9 @@ public:
bool Call(void** ppParam) const; bool Call(void** ppParam) const;
bool Unadvice(double nHandle); bool Unadvice(double nHandle);
// name and description of parameter nParam. /** name and description of parameter nParam.
// nParam==0 => Desc := function description, nParam==0 => Desc := function description,
// Name := n/a Name := n/a */
bool getParamDesc( OUString& aName, OUString& aDesc, sal_uInt16 nParam ) const; bool getParamDesc( OUString& aName, OUString& aDesc, sal_uInt16 nParam ) const;
}; };
......
sc/inc/cellform.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -30,9 +30,9 @@ class ScAddress; ...@@ -30,9 +30,9 @@ class ScAddress;
struct ScRefCellValue; struct ScRefCellValue;
enum ScForceTextFmt { enum ScForceTextFmt {
ftDontForce, // numbers as numbers ftDontForce, ///< numbers as numbers
ftForce, // numbers as text ftForce, ///< numbers as text
ftCheck // is the numberformat a textformat? ftCheck ///< is the numberformat a textformat?
}; };
//------------------------------------------------------------------------ //------------------------------------------------------------------------
......
sc/inc/patattr.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -35,17 +35,17 @@ class SvNumberFormatter; ...@@ -35,17 +35,17 @@ class SvNumberFormatter;
class ScDocument; class ScDocument;
// how to treat COL_AUTO in GetFont: /// how to treat COL_AUTO in GetFont:
enum ScAutoFontColorMode enum ScAutoFontColorMode
{ {
SC_AUTOCOL_RAW, // COL_AUTO is returned SC_AUTOCOL_RAW, ///< COL_AUTO is returned
SC_AUTOCOL_BLACK, // always use black SC_AUTOCOL_BLACK, ///< always use black
SC_AUTOCOL_PRINT, // black or white, depending on background SC_AUTOCOL_PRINT, ///< black or white, depending on background
SC_AUTOCOL_DISPLAY, // from style settings, or black/white if needed SC_AUTOCOL_DISPLAY, ///< from style settings, or black/white if needed
SC_AUTOCOL_IGNOREFONT, // like DISPLAY, but ignore stored font color (assume COL_AUTO) SC_AUTOCOL_IGNOREFONT, ///< like DISPLAY, but ignore stored font color (assume COL_AUTO)
SC_AUTOCOL_IGNOREBACK, // like DISPLAY, but ignore stored background color (use configured color) SC_AUTOCOL_IGNOREBACK, ///< like DISPLAY, but ignore stored background color (use configured color)
SC_AUTOCOL_IGNOREALL // like DISPLAY, but ignore stored font and background colors SC_AUTOCOL_IGNOREALL ///< like DISPLAY, but ignore stored font and background colors
}; };
...@@ -74,7 +74,7 @@ public: ...@@ -74,7 +74,7 @@ public:
static const SfxPoolItem& GetItem( sal_uInt16 nWhich, const SfxItemSet& rItemSet, const SfxItemSet* pCondSet ); static const SfxPoolItem& GetItem( sal_uInt16 nWhich, const SfxItemSet& rItemSet, const SfxItemSet* pCondSet );
const SfxPoolItem& GetItem( sal_uInt16 nWhich, const SfxItemSet* pCondSet ) const; const SfxPoolItem& GetItem( sal_uInt16 nWhich, const SfxItemSet* pCondSet ) const;
// pWhich are no ranges, but single IDs, 0-terminated /// @param pWhich are no ranges, but single IDs, 0-terminated
bool HasItemsSet( const sal_uInt16* pWhich ) const; bool HasItemsSet( const sal_uInt16* pWhich ) const;
void ClearItems( const sal_uInt16* pWhich ); void ClearItems( const sal_uInt16* pWhich );
...@@ -145,7 +145,7 @@ class ScFontToSubsFontConverter_AutoPtr ...@@ -145,7 +145,7 @@ class ScFontToSubsFontConverter_AutoPtr
DestroyFontToSubsFontConverter( h ); DestroyFontToSubsFontConverter( h );
} }
// prevent usage /// prevent usage
ScFontToSubsFontConverter_AutoPtr( const ScFontToSubsFontConverter_AutoPtr& ); ScFontToSubsFontConverter_AutoPtr( const ScFontToSubsFontConverter_AutoPtr& );
ScFontToSubsFontConverter_AutoPtr& operator=( const ScFontToSubsFontConverter_AutoPtr& ); ScFontToSubsFontConverter_AutoPtr& operator=( const ScFontToSubsFontConverter_AutoPtr& );
......
sc/inc/pivot.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -55,8 +55,8 @@ ...@@ -55,8 +55,8 @@
struct ScDPName struct ScDPName
{ {
OUString maName; /// Original name of the dimension. OUString maName; ///< Original name of the dimension.
OUString maLayoutName; /// Layout name (display name) OUString maLayoutName; ///< Layout name (display name)
explicit ScDPName(const OUString& rName, const OUString& rLayoutName); explicit ScDPName(const OUString& rName, const OUString& rLayoutName);
}; };
...@@ -65,16 +65,16 @@ struct ScDPName ...@@ -65,16 +65,16 @@ struct ScDPName
struct ScDPLabelData struct ScDPLabelData
{ {
OUString maName; /// Original name of the dimension. OUString maName; ///< Original name of the dimension.
OUString maLayoutName; /// Layout name (display name) OUString maLayoutName; ///< Layout name (display name)
OUString maSubtotalName; OUString maSubtotalName;
SCCOL mnCol; /// 0-based field index (not the source column index) SCCOL mnCol; ///< 0-based field index (not the source column index)
long mnOriginalDim; /// original dimension index (>= 0 for duplicated dimension) long mnOriginalDim; ///< original dimension index (>= 0 for duplicated dimension)
sal_uInt16 mnFuncMask; /// Page/Column/Row subtotal function. sal_uInt16 mnFuncMask; ///< Page/Column/Row subtotal function.
sal_Int32 mnUsedHier; /// Used hierarchy. sal_Int32 mnUsedHier; ///< Used hierarchy.
sal_Int32 mnFlags; /// Flags from the DataPilotSource dimension sal_Int32 mnFlags; ///< Flags from the DataPilotSource dimension
bool mbShowAll:1; /// true = Show all (also empty) results. bool mbShowAll:1; ///< true = Show all (also empty) results.
bool mbIsValue:1; /// true = Sum or count in data field. bool mbIsValue:1; ///< true = Sum or count in data field.
bool mbDataLayout:1; bool mbDataLayout:1;
struct Member struct Member
...@@ -87,22 +87,22 @@ struct ScDPLabelData ...@@ -87,22 +87,22 @@ struct ScDPLabelData
Member(); Member();
/** /**
* return the name that should be displayed in the dp dialogs i.e. * @return the name that should be displayed in the dp dialogs i.e.
* when the layout name is present, use it, or else use the original * when the layout name is present, use it, or else use the original
* name. * name.
*/ */
OUString SC_DLLPUBLIC getDisplayName() const; OUString SC_DLLPUBLIC getDisplayName() const;
}; };
::std::vector<Member> maMembers; ::std::vector<Member> maMembers;
::com::sun::star::uno::Sequence< OUString > maHiers; /// Hierarchies. ::com::sun::star::uno::Sequence< OUString > maHiers; ///< Hierarchies.
::com::sun::star::sheet::DataPilotFieldSortInfo maSortInfo; /// Sorting info. ::com::sun::star::sheet::DataPilotFieldSortInfo maSortInfo; ///< Sorting info.
::com::sun::star::sheet::DataPilotFieldLayoutInfo maLayoutInfo; /// Layout info. ::com::sun::star::sheet::DataPilotFieldLayoutInfo maLayoutInfo; ///< Layout info.
::com::sun::star::sheet::DataPilotFieldAutoShowInfo maShowInfo; /// AutoShow info. ::com::sun::star::sheet::DataPilotFieldAutoShowInfo maShowInfo; ///< AutoShow info.
ScDPLabelData(); ScDPLabelData();
/** /**
* return the name that should be displayed in the dp dialogs i.e. when * @return the name that should be displayed in the dp dialogs i.e. when
* the layout name is present, use it, or else use the original name. * the layout name is present, use it, or else use the original name.
*/ */
OUString SC_DLLPUBLIC getDisplayName() const; OUString SC_DLLPUBLIC getDisplayName() const;
...@@ -112,8 +112,8 @@ typedef boost::ptr_vector<ScDPLabelData> ScDPLabelDataVector; ...@@ -112,8 +112,8 @@ typedef boost::ptr_vector<ScDPLabelData> ScDPLabelDataVector;
struct ScPivotField struct ScPivotField
{ {
SCCOL nCol; /// 0-based dimension index (not source column index) SCCOL nCol; ///< 0-based dimension index (not source column index)
long mnOriginalDim; /// >= 0 for duplicated field. long mnOriginalDim; ///< >= 0 for duplicated field.
sal_uInt16 nFuncMask; sal_uInt16 nFuncMask;
sal_uInt8 mnDupCount; sal_uInt8 mnDupCount;
::com::sun::star::sheet::DataPilotFieldReference maFieldRef; ::com::sun::star::sheet::DataPilotFieldReference maFieldRef;
...@@ -129,8 +129,8 @@ typedef ::std::vector< ScPivotField > ScPivotFieldVector; ...@@ -129,8 +129,8 @@ typedef ::std::vector< ScPivotField > ScPivotFieldVector;
struct ScPivotParam struct ScPivotParam
{ {
SCCOL nCol; // Cursor Position / SCCOL nCol; ///< Cursor Position /
SCROW nRow; // or start of destination area SCROW nRow; ///< or start of destination area
SCTAB nTab; SCTAB nTab;
ScDPLabelDataVector maLabelArray; ScDPLabelDataVector maLabelArray;
ScPivotFieldVector maPageFields; ScPivotFieldVector maPageFields;
......
sc/inc/prnsave.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -31,9 +31,9 @@ class ScPrintSaverTab ...@@ -31,9 +31,9 @@ class ScPrintSaverTab
{ {
typedef ::std::vector< ScRange > ScRangeVec; typedef ::std::vector< ScRange > ScRangeVec;
ScRangeVec maPrintRanges; // Array ScRangeVec maPrintRanges; ///< Array
ScRange* mpRepeatCol; // single ScRange* mpRepeatCol; ///< single
ScRange* mpRepeatRow; // single ScRange* mpRepeatRow; ///< single
sal_Bool mbEntireSheet; sal_Bool mbEntireSheet;
public: public:
...@@ -54,7 +54,7 @@ public: ...@@ -54,7 +54,7 @@ public:
class ScPrintRangeSaver class ScPrintRangeSaver
{ {
SCTAB nTabCount; SCTAB nTabCount;
ScPrintSaverTab* pData; // Array ScPrintSaverTab* pData; ///< Array
public: public:
ScPrintRangeSaver( SCTAB nCount ); ScPrintRangeSaver( SCTAB nCount );
......
sc/inc/progress.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -52,7 +52,7 @@ private: ...@@ -52,7 +52,7 @@ private:
SfxProgress* pProgress; SfxProgress* pProgress;
// not implemented /// not implemented
ScProgress( const ScProgress& ); ScProgress( const ScProgress& );
ScProgress& operator=( const ScProgress& ); ScProgress& operator=( const ScProgress& );
...@@ -80,10 +80,10 @@ public: ...@@ -80,10 +80,10 @@ public:
~ScProgress(); ~ScProgress();
#ifdef SC_PROGRESS_CXX #ifdef SC_PROGRESS_CXX
// for DummyInterpret only, never use otherwise!!! /// for DummyInterpret only, never use otherwise!!!
ScProgress(); ScProgress();
#endif #endif
// might be NULL! /// might be NULL!
SfxProgress* GetSfxProgress() const { return pProgress; } SfxProgress* GetSfxProgress() const { return pProgress; }
sal_Bool SetStateText( sal_uLong nVal, const String &rVal, sal_uLong nNewRange = 0 ) sal_Bool SetStateText( sal_uLong nVal, const String &rVal, sal_uLong nNewRange = 0 )
...@@ -124,14 +124,14 @@ public: ...@@ -124,14 +124,14 @@ public:
return sal_True; return sal_True;
} }
sal_Bool SetStateOnPercent( sal_uLong nVal ) sal_Bool SetStateOnPercent( sal_uLong nVal )
{ // only if percentage increased { /// only if percentage increased
if ( nGlobalRange && (nVal * 100 / if ( nGlobalRange && (nVal * 100 /
nGlobalRange) > nGlobalPercent ) nGlobalRange) > nGlobalPercent )
return SetState( nVal ); return SetState( nVal );
return sal_True; return sal_True;
} }
sal_Bool SetStateCountDownOnPercent( sal_uLong nVal ) sal_Bool SetStateCountDownOnPercent( sal_uLong nVal )
{ // only if percentage increased { /// only if percentage increased
if ( nGlobalRange && if ( nGlobalRange &&
((nGlobalRange - nVal) * 100 / ((nGlobalRange - nVal) * 100 /
nGlobalRange) > nGlobalPercent ) nGlobalRange) > nGlobalPercent )
......
sc/inc/queryentry.hxx
Dosyayı görüntüle @ 59db0c24
...@@ -53,14 +53,14 @@ struct SC_DLLPUBLIC ScQueryEntry ...@@ -53,14 +53,14 @@ struct SC_DLLPUBLIC ScQueryEntry
SCCOLROW nField; SCCOLROW nField;
ScQueryOp eOp; ScQueryOp eOp;
ScQueryConnect eConnect; ScQueryConnect eConnect;
mutable utl::SearchParam* pSearchParam; // if RegExp, not saved mutable utl::SearchParam* pSearchParam; ///< if RegExp, not saved
mutable utl::TextSearch* pSearchText; // if RegExp, not saved mutable utl::TextSearch* pSearchText; ///< if RegExp, not saved
ScQueryEntry(); ScQueryEntry();
ScQueryEntry(const ScQueryEntry& r); ScQueryEntry(const ScQueryEntry& r);
~ScQueryEntry(); ~ScQueryEntry();
// creates pSearchParam and pSearchText if necessary, always RegExp! /// creates pSearchParam and pSearchText if necessary, always RegExp!
utl::TextSearch* GetSearchTextPtr( bool bCaseSens ) const; utl::TextSearch* GetSearchTextPtr( bool bCaseSens ) const;
QueryItemsType& GetQueryItems(); QueryItemsType& GetQueryItems();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment