diff options
author | Faisal M. Al-Otaibi <fmalotaibi@kacst.edu.sa> | 2012-07-25 15:43:39 +0300 |
---|---|---|
committer | Eike Rathke <erack@redhat.com> | 2012-07-25 19:13:03 +0200 |
commit | 8a01af8c7c27e93154733fc7a0a318c0d22cfbcd (patch) | |
tree | 3231f48888e3425ed6cebab6a643eea9af007385 /cui/source/dialogs | |
parent | cef66a3eed301ab77e02be6d6ba148142051e13d (diff) |
Modifying comments to follow Doxygen standards
Change-Id: Ic87c9c4f51af4da963835ac7311d998e69f61156
Diffstat (limited to 'cui/source/dialogs')
-rw-r--r-- | cui/source/dialogs/SpellAttrib.hxx | 2 | ||||
-rw-r--r-- | cui/source/dialogs/commonlingui.hxx | 19 | ||||
-rw-r--r-- | cui/source/dialogs/thesdlg_impl.hxx | 6 |
3 files changed, 14 insertions, 13 deletions
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 & ); |