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 /offapi | |
| parent | ce36de949df2351ee81ab05d32093372b65e9831 (diff) | |
*api: convert <atom>
sed -i 's,<atom>\([^<]\+\)</atom>,`\1`,g'
Change-Id: I530fe998b0c422e83c4324807d42700126bc9883
Diffstat (limited to 'offapi')
46 files changed, 143 insertions, 143 deletions
diff --git a/offapi/com/sun/star/animations/XAnimationNode.idl b/offapi/com/sun/star/animations/XAnimationNode.idl index 79078663123c..06b5454cee5a 100644 --- a/offapi/com/sun/star/animations/XAnimationNode.idl +++ b/offapi/com/sun/star/animations/XAnimationNode.idl @@ -40,7 +40,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <br> #Begin is <ul> - <li><atom>double</atom> describes the element begin as an offset in seconds from an implicit syncbase. + <li>`double` describes the element begin as an offset in seconds from an implicit syncbase. The definition of the implicit syncbase depends upon the element's parent time container. The offset is measured in parent simple time.</li> <li>Event describes an event and an optional offset that determine the @@ -61,7 +61,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <br> #Duration is <ul> - <li><atom>double</atom> specifies the length of the simple duration in seconds.</li> + <li>`double` specifies the length of the simple duration in seconds.</li> <li>Timing::INDEFINITE specifies the simple duration as indefinite.</li> <li>Timing::MEDIA specifies the simple duration as the intrinsic media duration. This is only valid for elements that define media.</li> <li><void/> the simple duration for the element is defined to be the implicit duration of the element.</li> @@ -75,7 +75,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <br> #End is <ul> - <li><atom>double</atom> describes the element end as an offset in seconds from an implicit syncbase. + <li>`double` describes the element end as an offset in seconds from an implicit syncbase. The definition of the implicit syncbase depends upon the element's parent time container. The offset is measured in parent simple time.</li> <li>Event describes an event and an optional offset that determine the @@ -100,7 +100,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild children (e.g. animate or area elements). #EndSync is - either a <atom>short</atom> constant from EndSync, + either a `short` constant from EndSync, an interface reference to a child XTimeContainer or <void/>. @@ -112,7 +112,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <br> #RepeatCount is <ul> - <li><atom>double</atom> + <li>`double` this is a numeric value that specifies the number of iterations. It can include partial iterations expressed as fraction values. A fractional value describes a portion of the simple duration. @@ -132,7 +132,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <br> #RepeatDuration is <ul> - <li><atom>double</atom> + <li>`double` specifies the duration in element active time to repeat the simple duration in seconds.</li> <li>Timing::INDEFINITE the element is defined to repeat indefinitely @@ -178,7 +178,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild /** defines the restart behavior of this element. <br> #Restart is - a <atom>short</atom> value from AnimationRestart. + a `short` value from AnimationRestart. @see AnimationRestart @see http://www.w3.org/TR/smil20/smil-timing.html#adef-restart diff --git a/offapi/com/sun/star/animations/XTransitionFilter.idl b/offapi/com/sun/star/animations/XTransitionFilter.idl index 03526a6cc2f4..8cc010997c6b 100644 --- a/offapi/com/sun/star/animations/XTransitionFilter.idl +++ b/offapi/com/sun/star/animations/XTransitionFilter.idl @@ -28,7 +28,7 @@ /** Base members XAnimate::Values, XAnimate::From, XAnimate::To and XAnimate::By can be used - with <atom>double</atom> values that set the transition progress the specific + with `double` values that set the transition progress the specific amount of time. diff --git a/offapi/com/sun/star/awt/XImageConsumer.idl b/offapi/com/sun/star/awt/XImageConsumer.idl index ace8958ee63d..54b3a08d392c 100644 --- a/offapi/com/sun/star/awt/XImageConsumer.idl +++ b/offapi/com/sun/star/awt/XImageConsumer.idl @@ -54,7 +54,7 @@ published interface XImageConsumer: com::sun::star::uno::XInterface [in] long AlphaMask ); - /** delivers a chunk of pixels as <atom>long</atom> values. + /** delivers a chunk of pixels as `long` values. <p>The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the @@ -73,7 +73,7 @@ published interface XImageConsumer: com::sun::star::uno::XInterface [in] long nScanSize ); - /** delivers a chunk of pixels as <atom>byte</atom> values. + /** delivers a chunk of pixels as `byte` values. <p>The pixels of the image are delivered using one or more calls to this method. Each call specifies the location and size of the diff --git a/offapi/com/sun/star/chart2/data/DataSequence.idl b/offapi/com/sun/star/chart2/data/DataSequence.idl index 27483e28e4bb..182b59c9d106 100644 --- a/offapi/com/sun/star/chart2/data/DataSequence.idl +++ b/offapi/com/sun/star/chart2/data/DataSequence.idl @@ -57,13 +57,13 @@ service DataSequence /** you may implement this interface to allow a fast access to numerical data. With this interface you can get a - <atom>sequence</atom> of <atom>double</atom> values. + `sequence` of `double` values. */ [optional] interface XNumericalDataSequence; /** you may implement this interface to allow a fast access to textual data. With this interface you can get a - <atom>sequence</atom> of <atom>string</atom> values. + `sequence` of `string` values. */ [optional] interface XTextualDataSequence; diff --git a/offapi/com/sun/star/chart2/data/XNumericalDataSequence.idl b/offapi/com/sun/star/chart2/data/XNumericalDataSequence.idl index f3c1f833dc1f..972a98792e0f 100644 --- a/offapi/com/sun/star/chart2/data/XNumericalDataSequence.idl +++ b/offapi/com/sun/star/chart2/data/XNumericalDataSequence.idl @@ -37,7 +37,7 @@ module data */ interface XNumericalDataSequence : ::com::sun::star::uno::XInterface { - /** retrieves data as <atom>double</atom> values. + /** retrieves data as `double` values. */ sequence< double > getNumericalData(); }; diff --git a/offapi/com/sun/star/configuration/AdministrationProvider.idl b/offapi/com/sun/star/configuration/AdministrationProvider.idl index e84117f81b40..1abccc557403 100644 --- a/offapi/com/sun/star/configuration/AdministrationProvider.idl +++ b/offapi/com/sun/star/configuration/AdministrationProvider.idl @@ -109,7 +109,7 @@ published service AdministrationProvider </p> <p>With both of the standard service-specifiers above, an implementation must - accept a single argument named <code>nodepath</code> of type <atom>string</atom>. + accept a single argument named <code>nodepath</code> of type `string`. This argument must contain the absolute path to an element of the configuration. The view that is selected consists of the named element and all its descendants. The administrative entity is the default for the diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl index c8922c090372..e566b3b54348 100644 --- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl @@ -90,30 +90,30 @@ module com { module sun { module star { module configuration { <ul> <li><strong>string</strong> can hold a human-readable text. - <p>Values are represented as <atom>string</atom>.</p> + <p>Values are represented as `string`.</p> <p>Sequences are represented as <atom dim="[]">string</atom>.</p> <p>"<em>human-readable</em>" here excludes non-printing characters except for CR, LF and TAB [Unicode code points 9,10,13]. For binary data, use type <strong>binary</strong> instead.</p> </li> <li><strong>boolean</strong> can hold the values <TRUE/> or <FALSE/>. - <p>Values are represented as <atom>boolean</atom>. + <p>Values are represented as `boolean`. <p>Sequences are represented as <atom dim="[]">boolean</atom>.</p> </li> <li><strong>short</strong> can hold a 16-bit signed integer. - <p>Values are represented as <atom>short</atom>.</p> + <p>Values are represented as `short`.</p> <p>Sequences are represented as <atom dim="[]">short</atom>.</p> </li> <li><strong>int</strong> can hold a 32-bit signed integer. - <p>Values are represented as <atom>long</atom>.</p> + <p>Values are represented as `long`.</p> <p>Sequences are represented as <atom dim="[]">long</atom>.</p> </li> <li><strong>long</strong> can hold a 64-bit signed integer. - <p>Values are represented as <atom>hyper</atom>.</p> + <p>Values are represented as `hyper`.</p> <p>Sequences are represented as <atom dim="[]">hyper</atom>.</p> </li> <li><strong>double</strong> can hold a floating point number. - <p>Values are represented as <atom>double</atom>.</p> + <p>Values are represented as `double`.</p> <p>Sequences are represented as <atom dim="[]">double</atom>.</p> </li> <li><strong>binary</strong> can hold a sequence of octets. @@ -124,7 +124,7 @@ module com { module sun { module star { module configuration { <p>Within templates an additional type <strong>any</strong> can occur. When such a template is used to create a new SetElement, the type - of the element is initially reported as <atom>any</atom> (having no value). + of the element is initially reported as `any` (having no value). When the value of such an element is first set, it will assume the type used. </p> diff --git a/offapi/com/sun/star/configuration/ConfigurationProvider.idl b/offapi/com/sun/star/configuration/ConfigurationProvider.idl index 9e11d9570990..fcb3b2bd84f5 100644 --- a/offapi/com/sun/star/configuration/ConfigurationProvider.idl +++ b/offapi/com/sun/star/configuration/ConfigurationProvider.idl @@ -93,7 +93,7 @@ published service ConfigurationProvider </p> <p>With both of the standard service-specifiers above, an implementation must - accept a single argument named <code>nodepath</code> of type <atom>string</atom>. + accept a single argument named <code>nodepath</code> of type `string`. This argument must contain the absolute path to an element of the configuration. The view that is selected consists of the named element and all its descendants. @@ -113,9 +113,9 @@ published service ConfigurationProvider <li> <strong>Selecting data into a view:</strong> <dl> - <dt><code>"nodepath"</code> : <atom>string</atom></dt> + <dt><code>"nodepath"</code> : `string`</dt> <dd>specifies the location of the view root in the configuration.</dd> - <dt><code>"depth"</code> : <atom>short</atom></dt> + <dt><code>"depth"</code> : `short`</dt> <dd>specifies that elements of the hierarchy that are more than the given number of nesting levels away from the root need not be included in the view. @@ -169,7 +169,7 @@ published service ConfigurationProvider <strong>Controlling cache behavior:</strong> (with providers that cache configuration data) <dl> - <dt><code>"enableasync"</code> : <atom>boolean</atom></dt> + <dt><code>"enableasync"</code> : `boolean`</dt> <dd>controls how updates are handled in the cache. If <TRUE/>, the cache may operate in <em>write-back</em> mode, where updates at first only affect the cache and are written to persistent storage @@ -183,7 +183,7 @@ published service ConfigurationProvider </em></p> </dd> - <dt><code>"nocache"</code> : <atom>boolean</atom></dt> + <dt><code>"nocache"</code> : `boolean`</dt> <dd>This deprecated parameter specifies that data for the view is not taken from the cache, but read directly from storage. This may entail that future changes that diff --git a/offapi/com/sun/star/configuration/HierarchyAccess.idl b/offapi/com/sun/star/configuration/HierarchyAccess.idl index 6da83620d8ed..5ed58f86192f 100644 --- a/offapi/com/sun/star/configuration/HierarchyAccess.idl +++ b/offapi/com/sun/star/configuration/HierarchyAccess.idl @@ -54,7 +54,7 @@ published service HierarchyAccess /** allows access to immediate children of this node. <p>com::sun::star::container::XNameAccess::getByName() - returns an <atom>any</atom> holding either a simple value or an interface + returns an `any` holding either a simple value or an interface on another HierarchyAccess if the child is not a simple value. </p> */ @@ -63,7 +63,7 @@ published service HierarchyAccess /** allows access to all descendants of this node <p>com::sun::star::container::XHierarchicalNameAccess::getByHierarchicalName() - returns an <atom>any</atom> holding either a simple value or an interface + returns an `any` holding either a simple value or an interface on another HierarchyAccess if the descendant is not a simple value. </p> */ diff --git a/offapi/com/sun/star/configuration/XTemplateContainer.idl b/offapi/com/sun/star/configuration/XTemplateContainer.idl index 6e8c94bb4c9f..cd119a0fdfc2 100644 --- a/offapi/com/sun/star/configuration/XTemplateContainer.idl +++ b/offapi/com/sun/star/configuration/XTemplateContainer.idl @@ -34,7 +34,7 @@ </p> <p> If multiple templates are supported, the supported factory interface may be com::sun::star::lang::XMultiServiceFactory, in which case - the <atom>string</atom> returned from + the `string` returned from XTemplateContainer::getElementTemplateName() can be used as the service name argument. </p> diff --git a/offapi/com/sun/star/configuration/backend/BackendSetupException.idl b/offapi/com/sun/star/configuration/backend/BackendSetupException.idl index 8b05373e2ded..0253ef5c389d 100644 --- a/offapi/com/sun/star/configuration/backend/BackendSetupException.idl +++ b/offapi/com/sun/star/configuration/backend/BackendSetupException.idl @@ -35,7 +35,7 @@ module backend { published exception BackendSetupException : ::com::sun::star::configuration::CannotLoadConfigurationException { /** The exception that is raised by the underlying backend implementation. - <p>May be a numeric error code, a message <atom>string</atom> or <void/>, + <p>May be a numeric error code, a message `string` or <void/>, if the original exception is not represented as a com::sun::star::uno::Exception. </p> diff --git a/offapi/com/sun/star/configuration/backend/CopyImporter.idl b/offapi/com/sun/star/configuration/backend/CopyImporter.idl index 305580898dd7..42ff761905eb 100644 --- a/offapi/com/sun/star/configuration/backend/CopyImporter.idl +++ b/offapi/com/sun/star/configuration/backend/CopyImporter.idl @@ -53,7 +53,7 @@ published service CopyImporter which must be provided as com::sun::star::beans::NamedValue: <dl> - <dt><code>Overwrite</code> : <atom>boolean</atom></dt> + <dt><code>Overwrite</code> : `boolean`</dt> <dd>If <FALSE/>, specifies that the data should be applied only if the existing layer is empty. </dd> diff --git a/offapi/com/sun/star/configuration/backend/Importer.idl b/offapi/com/sun/star/configuration/backend/Importer.idl index f96238abffcb..58b61aa7b5e4 100644 --- a/offapi/com/sun/star/configuration/backend/Importer.idl +++ b/offapi/com/sun/star/configuration/backend/Importer.idl @@ -51,7 +51,7 @@ published service Importer Implementations specify which arguments they support. <dl> - <dt><code>Notify</code> : <atom>boolean</atom></dt> + <dt><code>Notify</code> : `boolean`</dt> <dd>If <TRUE/>, specifies that the backend should trigger notification to its listeners. </dd> diff --git a/offapi/com/sun/star/configuration/backend/InteractionHandler.idl b/offapi/com/sun/star/configuration/backend/InteractionHandler.idl index ede5566797ba..f7e9d16cbf63 100644 --- a/offapi/com/sun/star/configuration/backend/InteractionHandler.idl +++ b/offapi/com/sun/star/configuration/backend/InteractionHandler.idl @@ -78,7 +78,7 @@ published service InteractionHandler com::sun::star::awt::XWindow denotes the parent window for any GUI dialogs the interaction handler pops up; it is strongly recommended that this property is supplied;</LI> - <LI><code>"Context"</code> of type <atom>string</atom> is a + <LI><code>"Context"</code> of type `string` is a textual description of the current context (used, e.g., as a first line of text in error boxes); this property is optional.</LI> </UL></P> diff --git a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl index 58edd6c12a26..325aad786685 100644 --- a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl +++ b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl @@ -60,11 +60,11 @@ published service LayerUpdateMerger com::sun::star::beans::NamedValue. Implementations should support the following named arguments: <dl> - <dt><code>Overwrite</code> : <atom>boolean</atom></dt> + <dt><code>Overwrite</code> : `boolean`</dt> <dd>If <FALSE/>, specifies that changes should be applied only if the existing layer is empty. </dd> - <dt><code>Truncate</code> : <atom>boolean</atom></dt> + <dt><code>Truncate</code> : `boolean`</dt> <dd>If <TRUE/> requests that changes should not be merged onto existing data, but that the changes should be applied to a layer that is completely empty. diff --git a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl index 2cc8c3c118dd..d8f26b9db6e2 100644 --- a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl +++ b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl @@ -47,17 +47,17 @@ published service LocalHierarchyBrowser com::sun::star::task::XJob::execute():<BR/> <dl> - <dt><code>SchemaDataUrl</code> : <atom>string</atom></dt> + <dt><code>SchemaDataUrl</code> : `string`</dt> <dd>Base directory to search for schema files. If this is specified, schema files will be browsed, so argument <code>LayerDataUrl</code> should not be specified. </dd> - <dt><code>LayerDataUrl</code> : <atom>string</atom></dt> + <dt><code>LayerDataUrl</code> : `string`</dt> <dd>Base directory to search for layer files. If this is specified, layer files will be browsed, so argument <code>SchemaDataUrl</code> should not be specified. </dd> - <dt><code>FetchComponentNames</code> : <atom>boolean</atom></dt> + <dt><code>FetchComponentNames</code> : `boolean`</dt> <dd><ul><li>if <TRUE/> components will be returned as component names,</li> <li>if <FALSE/> components will be returned as fileURLs,</li> <li>if this argument is not provided, the default is to diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index c300c5db71c6..8212f2e7132d 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -299,7 +299,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface <p> A <void/> type indicates that the type is unspecified in this layer. In this case any subsequent value may be of a generic type - (e.g. <atom>string</atom> or - for list values - + (e.g. `string` or - for list values - <atom dim="[]">string</atom>.) Such values may be converted to the type defined in the schema by the implementation. diff --git a/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl index 866860a5418c..9d8e83167f5d 100644 --- a/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/XVersionedSchemaSupplier.idl @@ -42,13 +42,13 @@ interface XVersionedSchemaSupplier : XSchemaSupplier component whose schema version will be determined @returns - a <atom>string</atom> that identifies the schema version for + a `string` that identifies the schema version for the given component. <p> The format of the version string is arbitrary. No meaning should be attached to it, unless an implementing service defines one. If no version can be determined, an empty - <atom>string</atom> may be returned. + `string` may be returned. </p> <p> Clients may assume that all instances of a schema with the diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl index b0a8f4c32668..c6a53a4f6a70 100644 --- a/offapi/com/sun/star/document/XDocumentProperties.idl +++ b/offapi/com/sun/star/document/XDocumentProperties.idl @@ -132,7 +132,7 @@ published interface XDocumentProperties /** contains the name of the template from which the document was created. <p> - The value is an empty <atom>string</atom> if the document was not + The value is an empty `string` if the document was not created from a template or if it was detached from the template. </p> */ @@ -141,7 +141,7 @@ published interface XDocumentProperties /** contains the URL of the template from which the document was created. <p> - The value is an empty <atom>string</atom> if the document was not + The value is an empty `string` if the document was not created from a template or if it was detached from the template. </p> */ @@ -160,7 +160,7 @@ published interface XDocumentProperties An empty URL is valid and describes a case where the document shall be reloaded from its original location after some time described by the attribute #AutoloadSecs. - An empty <atom>string</atom> together with an + An empty `string` together with an #AutoloadSecs value of 0 describes a case where no autoload is specified. </p> @@ -175,7 +175,7 @@ published interface XDocumentProperties frame. <p> A value of 0 is valid and describes a redirection. - A value of 0 together with an empty <atom>string</atom> as + A value of 0 together with an empty `string` as #AutoloadURL describes a case where no autoload is specified. </p> diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl index c683fb1a96c3..b667d01e7468 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl @@ -34,12 +34,12 @@ module com { module sun { module star { module form { module binding { is set at a BindableDatabaseListBox, the types from the following list are tried in descending order: The first type supported by the binding is used for data exchange. <ol> - <li><em>sequences of <atom>any</atom>s</em>: + <li><em>sequences of `any`s</em>: The elements in the sequence will represent the values the selected entries of the list box (taken from ValueList or read from BoundColumn). In other words, the SelectedValues property.</li> - <li><em><atom>any</atom> value</em>: + <li><em>`any` value</em>: The value will represent the value of the selected entry (taken from ValueList or read from BoundColumn). If more than one entry is selected, diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index 8a559f8067b8..948991adaf60 100644 --- a/offapi/com/sun/star/frame/FeatureStateEvent.idl +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -61,7 +61,7 @@ published struct FeatureStateEvent: com::sun::star::lang::EventObject <p> This can be, for example, simply <TRUE/> for a boolean feature like underline on/off. Some simple types like <code>string</code> or - <atom>boolean</atom> are useful here for generic UI elements, like + `boolean` are useful here for generic UI elements, like a checkmark in a menu. </p> */ diff --git a/offapi/com/sun/star/frame/XDispatchHelper.idl b/offapi/com/sun/star/frame/XDispatchHelper.idl index b7b2e50b71c3..a51d6a8ef0a2 100644 --- a/offapi/com/sun/star/frame/XDispatchHelper.idl +++ b/offapi/com/sun/star/frame/XDispatchHelper.idl @@ -57,7 +57,7 @@ published interface XDispatchHelper : com::sun::star::uno::XInterface @return A possible result of the executed internal dispatch. - The information behind this <atom>any</atom> depends on the dispatch! + The information behind this `any` depends on the dispatch! @see XDispatch::dispatch() */ diff --git a/offapi/com/sun/star/rdf/FileFormat.idl b/offapi/com/sun/star/rdf/FileFormat.idl index 7a4bd33d776b..edf7daa8c240 100644 --- a/offapi/com/sun/star/rdf/FileFormat.idl +++ b/offapi/com/sun/star/rdf/FileFormat.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module rdf { <p> Note that these are integers because UNO IDL does not permit - <atom>string</atom> constants. + `string` constants. </p> @since OOo 3.0 diff --git a/offapi/com/sun/star/rdf/URI.idl b/offapi/com/sun/star/rdf/URI.idl index c39fa47a4e38..b057e42660d6 100644 --- a/offapi/com/sun/star/rdf/URI.idl +++ b/offapi/com/sun/star/rdf/URI.idl @@ -39,7 +39,7 @@ service URI : XURI /** creates an URI RDF node. @param Value - the URI, represented as <atom>string</atom>. + the URI, represented as `string`. @throws com::sun::star::lang::IllegalArgumentException if the argument does not represent a valid URI @@ -51,10 +51,10 @@ service URI : XURI @param Namespace the namespace prefix of the URI, represented as - <atom>string</atom>. + `string`. @param LocalName - the local name of the URI, represented as <atom>string</atom>. + the local name of the URI, represented as `string`. @throws com::sun::star::lang::IllegalArgumentException if the arguments do not represent a valid URI diff --git a/offapi/com/sun/star/rdf/XDocumentRepository.idl b/offapi/com/sun/star/rdf/XDocumentRepository.idl index d9d260ec7d4e..9e056048db4f 100644 --- a/offapi/com/sun/star/rdf/XDocumentRepository.idl +++ b/offapi/com/sun/star/rdf/XDocumentRepository.idl @@ -53,7 +53,7 @@ interface XDocumentRepository : XRepository <ol> <li>Remove all previously set RDFa statements for the Object parameter from the repository</li> - <li>If the RDFaContent parameter is the empty <atom>string</atom>, + <li>If the RDFaContent parameter is the empty `string`, for every Predicate in the given list of Predicates, add the following RDF statement to an unspecified named graph: <ul> @@ -61,7 +61,7 @@ interface XDocumentRepository : XRepository XLiteral(Object->getText()^^RDFaDatatype)</code></li> </ul> </li> - <li>If the RDFaContent parameter is not the empty <atom>string</atom>, + <li>If the RDFaContent parameter is not the empty `string`, for every Predicate in the given list of Predicates, add the following RDF statement to an unspecified named graph: <ul> @@ -95,7 +95,7 @@ interface XDocumentRepository : XRepository @param RDFaContent the <code>rdfa:content</code> attribute (may be the empty - <atom>string</atom>). + `string`). @param RDFaDatatype the <code>rdfa:datatype</code> attribute (may be <NULL/>) diff --git a/offapi/com/sun/star/rdf/XLiteral.idl b/offapi/com/sun/star/rdf/XLiteral.idl index e76ebc6f5f23..4233291e2d36 100644 --- a/offapi/com/sun/star/rdf/XLiteral.idl +++ b/offapi/com/sun/star/rdf/XLiteral.idl @@ -46,7 +46,7 @@ interface XLiteral : XNode { /// the content of the literal [readonly, attribute] string Value; - /// the language of the literal; may be the empty <atom>string</atom> + /// the language of the literal; may be the empty `string` [readonly, attribute] string Language; /// the data type of the literal; may be <NULL/> [readonly, attribute] XURI Datatype; diff --git a/offapi/com/sun/star/rdf/XRepository.idl b/offapi/com/sun/star/rdf/XRepository.idl index 38673678cdfc..5899461593e6 100644 --- a/offapi/com/sun/star/rdf/XRepository.idl +++ b/offapi/com/sun/star/rdf/XRepository.idl @@ -313,7 +313,7 @@ interface XRepository </p> @param Query - the SPARQL query <atom>string</atom> + the SPARQL query `string` @returns an enumeration, containing @@ -343,7 +343,7 @@ interface XRepository </p> @param Query - the SPARQL query <atom>string</atom> + the SPARQL query `string` @returns an iterator over the query result graph, represented as an @@ -370,7 +370,7 @@ interface XRepository </p> @param Query - the SPARQL query <atom>string</atom> + the SPARQL query `string` @returns the boolean query result diff --git a/offapi/com/sun/star/script/browse/XBrowseNode.idl b/offapi/com/sun/star/script/browse/XBrowseNode.idl index 9d3d87e1adbf..64467b920783 100644 --- a/offapi/com/sun/star/script/browse/XBrowseNode.idl +++ b/offapi/com/sun/star/script/browse/XBrowseNode.idl @@ -37,7 +37,7 @@ interface XBrowseNode : ::com::sun::star::uno::XInterface Get the name of the node @return - The <atom>string</atom> name of this node + The `string` name of this node */ string getName(); @@ -53,12 +53,12 @@ interface XBrowseNode : ::com::sun::star::uno::XInterface Indicates if this node contains any children @returns - <atom> boolean </atom> true if there are child nodes. + ` boolean ` true if there are child nodes. */ boolean hasChildNodes(); /** the type of the node. - @returns A <atom>short</atom> representing the type of this node. + @returns A `short` representing the type of this node. */ short getType(); diff --git a/offapi/com/sun/star/script/provider/XScriptURIHelper.idl b/offapi/com/sun/star/script/provider/XScriptURIHelper.idl index 2e1faf0e4539..a1ace605970a 100644 --- a/offapi/com/sun/star/script/provider/XScriptURIHelper.idl +++ b/offapi/com/sun/star/script/provider/XScriptURIHelper.idl @@ -38,7 +38,7 @@ interface XScriptURIHelper : ::com::sun::star::uno::XInterface { resulting string can be used to access the storage for this using the Universal Content Broker - @returns a URI to the storage as a <atom>string</atom> + @returns a URI to the storage as a `string` */ string getRootStorageURI(); @@ -46,7 +46,7 @@ interface XScriptURIHelper : ::com::sun::star::uno::XInterface { Obtain the storage URI for a specific Scripting Framework script URI. - @returns a URI to the storage as a <atom>string</atom> + @returns a URI to the storage as a `string` @throws ::com::sun::star::lang::IllegalArgumentException if the storageURI is not a valid @@ -57,7 +57,7 @@ interface XScriptURIHelper : ::com::sun::star::uno::XInterface { /** Obtain the Scripting Framework script URI for a specific UCB URI - @returns the URI as a <atom>string</atom> + @returns the URI as a `string` @throws ::com::sun::star::lang::IllegalArgumentException if the storageURI is not a valid diff --git a/offapi/com/sun/star/sheet/AddIn.idl b/offapi/com/sun/star/sheet/AddIn.idl index 9385c22b8f21..9bbe7213200b 100644 --- a/offapi/com/sun/star/sheet/AddIn.idl +++ b/offapi/com/sun/star/sheet/AddIn.idl @@ -42,32 +42,32 @@ module com { module sun { module star { module sheet { <p>Each AddIn function can take parameters of the following types:</p> <dl> - <dt><atom>long</atom></dt> + <dt>`long`</dt> <dd>for integer values.</dd> - <dt><atom>double</atom></dt> + <dt>`double`</dt> <dd>for floating point values.</dd> - <dt><atom>string</atom></dt> + <dt>`string`</dt> <dd>for text strings.</dd> - <dt><atom>long[][]</atom></dt> + <dt>`long[][]`</dt> <dd>for (two-dimensional) arrays of integer values.</dd> - <dt><atom>double[][]</atom></dt> + <dt>`double[][]`</dt> <dd>for (two-dimensional) arrays of floating point values.</dd> - <dt><atom>string[][]</atom></dt> + <dt>`string[][]`</dt> <dd>for (two-dimensional) arrays of text strings.</dd> - <dt><atom>any[][]</atom></dt> - <dd>for (two-dimensional) arrays of mixed contents. Each <atom>any</atom> - will contain a <atom>double</atom> or a <atom>string</atom>, depending on + <dt>`any[][]`</dt> + <dd>for (two-dimensional) arrays of mixed contents. Each `any` + will contain a `double` or a `string`, depending on the data.</dd> - <dt><atom>any</atom></dt> - <dd>Depending on the data, a <atom>double</atom>, a <atom>string</atom>, - or an <atom>any[][]</atom> will be passed. If no argument is specified in + <dt>`any`</dt> + <dd>Depending on the data, a `double`, a `string`, + or an `any[][]` will be passed. If no argument is specified in the function call, <void/> will be passed. This allows for optional parameters.</dd> @@ -82,26 +82,26 @@ module com { module sun { module star { module sheet { can be used to query document settings like SpreadsheetDocumentSettings::NullDate.</dd> - <dt><atom>any[]</atom></dt> + <dt>`any[]`</dt> <dd>for varying parameters. Only the last parameter of a function may have this type. It will be filled with the remaining arguments of the function call that were not used for the previous parameters. Each - element of the sequence will be filled as in the case of <atom>any</atom> + element of the sequence will be filled as in the case of `any` above.</dd> </dl> <p>Each AddIn function must have one of the following return types:</p> <ul> - <li><atom>long</atom></li> - <li><atom>double</atom></li> - <li><atom>string</atom></li> - <li><atom>long[][]</atom></li> - <li><atom>double[][]</atom></li> - <li><atom>string[][]</atom></li> - <li><atom>any[][]</atom></li> + <li>`long`</li> + <li>`double`</li> + <li>`string`</li> + <li>`long[][]`</li> + <li>`double[][]`</li> + <li>`string[][]`</li> + <li>`any[][]`</li> <li>XVolatileResult</li> - <li><atom>any</atom></li> + <li>`any`</li> </ul> <p>The sequences must contain arrays as described above for the @@ -110,7 +110,7 @@ module com { module sun { module star { module sheet { implementing the VolatileResult service, that contains a volatile result. Subsequent calls with the same parameters must return the same object. - An <atom>any</atom> return value can contain any of the other types.</p> + An `any` return value can contain any of the other types.</p> */ published service AddIn { diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl index 51e8f91b01f3..d6a8dc66c4f9 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl @@ -82,7 +82,7 @@ published service DataPilotFieldGroup argument. An implementation should support the following data types: <ul> - <li>a non-empty <atom>string</atom> specifying the new name of the + <li>a non-empty `string` specifying the new name of the group member.</li> <li>an object supporting the <type scope="com::sun::star::container"> XNamed</type> interface, for example an instance of diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl index f649f38a93ff..1b1ca66e13fe 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl @@ -73,7 +73,7 @@ published service DataPilotFieldGroups implementation should support the following data types: <ul> - <li>an empty <atom>any</atom> to remove all items and leave the + <li>an empty `any` to remove all items and leave the group empty. The group can be filled later with new item names.</li> <li>a <atom dim="[]">string</atom> containing all item names that will be part of the group.</li> diff --git a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl index e2f845fafd98..6254f3875cb7 100644 --- a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl +++ b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl @@ -40,7 +40,7 @@ struct ExternalLinkInfo <ol> <li>If #Type is <const>ExternalLinkType::EXTERNAL - </const>, this member shall contain a <atom>string</atom> with the + </const>, this member shall contain a `string` with the <em>URI</em> of a document. The formula that would need this information for example would contain <code>=[1]Sheet1!A1</code> or <code>='[1]Sheet name'!A1</code> where <em>[1]</em> does resolve to diff --git a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl index 10e4f376cc66..856cfe376aac 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl @@ -41,11 +41,11 @@ constants FormulaMapGroupSpecialOffset the following values:</p> <ul> - <li>A value of type <atom>double</atom> for literal floating-point + <li>A value of type `double` for literal floating-point constants.</li> - <li>A <atom>string</atom> for literal text.</li> + <li>A `string` for literal text.</li> <li>A <atom dim="[][]">any</atom> for a literal array. The contained - values shall be of type <atom>double</atom> or <atom>string</atom>. + values shall be of type `double` or `string`. Floating-point values and strings may occur together in an array.</li> <li>A struct of type SingleReference for a reference to a single cell in the own document.</li> @@ -76,7 +76,7 @@ constants FormulaMapGroupSpecialOffset used in formulas. <p>The FormulaToken::Data member shall contain a - <atom>string</atom> with the programmatic name of the function, e.g. + `string` with the programmatic name of the function, e.g. "com.sun.star.sheet.addin.Analysis.getEomonth" for the EOMONTH function from the Analysis add-in.</p> */ @@ -88,7 +88,7 @@ constants FormulaMapGroupSpecialOffset used in formulas. <p>The FormulaToken::Data member shall contain an - integer value of type <atom>long</atom> specifying the index of the + integer value of type `long` specifying the index of the defined name. This index can be obtained from the defined name using its NamedRange::TokenIndex property.</p> @@ -124,7 +124,7 @@ constants FormulaMapGroupSpecialOffset able to parse. <p>The FormulaToken::Data member shall contain a - <atom>string</atom> with the bad data. This string will be displayed + `string` with the bad data. This string will be displayed literally in the formula.</p> */ const long BAD = 7; @@ -138,7 +138,7 @@ constants FormulaMapGroupSpecialOffset not affect the result of the formula.</p> <p>The FormulaToken::Data member shall contain a - positive integer value of type <atom>long</atom> specifying the number + positive integer value of type `long` specifying the number of space characters.</p> <p>Attention: This may change in next versions to support other @@ -155,7 +155,7 @@ constants FormulaMapGroupSpecialOffset describe the reference to a database range used in formulas. <p>The FormulaToken::Data member shall contain an - integer value of type <atom>long</atom> specifying the index of the + integer value of type `long` specifying the index of the database range. This index can be obtained from the database range using its DatabaseRange::TokenIndex property.</p> @@ -168,7 +168,7 @@ constants FormulaMapGroupSpecialOffset describe the reference to a macro function called in a formula. <p>The FormulaToken::Data member shall contain a - <atom>string</atom> specifying the name of the macro function.</p> + `string` specifying the name of the macro function.</p> */ const long MACRO = 11; diff --git a/offapi/com/sun/star/sheet/SolverConstraint.idl b/offapi/com/sun/star/sheet/SolverConstraint.idl index 1171247e87c4..68600fb2f77e 100644 --- a/offapi/com/sun/star/sheet/SolverConstraint.idl +++ b/offapi/com/sun/star/sheet/SolverConstraint.idl @@ -37,7 +37,7 @@ struct SolverConstraint /// The type of the constraint. SolverConstraintOperator Operator; - /** The comparison value, of type <atom>double</atom> or + /** The comparison value, of type `double` or com::sun::star::table::CellAddress. */ any Right; diff --git a/offapi/com/sun/star/sheet/XCellRangeData.idl b/offapi/com/sun/star/sheet/XCellRangeData.idl index 79a420739cd8..e9c6b225b6d4 100644 --- a/offapi/com/sun/star/sheet/XCellRangeData.idl +++ b/offapi/com/sun/star/sheet/XCellRangeData.idl @@ -33,16 +33,16 @@ published interface XCellRangeData: com::sun::star::uno::XInterface { /** gets an array from the contents of the cell range. - <p>Each element of the result contains a <atom>double</atom> - or a <atom>string</atom>.</p> + <p>Each element of the result contains a `double` + or a `string`.</p> */ sequence< sequence< any > > getDataArray(); /** fills the cell range with values from an array. <p>The size of the array must be the same as the size of the cell - range. Each element of the array must contain a <atom>double</atom> - or a <atom>string</atom>.</p> + range. Each element of the array must contain a `double` + or a `string`.</p> @throws com::sun::star::uno::RuntimeException If the size of the array is different from the current size. diff --git a/offapi/com/sun/star/sheet/XCellRangesQuery.idl b/offapi/com/sun/star/sheet/XCellRangesQuery.idl index 05c368e12719..eb9a6dcd6b78 100644 --- a/offapi/com/sun/star/sheet/XCellRangesQuery.idl +++ b/offapi/com/sun/star/sheet/XCellRangesQuery.idl @@ -61,7 +61,7 @@ published interface XCellRangesQuery: com::sun::star::uno::XInterface a combination of CellFlags flags. <p>Attention: Despite the CellFlags flags are - <atom>long</atom> values, this method expects a <atom>short</atom> + `long` values, this method expects a `short` parameter.</p> <p>Attention: Empty cells in the range may be skipped depending on diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl index 487fc439eeb8..5fc4f10de034 100644 --- a/offapi/com/sun/star/sheet/XFunctionAccess.idl +++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl @@ -45,21 +45,21 @@ published interface XFunctionAccess: com::sun::star::uno::XInterface <p>Each element must be of one of the following types:</p> <dl> - <dt><atom>long</atom> or <atom>double</atom></dt> + <dt>`long` or `double`</dt> <dd>for a numeric value.</dd> - <dt><atom>string</atom></dt> + <dt>`string`</dt> <dd>for a textual value.</dd> - <dt><atom>long[][]</atom> or <atom>double[][]</atom></dt> + <dt>`long[][]` or `double[][]`</dt> <dd>for an array of numeric values.</dd> - <dt><atom>string[][]</atom></dt> + <dt>`string[][]`</dt> <dd>for an array of textual values.</dd> - <dt><atom>any[][]</atom></dt> + <dt>`any[][]`</dt> <dd>for a mixed array, where each element must be of <void/>, - <atom>long</atom>, <atom>double</atom> or <atom>string</atom> + `long`, `double` or `string` type.</dd> <dt>com::sun::star::table::XCellRange</dt> @@ -76,15 +76,15 @@ published interface XFunctionAccess: com::sun::star::uno::XInterface <dt><void/></dt> <dd>if no result is available.</dd> - <dt><atom>double</atom></dt> + <dt>`double`</dt> <dd>for a numeric result.</dd> - <dt><atom>string</atom></dt> + <dt>`string`</dt> <dd>for a textual result.</dd> - <dt><atom>any[][]</atom></dt> - <dd>for an array result, containing <atom>double</atom> and - <atom>string</atom> values.</dd> + <dt>`any[][]`</dt> + <dd>for an array result, containing `double` and + `string` values.</dd> </dl> @throws com::sun::star::container::NoSuchElementException diff --git a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl index 9bde5ba4b22e..14c6659a5931 100644 --- a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl +++ b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl @@ -43,10 +43,10 @@ published interface XSheetConditionalEntries: com::sun::star::container::XIndexA <dt>ConditionOperator Operator</dt> <dd>contains the operation to perform for this condition.</dd> - <dt><atom>string</atom> Formula1</dt> + <dt>`string` Formula1</dt> <dd>contains the value or formula for the operation.</dd> - <dt><atom>string</atom> Formula2</dt> + <dt>`string` Formula2</dt> <dd>contains the second value or formula for the operation (used with ConditionOperator::BETWEEN or ConditionOperator::NOT_BETWEEN operations).</dd> @@ -56,7 +56,7 @@ published interface XSheetConditionalEntries: com::sun::star::container::XIndexA <dd>contains the base address for relative cell references in formulas. </dd> - <dt><atom>string</atom> StyleName</dt> + <dt>`string` StyleName</dt> <dd>contains the name of the cell style used by this condition.</dd> </dl> diff --git a/offapi/com/sun/star/task/InteractionHandler.idl b/offapi/com/sun/star/task/InteractionHandler.idl index f809655a67b9..5c0bca04b601 100644 --- a/offapi/com/sun/star/task/InteractionHandler.idl +++ b/offapi/com/sun/star/task/InteractionHandler.idl @@ -90,12 +90,12 @@ module com { module sun { module star { module task { <DT><code>"Uri"</code></DT> <DD>All error codes except com::sun::star::ucb::IOErrorCode::DIFFERENT_DEVICES. - The URI of the involved resource (a <atom>string</atom>).</DD> + The URI of the involved resource (a `string`).</DD> <DT><code>"ResourceName"</code></DT> <DD>All error codes except com::sun::star::ucb::IOErrorCode::DIFFERENT_DEVICES. - A name for the involved resource (a <atom>string</atom>) that might be + A name for the involved resource (a `string`) that might be more meaningful to the user than the URI. For example, a (platform-dependent) path notation for file system resources.</DD> @@ -104,7 +104,7 @@ module com { module sun { module star { module task { and com::sun::star::ucb::IOErrorCode::NOT_EXISTING only. An identifier for the type of resource involved (a - <atom>string</atom>). Currently understood values are + `string`). Currently understood values are <code>"volume"</code> (e.g., a file system volume) and <code>"folder"</code> (i.e., a resource that contains other resources).</DD> @@ -112,17 +112,17 @@ module com { module sun { module star { module task { <DT><code>"Removable"</code></DT> <DD>com::sun::star::ucb::IOErrorCode::NOT_EXISTING only. A flag indicating whether the resource resides on a storage - medium that can be removed by the user (a <atom>boolean</atom>).</DD> + medium that can be removed by the user (a `boolean`).</DD> <DT><code>"Folder"</code></DT> <DD>com::sun::star::ucb::IOErrorCode::CANT_CREATE only. The name of the folder in which a resource cannot be created (a - <atom>string</atom>).</DD> + `string`).</DD> <DT><code>"Volume"</code> and <code>"OtherVolume"</code></DT> <DD>com::sun::star::ucb::IOErrorCode::DIFFERENT_DEVICES only. The names of the two volumes involved (two - <atom>string</atom>s).</DD> + `string`s).</DD> </DL></P> <a name="configuring_handlers"></a> diff --git a/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl b/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl index 27fc3959586a..1c034f2e8cac 100644 --- a/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl +++ b/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl @@ -36,9 +36,9 @@ module com { module sun { module star { module ucb { <p>Each hierarchy data node has three data members: <ul> - <li>"Title", which is of type <atom>string</atom>. It contains a title + <li>"Title", which is of type `string`. It contains a title for the node. This value must not be empty. - <li>"TargetURL", which is of type <atom>string</atom></li> It may contain + <li>"TargetURL", which is of type `string`</li> It may contain any URL, which will be treated as the target of a hierarchy link. <li>"Children", which is of type HierarchyDataReadAccess or of type HierarchyDataReadWriteAccess</li>, depending on the @@ -51,10 +51,10 @@ published service HierarchyDataReadAccess <p>Examples: <ul> - <li><code>getByName( "Title" )</code> will return an <atom>any</atom> + <li><code>getByName( "Title" )</code> will return an `any` containing a string containing the title of the node. </li> - <li><code>getByName( "Children" )</code> will return an <atom>any</atom> + <li><code>getByName( "Children" )</code> will return an `any` containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service @@ -92,13 +92,13 @@ published service HierarchyDataReadAccess <ul> <li> <code>getByHierarchicalName( "Title" )</code> will return an - <atom>any</atom> containing a string containing the title of the node + `any` containing a string containing the title of the node itself. </li> <li> <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 + an `any` containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a @@ -107,13 +107,13 @@ published service HierarchyDataReadAccess <li> <code>getByHierarchicalName( "Children/['subnode2']/TargetURL" )</code> will give direct access to the "TargetURL" data member of the child node - named "subnode2" of the node. It will return an <atom>any</atom> - containing a <atom>string</atom> containing the target URL of the node. + named "subnode2" of the node. It will return an `any` + containing a `string` containing the target URL of the node. </li> <li> <code>getByHierarchicalName( "Children/['subnode3']/Children" )</code> 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> + named "subnode3" of the node. It will return an `any` containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service diff --git a/offapi/com/sun/star/ucb/HierarchyDataSource.idl b/offapi/com/sun/star/ucb/HierarchyDataSource.idl index 0da7ea0f18b6..4a9842cb67fc 100644 --- a/offapi/com/sun/star/ucb/HierarchyDataSource.idl +++ b/offapi/com/sun/star/ucb/HierarchyDataSource.idl @@ -65,7 +65,7 @@ published service HierarchyDataSource <p>With both of the standard service specifiers above, an implementation must accept a property named <code>nodepath</code> of type - <atom>string</atom>. This property must contain the absolute path to an + `string`. This property must contain the absolute path to an element of the data. The view that is selected consists of the named element and all its descendants. A path consists of segments that are separated by a single slash ("/"). There is neither a leading nor a diff --git a/offapi/com/sun/star/ucb/XAnyCompare.idl b/offapi/com/sun/star/ucb/XAnyCompare.idl index d0809f549666..cac854fd57d1 100644 --- a/offapi/com/sun/star/ucb/XAnyCompare.idl +++ b/offapi/com/sun/star/ucb/XAnyCompare.idl @@ -24,12 +24,12 @@ module com { module sun { module star { module ucb { -/** compares two <atom>any</atom>s. +/** compares two `any`s. */ published interface XAnyCompare: com::sun::star::uno::XInterface { - /** allows comparison of two <atom>any</atom>s. + /** allows comparison of two `any`s. @param Any1 is the first compare value diff --git a/offapi/com/sun/star/ucb/XProgressHandler.idl b/offapi/com/sun/star/ucb/XProgressHandler.idl index 170a8670c65e..bfa4d5644f8c 100644 --- a/offapi/com/sun/star/ucb/XProgressHandler.idl +++ b/offapi/com/sun/star/ucb/XProgressHandler.idl @@ -37,11 +37,11 @@ published interface XProgressHandler: com::sun::star::uno::XInterface be an agreement between caller and callee of methods XProgressHandler::push() and XProgressHandler::update() as to which Status - arguments are meaningful. For example, a <atom>string</atom> argument + arguments are meaningful. For example, a `string` argument to XProgressHandler::push() should be used to transport some status text that describes the progress being made (possibly followed by one or more XProgressHandler::update()s with - <atom>string</atom> arguments, if the appropriate status text changes + `string` arguments, if the appropriate status text changes as progress is being made). */ void push([in] any Status); diff --git a/offapi/com/sun/star/util/XStringMapping.idl b/offapi/com/sun/star/util/XStringMapping.idl index 5ae2843cde63..dc250cde4992 100644 --- a/offapi/com/sun/star/util/XStringMapping.idl +++ b/offapi/com/sun/star/util/XStringMapping.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module util { -/** provides a mapping from <atom>string</atom> to <atom>string</atom> +/** provides a mapping from `string` to `string` */ published interface XStringMapping: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/util/XTimeStamped.idl b/offapi/com/sun/star/util/XTimeStamped.idl index 756a7e884d29..166c3eb8588e 100644 --- a/offapi/com/sun/star/util/XTimeStamped.idl +++ b/offapi/com/sun/star/util/XTimeStamped.idl @@ -50,7 +50,7 @@ published interface XTimeStamped : ::com::sun::star::uno::XInterface @return - a <atom>string</atom> that represents a timestamp. + a `string` that represents a timestamp. */ string getTimestamp() ; |