[Libreoffice-commits] core.git: sc/inc

Nourah.AlShoeibi nourah.alshoeibi at gmail.com
Sun Jul 7 11:41:31 PDT 2013


 sc/inc/dispuno.hxx  |   20 ++++----
 sc/inc/docoptio.hxx |   24 +++++-----
 sc/inc/docuno.hxx   |  122 ++++++++++++++++++++++++++--------------------------
 sc/inc/scdll.hxx    |   12 ++---
 sc/inc/scextopt.hxx |   60 ++++++++++++-------------
 5 files changed, 119 insertions(+), 119 deletions(-)

New commits:
commit 35b42a9d1282a92dbc9a7fbc51d279812070688c
Author: Nourah.AlShoeibi <nourah.alshoeibi at gmail.com>
Date:   Sun Jul 7 13:18:20 2013 +0300

    Modifying comments to meet Doxygen standards
    
    Change-Id: I0a7d606f359a6cc99a8ecf0fd3fcc5c0b216c94f
    Reviewed-on: https://gerrit.libreoffice.org/4754
    Reviewed-by: abdulmajeed ahmed <aalabdulrazzaq at kacst.edu.sa>
    Tested-by: abdulmajeed ahmed <aalabdulrazzaq at kacst.edu.sa>

diff --git a/sc/inc/dispuno.hxx b/sc/inc/dispuno.hxx
index 6cf94b2..ad0549e 100644
--- a/sc/inc/dispuno.hxx
+++ b/sc/inc/dispuno.hxx
@@ -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);
 };
diff --git a/sc/inc/docoptio.hxx b/sc/inc/docoptio.hxx
index 4c70786..bc20c0a 100644
--- a/sc/inc/docoptio.hxx
+++ b/sc/inc/docoptio.hxx
@@ -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 );
diff --git a/sc/inc/docuno.hxx b/sc/inc/docuno.hxx
index a8647e4..897c90d 100644
--- a/sc/inc/docuno.hxx
+++ b/sc/inc/docuno.hxx
@@ -79,7 +79,7 @@ class SC_DLLPUBLIC ScModelObj : public SfxBaseModel,
                     public com::sun::star::view::XRenderable,
                     public com::sun::star::document::XLinkTargetSupplier,
                     public com::sun::star::beans::XPropertySet,
-                    public SvxFmMSFactory,  // derived from XMultiServiceFactory
+                    public SvxFmMSFactory,  ///< derived from XMultiServiceFactory
                     public com::sun::star::lang::XServiceInfo,
                     public ::com::sun::star::util::XChangesNotifier
 {
@@ -114,7 +114,7 @@ public:
                             ScModelObj(ScDocShell* pDocSh);
     virtual                 ~ScModelObj();
 
-    //  create ScModelObj and set at pDocSh (SetBaseModel)
+    /// create ScModelObj and set at pDocSh (SetBaseModel)
     static void             CreateAndSet(ScDocShell* pDocSh);
 
     ScDocument*             GetDocument() const;
@@ -143,15 +143,15 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XSpreadsheetDocument
+                            /// XSpreadsheetDocument
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XSpreadsheets > SAL_CALL
                             getSheets() throw(::com::sun::star::uno::RuntimeException);
 
-                                // XStyleFamiliesSupplier
+                            /// XStyleFamiliesSupplier
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > SAL_CALL
                             getStyleFamilies() throw(::com::sun::star::uno::RuntimeException);
 
-                            // XRenderable
+                            /// XRenderable
     virtual sal_Int32 SAL_CALL getRendererCount( const ::com::sun::star::uno::Any& aSelection,
                                     const ::com::sun::star::uno::Sequence<
                                         ::com::sun::star::beans::PropertyValue >& xOptions )
@@ -169,11 +169,11 @@ public:
                                 throw (::com::sun::star::lang::IllegalArgumentException,
                                         ::com::sun::star::uno::RuntimeException);
 
-                            // XLinkTargetSupplier
+                            /// XLinkTargetSupplier
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > SAL_CALL
                             getLinks() throw(::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);
@@ -184,7 +184,7 @@ public:
         virtual void SAL_CALL   lockControllers() throw (::com::sun::star::uno::RuntimeException);
         virtual void SAL_CALL   unlockControllers() throw (::com::sun::star::uno::RuntimeException);
 
-                                // XCalculatable
+                            /// XCalculatable
     virtual void SAL_CALL   calculate() throw(::com::sun::star::uno::RuntimeException);
     virtual void SAL_CALL   calculateAll() throw(::com::sun::star::uno::RuntimeException);
     virtual sal_Bool SAL_CALL isAutomaticCalculationEnabled()
@@ -192,7 +192,7 @@ public:
     virtual void SAL_CALL   enableAutomaticCalculation( sal_Bool bEnabled )
                                 throw(::com::sun::star::uno::RuntimeException);
 
-                            // XProtectable
+                            /// XProtectable
     virtual void SAL_CALL   protect( const OUString& aPassword )
                                 throw(::com::sun::star::uno::RuntimeException);
     virtual void SAL_CALL   unprotect( const OUString& aPassword )
@@ -200,18 +200,18 @@ public:
                                     ::com::sun::star::uno::RuntimeException);
     virtual sal_Bool SAL_CALL isProtected() throw(::com::sun::star::uno::RuntimeException);
 
-                            //  XDrawPagesSupplier
+                            /// XDrawPagesSupplier
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPages > SAL_CALL
                             getDrawPages() throw(::com::sun::star::uno::RuntimeException);
 
-                            //  XGoalSeek
+                            /// XGoalSeek
     virtual ::com::sun::star::sheet::GoalResult SAL_CALL seekGoal(
                                 const ::com::sun::star::table::CellAddress& aFormulaPosition,
                                 const ::com::sun::star::table::CellAddress& aVariablePosition,
                                 const OUString& aGoalValue )
                                     throw(::com::sun::star::uno::RuntimeException);
 
-                            //  XConsolidatable
+                            /// XConsolidatable
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XConsolidationDescriptor >
                             SAL_CALL createConsolidationDescriptor( sal_Bool bEmpty )
                                 throw(::com::sun::star::uno::RuntimeException);
@@ -219,14 +219,14 @@ public:
                                 ::com::sun::star::sheet::XConsolidationDescriptor >& xDescriptor )
                                     throw(::com::sun::star::uno::RuntimeException);
 
-                            //  XDocumentAuditing
+                            /// XDocumentAuditing
     virtual void SAL_CALL   refreshArrows() throw(::com::sun::star::uno::RuntimeException);
 
-                            //  XViewDataSupplier
+                            /// XViewDataSupplier
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess > SAL_CALL getViewData(  )
                                 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);
@@ -267,7 +267,7 @@ public:
                                     ::com::sun::star::lang::WrappedTargetException,
                                     ::com::sun::star::uno::RuntimeException);
 
-                            // XMultiServiceFactory
+                            /// XMultiServiceFactory
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL
                             createInstance( const OUString& aServiceSpecifier )
                                 throw(::com::sun::star::uno::Exception,
@@ -281,7 +281,7 @@ public:
     virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getAvailableServiceNames()
                                 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 )
@@ -289,7 +289,7 @@ public:
     virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames()
                                 throw(::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);
@@ -298,13 +298,13 @@ public:
     static ScModelObj* getImplementation( const com::sun::star::uno::Reference<
                                     com::sun::star::uno::XInterface> xObj );
 
-                            // XTypeProvider
+                            /// XTypeProvider
     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes()
                                 throw(::com::sun::star::uno::RuntimeException);
     virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId()
                                 throw(::com::sun::star::uno::RuntimeException);
 
-                            // XChangesNotifier
+                            /// XChangesNotifier
     virtual void SAL_CALL addChangesListener( const ::com::sun::star::uno::Reference<
                                     ::com::sun::star::util::XChangesListener >& aListener )
                                 throw (::com::sun::star::uno::RuntimeException);
@@ -331,7 +331,7 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XDrawPages
+                            /// XDrawPages
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XDrawPage > SAL_CALL
                             insertNewByIndex( sal_Int32 nIndex )
                                 throw(::com::sun::star::uno::RuntimeException);
@@ -339,19 +339,19 @@ public:
                                 ::com::sun::star::drawing::XDrawPage >& xPage )
                                     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);
 
-                            // 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 )
@@ -381,7 +381,7 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XSpreadsheets
+                            /// XSpreadsheets
     virtual void SAL_CALL   insertNewByName( const OUString& aName, sal_Int16 nPosition )
                                 throw(::com::sun::star::uno::RuntimeException);
     virtual void SAL_CALL   moveByName( const OUString& aName, sal_Int16 nDestination )
@@ -390,7 +390,7 @@ public:
                                 const OUString& aCopy, sal_Int16 nDestination )
                                     throw(::com::sun::star::uno::RuntimeException);
 
-                            // XSpreadsheets2
+                            /// XSpreadsheets2
     virtual sal_Int32 SAL_CALL importSheet(
         const ::com::sun::star::uno::Reference <
             ::com::sun::star::sheet::XSpreadsheetDocument > & xDocSrc,
@@ -400,7 +400,7 @@ public:
               ::com::sun::star::lang::IndexOutOfBoundsException,
               ::com::sun::star::uno::RuntimeException);
 
-                            // XCellRangesAccess
+                            /// XCellRangesAccess
 
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::table::XCell >
         SAL_CALL getCellByPosition( sal_Int32 nColumn, sal_Int32 nRow, sal_Int32 nSheet )
@@ -414,7 +414,7 @@ public:
         SAL_CALL getCellRangesByName( const OUString& aRange )
         throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
 
-                            // XNameContainer
+                            /// XNameContainer
     virtual void SAL_CALL   insertByName( const OUString& aName,
                                 const ::com::sun::star::uno::Any& aElement )
                                     throw(::com::sun::star::lang::IllegalArgumentException,
@@ -426,7 +426,7 @@ public:
                                     ::com::sun::star::lang::WrappedTargetException,
                                     ::com::sun::star::uno::RuntimeException);
 
-                            // XNameReplace
+                            /// XNameReplace
     virtual void SAL_CALL   replaceByName( const OUString& aName,
                                 const ::com::sun::star::uno::Any& aElement )
                                     throw(::com::sun::star::lang::IllegalArgumentException,
@@ -434,23 +434,23 @@ public:
                                         ::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);
 
-                            // 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);
 
-                            // 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,
@@ -460,7 +460,7 @@ public:
     virtual sal_Bool SAL_CALL hasByName( const OUString& aName )
                                 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 )
@@ -494,13 +494,13 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XTableColumns
+                            /// XTableColumns
     virtual void SAL_CALL   insertByIndex( sal_Int32 nIndex, sal_Int32 nCount )
                                 throw(::com::sun::star::uno::RuntimeException);
     virtual void SAL_CALL   removeByIndex( sal_Int32 nIndex, sal_Int32 nCount )
                                 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,
@@ -510,23 +510,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);
@@ -567,7 +567,7 @@ public:
                                     ::com::sun::star::lang::WrappedTargetException,
                                     ::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 )
@@ -599,29 +599,29 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XTableRows
+                            /// XTableRows
     virtual void SAL_CALL   insertByIndex( sal_Int32 nIndex, sal_Int32 nCount )
                                 throw(::com::sun::star::uno::RuntimeException);
     virtual void SAL_CALL   removeByIndex( sal_Int32 nIndex, sal_Int32 nCount )
                                 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);
@@ -662,7 +662,7 @@ public:
                                     ::com::sun::star::lang::WrappedTargetException,
                                     ::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 )
@@ -685,7 +685,7 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XPropertySet
+                            /// XPropertySet
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
                             SAL_CALL getPropertySetInfo()
                                 throw(::com::sun::star::uno::RuntimeException);
@@ -726,7 +726,7 @@ public:
                                     ::com::sun::star::lang::WrappedTargetException,
                                     ::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 )
@@ -744,7 +744,7 @@ class ScAnnotationsObj : public cppu::WeakImplHelper3<
 {
 private:
     ScDocShell*             pDocShell;
-    SCTAB                   nTab;           // Collection belongs to the sheet
+    SCTAB                   nTab;           ///< Collection belongs to the sheet
 
     bool                    GetAddressByIndex_Impl( sal_Int32 nIndex, ScAddress& rPos ) const;
     ScAnnotationObj*        GetObjectByIndex_Impl( sal_Int32 nIndex ) const;
@@ -755,30 +755,30 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XSheetAnnotations
+                            /// XSheetAnnotations
     virtual void SAL_CALL   insertNew( const ::com::sun::star::table::CellAddress& aPosition,
                                 const OUString& aText )
                                     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 )
@@ -809,7 +809,7 @@ public:
 
     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
 
-                            // XScenarios
+                            /// XScenarios
     virtual void SAL_CALL   addNewByName( const OUString& aName,
                                 const ::com::sun::star::uno::Sequence<
                                     ::com::sun::star::table::CellRangeAddress >& aRanges,
@@ -818,7 +818,7 @@ public:
     virtual void SAL_CALL   removeByName( const OUString& aName )
                                 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,
@@ -828,23 +828,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);
 
-                            // 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/scdll.hxx b/sc/inc/scdll.hxx
index fdf2792..6f7b163 100644
--- a/sc/inc/scdll.hxx
+++ b/sc/inc/scdll.hxx
@@ -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 );
diff --git a/sc/inc/scextopt.hxx b/sc/inc/scextopt.hxx
index 22e6ab6..33e5a26 100644
--- a/sc/inc/scextopt.hxx
+++ b/sc/inc/scextopt.hxx
@@ -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 );


More information about the Libreoffice-commits mailing list