diff options
author | Stephan Bergmann <sbergman@redhat.com> | 2017-01-19 18:00:00 +0100 |
---|---|---|
committer | Stephan Bergmann <sbergman@redhat.com> | 2017-01-19 18:03:24 +0100 |
commit | a10b95bcc97896f7f8d8643593a5d759f41ac82d (patch) | |
tree | 76cdb3318b9dec6bc0238d6630b1769408e9ae4a /include | |
parent | 5b2b75ac26961d3cef093ca546a5316be6f2d782 (diff) |
New loplugin:dynexcspec: Add @throws documentation, comphelper
Change-Id: I115c5c34cf97858d9fdd96432cb57bde6d4537cb
Diffstat (limited to 'include')
-rw-r--r-- | include/comphelper/ChainablePropertySet.hxx | 39 | ||||
-rw-r--r-- | include/comphelper/MasterPropertySet.hxx | 36 | ||||
-rw-r--r-- | include/comphelper/SelectionMultiplex.hxx | 2 | ||||
-rw-r--r-- | include/comphelper/accessiblecomponenthelper.hxx | 8 | ||||
-rw-r--r-- | include/comphelper/accessiblekeybindinghelper.hxx | 2 | ||||
-rw-r--r-- | include/comphelper/accessibleselectionhelper.hxx | 15 | ||||
-rw-r--r-- | include/comphelper/accessibletexthelper.hxx | 19 | ||||
-rw-r--r-- | include/comphelper/accessiblewrapper.hxx | 6 | ||||
-rw-r--r-- | include/comphelper/containermultiplexer.hxx | 4 | ||||
-rw-r--r-- | include/comphelper/eventattachermgr.hxx | 1 | ||||
-rw-r--r-- | include/comphelper/extract.hxx | 2 | ||||
-rw-r--r-- | include/comphelper/ofopxmlhelper.hxx | 4 | ||||
-rw-r--r-- | include/comphelper/propagg.hxx | 2 | ||||
-rw-r--r-- | include/comphelper/propertycontainer.hxx | 2 | ||||
-rw-r--r-- | include/comphelper/propertysethelper.hxx | 15 | ||||
-rw-r--r-- | include/comphelper/propmultiplex.hxx | 2 | ||||
-rw-r--r-- | include/comphelper/proxyaggregation.hxx | 3 | ||||
-rw-r--r-- | include/comphelper/storagehelper.hxx | 16 | ||||
-rw-r--r-- | include/comphelper/types.hxx | 1 |
19 files changed, 179 insertions, 0 deletions
diff --git a/include/comphelper/ChainablePropertySet.hxx b/include/comphelper/ChainablePropertySet.hxx index 3a7a7c9e0925..8135a77d1aed 100644 --- a/include/comphelper/ChainablePropertySet.hxx +++ b/include/comphelper/ChainablePropertySet.hxx @@ -63,12 +63,22 @@ namespace comphelper SolarMutex* mpMutex; rtl::Reference < ChainablePropertySetInfo > mxInfo; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _preSetValues () throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _setSingleValue(const comphelper::PropertyInfo & rInfo, const css::uno::Any &rValue) throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, @@ -76,6 +86,11 @@ namespace comphelper css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _postSetValues () throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, @@ -83,28 +98,52 @@ namespace comphelper css::lang::WrappedTargetException, css::uno::RuntimeException) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _preGetValues () throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _getSingleValue( const comphelper::PropertyInfo & rInfo, css::uno::Any & rValue ) throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException virtual void _postGetValues () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException static void _preGetPropertyState () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ); + /// @throws css::beans::UnknownPropertyException static void _getPropertyState( const comphelper::PropertyInfo& rInfo, css::beans::PropertyState& rState ) throw(css::beans::UnknownPropertyException ); + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException static void _postGetPropertyState () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ); + /// @throws css::beans::UnknownPropertyException static void _setPropertyToDefault( const comphelper::PropertyInfo& rEntry ) throw(css::beans::UnknownPropertyException ); + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException static css::uno::Any _getPropertyDefault( const comphelper::PropertyInfo& rEntry ) throw(css::beans::UnknownPropertyException, css::lang::WrappedTargetException ); diff --git a/include/comphelper/MasterPropertySet.hxx b/include/comphelper/MasterPropertySet.hxx index 37182a93c601..6c056bb376dd 100644 --- a/include/comphelper/MasterPropertySet.hxx +++ b/include/comphelper/MasterPropertySet.hxx @@ -66,33 +66,69 @@ namespace comphelper std::map< sal_uInt8, comphelper::SlaveData* > maSlaveMap; rtl::Reference< MasterPropertySetInfo > mxInfo; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException virtual void _preSetValues () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _setSingleValue( const comphelper::PropertyInfo & rInfo, const css::uno::Any &rValue ) throw (css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException virtual void _postSetValues () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException virtual void _preGetValues () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _getSingleValue( const comphelper::PropertyInfo & rInfo, css::uno::Any & rValue ) throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException virtual void _postGetValues () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException static void _preGetPropertyState () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ); + /// @throws css::beans::UnknownPropertyException static void _getPropertyState( const comphelper::PropertyInfo& rInfo, css::beans::PropertyState& rState ) throw(css::beans::UnknownPropertyException ); + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException static void _postGetPropertyState () throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException ); + /// @throws css::beans::UnknownPropertyException static void _setPropertyToDefault( const comphelper::PropertyInfo& rEntry ) throw(css::beans::UnknownPropertyException ); + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException static css::uno::Any _getPropertyDefault( const comphelper::PropertyInfo& rEntry ) throw(css::beans::UnknownPropertyException, css::lang::WrappedTargetException ); diff --git a/include/comphelper/SelectionMultiplex.hxx b/include/comphelper/SelectionMultiplex.hxx index bc1c023f5a68..c63cd8fa046a 100644 --- a/include/comphelper/SelectionMultiplex.hxx +++ b/include/comphelper/SelectionMultiplex.hxx @@ -51,7 +51,9 @@ namespace comphelper : m_pAdapter(nullptr), m_rMutex(_rMutex) { } virtual ~OSelectionChangeListener(); + /// @throws css::uno::RuntimeException virtual void _selectionChanged( const css::lang::EventObject& aEvent ) throw (css::uno::RuntimeException) = 0; + /// @throws css::uno::RuntimeException virtual void _disposing(const css::lang::EventObject& _rSource) throw (css::uno::RuntimeException, std::exception); diff --git a/include/comphelper/accessiblecomponenthelper.hxx b/include/comphelper/accessiblecomponenthelper.hxx index de445a2ce5bc..5c895d437ae3 100644 --- a/include/comphelper/accessiblecomponenthelper.hxx +++ b/include/comphelper/accessiblecomponenthelper.hxx @@ -46,17 +46,25 @@ namespace comphelper protected: /// implements the calculation of the bounding rectangle - still waiting to be overwritten + /// + /// @throws css::uno::RuntimeException virtual css::awt::Rectangle implGetBounds( ) throw (css::uno::RuntimeException, std::exception) = 0; protected: /** non-virtual versions of the methods which can be implemented using <method>implGetBounds</method> note: getLocationOnScreen relies on a valid parent (XAccessibleContext::getParent()->getAccessibleContext()), which itself implements XAccessibleComponent + + @throws css::uno::RuntimeException */ bool SAL_CALL containsPoint( const css::awt::Point& aPoint ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException css::awt::Point SAL_CALL getLocation( ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException css::awt::Point SAL_CALL getLocationOnScreen( ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException css::awt::Size SAL_CALL getSize( ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException css::awt::Rectangle SAL_CALL getBounds( ) throw (css::uno::RuntimeException); }; diff --git a/include/comphelper/accessiblekeybindinghelper.hxx b/include/comphelper/accessiblekeybindinghelper.hxx index 4ad6f425fff6..dd7d12a57daf 100644 --- a/include/comphelper/accessiblekeybindinghelper.hxx +++ b/include/comphelper/accessiblekeybindinghelper.hxx @@ -57,7 +57,9 @@ namespace comphelper OAccessibleKeyBindingHelper(); OAccessibleKeyBindingHelper( const OAccessibleKeyBindingHelper& rHelper ); + /// @throws css::uno::RuntimeException void AddKeyBinding( const css::uno::Sequence< css::awt::KeyStroke >& rKeyBinding ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException void AddKeyBinding( const css::awt::KeyStroke& rKeyStroke ) throw (css::uno::RuntimeException); // XAccessibleKeyBinding diff --git a/include/comphelper/accessibleselectionhelper.hxx b/include/comphelper/accessibleselectionhelper.hxx index bb222c3b55f5..0b5140bc650e 100644 --- a/include/comphelper/accessibleselectionhelper.hxx +++ b/include/comphelper/accessibleselectionhelper.hxx @@ -50,16 +50,19 @@ namespace comphelper protected: // access to context - still waiting to be overwritten + /// @throws css::uno::RuntimeException virtual css::uno::Reference< css::accessibility::XAccessibleContext > implGetAccessibleContext() throw ( css::uno::RuntimeException ) = 0; // return if the specified child is visible => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx) + /// @throws css::uno::RuntimeException virtual bool implIsSelected( sal_Int32 nAccessibleChildIndex ) throw (css::uno::RuntimeException) = 0; // select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx) + /// @throws css::uno::RuntimeException virtual void implSelect( sal_Int32 nAccessibleChildIndex, bool bSelect ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception) = 0; @@ -67,13 +70,25 @@ namespace comphelper protected: /** non-virtual versions of the methods which can be implemented using <method>implIsSelected</method> and <method>implSelect</method> + + @throws css::lang::IndexOutOfBoundsException + @throws css::uno::RuntimeException */ void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::uno::RuntimeException bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException); + /// @throws css::uno::RuntimeException void SAL_CALL clearAccessibleSelection( ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException void SAL_CALL selectAllAccessibleChildren( ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException sal_Int32 SAL_CALL getSelectedAccessibleChildCount( ) throw (css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::uno::RuntimeException css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::uno::RuntimeException void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException); }; diff --git a/include/comphelper/accessibletexthelper.hxx b/include/comphelper/accessibletexthelper.hxx index 368e468a5978..d01f5a7c142b 100644 --- a/include/comphelper/accessibletexthelper.hxx +++ b/include/comphelper/accessibletexthelper.hxx @@ -63,16 +63,35 @@ namespace comphelper virtual void implGetLineBoundary( css::i18n::Boundary& rBoundary, sal_Int32 nIndex ); /** non-virtual versions of the methods + + @throws css::lang::IndexOutOfBoundsException + @throws css::uno::RuntimeException */ sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException); + /// @throws css::uno::RuntimeException sal_Int32 SAL_CALL getCharacterCount() throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException OUString SAL_CALL getSelectedText() throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException sal_Int32 SAL_CALL getSelectionStart() throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException sal_Int32 SAL_CALL getSelectionEnd() throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException OUString SAL_CALL getText() throw (css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::uno::RuntimeException OUString SAL_CALL getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException css::accessibility::TextSegment SAL_CALL getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (css::lang::IndexOutOfBoundsException, css::lang::IllegalArgumentException, css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException css::accessibility::TextSegment SAL_CALL getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (css::lang::IndexOutOfBoundsException, css::lang::IllegalArgumentException, css::uno::RuntimeException); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException css::accessibility::TextSegment SAL_CALL getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (css::lang::IndexOutOfBoundsException, css::lang::IllegalArgumentException, css::uno::RuntimeException); public: diff --git a/include/comphelper/accessiblewrapper.hxx b/include/comphelper/accessiblewrapper.hxx index d2f769fea2c4..2cfae97b6303 100644 --- a/include/comphelper/accessiblewrapper.hxx +++ b/include/comphelper/accessiblewrapper.hxx @@ -199,8 +199,12 @@ namespace comphelper DECLARE_XTYPEPROVIDER( ) // XAccessibleContext + /// @throws css::uno::RuntimeException sal_Int32 baseGetAccessibleChildCount( ) throw (css::uno::RuntimeException, std::exception); + /// @throws css::lang::IndexOutOfBoundsException + /// @throws css::uno::RuntimeException css::uno::Reference< css::accessibility::XAccessible > baseGetAccessibleChild( sal_Int32 i ) throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception); + /// @throws css::uno::RuntimeException css::uno::Reference< css::accessibility::XAccessibleRelationSet > baseGetAccessibleRelationSet( ) throw (css::uno::RuntimeException, std::exception); // XAccessibleEventListener @@ -220,6 +224,8 @@ namespace comphelper <p>The mutex of the BroadcastHelper passed to the instance's ctor is <em>not</em> locked when calling into this method</p> + + @throws css::uno::RuntimeException */ virtual void notifyTranslatedEvent( const css::accessibility::AccessibleEventObject& _rEvent ) throw (css::uno::RuntimeException) = 0; diff --git a/include/comphelper/containermultiplexer.hxx b/include/comphelper/containermultiplexer.hxx index 8b3b545c68ca..946ff698373d 100644 --- a/include/comphelper/containermultiplexer.hxx +++ b/include/comphelper/containermultiplexer.hxx @@ -50,15 +50,19 @@ namespace comphelper OContainerListener(::osl::Mutex& _rMutex); virtual ~OContainerListener(); + /// @throws css::uno::RuntimeException virtual void _elementInserted( const css::container::ContainerEvent& _rEvent ) throw (css::uno::RuntimeException, std::exception); + /// @throws css::uno::RuntimeException virtual void _elementRemoved( const css::container::ContainerEvent& _rEvent ) throw (css::uno::RuntimeException, std::exception); + /// @throws css::uno::RuntimeException virtual void _elementReplaced( const css::container::ContainerEvent& _rEvent ) throw (css::uno::RuntimeException, std::exception); + /// @throws css::uno::RuntimeException virtual void _disposing(const css::lang::EventObject& _rSource) throw (css::uno::RuntimeException, std::exception); diff --git a/include/comphelper/eventattachermgr.hxx b/include/comphelper/eventattachermgr.hxx index 77b26a844232..ec5071eed8d0 100644 --- a/include/comphelper/eventattachermgr.hxx +++ b/include/comphelper/eventattachermgr.hxx @@ -40,6 +40,7 @@ namespace beans { namespace comphelper { +/// @throws css::uno::Exception COMPHELPER_DLLPUBLIC css::uno::Reference< css::script::XEventAttacherManager > createEventAttacherManager( const css::uno::Reference< css::uno::XComponentContext > & rxContext ) diff --git a/include/comphelper/extract.hxx b/include/comphelper/extract.hxx index 36597f89d4a3..272c818c98ad 100644 --- a/include/comphelper/extract.hxx +++ b/include/comphelper/extract.hxx @@ -70,6 +70,7 @@ inline bool enum2int( sal_Int32 & rnEnum, const css::uno::Any & rAny ) * @param rAny enum or int * @param eRet the enum value as int. If there is not enum of the given type or * a css::lang::IllegalArgumentException is thrown + * @throws css::lang::IllegalArgumentException */ template< typename E > inline void any2enum( E & eRet, const css::uno::Any & rAny ) @@ -92,6 +93,7 @@ inline void any2enum( E & eRet, const css::uno::Any & rAny ) * an any. If there is no bool or integer inside the any * a css::lang::IllegalArgumentException is thrown * + * @throws css::lang::IllegalArgumentException */ inline bool any2bool( const css::uno::Any & rAny ) throw( css::lang::IllegalArgumentException ) diff --git a/include/comphelper/ofopxmlhelper.hxx b/include/comphelper/ofopxmlhelper.hxx index 3f03a39c5301..d58268164feb 100644 --- a/include/comphelper/ofopxmlhelper.hxx +++ b/include/comphelper/ofopxmlhelper.hxx @@ -36,6 +36,7 @@ namespace OFOPXMLHelper { // returns sequence of elements, where each element is described by sequence of tags, // where each tag is described by StringPair ( First - name, Second - value ) // the first tag of each element sequence must be "Id" + /// @throws css::uno::Exception COMPHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > ReadRelationsInfoSequence( @@ -49,6 +50,7 @@ namespace OFOPXMLHelper { // by StringPair object ( First - Extension, Second - ContentType ) // the second sequence describes "Override" elements, where each element is described // by StringPair object ( First - PartName, Second - ContentType ) + /// @throws css::uno::Exception COMPHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Sequence< css::beans::StringPair > > ReadContentTypeSequence( @@ -59,6 +61,7 @@ namespace OFOPXMLHelper { // writes sequence of elements, where each element is described by sequence of tags, // where each tag is described by StringPair ( First - name, Second - value ) // the first tag of each element sequence must be "Id" + /// @throws css::uno::Exception COMPHELPER_DLLPUBLIC void WriteRelationsInfoSequence( const css::uno::Reference< css::io::XOutputStream >& xOutStream, @@ -71,6 +74,7 @@ namespace OFOPXMLHelper { // by StringPair object ( First - Extension, Second - ContentType ) // the second sequence describes "Override" elements, where each element is described // by StringPair object ( First - PartName, Second - ContentType ) + /// @throws css::uno::Exception COMPHELPER_DLLPUBLIC void WriteContentSequence( const css::uno::Reference< css::io::XOutputStream >& xOutStream, diff --git a/include/comphelper/propagg.hxx b/include/comphelper/propagg.hxx index 102f2c529c77..c28a5862f382 100644 --- a/include/comphelper/propagg.hxx +++ b/include/comphelper/propagg.hxx @@ -312,6 +312,8 @@ protected: virtual void forwardedPropertyValue( sal_Int32 _nHandle ); /// must be called before aggregation, if aggregation is used + /// + /// @throws css::lang::IllegalArgumentException void setAggregation(const css::uno::Reference< css::uno::XInterface >&) throw( css::lang::IllegalArgumentException ); void startListening(); }; diff --git a/include/comphelper/propertycontainer.hxx b/include/comphelper/propertycontainer.hxx index 45b93634e637..3e31eff11b92 100644 --- a/include/comphelper/propertycontainer.hxx +++ b/include/comphelper/propertycontainer.hxx @@ -49,6 +49,8 @@ protected: OPropertyContainer(::cppu::OBroadcastHelper& _rBHelper); /// for scripting : the types of the interfaces supported by this class + /// + /// @throws css::uno::RuntimeException static css::uno::Sequence< css::uno::Type > getBaseTypes() throw (css::uno::RuntimeException, std::exception); // OPropertySetHelper overridables diff --git a/include/comphelper/propertysethelper.hxx b/include/comphelper/propertysethelper.hxx index 87a2c24eecef..7cdf5ff966e4 100644 --- a/include/comphelper/propertysethelper.hxx +++ b/include/comphelper/propertysethelper.hxx @@ -40,11 +40,26 @@ private: std::unique_ptr<PropertySetHelperImpl> mpImpl; protected: + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _setPropertyValues( const comphelper::PropertyMapEntry** ppEntries, const css::uno::Any* pValues ) throw(css::beans::UnknownPropertyException, css::beans::PropertyVetoException, css::lang::IllegalArgumentException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception ) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual void _getPropertyValues( const comphelper::PropertyMapEntry** ppEntries, css::uno::Any* pValue ) throw (css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) = 0; + /// @throws css::beans::UnknownPropertyException + /// @throws css::uno::RuntimeException virtual void _getPropertyStates( const comphelper::PropertyMapEntry** ppEntries, css::beans::PropertyState* pStates ) throw(css::beans::UnknownPropertyException, css::uno::RuntimeException ); + /// @throws css::beans::UnknownPropertyException + /// @throws css::uno::RuntimeException virtual void _setPropertyToDefault( const comphelper::PropertyMapEntry* pEntry ) throw(css::beans::UnknownPropertyException, css::uno::RuntimeException ); + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException virtual css::uno::Any _getPropertyDefault( const comphelper::PropertyMapEntry* pEntry ) throw(css::beans::UnknownPropertyException, css::lang::WrappedTargetException, css::uno::RuntimeException ); public: diff --git a/include/comphelper/propmultiplex.hxx b/include/comphelper/propmultiplex.hxx index a65ce86865d6..628a809c157e 100644 --- a/include/comphelper/propmultiplex.hxx +++ b/include/comphelper/propmultiplex.hxx @@ -50,8 +50,10 @@ namespace comphelper : m_pAdapter(nullptr), m_rMutex(_rMutex) { } virtual ~OPropertyChangeListener(); + /// @throws css::uno::RuntimeException virtual void _propertyChanged(const css::beans::PropertyChangeEvent& _rEvent) throw (css::uno::RuntimeException, std::exception) = 0; + /// @throws css::uno::RuntimeException virtual void _disposing(const css::lang::EventObject& _rSource) throw( css::uno::RuntimeException, std::exception); diff --git a/include/comphelper/proxyaggregation.hxx b/include/comphelper/proxyaggregation.hxx index 2af3737e415a..03ce2d9d4c1b 100644 --- a/include/comphelper/proxyaggregation.hxx +++ b/include/comphelper/proxyaggregation.hxx @@ -105,7 +105,9 @@ namespace comphelper ); // XInterface and XTypeProvider + /// @throws css::uno::RuntimeException css::uno::Any SAL_CALL queryAggregation( const css::uno::Type& _rType ) throw (css::uno::RuntimeException); + /// @throws css::uno::RuntimeException css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) throw (css::uno::RuntimeException); private: @@ -166,6 +168,7 @@ namespace comphelper virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) throw (css::uno::RuntimeException, std::exception) override; // XComponent + /// @throws css::uno::RuntimeException virtual void SAL_CALL dispose() throw( css::uno::RuntimeException, std::exception ) = 0; private: diff --git a/include/comphelper/storagehelper.hxx b/include/comphelper/storagehelper.hxx index 67481985d00e..fb58cf69f8ce 100644 --- a/include/comphelper/storagehelper.hxx +++ b/include/comphelper/storagehelper.hxx @@ -66,18 +66,21 @@ public: class COMPHELPER_DLLPUBLIC OStorageHelper { public: + /// @throws css::uno::Exception static css::uno::Reference< css::lang::XSingleServiceFactory > GetStorageFactory( const css::uno::Reference< css::uno::XComponentContext >& rxContext = css::uno::Reference< css::uno::XComponentContext >() ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::lang::XSingleServiceFactory > GetFileSystemStorageFactory( const css::uno::Reference< css::uno::XComponentContext >& rxContext = css::uno::Reference< css::uno::XComponentContext >() ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetTemporaryStorage( const css::uno::Reference< css::uno::XComponentContext >& rxContext @@ -85,6 +88,8 @@ public: throw ( css::uno::Exception ); /// this one will only return Storage + /// + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageFromURL( const OUString& aURL, @@ -94,6 +99,8 @@ public: throw ( css::uno::Exception ); /// this one will return either Storage or FileSystemStorage + /// + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageFromURL2( const OUString& aURL, @@ -103,6 +110,7 @@ public: throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageFromInputStream( const css::uno::Reference < css::io::XInputStream >& xStream, @@ -110,6 +118,7 @@ public: = css::uno::Reference< css::uno::XComponentContext >() ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageFromStream( const css::uno::Reference < css::io::XStream >& xStream, @@ -118,27 +127,32 @@ public: = css::uno::Reference< css::uno::XComponentContext >() ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static void CopyInputToOutput( const css::uno::Reference< css::io::XInputStream >& xInput, const css::uno::Reference< css::io::XOutputStream >& xOutput ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::io::XInputStream > GetInputStreamFromURL( const OUString& aURL, const css::uno::Reference< css::uno::XComponentContext >& context ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static void SetCommonStorageEncryptionData( const css::uno::Reference< css::embed::XStorage >& xStorage, const css::uno::Sequence< css::beans::NamedValue >& aEncryptionData ) throw ( css::uno::Exception ); // the following method supports only storages of OOo formats + /// @throws css::uno::Exception static sal_Int32 GetXStorageFormat( const css::uno::Reference< css::embed::XStorage >& xStorage ) throw ( css::uno::Exception, std::exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageOfFormatFromURL( const OUString& aFormat, @@ -148,6 +162,7 @@ public: = css::uno::Reference< css::uno::XComponentContext >() ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageOfFormatFromInputStream( const OUString& aFormat, @@ -158,6 +173,7 @@ public: bool bUseBufferedStream = false ) throw ( css::uno::Exception ); + /// @throws css::uno::Exception static css::uno::Reference< css::embed::XStorage > GetStorageOfFormatFromStream( const OUString& aFormat, diff --git a/include/comphelper/types.hxx b/include/comphelper/types.hxx index a194374e1f63..16ced8746f96 100644 --- a/include/comphelper/types.hxx +++ b/include/comphelper/types.hxx @@ -90,6 +90,7 @@ namespace comphelper COMPHELPER_DLLPUBLIC OUString getString(const css::uno::Any& _rAny); COMPHELPER_DLLPUBLIC bool getBOOL(const css::uno::Any& _rAny); + /// @throws css::lang::IllegalArgumentException COMPHELPER_DLLPUBLIC sal_Int32 getEnumAsINT32(const css::uno::Any& _rAny) throw(css::lang::IllegalArgumentException); } // namespace comphelper |