diff options
author | Peter Foley <pefoley2@verizon.net> | 2013-03-18 21:55:24 -0400 |
---|---|---|
committer | Peter Foley <pefoley2@verizon.net> | 2013-03-18 21:57:02 -0400 |
commit | 980c1179bbde47bab53410794795781d0e61e82a (patch) | |
tree | 2c92e8a6ddce8f75bd32211484223accac16e4c0 /cppuhelper | |
parent | cleanup autodoc output (diff) | |
download | core-980c1179bbde47bab53410794795781d0e61e82a.tar.gz core-980c1179bbde47bab53410794795781d0e61e82a.zip |
cleanup doxygen warnings
Change-Id: I9181cad5bfa93f9e8b3d944b2b50a3ccc0b42595
Diffstat (limited to 'cppuhelper')
-rw-r--r-- | cppuhelper/inc/cppuhelper/component.hxx | 4 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/component_context.hxx | 2 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/exc_hlp.hxx | 2 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/interfacecontainer.h | 2 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/propertysetmixin.hxx | 42 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/propshlp.hxx | 24 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/shlib.hxx | 14 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/weak.hxx | 2 | ||||
-rw-r--r-- | cppuhelper/inc/cppuhelper/weakref.hxx | 4 |
9 files changed, 56 insertions, 40 deletions
diff --git a/cppuhelper/inc/cppuhelper/component.hxx b/cppuhelper/inc/cppuhelper/component.hxx index 115f39a9f24b..64460959fbbf 100644 --- a/cppuhelper/inc/cppuhelper/component.hxx +++ b/cppuhelper/inc/cppuhelper/component.hxx @@ -33,9 +33,9 @@ namespace cppu { -/** Deprecated. Helper for implementing ::com::sun::star::lang::XComponent. +/** Deprecated. Helper for implementing com::sun::star::lang::XComponent. Upon disposing objects of this class, sub-classes receive a disposing() call. Objects of - this class can be held weakly, i.e. by a ::com::sun::star::uno::WeakReference. Object of + this class can be held weakly, i.e. by a com::sun::star::uno::WeakReference. Object of this class can be aggregated, i.e. incoming queryInterface() calls are delegated. @attention diff --git a/cppuhelper/inc/cppuhelper/component_context.hxx b/cppuhelper/inc/cppuhelper/component_context.hxx index 3950ccd97d20..575fa490a452 100644 --- a/cppuhelper/inc/cppuhelper/component_context.hxx +++ b/cppuhelper/inc/cppuhelper/component_context.hxx @@ -33,7 +33,7 @@ struct ContextEntry_Init { /** late init denotes a object that will be raised when first get() is calling for it - The context implementation expects either a ::com::sun::star::lang::XSingleComponentFactory + The context implementation expects either a com::sun::star::lang::XSingleComponentFactory object as value (to instanciate the object) or a string as value for raising a service via the used service manager. */ diff --git a/cppuhelper/inc/cppuhelper/exc_hlp.hxx b/cppuhelper/inc/cppuhelper/exc_hlp.hxx index 14c2b6f67600..9c110ee6c018 100644 --- a/cppuhelper/inc/cppuhelper/exc_hlp.hxx +++ b/cppuhelper/inc/cppuhelper/exc_hlp.hxx @@ -39,6 +39,7 @@ CPPUHELPER_DLLPUBLIC void SAL_CALL throwException( const ::com::sun::star::uno:: /** Use this function to get the dynamic type of a caught C++-UNO exception; completes the above function throwing exceptions generically. + @code try { ... @@ -53,6 +54,7 @@ CPPUHELPER_DLLPUBLIC void SAL_CALL throwException( const ::com::sun::star::uno:: ::com::sun::star::uno::Any caught( ::cppu::getCaughtException() ); ... } + @endcode Restrictions: - use only for caught C++-UNO exceptions (UNOIDL defined) diff --git a/cppuhelper/inc/cppuhelper/interfacecontainer.h b/cppuhelper/inc/cppuhelper/interfacecontainer.h index 9ce8c9a11372..6e935f3f1936 100644 --- a/cppuhelper/inc/cppuhelper/interfacecontainer.h +++ b/cppuhelper/inc/cppuhelper/interfacecontainer.h @@ -196,7 +196,7 @@ public: @tparam ListenerT listener type @tparam FuncT unary functor type, let your compiler deduce this for you @param func unary functor object expecting an argument of type - ::com::sun::star::uno::Reference<ListenerT> + com::sun::star::uno::Reference<ListenerT> */ template <typename ListenerT, typename FuncT> inline void forEach( FuncT const& func ); diff --git a/cppuhelper/inc/cppuhelper/propertysetmixin.hxx b/cppuhelper/inc/cppuhelper/propertysetmixin.hxx index 2a05f68b47be..15bf836dd2ae 100644 --- a/cppuhelper/inc/cppuhelper/propertysetmixin.hxx +++ b/cppuhelper/inc/cppuhelper/propertysetmixin.hxx @@ -63,10 +63,10 @@ template< typename T > class PropertySetMixin; /** @short A helper base class for <code>cppu::PropertySetMixin</code>. - @descr See the documentation of <code>cppu::PropertySetMixin</code> for + See the documentation of <code>cppu::PropertySetMixin</code> for further details. - @descr That <code>cppu::PropertySetMixin</code> is derived from this + That <code>cppu::PropertySetMixin</code> is derived from this base class should be considered an implementation detail. The functionality of <code>cppu::PropertySetMixin</code> that is inherited from this base class and is visible to subclasses of @@ -120,11 +120,11 @@ protected: <code>cppu::PropertySetMixin</code> when implementing UNO interface type attribute setter functions. - @descr This class is not thread safe; that is, the constructor, + This class is not thread safe; that is, the constructor, <code>notify</code>, and the destructor must be called from the same thread. - @descr See <code>cppu::PropertySetMixinImpl::prepareSet</code> for + See <code>cppu::PropertySetMixinImpl::prepareSet</code> for further details. */ class CPPUHELPER_DLLPUBLIC BoundListeners { @@ -132,14 +132,14 @@ protected: /** @short The constructor. - @descr May throw <code>std::bad_alloc</code>. + May throw <code>std::bad_alloc</code>. */ BoundListeners(); /** @short The destructor. - @descr Does not throw. + Does not throw. */ ~BoundListeners(); @@ -147,10 +147,10 @@ protected: @short Notifies any <code>com::sun::star::beans::XPropertyChangeListener</code>s. - @descr May throw <code>com::sun::star::uno::RuntimeException</code> + May throw <code>com::sun::star::uno::RuntimeException</code> and <code>std::bad_alloc</code>. - @descr See <code>cppu::PropertySetMixinImpl::prepareSet</code> + See <code>cppu::PropertySetMixinImpl::prepareSet</code> for further details. */ void notify() const; @@ -170,7 +170,7 @@ protected: <code>cppu::PropertySetMixin</code> when implementing UNO interface type attribute setter functions. - @descr First, this function checks whether this instance has already been + First, this function checks whether this instance has already been disposed (see <code>cppu::PropertySetMixinImpl::dispose</code>), and throws a <code>com::sun::star::lang::DisposedException</code> if applicable. For a constrained attribute (whose setter can explicitly @@ -187,7 +187,7 @@ protected: Furthermore, <code>boundListeners->notify()</code> and this function have to be called from the same thread. - @descr May throw + May throw <code>com::sun::star::beans::PropertyVetoException</code>, <code>com::sun::star::uno::RuntimeException</code> (and <code>com::sun::star::lang::DisposedException</code> in particular), and @@ -201,7 +201,7 @@ protected: <code>com::sun::star::beans::PropertyChangeEvent::OldValue</code>, which is rather useless, anyway (see “Using the Observer Pattern” in <a href="http://tools.openoffice.org/CodingGuidelines.sxw"> - <cite>OpenOffice.org Coding Guidelines</cite></a>). If the attribute + OpenOffice.org Coding Guidelines</a>). If the attribute that is going to be set is neither bound nor constrained, or if <code>com::sun::star::beans::PropertyChangeEvent::OldValue</code> should not be set, a <code>VOID</code> <code>Any</code> can be used instead. @@ -211,7 +211,7 @@ protected: <code>com::sun::star::beans::PropertyChangeEvent::NewValue</code>, which is rather useless, anyway (see “Using the Observer Pattern” in <a href="http://tools.openoffice.org/CodingGuidelines.sxw"> - <cite>OpenOffice.org Coding Guidelines</cite></a>), <em>unless</em> the + OpenOffice.org Coding Guidelines</a>), <em>unless</em> the attribute that is going to be set is constrained. If the attribute that is going to be set is neither bound nor constrained, or if it is only bound but @@ -233,7 +233,7 @@ protected: /** @short Mark this instance as being disposed. - @descr See <code>com::sun::star::lang::XComponent</code> for the general + See <code>com::sun::star::lang::XComponent</code> for the general concept of disposing UNO objects. On the first call to this function, all registered listeners (<code>com::sun::star::beans::XPropertyChangeListener</code>s and @@ -241,7 +241,7 @@ protected: notified of the disposing source. Any subsequent calls to this function are ignored. - @descr May throw <code>com::sun::star::uno::RuntimeException</code> and + May throw <code>com::sun::star::uno::RuntimeException</code> and <code>std::bad_alloc</code>. */ void dispose(); @@ -251,7 +251,7 @@ protected: <code>cppu::PropertySetMixin</code> when implementing <code>com::sun::star::uno::XInterface::queryInterface</code>. - @descr This function checks for support of any of the UNO interface types + This function checks for support of any of the UNO interface types specified in the call of the <code>cppu::PropertySetMixin</code> constructor. It does not check for any other UNO interface types (not even for <code>com::sun::star::uno::XInterface</code>), and should not @@ -291,7 +291,7 @@ protected: @short Adds a <code>com::sun::star::beans::XPropertyChangeListener</code>. - @descr If a listener is added more than once, it will receive all + If a listener is added more than once, it will receive all relevant notifications multiple times. @see com::sun::star::beans::XPropertySet::addPropertyChangeListener @@ -319,7 +319,7 @@ protected: @short Adds a <code>com::sun::star::beans::XVetoableChangeListener</code>. - @descr If a listener is added more than once, it will receive all + If a listener is added more than once, it will receive all relevant notifications multiple times. @see com::sun::star::beans::XPropertySet::addVetoableChangeListener @@ -406,10 +406,10 @@ private: @short A helper mixin to implement certain UNO interfaces related to property set handling on top of the attributes of a given UNO interface type. - @descr The UNO interface type is specified by the type parameter + The UNO interface type is specified by the type parameter <code>T</code> (which must correspond to a UNO interface type). - @descr No specializations of this class template should be added by client + No specializations of this class template should be added by client code. @since UDK 3.2.1 @@ -419,7 +419,7 @@ protected: /** @short The constructor. - @descr May throw <code>com::sun::star::uno::RuntimeException</code> and + May throw <code>com::sun::star::uno::RuntimeException</code> and <code>std::bad_alloc</code>. @param context the component context used by this class template; must @@ -468,7 +468,7 @@ protected: /** @short The destructor. - @descr Does not throw. + Does not throw. */ ~PropertySetMixin() {} diff --git a/cppuhelper/inc/cppuhelper/propshlp.hxx b/cppuhelper/inc/cppuhelper/propshlp.hxx index c063f818b363..aa99ebaa6536 100644 --- a/cppuhelper/inc/cppuhelper/propshlp.hxx +++ b/cppuhelper/inc/cppuhelper/propshlp.hxx @@ -317,6 +317,19 @@ public: @param bIgnoreRuntimeExceptionsWhileFiring indicates whether occuring RuntimeExceptions shall be ignored when firing notifications + @param pnHandles the id's of the properties that changed. + @param nCount the number of elements in the arrays pnHandles, pNewValues and pOldValues. + @param bVetoable true means fire to VetoableChangeListener, false means fire to + XPropertyChangedListener and XMultiPropertyChangedListener. + @param bIgnoreRuntimeExceptionsWhileFiring + indicates whether occurring RuntimeExceptions will be + ignored when firing notifications + (vetoableChange(), propertyChange()) + to listeners. + PropertyVetoExceptions may still be thrown. + This flag is useful in an inter-process scenario when + remote bridges may break down + (firing DisposedExceptions). @see OPropertySetHelper::fire */ @@ -559,6 +572,7 @@ protected: @param rConvertedValue the converted value. Only set if return is true. @param rOldValue the old value. Only set if return is true. @param nHandle the handle of the proberty. + @param rValue the value to be converted @return true if the value converted. */ virtual sal_Bool SAL_CALL convertFastPropertyValue( @@ -575,11 +589,11 @@ protected: @attention Although you are permitted to throw any UNO exception, only the following are valid for usage: - -- ::com::sun::star::beans::UnknownPropertyException - -- ::com::sun::star::beans::PropertyVetoException - -- ::com::sun::star::lang::IllegalArgumentException - -- ::com::sun::star::lang::WrappedTargetException - -- ::com::sun::star::uno::RuntimeException + -- com::sun::star::beans::UnknownPropertyException + -- com::sun::star::beans::PropertyVetoException + -- com::sun::star::lang::IllegalArgumentException + -- com::sun::star::lang::WrappedTargetException + -- com::sun::star::uno::RuntimeException @param nHandle handle diff --git a/cppuhelper/inc/cppuhelper/shlib.hxx b/cppuhelper/inc/cppuhelper/shlib.hxx index 02ad877845fe..666359fac851 100644 --- a/cppuhelper/inc/cppuhelper/shlib.hxx +++ b/cppuhelper/inc/cppuhelper/shlib.hxx @@ -49,8 +49,8 @@ namespace cppu @param xMgr service manager to be provided to the component @param xKey registry key to be provided to the component @return - factory instance (::com::sun::star::lang::XSingleComponentFactory or - ::com::sun::star::lang::XSingleComponentFactory) + factory instance (com::sun::star::lang::XSingleComponentFactory or + com::sun::star::lang::XSingleComponentFactory) */ CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL loadSharedLibComponentFactory( @@ -74,8 +74,8 @@ SAL_CALL loadSharedLibComponentFactory( @param xKey registry key to be provided to the component @param rPrefix optional component prefix @return - factory instance (::com::sun::star::lang::XSingleComponentFactory or - ::com::sun::star::lang::XSingleComponentFactory) + factory instance (com::sun::star::lang::XSingleComponentFactory or + com::sun::star::lang::XSingleComponentFactory) */ CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL loadSharedLibComponentFactory( @@ -94,8 +94,8 @@ SAL_CALL loadSharedLibComponentFactory( @param xKey registry key to be provided to the component @param rPrefix optional component prefix @return - factory instance (::com::sun::star::lang::XSingleComponentFactory or - ::com::sun::star::lang::XSingleComponentFactory) + factory instance (com::sun::star::lang::XSingleComponentFactory or + com::sun::star::lang::XSingleComponentFactory) */ CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL invokeStaticComponentFactory( @@ -112,7 +112,7 @@ SAL_CALL invokeStaticComponentFactory( directory. The resulting path of the library will be checked against environment variable CPLD_ACCESSPATH if set. - @obsolete component_writeInfo should no longer be used in new components + @deprecated component_writeInfo should no longer be used in new components @param rLibName name of the library @param rPath optional path diff --git a/cppuhelper/inc/cppuhelper/weak.hxx b/cppuhelper/inc/cppuhelper/weak.hxx index c4cd7334a338..80d5ec07c500 100644 --- a/cppuhelper/inc/cppuhelper/weak.hxx +++ b/cppuhelper/inc/cppuhelper/weak.hxx @@ -54,7 +54,7 @@ protected: virtual ~OWeakObject() SAL_THROW( (::com::sun::star::uno::RuntimeException) ); /** disposes and resets m_pWeakConnectionPoint - @precond + @pre m_refCount equals 0 */ void disposeWeakConnectionPoint(); diff --git a/cppuhelper/inc/cppuhelper/weakref.hxx b/cppuhelper/inc/cppuhelper/weakref.hxx index 3b20e4a8599e..0a9530608159 100644 --- a/cppuhelper/inc/cppuhelper/weakref.hxx +++ b/cppuhelper/inc/cppuhelper/weakref.hxx @@ -35,7 +35,7 @@ namespace uno class OWeakRefListener; /** The WeakReferenceHelper holds a weak reference to an object. This object must implement - the ::com::sun::star::uno::XWeak interface. The implementation is thread safe. + the com::sun::star::uno::XWeak interface. The implementation is thread safe. */ class CPPUHELPER_DLLPUBLIC WeakReferenceHelper { @@ -111,7 +111,7 @@ protected: }; /** The WeakReference<> holds a weak reference to an object. This object must implement - the ::com::sun::star::uno::XWeak interface. The implementation is thread safe. + the com::sun::star::uno::XWeak interface. The implementation is thread safe. @tparam interface_type type of interface */ |