mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bin empty @seealso, @param, @return and @onerror metacomments

Browse Source 
Change-Id: I9a590b9e65960bf7360b37567aa5bfa7588c69f7
This commit is contained in:
Tor Lillqvist 2014-04-06 19:00:46 +03:00
parent 79247e9fa7
commit be616c26f9
9 changed files with 0 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
unotools/source/config/cmdoptions.cxx
View File

@ -129,9 +129,6 @@ class SvtCommandOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "lPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& lPropertyNames ) SAL_OVERRIDE;
@ -142,11 +139,6 @@ class SvtCommandOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -155,13 +147,6 @@ class SvtCommandOptions_Impl : public ConfigItem
@short base implementation of public interface for "SvtDynamicMenuOptions"!
@descr These class is used as static member of "SvtDynamicMenuOptions" ...
=> The code exist only for one time and isn't duplicated for every instance!
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
bool HasEntries ( SvtCommandOptions::CmdOption eOption ) const;
@ -174,13 +159,8 @@ class SvtCommandOptions_Impl : public ConfigItem
@short return list of key names of our configuration management which represent oue module tree
@descr These methods return the current list of key names! We need it to get needed values from our
configuration management and support dynamical menu item lists!
@seealso -
@param "nDisabledCount" , returns count of menu entries for "new"
@return A list of configuration key names is returned.
@onerror -
*//*-*****************************************************************************************************/
Sequence< OUString > impl_GetPropertyNames();

26
unotools/source/config/compatibility.cxx
View File

@ -231,9 +231,6 @@ class SvtCompatibilityOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "lPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& lPropertyNames ) SAL_OVERRIDE;
@ -244,11 +241,6 @@ class SvtCompatibilityOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -259,13 +251,6 @@ class SvtCompatibilityOptions_Impl : public ConfigItem
@short base implementation of public interface for "SvtCompatibilityOptions"!
@descr These class is used as static member of "SvtCompatibilityOptions" ...
=> The code exist only for one time and isn't duplicated for every instance!
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
void Clear();
@ -304,29 +289,18 @@ class SvtCompatibilityOptions_Impl : public ConfigItem
@short return list of key names of our configuration management which represent one module tree
@descr These methods return the current list of key names! We need it to get needed values from our
configuration management and support dynamical menu item lists!
@seealso -
@param -
@return A list of configuration key names is returned.
@onerror -
*//*-*****************************************************************************************************/
Sequence< OUString > impl_GetPropertyNames( Sequence< OUString >& rItems );
/*-****************************************************************************************************
@short expand the list for all well known properties to destination
@descr -
@attention -
@seealso method impl_GetPropertyNames()
@param "lSource" , original list
@param "lDestination" , destination of operation
@return A list of configuration key names is returned.
@onerror -
*//*-*****************************************************************************************************/
void impl_ExpandPropertyNames( const Sequence< OUString >& lSource,

22
unotools/source/config/dynamicmenuoptions.cxx
View File

@ -232,9 +232,6 @@ class SvtDynamicMenuOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "lPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& lPropertyNames ) SAL_OVERRIDE;
@ -245,11 +242,6 @@ class SvtDynamicMenuOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -258,13 +250,6 @@ class SvtDynamicMenuOptions_Impl : public ConfigItem
@short base implementation of public interface for "SvtDynamicMenuOptions"!
@descr These class is used as static member of "SvtDynamicMenuOptions" ...
=> The code exist only for one time and isn't duplicated for every instance!
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
Sequence< Sequence< PropertyValue > > GetMenu ( EDynamicMenuType eMenu ) const;
@ -275,14 +260,9 @@ class SvtDynamicMenuOptions_Impl : public ConfigItem
@short return list of key names of our configuration management which represent oue module tree
@descr These methods return the current list of key names! We need it to get needed values from our
configuration management and support dynamical menu item lists!
@seealso -
@param "nNewCount" , returns count of menu entries for "new"
@param "nWizardCount" , returns count of menu entries for "wizard"
@return A list of configuration key names is returned.
@onerror -
*//*-*****************************************************************************************************/
Sequence< OUString > impl_GetPropertyNames( sal_uInt32& nNewCount, sal_uInt32& nWizardCount, sal_uInt32& nHelpBookmarksCount );
@ -322,8 +302,6 @@ class SvtDynamicMenuOptions_Impl : public ConfigItem
@param "lDestination" , destination of operation
@param "sSetNode" , name of configuration set to build complete path
@return A list of configuration key names is returned.
@onerror -
*//*-*****************************************************************************************************/
void impl_SortAndExpandPropertyNames( const Sequence< OUString >& lSource ,

20
unotools/source/config/extendedsecurityoptions.cxx
View File

@ -74,9 +74,6 @@ class SvtExtendedSecurityOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "seqPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& seqPropertyNames ) SAL_OVERRIDE;
@ -87,11 +84,6 @@ class SvtExtendedSecurityOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -103,13 +95,7 @@ class SvtExtendedSecurityOptions_Impl : public ConfigItem
@short return list of key names of ouer configuration management which represent oue module tree
@descr These methods return a static const list of key names. We need it to get needed values from our
configuration management.
@seealso -
@param -
@return A list of needed configuration keys is returned.
@onerror -
*//*-*****************************************************************************************************/
static Sequence< OUString > GetPropertyNames();
@ -117,14 +103,8 @@ class SvtExtendedSecurityOptions_Impl : public ConfigItem
/*-****************************************************************************************************
@short Fills the hash map with all extensions known to be secure
@descr These methods fills the given hash map object with all extensions known to be secure.
@seealso -
@param aHashMap
A hash map to be filled with secure extension strings.
@return -
@onerror -
*//*-*****************************************************************************************************/
void FillExtensionHashMap( ExtensionHashMap& aHashMap );

21
unotools/source/config/fontoptions.cxx
View File

@ -60,9 +60,6 @@ class SvtFontOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "seqPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& seqPropertyNames ) SAL_OVERRIDE;
@ -73,11 +70,6 @@ class SvtFontOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -86,13 +78,6 @@ class SvtFontOptions_Impl : public ConfigItem
@short access method to get internal values
@descr These method give us a chance to regulate acces to ouer internal values.
It's not used in the moment - but it's possible for the feature!
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
bool IsFontHistoryEnabled ( ) const;
@ -107,13 +92,7 @@ class SvtFontOptions_Impl : public ConfigItem
@short return list of key names of ouer configuration management which represent oue module tree
@descr These methods return a static const list of key names. We need it to get needed values from our
configuration management.
@seealso -
@param -
@return A list of needed configuration keys is returned.
@onerror -
*//*-*****************************************************************************************************/
static Sequence< OUString > impl_GetPropertyNames();

21
unotools/source/config/localisationoptions.cxx
View File

@ -59,9 +59,6 @@ class SvtLocalisationOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "seqPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& seqPropertyNames ) SAL_OVERRIDE;
@ -72,11 +69,6 @@ class SvtLocalisationOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -85,13 +77,6 @@ class SvtLocalisationOptions_Impl : public ConfigItem
@short access method to get internal values
@descr These method give us a chance to regulate acces to ouer internal values.
It's not used in the moment - but it's possible for the feature!
@seealso -
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
bool IsAutoMnemonic ( ) const;
@ -103,13 +88,7 @@ class SvtLocalisationOptions_Impl : public ConfigItem
@short return list of key names of ouer configuration management which represent oue module tree
@descr These methods return a static const list of key names. We need it to get needed values from our
configuration management.
@seealso -
@param -
@return A list of needed configuration keys is returned.
@onerror -
*//*-*****************************************************************************************************/
static Sequence< OUString > GetPropertyNames();

46
unotools/source/config/moduleoptions.cxx
View File

@ -281,8 +281,6 @@ typedef FactoryInfo FactoryInfoList[FACTORYCOUNT];
@descr These class is used as a static data container of class SvtModuleOptions. The hold it by using
a refcount and make it threadsafe by using an osl mutex. So we don't must do anything for that.
We can implement pure functionality to read/write configuration data only.
@implements -
@base ConfigItem
@devstatus ready to use
@ -347,11 +345,6 @@ class SvtModuleOptions_Impl : public ::utl::ConfigItem
@seealso baseclass ConfigItem
@seealso method impl_Read()
@param -
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
SvtModuleOptions_Impl::SvtModuleOptions_Impl()
@ -380,11 +373,6 @@ SvtModuleOptions_Impl::SvtModuleOptions_Impl()
of this class modify internal member list m_lFactories! Otherwise Commit() will never be called!!!
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
SvtModuleOptions_Impl::~SvtModuleOptions_Impl()
@ -409,9 +397,6 @@ SvtModuleOptions_Impl::~SvtModuleOptions_Impl()
@seealso method impl_Read()
@param "lNames" is the list of set node entries which should be updated.
@return -
@onerror -
@threadsafe no
*//*-*************************************************************************************************************/
void SvtModuleOptions_Impl::Notify( const css::uno::Sequence< OUString >& )
@ -429,11 +414,6 @@ void SvtModuleOptions_Impl::Notify( const css::uno::Sequence< OUString >& )
are the only and right ones.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
@threadsafe no
*//*-*****************************************************************************************************/
void SvtModuleOptions_Impl::Commit()
@ -480,9 +460,6 @@ void SvtModuleOptions_Impl::Commit()
@attention Some people use any value as enum ... but we support in header specified values only!
We use it directly as index in our internal list. If enum value isn't right - we crash with an
"index out of range"!!! Please use me right - otherwise there is no guarantee.
@seealso -
@param "eModule" , index in list - specify module
@param "eFactory" , index in list - specify factory
@param "sTemplate", set new standard template for these factory
@ -732,8 +709,6 @@ void SvtModuleOptions_Impl::SetFactoryDefaultFilter( SvtModuleOptions::EFa
These full expanded list should be used to get values of this properties.
@seealso ctor
@param -
@return List of all relative addressed properties of given set entry names.
@onerror List will be empty.
@ -769,9 +744,6 @@ css::uno::Sequence< OUString > SvtModuleOptions_Impl::impl_ExpandSetNames( const
If it matches with these factory - break operation and return true AND right set parameter.
Otherwise try next one and so on. If no factory was found return false. Out parameter eFactory
is set to last tried value but shouldn't be used! Because our return value is false!
@seealso -
@param "sLongName" , long name of factory, which should be classified
@return "eFactory" , right enum value, which match given long name
and true for successfully classification, false otherwise
@ -853,8 +825,6 @@ bool SvtModuleOptions_Impl::ClassifyFactoryByName( const OUString& sName, SvtMod
@seealso method Notify()
@param "lFactories" is the list of set node entries which should be readed.
@return -
@onerror We do nothing.
@threadsafe no
*//*-*************************************************************************************************************/
@ -964,11 +934,6 @@ sal_Int32 SvtModuleOptions::m_nRefCount = 0;
container and create a static mutex, which is used for threadsafe code in further time of this object.
@seealso method impl_GetOwnStaticMutex()
@param -
@return -
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
SvtModuleOptions::SvtModuleOptions()
@ -1000,11 +965,6 @@ SvtModuleOptions::~SvtModuleOptions()
They are threadsafe. All calls are forwarded to impl-data-container. See there for further information!
@seealso method impl_GetOwnStaticMutex()
@param -
@return -
@onerror -
@threadsafe yes
*//*-*************************************************************************************************************/
bool SvtModuleOptions::IsModuleInstalled( EModule eModule ) const
@ -1127,13 +1087,7 @@ namespace
@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 -
@threadsafe yes
*//*-*****************************************************************************************************/
::osl::Mutex& SvtModuleOptions::impl_GetOwnStaticMutex()

14
unotools/source/config/securityoptions.cxx
View File

@ -121,9 +121,6 @@ class SvtSecurityOptions_Impl : public ConfigItem
@seealso baseclass ConfigItem
@param "seqPropertyNames" is the list of properties which should be updated.
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Notify( const Sequence< OUString >& seqPropertyNames ) SAL_OVERRIDE;
@ -134,11 +131,6 @@ class SvtSecurityOptions_Impl : public ConfigItem
and should always called in our destructor to guarantee consistency of config data.
@seealso baseclass ConfigItem
@param -
@return -
@onerror -
*//*-*****************************************************************************************************/
virtual void Commit() SAL_OVERRIDE;
@ -165,13 +157,7 @@ class SvtSecurityOptions_Impl : public ConfigItem
@short return list of key names of ouer configuration management which represent our module tree
@descr These methods return a static const list of key names. We need it to get needed values from our
configuration management.
@seealso -
@param -
@return A list of needed configuration keys is returned.
@onerror -
*//*-*****************************************************************************************************/
void SetProperty( sal_Int32 nHandle, const Any& rValue, bool bReadOnly );

10
unotools/source/config/viewoptions.cxx
View File

@ -294,9 +294,6 @@ class SvtViewOptionsBase_Impl
@seealso baseclass ::utl::ConfigItem
@seealso method Notify()
@param -
@return -
*//*-*************************************************************************************************************/
SvtViewOptionsBase_Impl::SvtViewOptionsBase_Impl( const OUString& sList )
: m_sListName ( sList ) // we must know, which view type we must support
@ -336,9 +333,6 @@ SvtViewOptionsBase_Impl::SvtViewOptionsBase_Impl( const OUString& sList )
@seealso method IsModified()
@seealso method SetModified()
@seealso method Commit()
@param -
@return -
*//*-*************************************************************************************************************/
SvtViewOptionsBase_Impl::~SvtViewOptionsBase_Impl()
{
@ -422,9 +416,6 @@ bool SvtViewOptionsBase_Impl::Delete( const OUString& sName )
@descr Follow methods support read/write access to all cache view items.
@seealso member m_sList
@param -
@return -
*//*-*************************************************************************************************************/
OUString SvtViewOptionsBase_Impl::GetWindowState( const OUString& sName )
{
@ -708,7 +699,6 @@ void SvtViewOptionsBase_Impl::SetVisible( const OUString& sName ,
@seealso method impl_writeDirectProp()
@param "sNode", name of new entry
@return -
*//*-*************************************************************************************************************/
css::uno::Reference< css::uno::XInterface > SvtViewOptionsBase_Impl::impl_getSetNode( const OUString& sNode ,
bool bCreateIfMissing)