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/deployment | |
parent | include: convert <type> here too (diff) | |
download | core-944eb9902788d8afec9e3f0f65d3b680041e039b.tar.gz core-944eb9902788d8afec9e3f0f65d3b680041e039b.zip |
*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/deployment')
13 files changed, 46 insertions, 46 deletions
diff --git a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl index 329874eb2a52..f619aed600e3 100644 --- a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl +++ b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl @@ -29,18 +29,18 @@ interface XPackage; /** indicates that <member>XPackageRegistry::bindPackage</member> was previously called with a different value for the <code>removed</code> parameter and that - the <type>XPackage</type> object created by that call still exist. + the XPackage object created by that call still exist. @since OOo 3.3 */ exception InvalidRemovedParameterException: com::sun::star::uno::Exception { /** the value of the <code>removed</code> parameter which was used in <member>XPackageRegistry::bindPackage</member> to create the currently - existing <type>XPackage</type> object. + existing XPackage object. */ boolean PreviousValue; /** - the <type>XPackage</type> that was already bound to the provided + the XPackage that was already bound to the provided <code>url</code> parameter during <member>XPackageRegistry::bindPackage</member>. diff --git a/offapi/com/sun/star/deployment/PackageRegistryBackend.idl b/offapi/com/sun/star/deployment/PackageRegistryBackend.idl index e4c6f2333851..e80419b5c6b8 100644 --- a/offapi/com/sun/star/deployment/PackageRegistryBackend.idl +++ b/offapi/com/sun/star/deployment/PackageRegistryBackend.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module deployment { -/** The <type>PackageRegistryBackend</type> service is used to bind - a specific type of <type>XPackage</type> which can be registered or revoked. +/** The PackageRegistryBackend service is used to bind + a specific type of XPackage which can be registered or revoked. <p> - All <type>PackageRegistryBackend</type> objects - are related to a <type>XPackageManager</type> instance. + All PackageRegistryBackend objects + are related to a XPackageManager instance. </p> @since OOo 2.0 diff --git a/offapi/com/sun/star/deployment/UpdateInformationEntry.idl b/offapi/com/sun/star/deployment/UpdateInformationEntry.idl index f70f6e4b7998..c930d79e3a77 100644 --- a/offapi/com/sun/star/deployment/UpdateInformationEntry.idl +++ b/offapi/com/sun/star/deployment/UpdateInformationEntry.idl @@ -26,7 +26,7 @@ interface XElement; module com { module sun { module star { module deployment { /** Objects of this type are used as elements of the enumeration - returned by <type>XUpdateInformationProvider</type>. + returned by XUpdateInformationProvider. @since OOo 2.3 */ diff --git a/offapi/com/sun/star/deployment/XExtensionManager.idl b/offapi/com/sun/star/deployment/XExtensionManager.idl index a77f716acc98..ffb4e756eba1 100644 --- a/offapi/com/sun/star/deployment/XExtensionManager.idl +++ b/offapi/com/sun/star/deployment/XExtensionManager.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module deployment { -/** The <type>XExtensionManager</type> interface is used to manage extensions +/** The XExtensionManager interface is used to manage extensions in the user, shared and bundled repository. @see ExtensionManager @@ -51,10 +51,10 @@ interface XExtensionManager interface com::sun::star::util::XModifyBroadcaster; - /** gets the supported <type>XPackageTypeInfo</type>s. + /** gets the supported XPackageTypeInfos. @return - supported <type>XPackageTypeInfo</type>s. + supported XPackageTypeInfos. */ sequence<XPackageTypeInfo> getSupportedPackageTypes(); @@ -199,7 +199,7 @@ interface XExtensionManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> object + XPackage object */ XPackage getDeployedExtension( [in] string repository, diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index ef04b73cfabe..2dcf2a9b6751 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module deployment { /** Objects of this interface reflect a bound package and are issued by a - <type>PackageRegistryBackend</type>. + PackageRegistryBackend. @since OOo 2.0 */ @@ -129,7 +129,7 @@ interface XPackage com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException); - /** registers this <type>XPackage</type>. + /** registers this XPackage. NEVER call this directly. This is done by the extension manager if necessary. @@ -153,7 +153,7 @@ interface XPackage com::sun::star::ucb::CommandAbortedException, com::sun::star::lang::IllegalArgumentException); - /** revokes this <type>XPackage</type>. + /** revokes this XPackage. NEVER call this directly. This is done by the extension manager if necessary. @@ -289,7 +289,7 @@ interface XPackage ::com::sun::star::beans::StringPair getPublisherInfo() raises (ExtensionRemovedException); - /** returns the <type>XPackageTypeInfo</type>, e.g. media-type etc. + /** returns the XPackageTypeInfo, e.g. media-type etc. @return media type of package diff --git a/offapi/com/sun/star/deployment/XPackageManager.idl b/offapi/com/sun/star/deployment/XPackageManager.idl index 40fd7f7724b7..65ff863df21d 100644 --- a/offapi/com/sun/star/deployment/XPackageManager.idl +++ b/offapi/com/sun/star/deployment/XPackageManager.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module deployment { -/** The <type>XPackageManager</type> interface is used to add or remove +/** The XPackageManager interface is used to add or remove packages to a specific repository. This interface represents a particular repository. Packages are deployable files, e.g. scripts or UNO components. @@ -48,11 +48,11 @@ module com { module sun { module star { module deployment { </p> <p> All interface methods do neither register nor revoke an extension. - This happens exclusively by <type>XExtensionManager</type>. + This happens exclusively by XExtensionManager. </p> <p> Objects of this interface are created using the - <type>XPackageManagerFactory</type> service resp. the singleton + XPackageManagerFactory service resp. the singleton <code> /singletons/com.sun.star.deployment.thePackageManagerFactory </code>. @@ -61,7 +61,7 @@ module com { module sun { module star { module deployment { @see thePackageManagerFactory @since OOo 2.0 @deprecated - Use <type>XExtensionManager</type>. + Use XExtensionManager. */ interface XPackageManager { @@ -82,10 +82,10 @@ interface XPackageManager */ string getContext(); - /** gets the supported <type>XPackageTypeInfo</type>s. + /** gets the supported XPackageTypeInfos. @return - supported <type>XPackageTypeInfo</type>s. + supported XPackageTypeInfos. */ sequence<XPackageTypeInfo> getSupportedPackageTypes(); @@ -115,7 +115,7 @@ interface XPackageManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage addPackage( [in] string url, [in] sequence<com::sun::star::beans::NamedValue> properties, @@ -141,7 +141,7 @@ interface XPackageManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage importExtension( [in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, @@ -181,7 +181,7 @@ interface XPackageManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage getDeployedPackage( [in] string identifier, @@ -291,7 +291,7 @@ interface XPackageManager The extension must be managed by this package manager, that is, it must be recorded in its database. The package manager calls XPackage::checkPrerequisites and updates its data base with the - result. The result, which is from <type>Prerequisites</type> will be + result. The result, which is from Prerequisites will be returned. */ long checkPrerequisites( diff --git a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl index b81aa7043ada..e54cd53fe41b 100644 --- a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl +++ b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module deployment { -/** The <type>XPackageManagerFactory</type> interface is used to obtain - <type>XPackageManager</type> instances. +/** The XPackageManagerFactory interface is used to obtain + XPackageManager instances. <p> You have to use the singleton <code> @@ -38,12 +38,12 @@ module com { module sun { module star { module deployment { @since OOo 2.0 @deprecated - Use <type>XExtensionManager</type>. + Use XExtensionManager. */ interface XPackageManagerFactory { /** Method to create (or reusing and already existing) - <type>XPackageManager</type> object to add or remove UNO packages + XPackageManager object to add or remove UNO packages persistently. <p> Packages for context strings <code>"user"</code> and @@ -52,7 +52,7 @@ interface XPackageManagerFactory </p> <!-- p> Document contexts (<code>"vnd.sun.star.tdoc:..."</code>) will get a - <type>XPackageManager</type> object that stores packages + XPackageManager object that stores packages in the given document and modify the manifest. </p --> <p> @@ -79,7 +79,7 @@ interface XPackageManagerFactory </li --> </ul> @return - <type>XPackageManager</type> object + XPackageManager object @throws ::com::sun::star::lang::IllegalArgumentException in case of an invalid context */ diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index b9f1f9a781dc..cd7a9e520d7f 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module deployment { */ interface XPackageRegistry { - /** binds a package URL to a <type>XPackage</type> handle. + /** binds a package URL to a XPackage handle. The returned UNO package handle ought to late-initialize itself, thus the process of binding must not be an expensive operation, because it is not abortable. @@ -48,7 +48,7 @@ interface XPackageRegistry may still contain all registration data of that extension, but the actual extension files do not exist anymore. The registration data must then be cleaned of all the remains of that extension. To to that one - creates an <type>XPackage</type> object on behalf of that extension and + creates an XPackage object on behalf of that extension and calls <member>XPackage::revokePakage</member>. The parameter <code>removed</code> indicates this case. The returned object may not rely on the file or folder to which refers <code>url</url>. Instead it @@ -56,7 +56,7 @@ interface XPackageRegistry of this object (<member>XPackage::revokePackage</member>). The implementation must ensure that there is only one instance of - <type>XPackage</type> for the same <code>url</code> at any + XPackage for the same <code>url</code> at any time. Therefore calling <member>bindPackage</member> again with the same <code>url</code> but different <code>mediaType<code> (the exception is, if previously an empty string was provided to cause the determination @@ -64,7 +64,7 @@ interface XPackageRegistry exception. An <type scope="com::sun::star::lang">IllegalArgumentException</type> will be thrown in case of a different <code>mediaType</code> parameter and a - <type>InvalidRemovedParameterException</type> is thrown if the + InvalidRemovedParameterException is thrown if the <code>removed</code> parameter is different. The <code>identifier</code> parameter must be provided when @@ -88,7 +88,7 @@ interface XPackageRegistry @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage bindPackage( [in] string url, @@ -101,10 +101,10 @@ interface XPackageRegistry com::sun::star::ucb::CommandFailedException, com::sun::star::lang::IllegalArgumentException); - /** gets the supported <type>XPackageTypeInfo</type>s. + /** gets the supported XPackageTypeInfos. @return - supported <type>XPackageTypeInfo</type>s. + supported XPackageTypeInfos. */ sequence<XPackageTypeInfo> getSupportedPackageTypes(); diff --git a/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl b/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl index 15ba3614b8fb..aecbe0594ab6 100644 --- a/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl +++ b/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl @@ -91,7 +91,7 @@ interface XUpdateInformationProvider attribute of the atom:category tag matches extensionId are returned. @returns - an enumeration of <type>UpdateInformationEntry</type>. + an enumeration of UpdateInformationEntry. */ com::sun::star::container::XEnumeration getUpdateInformationEnumeration( [in] sequence< string > repositories, diff --git a/offapi/com/sun/star/deployment/thePackageManagerFactory.idl b/offapi/com/sun/star/deployment/thePackageManagerFactory.idl index 4257a60cbeb0..7b9f106d646c 100644 --- a/offapi/com/sun/star/deployment/thePackageManagerFactory.idl +++ b/offapi/com/sun/star/deployment/thePackageManagerFactory.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module deployment { -/** <type>thePackageManagerFactory</type> denotes the one and only - <type>XPackageManagerFactory</type> object to be used. +/** thePackageManagerFactory denotes the one and only + XPackageManagerFactory object to be used. <p> The component context entry is <code> @@ -36,7 +36,7 @@ module com { module sun { module star { module deployment { @since OOo 2.0 @deprecated - Use <type>XExtensionManager</type>. + Use XExtensionManager. */ singleton thePackageManagerFactory : XPackageManagerFactory; diff --git a/offapi/com/sun/star/deployment/ui/LicenseDialog.idl b/offapi/com/sun/star/deployment/ui/LicenseDialog.idl index f1c8f2c842fa..223a3086c1ea 100644 --- a/offapi/com/sun/star/deployment/ui/LicenseDialog.idl +++ b/offapi/com/sun/star/deployment/ui/LicenseDialog.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module deployment { module ui { -/** The <type>LicenseDialog</type> is used to display a license text. +/** The LicenseDialog is used to display a license text. @since OOo 2.0.4 */ diff --git a/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl b/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl index cf8fa6c40f17..1e56b23fb882 100644 --- a/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl +++ b/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module deployment { module ui { -/** The <type>PackageManagerDialog</type> is used to visually manage installed +/** The PackageManagerDialog is used to visually manage installed packages of the user and shared installation as well as currently open documents. diff --git a/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl b/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl index 297fcb6428a0..fba9e4cad5be 100644 --- a/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl +++ b/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module deployment { module ui { -/** The <type>UpdateRequiredDialog</type> is used to show a list of extensions not compatible with this office version. +/** The UpdateRequiredDialog is used to show a list of extensions not compatible with this office version. @since OOo 3.2 */ |