diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-05-30 13:28:29 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:12 +0200 |
commit | f9a606ecd39f59364e9b0a88d38775f07a31fb82 (patch) | |
tree | 530ed25780bcf3caedba134b64482b7332c4d15f /udkapi/com/sun/star/lang | |
parent | a95520b501751af8977cc47a40d1897023fb2b78 (diff) |
*api: tweak docs
Change-Id: I20878a3977fe7b3ab7e733a7bc0d704fb5835009
Diffstat (limited to 'udkapi/com/sun/star/lang')
-rw-r--r-- | udkapi/com/sun/star/lang/XComponent.idl | 23 | ||||
-rw-r--r-- | udkapi/com/sun/star/lang/XMultiServiceFactory.idl | 16 | ||||
-rw-r--r-- | udkapi/com/sun/star/lang/XServiceInfo.idl | 2 | ||||
-rw-r--r-- | udkapi/com/sun/star/lang/XTypeProvider.idl | 8 |
4 files changed, 22 insertions, 27 deletions
diff --git a/udkapi/com/sun/star/lang/XComponent.idl b/udkapi/com/sun/star/lang/XComponent.idl index 7f03ba6f39ec..4711bea0c16e 100644 --- a/udkapi/com/sun/star/lang/XComponent.idl +++ b/udkapi/com/sun/star/lang/XComponent.idl @@ -63,7 +63,7 @@ published interface XComponent: com::sun::star::uno::XInterface Often the object can't fulfill its specification anymore, in this case it must throw the DisposedException (which is derived from com::sun::star::uno::RuntimeException) - when it gets called.</p> + when it gets called.</p> <p>For some objects no real owner can be identified, thus it can be disposed from multiple reference holders. In this case @@ -80,15 +80,12 @@ published interface XComponent: com::sun::star::uno::XInterface <p>It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.</p> - <p>If this com::sun::star::lang::XComponent is - already disposed when - com::sun::star::lang::XComponent::addEventListener() - is called, the call will not fail - with a com::sun::star::lang::DisposedException, but - the caller will be notified via the - com::sun::star::lang::XEventListener::disposing() + <p>If this XComponent is already disposed when + XComponent::addEventListener() is called, the call will not fail + with a DisposedException, but the caller will be notified via the + XEventListener::disposing() callback. This callback can occur synchronously within the - com::sun::star::lang::XComponent::addEventListener() call.</p> + addEventListener() call.</p> @see XComponent::removeEventListener */ @@ -101,11 +98,9 @@ published interface XComponent: com::sun::star::uno::XInterface <p>It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed. - <p>If this com::sun::star::lang::XComponent is - already disposed when - com::sun::star::lang::XComponent::removeEventListener() - is called, the call will not - fail with a com::sun::star::lang::DisposedException, + <p>If this XComponent is already disposed when + XComponent::removeEventListener() is called, the call will not + fail with a DisposedException, but will rather be ignored silently.</p> @see XComponent::addEventListener diff --git a/udkapi/com/sun/star/lang/XMultiServiceFactory.idl b/udkapi/com/sun/star/lang/XMultiServiceFactory.idl index c36b4c9d5f3e..31b5725d9896 100644 --- a/udkapi/com/sun/star/lang/XMultiServiceFactory.idl +++ b/udkapi/com/sun/star/lang/XMultiServiceFactory.idl @@ -28,15 +28,13 @@ module com { module sun { module star { module lang { -/** Factories support this interface creating instances giving a name, - e.g. a service name. - - <p> - Note: - Although this interface deals with the notion of "services", this is not - generally be meant. In general this interface can be used for all kinds - of factories for all kinds of instances, indeed not only UNO services. - </p> +/** Allows creating instances specified by a string name. + + @note + Although this interface deals with the notion of "services", it is + not restricted to services but is more general. + This interface can be used for all kinds + of factories for all kinds of instances, not only UNO services. */ published interface XMultiServiceFactory: com::sun::star::uno::XInterface { diff --git a/udkapi/com/sun/star/lang/XServiceInfo.idl b/udkapi/com/sun/star/lang/XServiceInfo.idl index 4ff9ffb63add..ff9603c25b96 100644 --- a/udkapi/com/sun/star/lang/XServiceInfo.idl +++ b/udkapi/com/sun/star/lang/XServiceInfo.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module lang { -/** Provides information regarding the implementation, i.e. which services +/** Provides information regarding the implementation: which services are implemented and the name of the implementation. */ published interface XServiceInfo: com::sun::star::uno::XInterface diff --git a/udkapi/com/sun/star/lang/XTypeProvider.idl b/udkapi/com/sun/star/lang/XTypeProvider.idl index d429ba08f9fa..a396472bb0e9 100644 --- a/udkapi/com/sun/star/lang/XTypeProvider.idl +++ b/udkapi/com/sun/star/lang/XTypeProvider.idl @@ -35,7 +35,8 @@ published interface XTypeProvider: com::sun::star::uno::XInterface /** returns a sequence of all types (usually interface types) provided by the object. - Important: If the object aggregates other objects the sequence also has + @attention + If the object aggregates other objects the sequence also has to contain all types supported by the aggregated objects. */ sequence<type> getTypes(); @@ -43,14 +44,15 @@ published interface XTypeProvider: com::sun::star::uno::XInterface /** returns a sequence of bytes with length > 0 that is used as an Id to distinguish - unambiguously between two sets of types, e.g. to realise hashing + unambiguously between two sets of types, for example to realise hashing functionality when the object is introspected. Two objects that return the same UUID also have to return the same set of types in getTypes(). If a unique implementation Id cannot be provided this method has to return an empty sequence. - Important: If the object aggregates other objects the UUID has to be unique + @attention + If the object aggregates other objects the UUID has to be unique for the whole combination of objects. */ sequence<byte> getImplementationId(); |