summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/util
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-27 21:47:17 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:00:59 +0200
commit944eb9902788d8afec9e3f0f65d3b680041e039b (patch)
tree3bbb926890561b81d9f6ae611be4677876799a36 /offapi/com/sun/star/util
parentcdbbbdce9956e290b4a849af332df55da1be8d36 (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/util')
-rw-r--r--offapi/com/sun/star/util/AliasProgrammaticPair.idl2
-rw-r--r--offapi/com/sun/star/util/DataEditorEvent.idl2
-rw-r--r--offapi/com/sun/star/util/DataEditorEventType.idl2
-rw-r--r--offapi/com/sun/star/util/Duration.idl2
-rw-r--r--offapi/com/sun/star/util/NumberFormatProperties.idl2
-rw-r--r--offapi/com/sun/star/util/PathSettings.idl2
-rw-r--r--offapi/com/sun/star/util/SearchOptions.idl2
-rw-r--r--offapi/com/sun/star/util/URL.idl6
-rw-r--r--offapi/com/sun/star/util/XChangesSet.idl2
-rw-r--r--offapi/com/sun/star/util/XCloseBroadcaster.idl2
-rw-r--r--offapi/com/sun/star/util/XCloseListener.idl6
-rw-r--r--offapi/com/sun/star/util/XCloseable.idl8
-rw-r--r--offapi/com/sun/star/util/XDataEditor.idl4
-rw-r--r--offapi/com/sun/star/util/XDataEditorListener.idl4
-rw-r--r--offapi/com/sun/star/util/XNumberFormatTypes.idl2
-rw-r--r--offapi/com/sun/star/util/XNumberFormats.idl6
-rw-r--r--offapi/com/sun/star/util/XNumberFormatsSupplier.idl4
-rw-r--r--offapi/com/sun/star/util/XNumberFormatter.idl12
-rw-r--r--offapi/com/sun/star/util/XNumberFormatter2.idl4
-rw-r--r--offapi/com/sun/star/util/XReplaceable.idl2
-rw-r--r--offapi/com/sun/star/util/XSearchable.idl2
-rw-r--r--offapi/com/sun/star/util/XStringAbbreviation.idl6
22 files changed, 42 insertions, 42 deletions
diff --git a/offapi/com/sun/star/util/AliasProgrammaticPair.idl b/offapi/com/sun/star/util/AliasProgrammaticPair.idl
index c6c7b55eed6e..f940748e6cf7 100644
--- a/offapi/com/sun/star/util/AliasProgrammaticPair.idl
+++ b/offapi/com/sun/star/util/AliasProgrammaticPair.idl
@@ -23,7 +23,7 @@ module com { module sun { module star { module util {
/** represents an entry from a component which implements the
- <type>XLocalizedAliases</type>.
+ XLocalizedAliases.
*/
published struct AliasProgrammaticPair
{
diff --git a/offapi/com/sun/star/util/DataEditorEvent.idl b/offapi/com/sun/star/util/DataEditorEvent.idl
index 017d5fafbb04..c216bcc50ef7 100644
--- a/offapi/com/sun/star/util/DataEditorEvent.idl
+++ b/offapi/com/sun/star/util/DataEditorEvent.idl
@@ -26,7 +26,7 @@
module com { module sun { module star { module util {
-/** specifies an event broadcasted by an <type>XDataEditor</type>.
+/** specifies an event broadcasted by an XDataEditor.
*/
published struct DataEditorEvent: com::sun::star::lang::EventObject
{
diff --git a/offapi/com/sun/star/util/DataEditorEventType.idl b/offapi/com/sun/star/util/DataEditorEventType.idl
index dc63b8510a2c..e6cd50570c49 100644
--- a/offapi/com/sun/star/util/DataEditorEventType.idl
+++ b/offapi/com/sun/star/util/DataEditorEventType.idl
@@ -22,7 +22,7 @@
module com { module sun { module star { module util {
-/** specifies the type of an event from an <type>XDataEditor</type>.
+/** specifies the type of an event from an XDataEditor.
*/
published enum DataEditorEventType
{
diff --git a/offapi/com/sun/star/util/Duration.idl b/offapi/com/sun/star/util/Duration.idl
index 519e837fef1a..03b58b7c0dc4 100644
--- a/offapi/com/sun/star/util/Duration.idl
+++ b/offapi/com/sun/star/util/Duration.idl
@@ -28,7 +28,7 @@ module com { module sun { module star { module util {
/** represents a duration.
<p>
- A duration is the difference of 2 <type>DateTime</type>s.
+ A duration is the difference of 2 DateTimes.
</p>
<p>
diff --git a/offapi/com/sun/star/util/NumberFormatProperties.idl b/offapi/com/sun/star/util/NumberFormatProperties.idl
index 3a1aeb123019..39abbaec62c5 100644
--- a/offapi/com/sun/star/util/NumberFormatProperties.idl
+++ b/offapi/com/sun/star/util/NumberFormatProperties.idl
@@ -26,7 +26,7 @@
module com { module sun { module star { module util {
-/** contains properties specifying the behavior of a <type>NumberFormatter</type>.
+/** contains properties specifying the behavior of a NumberFormatter.
@see NumberFormatter
*/
diff --git a/offapi/com/sun/star/util/PathSettings.idl b/offapi/com/sun/star/util/PathSettings.idl
index b43bba6eebb1..14b0d3fba30a 100644
--- a/offapi/com/sun/star/util/PathSettings.idl
+++ b/offapi/com/sun/star/util/PathSettings.idl
@@ -34,7 +34,7 @@ module com { module sun { module star { module util {
(org/openoffice/Office/Common.xml).<br>
This service supports the usage of path variables to define
paths that a relative to other office or system directories.
- See <type>PathSubstitution</type>
+ See PathSubstitution
</p>
@since OOo 1.1.2
diff --git a/offapi/com/sun/star/util/SearchOptions.idl b/offapi/com/sun/star/util/SearchOptions.idl
index 0b9426565f21..0ee292f32443 100644
--- a/offapi/com/sun/star/util/SearchOptions.idl
+++ b/offapi/com/sun/star/util/SearchOptions.idl
@@ -35,7 +35,7 @@ published struct SearchOptions {
/** some flags - can be mixed
- @see <type>SearchFlags</type>
+ @see SearchFlags
*/
long searchFlag;
diff --git a/offapi/com/sun/star/util/URL.idl b/offapi/com/sun/star/util/URL.idl
index cbdff9abcc7c..25f1f93d8fcb 100644
--- a/offapi/com/sun/star/util/URL.idl
+++ b/offapi/com/sun/star/util/URL.idl
@@ -28,7 +28,7 @@ module com { module sun { module star { module util {
<p>
If the structure represents a valid URL or not depends on prior usage of
- the functions of <type>XURLTransformer</type>. Only after one of the functions
+ the functions of XURLTransformer. Only after one of the functions
returned <TRUE/> this can be assumed.</br>
It is not necessary to set all of the fields; either <member>URL::Complete</member>
or (some of) the others are set. Additionally, most of the other
@@ -47,7 +47,7 @@ published struct URL
<p>
It is used as a central input/output or input parameter for the interfaces of
- <type>XURLTransformer</type>. The usage of one of the <type>XURLTransformer</type>
+ XURLTransformer. The usage of one of the XURLTransformer
function is mandatory to validate the URL. It cannot be assumed that
<member>URL::Complete</member> represents always a valid URL!
</p>
@@ -85,7 +85,7 @@ published struct URL
/** contains the last segment of the hierarchical path of the URL, for the above example, "foo.txt"
<p>
- <strong>Attention:</strong>A service implementing the <type>XURLTransformer</type> interface
+ <strong>Attention:</strong>A service implementing the XURLTransformer interface
will normally not detect if the last segment is a folder or a file. So it is possible that
the last segment describes a folder. If you want to be sure that a file URL that references
a folder will be correctly put into the URL fields you should append a "/" at the end of the
diff --git a/offapi/com/sun/star/util/XChangesSet.idl b/offapi/com/sun/star/util/XChangesSet.idl
index 3190e6e05a9d..96efc8206b4e 100644
--- a/offapi/com/sun/star/util/XChangesSet.idl
+++ b/offapi/com/sun/star/util/XChangesSet.idl
@@ -43,7 +43,7 @@ published interface XChangesSet: com::sun::star::container::XElementAccess
{
/** queries for all contained changes at once.
- @returns an array of <type>ElementChange</type> holding information about
+ @returns an array of ElementChange holding information about
each changes that is part of this object.
*/
sequence<ElementChange> getAllChanges();
diff --git a/offapi/com/sun/star/util/XCloseBroadcaster.idl b/offapi/com/sun/star/util/XCloseBroadcaster.idl
index bb87ae11b9f4..1882ddfd430e 100644
--- a/offapi/com/sun/star/util/XCloseBroadcaster.idl
+++ b/offapi/com/sun/star/util/XCloseBroadcaster.idl
@@ -30,7 +30,7 @@
<p>
The called object for closing must post the closing events immediately
and before any internal cancel operations will be started.
- If a listener disagree with that it should throw a <type>CloseVetoException</type>
+ If a listener disagree with that it should throw a CloseVetoException
and called function <method>XCloseable::close</method> must be broken immediately.
It's not allowed to catch it inside the close() request.
If no listener nor internal processes hinder the object on closing
diff --git a/offapi/com/sun/star/util/XCloseListener.idl b/offapi/com/sun/star/util/XCloseListener.idl
index 7c20530e968d..2c064c102433 100644
--- a/offapi/com/sun/star/util/XCloseListener.idl
+++ b/offapi/com/sun/star/util/XCloseListener.idl
@@ -30,11 +30,11 @@
is called for closing
<p>
- Such close events are broadcasted by a <type>XCloseBroadcaster</type>
+ Such close events are broadcasted by a XCloseBroadcaster
if somewhere tries to close it by calling <member>XCloseable::close()</member>.
Listener can:
<ul>
- <li>break that by throwing <type>CloseVetoException</type></li>
+ <li>break that by throwing CloseVetoException</li>
<li>or accept that by deregister himself at this broadcaster.</li>
</ul>
</p>
@@ -54,7 +54,7 @@ published interface XCloseListener: com::sun::star::lang::XEventListener
<p>
Is called before <member>XCloseListener::notifyClosing()</member>.
- Listener has the chance to break that by throwing a <type>CloseVetoException</type>.
+ Listener has the chance to break that by throwing a CloseVetoException.
This exception must be passed to the original caller of <member>XCloseable::close()</member>
without any interaction.
</p>
diff --git a/offapi/com/sun/star/util/XCloseable.idl b/offapi/com/sun/star/util/XCloseable.idl
index 90339abb36e3..fc0361a065bf 100644
--- a/offapi/com/sun/star/util/XCloseable.idl
+++ b/offapi/com/sun/star/util/XCloseable.idl
@@ -41,7 +41,7 @@ module com { module sun { module star { module util {
</p>
<p>
- Base interface <type>XCloseBroadcaster</type> makes it possible that any listener
+ Base interface XCloseBroadcaster makes it possible that any listener
which is interested on life time of listened object ...
<ul>
<li>can get a notification about closing of it</li>
@@ -62,12 +62,12 @@ published interface XCloseable: XCloseBroadcaster
But nobody can guarantee real closing of called object - because it can disagree with that if any
still running processes can't be canceled yet. It's not allowed to block this call till internal
operations will be finished here. They must be canceled or call must return immediately by throwing
- the <type>CloseVetoException</type>. Otherwise (if nothing exist to disagree) it must return normally.
+ the CloseVetoException. Otherwise (if nothing exist to disagree) it must return normally.
</p>
<p>
- Before any internal processes will be canceled, all registered <type>XCloseListener</type>
- must be notified. Any of them can disagree with a <type>CloseVetoException</type> too.
+ Before any internal processes will be canceled, all registered XCloseListener
+ must be notified. Any of them can disagree with a CloseVetoException too.
It's forbidden to catch this exception inside the called close() method because the caller must
get this information!
</p>
diff --git a/offapi/com/sun/star/util/XDataEditor.idl b/offapi/com/sun/star/util/XDataEditor.idl
index 0ff0280cba6a..b2532396409a 100644
--- a/offapi/com/sun/star/util/XDataEditor.idl
+++ b/offapi/com/sun/star/util/XDataEditor.idl
@@ -43,11 +43,11 @@ published interface XDataEditor: com::sun::star::uno::XInterface
*/
com::sun::star::uno::XInterface getModel();
- /** registers a listener to receive <type>DataEditorEvent</type>s.
+ /** registers a listener to receive DataEditorEvents.
*/
void addDataEditorListener( [in] XDataEditorListener listener );
- /** unregisters a listener which received <type>DataEditorEvent</type>s.
+ /** unregisters a listener which received DataEditorEvents.
*/
void removeDataEditorListener( [in] XDataEditorListener listener );
};
diff --git a/offapi/com/sun/star/util/XDataEditorListener.idl b/offapi/com/sun/star/util/XDataEditorListener.idl
index 5a21edf1fb6c..019800bfe2c2 100644
--- a/offapi/com/sun/star/util/XDataEditorListener.idl
+++ b/offapi/com/sun/star/util/XDataEditorListener.idl
@@ -27,11 +27,11 @@
module com { module sun { module star { module util {
/** makes it possible to receive status change events from an
- <type>XDataEditor</type>.
+ XDataEditor.
*/
published interface XDataEditorListener: com::sun::star::uno::XInterface
{
- /** is called when the state of a connected <type>XDataEditor</type> changes.
+ /** is called when the state of a connected XDataEditor changes.
*/
void updateDataEditorState( [in] DataEditorEvent event );
};
diff --git a/offapi/com/sun/star/util/XNumberFormatTypes.idl b/offapi/com/sun/star/util/XNumberFormatTypes.idl
index 3ea1d3a093a6..09876f385a1b 100644
--- a/offapi/com/sun/star/util/XNumberFormatTypes.idl
+++ b/offapi/com/sun/star/util/XNumberFormatTypes.idl
@@ -43,7 +43,7 @@ published interface XNumberFormatTypes: com::sun::star::uno::XInterface
@param nType
the type of the number format. Must be one of the
- <type>NumberFormat</type> constants.
+ NumberFormat constants.
*/
long getStandardFormat( [in] short nType,
[in] com::sun::star::lang::Locale nLocale );
diff --git a/offapi/com/sun/star/util/XNumberFormats.idl b/offapi/com/sun/star/util/XNumberFormats.idl
index 6ee02a6735f3..f7adcd35a69e 100644
--- a/offapi/com/sun/star/util/XNumberFormats.idl
+++ b/offapi/com/sun/star/util/XNumberFormats.idl
@@ -32,13 +32,13 @@
module com { module sun { module star { module util {
-/** provides access to multiple <type>NumberFormat</type>s.
+/** provides access to multiple NumberFormats.
*/
published interface XNumberFormats: com::sun::star::uno::XInterface
{
/** @returns
- a readonly <type>NumberFormatProperties</type>.
+ a readonly NumberFormatProperties.
*/
com::sun::star::beans::XPropertySet getByKey( [in] long nKey );
@@ -48,7 +48,7 @@ published interface XNumberFormats: com::sun::star::uno::XInterface
@param nType
the type of number formats to return. Must be one of the
- <type>NumberFormat</type> constants.
+ NumberFormat constants.
@param nLanguage
the language of number formats to return.
diff --git a/offapi/com/sun/star/util/XNumberFormatsSupplier.idl b/offapi/com/sun/star/util/XNumberFormatsSupplier.idl
index 3b381a57c53c..9ef6a72e73f0 100644
--- a/offapi/com/sun/star/util/XNumberFormatsSupplier.idl
+++ b/offapi/com/sun/star/util/XNumberFormatsSupplier.idl
@@ -30,14 +30,14 @@
module com { module sun { module star { module util {
-/** supplies the collection of <type>NumberFormat</type>s (for example, in a
+/** supplies the collection of NumberFormats (for example, in a
document) and the settings belonging to these formats.
*/
published interface XNumberFormatsSupplier: com::sun::star::uno::XInterface
{
/** @returns
- the <type>NumberFormatSettings</type> of this object.
+ the NumberFormatSettings of this object.
*/
com::sun::star::beans::XPropertySet getNumberFormatSettings();
diff --git a/offapi/com/sun/star/util/XNumberFormatter.idl b/offapi/com/sun/star/util/XNumberFormatter.idl
index eb330aa21577..73efb908d671 100644
--- a/offapi/com/sun/star/util/XNumberFormatter.idl
+++ b/offapi/com/sun/star/util/XNumberFormatter.idl
@@ -38,18 +38,18 @@
published interface XNumberFormatter: com::sun::star::uno::XInterface
{
- /** attaches an <type>XNumberFormatsSupplier</type> to this
- <type>NumberFormatter</type>.
+ /** attaches an XNumberFormatsSupplier to this
+ NumberFormatter.
- <p>This <type>NumberFormatter</type> will only use the <type>NumberFormats</type>
- specified in the attached <type>XNumberFormatsSupplier</type>. Without an attached
- <type>XNumberFormatsSupplier</type>, no formatting is possible.</p>
+ <p>This NumberFormatter will only use the NumberFormats
+ specified in the attached XNumberFormatsSupplier. Without an attached
+ XNumberFormatsSupplier, no formatting is possible.</p>
*/
void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
/** @returns
- the attached <type>XNumberFormatsSupplier</type>.
+ the attached XNumberFormatsSupplier.
*/
com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier();
diff --git a/offapi/com/sun/star/util/XNumberFormatter2.idl b/offapi/com/sun/star/util/XNumberFormatter2.idl
index 76f0a1aa9d2e..e9299eb80e0a 100644
--- a/offapi/com/sun/star/util/XNumberFormatter2.idl
+++ b/offapi/com/sun/star/util/XNumberFormatter2.idl
@@ -33,12 +33,12 @@ published interface XNumberFormatter2
{
/** is used to format or parse numbers using formats from a
- <type>NumberFormats</type> object.
+ NumberFormats object.
*/
interface com::sun::star::util::XNumberFormatter;
/** is used to format numbers using a number format string
- that is not inserted into a <type>NumberFormats</type> object.
+ that is not inserted into a NumberFormats object.
*/
interface com::sun::star::util::XNumberFormatPreviewer;
diff --git a/offapi/com/sun/star/util/XReplaceable.idl b/offapi/com/sun/star/util/XReplaceable.idl
index d17a0c0aa355..8eea70eaa646 100644
--- a/offapi/com/sun/star/util/XReplaceable.idl
+++ b/offapi/com/sun/star/util/XReplaceable.idl
@@ -31,7 +31,7 @@ module com { module sun { module star { module util {
/** makes it possible to replace strings in a text described by a
- <type>SearchDescriptor</type>.
+ SearchDescriptor.
@example
<listing>
diff --git a/offapi/com/sun/star/util/XSearchable.idl b/offapi/com/sun/star/util/XSearchable.idl
index 45ccc045acea..0c1ac8f990cf 100644
--- a/offapi/com/sun/star/util/XSearchable.idl
+++ b/offapi/com/sun/star/util/XSearchable.idl
@@ -52,7 +52,7 @@ module com { module sun { module star { module util {
*/
published interface XSearchable: com::sun::star::uno::XInterface
{
- /** creates a <type>SearchDescriptor</type> which contains properties that
+ /** creates a SearchDescriptor which contains properties that
specify a search in this container.@see SearchDescriptor
*/
com::sun::star::util::XSearchDescriptor createSearchDescriptor();
diff --git a/offapi/com/sun/star/util/XStringAbbreviation.idl b/offapi/com/sun/star/util/XStringAbbreviation.idl
index 09deb6e9087b..686bbc0deea5 100644
--- a/offapi/com/sun/star/util/XStringAbbreviation.idl
+++ b/offapi/com/sun/star/util/XStringAbbreviation.idl
@@ -44,10 +44,10 @@ published interface XStringAbbreviation: com::sun::star::uno::XInterface
wider than some given width.
<p>The width of a string is an abstract concept here, measured via
- an <type>XStringWidth</type> interface. Examples are the number of
- characters in the string (<type>XStringWidth</type> will measure the
+ an XStringWidth interface. Examples are the number of
+ characters in the string (XStringWidth will measure the
string's length), or the width in pixel when displayed with a specific
- font (which <type>XStringWidth</type> would encapsulate).</p>
+ font (which XStringWidth would encapsulate).</p>
@param xStringWidth
The interface that makes concrete the abstract notion of string width.