Kaydet (Commit) be7f280e authored tarafından Michael Stahl's avatar Michael Stahl

*api: convert <atom>

sed -i 's,<atom>\([^<]\+\)</atom>,`\1`,g'

Change-Id: I530fe998b0c422e83c4324807d42700126bc9883
üst ce36de94
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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;
......
......@@ -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();
};
......
......@@ -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
......
......@@ -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>
......
......@@ -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
......
......@@ -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>
*/
......
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......
......@@ -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.
......
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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>
......
......@@ -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,
......
......@@ -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>
*/
......
......@@ -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()
*/
......
......@@ -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
......
......@@ -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
......
......@@ -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/>)
......
......@@ -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;
......
......@@ -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
......
......@@ -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();
......
......@@ -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
......
......@@ -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[][]`</