diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-04-28 00:15:21 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:04 +0200 |
commit | be7f280ea7034a1cb1195a3d27b51d1b9626b905 (patch) | |
tree | 1d4201255666273daff789cf6e722cd9a87f06f8 /udkapi | |
parent | ce36de949df2351ee81ab05d32093372b65e9831 (diff) |
*api: convert <atom>
sed -i 's,<atom>\([^<]\+\)</atom>,`\1`,g'
Change-Id: I530fe998b0c422e83c4324807d42700126bc9883
Diffstat (limited to 'udkapi')
21 files changed, 47 insertions, 47 deletions
diff --git a/udkapi/com/sun/star/beans/IllegalTypeException.idl b/udkapi/com/sun/star/beans/IllegalTypeException.idl index 2a51aed7fb26..9f9c1cf173ce 100644 --- a/udkapi/com/sun/star/beans/IllegalTypeException.idl +++ b/udkapi/com/sun/star/beans/IllegalTypeException.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module beans { /** This exception is thrown to indicate the use of a type which is not appropriate. - <p>This problem can occur, if you use an <atom>any</atom>. </p> + <p>This problem can occur, if you use an `any`. </p> @see PropertyContainer */ published exception IllegalTypeException: com::sun::star::uno::Exception diff --git a/udkapi/com/sun/star/beans/Property.idl b/udkapi/com/sun/star/beans/Property.idl index 7c6a19ff21fc..58588cb8b382 100644 --- a/udkapi/com/sun/star/beans/Property.idl +++ b/udkapi/com/sun/star/beans/Property.idl @@ -57,7 +57,7 @@ published struct Property the property. <p>If the property has multiple types or the type is not - known, <strong>but not an <atom>any</atom></strong>, then + known, <strong>but not an `any`</strong>, then void must be returned.</p> */ type Type; diff --git a/udkapi/com/sun/star/beans/XMultiPropertyStates.idl b/udkapi/com/sun/star/beans/XMultiPropertyStates.idl index 69c6e2e31714..a54945b43fbd 100644 --- a/udkapi/com/sun/star/beans/XMultiPropertyStates.idl +++ b/udkapi/com/sun/star/beans/XMultiPropertyStates.idl @@ -85,7 +85,7 @@ published interface XMultiPropertyStates: com::sun::star::uno::XInterface <p>If no default exists, is not known, or is void, then the return type at the corresponding position in the - sequence returned is <atom>void</atom>. </p> + sequence returned is `void`. </p> @param aPropertyName specifies the names of the properties. All names must be unique. diff --git a/udkapi/com/sun/star/beans/XPropertyState.idl b/udkapi/com/sun/star/beans/XPropertyState.idl index 38bcb09472e6..e844cfc0b923 100644 --- a/udkapi/com/sun/star/beans/XPropertyState.idl +++ b/udkapi/com/sun/star/beans/XPropertyState.idl @@ -101,7 +101,7 @@ published interface XPropertyState: com::sun::star::uno::XInterface the default value of the property with the name PropertyName. <p>If no default exists, is not known or is void, - then the return type is <atom>void</atom>. + then the return type is `void`. @param aPropertyName specifies the name of the property. diff --git a/udkapi/com/sun/star/bridge/XBridgeSupplier.idl b/udkapi/com/sun/star/bridge/XBridgeSupplier.idl index 2ad23a47fa2a..fbdb6f606d8c 100644 --- a/udkapi/com/sun/star/bridge/XBridgeSupplier.idl +++ b/udkapi/com/sun/star/bridge/XBridgeSupplier.idl @@ -39,7 +39,7 @@ provided by the UNO runtime. </p> <p>All objects, whether they are part of the UNO object model or not, - are carried in an <atom>any</atom>. The representation of this object + are carried in an `any`. The representation of this object is heavily model-dependent and has to be specified in the following list: </p> <dl> @@ -48,8 +48,8 @@ struct, sequence, enum, or interface. </dd> <dt>OLE: </dt> - <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems) - or an <atom>unsigned hyper</atom> (on 64-bit systems), which is + <dd>The any carries an `unsigned long` (on 32-bit systems) + or an `unsigned hyper` (on 64-bit systems), which is interpreted as a variant pointer. The any does not control the lifetime of the represented variant. That implies that the caller has the responsibility of freeing the OLE resources represented diff --git a/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl b/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl index 2bb9ca354e93..fb4b2424565b 100644 --- a/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl +++ b/udkapi/com/sun/star/bridge/XBridgeSupplier2.idl @@ -54,7 +54,7 @@ if it is being accessed remotely. </p> <p>All objects, whether they are part of the UNO object model or not, - are carried in an <atom>any</atom>. The representation of this object + are carried in an `any`. The representation of this object is heavily model-dependent and has to be specified in the following list: </p> <dl> @@ -63,8 +63,8 @@ struct, sequence, enum or interface. </dd> <dt>OLE: </dt> - <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems) - or an <atom>unsigned hyper</atom> (on 64-bit systems), which is + <dd>The any carries an `unsigned long` (on 32-bit systems) + or an `unsigned hyper` (on 64-bit systems), which is interpreted as a variant pointer. The any does not control the lifetime of the represented variant. That implies that the caller has the responsibility of freeing the OLE resources represented diff --git a/udkapi/com/sun/star/bridge/oleautomation/Currency.idl b/udkapi/com/sun/star/bridge/oleautomation/Currency.idl index 6186f7f530e9..f9bbcf91ee84 100644 --- a/udkapi/com/sun/star/bridge/oleautomation/Currency.idl +++ b/udkapi/com/sun/star/bridge/oleautomation/Currency.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module bridge { module oleautomation /** is the UNO representation of the Automation type <code>CY</code>, also know as <code>CURRENCY</code>. <p> - A <code>CY</code> could actually be represented as <atom>hyper</atom> in UNO - and therefore a typedef from <atom>hyper</atom> to a currency type would do. + A <code>CY</code> could actually be represented as `hyper` in UNO + and therefore a typedef from `hyper` to a currency type would do. But a typedef cannot be expressed in all language bindings. In the case where no typedefs are supported the actual type is used. That is, a typedef'd currency type would be represented as <code>long</code> in Java. @@ -34,7 +34,7 @@ module com { module sun { module star { module bridge { module oleautomation </p> <p> When calling Automation objects from UNO the distinction between - <atom>hyper</atom> and a currency type is important. Therefore + `hyper` and a currency type is important. Therefore Currency is declared as struct. </p> diff --git a/udkapi/com/sun/star/bridge/oleautomation/Date.idl b/udkapi/com/sun/star/bridge/oleautomation/Date.idl index acc05d3e70ae..b65556a3b9d6 100644 --- a/udkapi/com/sun/star/bridge/oleautomation/Date.idl +++ b/udkapi/com/sun/star/bridge/oleautomation/Date.idl @@ -24,16 +24,16 @@ module com { module sun { module star { module bridge { module oleautomation /** is the UNO representation of the Automation type <code>DATE</code>. <p> - A <code>DATE</code> could actually be representd as<atom>double</atom> in - UNO and therefore a typedef from <atom>double</atom> to a date type would + A <code>DATE</code> could actually be representd as`double` in + UNO and therefore a typedef from `double` to a date type would do. But a typedef cannot be expressed in all language bindings. In the case where no typedefs are supported the actual type is used. That is, a typedef'd date type would be represented as <code>double</code> in Java. - The information that the <atom>double</atom> is a date type is lost. + The information that the `double` is a date type is lost. </p> <p> When calling Automation objects from UNO the distinction between - <atom>double</atom> and date type is important. Therefore Date + `double` and date type is important. Therefore Date is declared as struct. </p> diff --git a/udkapi/com/sun/star/bridge/oleautomation/SCode.idl b/udkapi/com/sun/star/bridge/oleautomation/SCode.idl index 4df11b61aefa..5791d9ddb7fb 100644 --- a/udkapi/com/sun/star/bridge/oleautomation/SCode.idl +++ b/udkapi/com/sun/star/bridge/oleautomation/SCode.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module bridge { module oleautomation </p> <p> A <code>SCODE</code> is used to express errors in Automation. - In UNO it could be represented by a <atom>long</atom> and therefore a typedef - from <atom>long</atom> to a particular error type would do. But a typedef + In UNO it could be represented by a `long` and therefore a typedef + from `long` to a particular error type would do. But a typedef cannot be expressed in all language bindings. In the case where no typedefs are supported the actual type is used. That is, a typedef'd error type would be represented as <code>int</code> in Java. The information that the @@ -35,7 +35,7 @@ module com { module sun { module star { module bridge { module oleautomation </p> <p> When calling Automation objects from UNO the distinction between error type - and <atom>long</atom> is important. Therefore the Scode is + and `long` is important. Therefore the Scode is declared as struct. </p> diff --git a/udkapi/com/sun/star/container/XElementAccess.idl b/udkapi/com/sun/star/container/XElementAccess.idl index a37c21448b07..a171cbf1110f 100644 --- a/udkapi/com/sun/star/container/XElementAccess.idl +++ b/udkapi/com/sun/star/container/XElementAccess.idl @@ -34,7 +34,7 @@ published interface XElementAccess: com::sun::star::uno::XInterface { /** @returns - the type of the elements. <atom>void</atom> means that it is a + the type of the elements. `void` means that it is a multi-type container and you cannot determine the exact types with this interface. */ diff --git a/udkapi/com/sun/star/java/XJavaVM.idl b/udkapi/com/sun/star/java/XJavaVM.idl index 43d141b7eb1a..8831f7f0f201 100644 --- a/udkapi/com/sun/star/java/XJavaVM.idl +++ b/udkapi/com/sun/star/java/XJavaVM.idl @@ -41,35 +41,35 @@ published interface XJavaVM: com::sun::star::uno::XInterface <p>If the VM is not already instantiated, it will be now.</p> <p>If the <code>processID</code> is a normal 16-byte ID, the returned - <atom>any</atom> contains a JNI <code>JavaVM</code> pointer as a - <atom>long</atom> or <atom>hyper</atom> integer (depending on the + `any` contains a JNI <code>JavaVM</code> pointer as a + `long` or `hyper` integer (depending on the platform). If the <code>processID</code> does not match the current process, or if the VM cannot be instantiated for whatever reason, a - <void/> <atom>any</atom> is returned.</p> + <void/> `any` is returned.</p> <p>If the <code>processID</code> has an additional 17th byte of - value <code>0</code>, the returned <atom>any</atom> contains a + value <code>0</code>, the returned `any` contains a non–reference-counted pointer to a (reference-counted) instance of the C++ <code>jvmaccess::VirtualMachine</code> class, always represented - as a <atom>hyper</atom> integer. The pointer is guaranteed to be valid + as a `hyper` integer. The pointer is guaranteed to be valid as long as the reference to this com::sun::star::java::XJavaVM is valid (but the pointer should be converted into a reference-counted reference as soon as possible). Again, if the first 16 bytes of the <code>processID</code> do not match the current process, or if the VM - cannot be instantiated for whatever reason, a <void/> <atom>any</atom> + cannot be instantiated for whatever reason, a <void/> `any` is returned.</p> <p>If the <code>processID</code> has an additional 17th byte of - value <code>1</code>, the returned <atom>any</atom> contains a + value <code>1</code>, the returned `any` contains a non–reference-counted pointer to a (reference-counted) instance of the C++ <code>jvmaccess::UnoVirtualMachine</code> class, always - represented as a <atom>hyper</atom> integer. The pointer is guaranteed + represented as a `hyper` integer. The pointer is guaranteed to be valid as long as the reference to this com::sun::star::java::XJavaVM is valid. Again, if the first 16 bytes of the <code>processID</code> do not match the current process, or if the VM cannot be instantiated for whatever - reason, a <void/> <atom>any</atom> is returned.</p> + reason, a <void/> `any` is returned.</p> <p>The first form (returning a JNI <code>JavaVM</code> pointer) is mainly for backwards compatibility, new code should use the second form @@ -90,8 +90,8 @@ published interface XJavaVM: com::sun::star::uno::XInterface of value <code>0</code> or <code>1</code>. @return - On success, the <atom>any</atom> contains a pointer represented as - <atom>long</atom> or <atom>hyper</atom>, otherwise the <atom>any</atom> + On success, the `any` contains a pointer represented as + `long` or `hyper`, otherwise the `any` is <void/>. */ any getJavaVM( [in] sequence<byte> processID ); diff --git a/udkapi/com/sun/star/reflection/XParameter.idl b/udkapi/com/sun/star/reflection/XParameter.idl index 935dbcf4c7e3..69dfe890038b 100644 --- a/udkapi/com/sun/star/reflection/XParameter.idl +++ b/udkapi/com/sun/star/reflection/XParameter.idl @@ -39,7 +39,7 @@ interface XParameter: XMethodParameter { <p>A rest parameter must always come last in a parameter list.</p> <p>Currently, only service constructors can have rest parameters, and - those rest parameters must be in parameters of type <atom>any</atom>.</p> + those rest parameters must be in parameters of type `any`.</p> @return <TRUE/> if and only if this parameter is a rest parameter */ diff --git a/udkapi/com/sun/star/reflection/XServiceConstructorDescription.idl b/udkapi/com/sun/star/reflection/XServiceConstructorDescription.idl index 6f43537c93d0..6c7fa3987796 100644 --- a/udkapi/com/sun/star/reflection/XServiceConstructorDescription.idl +++ b/udkapi/com/sun/star/reflection/XServiceConstructorDescription.idl @@ -44,7 +44,7 @@ interface XServiceConstructorDescription { Returns the constructor's name. @return the constructor's name; for a default constructor, an empty - <atom>string</atom> is returned + `string` is returned */ string getName(); diff --git a/udkapi/com/sun/star/script/XDefaultMethod.idl b/udkapi/com/sun/star/script/XDefaultMethod.idl index fe86064f10ed..e60e675750bf 100644 --- a/udkapi/com/sun/star/script/XDefaultMethod.idl +++ b/udkapi/com/sun/star/script/XDefaultMethod.idl @@ -40,7 +40,7 @@ interface XDefaultMethod : ::com::sun::star::uno::XInterface Returns the name of the default method @return - The <atom>string</atom> name of default method + The `string` name of default method */ string getDefaultMethodName(); diff --git a/udkapi/com/sun/star/script/XDefaultProperty.idl b/udkapi/com/sun/star/script/XDefaultProperty.idl index 2647d7d9389f..beb98210fe85 100644 --- a/udkapi/com/sun/star/script/XDefaultProperty.idl +++ b/udkapi/com/sun/star/script/XDefaultProperty.idl @@ -44,7 +44,7 @@ interface XDefaultProperty : ::com::sun::star::uno::XInterface Returns the name of the default property @return - The <atom>string</atom> name of default property + The `string` name of default property */ string getDefaultPropertyName(); diff --git a/udkapi/com/sun/star/script/XErrorQuery.idl b/udkapi/com/sun/star/script/XErrorQuery.idl index 5d36f48740ef..fe07c73c64eb 100644 --- a/udkapi/com/sun/star/script/XErrorQuery.idl +++ b/udkapi/com/sun/star/script/XErrorQuery.idl @@ -30,7 +30,7 @@ interface XErrorQuery : ::com::sun::star::uno::XInterface Returns whether this object has an error @return - <atom>boolean</atom> indicating an error or not + `boolean` indicating an error or not */ boolean hasError(); diff --git a/udkapi/com/sun/star/task/XInteractionRequest.idl b/udkapi/com/sun/star/task/XInteractionRequest.idl index 673a82c2c6fa..a1bc790614cc 100644 --- a/udkapi/com/sun/star/task/XInteractionRequest.idl +++ b/udkapi/com/sun/star/task/XInteractionRequest.idl @@ -35,7 +35,7 @@ published interface XInteractionRequest: com::sun::star::uno::XInterface @returns an com::sun::star::uno::Exception, wrapped as an - <atom>any</atom>. + `any`. */ any getRequest(); diff --git a/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTexpand.idl b/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTexpand.idl index ac9e4425cbbb..d146d91a80fd 100644 --- a/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTexpand.idl +++ b/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTexpand.idl @@ -30,7 +30,7 @@ published interface XUriSchemeParser; <p>The argument <code>scheme</code> of method com::sun::star::uri::XUriSchemeParser::parse() must - always be equal to the <atom>string</atom> + always be equal to the `string` <code>"vnd.sun.star.expand"</code>, ignoring case. The objects returned by com::sun::star::uri::XUriSchemeParser::parse() implement diff --git a/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTscript.idl b/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTscript.idl index e23b584ec445..861be045cc77 100644 --- a/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTscript.idl +++ b/udkapi/com/sun/star/uri/UriSchemeParser_vndDOTsunDOTstarDOTscript.idl @@ -30,7 +30,7 @@ published interface XUriSchemeParser; <p>The argument <code>scheme</code> of method com::sun::star::uri::XUriSchemeParser::parse() must - always be equal to the <atom>string</atom> + always be equal to the `string` <code>"vnd.sun.star.script"</code>, ignoring case. The objects returned by com::sun::star::uri::XUriSchemeParser::parse() implement diff --git a/udkapi/com/sun/star/uri/XUriReference.idl b/udkapi/com/sun/star/uri/XUriReference.idl index 54f4e2fd8650..5a555fc6256b 100644 --- a/udkapi/com/sun/star/uri/XUriReference.idl +++ b/udkapi/com/sun/star/uri/XUriReference.idl @@ -65,7 +65,7 @@ published interface XUriReference: com::sun::star::uno::XInterface { @returns the textual representation of the scheme part (with the exact spelling retained; without the delimiting “<code>:</code>”), if this - is an absolute URI reference; otherwise, an empty <atom>string</atom> is + is an absolute URI reference; otherwise, an empty `string` is returned. */ string getScheme(); @@ -111,7 +111,7 @@ published interface XUriReference: com::sun::star::uno::XInterface { @returns the textual representation of the authority part (with the exact spelling retained), if this is a hierarchical URI reference that has an authority - part; otherwise, an empty <atom>string</atom> is returned. + part; otherwise, an empty `string` is returned. */ string getAuthority(); @@ -161,7 +161,7 @@ published interface XUriReference: com::sun::star::uno::XInterface { spelling retained, without any delimiting “<code>/</code>”), if this URI reference is hierarchical and has that many path segments; otherwise, and in particular if <code>index</code> is negative, an empty - <atom>string</atom> is returned. + `string` is returned. */ string getPathSegment([in] long index); @@ -180,7 +180,7 @@ published interface XUriReference: com::sun::star::uno::XInterface { the textual representation of the query part (with the exact spelling retained; without the delimiting “<code>?</code>”), if this is a hierarchical URI reference that has a query part; otherwise, an - empty <atom>string</atom> is returned. + empty `string` is returned. */ string getQuery(); @@ -199,7 +199,7 @@ published interface XUriReference: com::sun::star::uno::XInterface { the textual representation of the fragment part (with the exact spelling retained; without the delimiting “<code>#</code>”), if this is a URI reference that has a fragment part; otherwise, an empty - <atom>string</atom> is returned. + `string` is returned. */ string getFragment(); diff --git a/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl b/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl index d4bf276e58e3..6a55b5155955 100644 --- a/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl +++ b/udkapi/com/sun/star/uri/XVndSunStarScriptUrl.idl @@ -86,7 +86,7 @@ published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface { @returns <TRUE/> if this URL has at least one parameter with the given key. In - particular, if <code>key</code> is an empty <atom>string</atom>, <FALSE/> + particular, if <code>key</code> is an empty `string`, <FALSE/> is returned. */ boolean hasParameter([in] string key); @@ -100,7 +100,7 @@ published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface { @returns the non-escaped value of the first parameter with the given key. If there is no parameter with the given key, or if <code>key</code> is an - empty <atom>string</atom>, an empty <atom>string</atom> is returned. + empty `string`, an empty `string` is returned. */ string getParameter([in] string key); |