summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-29 18:33:02 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:05 +0200
commitb7ba598ced9708da45372a6c3f8e1a17c306be8f (patch)
tree8f7bef1c06944e35828dfec635abd626ca402cec /offapi/com/sun/star/configuration
parentae7595a7553c61cab3cc9014bb12239e02fd8c6a (diff)
*api: clean up multi-line and mal-formed XML tags
It is amazing what some people believe autodoc supports. Also, com::sun::star::uno::Any does not exist in IDL, that is part of the C++ language binding. Change-Id: I1f1f5cf5d27663ace6ff618ecbecb41fd2dfa1fc
Diffstat (limited to 'offapi/com/sun/star/configuration')
-rw-r--r--offapi/com/sun/star/configuration/ConfigurationAccess.idl16
-rw-r--r--offapi/com/sun/star/configuration/backend/DataImporter.idl12
-rw-r--r--offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl2
-rw-r--r--offapi/com/sun/star/configuration/backend/LocalDataImporter.idl2
-rw-r--r--offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl2
-rw-r--r--offapi/com/sun/star/configuration/backend/StratumCreationException.idl2
-rw-r--r--offapi/com/sun/star/configuration/backend/XLayerHandler.idl2
-rw-r--r--offapi/com/sun/star/configuration/backend/XLayerImporter.idl4
8 files changed, 21 insertions, 21 deletions
diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl
index 9ad0f34ca537..9e34f9adff69 100644
--- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl
+++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl
@@ -91,34 +91,34 @@ module com { module sun { module star { module configuration {
<ul>
<li><strong>string</strong> can hold a human-readable text.
<p>Values are represented as `string`.</p>
- <p>Sequences are represented as <atom dim="[]">string</atom>.</p>
+ <p>Sequences are represented as `string[]`.</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 `boolean`.
- <p>Sequences are represented as <atom dim="[]">boolean</atom>.</p>
+ <p>Sequences are represented as `boolean[]`.</p>
</li>
<li><strong>short</strong> can hold a 16-bit signed integer.
<p>Values are represented as `short`.</p>
- <p>Sequences are represented as <atom dim="[]">short</atom>.</p>
+ <p>Sequences are represented as `short[]`.</p>
</li>
<li><strong>int</strong> can hold a 32-bit signed integer.
<p>Values are represented as `long`.</p>
- <p>Sequences are represented as <atom dim="[]">long</atom>.</p>
+ <p>Sequences are represented as `long[]`.</p>
</li>
<li><strong>long</strong> can hold a 64-bit signed integer.
<p>Values are represented as `hyper`.</p>
- <p>Sequences are represented as <atom dim="[]">hyper</atom>.</p>
+ <p>Sequences are represented as `hyper[]`.</p>
</li>
<li><strong>double</strong> can hold a floating point number.
<p>Values are represented as `double`.</p>
- <p>Sequences are represented as <atom dim="[]">double</atom>.</p>
+ <p>Sequences are represented as `double[]`.</p>
</li>
<li><strong>binary</strong> can hold a sequence of octets.
- <p>Values are represented as <atom dim="[]">byte</atom>.</p>
- <p>Sequences are represented as <atom dim="[][]">byte</atom>.</p>
+ <p>Values are represented as `byte[]`.</p>
+ <p>Sequences are represented as `byte[][]`.</p>
</li>
</ul>
diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl
index 8f3bba9cd47c..8798f7879e03 100644
--- a/offapi/com/sun/star/configuration/backend/DataImporter.idl
+++ b/offapi/com/sun/star/configuration/backend/DataImporter.idl
@@ -58,20 +58,20 @@ published service DataImporter
should be supported by implementations. Implementations must document
a failure to support any of these arguments:
<dl>
- <dt><code>ImporterService</code> : <atom >string</atom></dt>
+ <dt><code>ImporterService</code> : `string`</dt>
<dd>A service or implementation name used to instantiate the
Importer to use for importing. If this parameter
is missing, the implementation selects an appropriate importer.
By default, a MergeImporter should be used.
</dd>
- <dt><code>OverwriteExisting</code> : <atom >boolean</atom></dt>
+ <dt><code>OverwriteExisting</code> : `boolean`</dt>
<dd>If `TRUE`, specifies that no existing data should be
overwritten by the import. If the Importer used
does not support such protection, an error may be raised.
If some data is not imported, because there is existing
data, this is indicated by returning an appropriate exception.
</dd>
- <dt><code>TruncateExisting</code> : <atom >boolean</atom></dt>
+ <dt><code>TruncateExisting</code> : `boolean`</dt>
<dd>If `TRUE`, specifies that existing data should be
discarded and replaced by the imported data.
If the Importer used does not support this
@@ -79,19 +79,19 @@ published service DataImporter
By default, a CopyImporter is used to perform
truncating import.
</dd>
- <dt><code>Entity</code> : <atom >string</atom></dt>
+ <dt><code>Entity</code> : `string`</dt>
<dd>An identifier for the entity in the destination backend for
which the imported data should apply. The value will be passed
to XLayerImporter::importLayerForEntity().
If this parameter is missing, the implementation uses
XLayerImporter::importLayer() instead.
</dd>
- <dt><code>Component</code> : <atom >string</atom></dt>
+ <dt><code>Component</code> : `string`</dt>
<dd>Names the component for which to import data. If this
parameter is missing, the selection of data to import depends
on implementation-specific parameters.
</dd>
- <dt><code>LayerFilter</code> : <type >LayerFilter</type></dt>
+ <dt><code>LayerFilter</code> : LayerFilter</dt>
<dd>A filter to transform data during import. This parameter is
optional. If this parameter is missing, data will be imported
unaltered. <em>Support for this parameter is optional.</em>
diff --git a/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl
index 9b953638c03f..2bd96640df91 100644
--- a/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl
+++ b/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl
@@ -45,7 +45,7 @@ published service HierarchyBrowser
com::sun::star::task::XJob::execute()
must be supported by all implementations:
<dl>
- <dt><code>ExcludeComponents</code> : <atom dim="[]">string</atom> or <atom >string</atom></dt>
+ <dt><code>ExcludeComponents</code> : `string[]` or `string`</dt>
<dd>A component or list of components that should be skipped
and excluded from the result. If this argument appears multiple
times it is handled cumulatively.
diff --git a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl
index 6df0c05d50e3..a3b2bdd3e75c 100644
--- a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl
+++ b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl
@@ -66,7 +66,7 @@ published service LocalDataImporter
are all supported by implementations. Additionally the following
argument is required to select the data source:
<dl>
- <dt><code>LayerDataUrl</code> : <atom >string</atom></dt>
+ <dt><code>LayerDataUrl</code> : `string`</dt>
<dd>A file URL that specifies the location of the source data.
<p> If no <code>Component</code> is provided, this must be the
location of an OOR Update XML file, which will be imported
diff --git a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl
index 709f52c3ceb4..569c4a33861b 100644
--- a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl
+++ b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl
@@ -25,7 +25,7 @@
module com { module sun { module star { module configuration { module backend {
-/** is passed to an <type>InteractionHandler<type> when merging fails due to
+/** is passed to an InteractionHandler when merging fails due to
invalid layer data or access problems.
@since OOo 2.0
diff --git a/offapi/com/sun/star/configuration/backend/StratumCreationException.idl b/offapi/com/sun/star/configuration/backend/StratumCreationException.idl
index 354ff568c093..ce5a627142c9 100644
--- a/offapi/com/sun/star/configuration/backend/StratumCreationException.idl
+++ b/offapi/com/sun/star/configuration/backend/StratumCreationException.idl
@@ -25,7 +25,7 @@
module com { module sun { module star { module configuration { module backend {
-/** is passed to an <type>InteractionHandler<type> when creating a stratum backend fails.
+/** is passed to an InteractionHandler when creating a stratum backend fails.
@since OOo 2.0
*/
diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl
index e9e4e95f58fb..d8387a969509 100644
--- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl
+++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl
@@ -300,7 +300,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface
in this layer.
In this case any subsequent value may be of a generic type
(e.g. `string` or - for list values -
- <atom dim="[]">string</atom>.) Such values may be
+ `string[]`.) Such values may be
converted to the type defined in the schema by
the implementation.
</p>
diff --git a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl
index 77002a6d869b..91515e0284a1 100644
--- a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl
+++ b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl
@@ -42,7 +42,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface
@returns
the Backend into which layers are
- imported by <member>XLayerImporter::importLayer()<member/>.
+ imported by XLayerImporter::importLayer().
*/
XBackend getTargetBackend();
@@ -52,7 +52,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface
@param aBackend
a Backend into which layers should be
- imported by <method>XLayerImporter::importLayer()<method/>.
+ imported by XLayerImporter::importLayer().
@throws com::sun::star::lang::NullPointerException
if the backend passed is `NULL`.