diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 21:47:17 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:00:59 +0200 |
| commit | 944eb9902788d8afec9e3f0f65d3b680041e039b (patch) | |
| tree | 3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/ucb | |
| parent | cdbbbdce9956e290b4a849af332df55da1be8d36 (diff) | |
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that
contain capital letter (all API types do) automatically as type.
This patch removes 15k doxygen warnings.
git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
Diffstat (limited to 'offapi/com/sun/star/ucb')
123 files changed, 477 insertions, 477 deletions
diff --git a/offapi/com/sun/star/ucb/AnyCompareFactory.idl b/offapi/com/sun/star/ucb/AnyCompareFactory.idl index ef850a53fbb5..c482af31241a 100644 --- a/offapi/com/sun/star/ucb/AnyCompareFactory.idl +++ b/offapi/com/sun/star/ucb/AnyCompareFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory to get <type>XAnyCompare</type> service implementations. +/** is a factory to get XAnyCompare service implementations. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/ucb/CachedContentResultSet.idl b/offapi/com/sun/star/ucb/CachedContentResultSet.idl index 86e85076efc8..9f3b2a6be9c2 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSet.idl @@ -24,10 +24,10 @@ module com { module sun { module star { module ucb { -/** is used on client side to access a <type>ContentResultSet</type> +/** is used on client side to access a ContentResultSet remote optimized. - <p>The <type>CachedContentResultSet</type> will not load every single + <p>The CachedContentResultSet will not load every single property or even row just in that moment you ask for it, but load the data for some rows beforehand. diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl index 2837aeabc2cf..ecfa073a8c79 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedContentResultSet</type> implementations. +/** is a factory for CachedContentResultSet implementations. */ published service CachedContentResultSetFactory : XCachedContentResultSetFactory; diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl b/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl index 66626f81f700..7cf72072e449 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { -/** is used on provider side to access a <type>ContentResultSet</type> +/** is used on provider side to access a ContentResultSet remote optimized. */ @@ -42,7 +42,7 @@ published service CachedContentResultSetStub interface com::sun::star::ucb::XFetchProvider; /** Provides the possibility load information offered by a - <type>XContentAccess</type> for several rows of one result set at once. + XContentAccess for several rows of one result set at once. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl index 29b1a9f7e806..6d6ca92a9d96 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedContentResultSetStub</type> implementations. +/** is a factory for CachedContentResultSetStub implementations. */ published service CachedContentResultSetStubFactory : XCachedContentResultSetStubFactory; diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 5688103f07fa..3dde01a11d7b 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -26,33 +26,33 @@ module com { module sun { module star { module ucb { /** provides read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. - <p>For example, a <type>DynamicResultSet</type> is returned from the - open-command executed by an <type>XCommandProcessor</type> of the service - <type>Content</type>. + <p>For example, a DynamicResultSet is returned from the + open-command executed by an XCommandProcessor of the service + Content. */ published service CachedDynamicResultSet { /** Provides remote optimized read access to a static or a dynamically - changing <type>ContentResultSet</type>. + changing ContentResultSet. <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to the listener in the first notification in the - <type>WelcomeDynamicResultSetStruct</type> are implementations of the - <type>CachedContentResultSet</type> service. + WelcomeDynamicResultSetStruct are implementations of the + CachedContentResultSet service. <p>This interface is required. */ interface com::sun::star::ucb::XDynamicResultSet; - /** provides the initialization of the <type>CachedDynamicResultSet</type> + /** provides the initialization of the CachedDynamicResultSet with a source object. <p>The <var>Source</var> in <member>XSourceInitialization::setSource</member> has to be an - implementation of service <type>CachedDynamicResultSetStub</type> + implementation of service CachedDynamicResultSetStub <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl index 209a70d5daae..6a82cba0badb 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedDynamicResultSet</type> implementations. +/** is a factory for CachedDynamicResultSet implementations. */ published service CachedDynamicResultSetFactory : XCachedDynamicResultSetFactory; diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 56514c58b793..b7aaef24de28 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -26,34 +26,34 @@ module com { module sun { module star { module ucb { /** provides read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. - <p>For example, a <type>DynamicResultSet</type> is returned from the - open-command executed by an <type>XCommandProcessor</type> of the service - <type>Content</type>. + <p>For example, a DynamicResultSet is returned from the + open-command executed by an XCommandProcessor of the service + Content. */ published service CachedDynamicResultSetStub { - /** In Combination with a <type>CachedDynamicResultSet</type> this provides + /** In Combination with a CachedDynamicResultSet this provides remote optimized read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to the listener in the first notification in the - <type>WelcomeDynamicResultSetStruct</type> are implementations of - <type>CachedContentResultSetStub</type>. + WelcomeDynamicResultSetStruct are implementations of + CachedContentResultSetStub. <p>This interface is required. */ interface com::sun::star::ucb::XDynamicResultSet; - /** provides the initialization of the <type>CachedDynamicResultSetStub</type> + /** provides the initialization of the CachedDynamicResultSetStub with a source object. <p>The <var>Source</var> in <member>XSourceInitialization::setSource</member> has to be an - implementation of service <type>DynamicResultSet</type> + implementation of service DynamicResultSet <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl index 5d28643acb6e..c71b81adb5d6 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedDynamicResultSetStub</type> implementations. +/** is a factory for CachedDynamicResultSetStub implementations. */ published service CachedDynamicResultSetStubFactory : XCachedDynamicResultSetStubFactory; diff --git a/offapi/com/sun/star/ucb/CmisContentProvider.idl b/offapi/com/sun/star/ucb/CmisContentProvider.idl index c370252ff173..131c926a1157 100644 --- a/offapi/com/sun/star/ucb/CmisContentProvider.idl +++ b/offapi/com/sun/star/ucb/CmisContentProvider.idl @@ -18,7 +18,7 @@ module com { module sun { module star { module ucb { -/** The Cmis Content Provider implements a <type>ContentProvider</type> +/** The Cmis Content Provider implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to directories and files on a diff --git a/offapi/com/sun/star/ucb/CommandEnvironment.idl b/offapi/com/sun/star/ucb/CommandEnvironment.idl index db5240ddc36f..bfaeba914132 100644 --- a/offapi/com/sun/star/ucb/CommandEnvironment.idl +++ b/offapi/com/sun/star/ucb/CommandEnvironment.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { - /* This service implements an <type>XCommandEnvironment</type> that can be + /* This service implements an XCommandEnvironment that can be initialized with any implementation of <type scope="com::sun::star::task">XInteractionHandler</type> and <type scope="com::sun::star::ucb">XProgressHandler</type>. The respective diff --git a/offapi/com/sun/star/ucb/CommandInfoChange.idl b/offapi/com/sun/star/ucb/CommandInfoChange.idl index b4627e613c7e..99a7bcc42522 100644 --- a/offapi/com/sun/star/ucb/CommandInfoChange.idl +++ b/offapi/com/sun/star/ucb/CommandInfoChange.idl @@ -23,18 +23,18 @@ module com { module sun { module star { module ucb { -/** specifies reasons for sending <type>CommandInfoChangeEvent</type>s. +/** specifies reasons for sending CommandInfoChangeEvents. @see CommandInfoChangeEvent @see XCommandInfo */ published constants CommandInfoChange { - /** A command was inserted into a <type>XCommandInfo</type>. + /** A command was inserted into a XCommandInfo. */ const long COMMAND_INSERTED = 0; - /** A command was removed from a <type>XCommandInfo</type>. + /** A command was removed from a XCommandInfo. */ const long COMMAND_REMOVED = 1; }; diff --git a/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl b/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl index 20bc39a3600d..97985c5aeb97 100644 --- a/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl +++ b/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module ucb { -/** This event gets delivered whenever a <type>XCommandInfo</type> is changed. +/** This event gets delivered whenever a XCommandInfo is changed. - <p>A <type>CommandInfoChangeEvent</type> object is sent to - <type>XCommandInfoChangeListener</type>s. + <p>A CommandInfoChangeEvent object is sent to + XCommandInfoChangeListeners. */ published struct CommandInfoChangeEvent: com::sun::star::lang::EventObject { @@ -44,7 +44,7 @@ published struct CommandInfoChangeEvent: com::sun::star::lang::EventObject /** contains the reason for the event. - <p>The value can be one of the <type>CommandInfoChange</type> constants. + <p>The value can be one of the CommandInfoChange constants. */ long Reason; }; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index d4dbbdb14195..0df2111aa56d 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -33,15 +33,15 @@ module com { module sun { module star { module ucb { -/** A <type>Content</type> is a service that provides access to data of a +/** A Content is a service that provides access to data of a content provided by an implementation of the service - <type>ContentProvider</type>. + ContentProvider. */ published service Content { /** provides access to the identity and the type of the content and - allows the registration of listeners for <type>ContentEvent</type>s. + allows the registration of listeners for ContentEvents. <p>This interface is required. */ @@ -68,7 +68,7 @@ published service Content /** enables the caller to let the content execute commands. <p>It is strongly recommended that any implementation supports the - improved <type>XCommandProcessor2</type> interface.</p> + improved XCommandProcessor2 interface.</p> <p>Typical commands are "open", "delete", "getPropertyValues" and "setPropertyValues". Each content must support a set of standard @@ -830,7 +830,7 @@ published service Content resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; @@ -846,7 +846,7 @@ published service Content properties from the content dynamically. <p>Note that the dynamic properties must be kept persistent. The - service <type>Store</type> (UCB persistence service) may be used to + service Store (UCB persistence service) may be used to implement this. <p><b>Important:</b> The implementation of @@ -923,7 +923,7 @@ published service Content <p>The object returned by the implementation of the method <member scope="com::sun::star::container">XChild::getParent()</member> - must implement the service <type>Content</type>. If the content is a + must implement the service Content. If the content is a root object, an empty interface may be returned. <p>This interface must be implemented by a content which is a (logical) diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index ddbc09e9d880..54e3ff075358 100644 --- a/offapi/com/sun/star/ucb/ContentEvent.idl +++ b/offapi/com/sun/star/ucb/ContentEvent.idl @@ -33,7 +33,7 @@ published struct ContentEvent: com::sun::star::lang::EventObject { /** The action. - <p>The value can be one of the <type>ContentAction</type> constants. + <p>The value can be one of the ContentAction constants. */ long Action; diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index 08b2d67c7ff2..e8b2d16a2650 100644 --- a/offapi/com/sun/star/ucb/ContentInfo.idl +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -47,9 +47,9 @@ published struct ContentInfo <p>It is highly recommended to fill these flags very accurately, as they are very important when transferring contents between different - <type>ContentProvider</type>s. + ContentProviders. - <p>The value can be one of the <type>ContentInfoAttribute</type> + <p>The value can be one of the ContentInfoAttribute constants. */ long Attributes; diff --git a/offapi/com/sun/star/ucb/ContentInfoAttribute.idl b/offapi/com/sun/star/ucb/ContentInfoAttribute.idl index 99c3faeccae1..5861c8c5c56b 100644 --- a/offapi/com/sun/star/ucb/ContentInfoAttribute.idl +++ b/offapi/com/sun/star/ucb/ContentInfoAttribute.idl @@ -31,7 +31,7 @@ published constants ContentInfoAttribute */ const short NONE = 0; - /** Supply an input stream with the <type>InsertCommandArgument</type>, + /** Supply an input stream with the InsertCommandArgument, when committing the new content by executing the command "insert" at it. */ const short INSERT_WITH_INPUTSTREAM = 1; diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl index 2db5e3ab6260..257cf6bad600 100644 --- a/offapi/com/sun/star/ucb/ContentProvider.idl +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** provides access to a set of <type>Content</type>s. +/** provides access to a set of Contents. */ published service ContentProvider { @@ -35,7 +35,7 @@ published service ContentProvider */ interface com::sun::star::ucb::XContentProvider; - /** creates special <type>XContentIdentifier</type> implementation + /** creates special XContentIdentifier implementation objects for the contents provided by this content provider. <p>This interface can be implemented in case the provider wants to @@ -44,13 +44,13 @@ published service ContentProvider */ [optional] interface com::sun::star::ucb::XContentIdentifierFactory; - /** allows a <type>ContentProvider</type> to adjust itself to special + /** allows a ContentProvider to adjust itself to special needs. <p>Whenever a ContentProvider that supports this interface is - registered at a <type>XContentProviderManager</type>, the method + registered at a XContentProviderManager, the method <member>XParameterizedContentProvider::registerInstance</member> - should first be called, using the returned <type>XContentProvider</type> + should first be called, using the returned XContentProvider to register at the XContentProviderManager. */ [optional] interface com::sun::star::ucb::XParameterizedContentProvider; diff --git a/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl b/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl index 7f5d6263eb4d..caf7263cfe9b 100644 --- a/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl +++ b/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>ContentProviderProxy</type> implementations. +/** is a factory for ContentProviderProxy implementations. */ published service ContentProviderProxyFactory : XContentProviderFactory; diff --git a/offapi/com/sun/star/ucb/ContentResultSet.idl b/offapi/com/sun/star/ucb/ContentResultSet.idl index cd174dbaa7d0..738faba28717 100644 --- a/offapi/com/sun/star/ucb/ContentResultSet.idl +++ b/offapi/com/sun/star/ucb/ContentResultSet.idl @@ -61,7 +61,7 @@ published service ContentResultSet This interface mainly provides a cursor for the result set. <p>Note that every method of this interface implementation additionally - may throw a <type>ResultSetException</type> ( which is derived from + may throw a ResultSetException ( which is derived from <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. @@ -73,7 +73,7 @@ published service ContentResultSet /** provides access to data of the content the cursor is pointing to. <p>Note that every method of this interface implementation additionally - may throw a <type>ResultSetException</type> ( which is derived from + may throw a ResultSetException ( which is derived from <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. @@ -86,7 +86,7 @@ published service ContentResultSet retrieving data from a server ). <p>Note that every method of this interface implementation additionally - may throw a <type>ResultSetException</type> ( which is derived from + may throw a ResultSetException ( which is derived from <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. diff --git a/offapi/com/sun/star/ucb/ContentResultSetCapability.idl b/offapi/com/sun/star/ucb/ContentResultSetCapability.idl index 8b8ba4663a76..71b90cf67958 100644 --- a/offapi/com/sun/star/ucb/ContentResultSetCapability.idl +++ b/offapi/com/sun/star/ucb/ContentResultSetCapability.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module ucb { /** These values are used to specify the capabilities of an - <type>XDynamicResultSet</type>. + XDynamicResultSet. */ published constants ContentResultSetCapability { - /** indicates that a <type>ContentResultSet</type> is properly sorted, + /** indicates that a ContentResultSet is properly sorted, exactly following the rules given during the ContentResultSet was created. */ diff --git a/offapi/com/sun/star/ucb/ContentTransmitter.idl b/offapi/com/sun/star/ucb/ContentTransmitter.idl index 5fb455935197..c7725beaada4 100644 --- a/offapi/com/sun/star/ucb/ContentTransmitter.idl +++ b/offapi/com/sun/star/ucb/ContentTransmitter.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** A <type>ContentTransmitter</type> is a service that provides +/** A ContentTransmitter is a service that provides @deprecated */ diff --git a/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl b/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl index e6cb70c0550d..a58108e6405e 100644 --- a/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl +++ b/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl @@ -24,14 +24,14 @@ module com { module sun { module star { module ucb { -/** is a concrete implementation of service <type>HierarchyDataSource</type>, +/** is a concrete implementation of service HierarchyDataSource, which uses the service <type scope="com::sun::star::configuration">ConfigurationProvider</type> for reading and writing hierarchy data. */ published service DefaultHierarchyDataSource { - /** is a concrete implementation of service <type>HierarchyDataSource</type>, + /** is a concrete implementation of service HierarchyDataSource, which uses the service <type scope="com::sun::star::configuration">ConfigurationProvider</type> for reading and writing hierarchy data. diff --git a/offapi/com/sun/star/ucb/DynamicResultSet.idl b/offapi/com/sun/star/ucb/DynamicResultSet.idl index 5c7c5775e4aa..b62a6588c10a 100644 --- a/offapi/com/sun/star/ucb/DynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/DynamicResultSet.idl @@ -25,17 +25,17 @@ module com { module sun { module star { module ucb { /** provides read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. - <p>For example, a <type>DynamicResultSet</type> is returned from the - open-command executed by an <type>XCommandProcessor</type> of the service - <type>Content</type>. + <p>For example, a DynamicResultSet is returned from the + open-command executed by an XCommandProcessor of the service + Content. */ published service DynamicResultSet { /** Provides read access to a static or a dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/ExpandContentProvider.idl b/offapi/com/sun/star/ucb/ExpandContentProvider.idl index 423c0d084b73..873203f8974b 100644 --- a/offapi/com/sun/star/ucb/ExpandContentProvider.idl +++ b/offapi/com/sun/star/ucb/ExpandContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The Expand Content Provider implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The Expand Content Provider implements a ContentProvider + for the UniversalContentBroker (UCB). <p> It provides access to content via macrofied URLs, e.g. diff --git a/offapi/com/sun/star/ucb/FTPContent.idl b/offapi/com/sun/star/ucb/FTPContent.idl index 7b4db0629e5e..5b7dd5328c00 100644 --- a/offapi/com/sun/star/ucb/FTPContent.idl +++ b/offapi/com/sun/star/ucb/FTPContent.idl @@ -43,17 +43,17 @@ module com { module sun { module star { module ucb { published service FTPContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>An object representing a directory in the file system is able to create a new object, which in turn can become the representation @@ -90,7 +90,7 @@ published service FTPContent interface com::sun::star::ucb::XContentCreator; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -156,27 +156,27 @@ published service FTPContent interface com::sun::star::ucb::XCommandProcessor; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/FTPContentProvider.idl b/offapi/com/sun/star/ucb/FTPContentProvider.idl index 3019125b6a9a..1e7229c4d73b 100644 --- a/offapi/com/sun/star/ucb/FTPContentProvider.idl +++ b/offapi/com/sun/star/ucb/FTPContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** The FTP Content Provider (FCP) implements a <type>ContentProvider</type> +/** The FTP Content Provider (FCP) implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to directories and files on a diff --git a/offapi/com/sun/star/ucb/FetchError.idl b/offapi/com/sun/star/ucb/FetchError.idl index 8b7c0ae6bfeb..0b9b95d9fd10 100644 --- a/offapi/com/sun/star/ucb/FetchError.idl +++ b/offapi/com/sun/star/ucb/FetchError.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { /** These values are used to specify whether and which error has occurred - while fetching data of some <type>ContentResultSet</type> rows. + while fetching data of some ContentResultSet rows. @see FetchResult */ @@ -35,7 +35,7 @@ published constants FetchError /** indicates that during fetching we went beyond the last or first row. - <p>Therefore the <type>FetchResult</type> does not contain the full + <p>Therefore the FetchResult does not contain the full count of demanded rows, but the maximum possible count must be contained. */ @@ -44,8 +44,8 @@ published constants FetchError /** indicates that during fetching we got an exception. <p>The row, that causes the exception, and all following ( "following" - in read order! ) rows are not contained in the <type>FetchResult</type>. - Therefore the <type>FetchResult</type> does not contain the full count + in read order! ) rows are not contained in the FetchResult. + Therefore the FetchResult does not contain the full count of demanded rows. But all properly read rows so far must be contained. */ const short EXCEPTION = 2; diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index db6a6fc70025..d42f1e7258e1 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -22,7 +22,7 @@ module com { module sun { module star { module ucb { -/** contains data of several rows of a <type>ContentResultSet</type>. +/** contains data of several rows of a ContentResultSet. <p>This struct is returned from <member>XFetchProvider::fetch</member>, for example. @@ -60,7 +60,7 @@ published struct FetchResult /** indicates whether and which error has occurred, while fetching. <p>The value may contain zero or more constants of the - <type>FetchError</type> constants group. + FetchError constants group. */ short FetchError; }; diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index e7c8916c97b8..5f578fdc4a77 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -44,17 +44,17 @@ module com { module sun { module star { module ucb { published service FileContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>An object representing a directory in the file system is able to create a new object, which in turn can become the representation @@ -91,7 +91,7 @@ published service FileContent interface com::sun::star::ucb::XContentCreator; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -175,39 +175,39 @@ published service FileContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/FileContentProvider.idl b/offapi/com/sun/star/ucb/FileContentProvider.idl index ba3a42288ecd..3362a6424746 100644 --- a/offapi/com/sun/star/ucb/FileContentProvider.idl +++ b/offapi/com/sun/star/ucb/FileContentProvider.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** The File Content Provider (FCP) implements a <type>ContentProvider</type> +/** The File Content Provider (FCP) implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to the local file system. @@ -48,7 +48,7 @@ published service FileContentProvider interface com::sun::star::ucb::XContentProvider; /** This interface is implemented according to the specification of - service <type>ContentProvider</type>. + service ContentProvider. */ interface com::sun::star::ucb::XContentIdentifierFactory; @@ -70,7 +70,7 @@ published service FileContentProvider </li> <li> long FileSystemNotation ( read-only, the value is one of the - <type>FileSystemNotation</type> constants ) + FileSystemNotation constants ) </li> </ul> diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index 4e68bcf05d35..e17d01e38201 100644 --- a/offapi/com/sun/star/ucb/FolderListEntry.idl +++ b/offapi/com/sun/star/ucb/FolderListEntry.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** Information about a single folder in a <type>FolderList</type>. +/** Information about a single folder in a FolderList. */ published struct FolderListEntry { diff --git a/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl b/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl index 1580e5a349df..e7b2125a4322 100644 --- a/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl +++ b/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl @@ -54,7 +54,7 @@ published struct GlobalTransferCommandArgument <p>A title clash for instance occurs, if a file named "foo.txt" is to be transferred to a folder already containing another file named - "foo.txt". Refer to <type>NameClash</type> for possible values for + "foo.txt". Refer to NameClash for possible values for this field. */ long NameClash; diff --git a/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl b/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl index 9c421011c3db..0d7ae62cd55e 100644 --- a/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl +++ b/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl @@ -36,12 +36,12 @@ module com { module sun { module star { module ucb { service GnomeVFSDocumentContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; @@ -50,27 +50,27 @@ service GnomeVFSDocumentContent [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl b/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl index 9ea41cfdf37b..040f4de3be23 100644 --- a/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl +++ b/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl @@ -42,12 +42,12 @@ module com { module sun { module star { module ucb { service GnomeVFSFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; @@ -56,27 +56,27 @@ service GnomeVFSFolderContent [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/ucb/HelpContent.idl b/offapi/com/sun/star/ucb/HelpContent.idl index ebe6c3137156..42f5422fc88b 100644 --- a/offapi/com/sun/star/ucb/HelpContent.idl +++ b/offapi/com/sun/star/ucb/HelpContent.idl @@ -41,17 +41,17 @@ module com { module sun { module star { module ucb { published service HelpContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -126,39 +126,39 @@ published service HelpContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/HelpContentProvider.idl b/offapi/com/sun/star/ucb/HelpContentProvider.idl index ae1190055526..059179ed895e 100644 --- a/offapi/com/sun/star/ucb/HelpContentProvider.idl +++ b/offapi/com/sun/star/ucb/HelpContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** The Help Content Provider (HCP) implements a <type>ContentProvider</type> +/** The Help Content Provider (HCP) implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to the help contents and to the diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl index 4e8f1a378bcd..5d9fa601a4f8 100644 --- a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** The Hierarchy Content Provider (HCP) implements a - <type>ContentProvider</type> for the <type>UniversalContentBroker</type> + ContentProvider for the UniversalContentBroker (UCB). <p>It provides access to a persistent, customizable hierarchy of contents @@ -42,17 +42,17 @@ published service HierarchyContentProvider <b>HCP Contents</b> <ol> <li> - A HCP Link (<type>HierarchyLinkContent</type>) is a content which + A HCP Link (HierarchyLinkContent) is a content which points to another (UCB) content. It is always contained in HCP Folder. A HCP Link has no children. </li> <li> - A HCP Folder (<type>HierarchyFolderContent</type>) is a container for + A HCP Folder (HierarchyFolderContent) is a container for other HCP Folders and HCP Links. </li> <li> There is at most one instance of a HCP Root Folder - ( <type>HierarchyRootFolderContent</type> ) at a time. + ( HierarchyRootFolderContent ) at a time. All other HCP contents are children of this folder. The HCP Root Folder can contain HCP Folders and HCP Links. It has the URL "vnd.sun.star.hier:/". diff --git a/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl b/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl index b7510ecbac00..dd12f39d266f 100644 --- a/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl +++ b/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl @@ -40,8 +40,8 @@ module com { module sun { module star { module ucb { for the node. This value must not be empty. <li>"TargetURL", which is of type <atom>string</atom></li> It may contain any URL, which will be treated as the target of a hierarchy link. - <li>"Children", which is of type <type>HierarchyDataReadAccess</type> or - of type <type>HierarchyDataReadWriteAccess</type></li>, depending on the + <li>"Children", which is of type HierarchyDataReadAccess or + of type HierarchyDataReadWriteAccess</li>, depending on the type of the node. This member provides access to the children of a node. </ul> */ @@ -56,9 +56,9 @@ published service HierarchyDataReadAccess </li> <li><code>getByName( "Children" )</code> will return an <atom>any</atom> containing an implementation of service - <type>HierarchyDataReadAccess</type>, if it was called on a read-only + HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service - <type>HierarchyDataReadWriteAccess</type> if it was called on a + HierarchyDataReadWriteAccess if it was called on a writable node. </li> </ul> @@ -99,9 +99,9 @@ published service HierarchyDataReadAccess <code>getByHierarchicalName( "Children/['subnode1']" )</code> will give access to the child node named "subnode1" of the node. It will return an <atom>any</atom> containing an implementation of service - <type>HierarchyDataReadAccess</type>, if it was called on a read-only + HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service - <type>HierarchyDataReadWriteAccess</type> if it was called on a + HierarchyDataReadWriteAccess if it was called on a writable node. </li> <li> @@ -115,9 +115,9 @@ published service HierarchyDataReadAccess will give direct access to the "Children" data member of the child node named "subnode3" of the node. It will return an <atom>any</atom> containing an implementation of service - <type>HierarchyDataReadAccess</type>, if it was called on a read-only + HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service - <type>HierarchyDataReadWriteAccess</type> if it was called on a + HierarchyDataReadWriteAccess if it was called on a writable node. </li> </ul> diff --git a/offapi/com/sun/star/ucb/HierarchyDataSource.idl b/offapi/com/sun/star/ucb/HierarchyDataSource.idl index 7cf38cf1d2ff..6609c93d015d 100644 --- a/offapi/com/sun/star/ucb/HierarchyDataSource.idl +++ b/offapi/com/sun/star/ucb/HierarchyDataSource.idl @@ -45,14 +45,14 @@ published service HierarchyDataSource supports at least the service specifier <code>"com.sun.star.ucb.HierarchyDataReadAccess"</code>, which will create a <b>read-only view</b> to the data. The object that is created - implements the service <type>HierarchyDataReadAccess</type>. + implements the service HierarchyDataReadAccess. <p><b>Optionally</b> the factory may support <b>writable views</b>. A writable view is requested by passing the service specifier <code>"com.sun.star.ucb.HierarchyDataReadWriteAccess"</code> to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments</member> The object that is created implements the service - <type>HierarchyDataReadWriteAccess</type>. + HierarchyDataReadWriteAccess. <p>The arguments passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments</member> @@ -70,7 +70,7 @@ published service HierarchyDataSource element and all its descendants. A path consists of segments that are separated by a single slash ("/"). There is neither a leading nor a trailing slash allowed. The <b>root</b> of the hierarchy data always - has an empty path. Refer to <type>HierarchyDataReadAccess</type> for + has an empty path. Refer to HierarchyDataReadAccess for more information on hierarchical names. <p>Other arguments can be used to control the behavior of the view. diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index cba08b94b748..e10b15bd9b35 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -42,17 +42,17 @@ module com { module sun { module star { module ucb { published service HierarchyFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -104,44 +104,44 @@ published service HierarchyFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 4839af91da9d..6c29f90f669b 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -43,17 +43,17 @@ module com { module sun { module star { module ucb { published service HierarchyLinkContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -102,39 +102,39 @@ published service HierarchyLinkContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index f494ca0b77fc..5db0ee493b49 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -46,17 +46,17 @@ module com { module sun { module star { module ucb { published service HierarchyRootFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -102,44 +102,44 @@ published service HierarchyRootFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/IOErrorCode.idl b/offapi/com/sun/star/ucb/IOErrorCode.idl index 1db24793fc13..92a986f4996c 100644 --- a/offapi/com/sun/star/ucb/IOErrorCode.idl +++ b/offapi/com/sun/star/ucb/IOErrorCode.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { <P>See <type scope="com::sun::star::task">InteractionHandler</type> for a description of what kinds of arguments - <type>InteractiveAugmentedIOException</type> should use with each of these + InteractiveAugmentedIOException should use with each of these error codes.</P> */ published enum IOErrorCode diff --git a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl index ba39152cf026..3aba573c2494 100644 --- a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** An input/output error while processing a file. <p>This exception is deprecated. Use - <type>InteractiveAugmentedIOException</type> instead. + InteractiveAugmentedIOException instead. @deprecated */ diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index 9ab8a8da710d..e4930ea8303b 100644 --- a/offapi/com/sun/star/ucb/ListAction.idl +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { /** This struct contains information needed in the notifications of a - <type>XDynamicResultSet</type>. + XDynamicResultSet. @see ListEvent */ @@ -60,7 +60,7 @@ published struct ListAction <tr align=left> <td>WELCOME</td> <td>n/a</td> <td>n/a</td> - <td><type>WelcomeDynamicResultSetStruct</type> required</td></tr> + <td>WelcomeDynamicResultSetStruct required</td></tr> <tr align=left> <td>CLEARED</td> <td>n/a</td> @@ -89,7 +89,7 @@ published struct ListAction </table> <p>The value for this member can be one of the - <type>ListActionType</type> constants group. + ListActionType constants group. */ long ListActionType; diff --git a/offapi/com/sun/star/ucb/ListActionType.idl b/offapi/com/sun/star/ucb/ListActionType.idl index 7bc27c6a261d..e284cf848ef2 100644 --- a/offapi/com/sun/star/ucb/ListActionType.idl +++ b/offapi/com/sun/star/ucb/ListActionType.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module ucb { /** These values are used to specify the type of change happened to a list. - <p>A change happened is sent from an <type>XDynamicResultSet</type> - as <type>ListAction</type> to a <type>XDynamicResultSetListener</type>. + <p>A change happened is sent from an XDynamicResultSet + as ListAction to a XDynamicResultSetListener. <p>The values are contained in <member>ListAction::ListActionType</member>. */ @@ -39,7 +39,7 @@ published constants ListActionType to a new listener. <p>The member <member>ListAction::ActionInfo</member> is required to - contain a struct <type>WelcomeDynamicResultSetStruct</type>. + contain a struct WelcomeDynamicResultSetStruct. This struct contains two <type scope="com::sun::star::sdbc">XResultSet</type>s (old and new). During and after the notification only the new set is valid for access. @@ -134,7 +134,7 @@ published constants ListActionType The identity of a row has changed. - <p>This action is related to <type>ContentAction</type> == EXCHANGED. + <p>This action is related to ContentAction == EXCHANGED. <p>The members <member>ListAction::Count</member> and <member>ListAction::Position</member> contain the position and count of the diff --git a/offapi/com/sun/star/ucb/ListEvent.idl b/offapi/com/sun/star/ucb/ListEvent.idl index 4877ecc8b942..3f465515c09f 100644 --- a/offapi/com/sun/star/ucb/ListEvent.idl +++ b/offapi/com/sun/star/ucb/ListEvent.idl @@ -25,12 +25,12 @@ module com { module sun { module star { module ucb { -/** specifies the type of event fired by an <type>XDynamicResultSet</type> +/** specifies the type of event fired by an XDynamicResultSet */ published struct ListEvent: com::sun::star::lang::EventObject { - /** If you apply the given <type>ListAction</type>s one after the other + /** If you apply the given ListActions one after the other to the old version of an result set in given order, you will get the positions in the new version. */ diff --git a/offapi/com/sun/star/ucb/MissingInputStreamException.idl b/offapi/com/sun/star/ucb/MissingInputStreamException.idl index 11302a60dd27..a479109078eb 100644 --- a/offapi/com/sun/star/ucb/MissingInputStreamException.idl +++ b/offapi/com/sun/star/ucb/MissingInputStreamException.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ucb { <p>For example, the command "insert" may fail, if the implementation expects that an input stream is supplied with the given - <type>InsertCommandArgument</type>. + InsertCommandArgument. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/NameClash.idl b/offapi/com/sun/star/ucb/NameClash.idl index 9d3f21a27019..af9573a874c2 100644 --- a/offapi/com/sun/star/ucb/NameClash.idl +++ b/offapi/com/sun/star/ucb/NameClash.idl @@ -48,7 +48,7 @@ published constants NameClash */ const long KEEP = 3; - /** Means to use a <type>NameClashResolveRequest</type> in order to solve + /** Means to use a NameClashResolveRequest in order to solve the name clash. @see com::sun::star::task::XInteractionHandler diff --git a/offapi/com/sun/star/ucb/NameClashResolveRequest.idl b/offapi/com/sun/star/ucb/NameClashResolveRequest.idl index ad1069f9c15e..79e105fcdbc2 100644 --- a/offapi/com/sun/star/ucb/NameClashResolveRequest.idl +++ b/offapi/com/sun/star/ucb/NameClashResolveRequest.idl @@ -33,12 +33,12 @@ module com { module sun { module star { module ucb { <p>If this exception is passed to an <type scope="com::sun::star::task">XInteractionHandler</type> an - <type>XInteractionSupplyName</type> and an - <type>XInteractionReplaceExistingData</type> should be supplied with + XInteractionSupplyName and an + XInteractionReplaceExistingData should be supplied with the <type scope="com::sun::star::task">XInteractionRequest</type>. On - return the <type>XInteractionSupplyName</type>, if selected, will contain + return the XInteractionSupplyName, if selected, will contain a new name supposed to resolve the name clash. The - <type>XInteractionReplaceExistingData</type> will be selected if the + XInteractionReplaceExistingData will be selected if the clashing resource shall be overwritten. @version 1.0 diff --git a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl index 55b64e72ef16..d438578dffc2 100644 --- a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl +++ b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl @@ -22,11 +22,11 @@ module com { module sun { module star { module ucb { -/** contains information for sorting a <type>ContentResultSet</type>. +/** contains information for sorting a ContentResultSet. - <p> In contrast to the struct <type>SortingInfo</type> this struct is + <p> In contrast to the struct SortingInfo this struct is used to be on the safe side, that no one asks for sorting by a property - which is not contained in a <type>ContentResultSet</type>. + which is not contained in a ContentResultSet. */ published struct NumberedSortingInfo { diff --git a/offapi/com/sun/star/ucb/ODMAContent.idl b/offapi/com/sun/star/ucb/ODMAContent.idl index 9d36f2d542c5..60978610d527 100644 --- a/offapi/com/sun/star/ucb/ODMAContent.idl +++ b/offapi/com/sun/star/ucb/ODMAContent.idl @@ -45,17 +45,17 @@ module com { module sun { module star { module ucb { published service ODMAContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -122,39 +122,39 @@ published service ODMAContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/ODMAContentProvider.idl b/offapi/com/sun/star/ucb/ODMAContentProvider.idl index c78c8b794cc8..dcdf56e65be2 100644 --- a/offapi/com/sun/star/ucb/ODMAContentProvider.idl +++ b/offapi/com/sun/star/ucb/ODMAContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The ODMA Content Provider (OCP) implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The ODMA Content Provider (OCP) implements a ContentProvider + for the UniversalContentBroker (UCB). <p>It provides access to a document structure stored on a Document Management System (DMS).</p> diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index c2035ce73dea..6ec17644d033 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument.idl @@ -33,7 +33,7 @@ published struct OpenCommandArgument { /** A mode. - <p>The value can be one of the <type>OpenMode</type> constants. + <p>The value can be one of the OpenMode constants. */ long Mode; @@ -62,7 +62,7 @@ published struct OpenCommandArgument com::sun::star::uno::XInterface Sink; /** The properties, for that the values shall be provided by the - <type>DynamicResultSet</type> returned by the command). + DynamicResultSet returned by the command). */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl index 634149d86cda..1e90dad16905 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module ucb { published struct OpenCommandArgument2 : OpenCommandArgument { /** The sort criteria for the rows of the returned - <type>ContentResultSet</type>. + ContentResultSet. <p>The result set implementation may ignore this parameter, if it cannot sort the data by the given criteria in an efficient way (i.e. diff --git a/offapi/com/sun/star/ucb/OpenMode.idl b/offapi/com/sun/star/ucb/OpenMode.idl index 826860bf13b4..323cd914ff59 100644 --- a/offapi/com/sun/star/ucb/OpenMode.idl +++ b/offapi/com/sun/star/ucb/OpenMode.idl @@ -44,7 +44,7 @@ published constants OpenMode sharing. <p>Note: There must be a data sink supplied in the - <type>OpenCommandArgument</type> struct, if this value is set. This + OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data. */ @@ -53,7 +53,7 @@ published constants OpenMode /** open a document. Allow shared read and write access. <p>Note: There must be a data sink supplied in the - <type>OpenCommandArgument</type> struct, if this value is set. This + OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data. */ @@ -62,7 +62,7 @@ published constants OpenMode /** open a document. Deny shared write access. <p>Note: There must be a data sink supplied in the - <type>OpenCommandArgument</type> struct, if this value is set. This + OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data. */ diff --git a/offapi/com/sun/star/ucb/PackageContentProvider.idl b/offapi/com/sun/star/ucb/PackageContentProvider.idl index de69ab0cf5d0..ae51059ce8bf 100644 --- a/offapi/com/sun/star/ucb/PackageContentProvider.idl +++ b/offapi/com/sun/star/ucb/PackageContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The Package Content Provider (PCP) implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The Package Content Provider (PCP) implements a ContentProvider + for the UniversalContentBroker (UCB). <p>It provides access to packages ( zip / jar archive files ) containing folders and streams. @@ -41,12 +41,12 @@ published service PackageContentProvider <b>PCP Contents</b> <ol> <li> - A PCP Stream (<type>PackageStreamContent</type>) is a content which + A PCP Stream (PackageStreamContent) is a content which represents a file inside a package. It is always contained in a PCP Folder. A PCP Stream has no children. </li> <li> - A PCP Folder (<type>PackageFolderContent</type>) is a container for + A PCP Folder (PackageFolderContent) is a container for other PCP Folders and PCP Streams. </li> </ol> diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 7e4692b67211..514d45aaadd6 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -41,17 +41,17 @@ module com { module sun { module star { module ucb { published service PackageFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -117,44 +117,44 @@ published service PackageFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 32cb3acae01e..3d67c7f6bc74 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -42,17 +42,17 @@ module com { module sun { module star { module ucb { published service PackageStreamContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -117,39 +117,39 @@ published service PackageStreamContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl index 42c830ef5e84..17a4d16d653e 100644 --- a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl @@ -25,28 +25,28 @@ module com { module sun { module star { module ucb { -/** A <type>RemoteAccessContentProvider</type> is a - <type>ContentProvider</type> that provides access to contents available at +/** A RemoteAccessContentProvider is a + ContentProvider that provides access to contents available at other (remote) UCBs. */ published service RemoteAccessContentProvider { - /** A <type>RemoteAccessContentProvider</type> is a specialized - <type>ContentProvider</type>. + /** A RemoteAccessContentProvider is a specialized + ContentProvider. */ service com::sun::star::ucb::ContentProvider; - /** allows configuration of the <type>RemoteAccessContentProvider</type>, - to specify that certain <type>XContentIdentifier</type>s map to - <type>XContent</type>s from a certain remote UCB. The Arguments + /** allows configuration of the RemoteAccessContentProvider, + to specify that certain XContentIdentifiers map to + XContents from a certain remote UCB. The Arguments string in the <member>XParameterizedContentProvider::registerInstance</member> call must contain the UNO URL of the remote UCB. @descr - The <type>XContentProvider</type>s obtained through this interface - implement the service <type>ContentProvider</type> and, if - appropriate, also the interface <type>XFileIdentifierConverter</type>. + The XContentProviders obtained through this interface + implement the service ContentProvider and, if + appropriate, also the interface XFileIdentifierConverter. */ interface com::sun::star::ucb::XParameterizedContentProvider; }; diff --git a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl index a8a91639d421..bb09062a5f53 100644 --- a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl @@ -26,15 +26,15 @@ module com { module sun { module star { module ucb { published interface XContentProvider; published interface XParameterizedContentProvider; -/** A <type>ContentProvider</type> that wraps remote content providers that +/** A ContentProvider that wraps remote content providers that (potentially) have been distributed to a UCB. <p>Before trying to pass a request to a "real", underlying content provider (which will most likely be a remote content provider distributed to this UCB), this proxy first activates any remote content providers that have been distributed here, but are still inactive (see - <type>RemoteContentProviderAcceptor</type> and - <type>XRemoteContentProviderActivator</type> for more information). + RemoteContentProviderAcceptor and + XRemoteContentProviderActivator for more information). <p>The way this works might change, therefore this interface is marked as deprecated. @@ -44,17 +44,17 @@ module com { module sun { module star { module ucb { published service RemoteProxyContentProvider { /** activates any potentially inactive remote content providers before - passing on requests to the underlying <type>XContentProvider</type>. + passing on requests to the underlying XContentProvider. */ interface XContentProvider; /** activates any potentially inactive remote content providers before passing on requests to the underlying - <type>XContentIdentifierFactory</type>. + XContentIdentifierFactory. */ [optional] interface XContentIdentifierFactory; - /** allows this <type>ContentProvider</type> to adjust itself to special + /** allows this ContentProvider to adjust itself to special needs. */ [optional] interface XParameterizedContentProvider; diff --git a/offapi/com/sun/star/ucb/ResultSetException.idl b/offapi/com/sun/star/ucb/ResultSetException.idl index 0228ae36c533..ff9e1d3eb05e 100644 --- a/offapi/com/sun/star/ucb/ResultSetException.idl +++ b/offapi/com/sun/star/ucb/ResultSetException.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** This exception is thrown to propagate exceptions thrown by operations - on <type>ContentResultSet</type>s. + on ContentResultSets. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/Rule.idl b/offapi/com/sun/star/ucb/Rule.idl index 70d89676ea22..ddf20924af68 100644 --- a/offapi/com/sun/star/ucb/Rule.idl +++ b/offapi/com/sun/star/ucb/Rule.idl @@ -27,8 +27,8 @@ module com { module sun { module star { module ucb { /** describes a rule that can be applies to a number of objects. - <p>A rule consists of a sequence of <type>RuleTerm</type>s describing the - objects to which the rule should be applied, the <type>RuleAction</type> + <p>A rule consists of a sequence of RuleTerms describing the + objects to which the rule should be applied, the RuleAction which should be used on the matching objects, and a parameter. */ published struct Rule @@ -38,7 +38,7 @@ published struct Rule */ sequence<com::sun::star::ucb::RuleTerm> Terms; - /** Some <type>RuleAction</type>s require a parameter. + /** Some RuleActions require a parameter. <table border =1> <tr> @@ -63,7 +63,7 @@ published struct Rule /** the action to perform on the matching objects. - <p>The value can be one of the <type>RuleAction</type> constants. + <p>The value can be one of the RuleAction constants. */ short Action; diff --git a/offapi/com/sun/star/ucb/RuleSet.idl b/offapi/com/sun/star/ucb/RuleSet.idl index ca27a5e600fa..bf4a061f3fab 100644 --- a/offapi/com/sun/star/ucb/RuleSet.idl +++ b/offapi/com/sun/star/ucb/RuleSet.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module ucb { -/** describes a set of <type>Rule</type>s. +/** describes a set of Rules. <p>A RuleSet is applied to a folder. It consists of a sequence of rules. - Each rule consists of a sequence of <type>RuleTerm</type>s describing the - objects to which the rule should by applied and the <type>RuleAction</type> + Each rule consists of a sequence of RuleTerms describing the + objects to which the rule should by applied and the RuleAction which should be performed on the matching objects. */ published struct RuleSet diff --git a/offapi/com/sun/star/ucb/RuleTerm.idl b/offapi/com/sun/star/ucb/RuleTerm.idl index bef8263a9cc5..49b2a51dfabc 100644 --- a/offapi/com/sun/star/ucb/RuleTerm.idl +++ b/offapi/com/sun/star/ucb/RuleTerm.idl @@ -41,7 +41,7 @@ published struct RuleTerm /** the operator used to compare the property of the document with the given value (e.g. "contains" or "greater equal"). - <p>The value can be one of the <type>RuleOperator</type> constants. + <p>The value can be one of the RuleOperator constants. */ short Operator; diff --git a/offapi/com/sun/star/ucb/SearchCommandArgument.idl b/offapi/com/sun/star/ucb/SearchCommandArgument.idl index 1df91bfcb5f9..6c5d112e1b57 100644 --- a/offapi/com/sun/star/ucb/SearchCommandArgument.idl +++ b/offapi/com/sun/star/ucb/SearchCommandArgument.idl @@ -37,7 +37,7 @@ published struct SearchCommandArgument SearchInfo Info; /** the properties for which values shall be provided through the - <type>ContentResultSet</type> returned by the search command. + ContentResultSet returned by the search command. */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl index f6c2fe7adcc6..a5b0a14ac5a2 100644 --- a/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>DynamicResultSet</type> implementations, which +/** is a factory for DynamicResultSet implementations, which will be sorted according to the given sorting options. */ published service SortedDynamicResultSetFactory diff --git a/offapi/com/sun/star/ucb/Store.idl b/offapi/com/sun/star/ucb/Store.idl index a6eb94876445..500d2999c2c6 100644 --- a/offapi/com/sun/star/ucb/Store.idl +++ b/offapi/com/sun/star/ucb/Store.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** creates instances of the service <type>PropertySetRegistry</type>. +/** creates instances of the service PropertySetRegistry. */ published service Store : XPropertySetRegistryFactory; diff --git a/offapi/com/sun/star/ucb/TransferInfo.idl b/offapi/com/sun/star/ucb/TransferInfo.idl index ff7ab7e29b28..07c6af8faa96 100644 --- a/offapi/com/sun/star/ucb/TransferInfo.idl +++ b/offapi/com/sun/star/ucb/TransferInfo.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { <p>The transfer command is always called on the target folder. For a details description of the transfer command refer to the documentation - of service <type>Content</type>. + of service Content. */ published struct TransferInfo { @@ -56,7 +56,7 @@ published struct TransferInfo to be transferred to a folder already containing another file named "foo.txt". - <p>The value can be one of the <type>NameClash</type> constants. + <p>The value can be one of the NameClash constants. <p>Implementations that are not able to detect whether there is a clashing resource may ignore <member>NameClash::ERROR</member> and diff --git a/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl b/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl index 7fb990352209..012a3dd46fa8 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** The Transient Documents Content Provider (TDCP) implements a - <type>ContentProvider</type> for the <type>UniversalContentBroker</type> + ContentProvider for the UniversalContentBroker (UCB). <p>It provides access to the hierarchical structure of the documents that @@ -57,25 +57,25 @@ service TransientDocumentsContentProvider <b>TDCP Contents</b> <ol> <li> - A TDCP Stream (<type>TransientDocumentsStreamContent</type>) is a + A TDCP Stream (TransientDocumentsStreamContent) is a content which represents a data stream of an Office document. It is contained in a TDCP Folder or TDCP Document. A TDCP Stream has no children. </li> <li> - A TDCP Folder (<type>TransientDocumentsFolderContent</type>) is a + A TDCP Folder (TransientDocumentsFolderContent) is a container for other TDCP Folders and TDCP Streams. It may be contained in another TDCP Folder or in a TDCP Document. </li> <li> - A TDCP Document (<type>TransientDocumentsDocumentContent</type>) + A TDCP Document (TransientDocumentsDocumentContent) represents the root folder of a transient document. It is a container for other TDCP Folders and TDCP Streams. It is always a child of the TDCP Root. </li> <li> There is at most one instance of a TDCP Root - (<type>TransientDocumentsRootContent</type>) at a time. All other TDCP + (TransientDocumentsRootContent) at a time. All other TDCP contents are children of this folder. The TDCP Root Folder can contain only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/". </li> diff --git a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl index 078c56085490..b45283769b06 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsDocumentContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -106,44 +106,44 @@ service TransientDocumentsDocumentContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>To create a new child of a TDCP Document: diff --git a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl index 1b0c545ef722..dee571768248 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl @@ -47,17 +47,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -116,44 +116,44 @@ service TransientDocumentsFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>To create a new child of a TDCP Folder: diff --git a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl index 284f885418a0..271c9410626c 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsRootContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -101,39 +101,39 @@ service TransientDocumentsRootContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl index 30d5a750def2..89b95d7fbb05 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsStreamContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -107,39 +107,39 @@ service TransientDocumentsStreamContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/ucb/UniversalContentBroker.idl b/offapi/com/sun/star/ucb/UniversalContentBroker.idl index 81cc2dfaebe7..39768d13a7bd 100644 --- a/offapi/com/sun/star/ucb/UniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/UniversalContentBroker.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** is a one-instance service that provides access to a set of - <type>Content</type>s via <type>ContentProvider</type>s. + Contents via ContentProviders. <p>Traditionally, this service implements <type scope="com::sun::star::lang">XInitialization</type> and needed to be diff --git a/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl b/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl index 96007a7095fa..8403afeaad30 100644 --- a/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** This exception is used to indicate that the requested type of data sink is not supported. - <p>For example, each <type>OpenCommandArgument</type> supplied as argument + <p>For example, each OpenCommandArgument supplied as argument of the command "open" contains such a data sink. @version 1.0 diff --git a/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl b/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl index e667373a2d9e..e8154991dc39 100644 --- a/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ucb { it or if it is just not (yet) implemented. <p>Command "transfer": Used if the name clash directive specified in - parameter NameClash of the supplied <type>TransferInfo</type> is not + parameter NameClash of the supplied TransferInfo is not supported. For example, if the NameClash was set to NameClash::ERROR, to NameClash::RENAME or to NameClash::ASK, the implementation must be able determine whether there are existing data. This exception must also @@ -38,7 +38,7 @@ module com { module sun { module star { module ucb { unable to create a valid new name after a suitable number of tries. <p>Command "insert": Used if the parameter ReplaceExisting of the - supplied <type>InsertCommandArgument</type> was set to <false/> and the + supplied InsertCommandArgument was set to <false/> and the implementation is unable to determine whether there are existing data. The member NameClash of the exception must be set to NameClash::ERROR @@ -48,7 +48,7 @@ module com { module sun { module star { module ucb { */ published exception UnsupportedNameClashException : com::sun::star::uno::Exception { - /** contains the <type>NameClash</type> that is not supported. + /** contains the NameClash that is not supported. */ long NameClash; }; diff --git a/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl b/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl index 20aca8332f96..8aa2555083ca 100644 --- a/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module ucb { -/** This exception is used to indicate that the requested <type>OpenMode</type> +/** This exception is used to indicate that the requested OpenMode is not supported. - <p>For example, each <type>OpenCommandArgument</type> supplied as argument + <p>For example, each OpenCommandArgument supplied as argument of the command "open" contains such an open mode. @version 1.0 @@ -37,7 +37,7 @@ module com { module sun { module star { module ucb { */ published exception UnsupportedOpenModeException : com::sun::star::uno::Exception { - /** contains the <type>OpenMode</type> that is not supported. + /** contains the OpenMode that is not supported. */ short Mode; }; diff --git a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl index ceaa55a889af..6a27e7f1704a 100644 --- a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl +++ b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The WebDAV Content Provider (DCP) implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The WebDAV Content Provider (DCP) implements a ContentProvider + for the UniversalContentBroker (UCB). <p>It provides access to WebDAV and standard HTTP servers. The DCP communicates with the server using the WebDAV protocol which is an @@ -45,11 +45,11 @@ published service WebDAVContentProvider <b>DCP Contents</b> <ol> <li> - A DCP Folder (<type>WebDAVFolderContent</type>) is a container for + A DCP Folder (WebDAVFolderContent) is a container for other DCP Folders or Documents. </li> <li> - A DCP Document (<type>WebDAVDocumentContent</type>) is a container for + A DCP Document (WebDAVDocumentContent) is a container for Document data/content. The data/content may be anything, a WebDAV server, like an HTTP server, does not necessarily mandate what type of data/content may be contained within Documents. The type of data/content diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index 4078fd443a5b..827936999813 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { published service WebDAVDocumentContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -86,7 +86,7 @@ published service WebDAVDocumentContent open </li> <li> - post ( Argument: <type>PostCommandArgument2</type> - does a HTTP POST ) + post ( Argument: PostCommandArgument2 - does a HTTP POST ) </li> </ul> @@ -122,39 +122,39 @@ published service WebDAVDocumentContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index ca3e5324d9b2..02b2cd3d819d 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -41,17 +41,17 @@ module com { module sun { module star { module ucb { published service WebDAVFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -116,44 +116,44 @@ published service WebDAVFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl index 668e3d0a349a..ce6b78af5a90 100644 --- a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl +++ b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** This struct is to be contained in the first notification of an - <type>XDynamicResultSet</type>. + XDynamicResultSet. @see XDynamicResultSet @see ListEvent diff --git a/offapi/com/sun/star/ucb/XAnyCompareFactory.idl b/offapi/com/sun/star/ucb/XAnyCompareFactory.idl index 500f311d2086..1fb0956b3680 100644 --- a/offapi/com/sun/star/ucb/XAnyCompareFactory.idl +++ b/offapi/com/sun/star/ucb/XAnyCompareFactory.idl @@ -26,12 +26,12 @@ module com { module sun { module star { module ucb { -/** creates an <type>XAnyCompare</type> instance. +/** creates an XAnyCompare instance. */ published interface XAnyCompareFactory: com::sun::star::uno::XInterface { - /** creates an <type>XAnyCompare</type> instance. + /** creates an XAnyCompare instance. @param PropertyName is the name of a property diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl index f24c9d642288..47833e402de4 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedContentResultSet</type>. +/** creates a CachedContentResultSet. */ published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface @@ -35,15 +35,15 @@ published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterf <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource - must be an instance of service <type>CachedContentResultSetStub</type>. + must be an instance of service CachedContentResultSetStub. @param xMapping can be used for optimization of remote access via the interface - <type>XContentAccess</type> of the <type>CachedContentResultSet</type>. + XContentAccess of the CachedContentResultSet. This parameter can be <NULL/>. @returns - an instance of service <type>CachedContentResultSet</type>. + an instance of service CachedContentResultSet. */ com::sun::star::sdbc::XResultSet createCachedContentResultSet( [in] com::sun::star::sdbc::XResultSet xSource, diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl index d3795626afa8..f27e1c9b3a97 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedContentResultSetStub</type>. +/** creates a CachedContentResultSetStub. */ published interface XCachedContentResultSetStubFactory: com::sun::star::uno::XInterface @@ -34,10 +34,10 @@ published interface XCachedContentResultSetStubFactory: com::sun::star::uno::XIn <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource - must be an instance of service <type>ContentResultSet</type>. + must be an instance of service ContentResultSet. @returns - an instance of service <type>CachedContentResultSetStub</type>. + an instance of service CachedContentResultSetStub. */ com::sun::star::sdbc::XResultSet createCachedContentResultSetStub( [in] com::sun::star::sdbc::XResultSet xSource ); diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl index 59adad760ae7..f6205e30422d 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl @@ -26,34 +26,34 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedDynamicResultSet</type>. +/** creates a CachedDynamicResultSet. <p>Pay attention to instantiate this helper on client side where your want to read the data respectively where you have instantiated the listener to - the <type>XDynamicResultSet</type>. + the XDynamicResultSet. <p>The needed stub on server side can be created using - <type>XCachedDynamicResultSetStubFactory</type>. + XCachedDynamicResultSetStubFactory. */ published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface { - /** creates a remote optimizes <type>XDynamicResultSet</type>. + /** creates a remote optimizes XDynamicResultSet. @param SourceStub - must be an instance of service <type>CachedDynamicResultSetStub</type>. + must be an instance of service CachedDynamicResultSetStub. It can be <NULL/>. In this case you can use the interface - <type>XSourceInitialization</type> of the returned - <type>CachedDynamicResultSet</type> to set the stub later. + XSourceInitialization of the returned + CachedDynamicResultSet to set the stub later. @param ContentIdentifierMapping is not required, but can be set if it is necessary to change the identity of the contents accessible via the interface - <type>XContentAccess</type> of the <type>ContentResultSet</type> + XContentAccess of the ContentResultSet (e.g., if merging two sources of the same type). @returns - an instance of service <type>CachedDynamicResultSet</type>. + an instance of service CachedDynamicResultSet. */ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSet( [in] com::sun::star::ucb::XDynamicResultSet SourceStub diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 9ca861b7db9f..91ef8523811e 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -27,48 +27,48 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedDynamicResultSetStub</type> and connects a non-remote - optimized <type>DynamicResultSet</type> to a remote optimized - <type>CachedDynamicResultSet</type>. +/** creates a CachedDynamicResultSetStub and connects a non-remote + optimized DynamicResultSet to a remote optimized + CachedDynamicResultSet. <p>Pay attention to instantiate this helper on server side where your source - <type>DynamicResultSet</type> was instantiated. + DynamicResultSet was instantiated. <p>Method <member>XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub</member> can be used to create a stub on server side. - <p>If you have instantiated a <type>CachedDynamicResultSet</type> on client + <p>If you have instantiated a CachedDynamicResultSet on client side already, use method <member>connectToCache</member> to connect your given DynamicResultSet with this Cache. <p>The needed cache on server side you can create using - <type>XCachedDynamicResultSetFactory</type>. + XCachedDynamicResultSetFactory. */ published interface XCachedDynamicResultSetStubFactory: com::sun::star::uno::XInterface { - /** creates a remote optimizes <type>XDynamicResultSet</type>. + /** creates a remote optimizes XDynamicResultSet. @param Source - must be an instance of service <type>DynamicResultSet</type>. + must be an instance of service DynamicResultSet. @returns - an instance of service <type>CachedDynamicResultSetStub</type>. + an instance of service CachedDynamicResultSetStub. */ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSetStub( [in] com::sun::star::ucb::XDynamicResultSet Source ); - /** If you have instantiated a <type>CachedDynamicResultSet</type> on + /** If you have instantiated a CachedDynamicResultSet on client side already, use this to connect your given Source on server side to the TargetCache. @param Source - is an instance of service <type>DynamicResultSet</type>. + is an instance of service DynamicResultSet. @param TargetCache - is an instance of service <type>CachedDynamicResultSet</type>. + is an instance of service CachedDynamicResultSet. @param SortingInfo can be an empty sequence. Otherwise, Source will be sorted according diff --git a/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl b/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl index 129065f6d092..10546e68e16a 100644 --- a/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl +++ b/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a listener for events related to changing <type>XCommandInfo</type>s. +/** a listener for events related to changing XCommandInfos. @version 1.0 @author Kai Sommerfeld @@ -34,7 +34,7 @@ module com { module sun { module star { module ucb { */ published interface XCommandInfoChangeListener : com::sun::star::lang::XEventListener { - /** gets called whenever changes of a <type>XCommandInfo</type> shall + /** gets called whenever changes of a XCommandInfo shall be propagated. @param evt diff --git a/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl b/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl index c1d0bb563567..80eb0fa78acc 100644 --- a/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a notifier for changes of <type>XCommandInfo</type>s. +/** a notifier for changes of XCommandInfos. @version 1.0 @author Kai Sommerfeld @@ -34,7 +34,7 @@ module com { module sun { module star { module ucb { */ published interface XCommandInfoChangeNotifier : com::sun::star::uno::XInterface { - /** registers a listener for <type>CommandInfoChangeEvent</type>s. + /** registers a listener for CommandInfoChangeEvents. @param Listener the listener to add. @@ -42,7 +42,7 @@ published interface XCommandInfoChangeNotifier : com::sun::star::uno::XInterface void addCommandInfoChangeListener( [in] XCommandInfoChangeListener Listener ); - /** removes a listener for <type>CommandInfoChangeEvent</type>s. + /** removes a listener for CommandInfoChangeEvents. @param Listener the listener to remove. diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index 89cee4005ac5..1edf2ca3cea4 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor.idl @@ -72,7 +72,7 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface /** executes a command. <p>Common command definitions can be found in the specification of the - service <type>Content</type>. + service Content. @param aCommand is the command to execute. @@ -83,7 +83,7 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface zero can be used, if the command never shall be aborted. Different threads MUST NOT share one command identifier (except <code>0</code>). This can easily achieved, if every thread that wants to use an - <type>XCommandProcessor</type>, obtains exactly one identifier + XCommandProcessor, obtains exactly one identifier using <member>XCommandProcessor::createCommandIdentifier</member>. This identifier can be used for every call to <member>XCommandProcessor::execute</member> done by that thread. diff --git a/offapi/com/sun/star/ucb/XContentAccess.idl b/offapi/com/sun/star/ucb/XContentAccess.idl index 8f25fb9e7e30..75abcd300016 100644 --- a/offapi/com/sun/star/ucb/XContentAccess.idl +++ b/offapi/com/sun/star/ucb/XContentAccess.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ucb { /** specifies methods for obtaining information on a content in different levels. - <p>For example, if there is a cursor which points to <type>XContent</type>s, + <p>For example, if there is a cursor which points to XContents, this interface could be used to give the user access to the content under the cursor. If the client only needs the identifier string of the content, there is no need to first create the content object, then to obtain the diff --git a/offapi/com/sun/star/ucb/XContentCreator.idl b/offapi/com/sun/star/ucb/XContentCreator.idl index 52b4e7fef471..69080f2e36ee 100644 --- a/offapi/com/sun/star/ucb/XContentCreator.idl +++ b/offapi/com/sun/star/ucb/XContentCreator.idl @@ -41,7 +41,7 @@ module com { module sun { module star { module ucb { @deprecated - <p>This interface is deprecated. Use <type>Content</type> property + <p>This interface is deprecated. Use Content property "CreatableContentsInfo" and command "createNewContent" instead. @version 1.0 diff --git a/offapi/com/sun/star/ucb/XContentEventListener.idl b/offapi/com/sun/star/ucb/XContentEventListener.idl index 7434fc549da7..02cf799c98f1 100644 --- a/offapi/com/sun/star/ucb/XContentEventListener.idl +++ b/offapi/com/sun/star/ucb/XContentEventListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a listener for events related to <type>XContent</type>s. +/** a listener for events related to XContents. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl index c332ee402292..b06a1b743b37 100644 --- a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl +++ b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl @@ -27,17 +27,17 @@ module com { module sun { module star { module ucb { published interface XContent; published interface XContentIdentifier; -/** A mapping from a (source) set of <type>XContentIdentifier</type>s to +/** A mapping from a (source) set of XContentIdentifiers to another (target) set of XContentIdentifiers. <p>For convenience and performance, mapping between the string representations of source/target XContentIdentifiers, as well as mapping - between <type>XContent</type>s identified by source/target + between XContents identified by source/target XContentIdentifiers is also supported. <p>This interface can be useful in cases where the identifiers (and associated contents) returned by the various methods of an - <type>XContentAccess</type> need to be mapped to some other space of + XContentAccess need to be mapped to some other space of identifiers (and associated contents). @see XContent @@ -47,7 +47,7 @@ module com { module sun { module star { module ucb { published interface XContentIdentifierMapping: com::sun::star::uno::XInterface { - /** Map the string representation of an <type>XContentIdentifier</type>. + /** Map the string representation of an XContentIdentifier. @param Source The string representation of an XContentIdentifier from the source set. @@ -59,7 +59,7 @@ published interface XContentIdentifierMapping: com::sun::star::uno::XInterface */ string mapContentIdentifierString([in] string Source); - /** Map an <type>XContentIdentifier</type>. + /** Map an XContentIdentifier. @param Source An XContentIdentifier from the source set. @@ -70,8 +70,8 @@ published interface XContentIdentifierMapping: com::sun::star::uno::XInterface */ XContentIdentifier mapContentIdentifier([in] XContentIdentifier Source); - /** Map the <type>XContent</type> identified by an - <type>XContentIdentifier</type>. + /** Map the XContent identified by an + XContentIdentifier. @param Source The XContent identified by an XContentIdentifier from the source set. diff --git a/offapi/com/sun/star/ucb/XContentProvider.idl b/offapi/com/sun/star/ucb/XContentProvider.idl index 1f6d8beb5570..96890184c715 100644 --- a/offapi/com/sun/star/ucb/XContentProvider.idl +++ b/offapi/com/sun/star/ucb/XContentProvider.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** a content provider which creates and manages <type>XContent</type>s. +/** a content provider which creates and manages XContents. @version 1.0 @author Kai Sommerfeld @@ -36,8 +36,8 @@ module com { module sun { module star { module ucb { */ published interface XContentProvider: com::sun::star::uno::XInterface { - /** creates a new <type>XContent</type> instance, if the given - <type>XContentIdentifier</type> matches a content provided by the + /** creates a new XContent instance, if the given + XContentIdentifier matches a content provided by the implementation of this interface. @param Identifier @@ -54,7 +54,7 @@ published interface XContentProvider: com::sun::star::uno::XInterface [in] com::sun::star::ucb::XContentIdentifier Identifier ) raises ( com::sun::star::ucb::IllegalIdentifierException ); - /** compares two <type>XContentIdentifier</type>s. + /** compares two XContentIdentifiers. @param Id1 first content identifier. diff --git a/offapi/com/sun/star/ucb/XContentProviderFactory.idl b/offapi/com/sun/star/ucb/XContentProviderFactory.idl index bc399bc6d442..4ffa14f99275 100644 --- a/offapi/com/sun/star/ucb/XContentProviderFactory.idl +++ b/offapi/com/sun/star/ucb/XContentProviderFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a factory for a <type>XContentProvider</type>. +/** a factory for a XContentProvider. @version 1.0 @author Kai Sommerfeld @@ -33,7 +33,7 @@ module com { module sun { module star { module ucb { */ published interface XContentProviderFactory : com::sun::star::uno::XInterface { - /** creates a <type>XContentProvider</type> implementation object. + /** creates a XContentProvider implementation object. @param Service the name of the UNO service to be used to create the implementation of diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 9061770691a2..abfa388c2cbf 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -45,7 +45,7 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface <p>This may be <NULL/>, in which case a later <member>XContentProvider::queryContent</member> with an - <type>XContentIdentifier</type> that matches the <var>Scheme</var> + XContentIdentifier that matches the <var>Scheme</var> will simply return <NULL/>. These "dummy" content providers are useful in combination with other content providers that are registered on a wildcard URL template: For example, imagine that you want to route all @@ -95,8 +95,8 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface match the same URLs as their <code><simple>:</code> counterparts, but they also describe how a (local) URL is mapped to another (remote) URL. This mapping is only relevant for methods of the - <type>RemoteAccessContentProvider</type>'s - <type>XParameterizedContentProvider</type> interface; in all other + RemoteAccessContentProvider's + XParameterizedContentProvider interface; in all other cases, <code><translation>:</code> regexps have the same semantics as their <code><simple>:</code> counterparts. diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index 0f835706042a..ad783c5b7d3b 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -29,33 +29,33 @@ module com { module sun { module star { module ucb { -/** Provides read access to a <type>ContentResultSet</type>. +/** Provides read access to a ContentResultSet. <p> - You can either get a simple static <type>ContentResultSet</type> or you can + You can either get a simple static ContentResultSet or you can listen to change-notifications and than swap from the old to a new - <type>ContentResultSet</type>. + ContentResultSet. </p> <p>The following describes the dynamic use:</p> <p> - <type>XDynamicResultSet</type> provides the possibility to get notifications - about changes on a <type>ContentResultSet</type> and have an + XDynamicResultSet provides the possibility to get notifications + about changes on a ContentResultSet and have an listener-controlled update from one version to the next version. Two - <type>ContentResultSet</type> implementations were given to the listener in + ContentResultSet implementations were given to the listener in the first notification as interface <type scope="com::sun::star::sdbc">XResultSet</type>. </p> <p> To get notifications the listener has to be of type - <type>XDynamicResultSetListener</type>. + XDynamicResultSetListener. </p> <p> After registration you will get notifications for events of type - <type>ListEvent</type>. + ListEvent. </p> <p> @@ -70,7 +70,7 @@ module com { module sun { module star { module ucb { </p> <ol> - <li> The listener is allowed to access both <type>ContentResultSet</type>s, + <li> The listener is allowed to access both ContentResultSets, they must be both valid.</li> <li> It is not allowed to start a second notify-call.</li> <li> All additional things we want to send as notification are to be @@ -84,10 +84,10 @@ module com { module sun { module star { module ucb { <ol> <li> The listener is allowed to access the new - <type>ContentResultSet</type>. The new one is first assigned in the + ContentResultSet. The new one is first assigned in the WELCOME-event and than the ResultSets are always swapped.</li> <li> The listener is not allowed to access the old - <type>ContentResultSet</type>.</li> + ContentResultSet.</li> </ol> */ @@ -97,13 +97,13 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @returns an <type scope="com::sun::star::sdbc">XResultSet</type> that is - implemented as <type>ContentResultSet</type>. Its content will never + implemented as ContentResultSet. Its content will never change. @trows ListenerAlreadySetException if someone already has registered as listener via <member>XDynamicResultSet::setListener</member> or if someone has - established a connection to a <type>CachedDynamicResultSet</type> + established a connection to a CachedDynamicResultSet via <member>XDynamicResultSet::connectToCache</member>. */ com::sun::star::sdbc::XResultSet getStaticResultSet() @@ -123,17 +123,17 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @throws ListenerAlreadySetException if this method is called more than once during the life of the implementation object or if this method is called if someone already - has fetched the <type>ContentResultSet</type> via + has fetched the ContentResultSet via <member>XDynamicResultSet::getStaticResultSet</member>. */ void setListener( [in] XDynamicResultSetListener Listener ) raises( com::sun::star::ucb::ListenerAlreadySetException ); - /** Connects this to a <type>CachedDynamicResultSet</type> for optimized + /** Connects this to a CachedDynamicResultSet for optimized remote data transport. - <p>This method creates a <type>CachedDynamicResultSetStub</type> + <p>This method creates a CachedDynamicResultSetStub and sets it as Source to the given cache. <p>After this method has returned you can and have to use the given @@ -141,11 +141,11 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @param Cache has to be an implementation of the service - <type>CachedDynamicResultSet</type>. In particular it has to support - the interface <type>XSourceInitialization</type>. + CachedDynamicResultSet. In particular it has to support + the interface XSourceInitialization. @throws ListenerAlreadySetException - if if someone already has fetched the <type>ContentResultSet</type> via + if if someone already has fetched the ContentResultSet via <member>XDynamicResultSet::getStaticResultSet</member>. @throws AlreadyInitializedException @@ -159,11 +159,11 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent , com::sun::star::ucb::ServiceNotFoundException ); /** Using this method you can get information, whether the offered - <type>ContentResultSet</type>s are sorted or filtered etc correctly as - demanded during the creation of the <type>XDynamicResultSet</type>. + ContentResultSets are sorted or filtered etc correctly as + demanded during the creation of the XDynamicResultSet. @returns - zero or more constants of the <type>ContentResultSetCapability</type> + zero or more constants of the ContentResultSetCapability constants group. */ short getCapabilities(); diff --git a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl index e06e107aa7bb..77f97f00dd4b 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** used to receive notifications from an <type>XDynamicResultSet</type>. +/** used to receive notifications from an XDynamicResultSet. */ published interface XDynamicResultSetListener: com::sun::star::lang::XEventListener @@ -35,7 +35,7 @@ published interface XDynamicResultSetListener: com::sun::star::lang::XEventListe <p>In the first notify-call the listener gets two(!) <type scope="com::sun::star::sdbc">XResultSet</type>s and has to hold them. The <type scope="com::sun::star::sdbc">XResultSet</type>s are - implementations of the service <type>ContentResultSet</type>. + implementations of the service ContentResultSet. <p>The notified new <type scope="com::sun::star::sdbc">XResultSet</type> will stay valid diff --git a/offapi/com/sun/star/ucb/XFetchProvider.idl b/offapi/com/sun/star/ucb/XFetchProvider.idl index d790b53917cb..64a24245b6dd 100644 --- a/offapi/com/sun/star/ucb/XFetchProvider.idl +++ b/offapi/com/sun/star/ucb/XFetchProvider.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** provides the possibility to get the contents of the columns of several - rows of a <type>ContentResultSet</type> with a single function call. + rows of a ContentResultSet with a single function call. */ published interface XFetchProvider: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl index 59ace22f74de..cd39c388df44 100644 --- a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl +++ b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module ucb { /** provides the possibility to load information offered by a - <type>XContentAccess</type> for several rows of a - <type>ContentResultSet</type> with a single function call. + XContentAccess for several rows of a + ContentResultSet with a single function call. */ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface { @@ -54,12 +54,12 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf , [in] long nRowCount , [in] boolean bDirection ); - /** returns the <type>XContentIdentifier</type>s of the columns of the + /** returns the XContentIdentifiers of the columns of the indicated rows @returns <member>FetchResult::Rows</member> contains a sequence of anys. Each - of these anys contains an <type>XContentIdentifier</type>. + of these anys contains an XContentIdentifier. @param nRowStartPosition the starting row of the result set @@ -81,7 +81,7 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf @returns <member>FetchResult::Rows</member> contains a sequence of anys. Each - of these anys contains an <type>XContent</type>. + of these anys contains an XContent. @param nRowStartPosition the starting row of the result set diff --git a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl index 83f5cac68353..32946dabfa8e 100644 --- a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl +++ b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** This interface should be implemented by an internal - <type>XCommandEnvironment</type> that can not supply an + XCommandEnvironment that can not supply an <type scope="com::sun::star::task">XInteractionHandler</type>, but instead wants interaction requests to be handled by other internal error handling mechanism. diff --git a/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl b/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl index e160195101f8..e5e568d5eaba 100644 --- a/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl +++ b/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { existing data. <p>For example, this continuation can be selected when handling a - <type>NameClashResolveRequest</type> in order to instruct the requester + NameClashResolveRequest in order to instruct the requester to overwrite the clashing data. @version 1.0 diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index 96c90829ca75..3ccc8b8bd828 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** An interaction continuation handing back some authentication data. <p> This continuation is typically used in conjunction with - <type>AuthenticationRequest</type>. </p> + AuthenticationRequest. </p> */ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionContinuation { diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl index 090343fb8dad..c775f37f065e 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** An interaction continuation handing back some authentication data. <p> This continuation is typically used in conjunction with - <type>AuthenticationRequest</type>. </p> + AuthenticationRequest. </p> @since OOo 3.2 */ diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyName.idl b/offapi/com/sun/star/ucb/XInteractionSupplyName.idl index a5d7f0fba933..97eef6d613bf 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyName.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyName.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { /** is an interaction continuation used to hand back a new name for something. <p>For example, this continuation can be selected when handling a - <type>NameClashResolveRequest</type> in order to supply a new name + NameClashResolveRequest in order to supply a new name for a clashing resource. @version 1.0 diff --git a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl index 45d5c9c85649..7c9f66e8170b 100644 --- a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl +++ b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl @@ -42,7 +42,7 @@ published interface XParameterizedContentProvider: com::sun::star::uno::XInterfa complex, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. @param Arguments Any supplementary arguments required by this - <type>XContentProvider</type>, represented as a single string. If the + XContentProvider, represented as a single string. If the input is malformed, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. @@ -53,12 +53,12 @@ published interface XParameterizedContentProvider: com::sun::star::uno::XInterfa already registered instance, the new registration is not performed, and null is returned. - @return Either this <type>XContentProvider</type>, or another, - specially adjusted version of this <type>XContentProvider</type> (this + @return Either this XContentProvider, or another, + specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if the given Template conflicts with an already registered instance and ReplaceExisting is false. Note that the returned - <type>XContentProvider</type> must still be registered at the content + XContentProvider must still be registered at the content provider manager! */ com::sun::star::ucb::XContentProvider @@ -73,16 +73,16 @@ published interface XParameterizedContentProvider: com::sun::star::uno::XInterfa complex, an IllegalArgumentException may be raised. @param Arguments Any supplementary arguments required by this - <type>XContentProvider</type>, represented as a single string. If the + XContentProvider, represented as a single string. If the input is malformed, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. - @return Either this <type>XContentProvider</type>, or another, - specially adjusted version of this <type>XContentProvider</type> (this + @return Either this XContentProvider, or another, + specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if no instance is registered for the given Template. Note that the - returned <type>XContentProvider</type> must still be deregistered at + returned XContentProvider must still be deregistered at the content provider manager! */ com::sun::star::ucb::XContentProvider diff --git a/offapi/com/sun/star/ucb/XPersistentPropertySet.idl b/offapi/com/sun/star/ucb/XPersistentPropertySet.idl index 7e4fbf069484..95a1bb099961 100644 --- a/offapi/com/sun/star/ucb/XPersistentPropertySet.idl +++ b/offapi/com/sun/star/ucb/XPersistentPropertySet.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { published interface XPropertySetRegistry; /** A persistent property set, which can be saved in and restored from a - <type>XPropertySetRegistry</type>. + XPropertySetRegistry. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl b/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl index c8b728d56fff..4d3d0fce83d3 100644 --- a/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl +++ b/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { -/** Creates an <type>XPropertyMatcher</type>, given a set of search criteria. +/** Creates an XPropertyMatcher, given a set of search criteria. */ published interface XPropertyMatcherFactory : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/ucb/XRecycler.idl b/offapi/com/sun/star/ucb/XRecycler.idl index 52552214daba..c201153dc98c 100644 --- a/offapi/com/sun/star/ucb/XRecycler.idl +++ b/offapi/com/sun/star/ucb/XRecycler.idl @@ -26,14 +26,14 @@ module com { module sun { module star { module ucb { -/** Allows an <type>XContent</type> to delete itself into the trash can. +/** Allows an XContent to delete itself into the trash can. <p>This is an additional interface the XContent representing the trash can (URL: "vnd.sun.staroffice.trashcan:///") should support. */ published interface XRecycler : com::sun::star::uno::XInterface { - /** Notify the trash can that an <type>XContent</type> is deleting itself + /** Notify the trash can that an XContent is deleting itself into it. @param Properties diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 52dcc97b38c0..2b4f77621fb7 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -42,7 +42,7 @@ published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterf remote content provider. @param Factory A factory through which the remote content provider's - <type>UniversalContentBroker</type> service can be instantiated. + UniversalContentBroker service can be instantiated. @param Templates A sequence of URL templates the remote content provider is willing to handle. @@ -56,7 +56,7 @@ published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterf To enable connection control, it is recommended that this argument also implements the interface - <type>XRemoteContentProviderConnectionControl</type>. + XRemoteContentProviderConnectionControl. @return true if the remote content provider has successfully been added. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl index ffed3ad35d24..a8b96f053f7a 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { published interface XContentProviderManager; /** This interface should be implemented together with - <type>XRemoteContentProviderAcceptor</type> and allows for a lazy + XRemoteContentProviderAcceptor and allows for a lazy implementation of <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. @@ -48,7 +48,7 @@ published interface XRemoteContentProviderActivator: com::sun::star::uno::XInter to be implemented in a lazy fashion (remember the remote content providers, but do not register them right away), which can increase performance in certain situations. But it is not required that an - implementation of <type>XRemoteContentProviderAcceptor</type> uses this + implementation of XRemoteContentProviderAcceptor uses this lazy strategy (and thus also implements this interface). @return diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index 79e90ea33458..16ef09f2c0a6 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { module com { module sun { module star { module ucb { -/** Notify about changes to a <type>XRemoteContentProviderSupplier</type>. +/** Notify about changes to a XRemoteContentProviderSupplier. @version 1.0 @author Stephan Bergmann diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl index ea0066693c83..eff305662462 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** Distribute a content broker to various - <type>XRemoteContentProviderAcceptor</type>s. + XRemoteContentProviderAcceptors. @version 1.0 @author Stephan Bergmann @@ -44,10 +44,10 @@ published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInt which is responsible for raising any of the advertised exceptions. </p> @param Url A Uno Url to address the - <type>XRemoteContentProviderAcceptor</type>. + XRemoteContentProviderAcceptor. @param Identifier An identifier handed to the - <type>XRemoteContentProviderAcceptor</type>. + XRemoteContentProviderAcceptor. @returns success indicator. Especially, if there's already a connection to the given Url, the call will fail, no matter whether @@ -63,7 +63,7 @@ published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInt content provider acceptor. @param Url A Uno Url to address the - <type>XRemoteContentProviderAcceptor</type>. + XRemoteContentProviderAcceptor. @returns success indicator. */ diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl index ee37340d80f2..9df980515a6d 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { published interface XRemoteContentProviderAcceptor; /** A notification mechanism that a - <type>XRemoteContentProviderAcceptor</type> no longer needs a remote + XRemoteContentProviderAcceptor no longer needs a remote content provider. @version 1.0 @@ -36,7 +36,7 @@ module com { module sun { module star { module ucb { published interface XRemoteContentProviderDoneListener: com::sun::star::uno::XInterface { /** A notification that all remote content providers added to the given - <type>XRemoteContentProviderAcceptor</type> should be removed, + XRemoteContentProviderAcceptor should be removed, because the acceptor no longer needs them. @param Acceptor diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl index 16870ef11d6b..378bad360aa5 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module ucb { published interface XRemoteContentProviderSupplier: com::sun::star::uno::XInterface { /** Get a factory through which a remote content provider's - <type>UniversalContentBroker</type> service can be instantiated. + UniversalContentBroker service can be instantiated. @param Identifier An arbitrary identifier uniquely identifying a remote content provider. diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index 39aeb2711abc..d343f7f70416 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -190,7 +190,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface An XOutputStream, if the file can be opened for writing @throws - <type>UnsupportedDataSinkException</type>, if the file cannot be + UnsupportedDataSinkException, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources <member>XSimpleFileAccess2::writeFile</member> may be used. @@ -207,7 +207,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface An XStream, if the file can be opened for reading and writing @throws - <type>UnsupportedDataSinkException</type>, if the file cannot be + UnsupportedDataSinkException, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources <member>XSimpleFileAccess2::writeFile</member> may be used. diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl index fa025b721f13..71de89dd2963 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** This is an extension to the interface <type>XSimpleFileAccess</type>. +/** This is an extension to the interface XSimpleFileAccess. */ published interface XSimpleFileAccess2 : com::sun::star::ucb::XSimpleFileAccess { diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl index cd3cc7b6b3ef..99c27688a4b1 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** This is an extension to the interface <type>XSimpleFileAccess2</type>. +/** This is an extension to the interface XSimpleFileAccess2. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl index 8cef589e9365..7ec634e896ce 100644 --- a/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module ucb { -/** Provides a method to create an <type>XDynamicResultSet</type> which +/** Provides a method to create an XDynamicResultSet which will be sorted according to the given sorting options. */ published interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface { - /** creates a sorted <type>XDynamicResultSet</type> depending on internal + /** creates a sorted XDynamicResultSet depending on internal data, an (unsorted) XDynamicResultSet and the sorting info. @returns diff --git a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl index 29d364692134..20a38f589097 100644 --- a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl @@ -66,7 +66,7 @@ published interface XUniversalContentBroker */ interface com::sun::star::ucb::XContentProviderManager; - /** creates <type>XContentIdentifier</type> implementation objects for + /** creates XContentIdentifier implementation objects for all kind of contents provided by the UCB. <p>This interface is required. @@ -75,7 +75,7 @@ published interface XUniversalContentBroker /** Enables the caller to execute commands at the broker. - Is an enhanced version of <type>XCommandProcessor</type> that has an + Is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to @@ -100,7 +100,7 @@ published interface XUniversalContentBroker // This command obtains an interface which allows to query // information on commands supported by the Content Broker. - <type>XCommandInfo</type> + XCommandInfo getCommandInfo void @@ -109,12 +109,12 @@ published interface XUniversalContentBroker // The implementation must be able to handle Contents provided // by any Content Provider. This is different from the command // "transfer" that can be supported by a Content. That command - // typically can only handle <type>Content</type>s provided by one - // <type>ContentProvider</type>. + // typically can only handle Contents provided by one + // ContentProvider. void globalTransfer - <type>GlobalTransferCommandArgument</type> + GlobalTransferCommandArgument </pre> */ diff --git a/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl b/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl index 25ed63146a04..2547aab74216 100644 --- a/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl +++ b/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl @@ -29,8 +29,8 @@ module com { module sun { module star { module ucb { commands. <p>Supply an implementation of this interface together with an - <type>XCommandEnvironment</type> implementation, when executing a command - using <type>XCommandProcessor</type>. + XCommandEnvironment implementation, when executing a command + using XCommandProcessor. */ interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface { |