diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 21:47:17 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:00:59 +0200 |
| commit | 944eb9902788d8afec9e3f0f65d3b680041e039b (patch) | |
| tree | 3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/configuration | |
| parent | cdbbbdce9956e290b4a849af332df55da1be8d36 (diff) | |
*api: convert <type>Foo</type>
Doxygen does not know type element and will recognize strings that
contain capital letter (all API types do) automatically as type.
This patch removes 15k doxygen warnings.
git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1,"
Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
Diffstat (limited to 'offapi/com/sun/star/configuration')
53 files changed, 194 insertions, 194 deletions
diff --git a/offapi/com/sun/star/configuration/AccessRootElement.idl b/offapi/com/sun/star/configuration/AccessRootElement.idl index ec4b7e63ca51..65cbbf6df644 100644 --- a/offapi/com/sun/star/configuration/AccessRootElement.idl +++ b/offapi/com/sun/star/configuration/AccessRootElement.idl @@ -62,7 +62,7 @@ module com { module sun { module star { module configuration { A complementary service, for children of a static heterogeneous collection. @see com::sun::star::configuration::ConfigurationProvider - Objects provided by a <type>ConfigurationProvider</type> implement this service. + Objects provided by a ConfigurationProvider implement this service. */ published service AccessRootElement { diff --git a/offapi/com/sun/star/configuration/AdministrationProvider.idl b/offapi/com/sun/star/configuration/AdministrationProvider.idl index 6fcb945a05e1..073ab9b8abee 100644 --- a/offapi/com/sun/star/configuration/AdministrationProvider.idl +++ b/offapi/com/sun/star/configuration/AdministrationProvider.idl @@ -55,10 +55,10 @@ module com { module sun { module star { module configuration { Offers the same services and creates the same accessor objects as this service, but accesses the personal configuration. - <p>A <type> ConfigurationProvider</type> provides access to the personal + <p>A ConfigurationProvider provides access to the personal layer of configuration data of the current user context. It should in most cases be used when <em>using</em> the configuration data, although - for most contexts a <type>AdministrationProvider</type> can be used as + for most contexts a AdministrationProvider can be used as a drop-in replacement. </p> */ @@ -76,20 +76,20 @@ published service AdministrationProvider <p>Using the first of these service specifiers requests a read-only view of the configuration. - The object that is created implements service <type>ConfigurationAccess</type>. + The object that is created implements service ConfigurationAccess. To reflect its <em>element role</em> as root of the view, it implements - service <type>AccessRootElement</type>. + service AccessRootElement. </p> <p>Using the second form requests an updatable view of the configuration. The object that is created should implement service - <type>ConfigurationUpdateAccess</type>. To reflect its <em>element role</em> + ConfigurationUpdateAccess. To reflect its <em>element role</em> which includes controlling updates for the whole view, it implements - service <type>UpdateRootElement</type>. + service UpdateRootElement. <BR />If the root element of the view is marked read-only (as indicated by <const scope="com::sun::star::beans">PropertyAttributes::READONLY</const>), the implementation may either raise an exception or return a (read-only) - <type>ConfigurationAccess</type>/<type>AccessRootElement</type> instead. + ConfigurationAccess/AccessRootElement instead. </p> <p>The arguments passed to @@ -113,7 +113,7 @@ published service AdministrationProvider 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 - <type>AdministrationProvider</type>. Usually this is the largest entity + AdministrationProvider. Usually this is the largest entity encompassing all entities accessible from this instance. In other words this can be used to influence as global a scope as possible. </p> @@ -127,13 +127,13 @@ published service AdministrationProvider <p>An implementation may ignore unknown arguments.</p> <p>Some parameters that are commonly supported are described for service - <type>ConfigurationProvider</type>. + ConfigurationProvider. </p> <p>One notable difference exists for parameter <code>"Locale"</code>. For a - <type>ConfigurationProvider</type> the default behavior usually is to select + ConfigurationProvider the default behavior usually is to select the locale set up for the user. But this service by default gets data for all locales for which data is present. Locale-dependent values in this case are - replaced by a <type>SetAccess</type> using the language names as accessors. + replaced by a SetAccess using the language names as accessors. This also allows targeted setting of values for selected locales. This behavior can be requested explicitly by specifying a special argument value <code>locale = "*"</code>. diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl index 70db06e12a3a..2b5d2a643ac4 100644 --- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl @@ -123,7 +123,7 @@ module com { module sun { module star { module configuration { </ul> <p>Within templates an additional type <strong>any</strong> can occur. When - such a template is used to create a new <type>SetElement</type>, the type + 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). When the value of such an element is first set, it will assume the type used. </p> @@ -140,7 +140,7 @@ module com { module sun { module star { module configuration { @see ConfigurationProvider Root instances of this service can be requested from a - <type>ConfigurationProvider</type>. + ConfigurationProvider. @see ConfigurationUpdateAccess an extended service that includes facilities for modifying @@ -156,8 +156,8 @@ published service ConfigurationAccess <p>Implementations shall implement exactly one of:</p> <ul> - <li><type>SetAccess</type> if this element is a <em>Set</em>.</li> - <li><type>GroupAccess</type> if this element is a <em>Group</em>.</li> + <li>SetAccess if this element is a <em>Set</em>.</li> + <li>GroupAccess if this element is a <em>Group</em>.</li> </ul> */ service HierarchyAccess; @@ -171,57 +171,57 @@ published service ConfigurationAccess <p>Implementations shall implement exactly one of:</p> <ul> - <li><type>AccessRootElement</type> if this element is the + <li>AccessRootElement if this element is the <em>Root</em> of the whole hierarchy. Objects that can be - created directly by a <type>ConfigurationProvider</type> + created directly by a ConfigurationProvider implement this service.</li> - <li><type>SetElement</type> if this element may be contained in a + <li>SetElement if this element may be contained in a <em>Set</em>.</li> - <li><type>GroupElement</type> if this element is a child of a + <li>GroupElement if this element is a child of a <em>Group</em>.</li> </ul> */ service HierarchyElement; - /** specializes <type>HierarchyAccess</type>, if this element is a <em>Set</em>. + /** specializes HierarchyAccess, if this element is a <em>Set</em>. - <p>This is an alternative to <type>GroupAccess</type>. + <p>This is an alternative to GroupAccess. </p> */ [optional] service SetAccess; - /** specializes <type>HierarchyAccess</type>, + /** specializes HierarchyAccess, if this element is a <em>Group</em>. - <p>This is an alternative to <type>SetAccess</type>. + <p>This is an alternative to SetAccess. </p> */ [optional] service GroupAccess; - /** specializes <type>HierarchyElement</type>, + /** specializes HierarchyElement, if this element is the <em>Root</em> of the whole hierarchy. - <p>This is an alternative to <type>SetElement</type> - or <type>GroupElement</type>. + <p>This is an alternative to SetElement + or GroupElement. </p> @see ConfigurationProvider - Instances obtained from a <type>ConfigurationProvider</type> will - implement this version of <type>HierarchyElement</type>. + Instances obtained from a ConfigurationProvider will + implement this version of HierarchyElement. */ [optional] service AccessRootElement; - /** specializes <type>HierarchyElement</type>, + /** specializes HierarchyElement, if this element may be contained in a <em>Set</em>. - <p>This is an alternative to <type>AccessRootElement</type> - or <type>GroupElement</type>. + <p>This is an alternative to AccessRootElement + or GroupElement. </p> */ [optional] service SetElement; - /** specializes <type>HierarchyElement</type>, + /** specializes HierarchyElement, if this element is a child of a <em>Group</em>. - <p>This is an alternative to <type>AccessRootElement</type> - or <type>SetElement</type>. + <p>This is an alternative to AccessRootElement + or SetElement. </p> */ [optional] service GroupElement; diff --git a/offapi/com/sun/star/configuration/ConfigurationProvider.idl b/offapi/com/sun/star/configuration/ConfigurationProvider.idl index e0e33712f35f..bd240c3f6b43 100644 --- a/offapi/com/sun/star/configuration/ConfigurationProvider.idl +++ b/offapi/com/sun/star/configuration/ConfigurationProvider.idl @@ -47,7 +47,7 @@ module com { module sun { module star { module configuration { this applies to the parameters <code>"Locale"</code> and <code>"EnableAsync"</code>. </p> - @deprecated Use <type>theDefaultProvider</type> instead. + @deprecated Use theDefaultProvider instead. */ published service ConfigurationProvider { @@ -63,20 +63,20 @@ published service ConfigurationProvider <p>Using the first of these service specifiers requests a read-only view of the configuration. - The object that is created implements service <type>ConfigurationAccess</type>. + The object that is created implements service ConfigurationAccess. To reflect its <em>element role</em> as root of the view, it implements - service <type>AccessRootElement</type>. + service AccessRootElement. </p> <p>Using the second form requests an updatable view of the configuration. The object that is created should implement service - <type>ConfigurationUpdateAccess</type>. To reflect its <em>element role</em> + ConfigurationUpdateAccess. To reflect its <em>element role</em> which includes controlling updates for the whole view, it implements - service <type>UpdateRootElement</type>. + service UpdateRootElement. <BR />If the root element of the view is marked read-only (as indicated by <const scope="com::sun::star::beans">PropertyAttributes::READONLY</const>), the implementation may either raise an exception or return a (read-only) - <type>ConfigurationAccess</type>/<type>AccessRootElement</type> instead. + ConfigurationAccess/AccessRootElement instead. </p> <p>The arguments passed to diff --git a/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl b/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl index 99ee2671e3e3..820af129eaf1 100644 --- a/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl +++ b/offapi/com/sun/star/configuration/ConfigurationUpdateAccess.idl @@ -29,22 +29,22 @@ module com { module sun { module star { module configuration { /** provides modifying access to a fragment of the configuration hierarchy. - <p>Extends <type>ConfigurationAccess</type> to support modifying values + <p>Extends ConfigurationAccess to support modifying values or inserting and removing elements. </p> <p>Descendants of this service also implement this service unless they are marked <em>read-only</em> (which is indicated by attribute <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>), - in which case they only need implement <type>ConfigurationAccess</type>. + in which case they only need implement ConfigurationAccess. </p> <p>The classification of implementations that is described for - <type>ConfigurationAccess</type> applies to implementations of this service + ConfigurationAccess applies to implementations of this service as well. Therefore an implementation will support one of several alternate services describing its <em>Container</em> role and one of several alternate services describing its <em>Element</em> role. These services are - extensions of the respective services documented for <type>ConfigurationAccess</type>. + extensions of the respective services documented for ConfigurationAccess. </p> <ul> <li><em>Container</em> role: @@ -62,55 +62,55 @@ module com { module sun { module star { module configuration { @see ConfigurationProvider Root instances of this service can be requested from a - <type>ConfigurationProvider</type> + ConfigurationProvider */ published service ConfigurationUpdateAccess { /** is the basic service providing read access to an element of the configuration hierarchy and its child and descendent elements. - <p>The <type>HierarchyAccess</type> specialization implemented will be + <p>The HierarchyAccess specialization implemented will be further specialized to support modifying access. - Implementations shall therefore implement one of <type>SetUpdate</type> or - <type>GroupUpdate</type> depending on the <em>Container</em> role. + Implementations shall therefore implement one of SetUpdate or + GroupUpdate depending on the <em>Container</em> role. </p> - <p>If the <type>HierarchyElement</type> specialization that is implemented - is <type>AccessRootElement</type>, the implementation must support the - extended functionality of <type>UpdateRootElement</type>. Otherwise, there + <p>If the HierarchyElement specialization that is implemented + is AccessRootElement, the implementation must support the + extended functionality of UpdateRootElement. Otherwise, there are no new requirements mandated by the <em>Element</em> role. </p> */ service ConfigurationAccess; - /** specializes <type>SetAccess</type> to support modifying the element. + /** specializes SetAccess to support modifying the element. <p>Implemented, if this element is a <em>Set</em>. - Otherwise service <type>GroupUpdate</type> is provided. + Otherwise service GroupUpdate is provided. </p> */ [optional] service SetUpdate; - /** specializes <type>GroupAccess</type> to support modifying contained + /** specializes GroupAccess to support modifying contained data. <p>Implemented, if this element is a <em>Group</em>. - Otherwise service <type>SetUpdate</type> is provided. + Otherwise service SetUpdate is provided. </p> */ [optional] service GroupUpdate; - /** specializes <type>AccessRootElement</type> to support transaction-like + /** specializes AccessRootElement to support transaction-like control over a batch of changes accumulated within the tree fragment. <p>Implemented, if this element is the <em>Root</em> of the whole hierarchy. - Otherwise either <type>SetElement</type> or <type>GroupElement</type> is provided. + Otherwise either SetElement or GroupElement is provided. </p> @see ConfigurationProvider - Instances obtained from a <type>ConfigurationProvider</type> will - implement this version of <type>HierarchyElement</type>. + Instances obtained from a ConfigurationProvider will + implement this version of HierarchyElement. */ [optional] service UpdateRootElement; }; diff --git a/offapi/com/sun/star/configuration/DefaultProvider.idl b/offapi/com/sun/star/configuration/DefaultProvider.idl index 278dc157ab36..07b2c7f05891 100644 --- a/offapi/com/sun/star/configuration/DefaultProvider.idl +++ b/offapi/com/sun/star/configuration/DefaultProvider.idl @@ -30,12 +30,12 @@ module com { module sun { module star { module configuration { /** - is a <type>ConfigurationProvider</type>, that is - the default <type>ConfigurationProvider</type> for its + is a ConfigurationProvider, that is + the default ConfigurationProvider for its <type scope="com::sun::star::uno">XComponentContext</type>. <p>This object is accessible as singleton - <type>theDefaultProvider</type></p>. + theDefaultProvider</p>. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/configuration/GroupAccess.idl b/offapi/com/sun/star/configuration/GroupAccess.idl index ebbb23a85b6a..fca524dd595d 100644 --- a/offapi/com/sun/star/configuration/GroupAccess.idl +++ b/offapi/com/sun/star/configuration/GroupAccess.idl @@ -64,8 +64,8 @@ published service GroupAccess <p>This view is meaningful only for a static fragment of the hierarchy Object's properties may change, but not which properties they have. - Therefore, dynamic elements of the hierarchy (see <type>SetAccess</type>) - do not implement service <type>PropertyHierarchy</type>. + Therefore, dynamic elements of the hierarchy (see SetAccess) + do not implement service PropertyHierarchy. </p> <p>If such elements occur as properties or subproperties of an implementation, @@ -95,7 +95,7 @@ published service GroupAccess </p> <p>For properties that are objects themselves, the semantic documented for - service <type>HierarchyAccess</type> applies. + service HierarchyAccess applies. </p> */ [optional] interface com::sun::star::beans::XPropertyState; @@ -108,7 +108,7 @@ published service GroupAccess </p> <p>For properties that are objects themselves, the semantic documented for - service <type>HierarchyAccess</type> applies. + service HierarchyAccess applies. </p> */ [optional] interface com::sun::star::beans::XMultiPropertyStates; diff --git a/offapi/com/sun/star/configuration/GroupUpdate.idl b/offapi/com/sun/star/configuration/GroupUpdate.idl index 147bdbb174fd..12e0e596c372 100644 --- a/offapi/com/sun/star/configuration/GroupUpdate.idl +++ b/offapi/com/sun/star/configuration/GroupUpdate.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module configuration { /** provides write access to a predefined heterogeneous group of values and nested trees as part of a hierarchy. - <p>This service extends <type>GroupAccess</type> to support + <p>This service extends GroupAccess to support modifying values. </p> */ @@ -48,9 +48,9 @@ published service GroupUpdate <p>This service extends the interface <type scope="com::sun::star::container">XNameAccess</type> supported - by service <type>GroupAccess</type> to allow changing values. + by service GroupAccess to allow changing values. This strongly overlaps with functionality available through - <type>PropertyHierarchy</type> (from <type>GroupAccess</type>), so that + PropertyHierarchy (from GroupAccess), so that <code>xGroup.setPropertyValue( aName, aValue )</code> is equivalent to <code>xGroup.replaceByName( aName, aValue )</code>. </p> diff --git a/offapi/com/sun/star/configuration/HierarchyAccess.idl b/offapi/com/sun/star/configuration/HierarchyAccess.idl index ea910c62697d..1b3bcf1f99c6 100644 --- a/offapi/com/sun/star/configuration/HierarchyAccess.idl +++ b/offapi/com/sun/star/configuration/HierarchyAccess.idl @@ -45,7 +45,7 @@ module com { module sun { module star { module configuration { </p> <p>Implementations of this service usually also implement - service <type>HierarchyElement</type>, which concerns the complementary role + service HierarchyElement, which concerns the complementary role of being accessible as an element of the hierarchy. </p> */ diff --git a/offapi/com/sun/star/configuration/HierarchyElement.idl b/offapi/com/sun/star/configuration/HierarchyElement.idl index 7cc0c47519ff..dda2f5c74a03 100644 --- a/offapi/com/sun/star/configuration/HierarchyElement.idl +++ b/offapi/com/sun/star/configuration/HierarchyElement.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module configuration { </p> <p>Implementations of this service usually also implement - service <type>HierarchyAccess</type>, which concerns the complementary role + service HierarchyAccess, which concerns the complementary role of providing access to subelements of the hierarchy. </p> */ diff --git a/offapi/com/sun/star/configuration/PropertyHierarchy.idl b/offapi/com/sun/star/configuration/PropertyHierarchy.idl index b42842e4c915..8f52472b5021 100644 --- a/offapi/com/sun/star/configuration/PropertyHierarchy.idl +++ b/offapi/com/sun/star/configuration/PropertyHierarchy.idl @@ -41,7 +41,7 @@ module com { module sun { module star { module configuration { implement <type scope="com::sun::star::beans">XProperty</type> to allow direct access to information about the object. If such objects have properties of their own, they should fully implement - <type>PropertyHierarchy</type> again. + PropertyHierarchy again. */ published service PropertyHierarchy { diff --git a/offapi/com/sun/star/configuration/SetAccess.idl b/offapi/com/sun/star/configuration/SetAccess.idl index 4c555420d0aa..bcc0869e6fba 100644 --- a/offapi/com/sun/star/configuration/SetAccess.idl +++ b/offapi/com/sun/star/configuration/SetAccess.idl @@ -40,7 +40,7 @@ module com { module sun { module star { module configuration { </p> @see com::sun::star::configuration::SetElement - Child objects of this service generally implement <type>SetElement</type>. + Child objects of this service generally implement SetElement. The template name returned by the child from <member>XTemplateInstance::getTemplateName()</member> corresponds to the name returned by the set from @@ -66,7 +66,7 @@ published service SetAccess of a not necessarily hierarchical <em>set</em>. <p>Interface <type scope="com::sun::star::configuration">XTemplateContainer</type>, - which is optional in <type>SimpleSetAccess</type> must always be implemented + which is optional in SimpleSetAccess must always be implemented in this service, if the elements are of object type. </p> */ service SimpleSetAccess; diff --git a/offapi/com/sun/star/configuration/SetElement.idl b/offapi/com/sun/star/configuration/SetElement.idl index ec877b4467f2..8a37279311f2 100644 --- a/offapi/com/sun/star/configuration/SetElement.idl +++ b/offapi/com/sun/star/configuration/SetElement.idl @@ -43,7 +43,7 @@ module com { module sun { module star { module configuration { <p>New set element instances generally are created through members of <type scope="com::sun::star::lang">XSingleServiceFactory</type> or, if supported, <type scope="com::sun::star::lang">XMultiServiceFactory</type> - on an implementation of <type>SetUpdate</type>. Initially, they are not + on an implementation of SetUpdate. Initially, they are not contained in a set object and have no meaningful name. </p> @@ -140,13 +140,13 @@ published service SetElement <p>If the object was created using interface <type scope="com::sun::star::lang">XSingleServiceFactory</type> - on an implementation of <type>SetUpdate</type>, this interface describes the - same template as interface <type>XTemplateContainer</type> on that - <type>SetUpdate</type>. + on an implementation of SetUpdate, this interface describes the + same template as interface XTemplateContainer on that + SetUpdate. </p> <p>If the object was created using interface <type scope="com::sun::star::lang">XMultiServiceFactory</type> - on an implementation of <type>SetUpdate</type>, this interface describes the + on an implementation of SetUpdate, this interface describes the template whose name was used as a service identifier for the factory method. </p> <p>Otherwise, the semantics of the information provided about the template depends on the diff --git a/offapi/com/sun/star/configuration/SetUpdate.idl b/offapi/com/sun/star/configuration/SetUpdate.idl index 03b3f4fa71d2..517982a3a33d 100644 --- a/offapi/com/sun/star/configuration/SetUpdate.idl +++ b/offapi/com/sun/star/configuration/SetUpdate.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module configuration { Helps creates new elements to be added. </p> - <p>This service extends <type>SetAccess</type> to support + <p>This service extends SetAccess to support modifying the container. </p> diff --git a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl index d3c80b84a63b..d2b2e31a486f 100644 --- a/offapi/com/sun/star/configuration/SimpleSetUpdate.idl +++ b/offapi/com/sun/star/configuration/SimpleSetUpdate.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module configuration { Helps create new elements to be added. </p> - <p>This service extends <type>SimpleSetAccess</type> to support + <p>This service extends SimpleSetAccess to support modifying the container. Any child objects shall in turn support modifying access. </p> @@ -50,7 +50,7 @@ published service SimpleSetUpdate <p>This interface extends the interface <type scope="com::sun::star::container">XNameAccess</type> supported - by service <type>SimpleSetAccess</type> to allow modifying the container. + by service SimpleSetAccess to allow modifying the container. </p> <p>If available, changes can be observed by registering a listener with interface @@ -137,7 +137,7 @@ published service SimpleSetUpdate (as returned by <member scope="com::sun::star::container">XElementAccess::getElementType()</member>) is an object type, such as an interface. An implementation should also implement - interface <type>XTemplateContainer</type> which is optional in this service. + interface XTemplateContainer which is optional in this service. </p> <p>The service identifier argument passed diff --git a/offapi/com/sun/star/configuration/UpdateRootElement.idl b/offapi/com/sun/star/configuration/UpdateRootElement.idl index 5827c67c333e..fa2895b2e547 100644 --- a/offapi/com/sun/star/configuration/UpdateRootElement.idl +++ b/offapi/com/sun/star/configuration/UpdateRootElement.idl @@ -28,12 +28,12 @@ module com { module sun { module star { module configuration { /** provides update control for a hierarchy of configuration items and information about the hierarchy as a whole as well as its root. - <p>Extends <type>AccessRootElement</type> by adding support for + <p>Extends AccessRootElement by adding support for collecting changes and applying them to a backend store as a single batch. </p> <p>An implementation represents the root of a partial hierarchy. [See the - documentation for <type>AccessRootElement</type>]. The hierarchy in turn is + documentation for AccessRootElement]. The hierarchy in turn is a <em>view</em> onto a fragment of persistent data tree that can be accessed through several such views, or even several processes, simultaneously. </p> diff --git a/offapi/com/sun/star/configuration/backend/BackendAdapter.idl b/offapi/com/sun/star/configuration/backend/BackendAdapter.idl index 038d1043c508..ab708a7dc900 100644 --- a/offapi/com/sun/star/configuration/backend/BackendAdapter.idl +++ b/offapi/com/sun/star/configuration/backend/BackendAdapter.idl @@ -28,8 +28,8 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>Backend</type> retrieving data - from a <type>SingleBackend</type>. + implements Backend retrieving data + from a SingleBackend. @since OOo 1.1.2 */ @@ -42,7 +42,7 @@ published service BackendAdapter /** - This interface, that is optional in <type>Backend</type>, is + This interface, that is optional in Backend, is mandatory in this service. */ interface XBackendEntities ; @@ -51,7 +51,7 @@ published service BackendAdapter /** allows initializing the backend to use. - <p>If this interface is present, a <type>SingleBackend</type> + <p>If this interface is present, a SingleBackend may be passed, that is used to access the data. Also a <type scope="com::sun::star::configuration::bootstrap">BootstrapContext</type> can be passed, that provides further settings for the backend. diff --git a/offapi/com/sun/star/configuration/backend/CopyImporter.idl b/offapi/com/sun/star/configuration/backend/CopyImporter.idl index d1fdf00d1955..b614cbb05903 100644 --- a/offapi/com/sun/star/configuration/backend/CopyImporter.idl +++ b/offapi/com/sun/star/configuration/backend/CopyImporter.idl @@ -38,7 +38,7 @@ published service CopyImporter /** allows importing configuration data into a backend. <p> In this implementation, the changes are copied over any - <type>XLayer</type> data that already exists in the <type>Backend</type>, + XLayer data that already exists in the Backend, replacing it completely. </p> */ @@ -48,7 +48,7 @@ published service CopyImporter /** allows initializing the implementation with settings that control its behavior . - <p> This interface, which is optional in <type>Importer</type> + <p> This interface, which is optional in Importer is mandatory in this service and supports the following arguments which must be provided as <type scope="com::sun::star::beans">NamedValue</type>: diff --git a/offapi/com/sun/star/configuration/backend/DataImporter.idl b/offapi/com/sun/star/configuration/backend/DataImporter.idl index 1bad1ea9b456..1f17b903c5e3 100644 --- a/offapi/com/sun/star/configuration/backend/DataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/DataImporter.idl @@ -60,13 +60,13 @@ published service DataImporter <dl> <dt><code>ImporterService</code> : <atom >string</atom></dt> <dd>A service or implementation name used to instantiate the - <type>Importer</type> to use for importing. If this parameter + Importer to use for importing. If this parameter is missing, the implementation selects an appropriate importer. - By default, a <type>MergeImporter</type> should be used. + By default, a MergeImporter should be used. </dd> <dt><code>OverwriteExisting</code> : <atom >boolean</atom></dt> <dd>If <TRUE/>, specifies that no existing data should be - overwritten by the import. If the <type>Importer</type> used + 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. @@ -74,9 +74,9 @@ published service DataImporter <dt><code>TruncateExisting</code> : <atom >boolean</atom></dt> <dd>If <TRUE/>, specifies that existing data should be discarded and replaced by the imported data. - If the <type>Importer</type> used does not support this + If the Importer used does not support this operation, an error may be raised. - By default, a <type>CopyImporter</type> is used to perform + By default, a CopyImporter is used to perform truncating import. </dd> <dt><code>Entity</code> : <atom >string</atom></dt> diff --git a/offapi/com/sun/star/configuration/backend/DefaultBackend.idl b/offapi/com/sun/star/configuration/backend/DefaultBackend.idl index 1b06b3f80ee1..f125fb2a6d21 100644 --- a/offapi/com/sun/star/configuration/backend/DefaultBackend.idl +++ b/offapi/com/sun/star/configuration/backend/DefaultBackend.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module configuration { module backend { /** - is a <type>DefaultBackend</type>, that is - the default <type>DefaultBackend</type> for its + is a DefaultBackend, that is + the default DefaultBackend for its <type scope="com::sun::star::uno">XComponentContext</type>. <p>This object is accessible as singleton within the context</p>. diff --git a/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl index e54ce5091a2e..4797aab4ad4c 100644 --- a/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl +++ b/offapi/com/sun/star/configuration/backend/HierarchyBrowser.idl @@ -57,7 +57,7 @@ published service HierarchyBrowser is a list of components found. The format in which components are returned may depend on the implementation. Each implementation should support returning component identifiers that are compatible - with some implementation of <type>Backend</type>. + with some implementation of Backend. </p> */ interface com::sun::star::task::XJob ; diff --git a/offapi/com/sun/star/configuration/backend/Importer.idl b/offapi/com/sun/star/configuration/backend/Importer.idl index ddf963151aab..dd57765e7a0a 100644 --- a/offapi/com/sun/star/configuration/backend/Importer.idl +++ b/offapi/com/sun/star/configuration/backend/Importer.idl @@ -29,8 +29,8 @@ module com { module sun { module star { module configuration { module backend { /** imports data into a configuration layer. - <p> The configuration changes are read from a <type>XLayer</type> - and stored into a <type>Backend</type>. + <p> The configuration changes are read from a XLayer + and stored into a Backend. </p> @since OOo 1.1.2 diff --git a/offapi/com/sun/star/configuration/backend/InteractionHandler.idl b/offapi/com/sun/star/configuration/backend/InteractionHandler.idl index 3df643668c3b..040941b27731 100644 --- a/offapi/com/sun/star/configuration/backend/InteractionHandler.idl +++ b/offapi/com/sun/star/configuration/backend/InteractionHandler.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module configuration { module backend { <P>The well known requests handled by this service include <UL> - <LI><type>MergeRecoveryRequest</type>*</LI> + <LI>MergeRecoveryRequest*</LI> </UL> The requests marked with an asterisk are only handled if (a) their continuations match certain restrictions (see below), and (b) the diff --git a/offapi/com/sun/star/configuration/backend/LayerFilter.idl b/offapi/com/sun/star/configuration/backend/LayerFilter.idl index b4e6b8e20f0a..2f68527f8650 100644 --- a/offapi/com/sun/star/configuration/backend/LayerFilter.idl +++ b/offapi/com/sun/star/configuration/backend/LayerFilter.idl @@ -28,16 +28,16 @@ module com { module sun { module star { module configuration { module backend { /** - provides a filtered version of a configuration data <type>Layer</type>. + provides a filtered version of a configuration data Layer. - <p> A layer filter wraps a source <type>XLayer</type> object and + <p> A layer filter wraps a source XLayer object and provides access to a filtered version of its data. The data read from the filter usually is produced from the source data by adding and removing elements or modifying values. </p> @see com::sun::star::configuration::backend::DataImporter - Service that supports applying a <type>LayerFilter</type> to imported data. + Service that supports applying a LayerFilter to imported data. @since OOo 2.0 */ @@ -61,7 +61,7 @@ published service LayerFilter with a single argument of type <type scope="com::sun::star::beans">NamedValue</type>, where <member scope="com::sun::star::beans">NamedValue::Name</member> is <code>"Source"</code> and <member scope="com::sun::star::beans">NamedValue::Value</member> - is an object implementing <type>XLayer</type>. + is an object implementing XLayer. </p> */ interface com::sun::star::lang::XInitialization ; diff --git a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl index c63ae4633898..c9bd5628414f 100644 --- a/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl +++ b/offapi/com/sun/star/configuration/backend/LayerUpdateMerger.idl @@ -29,9 +29,9 @@ module com { module sun { module star { module configuration { module backend { /** applies updates to a configuration layer. - <p> The configuration layer data is read from a <type>XLayer</type> - and the changed layer is provided as <type>XLayer</type> again or - described to a <type>XLayerHandler</type>. + <p> The configuration layer data is read from a XLayer + and the changed layer is provided as XLayer again or + described to a XLayerHandler. </p> @see com::sun::star::configuration::backend::UpdatableLayer @@ -50,9 +50,9 @@ published service LayerUpdateMerger /** allows initializing layer data source and target. <p> Both source and target of the update can be provided by passing a - <type>XUpdatableLayer</type> object. Alternatively they can be - provided individually by providing a <type>XLayer</type> object as - data source and an <type>XLayerHandler</type> object to receive the + XUpdatableLayer object. Alternatively they can be + provided individually by providing a XLayer object as + data source and an XLayerHandler object to receive the updated data. </p> <p> Implementations can provide more arguments to fine tune the behavior. diff --git a/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl index ed978e35df85..074034cadeb0 100644 --- a/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/LdapMultiLayerStratum.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>MultiLayerStratum</type> that + implements MultiLayerStratum that provides access to a multiple layers of configuration data from LDAP source */ service LdapMultiLayerStratum diff --git a/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl b/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl index 42a281c9257a..c39e06333796 100644 --- a/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl +++ b/offapi/com/sun/star/configuration/backend/LdapSingleBackend.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>SingleBackend</type> that stores data in an + implements SingleBackend that stores data in an LDAP directory. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl b/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl index d41387679870..db95e6676861 100644 --- a/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl +++ b/offapi/com/sun/star/configuration/backend/LdapSingleStratum.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>SingleLayerStratum</type> that + implements SingleLayerStratum that provides access to a single layer of configuration data from LDAP source */ service LdapSingleStratum diff --git a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl index a1a1d5e17fa2..71fd003c180b 100644 --- a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl +++ b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl @@ -27,12 +27,12 @@ module com { module sun { module star { module configuration { module backend { /** allows importing data from a local configuration data repository - or file into any <type>Backend</type>. + or file into any Backend. <p> Data to be imported can be a single layer either from a full local configuration database or from a particular OOR Update XML file. </p> - <p> Data is imported into the <type>DefaultBackend</type>. + <p> Data is imported into the DefaultBackend. </p> @see com::sun::star::configuration::backend::LocalHierarchyBrowser @@ -82,8 +82,8 @@ published service LocalDataImporter </dl> </p> <p> Implementations may support additional parameters to select - a destination <type>Backend</type>, that is not the - <type>DefaultBackend</type>. + a destination Backend, that is not the + DefaultBackend. </p> */ service DataImporter ; diff --git a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl index e7f824c8b332..42c0bebd3b21 100644 --- a/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl +++ b/offapi/com/sun/star/configuration/backend/LocalHierarchyBrowser.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - is a <type>HierarchyBrowser</type>, that browses a configuration database + is a HierarchyBrowser, that browses a configuration database stored in the local file system. @see com::sun::star::configuration::backend::LocalSingleBackend diff --git a/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl b/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl index 1648b00f662f..9ccb603635d0 100644 --- a/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl +++ b/offapi/com/sun/star/configuration/backend/LocalSchemaSupplier.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>SchemaSupplier</type> providing access to + implements SchemaSupplier providing access to local configuration schemas */ service LocalSchemaSupplier diff --git a/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl b/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl index 87d0df99440f..97a4b883c5c9 100644 --- a/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl +++ b/offapi/com/sun/star/configuration/backend/LocalSingleBackend.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>SingleBackend</type> that stores data in the + implements SingleBackend that stores data in the local file system using the OOR XML formats. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl b/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl index 910abc331d56..598fd305389b 100644 --- a/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl +++ b/offapi/com/sun/star/configuration/backend/LocalSingleStratum.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>SingleLayerStratum</type> that + implements SingleLayerStratum that provides access to a singe layer of configuration data from local file system */ service LocalSingleStratum diff --git a/offapi/com/sun/star/configuration/backend/MergeImporter.idl b/offapi/com/sun/star/configuration/backend/MergeImporter.idl index 1d9ed1fcec7f..4dbbbe5e4fad 100644 --- a/offapi/com/sun/star/configuration/backend/MergeImporter.idl +++ b/offapi/com/sun/star/configuration/backend/MergeImporter.idl @@ -42,7 +42,7 @@ published service MergeImporter /** allows importing configuration data into a backend. <p> In this implementation, the changes are merged with any - <type>XLayer</type> data that already exists in the <type>Backend</type>, + XLayer data that already exists in the Backend, replacing it completely. </p> diff --git a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl index ae38140be657..4f253995e9d0 100644 --- a/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl +++ b/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl @@ -41,10 +41,10 @@ exception MergeRecoveryRequest: ::com::sun::star::uno::Exception </p> <p> For example the following exceptions may be used: <dl> - <dt><type>MalformedException</type></dt> + <dt>MalformedException</dt> <dd>for layers containing invalid data.</dd> - <dt><type>BackendAccessException</type></dt> + <dt>BackendAccessException</dt> <dd>for layers that can't be accessed.</dd> </dl> </p> diff --git a/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl b/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl index acb031fa51ef..8190bfa4454f 100644 --- a/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl +++ b/offapi/com/sun/star/configuration/backend/MultiStratumBackend.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>Backend</type> provides access to a configuration database + implements Backend provides access to a configuration database composed of one or more storage backends containing settings used by software modules. */ service MultiStratumBackend diff --git a/offapi/com/sun/star/configuration/backend/NodeAttribute.idl b/offapi/com/sun/star/configuration/backend/NodeAttribute.idl index 15ce009deef9..ac1a24093824 100644 --- a/offapi/com/sun/star/configuration/backend/NodeAttribute.idl +++ b/offapi/com/sun/star/configuration/backend/NodeAttribute.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module configuration { module backend { in a layer. <p> The values were chosen so they can be combined with values from - <type>SchemaAttribute</type> + SchemaAttribute </p> @see com::sun::star::configuration::backend::SchemaAttribute diff --git a/offapi/com/sun/star/configuration/backend/OfflineBackend.idl b/offapi/com/sun/star/configuration/backend/OfflineBackend.idl index 7f1917a6c077..f9e6aa0eb0c6 100644 --- a/offapi/com/sun/star/configuration/backend/OfflineBackend.idl +++ b/offapi/com/sun/star/configuration/backend/OfflineBackend.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>BackendAdapter</type> that maintains a cache so it - can operate even if the <type>SingleBackend</type> holding the data + implements BackendAdapter that maintains a cache so it + can operate even if the SingleBackend holding the data is inaccessible. @see com::sun::star::configuration::backend::OnlineBackend @@ -37,19 +37,19 @@ module com { module sun { module star { module configuration { module backend { published service OfflineBackend { - /** provides access to configuration data from a <type>SingleBackend</type>. + /** provides access to configuration data from a SingleBackend. <p>If no backend is provided during initialization or if the context contains an <code>Offline</code> flag that is <TRUE/>, then off-line mode is activated. This may fail, if the off-line cache has not been filled during a previous execution. </p> - <p>Less entities may be available from <type>XBackendEntities</type>, + <p>Less entities may be available from XBackendEntities, when operating in off-line mode than when operating with an on-line - <type>SingleBackend</type>. + SingleBackend. </p> <p>If off-line mode is not invoked, the implementation behaves - like any other <type>BackendAdapter</type>. + like any other BackendAdapter. </p> */ diff --git a/offapi/com/sun/star/configuration/backend/OnlineBackend.idl b/offapi/com/sun/star/configuration/backend/OnlineBackend.idl index 4a0cb1e6b181..9822ae5bacb5 100644 --- a/offapi/com/sun/star/configuration/backend/OnlineBackend.idl +++ b/offapi/com/sun/star/configuration/backend/OnlineBackend.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module configuration { module backend { /** - implements a <type>BackendAdapter</type> that requires that - the <type>SingleBackend</type> holding the data + implements a BackendAdapter that requires that + the SingleBackend holding the data is continuously accessible. @see com::sun::star::configuration::backend::OfflineBackend @@ -37,7 +37,7 @@ module com { module sun { module star { module configuration { module backend { published service OnlineBackend { - /** provides access to configuration data from a <type>SingleBackend</type>. + /** provides access to configuration data from a SingleBackend. */ service BackendAdapter ; diff --git a/offapi/com/sun/star/configuration/backend/PlatformBackend.idl b/offapi/com/sun/star/configuration/backend/PlatformBackend.idl index 141273c6ecf5..fecc0b9007c0 100644 --- a/offapi/com/sun/star/configuration/backend/PlatformBackend.idl +++ b/offapi/com/sun/star/configuration/backend/PlatformBackend.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module configuration { module backend { /** - implements <type>SingleLayerStratum</type> that + implements SingleLayerStratum that provides access to a singe layer of configuration data from external data store */ service PlatformBackend diff --git a/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl b/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl index cb33f595f320..da6ecb788221 100644 --- a/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl +++ b/offapi/com/sun/star/configuration/backend/SingleBackendAdapter.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module configuration { module backend { /** - implements a simple <type>BackendAdapter</type> that can be used for + implements a simple BackendAdapter that can be used for normal configuration operation. - <p>All real functionality is provided by the wrapped <type>SingleBackend</type>. + <p>All real functionality is provided by the wrapped SingleBackend. @see com::sun::star::configuration::backend::OnlineBackend @@ -38,7 +38,7 @@ module com { module sun { module star { module configuration { module backend { published service SingleBackendAdapter { - /** provides access to configuration data from a <type>SingleBackend</type>. + /** provides access to configuration data from a SingleBackend. */ service BackendAdapter ; diff --git a/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl b/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl index e4529add05dc..52c7b1c48828 100644 --- a/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl +++ b/offapi/com/sun/star/configuration/backend/UpdatableLayer.idl @@ -59,8 +59,8 @@ published service UpdatableLayer /** provides write access to the contents of the layer. - <p> Depending of the actual type (simple, i.e pure <type>XLayer</type> or - composite, i.e <type>XCompositeLayer</type>) of the current layer and + <p> Depending of the actual type (simple, i.e pure XLayer or + composite, i.e XCompositeLayer) of the current layer and the provided replacement layer, the operation performed by <member>XUpdatableLayer::replaceWith()</member>, will vary. </p> @@ -89,7 +89,7 @@ published service UpdatableLayer </dd> </dl> - <em> Not all implementations of <type>XUpdatableLayer</type> + <em> Not all implementations of XUpdatableLayer support conversions of the replacement layer. In such a case the sublayers of the provided layer may be ignored or all simple data be merged into the main layer. diff --git a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl index 8ac34eb76ee2..4f1ec9a926cf 100644 --- a/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl @@ -55,7 +55,7 @@ published interface XCompositeLayer : XLayer /** Describes the content of a particular sublayer to - an <type>XLayerHandler</type>. + an XLayerHandler. @param aHandler Handler object that will receive calls @@ -75,7 +75,7 @@ published interface XCompositeLayer : XLayer if an error occurs in the access to or processing of the data. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the - <type>XLayerHandler</type>. + XLayerHandler. */ void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId) raises (com::sun::star::lang::NullPointerException, diff --git a/offapi/com/sun/star/configuration/backend/XLayer.idl b/offapi/com/sun/star/configuration/backend/XLayer.idl index 3656231e1802..4d85f5f6402c 100644 --- a/offapi/com/sun/star/configuration/backend/XLayer.idl +++ b/offapi/com/sun/star/configuration/backend/XLayer.idl @@ -38,7 +38,7 @@ published interface XLayer : ::com::sun::star::uno::XInterface { /** - describes the contents of the layer to an <type>XLayerHandler</type>. + describes the contents of the layer to an XLayerHandler. @param aHandler Handler object that will receive calls @@ -50,7 +50,7 @@ published interface XLayer : ::com::sun::star::uno::XInterface if an error occurs in the access to or processing of the data. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the - <type>XLayerHandler</type>. + XLayerHandler. */ void readData([in] XLayerHandler aHandler) raises (com::sun::star::lang::NullPointerException, diff --git a/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl b/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl index 33ae5c635d32..0439a023ad6c 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerContentDescriber.idl @@ -39,7 +39,7 @@ interface XLayerContentDescriber : ::com::sun::star::uno::XInterface { /** - describes the contents of the layer to an <type>XLayerHandler</type>. + describes the contents of the layer to an XLayerHandler. @param aHandler Handler object that will receive calls @@ -53,7 +53,7 @@ interface XLayerContentDescriber : ::com::sun::star::uno::XInterface if a <NULL/> handler is passed. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the - <type>XLayerHandler</type>. + XLayerHandler. */ void describeLayer([in] XLayerHandler aHandler, [in] sequence<PropertyInfo> aPropertyInfos) diff --git a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl index d23a47b75626..25a453928153 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerHandler.idl @@ -90,7 +90,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies attribute values to be applied to the node. <p> The value is a combination of - <type>NodeAttribute</type> flags. + NodeAttribute flags. </p> <p> The attributes are combined cumulatively with those set on lower layers. @@ -144,7 +144,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies attribute values to be applied to the new node. <p> The value is a combination of - <type>NodeAttribute</type> flags. Note that + NodeAttribute flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. </p> @@ -192,7 +192,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies attribute values to be applied to the new node. <p> The value is a combination of - <type>NodeAttribute</type> flags. Note that + NodeAttribute flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. </p> @@ -282,7 +282,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies the new attributes of the property. <p> The value is a combination of - <type>NodeAttribute</type> flags. + NodeAttribute flags. </p> <p> The attributes are combined cumulatively with those set on lower layers. @@ -440,7 +440,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies the attributes of the new property. <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + NodeAttribute flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> <p> <const>NodeAttribute::MANDATORY</const> need not be set, @@ -486,7 +486,7 @@ published interface XLayerHandler: ::com::sun::star::uno::XInterface specifies the attributes of the new property. <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + NodeAttribute flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> </p> diff --git a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl index b3fc58a673d8..96c34e5bfd37 100644 --- a/offapi/com/sun/star/configuration/backend/XLayerImporter.idl +++ b/offapi/com/sun/star/configuration/backend/XLayerImporter.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module configuration { module backend { -/** allows importing a layer into a <type>Backend</type> +/** allows importing a layer into a Backend @since OOo 1.1.2 */ @@ -41,7 +41,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface /** gets the target backend for importing. @returns - the <type>Backend</type> into which layers are + the Backend into which layers are imported by <member>XLayerImporter::importLayer()<member/>. */ @@ -51,7 +51,7 @@ published interface XLayerImporter : ::com::sun::star::uno::XInterface /** sets the target backend for importing. @param aBackend - a <type>Backend</type> into which layers should be + a Backend into which layers should be imported by <method>XLayerImporter::importLayer()<method/>. @throws com::sun::star::lang::NullPointerException diff --git a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl index c071add3ea92..48ba982ec3fe 100644 --- a/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XMultiLayerStratum.idl @@ -61,7 +61,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @return a list of layer identifiers that can be used to - retrieve <type>Layer</type> objects. + retrieve Layer objects. <p> The list is ordered by priority. Typically the most general layers (global defaults, entire organization) are first, more specific layers @@ -104,7 +104,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface @returns a layer identifier that can be used to obtain - an <type>UpdatableLayer</type> object. + an UpdatableLayer object. @throws com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or @@ -153,7 +153,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface </p> @returns - a <type>Layer</type> object providing access to the layer data, + a Layer object providing access to the layer data, <NULL/> if the layer is newer than indicated by the timestamp. @throws com::sun::star::lang::IllegalArgumentException @@ -196,7 +196,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface </p> @returns - a list of <type>Layer</type> objects + a list of Layer objects providing access to the layer data. <p> The list has the same length as aLayerIds. Each layer object is associated to the layer id in the corresponding @@ -250,7 +250,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface </p> @returns - a list of <type>Layer</type> objects + a list of Layer objects providing access to the layer data. <p> The list has the same length as aLayerIds. Each layer object is associated to the layer id in the corresponding @@ -287,7 +287,7 @@ published interface XMultiLayerStratum : ::com::sun::star::uno::XInterface </p> @return - an <type>UpdatableLayer</type> object providing + an UpdatableLayer object providing write access to the layer @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/configuration/backend/XSchema.idl b/offapi/com/sun/star/configuration/backend/XSchema.idl index 1916944a5f7c..d061a8cf3a81 100644 --- a/offapi/com/sun/star/configuration/backend/XSchema.idl +++ b/offapi/com/sun/star/configuration/backend/XSchema.idl @@ -40,7 +40,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface /** Describes the full schema (templates + component) to a - <type>XSchemaHandler</type>. + XSchemaHandler. @param aHandler schema handler that will receive calls @@ -51,12 +51,12 @@ published interface XSchema : ::com::sun::star::uno::XInterface if a <NULL/> handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or - if a subsequent call to any of the <type>XSchema</type>methods is made. + if a subsequent call to any of the XSchemamethods is made. The elements of a component schema are only parsed once,a repeat call leads to exception. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the - <type>XSchemaHandler</type>. + XSchemaHandler. */ void readSchema([in] XSchemaHandler aHandler) raises (com::sun::star::lang::NullPointerException, @@ -65,7 +65,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface /** - Describes only the component definition to a <type>XSchemaHandler</type>. + Describes only the component definition to a XSchemaHandler. @param aHandler schema handler that will receive calls @@ -76,12 +76,12 @@ published interface XSchema : ::com::sun::star::uno::XInterface if a <NULL/> handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or - if a subsequent call to any of the <type>XSchema</type>methods is made. + if a subsequent call to any of the XSchemamethods is made. The elements of a component schema are only parsed once,a repeat call leads to exception. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the - <type>XSchemaHandler</type>. + XSchemaHandler. */ void readComponent([in] XSchemaHandler aHandler) raises (com::sun::star::lang::NullPointerException, @@ -90,7 +90,7 @@ published interface XSchema : ::com::sun::star::uno::XInterface /** - Describes the component templates to a <type>XSchemaHandler</type>. + Describes the component templates to a XSchemaHandler. @param aHandler schema handler that will receive calls @@ -100,12 +100,12 @@ published interface XSchema : ::com::sun::star::uno::XInterface if a <NULL/> handler is passed. @throws com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or - if a subsequent call to any of the <type>XSchema</type>methods is made. + if a subsequent call to any of the XSchemamethods is made. The elements of a component schema are only parsed once,a repeat call leads to exception. @throws com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the - <type>XSchemaHandler</type>. + XSchemaHandler. */ void readTemplates([in] XSchemaHandler aHandler) raises (com::sun::star::lang::NullPointerException, diff --git a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl index bb15f646ab8b..8798935d726a 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl @@ -155,7 +155,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the attributes of the template. <p> The value is a combination of - <type>SchemaAttribute</type> flags. + SchemaAttribute flags. </p> <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used to describe a template for a node with an extensible @@ -197,7 +197,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the attributes of the template. <p> The value is a combination of - <type>SchemaAttribute</type> flags. + SchemaAttribute flags. </p> <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used to describe a template for a node with an extensible @@ -266,7 +266,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the attributes of the node. <p> The value is a combination of - <type>SchemaAttribute</type> flags. + SchemaAttribute flags. </p> <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used to describe a group with an extensible set of properties. @@ -305,7 +305,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the attributes of the node. <p> The value is a combination of - <type>SchemaAttribute</type> flags. + SchemaAttribute flags. </p> <p> <const>SchemaAttribute::EXTENSIBLE</const> can be used to describe a set with an extensible set of properties. @@ -370,7 +370,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the attributes of the new property. <p> The value is a combination of - <type>SchemaAttribute</type> flags. + SchemaAttribute flags. </p> @param aType @@ -408,7 +408,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface specifies the attributes of the new property. <p> The value is a combination of - <type>SchemaAttribute</type> flags. + SchemaAttribute flags. </p> @param aDefaultValue diff --git a/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl b/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl index 5a4a7b4790dc..10a45dcfc6be 100644 --- a/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl +++ b/offapi/com/sun/star/configuration/backend/XSingleLayerStratum.idl @@ -70,7 +70,7 @@ published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface </p> @returns - a <type>Layer</type> object providing access to the layer data, + a Layer object providing access to the layer data, <NULL/> if the layer is newer than indicated by the timestamp. @throws com::sun::star::lang::IllegalArgumentException @@ -95,7 +95,7 @@ published interface XSingleLayerStratum : ::com::sun::star::uno::XInterface The name of the component to access. @return - an <type>UpdatableLayer</type> object providing + an UpdatableLayer object providing write access to the layer @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl index 76d70aee0ec9..a0ac6338f07c 100644 --- a/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XUpdateHandler.idl @@ -97,7 +97,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface current layer. <p> The value is a combination of - <type>NodeAttribute</type> flags. + NodeAttribute flags. </p> <p> Only attributes which are selected in aAttributeMask are changed. @@ -107,7 +107,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies which attributes should be changed for the node. <p> The value is a combination of - <type>NodeAttribute</type> flags. + NodeAttribute flags. </p> @param bReset @@ -159,7 +159,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies attribute values to be applied to the new node. <p> The value is a combination of - <type>NodeAttribute</type> flags. Note that + NodeAttribute flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. </p> @@ -206,7 +206,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies attribute values to be applied to the new node. <p> The value is a combination of - <type>NodeAttribute</type> flags. Note that + NodeAttribute flags. Note that <member>NodeAttribute::FUSE</member> has an impact on the semantics of this method. </p> @@ -296,7 +296,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies new attributes of the property. <p> The value is a combination of - <type>NodeAttribute</type> flags. + NodeAttribute flags. </p> <p> Only attributes which are selected in aAttributeMask are changed. </p> @@ -309,7 +309,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies which attributes should be changed for the property. <p> The value is a combination of - <type>NodeAttribute</type> flags. + NodeAttribute flags. </p> @param aType @@ -510,7 +510,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies the attributes of the new property. <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + NodeAttribute flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> </p> @@ -559,7 +559,7 @@ published interface XUpdateHandler: ::com::sun::star::uno::XInterface specifies the attributes of the new property. <p> The value is a combination of - <type>NodeAttribute</type> flags and may also contain the + NodeAttribute flags and may also contain the <const>SchemaAttribute::REQUIRED</const> flag. </p> </p> diff --git a/offapi/com/sun/star/configuration/theDefaultProvider.idl b/offapi/com/sun/star/configuration/theDefaultProvider.idl index a8e51d92cfa0..f0473beb16ae 100644 --- a/offapi/com/sun/star/configuration/theDefaultProvider.idl +++ b/offapi/com/sun/star/configuration/theDefaultProvider.idl @@ -17,12 +17,12 @@ module com { module sun { module star { module lang { module com { module sun { module star { module configuration { /** - The default <type>ConfigurationProvider</type>. + The default ConfigurationProvider. <p>This singleton somewhat arbitrarily makes available the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface of - the (old-style) <type>DefaultProvider</type> service, as it is the most - frequently used one. See the <type>DefaultProvider</type> service for + the (old-style) DefaultProvider service, as it is the most + frequently used one. See the DefaultProvider service for details.</p> @since OOo 1.1.2 |