diff options
Diffstat (limited to 'offapi/com/sun/star/ucb')
38 files changed, 94 insertions, 94 deletions
diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 5f5a57e5386a..fc045394fcff 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -51,7 +51,7 @@ published service CachedDynamicResultSet with a source object. <p>The <var>Source</var> in - <member>XSourceInitialization::setSource</member> has to be an + XSourceInitialization::setSource() has to be an implementation of service CachedDynamicResultSetStub <p>This interface is required. diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 80c7fcd06f82..49c0bae01a21 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -52,7 +52,7 @@ published service CachedDynamicResultSetStub with a source object. <p>The <var>Source</var> in - <member>XSourceInitialization::setSource</member> has to be an + XSourceInitialization::setSource() has to be an implementation of service DynamicResultSet <p>This interface is required. diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index aafe79867ac9..745fd68b8258 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -826,9 +826,9 @@ published service Content /** is an enhanced version of <type>XCommandProcessor</type> that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index e8b2d16a2650..f10c8527ba3d 100644 --- a/offapi/com/sun/star/ucb/ContentInfo.idl +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -36,7 +36,7 @@ published struct ContentInfo <p>This is an implementation specific string characterizing the kind of a content (e.g. "application/vnd.sun.star.hierarchy-link"). The value of this member should match the value returned by - <member>XContent::getContentType</member> of an appropriate content. + XContent::getContentType() of an appropriate content. */ string Type; @@ -56,7 +56,7 @@ published struct ContentInfo /** This field contains a list with the properties which must be set at a content that was just created using - <member>XContentCreator::createNewContent</member> before it can be + XContentCreator::createNewContent() before it can be committed (by executing the command "insert" at the new content). <p>If one of the properties is missing, the insert command will fail. diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl index 257cf6bad600..27328f3ef949 100644 --- a/offapi/com/sun/star/ucb/ContentProvider.idl +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -49,7 +49,7 @@ published service ContentProvider <p>Whenever a ContentProvider that supports this interface is registered at a XContentProviderManager, the method - <member>XParameterizedContentProvider::registerInstance</member> + XParameterizedContentProvider::registerInstance() should first be called, using the returned XContentProvider to register at the XContentProviderManager. */ diff --git a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl index 9eb21e5d6f02..8e5ff313a62c 100644 --- a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl +++ b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is thrown by <member>XCommandProcessor::execute</member> to indicate that +/** is thrown by XCommandProcessor::execute() to indicate that the same command identifier was used for two threads. <p>Each thread must use it's own command identifier, which must be obtained diff --git a/offapi/com/sun/star/ucb/FTPContent.idl b/offapi/com/sun/star/ucb/FTPContent.idl index 70d5af32e4a6..166a1d1a6b25 100644 --- a/offapi/com/sun/star/ucb/FTPContent.idl +++ b/offapi/com/sun/star/ucb/FTPContent.idl @@ -65,7 +65,7 @@ published service FTPContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new directories is "application/vnd.sun.staroffice.ftp-folder". To create a new file use the type "application/vnd.sun.staroffice.ftp-file". diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index d42f1e7258e1..06a9181fbf1b 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { /** contains data of several rows of a ContentResultSet. - <p>This struct is returned from <member>XFetchProvider::fetch</member>, + <p>This struct is returned from XFetchProvider::fetch(), for example. */ diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index 69e61a477dff..2e9809bdbe93 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -66,7 +66,7 @@ published service FileContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new directories is "application/vnd.sun.staroffice.fsys-folder". To create a new file use the type "application/vnd.sun.staroffice.fsys-file". @@ -177,9 +177,9 @@ published service FileContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/HelpContent.idl b/offapi/com/sun/star/ucb/HelpContent.idl index 42f5422fc88b..7047c61dded0 100644 --- a/offapi/com/sun/star/ucb/HelpContent.idl +++ b/offapi/com/sun/star/ucb/HelpContent.idl @@ -128,9 +128,9 @@ published service HelpContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index e10b15bd9b35..2f6c5b87bb47 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -106,9 +106,9 @@ published service HierarchyFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -151,7 +151,7 @@ published service HierarchyFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.hier-folder". To create a new link, use the type "application/vnd.sun.star.hier-link". </li> diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 6c29f90f669b..a72cf7c667d0 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -104,9 +104,9 @@ published service HierarchyLinkContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index 5db0ee493b49..e0483ebac3f5 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -104,9 +104,9 @@ published service HierarchyRootFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -149,7 +149,7 @@ published service HierarchyRootFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.hier-folder". To create a new link, use the type "application/vnd.sun.star.hier-link". </li> diff --git a/offapi/com/sun/star/ucb/ODMAContent.idl b/offapi/com/sun/star/ucb/ODMAContent.idl index 3ba646259497..5f1a11ea1717 100644 --- a/offapi/com/sun/star/ucb/ODMAContent.idl +++ b/offapi/com/sun/star/ucb/ODMAContent.idl @@ -124,9 +124,9 @@ published service ODMAContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 0a2f157f877e..c38350b07dcd 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -119,9 +119,9 @@ published service PackageFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -164,7 +164,7 @@ published service PackageFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.pkg-folder". To create a new PCP Stream, use the type "application/vnd.sun.star.pkg-stream". diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 3d67c7f6bc74..f3a1c39020e7 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -119,9 +119,9 @@ published service PackageStreamContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/PersistentPropertySet.idl b/offapi/com/sun/star/ucb/PersistentPropertySet.idl index d6e829b62e1e..212f87cb2218 100644 --- a/offapi/com/sun/star/ucb/PersistentPropertySet.idl +++ b/offapi/com/sun/star/ucb/PersistentPropertySet.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { /** This service contains the interfaces to implement by objects - returned by <member>XPropertySetRegistry::openPropertySet</member>. + returned by XPropertySetRegistry::openPropertySet(). */ published service PersistentPropertySet { diff --git a/offapi/com/sun/star/ucb/PropertySetRegistry.idl b/offapi/com/sun/star/ucb/PropertySetRegistry.idl index 15a5c868f688..54f21471d9ba 100644 --- a/offapi/com/sun/star/ucb/PropertySetRegistry.idl +++ b/offapi/com/sun/star/ucb/PropertySetRegistry.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** This service contains the interfaces to implement by objects - returned by <member>XPropertySetRegistryFactory::createRegistry</member>. + returned by XPropertySetRegistryFactory::createRegistry(). */ published service PropertySetRegistry { diff --git a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl index 17a4d16d653e..0a50ea3c016f 100644 --- a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl @@ -40,7 +40,7 @@ published service RemoteAccessContentProvider to specify that certain XContentIdentifiers map to XContents from a certain remote UCB. The Arguments string in the - <member>XParameterizedContentProvider::registerInstance</member> + XParameterizedContentProvider::registerInstance() call must contain the UNO URL of the remote UCB. @descr diff --git a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl index 4363c8504e32..7f9969019419 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl @@ -108,9 +108,9 @@ service TransientDocumentsDocumentContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -150,7 +150,7 @@ service TransientDocumentsDocumentContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.tdoc-folder". To create a new stream, use the type string "application/vnd.sun.star.tdoc-stream". diff --git a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl index 61d9fe53b82b..f9dd69144b52 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl @@ -118,9 +118,9 @@ service TransientDocumentsFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -160,7 +160,7 @@ service TransientDocumentsFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.tdoc-folder". To create a new stream, use the type string "application/vnd.sun.star.tdoc-stream". diff --git a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl index 271c9410626c..a8de4dd6cdb8 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl @@ -103,9 +103,9 @@ service TransientDocumentsRootContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl index 89b95d7fbb05..0382a61a4301 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl @@ -109,9 +109,9 @@ service TransientDocumentsStreamContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index ef3b1eacf91f..495c47866392 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module ucb { does not necessarily mandate what type of data/content may be contained within Documents. The type of data/content is defined by the MediaType property which is different from the content type returned from the - <member>XContent::getContentType</member> method. The MediaType property + XContent::getContentType() method. The MediaType property is mapped to the equivalent WebDAV property and the WebDAV server calculates the value. @@ -124,9 +124,9 @@ published service WebDAVDocumentContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index 0426737b3e4c..0c762a61a26d 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -118,9 +118,9 @@ published service WebDAVFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -163,7 +163,7 @@ published service WebDAVFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.webdav-collection". To create a new DCP Document, use the type "application/http-content". diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 236006e1d639..5696f6a2f434 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module ucb { DynamicResultSet was instantiated. <p>Method - <member>XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub</member> + XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub() can be used to create a stub on server side. <p>If you have instantiated a CachedDynamicResultSet on client diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index 1edf2ca3cea4..dc4e718d5a33 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor.idl @@ -53,15 +53,15 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface only should get one identifier per thread and assign it to every command executed by that thread.</p> - <p>Also, after a call to <member>XCommandProcessor::abort</member>, an + <p>Also, after a call to XCommandProcessor::abort(), an identifier should not be used any longer (and instead be released by a - call to <member>XCommandProcessor2::releaseCommandIdentifier</member>), + call to XCommandProcessor2::releaseCommandIdentifier()), because it may well abort <em>all</em> further calls to - <member>XCommandProcessor::execute</member>.</p> + XCommandProcessor::execute().</p> <p>To avoid ever-increasing resource consumption, the identifier should be released via - <member>XCommandProcessor2::releaseCommandIdentifier</member> + XCommandProcessor2::releaseCommandIdentifier() when it is no longer used.</p> @returns @@ -79,14 +79,14 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface @param CommandId is a unique id for the command. This identifier was obtained by calling - <member>XCommandProcessor::createCommandIdentifier</member>. A value of + XCommandProcessor::createCommandIdentifier(). A value of 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 XCommandProcessor, obtains exactly one identifier - using <member>XCommandProcessor::createCommandIdentifier</member>. + using XCommandProcessor::createCommandIdentifier(). This identifier can be used for every call to - <member>XCommandProcessor::execute</member> done by that thread. + XCommandProcessor::execute() done by that thread. @param Environment is the execution environment. @@ -116,7 +116,7 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface @param CommandId is a unique id for the command to abort. This must be the identifier - passed to <member>XCommandProcessor::execute</member> for the command + passed to XCommandProcessor::execute() for the command to abort. */ void abort( [in] long CommandId ); diff --git a/offapi/com/sun/star/ucb/XCommandProcessor2.idl b/offapi/com/sun/star/ucb/XCommandProcessor2.idl index a1c8585bd735..0ad842e92ff0 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor2.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor2.idl @@ -31,22 +31,22 @@ module com { module sun { module star { module ucb { published interface XCommandProcessor2: com::sun::star::ucb::XCommandProcessor { /** releases a command identifier obtained through - <member>XCommandProcessor::createCommandIdentifier</member> when it is + XCommandProcessor::createCommandIdentifier() when it is no longer used. <p>After this call the command identifier cannot be used any longer in - calls to <member>XCommandProcessor::execute</member> and - <member>XCommandProcessor::abort</member>. (But it can happen that a - call to <member>XCommandProcessor::createCommandIdentifier</member> + calls to XCommandProcessor::execute() and + XCommandProcessor::abort(). (But it can happen that a + call to XCommandProcessor::createCommandIdentifier() reuses this identifier.)</p> @param CommandId A command identifier obtained through - <member>XCommandProcessor::createCommandIdentifier</member>. If the + XCommandProcessor::createCommandIdentifier(). If the identifier is zero, the request is silently ignored; but if the identifier is invalid (not obtained via - <member>XCommandProcessor::createCommandIdentifier</member> or already - handed to <member>XCommandProcessor2::releaseCommandIdentifier</member> + XCommandProcessor::createCommandIdentifier() or already + handed to XCommandProcessor2::releaseCommandIdentifier() before), the behavior is undefined. */ void releaseCommandIdentifier([in] long CommandId); diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 7f30e131a66a..36627b5570d4 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -44,7 +44,7 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface the content provider to register. <p>This may be <NULL/>, in which case a later - <member>XContentProvider::queryContent</member> with an + XContentProvider::queryContent() with an 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 diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index 83091aa88b9c..6fd0d57a10d9 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -59,7 +59,7 @@ module com { module sun { module star { module ucb { </p> <p> - The calling of <member>XDynamicResultSetListener::notify</member> has + The calling of XDynamicResultSetListener::notify() has to happen in an own thread, because it could take a longer time and any actions ??? until the listener returns the call. So don't block the notify-causing action. @@ -102,9 +102,9 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @trows ListenerAlreadySetException if someone already has registered as listener via - <member>XDynamicResultSet::setListener</member> or if someone has + XDynamicResultSet::setListener() or if someone has established a connection to a CachedDynamicResultSet - via <member>XDynamicResultSet::connectToCache</member>. + via XDynamicResultSet::connectToCache(). */ com::sun::star::sdbc::XResultSet getStaticResultSet() raises( com::sun::star::ucb::ListenerAlreadySetException ); @@ -124,7 +124,7 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent 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 ContentResultSet via - <member>XDynamicResultSet::getStaticResultSet</member>. + XDynamicResultSet::getStaticResultSet(). */ void setListener( [in] XDynamicResultSetListener Listener ) @@ -146,7 +146,7 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @throws ListenerAlreadySetException if if someone already has fetched the ContentResultSet via - <member>XDynamicResultSet::getStaticResultSet</member>. + XDynamicResultSet::getStaticResultSet(). @throws AlreadyInitializedException if <var>Cache</var> was already initialized with another source. diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index 3ccc8b8bd828..c5d719b1f048 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -42,7 +42,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetRealm</member> returned + XInteractionSupplyAuthentication::canSetRealm() returned <true/>.</p> */ void setRealm( [in] string Realm ); @@ -56,7 +56,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetUserName</member> + XInteractionSupplyAuthentication::canSetUserName() returned <true/>.</p> */ void setUserName( [in] string UserName ); @@ -70,7 +70,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetPassword</member> + XInteractionSupplyAuthentication::canSetPassword() returned <true/>.</p> */ void setPassword( [in] string Password ); @@ -92,12 +92,12 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::setPassword</member> + XInteractionSupplyAuthentication::setPassword() is also called.</p> @param Remember The mode to hand back, should be contained in the sequence returned by - <member>XInteractionSupplyAuthentication::getRememberPasswordModes</member>. + XInteractionSupplyAuthentication::getRememberPasswordModes(). */ void setRememberPassword( [in] com::sun::star::ucb::RememberAuthentication Remember ); @@ -110,7 +110,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetAccount</member> + XInteractionSupplyAuthentication::canSetAccount() returned <true/>.</p> */ @@ -132,12 +132,12 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::setAccount</member> + XInteractionSupplyAuthentication::setAccount() is also called.</p> @param Remember The mode to hand back, should be contained in the sequence returned by - <member>XInteractionSupplyAuthentication::getRememberAccountModes</member>. + XInteractionSupplyAuthentication::getRememberAccountModes(). */ void setRememberAccount( [in] com::sun::star::ucb::RememberAuthentication Remember ); diff --git a/offapi/com/sun/star/ucb/XProgressHandler.idl b/offapi/com/sun/star/ucb/XProgressHandler.idl index 3bbc55d04b4a..170a8670c65e 100644 --- a/offapi/com/sun/star/ucb/XProgressHandler.idl +++ b/offapi/com/sun/star/ucb/XProgressHandler.idl @@ -35,12 +35,12 @@ published interface XProgressHandler: com::sun::star::uno::XInterface @param Status An object representing the new activity. There has to be an agreement between caller and callee of methods - <member>XProgressHandler::push</member> and - <member>XProgressHandler::update</member> as to which Status + XProgressHandler::push() and + XProgressHandler::update() as to which Status arguments are meaningful. For example, a <atom>string</atom> argument - to <member>XProgressHandler::push</member> should be used to transport + to XProgressHandler::push() should be used to transport some status text that describes the progress being made (possibly - followed by one or more <member>XProgressHandler::update</member>s with + followed by one or more XProgressHandler::update()s with <atom>string</atom> arguments, if the appropriate status text changes as progress is being made). */ @@ -50,7 +50,7 @@ published interface XProgressHandler: com::sun::star::uno::XInterface progress. @param Status An object representing the progress made. See the - documentation of <member>XProgressHandler::push</member> for more + documentation of XProgressHandler::push() for more information. */ void update([in] any Status); diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 2b4f77621fb7..436d1038fad7 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -51,7 +51,7 @@ published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterf can---through this callback---tell the calling side that the implementation no longer needs the remote content provider. (And the calling side should call - <member>XRemoteContentProviderAcceptor::removeRemoteContentProvider</member> + XRemoteContentProviderAcceptor::removeRemoteContentProvider() then.) To enable connection control, it is recommended that this argument diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl index a8b96f053f7a..b68c4bfeb5f5 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** This interface should be implemented together with XRemoteContentProviderAcceptor and allows for a lazy implementation of - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. + XRemoteContentProviderAcceptor::addRemoteContentProvider(). The way this works might change, therefore this interface is marked as deprecated. @@ -40,11 +40,11 @@ published interface XRemoteContentProviderActivator: com::sun::star::uno::XInter { /** Activate (i.e., register at the broker) the remote content providers that until now have only been remembered by - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>, + XRemoteContentProviderAcceptor::addRemoteContentProvider(), but not registered. <p>This allows for - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member> + XRemoteContentProviderAcceptor::addRemoteContentProvider() 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 diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index 16ef09f2c0a6..e06ef8085e42 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -49,7 +49,7 @@ published interface XRemoteContentProviderChangeNotifier: @param Listener. Some listener previously added via - <member>XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener</member>. + XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener(). */ void removeRemoteContentProviderChangeListener( diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl index e74fe21af5c4..daecd63f8cc7 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module ucb { <p>This interface should be supported by the <var>DoneListener</var> parameter of - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. + XRemoteContentProviderAcceptor::addRemoteContentProvider(). @version 1.0 @author Stephan Bergmann diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index d7a11dcb74db..974f4eee0591 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -193,7 +193,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface 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. + XSimpleFileAccess2::writeFile() may be used. */ com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); @@ -210,7 +210,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface 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. + XSimpleFileAccess2::writeFile() may be used. */ com::sun::star::io::XStream openFileReadWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); diff --git a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl index 20a38f589097..4d971316243b 100644 --- a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl @@ -77,9 +77,9 @@ published interface XUniversalContentBroker Is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>This interface is required. |