Modifying comments to meet Doxygen standards

Change-Id: I5626478f75a95a47493689db73b2886e316edb5d
Reviewed-on: https://gerrit.libreoffice.org/4788
Reviewed-by: Petr Mladek <pmladek@suse.cz>
Tested-by: Petr Mladek <pmladek@suse.cz>

10 files changed, 63 insertions, 63 deletions

diff --git a/sc/inc/AccessibleFilterMenu.hxx b/sc/inc/AccessibleFilterMenu.hxx
index 0c6bd58afaa3..2078e6a42417 100644
--- a/sc/inc/AccessibleFilterMenu.hxx
+++ b/sc/inc/AccessibleFilterMenu.hxx
@@ -52,7 +52,7 @@ public:
             ScMenuFloatingWindow* pWin, const OUString& rName, size_t nMenuPos);
     virtual ~ScAccessibleFilterMenu();
 
-    // XAccessibleComponent
+    /// XAccessibleComponent
 
     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >
         SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint )
@@ -70,7 +70,7 @@ public:
     virtual sal_Int32 SAL_CALL getBackground()
         throw (::com::sun::star::uno::RuntimeException);
 
-    // XAccessibleContext
+    /// XAccessibleContext
 
     virtual OUString SAL_CALL getAccessibleName()
         throw (::com::sun::star::uno::RuntimeException);
@@ -90,7 +90,7 @@ public:
     virtual OUString SAL_CALL getImplementationName()
         throw (::com::sun::star::uno::RuntimeException);
 
-    // XAccessibleEventBroadcaster
+    /// XAccessibleEventBroadcaster
     virtual void SAL_CALL
         addAccessibleEventListener(
             const ::com::sun::star::uno::Reference<
@@ -104,7 +104,7 @@ public:
                 ::com::sun::star::accessibility::XAccessibleEventListener>& xListener)
         throw (com::sun::star::uno::RuntimeException);
 
-    // XAccessibleSelection
+    /// XAccessibleSelection
 
     virtual void SAL_CALL selectAccessibleChild(sal_Int32 nChildIndex)
         throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
@@ -128,7 +128,7 @@ public:
     virtual void SAL_CALL deselectAccessibleChild(sal_Int32 nChildIndex)
         throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 
-    // XInterface
+    /// XInterface
 
     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
         ::com::sun::star::uno::Type const & rType )
@@ -137,12 +137,12 @@ public:
     virtual void SAL_CALL acquire() throw ();
     virtual void SAL_CALL release() throw ();
 
-    // XTypeProvider
+    /// XTypeProvider
 
     virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL getImplementationId()
         throw (::com::sun::star::uno::RuntimeException);
 
-    // non-UNO methods
+    /// non-UNO methods
 
     void appendMenuItem(const OUString& rName, bool bEnabled, size_t nMenuPos);
     void setMenuPos(size_t nMenuPos);
diff --git a/sc/inc/AccessibleFilterMenuItem.hxx b/sc/inc/AccessibleFilterMenuItem.hxx
index 82b6f843ccd4..93927f9b246d 100644
--- a/sc/inc/AccessibleFilterMenuItem.hxx
+++ b/sc/inc/AccessibleFilterMenuItem.hxx
@@ -41,7 +41,7 @@ public:
 
     virtual ~ScAccessibleFilterMenuItem();
 
-    // XAccessibleContext
+    /// XAccessibleContext
 
     virtual sal_Int32 SAL_CALL getAccessibleChildCount()
         throw (::com::sun::star::uno::RuntimeException);
@@ -59,7 +59,7 @@ public:
     virtual OUString SAL_CALL getImplementationName()
         throw (::com::sun::star::uno::RuntimeException);
 
-    // XAccessibleAction
+    /// XAccessibleAction
 
     virtual ::sal_Int32 SAL_CALL getAccessibleActionCount()
         throw (::com::sun::star::uno::RuntimeException);
@@ -75,7 +75,7 @@ public:
         getAccessibleActionKeyBinding(sal_Int32 nIndex)
             throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
 
-    // XInterface
+    /// XInterface
 
     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
         ::com::sun::star::uno::Type const & rType )
@@ -84,7 +84,7 @@ public:
     virtual void SAL_CALL acquire() throw ();
     virtual void SAL_CALL release() throw ();
 
-    // Non-UNO Methods
+    /// Non-UNO Methods
 
     void setEnabled(bool bEnabled);
 
diff --git a/sc/inc/bigrange.hxx b/sc/inc/bigrange.hxx
index a3efe5ade28c..5abb2b09ec6b 100644
--- a/sc/inc/bigrange.hxx
+++ b/sc/inc/bigrange.hxx
@@ -185,9 +185,9 @@ public:
                     { return ScRange( aStart.MakeAddress(),
                         aEnd.MakeAddress() ); }
 
-    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 Intersects( const ScBigRange& ) const;  // do two ranges overlap?
+    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 Intersects( const ScBigRange& ) const;  ///< do two ranges overlap?
 
     ScBigRange&     operator=( const ScBigRange& r )
                         { aStart = r.aStart; aEnd = r.aEnd; return *this; }
diff --git a/sc/inc/callform.hxx b/sc/inc/callform.hxx
index 386e0822f7f0..5caf2ec8e466 100644
--- a/sc/inc/callform.hxx
+++ b/sc/inc/callform.hxx
@@ -80,9 +80,9 @@ public:
     bool        Call(void** ppParam) const;
     bool        Unadvice(double nHandle);
 
-                // name and description of parameter nParam.
-                // nParam==0 => Desc := function description,
-                // Name := n/a
+                /** name and description of parameter nParam.
+                    nParam==0 => Desc := function description,
+                    Name := n/a */
     bool getParamDesc( OUString& aName, OUString& aDesc, sal_uInt16 nParam ) const;
 };
 
diff --git a/sc/inc/cellform.hxx b/sc/inc/cellform.hxx
index 87181ca06cf6..6a164a0c98e8 100644
--- a/sc/inc/cellform.hxx
+++ b/sc/inc/cellform.hxx
@@ -30,9 +30,9 @@ class ScAddress;
 struct ScRefCellValue;
 
 enum ScForceTextFmt {
-    ftDontForce,            // numbers as numbers
-    ftForce,                // numbers as text
-    ftCheck                 // is the numberformat a textformat?
+    ftDontForce,            ///< numbers as numbers
+    ftForce,                ///< numbers as text
+    ftCheck                 ///< is the numberformat a textformat?
 };
 
 //------------------------------------------------------------------------
diff --git a/sc/inc/patattr.hxx b/sc/inc/patattr.hxx
index d0e6741ce308..317f9aeef18e 100644
--- a/sc/inc/patattr.hxx
+++ b/sc/inc/patattr.hxx
@@ -35,17 +35,17 @@ class SvNumberFormatter;
 class ScDocument;
 
 
-//  how to treat COL_AUTO in GetFont:
+///  how to treat COL_AUTO in GetFont:
 
 enum ScAutoFontColorMode
 {
-    SC_AUTOCOL_RAW,         // COL_AUTO is returned
-    SC_AUTOCOL_BLACK,       // always use black
-    SC_AUTOCOL_PRINT,       // black or white, depending on background
-    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_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_RAW,         ///< COL_AUTO is returned
+    SC_AUTOCOL_BLACK,       ///< always use black
+    SC_AUTOCOL_PRINT,       ///< black or white, depending on background
+    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_IGNOREBACK,  ///< like DISPLAY, but ignore stored background color (use configured color)
+    SC_AUTOCOL_IGNOREALL    ///< like DISPLAY, but ignore stored font and background colors
 };
 
 
@@ -74,7 +74,7 @@ public:
     static const SfxPoolItem& GetItem( sal_uInt16 nWhich, const SfxItemSet& rItemSet, const SfxItemSet* pCondSet );
     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;
     void                    ClearItems( const sal_uInt16* pWhich );
 
@@ -145,7 +145,7 @@ class ScFontToSubsFontConverter_AutoPtr
                                             DestroyFontToSubsFontConverter( h );
                                     }
 
-                                // prevent usage
+                                /// prevent usage
                                 ScFontToSubsFontConverter_AutoPtr( const ScFontToSubsFontConverter_AutoPtr& );
     ScFontToSubsFontConverter_AutoPtr& operator=( const ScFontToSubsFontConverter_AutoPtr& );
 
diff --git a/sc/inc/pivot.hxx b/sc/inc/pivot.hxx
index 12ed6374a7ab..ae38c1022200 100644
--- a/sc/inc/pivot.hxx
+++ b/sc/inc/pivot.hxx
@@ -55,8 +55,8 @@
 
 struct ScDPName
 {
-    OUString     maName;         /// Original name of the dimension.
-    OUString     maLayoutName;   /// Layout name (display name)
+    OUString     maName;         ///< Original name of the dimension.
+    OUString     maLayoutName;   ///< Layout name (display name)
 
     explicit ScDPName(const OUString& rName, const OUString& rLayoutName);
 };
@@ -65,16 +65,16 @@ struct ScDPName
 
 struct ScDPLabelData
 {
-    OUString       maName;         /// Original name of the dimension.
-    OUString       maLayoutName;   /// Layout name (display name)
+    OUString       maName;              ///< Original name of the dimension.
+    OUString       maLayoutName;        ///< Layout name (display name)
     OUString       maSubtotalName;
-    SCCOL               mnCol;          /// 0-based field index (not the source column index)
-    long                mnOriginalDim;  /// original dimension index (>= 0 for duplicated dimension)
-    sal_uInt16          mnFuncMask;     /// Page/Column/Row subtotal function.
-    sal_Int32           mnUsedHier;     /// Used hierarchy.
-    sal_Int32           mnFlags;        /// Flags from the DataPilotSource dimension
-    bool                mbShowAll:1;    /// true = Show all (also empty) results.
-    bool                mbIsValue:1;    /// true = Sum or count in data field.
+    SCCOL               mnCol;          ///< 0-based field index (not the source column index)
+    long                mnOriginalDim;  ///< original dimension index (>= 0 for duplicated dimension)
+    sal_uInt16          mnFuncMask;     ///< Page/Column/Row subtotal function.
+    sal_Int32           mnUsedHier;     ///< Used hierarchy.
+    sal_Int32           mnFlags;        ///< Flags from the DataPilotSource dimension
+    bool                mbShowAll:1;    ///< true = Show all (also empty) results.
+    bool                mbIsValue:1;    ///< true = Sum or count in data field.
     bool                mbDataLayout:1;
 
     struct Member
@@ -87,22 +87,22 @@ struct ScDPLabelData
         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
          * name.
          */
         OUString SC_DLLPUBLIC getDisplayName() const;
     };
     ::std::vector<Member>                               maMembers;
-    ::com::sun::star::uno::Sequence< OUString >  maHiers;        /// Hierarchies.
-    ::com::sun::star::sheet::DataPilotFieldSortInfo     maSortInfo;     /// Sorting info.
-    ::com::sun::star::sheet::DataPilotFieldLayoutInfo   maLayoutInfo;   /// Layout info.
-    ::com::sun::star::sheet::DataPilotFieldAutoShowInfo maShowInfo;     /// AutoShow info.
+    ::com::sun::star::uno::Sequence< OUString >  maHiers;               ///< Hierarchies.
+    ::com::sun::star::sheet::DataPilotFieldSortInfo     maSortInfo;     ///< Sorting info.
+    ::com::sun::star::sheet::DataPilotFieldLayoutInfo   maLayoutInfo;   ///< Layout info.
+    ::com::sun::star::sheet::DataPilotFieldAutoShowInfo maShowInfo;     ///< AutoShow info.
 
     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.
      */
     OUString SC_DLLPUBLIC getDisplayName() const;
@@ -112,8 +112,8 @@ typedef boost::ptr_vector<ScDPLabelData> ScDPLabelDataVector;
 
 struct ScPivotField
 {
-    SCCOL               nCol; /// 0-based dimension index (not source column index)
-    long                mnOriginalDim; /// >= 0 for duplicated field.
+    SCCOL               nCol;          ///< 0-based dimension index (not source column index)
+    long                mnOriginalDim; ///< >= 0 for duplicated field.
     sal_uInt16          nFuncMask;
     sal_uInt8           mnDupCount;
     ::com::sun::star::sheet::DataPilotFieldReference maFieldRef;
@@ -129,8 +129,8 @@ typedef ::std::vector< ScPivotField > ScPivotFieldVector;
 
 struct ScPivotParam
 {
-    SCCOL           nCol;           // Cursor Position /
-    SCROW           nRow;           // or start of destination area
+    SCCOL           nCol;           ///< Cursor Position /
+    SCROW           nRow;           ///< or start of destination area
     SCTAB           nTab;
     ScDPLabelDataVector maLabelArray;
     ScPivotFieldVector maPageFields;
diff --git a/sc/inc/prnsave.hxx b/sc/inc/prnsave.hxx
index 08644a113302..7e2385a99808 100644
--- a/sc/inc/prnsave.hxx
+++ b/sc/inc/prnsave.hxx
@@ -31,9 +31,9 @@ class ScPrintSaverTab
 {
     typedef ::std::vector< ScRange > ScRangeVec;
 
-    ScRangeVec  maPrintRanges;      // Array
-    ScRange*    mpRepeatCol;        // single
-    ScRange*    mpRepeatRow;        // single
+    ScRangeVec  maPrintRanges;      ///< Array
+    ScRange*    mpRepeatCol;        ///< single
+    ScRange*    mpRepeatRow;        ///< single
     sal_Bool        mbEntireSheet;
 
 public:
@@ -54,7 +54,7 @@ public:
 class ScPrintRangeSaver
 {
     SCTAB               nTabCount;
-    ScPrintSaverTab*    pData;      // Array
+    ScPrintSaverTab*    pData;      ///< Array
 
 public:
             ScPrintRangeSaver( SCTAB nCount );
diff --git a/sc/inc/progress.hxx b/sc/inc/progress.hxx
index 52c1fe22ddf8..db7be4a5d450 100644
--- a/sc/inc/progress.hxx
+++ b/sc/inc/progress.hxx
@@ -52,7 +52,7 @@ private:
 
             SfxProgress*    pProgress;
 
-                            // not implemented
+                            /// not implemented
                             ScProgress( const ScProgress& );
             ScProgress&     operator=( const ScProgress& );
 
@@ -80,10 +80,10 @@ public:
                             ~ScProgress();
 
 #ifdef SC_PROGRESS_CXX
-                            // for DummyInterpret only, never use otherwise!!!
+                            /// for DummyInterpret only, never use otherwise!!!
                             ScProgress();
 #endif
-                            // might be NULL!
+                            /// might be NULL!
             SfxProgress*    GetSfxProgress() const { return pProgress; }
 
             sal_Bool            SetStateText( sal_uLong nVal, const String &rVal, sal_uLong nNewRange = 0 )
@@ -124,14 +124,14 @@ public:
                                     return sal_True;
                                 }
             sal_Bool            SetStateOnPercent( sal_uLong nVal )
-                                {   // only if percentage increased
+                                {   /// only if percentage increased
                                     if ( nGlobalRange && (nVal * 100 /
                                             nGlobalRange) > nGlobalPercent )
                                         return SetState( nVal );
                                     return sal_True;
                                 }
             sal_Bool            SetStateCountDownOnPercent( sal_uLong nVal )
-                                {   // only if percentage increased
+                                {   /// only if percentage increased
                                     if ( nGlobalRange &&
                                             ((nGlobalRange - nVal) * 100 /
                                             nGlobalRange) > nGlobalPercent )
diff --git a/sc/inc/queryentry.hxx b/sc/inc/queryentry.hxx
index 08a2f811fd77..a3baea6fd5c2 100644
--- a/sc/inc/queryentry.hxx
+++ b/sc/inc/queryentry.hxx
@@ -53,14 +53,14 @@ struct SC_DLLPUBLIC ScQueryEntry
     SCCOLROW        nField;
     ScQueryOp       eOp;
     ScQueryConnect  eConnect;
-    mutable utl::SearchParam* pSearchParam;       // if RegExp, not saved
-    mutable utl::TextSearch*  pSearchText;        // if RegExp, not saved
+    mutable utl::SearchParam* pSearchParam;       ///< if RegExp, not saved
+    mutable utl::TextSearch*  pSearchText;        ///< if RegExp, not saved
 
     ScQueryEntry();
     ScQueryEntry(const ScQueryEntry& r);
     ~ScQueryEntry();
 
-    // creates pSearchParam and pSearchText if necessary, always RegExp!
+    /// creates pSearchParam and pSearchText if necessary, always RegExp!
     utl::TextSearch* GetSearchTextPtr( bool bCaseSens ) const;
 
     QueryItemsType& GetQueryItems();