Modifying comments to follow Doxygen standards

Change-Id: Ic87c9c4f51af4da963835ac7311d998e69f61156

12 files changed, 71 insertions, 74 deletions

diff --git a/cui/source/customize/eventdlg.hxx b/cui/source/customize/eventdlg.hxx
index c68bcf634226..6c8d9f2bbd6d 100644
--- a/cui/source/customize/eventdlg.hxx
+++ b/cui/source/customize/eventdlg.hxx
@@ -45,8 +45,8 @@ class SvxEventConfigPage : public _SvxMacroTabPage
     SvxEventConfigPage & operator= (const SvxEventConfigPage &);
 
 public:
-                    /// this is only to let callers know that there is a LateInit which *must* be called
-                    struct EarlyInit { };
+
+                    struct EarlyInit { }; ///< this is only to let callers know that there is a LateInit which *must* be called
                     SvxEventConfigPage( Window *pParent, const SfxItemSet& rSet, EarlyInit );
                     ~SvxEventConfigPage();
 
diff --git a/cui/source/dialogs/SpellAttrib.hxx b/cui/source/dialogs/SpellAttrib.hxx
index 731c6942a082..4a260f5b2d54 100644
--- a/cui/source/dialogs/SpellAttrib.hxx
+++ b/cui/source/dialogs/SpellAttrib.hxx
@@ -50,7 +50,7 @@ struct SpellErrorDescription
     ::rtl::OUString                                     sExplanationURL;
     ::com::sun::star::lang::Locale                      aLocale;
     ::com::sun::star::uno::Reference< ::com::sun::star::linguistic2::XProofreader > xGrammarChecker;
-    ::rtl::OUString                                     sServiceName; //service name of GrammarChecker/SpellChecker
+    ::rtl::OUString                                     sServiceName; ///< service name of GrammarChecker/SpellChecker
     ::com::sun::star::uno::Sequence< ::rtl::OUString >  aSuggestions;
     ::rtl::OUString                                     sRuleId;
 
diff --git a/cui/source/dialogs/commonlingui.hxx b/cui/source/dialogs/commonlingui.hxx
index 1c32dcd5b718..81931a9bf5f8 100644
--- a/cui/source/dialogs/commonlingui.hxx
+++ b/cui/source/dialogs/commonlingui.hxx
@@ -110,15 +110,16 @@ public:
     inline  PushButton*         GetButton( ButtonType _eType )          { return implGetButton( _eType  ); }
     inline  const PushButton*   GetButton( ButtonType _eType ) const    { return implGetButton( _eType  ); }
 
-    // users of this class may want to insert own controls in some places, where the ordinary
-    // Z-Order determined by construction time is not sufficient
-    // Use the following methods for this
-    enum ControlGroup // control groups in this window which cannot be devided (e.g. are adjacent in the Z order)
+    /** users of this class may want to insert own controls in some places, where the ordinary
+        Z-Order determined by construction time is not sufficient
+        Use the following methods for this
+        control groups in this window which cannot be devided (e.g. are adjacent in the Z order)*/
+    enum ControlGroup
     {
-        eLeftRightWords,    // the controls for the two words (original and suggestion), including the labels
-        eSuggestionLabel,   // the label for the suggestion
-        eActionButtons,     // the group of "ignore(all)" / "change(all)" buttons
-        eDialogButtons      // the group of dialog control buttons (help and close)
+        eLeftRightWords,    ///< the controls for the two words (original and suggestion), including the labels
+        eSuggestionLabel,   ///< the label for the suggestion
+        eActionButtons,     ///< the group of "ignore(all)" / "change(all)" buttons
+        eDialogButtons      ///< the group of dialog control buttons (help and close)
     };
     void    InsertControlGroup( Window& _rFirstGroupWindow, Window& _rLastGroupWindow, ControlGroup _eInsertAfter );
 
@@ -140,7 +141,7 @@ public:
     inline Edit&        GetWordInputControl()           { return aNewWordED; }
     inline const Edit&  GetWordInputControl() const { return aNewWordED; }
 
-    // returns the location (upper-left corner) of the group of action buttons
+    /// @return the location (upper-left corner) of the group of action buttons
     inline Point    GetActionButtonsLocation( ) const { return aIgnoreBtn.GetPosPixel(); }
 };
 
diff --git a/cui/source/dialogs/thesdlg_impl.hxx b/cui/source/dialogs/thesdlg_impl.hxx
index 678b1257bf5f..0c4af351e1dc 100644
--- a/cui/source/dialogs/thesdlg_impl.hxx
+++ b/cui/source/dialogs/thesdlg_impl.hxx
@@ -68,7 +68,7 @@ class LookUpComboBox_Impl : public ComboBox
     Button *                    m_pBtn;
     SvxThesaurusDialog_Impl &   m_rDialogImpl;
 
-    // disable copy c-tor and assignment operator
+    /// disable copy c-factor and assignment operator
     LookUpComboBox_Impl( const LookUpComboBox_Impl & );
     LookUpComboBox_Impl & operator = ( const LookUpComboBox_Impl & );
 
@@ -90,7 +90,7 @@ class ReplaceEdit_Impl : public Edit
 {
     Button *                    m_pBtn;
 
-    // disable copy c-tor and assignment operator
+    /// disable copy c-factor and assignment operator
     ReplaceEdit_Impl( const ReplaceEdit_Impl & );
     ReplaceEdit_Impl & operator = ( const ReplaceEdit_Impl & );
 
@@ -146,7 +146,7 @@ class ThesaurusAlternativesCtrl_Impl :
     typedef std::map< const SvLBoxEntry *, AlternativesExtraData >  UserDataMap_t;
     UserDataMap_t           m_aUserData;
 
-    // disable copy c-tor and assignment operator
+    /// disable copy c-factor and assignment operator
     ThesaurusAlternativesCtrl_Impl( const ThesaurusAlternativesCtrl_Impl & );
     ThesaurusAlternativesCtrl_Impl & operator = ( const ThesaurusAlternativesCtrl_Impl & );
 
diff --git a/cui/source/inc/about.hxx b/cui/source/inc/about.hxx
index 783a261673b2..51040753a8a9 100644
--- a/cui/source/inc/about.hxx
+++ b/cui/source/inc/about.hxx
@@ -35,7 +35,7 @@
 #include <svtools/svmedit.hxx>
 #include <svtools/stdctrl.hxx>
 #include "svtools/fixedhyper.hxx"
-#include <sfx2/basedlgs.hxx>        // SfxModalDialog
+#include <sfx2/basedlgs.hxx>        ///< for SfxModalDialog
 #include <vector>
 
 // class AboutDialog -----------------------------------------------------
diff --git a/cui/source/inc/acccfg.hxx b/cui/source/inc/acccfg.hxx
index ccb06d7ddf97..3ee71f27ee7c 100644
--- a/cui/source/inc/acccfg.hxx
+++ b/cui/source/inc/acccfg.hxx
@@ -89,7 +89,8 @@ public:
 struct TAccInfo
 {
     public:
-
+        /** its important to set sal_True as default -
+        because only fix entries will be disabled later ...*/
         TAccInfo(      sal_Int32 nKeyPos ,
                        sal_Int32 nListPos,
                  const KeyCode&  aKey    )
@@ -98,8 +99,6 @@ struct TAccInfo
             , m_bIsConfigurable(sal_True )
             , m_sCommand       (         )
             , m_aKey           (aKey     )
-            // its important to set sal_True as default -
-            // because only fix entries will be disabled later ...
         {}
 
         sal_Bool isConfigured() const
diff --git a/cui/source/inc/autocdlg.hxx b/cui/source/inc/autocdlg.hxx
index 90395416cd1d..98c8ccea054e 100644
--- a/cui/source/inc/autocdlg.hxx
+++ b/cui/source/inc/autocdlg.hxx
@@ -221,7 +221,7 @@ struct DoubleString
 {
     String  sShort;
     String  sLong;
-    void*   pUserData; // CheckBox -> form. Text Bool -> selection text
+    void*   pUserData; ///< CheckBox -> form. Text Bool -> selection text
 };
 typedef std::vector<DoubleString> DoubleStringArray;
 typedef std::map<LanguageType, DoubleStringArray> DoubleStringTable;
@@ -318,8 +318,8 @@ private:
     DECL_LINK(NewDelHdl, PushButton*);
     DECL_LINK(SelectHdl, ListBox*);
     DECL_LINK(ModifyHdl, Edit*);
-
-    void            RefillReplaceBoxes(sal_Bool bFromReset, //Box filled with new language
+                    /// Box filled with new language
+    void            RefillReplaceBoxes(sal_Bool bFromReset,
                                         LanguageType eOldLanguage,
                                         LanguageType eNewLanguage);
 public:
@@ -344,10 +344,10 @@ class OfaQuoteTabPage : public SfxTabPage
     using TabPage::ActivatePage;
 
 private:
-    // For anything but writer
+    /// For anything but writer
     SvxCheckListBox aCheckLB;
 
-    // Just for writer
+    /// Just for writer
     SvxSimpleTableContainer m_aSwCheckLBContainer;
     OfaACorrCheckListBox    aSwCheckLB;
     String          sHeader1;
@@ -426,12 +426,12 @@ class OfaAutoCompleteTabPage : public SfxTabPage
         virtual long PreNotify( NotifyEvent& rNEvt );
     };
 
-    CheckBox        aCBActiv; //Enable word completion
-    CheckBox        aCBAppendSpace;//Append space
-    CheckBox        aCBAsTip; //Show as tip
+    CheckBox        aCBActiv; ///<Enable word completion
+    CheckBox        aCBAppendSpace;///<Append space
+    CheckBox        aCBAsTip; ///<Show as tip
 
-    CheckBox        aCBCollect;//Collect words
-    CheckBox        aCBRemoveList;//...save the list for later use...
+    CheckBox        aCBCollect;///<Collect words
+    CheckBox        aCBRemoveList;///<...save the list for later use...
 
     FixedText       aFTExpandKey;
     ListBox         aDCBExpandKey;
@@ -480,7 +480,7 @@ private:
     PushButton              m_aPropertiesPB;
     FixedText               m_aTitleFT;
 
-    // construction via Create()
+    /// construction via Create()
     OfaSmartTagOptionsTabPage( Window* pParent, const SfxItemSet& rSet );
 
     /** Inserts items into m_aSmartTagTypesLB
diff --git a/cui/source/inc/backgrnd.hxx b/cui/source/inc/backgrnd.hxx
index ce3b0cb41ef9..e20726f5acaf 100644
--- a/cui/source/inc/backgrnd.hxx
+++ b/cui/source/inc/backgrnd.hxx
@@ -36,16 +36,6 @@
 #include <svtools/valueset.hxx>
 #include <svx/dlgctrl.hxx>
 
-// class SvxBackgroundTabPage --------------------------------------------
-/*
-{k:\svx\prototyp\dialog\backgrnd.bmp}
-    [Description]
-    With this TabPage a Brush (e. g. for a frame's background color)
-    can be set.
-    [Items]
-    <SvxBrushItem>:     <SID_ATTR_BRUSH>;
-*/
-
 //------------------------------------------------------------------------
 // forwards:
 
@@ -55,7 +45,14 @@ struct SvxBackgroundTable_Impl;
 struct SvxBackgroundPara_Impl;
 struct SvxBackgroundPage_Impl;
 class SvxBrushItem;
-//------------------------------------------------------------------------
+/** class SvxBackgroundTabPage --------------------------------------------
+{k:\svx\prototyp\dialog\backgrnd.bmp}
+    [Description]
+    With this TabPage a Brush (e. g. for a frame's background color)
+    can be set.
+    [Items]
+    <SvxBrushItem>:     <SID_ATTR_BRUSH>;
+*/
 
 class SvxBackgroundTabPage : public SvxTabPage
 {
@@ -68,10 +65,12 @@ public:
     virtual void        Reset( const SfxItemSet& rSet );
     virtual void        FillUserData();
     virtual void        PointChanged( Window* pWindow, RECT_POINT eRP );
-
-    void                ShowSelector(); // Shift-ListBox activation
-    void                ShowTblControl(); // for the Writer (cells/rows/tables)
-    void                ShowParaControl(sal_Bool bCharOnly = sal_False); // for the Writer (paragraph/characters)
+    /// Shift-ListBox activation
+    void                ShowSelector();
+    /// for the Writer (cells/rows/tables)
+    void                ShowTblControl();
+    /// for the Writer (paragraph/characters)
+    void                ShowParaControl(sal_Bool bCharOnly = sal_False);
     void                EnableTransparency(sal_Bool bColor, sal_Bool bGraphic);
     virtual void        PageCreated (SfxAllItemSet aSet);
 protected:
@@ -92,8 +91,8 @@ private:
     ValueSet                aBackgroundColorSet;
     FixedLine               aBackgroundColorBox;
     BackgroundPreviewImpl*  pPreviewWin1;
-    //color transparency
-    FixedText               aColTransFT;
+
+    FixedText               aColTransFT;///<color transparency
     MetricField             aColTransMF;
     CheckBox                aBtnPreview;
     // Background Bitmap ----------------------------------
@@ -106,8 +105,8 @@ private:
     RadioButton             aBtnTile;
     SvxRectCtl              aWndPosition;
     FixedInfo               aFtFile;
-    //transparency of graphics
-    FixedLine               aGraphTransFL;
+
+    FixedLine               aGraphTransFL;///<transparency of graphics
     MetricField             aGraphTransMF;
 
     BackgroundPreviewImpl*  pPreviewWin2;
@@ -129,10 +128,8 @@ private:
     SvxBackgroundPage_Impl* pPageImpl;
     SvxOpenGraphicDialog* pImportDlg;
 
-    // Items for Sw-Table must be corrected
-    SvxBackgroundTable_Impl*    pTableBck_Impl;
-    // also for the paragraph style
-    SvxBackgroundPara_Impl* pParaBck_Impl;
+    SvxBackgroundTable_Impl*    pTableBck_Impl;///< Items for Sw-Table must be corrected
+    SvxBackgroundPara_Impl* pParaBck_Impl;///< also for the paragraph style
 
 #ifdef _SVX_BACKGRND_CXX
     void                FillColorValueSets_Impl();
diff --git a/cui/source/inc/bbdlg.hxx b/cui/source/inc/bbdlg.hxx
index 7497855c9858..ded144041030 100644
--- a/cui/source/inc/bbdlg.hxx
+++ b/cui/source/inc/bbdlg.hxx
@@ -49,7 +49,7 @@ protected:
     virtual void    PageCreated( sal_uInt16 nPageId, SfxTabPage& rTabPage );
 
 private:
-    sal_Bool    bEnableBackgroundSelector; // for Border/Background
+    sal_Bool    bEnableBackgroundSelector; ///< for Border/Background
 };
 
 
diff --git a/cui/source/inc/border.hxx b/cui/source/inc/border.hxx
index ecb6c9ea46f0..e3a9d0847f82 100644
--- a/cui/source/inc/border.hxx
+++ b/cui/source/inc/border.hxx
@@ -106,8 +106,8 @@ private:
     FixedText           aFtShadowColor;
     ColorListBox        aLbShadowColor;
 
-    //properties - "Merge with next paragraph" in Writer
-    FixedLine           aPropertiesFL;
+
+    FixedLine           aPropertiesFL;///< properties - "Merge with next paragraph" in Writer
     CheckBox            aMergeWithNextCB;
     // #i29550#
     CheckBox            aMergeAdjacentBordersCB;
@@ -117,13 +117,13 @@ private:
     ImageList           aBorderImgLstH;
     ImageList           aBorderImgLst;
 
-    long                nMinValue;  // minimum distance
-    int                 nSWMode;    // table, textframe, paragraph
+    long                nMinValue;  ///< minimum distance
+    int                 nSWMode;    ///< table, textframe, paragraph
 
-    bool                mbHorEnabled;       /// true = Inner horizontal border enabled.
-    bool                mbVerEnabled;       /// true = Inner vertical border enabled.
-    bool                mbTLBREnabled;      /// true = Top-left to bottom-right border enabled.
-    bool                mbBLTREnabled;      /// true = Bottom-left to top-right border enabled.
+    bool                mbHorEnabled;       ///< true = Inner horizontal border enabled.
+    bool                mbVerEnabled;       ///< true = Inner vertical border enabled.
+    bool                mbTLBREnabled;      ///< true = Top-left to bottom-right border enabled.
+    bool                mbBLTREnabled;      ///< true = Bottom-left to top-right border enabled.
     bool                mbUseMarginItem;
     bool                mbSync;
 
@@ -148,7 +148,7 @@ private:
     // Filler
     void                FillLineListBox_Impl();
 
-    // share for individual Frame-/Core-Line
+    /// share for individual Frame-/Core-Line
     void                ResetFrameLine_Impl( svx::FrameBorderType eBorder,
                                              const editeng::SvxBorderLine* pCurLine,
                                              bool bValid );
diff --git a/cui/source/inc/cfg.hxx b/cui/source/inc/cfg.hxx
index 037a68c8ca7f..1a4ba4812e83 100644
--- a/cui/source/inc/cfg.hxx
+++ b/cui/source/inc/cfg.hxx
@@ -174,8 +174,8 @@ private:
 
     SvxConfigEntry* pRootEntry;
 
-    // static holder of the default menu data
-    static MenuSaveInData* pDefaultData;
+
+    static MenuSaveInData* pDefaultData;    ///< static holder of the default menu data
 
     static void SetDefaultData( MenuSaveInData* pData ) {pDefaultData = pData;}
     static MenuSaveInData* GetDefaultData() { return pDefaultData; }
@@ -214,7 +214,7 @@ public:
 
     ~MenuSaveInData();
 
-    // methods inherited from SaveInData
+    /// methods inherited from SaveInData
     SvxEntries*         GetEntries();
     void                SetEntries( SvxEntries* );
     bool                HasURL( const rtl::OUString& URL ) { (void)URL; return sal_False; }
@@ -242,8 +242,8 @@ private:
     bool                        bIsMovable;
     bool                        bIsParentData;
 
-    // toolbar specific properties
-    bool                        bIsVisible;
+
+    bool                        bIsVisible;    ///< toolbar specific properties
     sal_Int32                   nStyle;
 
     ::com::sun::star::uno::Reference<
@@ -414,8 +414,8 @@ protected:
 
     SvxScriptSelectorDialog*            pSelectorDlg;
 
-    // the ResourceURL to select when opening the dialog
-    rtl::OUString                       m_aURLToSelect;
+
+    rtl::OUString                       m_aURLToSelect;  ///< the ResourceURL to select when opening the dialog
 
     ::com::sun::star::uno::Reference
         < ::com::sun::star::frame::XFrame > m_xFrame;
diff --git a/cui/source/inc/chardlg.hxx b/cui/source/inc/chardlg.hxx
index 99274bdb4921..6afa2428f646 100644
--- a/cui/source/inc/chardlg.hxx
+++ b/cui/source/inc/chardlg.hxx
@@ -175,7 +175,7 @@ public:
     void                SetFontList( const SvxFontListItem& rItem );
     void                EnableRelativeMode();
     void                EnableSearchMode();
-    //                  the writer uses SID_ATTR_BRUSH as font background
+    ///                  the writer uses SID_ATTR_BRUSH as font background
     void                SetPreviewBackgroundToCharacter();
 
     void                DisableControls( sal_uInt16 nDisable );
@@ -261,7 +261,7 @@ public:
 
     void                DisableControls( sal_uInt16 nDisable );
     void                EnableFlash();
-    //                  the writer uses SID_ATTR_BRUSH as font background
+    ///                  the writer uses SID_ATTR_BRUSH as font background
     void                SetPreviewBackgroundToCharacter();
     virtual void        PageCreated (SfxAllItemSet aSet);
 };
@@ -336,7 +336,7 @@ public:
     virtual void        Reset( const SfxItemSet& rSet );
     virtual sal_Bool        FillItemSet( SfxItemSet& rSet );
     virtual void        FillUserData();
-    //                  the writer uses SID_ATTR_BRUSH as font background
+    ///                  the writer uses SID_ATTR_BRUSH as font background
     void                SetPreviewBackgroundToCharacter();
     virtual void        PageCreated (SfxAllItemSet aSet);
 };
@@ -381,7 +381,7 @@ public:
 
     virtual void        Reset( const SfxItemSet& rSet );
     virtual sal_Bool        FillItemSet( SfxItemSet& rSet );
-    //                  the writer uses SID_ATTR_BRUSH as font background
+    ///                  the writer uses SID_ATTR_BRUSH as font background
     void                SetPreviewBackgroundToCharacter();
     virtual void        PageCreated (SfxAllItemSet aSet);
 };