diff options
author | Tor Lillqvist <tml@collabora.com> | 2014-04-06 19:53:16 +0300 |
---|---|---|
committer | Tor Lillqvist <tml@collabora.com> | 2014-04-06 20:00:14 +0300 |
commit | 149e3d4212704b36c101c2cab11cb43ad633ddd5 (patch) | |
tree | e45809351fcbbf18790df399d115dae317c87f86 | |
parent | c81cb85d3db1a5b66027ce9f21f0dd5fa115a954 (diff) |
Bin empty @seealso, @param, @return etc metacomments
-rw-r--r-- | include/unotools/cmdoptions.hxx | 26 | ||||
-rw-r--r-- | include/unotools/compatibility.hxx | 30 | ||||
-rw-r--r-- | include/unotools/dynamicmenuoptions.hxx | 18 | ||||
-rw-r--r-- | include/unotools/extendedsecurityoptions.hxx | 16 | ||||
-rw-r--r-- | include/unotools/fontoptions.hxx | 22 | ||||
-rw-r--r-- | include/unotools/historyoptions.hxx | 35 | ||||
-rw-r--r-- | include/unotools/localisationoptions.hxx | 19 | ||||
-rw-r--r-- | include/unotools/moduleoptions.hxx | 4 | ||||
-rw-r--r-- | include/unotools/printwarningoptions.hxx | 16 | ||||
-rw-r--r-- | include/unotools/securityoptions.hxx | 20 | ||||
-rw-r--r-- | include/unotools/viewoptions.hxx | 36 |
11 files changed, 0 insertions, 242 deletions
diff --git a/include/unotools/cmdoptions.hxx b/include/unotools/cmdoptions.hxx index 53649ce90c70..eddc1490c1e1 100644 --- a/include/unotools/cmdoptions.hxx +++ b/include/unotools/cmdoptions.hxx @@ -44,10 +44,6 @@ class SvtCommandOptions_Impl; /*-************************************************************************************************************ @short collect information about dynamic menus @descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard". - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -72,11 +68,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtCommandOptions(); @@ -86,9 +77,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: @short return complete specified list @descr Call it to get all entries of an dynamic menu. We return a list of all nodes with his names and properties. - - @seealso - - @param "eOption" select the list to retrieve. @return A list of command strings is returned. @@ -100,14 +88,9 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: /*-**************************************************************************************************** @short Lookup if a command URL is inside a given list @descr Lookup if a command URL is inside a given lst - - @seealso - - @param "eOption" select right command list @param "aCommandURL" a command URL that is used for the look up @return "sal_True" if the command is inside the list otherwise "sal_False" - - @onerror - *//*-*****************************************************************************************************/ bool Lookup( CmdOption eOption, const OUString& aCommandURL ) const; @@ -122,9 +105,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: @param "xFrame" points to the frame, which wish to be notified, if configuration was changed. - @return - - - @onerror - *//*-*****************************************************************************************************/ void EstablisFrameCallback(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame); @@ -136,13 +116,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtCommandOptions : public utl::detail: @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); diff --git a/include/unotools/compatibility.hxx b/include/unotools/compatibility.hxx index 1d64559b51d5..89ca6dc192b3 100644 --- a/include/unotools/compatibility.hxx +++ b/include/unotools/compatibility.hxx @@ -77,10 +77,6 @@ class SvtCompatibilityOptions_Impl; /*-************************************************************************************************************ @short collect information about dynamic menus @descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard". - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -102,11 +98,6 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtCompatibilityOptions(); @@ -117,13 +108,6 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options /*-**************************************************************************************************** @short clear complete specified list @descr Call this methods to clear the whole list. - - @seealso - - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ void Clear(); @@ -134,10 +118,6 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options @short return complete specified list @descr Call it to get all entries of compatibility options. We return a list of all nodes with its names and properties. - - @seealso - - - @param - @return A list of compatibility options is returned. @onerror We return an empty list. @@ -153,10 +133,6 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options @param "sName" Name @param "sModule" Module - - @return - - - @onerror - *//*-*****************************************************************************************************/ void AppendItem( const OUString& sName, @@ -194,13 +170,7 @@ class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions: public utl::detail::Options @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); diff --git a/include/unotools/dynamicmenuoptions.hxx b/include/unotools/dynamicmenuoptions.hxx index efc873dd72b8..24e358b771bf 100644 --- a/include/unotools/dynamicmenuoptions.hxx +++ b/include/unotools/dynamicmenuoptions.hxx @@ -57,10 +57,6 @@ class SvtDynamicMenuOptions_Impl; /*-************************************************************************************************************ @short collect information about dynamic menus @descr Make it possible to configure dynamic menu structures of menus like "new" or "wizard". - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -76,11 +72,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtDynamicMenuOptions : public utl::det @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtDynamicMenuOptions(); @@ -90,9 +81,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtDynamicMenuOptions : public utl::det @short return complete specified list @descr Call it to get all entries of an dynamic menu. We return a list of all nodes with his names and properties. - - @seealso - - @param "eMenu" select right menu. @return A list of menu items is returned. @@ -107,13 +95,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtDynamicMenuOptions : public utl::det @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); diff --git a/include/unotools/extendedsecurityoptions.hxx b/include/unotools/extendedsecurityoptions.hxx index 889b0e344d48..8c9840c21b11 100644 --- a/include/unotools/extendedsecurityoptions.hxx +++ b/include/unotools/extendedsecurityoptions.hxx @@ -37,11 +37,6 @@ class SvtExtendedSecurityOptions_Impl; /*-************************************************************************************************************ @short collect information about security features - @descr - - - @implements - - @base - - @ATTENTION This class is partially threadsafe. @devstatus ready to use @@ -67,11 +62,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtExtendedSecurityOptions : public utl @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtExtendedSecurityOptions(); @@ -86,13 +76,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtExtendedSecurityOptions : public utl @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetInitMutex(); diff --git a/include/unotools/fontoptions.hxx b/include/unotools/fontoptions.hxx index 688c78779bd9..6cb4b0ce0554 100644 --- a/include/unotools/fontoptions.hxx +++ b/include/unotools/fontoptions.hxx @@ -36,11 +36,6 @@ class SvtFontOptions_Impl; /*-************************************************************************************************************ @short collect information about font features - @descr - - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -56,11 +51,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtFontOptions : public utl::detail::Op @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtFontOptions(); @@ -79,12 +69,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtFontOptions : public utl::detail::Op ..FontWYSIWYG..() => With this option the names of the selectable fonts (for example, the fonts in the Font field in the object bar) will be formatted as the current font. - - @seealso - - - @param - - @return - - @onerror No error should occur! *//*-*****************************************************************************************************/ @@ -99,13 +83,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtFontOptions : public utl::detail::Op @short return a reference to a static mutex @descr These class use his own static mutex to be threadsafe. We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& impl_GetOwnStaticMutex(); diff --git a/include/unotools/historyoptions.hxx b/include/unotools/historyoptions.hxx index 2bcb240f1dc9..7a41bf59c29e 100644 --- a/include/unotools/historyoptions.hxx +++ b/include/unotools/historyoptions.hxx @@ -60,11 +60,6 @@ class SvtHistoryOptions_Impl; /*-************************************************************************************************************ @short collect information about history features - @descr - - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -80,11 +75,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtHistoryOptions(); @@ -101,15 +91,10 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: @descr Call this methods to get information about max. size of specified list. These value lay down the max count of items in these history. If a new one is add to it the oldest one is deleted automaticly! - - @seealso - - @param "eHistory" select right history. @param "nSize" is the new max size of specified list. If new size smaller then the old one some oldest entries will be destroyed automaticly! @return Current max size of specified list. - - @onerror - *//*-*****************************************************************************************************/ sal_uInt32 GetSize( EHistoryType eHistory ) const; @@ -118,13 +103,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: @short clear complete sepcified list @descr Call this methods to clear the whole list. After that GetItemCount() will return 0 ... but GetSize() will return the old value! - - @seealso - - @param "eHistory" select right history. - @return - - - @onerror - *//*-*****************************************************************************************************/ void Clear( EHistoryType eHistory ); @@ -132,13 +111,8 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: /*-**************************************************************************************************** @short return complete sepcified list @descr If you will show the whole list call this method to get it completely. - - @seealso - - @param "eHistory" select right history. @return A list of history items is returned. - - @onerror - *//*-*****************************************************************************************************/ ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > > GetList( EHistoryType eHistory ) const; @@ -158,9 +132,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: @param "sFilter" filter name to save in history @param "sTitle" document title to save in history @param "sPassword" password to save in history - @return - - - @onerror - *//*-*****************************************************************************************************/ void AppendItem(EHistoryType eHistory, @@ -172,13 +143,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtHistoryOptions : public utl::detail: /*-**************************************************************************************************** @short return a reference to a static mutex @descr Make these class threadsafe. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); diff --git a/include/unotools/localisationoptions.hxx b/include/unotools/localisationoptions.hxx index c84a3e40b14a..66ee0320c8e3 100644 --- a/include/unotools/localisationoptions.hxx +++ b/include/unotools/localisationoptions.hxx @@ -35,11 +35,6 @@ class SvtLocalisationOptions_Impl; /*-************************************************************************************************************ @short collect information about localisation features - @descr - - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -55,11 +50,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::de @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtLocalisationOptions(); @@ -68,9 +58,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::de /*-**************************************************************************************************** @short interface methods to get and set value of config key "org.openoffice.Office.Common/View/Localisation/AutoMnemonic" @descr These value specifies if shortcuts should be assigned automatically. - - @seealso - - @param "bState", new value to set it in configuration. @return The value which represent current state of internal variable. @@ -105,13 +92,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtLocalisationOptions : public utl::de @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); diff --git a/include/unotools/moduleoptions.hxx b/include/unotools/moduleoptions.hxx index 19242c442180..a6cc8f6987b3 100644 --- a/include/unotools/moduleoptions.hxx +++ b/include/unotools/moduleoptions.hxx @@ -51,10 +51,6 @@ class SvtModuleOptions_Impl; @descr Use these class to get installation state of different office modules like writer, calc etc Further you can ask for additional information; e.g. name of standard template file, which should be used by corresponding module; or short/long name of these module factory. - - @implements - - @base - - @devstatus ready to use @threadsafe yes *//*-*************************************************************************************************************/ diff --git a/include/unotools/printwarningoptions.hxx b/include/unotools/printwarningoptions.hxx index 90a5bd980d1b..92a8d7b0c81c 100644 --- a/include/unotools/printwarningoptions.hxx +++ b/include/unotools/printwarningoptions.hxx @@ -37,11 +37,6 @@ class SvtPrintWarningOptions_Impl; /*-************************************************************************************************************ @short collect information about startup features - @descr - - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -57,11 +52,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtPrintWarningOptions : public utl::de @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtPrintWarningOptions(); @@ -90,13 +80,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtPrintWarningOptions : public utl::de @short return a reference to a static mutex @descr These class use his own static mutex to be threadsafe. We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); diff --git a/include/unotools/securityoptions.hxx b/include/unotools/securityoptions.hxx index b74a41fd09a3..9dad487c232b 100644 --- a/include/unotools/securityoptions.hxx +++ b/include/unotools/securityoptions.hxx @@ -49,11 +49,6 @@ enum EBasicSecurityMode /*-************************************************************************************************************ @short collect information about security features - @descr - - - @implements - - @base - - @ATTENTION This class is partially threadsafe. @devstatus ready to use @@ -112,11 +107,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail @seealso member m_nRefCount @seealso member m_pDataContainer - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ SvtSecurityOptions(); @@ -125,8 +115,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail /*-**************************************************************************************************** @short returns readonly state @descr It can be called to get information about the readonly state of a provided item. - @seealso - - @param "eOption", specify, which item is queried @return <TRUE/> if item is readonly; <FALSE/> otherwise @@ -145,8 +133,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail private:schedule => Scripts of the scheduler; private:searchfolder => Scripts of the searchfolder; private:user => Scripts that are entered in the URL field. - @seealso - - @param "seqURLList", new values to set it in configuration. @return The values which represent current state of internal variable. @@ -227,13 +213,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtSecurityOptions : public utl::detail @descr These class is partially threadsafe (for de-/initialization only). All access methods are'nt safe! We create a static mutex only for one ime and use at different times. - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetInitMutex(); diff --git a/include/unotools/viewoptions.hxx b/include/unotools/viewoptions.hxx index ad6de9affef4..4735473ef6fc 100644 --- a/include/unotools/viewoptions.hxx +++ b/include/unotools/viewoptions.hxx @@ -94,10 +94,6 @@ enum EViewType /Window_Options [WindowType] ... /Window_<YourName> [WindowType] - - @implements - - @base - - @devstatus ready to use *//*-*************************************************************************************************************/ @@ -120,8 +116,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op @param "eType" specify type of your view and is used to use right data container! @param "sViewName" specify the name of your view and is the key name in data list too. - @return - - @onerror An assertion is thrown in debug version. Otherwise we do nothing! *//*-*****************************************************************************************************/ @@ -132,13 +126,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op /*-**************************************************************************************************** @short support preload of these config item @descr Sometimes we need preloading of these configuration data without real using of it. - - @seealso - - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ static void AcquireOptions(); @@ -152,9 +139,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op it not already exist and work with default values! If this a problem for you - you MUST call these method before and you must make up your own mind about that. - - @seealso - - @onerror No error should occur. *//*-*****************************************************************************************************/ @@ -183,8 +167,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op parse given string! @seealso vcl methods - - @onerror - *//*-*****************************************************************************************************/ OUString GetWindowState( ) const; @@ -195,9 +177,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op @descr It's only supported for: - tab-dialogs If you call it for other ones you will get an assertion in debug version. In a product version we do nothing! - - @seealso - - @onerror An assertion is thrown in debug version. Otherwise we do nothing! *//*-*****************************************************************************************************/ @@ -209,9 +188,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op @descr It's only supported for: - windows If you call it for other ones you will get an assertion in debug version. In a product version we do nothing! - - @seealso - - @onerror An assertion is thrown in debug version. Otherwise we do nothing! *//*-*****************************************************************************************************/ @@ -229,9 +205,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op @short use it to set/get the extended user data (consisting of a set of named scalar values) @descr It's supported for ALL types! Every view can handle its own user defined data set. - - @seealso - - @onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored. *//*-*****************************************************************************************************/ ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > GetUserData( ) const; @@ -241,9 +214,6 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op @short use it to set/get ONE special user data item directly @descr Normaly you can work on full user data list by using "Set/GetUserData()". With this function you have an access on special list entries directly without any - - @seealso - - @onerror In the non-product version, an assertion is made. In a product version, errors are silently ignored. *//*-*****************************************************************************************************/ @@ -260,13 +230,7 @@ class UNOTOOLS_DLLPUBLIC SAL_WARN_UNUSED SvtViewOptions : public utl::detail::Op @descr These class is threadsafe. We create a static mutex only for one time and use it to protect our refcount and container member! - - @seealso - - - @param - @return A reference to a static mutex member. - - @onerror - *//*-*****************************************************************************************************/ UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetOwnStaticMutex(); |