Skip to content

C
core
Kaydet (Commit) 35b42a9d authored tarafından Nourah.AlShoeibi's avatar Nourah.AlShoeibi Kaydeden (comit) abdulmajeed ahmed
Dosyalara gözat
Seçenekler

Modifying comments to meet Doxygen standards 

Change-Id: I0a7d606f359a6cc99a8ecf0fd3fcc5c0b216c94f
Reviewed-on: https://gerrit.libreoffice.org/4754Reviewed-by: 's avatarabdulmajeed ahmed <aalabdulrazzaq@kacst.edu.sa>
Tested-by: 's avatarabdulmajeed ahmed <aalabdulrazzaq@kacst.edu.sa>
üst c06ef2b5
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 58 additions and 58 deletions
sc/inc/dispuno.hxx
Dosyayı görüntüle @ 35b42a9d
......@@ -24,7 +24,7 @@
#include <com/sun/star/view/XSelectionChangeListener.hpp>
#include <cppuhelper/implbase2.hxx>
#include <svl/lstner.hxx>
#include "global.hxx" // ScImportParam
#include "global.hxx" ///< ScImportParam
#include <boost/ptr_container/ptr_vector.hpp>
......@@ -47,17 +47,17 @@ class ScDispatchProviderInterceptor : public cppu::WeakImplHelper2<
{
ScTabViewShell* pViewShell;
// the component which's dispatches we're intercepting
/// the component which's dispatches we're intercepting
::com::sun::star::uno::Reference<
::com::sun::star::frame::XDispatchProviderInterception> m_xIntercepted;
// chaining
/// chaining
::com::sun::star::uno::Reference<
::com::sun::star::frame::XDispatchProvider> m_xSlaveDispatcher;
::com::sun::star::uno::Reference<
::com::sun::star::frame::XDispatchProvider> m_xMasterDispatcher;
// own dispatch
/// own dispatch
::com::sun::star::uno::Reference<
::com::sun::star::frame::XDispatch> m_xMyDispatch;
......@@ -68,7 +68,7 @@ public:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
// XDispatchProvider
/// XDispatchProvider
virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch > SAL_CALL
queryDispatch( const ::com::sun::star::util::URL& aURL,
const OUString& aTargetFrameName,
......@@ -80,7 +80,7 @@ public:
::com::sun::star::frame::DispatchDescriptor >& aDescripts )
throw(::com::sun::star::uno::RuntimeException);
// XDispatchProviderInterceptor
/// XDispatchProviderInterceptor
virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatchProvider > SAL_CALL
getSlaveDispatchProvider() throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setSlaveDispatchProvider( const ::com::sun::star::uno::Reference<
......@@ -92,7 +92,7 @@ public:
::com::sun::star::frame::XDispatchProvider >& xNewSupplier )
throw(::com::sun::star::uno::RuntimeException);
// XEventListener
/// XEventListener
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source )
throw(::com::sun::star::uno::RuntimeException);
};
......@@ -115,7 +115,7 @@ public:
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
// XDispatch
/// XDispatch
virtual void SAL_CALL dispatch( const ::com::sun::star::util::URL& aURL,
const ::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue >& aArgs )
......@@ -129,11 +129,11 @@ public:
const ::com::sun::star::util::URL& aURL )
throw(::com::sun::star::uno::RuntimeException);
// XSelectionChangeListener
/// XSelectionChangeListener
virtual void SAL_CALL selectionChanged( const ::com::sun::star::lang::EventObject& aEvent )
throw (::com::sun::star::uno::RuntimeException);
// XEventListener
/// XEventListener
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source )
throw (::com::sun::star::uno::RuntimeException);
};
......
sc/inc/docoptio.hxx
Dosyayı görüntüle @ 35b42a9d
......@@ -32,20 +32,20 @@
class SC_DLLPUBLIC ScDocOptions
{
double fIterEps; // epsilon value dazu
sal_uInt16 nIterCount; // number
sal_uInt16 nPrecStandardFormat; // precision for standard format
sal_uInt16 nDay; // Null date:
sal_uInt16 nIterCount; ///< number
sal_uInt16 nPrecStandardFormat; ///< precision for standard format
sal_uInt16 nDay; ///< Null date:
sal_uInt16 nMonth;
sal_uInt16 nYear;
sal_uInt16 nYear2000; // earlier 19YY is assumed, 20YY otherwise (if only YY of year is given)
sal_uInt16 nTabDistance; // distance of standard tabs
sal_Bool bIsIgnoreCase; // ignore case for comparisons?
sal_Bool bIsIter; // iterations for circular refs
sal_Bool bCalcAsShown; // calculate as shown (wrt precision)
sal_Bool bMatchWholeCell; // search criteria must match the whole cell
sal_Bool bDoAutoSpell; // auto-spelling
sal_Bool bLookUpColRowNames; // determine column-/row titles automagically
sal_Bool bFormulaRegexEnabled; // regular expressions in formulas enabled
sal_uInt16 nYear2000; ///< earlier 19YY is assumed, 20YY otherwise (if only YY of year is given)
sal_uInt16 nTabDistance; ///< distance of standard tabs
sal_Bool bIsIgnoreCase; ///< ignore case for comparisons?
sal_Bool bIsIter; ///< iterations for circular refs
sal_Bool bCalcAsShown; ///< calculate as shown (wrt precision)
sal_Bool bMatchWholeCell; ///< search criteria must match the whole cell
sal_Bool bDoAutoSpell; ///< auto-spelling
sal_Bool bLookUpColRowNames; ///< determine column-/row titles automagically
sal_Bool bFormulaRegexEnabled; ///< regular expressions in formulas enabled
public:
ScDocOptions();
ScDocOptions( const ScDocOptions& rCpy );
......
sc/inc/docuno.hxx
Dosyayı görüntüle @ 35b42a9d
This diff is collapsed.
sc/inc/scdll.hxx
Dosyayı görüntüle @ 35b42a9d
......@@ -39,17 +39,17 @@ class SfxFilter;
class ScDLL
{
public:
// Ctor/Dtor must be linked to the application
/// Ctor/Dtor must be linked to the application
ScDLL();
~ScDLL();
// static-init/exit-code must be linked to the application
static void LibInit(); // called from SfxApplication-subclass::Init()
static void LibExit(); // called from SfxApplication-subclass::Exit()
/// static-init/exit-code must be linked to the application
static void LibInit(); ///< called from SfxApplication-subclass::Init()
static void LibExit(); ///< called from SfxApplication-subclass::Exit()
static void PreExit(); // muss vor LibExit gerufen werden
// DLL-init/exit-code must be linked to the DLL only
static SC_DLLPUBLIC void Init(); // called directly after loading the DLL
/// DLL-init/exit-code must be linked to the DLL only
static SC_DLLPUBLIC void Init(); ///< called directly after loading the DLL
static sal_uLong DetectFilter( SfxMedium& rMedium, const SfxFilter** ppFilter,
SfxFilterFlags nMust, SfxFilterFlags nDont );
......
sc/inc/scextopt.hxx
Dosyayı görüntüle @ 35b42a9d
......@@ -28,10 +28,10 @@
/** Extended settings for the document, used in import/export filters. */
struct ScExtDocSettings
{
String maGlobCodeName; /// Global codename (VBA module name).
double mfTabBarWidth; /// Width of the tabbar, relative to frame window width (0.0 ... 1.0).
sal_uInt32 mnLinkCnt; /// Recursive counter for loading external documents.
SCTAB mnDisplTab; /// Index of displayed sheet.
String maGlobCodeName; ///< Global codename (VBA module name).
double mfTabBarWidth; ///< Width of the tabbar, relative to frame window width (0.0 ... 1.0).
sal_uInt32 mnLinkCnt; ///< Recursive counter for loading external documents.
SCTAB mnDisplTab; ///< Index of displayed sheet.
explicit ScExtDocSettings();
};
......@@ -39,30 +39,30 @@ struct ScExtDocSettings
/** Enumerates possible positions of panes in split sheets. */
enum ScExtPanePos
{
SCEXT_PANE_TOPLEFT, /// Single, top, left, or top-left pane.
SCEXT_PANE_TOPRIGHT, /// Right, or top-right pane.
SCEXT_PANE_BOTTOMLEFT, /// Bottom, or bottom-left pane.
SCEXT_PANE_BOTTOMRIGHT /// Bottom-right pane.
SCEXT_PANE_TOPLEFT, ///< Single, top, left, or top-left pane.
SCEXT_PANE_TOPRIGHT, ///< Right, or top-right pane.
SCEXT_PANE_BOTTOMLEFT, ///< Bottom, or bottom-left pane.
SCEXT_PANE_BOTTOMRIGHT ///< Bottom-right pane.
};
/** Extended settings for a sheet, used in import/export filters. */
struct ScExtTabSettings
{
ScRange maUsedArea; /// Used area in the sheet (columns/rows only).
ScRangeList maSelection; /// Selected cell ranges (columns/rows only).
ScAddress maCursor; /// The cursor position (column/row only).
ScAddress maFirstVis; /// Top-left visible cell (column/row only).
ScAddress maSecondVis; /// Top-left visible cell in add. panes (column/row only).
ScAddress maFreezePos; /// Position of frozen panes (column/row only).
Point maSplitPos; /// Position of split.
ScExtPanePos meActivePane; /// Active (focused) pane.
Color maGridColor; /// Grid color.
long mnNormalZoom; /// Zoom in percent for normal view.
long mnPageZoom; /// Zoom in percent for pagebreak preview.
bool mbSelected; /// true = Sheet is selected.
bool mbFrozenPanes; /// true = Frozen panes; false = Normal splits.
bool mbPageMode; /// true = Pagebreak mode; false = Normal view mode.
bool mbShowGrid; /// Whether or not to display gridlines.
ScRange maUsedArea; ///< Used area in the sheet (columns/rows only).
ScRangeList maSelection; ///< Selected cell ranges (columns/rows only).
ScAddress maCursor; ///< The cursor position (column/row only).
ScAddress maFirstVis; ///< Top-left visible cell (column/row only).
ScAddress maSecondVis; ///< Top-left visible cell in add. panes (column/row only).
ScAddress maFreezePos; ///< Position of frozen panes (column/row only).
Point maSplitPos; ///< Position of split.
ScExtPanePos meActivePane; ///< Active (focused) pane.
Color maGridColor; ///< Grid color.
long mnNormalZoom; ///< Zoom in percent for normal view.
long mnPageZoom; ///< Zoom in percent for pagebreak preview.
bool mbSelected; ///< true = Sheet is selected.
bool mbFrozenPanes; ///< true = Frozen panes; false = Normal splits.
bool mbPageMode; ///< true = Pagebreak mode; false = Normal view mode.
bool mbShowGrid; ///< Whether or not to display gridlines.
explicit ScExtTabSettings();
};
......@@ -84,24 +84,24 @@ public:
ScExtDocOptions& operator=( const ScExtDocOptions& rSrc );
/** Returns true, if the data needs to be copied to the view data after import. */
/** @return true, if the data needs to be copied to the view data after import. */
bool IsChanged() const;
/** If set to true, the data will be copied to the view data after import. */
void SetChanged( bool bChanged );
/** Returns read access to the global document settings. */
/** @return read access to the global document settings. */
const ScExtDocSettings& GetDocSettings() const;
/** Returns read/write access to the global document settings. */
/** @return read/write access to the global document settings. */
ScExtDocSettings& GetDocSettings();
/** Returns read access to the settings of a sheet, if extant; otherwise 0. */
/** @return read access to the settings of a sheet, if extant; otherwise 0. */
const ScExtTabSettings* GetTabSettings( SCTAB nTab ) const;
/** Returns read/write access to the settings of a sheet, may create a new struct. */
/** @return read/write access to the settings of a sheet, may create a new struct. */
ScExtTabSettings& GetOrCreateTabSettings( SCTAB nTab );
/** Returns the number of sheet codenames. */
/** @return the number of sheet codenames. */
SCTAB GetCodeNameCount() const;
/** Returns the specified codename (empty string = no codename). */
/** @return the specified codename (empty string = no codename). */
const String& GetCodeName( SCTAB nTab ) const;
/** Appends a codename for a sheet. */
void SetCodeName( SCTAB nTab, const String& rCodeName );
......
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