diff options
author | Michael Hönnig <mi@openoffice.org> | 2000-12-19 14:36:01 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2000-12-19 14:36:01 +0000 |
commit | 63e596abd54df73dcab1265825ce4b5a432b2c1f (patch) | |
tree | b4b15951b56d91e62edd6c77ce5cd9cb44d950e0 /udkapi | |
parent | d5812f6ceae91707d7fc84c69e618f1cae7a63ca (diff) |
documentation syntax fixed
Diffstat (limited to 'udkapi')
-rw-r--r-- | udkapi/com/sun/star/beans/MethodConcept.idl | 11 | ||||
-rw-r--r-- | udkapi/com/sun/star/beans/PropertyAttribute.idl | 9 | ||||
-rw-r--r-- | udkapi/com/sun/star/container/XContentEnumerationAccess.idl | 9 | ||||
-rw-r--r-- | udkapi/com/sun/star/container/XHierarchicalNameAccess.idl | 9 | ||||
-rw-r--r-- | udkapi/com/sun/star/container/XNameAccess.idl | 9 | ||||
-rw-r--r-- | udkapi/com/sun/star/lang/RegistryServiceManager.idl | 9 | ||||
-rw-r--r-- | udkapi/com/sun/star/lang/ServiceManager.idl | 19 | ||||
-rw-r--r-- | udkapi/com/sun/star/lang/XConnectionPoint.idl | 17 | ||||
-rw-r--r-- | udkapi/com/sun/star/script/XEventAttacherManager.idl | 23 | ||||
-rw-r--r-- | udkapi/com/sun/star/script/XInvocation.idl | 17 | ||||
-rw-r--r-- | udkapi/com/sun/star/script/XInvocation2.idl | 18 | ||||
-rw-r--r-- | udkapi/com/sun/star/test/XSimpleTest.idl | 11 | ||||
-rw-r--r-- | udkapi/com/sun/star/test/XTest.idl | 15 | ||||
-rw-r--r-- | udkapi/com/sun/star/uno/XAggregation.idl | 32 |
14 files changed, 123 insertions, 85 deletions
diff --git a/udkapi/com/sun/star/beans/MethodConcept.idl b/udkapi/com/sun/star/beans/MethodConcept.idl index 7ba01e7dcd80..67dc95ca7c5c 100644 --- a/udkapi/com/sun/star/beans/MethodConcept.idl +++ b/udkapi/com/sun/star/beans/MethodConcept.idl @@ -2,9 +2,9 @@ * * $RCSfile: MethodConcept.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -137,7 +137,7 @@ constants MethodConcept <code>set...ByName()</code>, <code>replace...ByName()</code>, <code>remove...ByName()</code>, <code>has...ByName()</code> or <code>get...Names</code>. In addition, the method - <method>XNameAccess::getElementType()</method> belongs to this + <member>XNameAccess::getElementType()</member> belongs to this concept. </p> */ const long NAMECONTAINER = 16; @@ -150,7 +150,7 @@ constants MethodConcept <p>These methods have the signature <code>get...ByIndex()</code>, <code>insert...ByIndex()</code>, <code>replace...ByIndex()</code> or <code>remove...ByIndex()</code>. The method - <method scope="com::sun::star::container">XIndexAccess::getCount()</method> + <member scope="com::sun::star::container">XIndexAccess::getCount()</member> also belongs to this concept. </p> */ const long INDEXCONTAINER = 32; @@ -164,6 +164,9 @@ constants MethodConcept /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/11 16:09:35 mi + documentation syntax fixed and some minor semantic documentation fixes + Revision 1.4 2000/11/08 12:28:20 mi moved from api diff --git a/udkapi/com/sun/star/beans/PropertyAttribute.idl b/udkapi/com/sun/star/beans/PropertyAttribute.idl index 316cdfd1baaf..7d32c44c240c 100644 --- a/udkapi/com/sun/star/beans/PropertyAttribute.idl +++ b/udkapi/com/sun/star/beans/PropertyAttribute.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyAttribute.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:35 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -134,7 +134,7 @@ constants PropertyAttribute // DocMerge from idl: value com::sun::star::beans::PropertyAttribute::REMOVEABLE /** indicates that the property can be removed - (i.e. by calling <method>XPropertyContainer::removeProperty</method>). + (i.e. by calling <member>XPropertyContainer::removeProperty</member>). */ const short REMOVEABLE = 128; @@ -151,6 +151,9 @@ constants PropertyAttribute /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/11 16:09:35 mi + documentation syntax fixed and some minor semantic documentation fixes + Revision 1.4 2000/11/08 12:28:20 mi moved from api diff --git a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl index 6cb6c2517066..1c0c0d73d127 100644 --- a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl +++ b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentEnumerationAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -107,7 +107,7 @@ interface XContentEnumerationAccess: com::sun::star::uno::XInterface /** @returns all names of services of which instances exist in this object. - <p><method>XContentEnumerationAccess::createContentEnumeration</method> + <p><member>XContentEnumerationAccess::createContentEnumeration</member> creates a non-empty enumeration for all the service names which are listed here. For all others it creates no enumeration. </p> */ @@ -122,6 +122,9 @@ interface XContentEnumerationAccess: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/11 16:09:45 mi + documentation syntax fixed and some minor semantic documentation fixes + Revision 1.4 2000/11/08 12:28:31 mi moved from api diff --git a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl index 886864b52e34..9c54eb10ef29 100644 --- a/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl +++ b/udkapi/com/sun/star/container/XHierarchicalNameAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XHierarchicalNameAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -112,7 +112,7 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface <TRUE/> if an element with this name is in the container, <FALSE/> otherwise. - <p>In many cases the next call is <method>XNameAccess::getByName</method>. + <p>In many cases the next call is <member>XNameAccess::getByName</member>. You should optimize this case. @param aName @@ -129,6 +129,9 @@ interface XHierarchicalNameAccess: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/11 16:09:45 mi + documentation syntax fixed and some minor semantic documentation fixes + Revision 1.4 2000/11/08 12:28:31 mi moved from api diff --git a/udkapi/com/sun/star/container/XNameAccess.idl b/udkapi/com/sun/star/container/XNameAccess.idl index 35d641213bb7..f6cdaa6edb84 100644 --- a/udkapi/com/sun/star/container/XNameAccess.idl +++ b/udkapi/com/sun/star/container/XNameAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XNameAccess.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:45 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -130,7 +130,7 @@ interface XNameAccess: com::sun::star::container::XElementAccess <TRUE/> if an element with this name is in the container, <FALSE/> otherwise. - <p>In many cases the next call is <method>XNameAccess::getByName</method>. + <p>In many cases the next call is <member>XNameAccess::getByName</member>. You should optimize this case. </p> @param iaName @@ -147,6 +147,9 @@ interface XNameAccess: com::sun::star::container::XElementAccess /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/11 16:09:45 mi + documentation syntax fixed and some minor semantic documentation fixes + Revision 1.4 2000/11/08 12:28:31 mi moved from api diff --git a/udkapi/com/sun/star/lang/RegistryServiceManager.idl b/udkapi/com/sun/star/lang/RegistryServiceManager.idl index 1e046209ace5..11ee088d26c1 100644 --- a/udkapi/com/sun/star/lang/RegistryServiceManager.idl +++ b/udkapi/com/sun/star/lang/RegistryServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: RegistryServiceManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -149,7 +149,7 @@ service RegistryServiceManager // DocMerge from xml: service com::sun::star::lang::RegistryServiceManager: interface com::sun::star::beans::XPropertySet - /** The method <method>getPropertyValue</method> must be implemented + /** The method <member>getPropertyValue</member> must be implemented to get the readonly property <member>Registry</member>. All other methods are optional. */ @@ -175,6 +175,9 @@ service RegistryServiceManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/13 15:47:00 mi + symtactical documentation and minor semantic documentation flaws fixed + Revision 1.4 2000/11/08 12:28:41 mi moved from api diff --git a/udkapi/com/sun/star/lang/ServiceManager.idl b/udkapi/com/sun/star/lang/ServiceManager.idl index 20646499d164..a95c501c7578 100644 --- a/udkapi/com/sun/star/lang/ServiceManager.idl +++ b/udkapi/com/sun/star/lang/ServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: ServiceManager.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-13 15:47:00 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -132,15 +132,15 @@ service ServiceManager // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XComponent /** Normally you should call the method - <method scope="com::sun::star::util">XComponent::dispose</method> + <member scope="com::sun::star::util">XComponent::dispose</member> at the service manager just before the application terminates. <p>The service manager first broadcasts the - <method scope="com::sun::star::util">XEventListener::disposing()</method> + <member scope="com::sun::star::util">XEventListener::disposing()</member> message to all registered listeners. In this state you can still get all factories from the service manager, but it is not possible to add disposing listeners. Second the service manager calls - <method scope="com::sun::star::util">XComponent::dispose</method> + <member scope="com::sun::star::util">XComponent::dispose</member> at all registered factories that implement <type>XComponent</type>. In this second state the service manager does not provide any factory. This is called a two-phase shut down. </p> @@ -159,7 +159,7 @@ service ServiceManager // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::container::XContentEnumerationAccess /** It is possible to enumerate all implementations that support the service specified with the argument of the - <method>XContentEnumerationAccess::createContentEnumeration</method> method. + <member>XContentEnumerationAccess::createContentEnumeration</member> method. <p>The enumerator returns interfaces. The type of interfaces are not specified. Normally these are @@ -174,8 +174,8 @@ service ServiceManager <p>First the service manager gets the factory registered under the service name. Then - <method>XMultiServiceFactory::createInstance</type> or - <method>XMultiServiceFactory::createInstanceWithArguments</method> + <member>XMultiServiceFactory::createInstance</type> or + <member>XMultiServiceFactory::createInstanceWithArguments</member> of this factory is called. */ interface com::sun::star::lang::XMultiServiceFactory; @@ -197,6 +197,9 @@ service ServiceManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/13 15:47:00 mi + symtactical documentation and minor semantic documentation flaws fixed + Revision 1.4 2000/11/08 12:28:41 mi moved from api diff --git a/udkapi/com/sun/star/lang/XConnectionPoint.idl b/udkapi/com/sun/star/lang/XConnectionPoint.idl index 4f83d0cfe643..b01c3de82870 100644 --- a/udkapi/com/sun/star/lang/XConnectionPoint.idl +++ b/udkapi/com/sun/star/lang/XConnectionPoint.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnectionPoint.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-13 15:47:01 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -123,7 +123,7 @@ module com { module sun { module star { module lang { <p>Each connection point is a separate sub-object to avoid circular reference counting problems. A connection point controls how many connections (one or more) it will allow in its implementation of - <method>XConnectionPoint::advise()</method>. </p> + <member>XConnectionPoint::advise()</member>. </p> <h4>When to use?</h4> @@ -155,13 +155,13 @@ interface XConnectionPoint: com::sun::star::uno::XInterface the type of the outgoing interface managed by this connection point. - <p>Using the <method>XConnectionPointContainer::getConnectionPoints</method> + <p>Using the <member>XConnectionPointContainer::getConnectionPoints</member> method, a client can obtain an <type>XConnectionPoint</type> interface. Using that interface and this method, the client can determine the type of each connection point enumerated. The type returned from this method must enable the caller to access this same connection point through - <method>XConnectionPointContainer::findConnectionPoint</method>. + <member>XConnectionPointContainer::findConnectionPoint</member>. @see IConnectionPointContainer::FindConnectionPoint */ @@ -187,7 +187,7 @@ interface XConnectionPoint: com::sun::star::uno::XInterface <p>A few <code>add...Listener</code> methods need additional parameters to add listeners or throw exceptions. One of these methods is - <method scope="com::sun::star::beans">XPropertySet::addPropertyChangeListener</method>. + <member scope="com::sun::star::beans">XPropertySet::addPropertyChangeListener</member>. We ignore the problem in this interface. A solution must be provided in an additional <type>XConnectionPoint</type> interface. </p> @@ -215,7 +215,7 @@ interface XConnectionPoint: com::sun::star::uno::XInterface <p>A few <code>remove...Listener</code> methods need additional parameters to add listeners or throw exceptions. One of these methods - is <method scope="com::sun::star::beans">XPropertySet::removePropertyChangeListener</method>. + is <member scope="com::sun::star::beans">XPropertySet::removePropertyChangeListener</member>. We ignore the problem in this interface. A solution must be provided in an additional <type>XConnectionPoint</type> interface. </p> @@ -243,6 +243,9 @@ interface XConnectionPoint: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/12/13 15:47:01 mi + symtactical documentation and minor semantic documentation flaws fixed + Revision 1.4 2000/11/08 12:28:41 mi moved from api diff --git a/udkapi/com/sun/star/script/XEventAttacherManager.idl b/udkapi/com/sun/star/script/XEventAttacherManager.idl index e08028e40038..b2f008680556 100644 --- a/udkapi/com/sun/star/script/XEventAttacherManager.idl +++ b/udkapi/com/sun/star/script/XEventAttacherManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEventAttacherManager.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:35:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -223,11 +223,14 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface // DOCUMENTATION CHANGED FOR XEventAttacherManager::getScriptEvents // DocMerge from idl: method com::sun::star::script::XEventAttacherManager::getScriptEvents - /** * Returns all events registered for the given object index. - * - * @param Index an index pevious inserted with the method insertEntry. - * - * @exception IllegalArgumentException if Index is not valid. + /** @eturns + all events registered for the given object index. + + @param Index + an index pevious inserted with the method insertEntry. + + @throws IllegalArgumentException + if Index is not valid. */ sequence<com::sun::star::script::ScriptEventDescriptor> getScriptEvents( [in] long Index ) raises( com::sun::star::lang::IllegalArgumentException ); @@ -238,14 +241,11 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface /** attaches all the <type>ScriptEvent</type>s which are registered for the given index to the given object. - - <p> <type scope="com::sun::star::beans">IntrospectionException</type> and <type scope="com::sun::star::script">CannotCreateAdapterException</type> are thrown by the <type>XEventAttacher</type> and are caught and ignored. - </p> */ void attach( [in] long nIndex, @@ -307,6 +307,9 @@ interface XEventAttacherManager: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import diff --git a/udkapi/com/sun/star/script/XInvocation.idl b/udkapi/com/sun/star/script/XInvocation.idl index 8426d189344e..ab674aba685e 100644 --- a/udkapi/com/sun/star/script/XInvocation.idl +++ b/udkapi/com/sun/star/script/XInvocation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -167,7 +167,7 @@ interface XInvocation: com::sun::star::uno::XInterface <TRUE/> if the method with the specified name exists. <p>This optimizes the calling sequence - ( <method>XInvocation::hasMethod</method>, <method>XInvocation::invoke</method> )! + ( <member>XInvocation::hasMethod</member>, <member>XInvocation::invoke</member> )! @param aName specifies the name of the method. @@ -181,11 +181,11 @@ interface XInvocation: com::sun::star::uno::XInterface <TRUE/> if the property with the specified name exists. <p>This optimizes the calling sequence - ( <method>XInvocation::hasProperty</method>, - <method>XInvocation::getValue</method> ) or + ( <member>XInvocation::hasProperty</member>, + <member>XInvocation::getValue</member> ) or - ( <method>XInvocation::hasProperty</method>, - <method>XInvocation::setValue</method> )! + ( <member>XInvocation::hasProperty</member>, + <member>XInvocation::setValue</member> )! @param aName specifies the name of the property. @@ -201,6 +201,9 @@ interface XInvocation: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:52 mi + moved from api + Revision 1.2 2000/10/06 14:43:29 dbo added doc for XInvocation::invoke() diff --git a/udkapi/com/sun/star/script/XInvocation2.idl b/udkapi/com/sun/star/script/XInvocation2.idl index 8b43107b7d38..b82a34a3736b 100644 --- a/udkapi/com/sun/star/script/XInvocation2.idl +++ b/udkapi/com/sun/star/script/XInvocation2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocation2.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:35:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,11 +100,14 @@ interface XInvocation2: com::sun::star::script::XInvocation /** @returns Information item for the method or property defined by aName - @param aName specifies the name of the method or property - @param bExact specifies the name of the method or property + @param aName + specifies the name of the method or property - @exception IllegalArgumentException if aName is not the name - of a supported method or property + @param bExact + specifies the name of the method or property + + @throws IllegalArgumentException + if aName is not the name of a supported method or property @see com::sun::star::script::Invocation */ @@ -120,6 +123,9 @@ interface XInvocation2: com::sun::star::script::XInvocation /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:36 hjs initial import diff --git a/udkapi/com/sun/star/test/XSimpleTest.idl b/udkapi/com/sun/star/test/XSimpleTest.idl index f95a08dab42a..4d2ea4cb6d16 100644 --- a/udkapi/com/sun/star/test/XSimpleTest.idl +++ b/udkapi/com/sun/star/test/XSimpleTest.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleTest.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:57 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:36:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,8 +93,8 @@ interface XSimpleTest: com::sun::star::uno::XInterface between test scenarios. @param TestObject The instance to be tested. - @exception IllegalArgumentException if the test does not support TestName or - TestObject is null. + @throws IllegalArgumentException + if the test does not support TestName or TestObject is null. */ void testInvariant( [in] string TestName, [in] com::sun::star::uno::XInterface TestObject ) @@ -119,7 +119,8 @@ interface XSimpleTest: com::sun::star::uno::XInterface Handle of next test is returned by the method. @return Handle of the next test. -1 if this was the last test. - @exception IllegalArgumentException if the test does not support TestName or + @throws IllegalArgumentException + if the test does not support TestName or TestObject is null. */ long test( [in] string TestName, diff --git a/udkapi/com/sun/star/test/XTest.idl b/udkapi/com/sun/star/test/XTest.idl index f2d9e244771d..9ff40c1a04c9 100644 --- a/udkapi/com/sun/star/test/XTest.idl +++ b/udkapi/com/sun/star/test/XTest.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTest.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:57 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:36:01 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -97,8 +97,8 @@ interface XTest: com::sun::star::uno::XInterface between test scenarios. @param TestObject The instance to be tested. - @exception IllegalArgumentException if the test does not support TestName or - TestObject is null. + @throws IllegalArgumentException + if the test does not support TestName or TestObject is null. */ void testInvariant( [in] string TestName, [in] com::sun::star::uno::XInterface TestObject ) @@ -122,7 +122,8 @@ interface XTest: com::sun::star::uno::XInterface Handle of next test is returned by the method. @return Handle of the next test. -1 if this was the last test. - @exception IllegalArgumentException if the test does not support TestName + @throws IllegalArgumentException + if the test does not support TestName or TestObject is null. */ long test( [in] string TestName, @@ -154,8 +155,8 @@ interface XTest: com::sun::star::uno::XInterface Handle of next test is returned by the method. @return Handle of the next test. -1 if this was the last test. - @exception IllegalArgumentException if the test does not support TestName - or TestObject is null. + @throws IllegalArgumentException + if the test does not support TestName or TestObject is null. */ long testMultiThread( [in] string TestName, [in] com::sun::star::uno::XInterface TestObject, diff --git a/udkapi/com/sun/star/uno/XAggregation.idl b/udkapi/com/sun/star/uno/XAggregation.idl index 87a2214f0b77..ed96ae3a87b5 100644 --- a/udkapi/com/sun/star/uno/XAggregation.idl +++ b/udkapi/com/sun/star/uno/XAggregation.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAggregation.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:29:00 $ + * last change: $Author: mi $ $Date: 2000-12-19 15:32:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ module com { module sun { module star { module uno { <p>That means if an object "A" aggregates "B", "A" can provide all or some of the interfaces of "B". Whenever the method - <method>XInterface::queryInterface()</method> + <member>XInterface::queryInterface()</member> is called on either of the objects, the call will be forwarded to object "A". Object "A" now can determine whether to use the interfaces of "A" or "B" or neither. Actually, any number of @@ -89,24 +89,24 @@ module com { module sun { module star { module uno { <p>The following rules are to be observed: <ol> - <li>All calls to <method>XInterface::acquire()</method> + <li>All calls to <member>XInterface::acquire()</member> which are made before the delegator was set (using the method - <method>XAggregation::setDelegator()</method>) must not be taken back - (using the method <method>XInterface::release()</method>) + <member>XAggregation::setDelegator()</member>) must not be taken back + (using the method <member>XInterface::release()</member>) before the delegation is removed by calling <code>xAggregation->setDelegator(NULL)</code>. <li>The constructor of a delegator has to increment its own reference count by calling its method - <method>XInterface::acquire()</method> + <member>XInterface::acquire()</member> before it sets itself to any aggregate using the method - <method>XAggregation::setDelegator()</method>. After that + <member>XAggregation::setDelegator()</member>. After that call it has to reset its own reference count without the destructor getting called. <li>The destructor of a delegator has to reset the delegator in its aggregated objects by calling their method - <method>XAggregation::setDelegator()</method> with + <member>XAggregation::setDelegator()</member> with <const>NULL</const> before it releases its reference to its aggregated objects. </ol> @@ -116,16 +116,16 @@ interface XAggregation: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** sets the object to which all calls to the method - <method>XInterface::queryInterface()</method> + <member>XInterface::queryInterface()</member> have to be forwarded. @ @param xDelegator specifies the object which handles the calls to - <method>XInterface::queryInterface()</method>. + <member>XInterface::queryInterface()</member>. If <var>xDelegator</var> is <const>NULL</const>, the delegator is removed and thus the object becomes its own delegator and has to handle calls to the method - <method>XInterface::queryInterface()</method> + <member>XInterface::queryInterface()</member> itself. @example:Java @@ -157,17 +157,17 @@ interface XAggregation: com::sun::star::uno::XInterface void setDelegator( [in] com::sun::star::uno::XInterface pDelegator ); //------------------------------------------------------------------------- - /** is similar to <method>XInterface::queryInterface()</method>, + /** is similar to <member>XInterface::queryInterface()</member>, but it is to be processed directly without being forwarded to the delegator. @ <p>This method is only called from within an implementation of - <method>XInterface::queryInterface()</method> - or <method>XAggregation::queryAggregation()</method>. This method + <member>XInterface::queryInterface()</member> + or <member>XAggregation::queryAggregation()</member>. This method is to be called by the delegator if it does not implement the interface itself. An object which got aggregated cannot depend on getting its own interface when it calls the method - <method>XInterface::queryInterface()</method>. + <member>XInterface::queryInterface()</member>. @example:Java |