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 | |
| 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')
1167 files changed, 3339 insertions, 3339 deletions
diff --git a/offapi/com/sun/star/accessibility/Accessible.idl b/offapi/com/sun/star/accessibility/Accessible.idl index a3b5e5bfc8df..c3d5d5e52585 100644 --- a/offapi/com/sun/star/accessibility/Accessible.idl +++ b/offapi/com/sun/star/accessibility/Accessible.idl @@ -25,9 +25,9 @@ module com { module sun { module star { module accessibility { /** Every class has to support this service in order to be accessible. - <p>It provides the means to derive a <type>XAccessibleContext</type> + <p>It provides the means to derive a XAccessibleContext object--which may but usually is not the same object as the object that - supports the <type>XAccessible</type> interface--that provides the + supports the XAccessible interface--that provides the actual information that is needed to make it accessible.</p> <p>Service <code>Accessible</code> is just a wrapper for the interface diff --git a/offapi/com/sun/star/accessibility/AccessibleContext.idl b/offapi/com/sun/star/accessibility/AccessibleContext.idl index d9fe07c7f288..e3233a3eea05 100644 --- a/offapi/com/sun/star/accessibility/AccessibleContext.idl +++ b/offapi/com/sun/star/accessibility/AccessibleContext.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module accessibility { are organized can be navigated in freely. It typically represents spatial relationship of one object containing a set of children like a dialog box contains a set of buttons. Additionally the - <type>XAccessibleContext</type> interface of this service exposes + XAccessibleContext interface of this service exposes methods that provide access to the actual object's content. This can be the object's role, name, description, and so on.</p> diff --git a/offapi/com/sun/star/accessibility/AccessibleEventId.idl b/offapi/com/sun/star/accessibility/AccessibleEventId.idl index c5d0bdf5e886..55baaf8dffc8 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventId.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventId.idl @@ -21,7 +21,7 @@ module com { module sun { module star { module accessibility { -/** These constants identify the type of <type>AccessibleEventObject</type> +/** These constants identify the type of AccessibleEventObject objects. <p>The <member>AccessibleEventObject::OldValue</member> and @@ -148,15 +148,15 @@ constants AccessibleEventId /** A visible data event indicates the change of the visual appearance of an accessible object. This includes for example most of the - attributes available over the <type>XAccessibleComponent</type> and - <type>XAccessibleExtendedComponent</type> interfaces. The + attributes available over the XAccessibleComponent and + XAccessibleExtendedComponent interfaces. The <member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::NewValue</member> fields are left empty. */ const short VISIBLE_DATA_CHANGED = 10; /** This constant indicates changes of the value of an - <type>XAccessibleValue</type> interface. The + XAccessibleValue interface. The <member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::NewValue</member> field contain the old and new value as a number. Its exact type is implementation @@ -245,7 +245,7 @@ constants AccessibleEventId /** Events of this type signal changes of the selection. The old or new selection is <em>not</em> available through the event object. You - have to query the <type>XAccessibleText</type> interface of the + have to query the XAccessibleText interface of the event source for this information. The type of content of the <member>AccessibleEventObject::OldValue</member> and <member>AccessibleEventObject::NewValue</member> fields is not @@ -254,8 +254,8 @@ constants AccessibleEventId const short TEXT_SELECTION_CHANGED = 21; /** Use this id to indicate general text changes, i.e. changes to text - that is exposed through the <type>XAccessibleText</type> and - <type>XAccessibleEditableText</type> interfaces. + that is exposed through the XAccessibleText and + XAccessibleEditableText interfaces. <p>The affected text ranges are represented by <type scope="com::sun::star::accessibility">TextSegment</type> structures.<p> @@ -322,7 +322,7 @@ constants AccessibleEventId /** Constant used to indicate that the column header has changed. The <member>AccessibleEventObject::OldValue</member> is empty, the <member>AccessibleEventObject::NewValue</member> field contains an - <type>AccessibleTableModelChange</type> representing the header + AccessibleTableModelChange representing the header change. */ const short TABLE_COLUMN_HEADER_CHANGED = 27; @@ -330,7 +330,7 @@ constants AccessibleEventId /** Constant used to indicate that the table data has changed. The <member>AccessibleEventObject::OldValue</member> is empty, the <member>AccessibleEventObject::NewValue</member> field contains an - <type>AccessibleTableModelChange</type> representing the data + AccessibleTableModelChange representing the data change. */ const short TABLE_MODEL_CHANGED = 28; @@ -345,7 +345,7 @@ constants AccessibleEventId /** Constant used to indicate that the row header has changed. The <member>AccessibleEventObject::OldValue</member> is empty, the <member>AccessibleEventObject::NewValue</member> field contains an - <type>AccessibleTableModelChange</type> representing the header + AccessibleTableModelChange representing the header change. */ const short TABLE_ROW_HEADER_CHANGED = 30; diff --git a/offapi/com/sun/star/accessibility/AccessibleEventObject.idl b/offapi/com/sun/star/accessibility/AccessibleEventObject.idl index 781a8f1cdf0f..3ce87339813e 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventObject.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventObject.idl @@ -24,10 +24,10 @@ module com { module sun { module star { module accessibility { /** this struct describes an accessible event, that is broadcasted from - the <type>XAccessibleEventBroadcaster</type> and notified to - <type>XAccessibleEventListener</type>. + the XAccessibleEventBroadcaster and notified to + XAccessibleEventListener. - <p>It is usually implemented by <type>AccessibleContext</type>. + <p>It is usually implemented by AccessibleContext. @since OOo 1.1.2 */ @@ -35,7 +35,7 @@ struct AccessibleEventObject: ::com::sun::star::lang::EventObject { /** specifies the type of this event. - <p>For a list of possible events see <type>AccessibleEventId</type>. + <p>For a list of possible events see AccessibleEventId. */ short EventId; diff --git a/offapi/com/sun/star/accessibility/AccessibleRelation.idl b/offapi/com/sun/star/accessibility/AccessibleRelation.idl index b715abf5675d..f3b5e8402cea 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRelation.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRelation.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module accessibility { -/** An <type>AccessibleRelation</type> object defines a one-to-many +/** An AccessibleRelation object defines a one-to-many relation. <p>The represented relation points from the implementing object to a set @@ -36,7 +36,7 @@ struct AccessibleRelation /** Type of the relation. <p>Its value has to be one of the constants defined by - <type>AccessibleRelationType</type>. If that value is INVALID then + AccessibleRelationType. If that value is INVALID then the whole relation is regarded as invalid. The content of the TargetSet is then undefined.</p> diff --git a/offapi/com/sun/star/accessibility/AccessibleRelationType.idl b/offapi/com/sun/star/accessibility/AccessibleRelationType.idl index 32a94afc17dd..2219c26cfd8f 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRelationType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRelationType.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module accessibility { /** Collection of relation types. <p>This list of constants defines the available types of relations that - are usable by <type>AccessibleRelation</type>.</p> + are usable by AccessibleRelation.</p> <p>We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to diff --git a/offapi/com/sun/star/accessibility/AccessibleRole.idl b/offapi/com/sun/star/accessibility/AccessibleRole.idl index 9f57f8f53201..1b5b4e213d1a 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRole.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRole.idl @@ -25,12 +25,12 @@ module com { module sun { module star { module accessibility { /** Collection of roles. <p>This collection of constants defines the set of possible roles of - classes implementing the <type>XAccessible</type> interface according to + classes implementing the XAccessible interface according to the Java class javax.accessibility.AccessibleRole. The role of an object describes its generic function like "button", "menu", or "text". You can obtain an object's role by calling the <member>getAccessibleRole</member> method of the - <type>XAccessibleContext</type> interface.</p> + XAccessibleContext interface.</p> <p>We are using constants instead of a more typesafe enum. The reason for this is that IDL enums may not be extended. Therefore, in order to diff --git a/offapi/com/sun/star/accessibility/AccessibleStateType.idl b/offapi/com/sun/star/accessibility/AccessibleStateType.idl index acf0a302db58..f0c13cee6e0c 100644 --- a/offapi/com/sun/star/accessibility/AccessibleStateType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleStateType.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module accessibility { /** Collection of state types. <p>This list of constants defines the available set of states that an - object that implements <type>XAccessibleContext</type> can be in.</p> + object that implements XAccessibleContext can be in.</p> <p>The comments describing the states is taken verbatim from the Java Accessibility API 1.4 documentation.</p> diff --git a/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl b/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl index c79904340610..ae49447cecb6 100644 --- a/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl +++ b/offapi/com/sun/star/accessibility/AccessibleTableModelChange.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module accessibility { /** This structure lets an event give access to a change of a table model. - <p>The data members of the <type>AccessibleTableModelChange</type> structure + <p>The data members of the AccessibleTableModelChange structure give access to the type and cell range of a change of a table model. See - <type>AccessibleTableModelChangeType</type> for details of the change + AccessibleTableModelChangeType for details of the change type. The range of the affected rows, columns, and/or cells can be obtained by accessing the other four data members.</p> @@ -37,11 +37,11 @@ module com { module sun { module star { module accessibility { struct AccessibleTableModelChange { /** The type of the event as defined in - <type>AccessibleTableModelChangeType</type>. + AccessibleTableModelChangeType. <p>The model change either inserted or deleted one or more rows and/or columns or modified the content of a number of cells. See - <type>AccessibleTableModelChangeType</type> for details of the type + AccessibleTableModelChangeType for details of the type of the model change.</p> */ short Type; diff --git a/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl b/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl index cef7f8204d3d..6b933b9bfb31 100644 --- a/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleTableModelChangeType.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module accessibility { /** Type of a change made to a table model. <p>The value of this constants group are used by the - <type>AccessibleTableModelChange</type> structure to specify the + AccessibleTableModelChange structure to specify the type of change that has been made to a table model.</p> <p>Two of the constants, @@ -44,7 +44,7 @@ constants AccessibleTableModelChangeType { /** One or more rows and/or columns have been inserted. - <p>Use the fields of the <type>AccessibleTableModelChange</type> + <p>Use the fields of the AccessibleTableModelChange structure to determine the indices of the rows and/or columns that have been inserted.</p> */ @@ -53,7 +53,7 @@ constants AccessibleTableModelChangeType /** One or more rows and/or columns have been deleted. <p>The affected area of the table is stored in the fields of the - <type>AccessibleTableModelChange</type> structure.</p> + AccessibleTableModelChange structure.</p> */ const short DELETE = 2; @@ -61,7 +61,7 @@ constants AccessibleTableModelChangeType <p>The number of rows and columns remains unchanged. Only (some of) the content of the cells in the range that is specified by the - fields of the <type>AccessibleTableModelChange</type> structure have + fields of the AccessibleTableModelChange structure have been changed.</p> */ const short UPDATE = 3; diff --git a/offapi/com/sun/star/accessibility/AccessibleTextType.idl b/offapi/com/sun/star/accessibility/AccessibleTextType.idl index 7bad07cd62c9..23df274df2ee 100644 --- a/offapi/com/sun/star/accessibility/AccessibleTextType.idl +++ b/offapi/com/sun/star/accessibility/AccessibleTextType.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module accessibility { <p>This collection describes the types of text portions that can be accessed with the help of the methods of the - <type>XAccessibleText</type> interface.</p> + XAccessibleText interface.</p> @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/accessibility/TextSegment.idl b/offapi/com/sun/star/accessibility/TextSegment.idl index 49630e02b61f..12cf1b672caa 100644 --- a/offapi/com/sun/star/accessibility/TextSegment.idl +++ b/offapi/com/sun/star/accessibility/TextSegment.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module accessibility { /** This structure describes a text segment that is embedded in a larger portion of text. It is used for example by the - <type>XAccessibleText</type> interface to describe a text portion that + XAccessibleText interface to describe a text portion that was inserted into or deleted from an accessible text. <p>The indices <member>TextSegment::SegmentStart</member> and @@ -32,7 +32,7 @@ module com { module sun { module star { module accessibility { The <member>TextSegment::SegmentText</member> member contains the text between these two indices including the start index but not the end index. With it you can use this structure without having to - access the <type>XAccessibleText</type> interface that represents the + access the XAccessibleText interface that represents the enclosing text.</p> <p>An empty text segment is expressed by diff --git a/offapi/com/sun/star/accessibility/XAccessible.idl b/offapi/com/sun/star/accessibility/XAccessible.idl index a738d2b73b04..e8e6c80469e5 100644 --- a/offapi/com/sun/star/accessibility/XAccessible.idl +++ b/offapi/com/sun/star/accessibility/XAccessible.idl @@ -29,20 +29,20 @@ module com { module sun { module star { module accessibility { /** This interface has to be implemented by any class that wants to be accessible. - <p>It is used to provide access to the <type>XAccessibleContext</type> + <p>It is used to provide access to the XAccessibleContext interface but allows at the same time that that interface is implemented by another class.</p> - <p>The distinction between the interfaces <type>XAccessible</type> and - <type>XAccessibleContext</type> makes it possible to split up the + <p>The distinction between the interfaces XAccessible and + XAccessibleContext makes it possible to split up the implementation of the class that is made accessible and the actual accessibility code into two (mostly) independent parts. The only necessary dependence is the <member scope="XAccessible">getAccessibleContext()</member> function that returns the accessible context. This one-way link has to be persistent in some sense: As long as there is at least one reference to - a specific <type>XAccessibleContext</type> object the - <type>XAccessible</type> object has to return the same context for every + a specific XAccessibleContext object the + XAccessible object has to return the same context for every call to <member scope="XAccessible">getAccessibleContext()</member>. This is necessary to allow the use of object identity for comparing accessibility contexts for being equal.</p> @@ -56,11 +56,11 @@ interface XAccessible : ::com::sun::star::uno::XInterface /** Returns the AccessibleContext associated with this object. <p>The idea to let this interface only return an - <type>XAccessibleContext</type> instead of directly supporting its + XAccessibleContext instead of directly supporting its functions is to allow the separation of the implementation of the functions that make a class accessible from the implementation of - that class. You may, of course, implement <type>XAccessible</type> - and <type>XAccessibleContext</type> in one class.</p> + that class. You may, of course, implement XAccessible + and XAccessibleContext in one class.</p> @return A reference to the object that contains the actual accessibility diff --git a/offapi/com/sun/star/accessibility/XAccessibleAction.idl b/offapi/com/sun/star/accessibility/XAccessibleAction.idl index de46557196ca..bb88415901c7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleAction.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleAction.idl @@ -88,7 +88,7 @@ interface XAccessibleAction : ::com::sun::star::uno::XInterface /** Returns a key binding object, if there is one, associated with the specified action. Note that there can be several alternative key - bindings for an action. See <type>XAccessibleKeyBinding</type> for + bindings for an action. See XAccessibleKeyBinding for more information about how key bindings are represented. @param nIndex diff --git a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl index 583972cbf6c6..bd497266fee1 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module accessibility { interface XAccessible; -/** The <type>XAccessibleComponent</type> interface should be supported by +/** The XAccessibleComponent interface should be supported by any class that can be rendered on the screen. <p>This interface provides the standard mechanism for an assistive @@ -43,7 +43,7 @@ module com { module sun { module star { module accessibility { and <code>javax.accessibility.AccessibleExtendedComponent</code>.</p> <p>Further information about the graphical appearance of an object can - be expressed with the <type>XAccessibleExtendedComponent</type> + be expressed with the XAccessibleExtendedComponent interface.</p> <p>Coordinates used by the functions of this interface are specified in @@ -68,7 +68,7 @@ module com { module sun { module star { module accessibility { bindings are associated with actions and directly with a component. This distinction becomes important when there are more than one action. To get access to the key bindings you have to get the - <type>XAccessibleAction</type> interface of a component, provided that + XAccessibleAction interface of a component, provided that it is supported, and use the <method scope="XAccessibleAction">getAccessibleKeyBinding()</method>.</p> diff --git a/offapi/com/sun/star/accessibility/XAccessibleContext.idl b/offapi/com/sun/star/accessibility/XAccessibleContext.idl index 3ed97715b60e..eccfe0f2adca 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleContext.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleContext.idl @@ -163,7 +163,7 @@ interface XAccessibleContext : ::com::sun::star::uno::XInterface <p>The returned state set is a copy: Changing the returned state set will not be reflected by changing the object's set of states. See - the documentation of <type>XAccessibleStateSet</type> for a + the documentation of XAccessibleStateSet for a description of the individual states.</p> @return @@ -182,7 +182,7 @@ interface XAccessibleContext : ::com::sun::star::uno::XInterface @return If this object does not have a locale, the locale of its parent is returned. If it does not have (yet) a parent it throws the - exception <type>IllegalAccessibleComponentStateException</type>. + exception IllegalAccessibleComponentStateException. @throws IllegalAccessibleComponentStateException when this object does not (yet) have a parent. diff --git a/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl b/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl index ccfbba3fa2f7..af74015ed0d8 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module accessibility { representation. <p>This interface is typically used in conjunction with the - <type>XAccessibleText</type> interface and extents it about the ability + XAccessibleText interface and extents it about the ability to modify the text represented by that interface.</p> @since OOo 1.1.2 diff --git a/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl b/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl index e3e859ed1054..a8fa56ea443e 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEventBroadcaster.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module accessibility { interface XAccessibleEventListener; /** makes it possible to register listeners which are called whenever - an accessibility event (see <type>AccessibleEventObject</type>) occurs. + an accessibility event (see AccessibleEventObject) occurs. @see AccessibleEventObject @see XAccessibleEventListener @@ -37,12 +37,12 @@ module com { module sun { module star { module accessibility { interface XAccessibleEventBroadcaster: ::com::sun::star::uno::XInterface { - /** registers the given <type>XAccessibleEventListener</type>. + /** registers the given XAccessibleEventListener. */ void addAccessibleEventListener( [in] XAccessibleEventListener xListener ); - /** unregisters the given <type>XAccessibleEventListener</type>. + /** unregisters the given XAccessibleEventListener. */ void removeAccessibleEventListener( [in] XAccessibleEventListener xListener ); }; diff --git a/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl b/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl index 396c504bbf4d..10cef20d50a7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEventListener.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module accessibility { interface XAccessibleEventListener: ::com::sun::star::lang::XEventListener { - /** is called whenever a accessible event (see <type>AccessibleEventObject</type>) occurs. + /** is called whenever a accessible event (see AccessibleEventObject) occurs. */ void notifyEvent( [in] AccessibleEventObject aEvent ); }; diff --git a/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl b/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl index 00762e053b62..a5af6c73b44f 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleExtendedComponent.idl @@ -31,12 +31,12 @@ module com { module sun { module star { module accessibility { -/** The <type>XAccessibleExtendedComponent</type> interface contains - additional methods to those of the <type>XAccessibleComponent</type> +/** The XAccessibleExtendedComponent interface contains + additional methods to those of the XAccessibleComponent interface. These methods provide information that is used not as often. The division into two interfaces allows classes to support the more - frequently used methods of the <type>XAccessibleComponent</type> - interface and only support the <type>XAccessibleExtendedComponent</type> + frequently used methods of the XAccessibleComponent + interface and only support the XAccessibleExtendedComponent interface if that makes sense for the class. <p>This interface provides extended access to retrieve information diff --git a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl index e095eb4c6fea..e6779ac33731 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module accessibility { <p>Single hyperlinks correspond to simple <a href> tags. Groups of hyperlinks are contained in client side image maps. Linked objects and anchors are implementation dependent. This interface inherits the - <type>XAccessibleAction</type> interface. Especially that interface's + XAccessibleAction interface. Especially that interface's <member>XAccessibleAction::getActionCount</member> method is needed to obtain a maximum value for the indices passed to the <member>XAccessibleHyperlink::getAccessibleActionAnchor</member> and @@ -40,7 +40,7 @@ module com { module sun { module star { module accessibility { <p>Furthermore, the object that implements this interface has to be connected implicitly or explicitly with an object that implements the - the <type>XAccessibleText</type> interface. The + the XAccessibleText interface. The <member>XAccessibleHyperlink::getStartIndex</member> and <member>XAccessibleHyperlink::getEndIndex</member> methods return indices with respect to the text exposed by that interface.</p> @@ -91,24 +91,24 @@ interface XAccessibleHyperlink : /** Returns the index at which the textual representation of the hyperlink (group) starts. - <p>The returned value relates to the <type>XAccessibleText</type> + <p>The returned value relates to the XAccessibleText interface that owns this hyperlink.</p> @return The index relates to the text exposed by the - <type>XAccessibleHypertext</type> interface. + XAccessibleHypertext interface. */ long getStartIndex (); /** Returns the index at which the textual representation of the hyperlink (group) ends. - <p>The returned value relates to the <type>XAccessibleText</type> + <p>The returned value relates to the XAccessibleText interface that owns this hyperlink.</p> @return The index relates to the text exposed by the - <type>XAccessibleText</type> interface. + XAccessibleText interface. */ long getEndIndex (); diff --git a/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl b/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl index 92707d3178fb..f05ef585ec0a 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl @@ -31,13 +31,13 @@ module com { module sun { module star { module accessibility { /** Implement this interface to expose the hypertext structure of a document. - <p>The <type>XAccessibleHypertext</type> interface is the main interface + <p>The XAccessibleHypertext interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other (parts of) documents. For supporting the <member>XAccessibleHypertext::getLinkIndex</member> method of this interface and other character related methods of the - <type>XAccessibleHyperlink</type> interface, it is necessary to also - support the <type>XAccessibleText</type> interface.</p> + XAccessibleHyperlink interface, it is necessary to also + support the XAccessibleText interface.</p> @see XAccessibleHyperlink, XAccessibleText @@ -57,7 +57,7 @@ interface XAccessibleHypertext /** Return the specified link. - <p>The returned <type>XAccessibleHyperlink</type> object + <p>The returned XAccessibleHyperlink object encapsulates the hyperlink and provides several kinds of information describing it.</p> @@ -82,7 +82,7 @@ interface XAccessibleHypertext @param nCharIndex Index of the character for which to return the link index. If - the <type>XAccessibleText</type> interface is used to represent + the XAccessibleText interface is used to represent the text containing the link, then the character index is only valid if it is greater than or equal to zero and lower then the number of characters in the text. See that interface's diff --git a/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl b/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl index 8b374aba1d21..5c6a7cb698f9 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl @@ -32,8 +32,8 @@ module com { module sun { module star { module accessibility { <p>There can be zero, one, or more key bindings. Each key binding consists of a sequence of <type scope="::com::sun::star::awt">KeyStroke</type> objects. The association of an action with a key binding is established - by the <type>XAccessibleAction</type> interface returning an - <type>XAccessibleKeyBinding</type> object.</p> + by the XAccessibleAction interface returning an + XAccessibleKeyBinding object.</p> <p>A key binding describes alternative ways how to invoke an action with pressing one or more keys after each other. Each individual sequence of diff --git a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl index 8c3cc17e35ff..fd539bc9a7b7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module accessibility { and line numbers. <p>This interface is typically used in conjunction with the - <type>XAccessibleText</type> interface and extents it with a notion + XAccessibleText interface and extents it with a notion of line numbers</p> @since OOo 3.0 diff --git a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl index 02fbd70bd51a..db940a0b8fd6 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl @@ -28,9 +28,9 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give access to an object's set of relations. - <p>Such relation are modeled with the <type>AccessibleRelation</type> + <p>Such relation are modeled with the AccessibleRelation structure. This interface is used for representing sets of relations - between <type>Accessible</type> objects. Most of the convenience + between Accessible objects. Most of the convenience methods of the corresponding AccessibleRelationSet interface of the Java Accessibility API have been removed from this interface in order to clean it up. These methods are <member>add</member>, @@ -71,7 +71,7 @@ interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface @param aRelationType The type of relation to look for in this set of relations. This has to be one of the constants of - <type>AccessibleRelationType</type>. + AccessibleRelationType. @return Returns <TRUE/> if there is a (at least one) relation of the @@ -83,7 +83,7 @@ interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface @param aRelationType The type of the relation to return. This has to be one of the - constants of <type>AccessibleRelationType</type>. + constants of AccessibleRelationType. @return If a relation with the given type could be found than (a copy diff --git a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl index 2db010ae78db..c8ed13aee1bc 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl @@ -33,8 +33,8 @@ module com { module sun { module star { module accessibility { currently selected children. Every object that has children that can be selected should support this interface.</p> - <p>The <type>XAccessibleSelection</type> interface has to be implemented - in conjunction with the <type>XAccessibleContext</type> interface that + <p>The XAccessibleSelection interface has to be implemented + in conjunction with the XAccessibleContext interface that provides the children on which the first operates.</p> <p>It depends on the class implementing this interface, whether it @@ -44,7 +44,7 @@ module com { module sun { module star { module accessibility { */ interface XAccessibleSelection : ::com::sun::star::uno::XInterface { - /** Selects the specified <type>Accessible</type> child of the + /** Selects the specified Accessible child of the object. <p>Depending on the implementing class the child is added to the @@ -119,7 +119,7 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface @return If the index is valid, i.e. not negative and lower than the number of selected children, then a valid reference to the - corresponding <type>XAccessible</type> child is returned. + corresponding XAccessible child is returned. Otherwise an exception is thrown. @throws ::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to diff --git a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl index 170f4e1e9391..e08e194587a2 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleStateSet.idl @@ -29,10 +29,10 @@ module com { module sun { module star { module accessibility { /** Implement this interface to represent a set of states. - <p>The interface <type>XAccessibleStateSet</type> represents a set of + <p>The interface XAccessibleStateSet represents a set of states of an accessible object. It can hold any combination of states defined by the constants collection - <type>AccessibleStateType</type>.</p> + AccessibleStateType.</p> @since OOo 1.1.2 */ @@ -51,7 +51,7 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface @param aState The state for which to check membership. This has to be one of - the constants of <type>AccessibleStateType</type>. + the constants of AccessibleStateType. @return Returns <TRUE/> if the given state is a member of this object's @@ -66,7 +66,7 @@ interface XAccessibleStateSet : ::com::sun::star::uno::XInterface This sequence of states is interpreted as set and every of its members, duplicates are ignored, is checked for membership in this object's state set. Each state has to be one of the - constants of <type>AccessibleStateType</type>. + constants of AccessibleStateType. @return Returns <TRUE/> if all states of the given state set are members diff --git a/offapi/com/sun/star/accessibility/XAccessibleTable.idl b/offapi/com/sun/star/accessibility/XAccessibleTable.idl index 221c92bbd7c4..ea60a3b8ac22 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTable.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTable.idl @@ -29,13 +29,13 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give access to a two-dimensional table. - <p>The <type>XAccessibleTable</type> interface is used to represent + <p>The XAccessibleTable interface is used to represent two-dimensional tables. This interface combines the two interfaces <code>javax.accessibility.AccessibleTable</code> and <code>javax.accessibility.AccessibleExtendedTable</code> of the Java Accessibility API (version 1.4).</p> - <p>All <type>XAccessible</type> objects that represent cells or + <p>All XAccessible objects that represent cells or cell-clusters of a table have to be at the same time children of the table. This is necessary to be able to convert row and column indices into child indices and vice versa with the methods @@ -165,7 +165,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface long getAccessibleColumnExtentAt ([in] long nRow, [in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - /** Returns the row headers as an <type>XAccessibleTable</type> + /** Returns the row headers as an XAccessibleTable object. <p>Content and size of the returned table are implementation @@ -173,11 +173,11 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return Returns always a valid reference to an - <type>XAccessibleTable</type> object. + XAccessibleTable object. */ XAccessibleTable getAccessibleRowHeaders (); - /** Returns the column headers as an <type>XAccessibleTable</type> + /** Returns the column headers as an XAccessibleTable object. <p>Content and size of the returned table are implementation @@ -185,7 +185,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return Returns always a valid reference to an - <type>XAccessibleTable</type> object. + XAccessibleTable object. */ XAccessibleTable getAccessibleColumnHeaders (); @@ -246,7 +246,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface boolean isAccessibleColumnSelected ([in] long nColumn) raises (::com::sun::star::lang::IndexOutOfBoundsException); - /** Returns the <type>XAccessible</type> object at the specified row + /** Returns the XAccessible object at the specified row and column in the table. <p>This method has been renamed from the Java name @@ -264,7 +264,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return If both row and column index are valid then the corresponding - <type>XAccessible</type> object is returned that represents the + XAccessible object is returned that represents the requested cell regardless of whether the cell is currently visible (on the screen). @@ -288,7 +288,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface @return Returns a reference to an implementation dependent - <type>XAccessible</type> object representing the table's summary + XAccessible object representing the table's summary or an empty reference if the table does not support a summary. */ XAccessible getAccessibleSummary (); diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl index c020d518d078..c00da1635e9b 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl @@ -33,12 +33,12 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give read-only access to a text. - <p>The <type>XAccessibleText</type> interface should be implemented by + <p>The XAccessibleText interface should be implemented by all UNO components that present textual information on the display like buttons, text entry fields, or text portions of the document window. The interface provides access to the text's content, attributes, and spatial location. However, text can not be modified with this - interface. That is the task of the <type>XAccessibleEditableText</type> + interface. That is the task of the XAccessibleEditableText interface.</p> <p>The text length, i.e. the number of characters in the text, is @@ -364,7 +364,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface @param nTextType The type of the text portion to return. See - <type>AccessibleTextType</type> for the complete list. + AccessibleTextType for the complete list. @return Returns the requested text portion. This portion may be empty @@ -403,7 +403,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface @param nTextType The type of the text portion to return. See - <type>AccessibleTextType</type> for the complete list. + AccessibleTextType for the complete list. @return Returns the requested text portion. This portion may be empty @@ -441,7 +441,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface @param nTextType The type of the text portion to return. See - <type>AccessibleTextType</type> for the complete list. + AccessibleTextType for the complete list. @return Returns the requested text portion. This portion may be empty @@ -466,7 +466,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface <p>The other clipboard related methods <member>XAccessibleEditableText::cutText</member> and <member>XAccessibleEditableText::deleteText</member> can be found in - the <type>XAccessibleEditableText</type> because of their + the XAccessibleEditableText because of their destructive nature.</p> @param nStartIndex diff --git a/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl b/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl index 99cb6706c7c3..af571d58c494 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl @@ -33,13 +33,13 @@ module com { module sun { module star { module accessibility { /** Implement this interface to expose the text markups of a text. - <p>The <type>XAccessibleTextMarkup</type> interface is the main interface + <p>The XAccessibleTextMarkup interface is the main interface to expose text markups in a text, typically of a text document, that are used to reference other (parts of) documents. For supporting the <member>XAccessibleTextMarkup::getTextMarkupIndex</member> method of this interface and other character related methods of the - <type>XAccessibleTextMarkup</type> interface, it is necessary to also - support the <type>XAccessibleText</type> interface.</p> + XAccessibleTextMarkup interface, it is necessary to also + support the XAccessibleText interface.</p> @see XAccessibleText @@ -51,12 +51,12 @@ interface XAccessibleTextMarkup /** Returns the number of text markup of the given text markup type of a text. - <p>Throws <type>IllegalArgumentException</type>, if given text + <p>Throws IllegalArgumentException, if given text markup type is out of valid range.</p> @param TextMarkupType This specifies the type of text markups, whose count should - be returned - see <type>TextMarkupType</type>. + be returned - see TextMarkupType. @return The number of text markup of the given text markup type. @@ -68,9 +68,9 @@ interface XAccessibleTextMarkup /** Returns the text segment of the text markup of the given index and of the given text mark type - <p>Throws <type>IndexOutOfBoundsException</type>, if given index + <p>Throws IndexOutOfBoundsException, if given index is out of valid range.</p> - <p>Throws <type>IllegalArgumentException</type>, if given text + <p>Throws IllegalArgumentException, if given text markup type is out of valid range.</p> @param TextMarkupIndex @@ -78,11 +78,11 @@ interface XAccessibleTextMarkup @param TextMarkupType This specifies the type of the text markup to be returned - see - <type>TextMarkupType</type>. + TextMarkupType. @return If the given index is in range [0..getTextMarkupCount(TextMarkupType)-1], - the text segment - see <type>TextSegment</type> - of the text markup + the text segment - see TextSegment - of the text markup of the given text markup type is returned. */ TextSegment getTextMarkup ( [in] long TextMarkupIndex, @@ -93,9 +93,9 @@ interface XAccessibleTextMarkup /** returns a sequence of the text segments of the text markups at the given character index and of the given text markup type. - <p>Throws <type>IndexOutOfBoundsException</type>, if given character + <p>Throws IndexOutOfBoundsException, if given character index is out of range [0..number of characters in the text).</p> - <p>Throws <type>IllegalArgumentException</type>, if given text + <p>Throws IllegalArgumentException, if given text markup type is out of valid range.</p> @param CharIndex @@ -103,11 +103,11 @@ interface XAccessibleTextMarkup @param TextMarkupType This specifies the type of the text markups to be returned - see - <type>TextMarkupType</type>. + TextMarkupType. @return If character index is in range [0..number of characters in the text-1], - a sequence of <type>TextSegment</type>s of the text markups at + a sequence of TextSegments of the text markups at given character index of the given text markup type are returned. The sequence is empty, if no such text markup is found. */ diff --git a/offapi/com/sun/star/accessibility/XAccessibleValue.idl b/offapi/com/sun/star/accessibility/XAccessibleValue.idl index 9d752c88852c..22984f7370a7 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleValue.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleValue.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module accessibility { /** Implement this interface to give access to a single numerical value. - <p>The <type>XAccessibleValue</type> interface represents a single + <p>The XAccessibleValue interface represents a single numerical value and should be implemented by any class that supports numerical value like scroll bars and spin boxes. This interface lets you access the value and its upper and lower bounds.</p> diff --git a/offapi/com/sun/star/animations/AnimationAdditiveMode.idl b/offapi/com/sun/star/animations/AnimationAdditiveMode.idl index 5c8e13f8c21f..06d25d79e927 100644 --- a/offapi/com/sun/star/animations/AnimationAdditiveMode.idl +++ b/offapi/com/sun/star/animations/AnimationAdditiveMode.idl @@ -25,7 +25,7 @@ /** Specifies the additive mode for the animation. - @see <type>XAnimate</type> + @see XAnimate @see http://www.w3.org/TR/smil20/animation.html#adef-calcMode @see http://www.w3.org/TR/smil20/animation.html#adef-SplineAnimation-calcMode */ diff --git a/offapi/com/sun/star/animations/AnimationCalcMode.idl b/offapi/com/sun/star/animations/AnimationCalcMode.idl index e9fa85313890..d9da7a84c68c 100644 --- a/offapi/com/sun/star/animations/AnimationCalcMode.idl +++ b/offapi/com/sun/star/animations/AnimationCalcMode.idl @@ -25,7 +25,7 @@ /** Specifies the interpolation mode for the animation. - @see <type>XAnimation</type> + @see XAnimation @see http://www.w3.org/TR/smil20/animation.html#adef-calcMode @see http://www.w3.org/TR/smil20/animation.html#adef-SplineAnimation-calcMode */ diff --git a/offapi/com/sun/star/animations/AnimationFill.idl b/offapi/com/sun/star/animations/AnimationFill.idl index 35c7e903434f..d466d2864114 100644 --- a/offapi/com/sun/star/animations/AnimationFill.idl +++ b/offapi/com/sun/star/animations/AnimationFill.idl @@ -24,9 +24,9 @@ /** This constants are used for the members <member>fill</member> and <member>fillDefault</member> - of the an <type>XTimeContainer</type>. + of the an XTimeContainer. - @see <type>XTimeContainer</type> + @see XTimeContainer @see http://www.w3.org/TR/smil20/smil-timing.html#adef-fill */ constants AnimationFill diff --git a/offapi/com/sun/star/animations/AnimationTransformType.idl b/offapi/com/sun/star/animations/AnimationTransformType.idl index f47d6bd0f9b8..52e5f383494e 100644 --- a/offapi/com/sun/star/animations/AnimationTransformType.idl +++ b/offapi/com/sun/star/animations/AnimationTransformType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module animations { -/** Specifies the transformation type for an <type>XAnimateTransform</type>. +/** Specifies the transformation type for an XAnimateTransform. @see http://www.w3.org/TR/SVG/animate.html#AnimateTransformElementTypeAttribute */ diff --git a/offapi/com/sun/star/animations/XAnimateTransform.idl b/offapi/com/sun/star/animations/XAnimateTransform.idl index cf0a73f6ed79..cdda0f61a1c8 100644 --- a/offapi/com/sun/star/animations/XAnimateTransform.idl +++ b/offapi/com/sun/star/animations/XAnimateTransform.idl @@ -38,9 +38,9 @@ <ul> <li><const>AnimationTransformType::TRANSLATE</const><br> - <type>ValuePair</type> of <i>tx</i> and <i>ty</i></li> + ValuePair of <i>tx</i> and <i>ty</i></li> <li><const>AnimationTransformType::SCALE</const><br> - <type>ValuePair</type> of <i>sx</i> and <i>sy</i></li> + ValuePair of <i>sx</i> and <i>sy</i></li> <li><const>AnimationTransformType::ROTATE</const><br> Values for a rotation angle</li> <li><const>AnimationTransformType::SKEWX</const><br> diff --git a/offapi/com/sun/star/animations/XAnimationNode.idl b/offapi/com/sun/star/animations/XAnimationNode.idl index 975b0b776e0c..de64f0fdcb1c 100644 --- a/offapi/com/sun/star/animations/XAnimationNode.idl +++ b/offapi/com/sun/star/animations/XAnimationNode.idl @@ -43,12 +43,12 @@ interface XAnimationNode : ::com::sun::star::container::XChild <li><atom>double</atom> 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><type>Event</type> describes an event and an optional offset that determine the + <li>Event describes an event and an optional offset that determine the element begin. The element begin is defined relative to the time that the event is raised.</li> <li><const>Timing::INDEFINITE</const> the begin of the element will be determined by an external event to the element.</li> - <li><type>sequence<any></type> a sequence of values described above if more than + <li>sequence<any> a sequence of values described above if more than one begin value is defined for this element.</li> <li><void/> if no begin behavior is defined for this element.</li> </ul> @@ -78,12 +78,12 @@ interface XAnimationNode : ::com::sun::star::container::XChild <li><atom>double</atom> 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><type>Event</type> describes an event and an optional offset that determine the + <li>Event describes an event and an optional offset that determine the element end. The element end is defined relative to the time that the event is raised.</li> <li><const>Timing::INDEFINITE</const> the end of the element will be determined by an external event to the element.</li> - <li><type>sequence<any></type> a sequence of values described above if more than + <li>sequence<any> a sequence of values described above if more than one begin value is defined for this element.</li> <li><void/> if no end behavior is defined for this element.</li> </ul> @@ -101,7 +101,7 @@ interface XAnimationNode : ::com::sun::star::container::XChild <member>EndSync</member> is either a <atom>short</atom> constant from <const>EndSync</const>, - an interface reference to a child <type>XTimeContainer</type> + an interface reference to a child XTimeContainer or <void/>. @see http://www.w3.org/TR/smil20/smil-timing.html#adef-endsync diff --git a/offapi/com/sun/star/auth/SSOManagerFactory.idl b/offapi/com/sun/star/auth/SSOManagerFactory.idl index 773b2ba7e035..424159eb4a52 100644 --- a/offapi/com/sun/star/auth/SSOManagerFactory.idl +++ b/offapi/com/sun/star/auth/SSOManagerFactory.idl @@ -33,13 +33,13 @@ module com { module sun { module star { module auth { between the two parties. The steps which should be followed to successfully use the SSO APIs are as follows: <UL> - <LI>Create an <type>XSSOManagerFactory</type> instance</LI> - <LI>Use this factory to create/retrieve an <type>XSSOManager</type> + <LI>Create an XSSOManagerFactory instance</LI> + <LI>Use this factory to create/retrieve an XSSOManager instance.</LI> <LI>Depending on whether your code is acting as SSO source or target, - you should use the <type>XSSOManager</type> instance to create an - initiator security context, <type>XSSOInitiatorContext</type> or an - acceptor security context, <type>XSSOAcceptorContext</type> + you should use the XSSOManager instance to create an + initiator security context, XSSOInitiatorContext or an + acceptor security context, XSSOAcceptorContext respectively.</LI> <LI>On the initiator side, use the previously created context to process security tokens received from the acceptor side and to create @@ -49,7 +49,7 @@ module com { module sun { module star { module auth { send to the initiator side.</LI> </UL> - The interface supports the creation of <type>XSSOManager</type> instances + The interface supports the creation of XSSOManager instances which can subsequently be used to create security contexts. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/auth/XSSOManagerFactory.idl b/offapi/com/sun/star/auth/XSSOManagerFactory.idl index 40f1aade210f..c66edbd3c0ee 100644 --- a/offapi/com/sun/star/auth/XSSOManagerFactory.idl +++ b/offapi/com/sun/star/auth/XSSOManagerFactory.idl @@ -33,11 +33,11 @@ module com { module sun { module star { module auth { published interface XSSOManagerFactory : ::com::sun::star::uno::XInterface { - /** provides a <type>XSSOManager</type> to be used in subsequent security + /** provides a XSSOManager to be used in subsequent security context creation. @returns - the relevant <type>XSSOManager</type> instance + the relevant XSSOManager instance */ XSSOManager getSSOManager(); }; diff --git a/offapi/com/sun/star/awt/AccessibleListBoxList.idl b/offapi/com/sun/star/awt/AccessibleListBoxList.idl index f178cf046908..1139e722d095 100644 --- a/offapi/com/sun/star/awt/AccessibleListBoxList.idl +++ b/offapi/com/sun/star/awt/AccessibleListBoxList.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { /** Accessible list box lists are used by list boxes as container for the list items. In addition of the simple container functionality of the - <type>AccessibleList</type> service the + AccessibleList service the <type scope="com::sun::star::accessibility">XAccessibleSelection</type> interface is supported. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/awt/AccessibleMenu.idl b/offapi/com/sun/star/awt/AccessibleMenu.idl index 41c1f42a0ad0..1ab33aa0558a 100644 --- a/offapi/com/sun/star/awt/AccessibleMenu.idl +++ b/offapi/com/sun/star/awt/AccessibleMenu.idl @@ -48,12 +48,12 @@ service AccessibleMenu help text.</li> <li>Children: The children of a menu are menus, menu items or menu separators, whose accessible context supports the services - <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or - <type>AccessibleMenuSeparator</type>.</li> + AccessibleMenu, AccessibleMenuItem or + AccessibleMenuSeparator.</li> <li>Parent: The parent of a menu is a menu bar, a pop-up menu or a menu, whose accessible context supports the services - <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type> - or <type>AccessibleMenu</type>.</li> + AccessibleMenuBar, AccessiblePopupMenu + or AccessibleMenu.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessibleMenuBar.idl b/offapi/com/sun/star/awt/AccessibleMenuBar.idl index aab1b853ed2a..1c731496a94b 100644 --- a/offapi/com/sun/star/awt/AccessibleMenuBar.idl +++ b/offapi/com/sun/star/awt/AccessibleMenuBar.idl @@ -46,8 +46,8 @@ service AccessibleMenuBar help text.</li> <li>Children: The children of a menu bar are menus, menu items or menu separators, whose accessible context supports the services - <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or - <type>AccessibleMenuSeparator</type>.</li> + AccessibleMenu, AccessibleMenuItem or + AccessibleMenuSeparator.</li> <li>Parent: The parent is the window that contains the menu bar.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are diff --git a/offapi/com/sun/star/awt/AccessibleMenuItem.idl b/offapi/com/sun/star/awt/AccessibleMenuItem.idl index 1a50da348856..fbc050707540 100644 --- a/offapi/com/sun/star/awt/AccessibleMenuItem.idl +++ b/offapi/com/sun/star/awt/AccessibleMenuItem.idl @@ -49,8 +49,8 @@ service AccessibleMenuItem <li>Children: There are no children.</li> <li>Parent: The parent of a menu item is a menu bar, a pop-up menu or a menu, whose accessible context supports the services - <type>AccessibleMenuBar</type>, <type>AccessiblePopupMenu</type> - or <type>AccessibleMenu</type>.</li> + AccessibleMenuBar, AccessiblePopupMenu + or AccessibleMenu.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessibleMenuSeparator.idl b/offapi/com/sun/star/awt/AccessibleMenuSeparator.idl index 39b146f686b2..99ec9da2773a 100644 --- a/offapi/com/sun/star/awt/AccessibleMenuSeparator.idl +++ b/offapi/com/sun/star/awt/AccessibleMenuSeparator.idl @@ -45,9 +45,9 @@ service AccessibleMenuSeparator <li>Children: There are no children.</li> <li>Parent: The parent of a menu separator is a menu bar, a pop-up menu or a menu, whose accessible context supports the - services <type>AccessibleMenuBar</type>, - <type>AccessiblePopupMenu</type> or - <type>AccessibleMenu</type>.</li> + services AccessibleMenuBar, + AccessiblePopupMenu or + AccessibleMenu.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessiblePopupMenu.idl b/offapi/com/sun/star/awt/AccessiblePopupMenu.idl index 3cc7e3c11b00..227df7e9ff5b 100644 --- a/offapi/com/sun/star/awt/AccessiblePopupMenu.idl +++ b/offapi/com/sun/star/awt/AccessiblePopupMenu.idl @@ -46,8 +46,8 @@ service AccessiblePopupMenu help text.</li> <li>Children: The children of a pop-up menu are menus, menu items or menu separators, whose accessible context supports the services - <type>AccessibleMenu</type>, <type>AccessibleMenuItem</type> or - <type>AccessibleMenuSeparator</type>.</li> + AccessibleMenu, AccessibleMenuItem or + AccessibleMenuSeparator.</li> <li>Parent: The parent is the window that contains the pop-up menu.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are diff --git a/offapi/com/sun/star/awt/AccessibleStatusBar.idl b/offapi/com/sun/star/awt/AccessibleStatusBar.idl index b8f21eefa692..9c3aae2878e5 100644 --- a/offapi/com/sun/star/awt/AccessibleStatusBar.idl +++ b/offapi/com/sun/star/awt/AccessibleStatusBar.idl @@ -44,7 +44,7 @@ service AccessibleStatusBar <li>Description: There is no description.</li> <li>Children: The children of a status bar are status bar items, whose accessible context supports the service - <type>AccessibleStatusBarItem</type>.</li> + AccessibleStatusBarItem.</li> <li>Parent: The parent is the window that contains the status bar.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are diff --git a/offapi/com/sun/star/awt/AccessibleStatusBarItem.idl b/offapi/com/sun/star/awt/AccessibleStatusBarItem.idl index a87b889665a0..f8602ccb703c 100644 --- a/offapi/com/sun/star/awt/AccessibleStatusBarItem.idl +++ b/offapi/com/sun/star/awt/AccessibleStatusBarItem.idl @@ -48,7 +48,7 @@ service AccessibleStatusBarItem <li>Children: There are no children.</li> <li>Parent: The parent of a status bar item is the status bar, whose accessible context supports the service - <type>AccessibleStatusBar</type>.</li> + AccessibleStatusBar.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessibleTabBar.idl b/offapi/com/sun/star/awt/AccessibleTabBar.idl index 962b6f40b0e5..3711073f8aba 100644 --- a/offapi/com/sun/star/awt/AccessibleTabBar.idl +++ b/offapi/com/sun/star/awt/AccessibleTabBar.idl @@ -46,7 +46,7 @@ service AccessibleTabBar <li>Children: The children of a tabbar are tabbar buttons, the tabbar sizer and the tabbar page list, whose accessible context supports the service - <type>AccessibleTabBarPageList</type>.</li> + AccessibleTabBarPageList.</li> <li>Parent: The parent is the window that contains the tabbar.</li> <li>Relations: There are no relations.</li> diff --git a/offapi/com/sun/star/awt/AccessibleTabBarPage.idl b/offapi/com/sun/star/awt/AccessibleTabBarPage.idl index 807f5713bfae..73238a65fd1b 100644 --- a/offapi/com/sun/star/awt/AccessibleTabBarPage.idl +++ b/offapi/com/sun/star/awt/AccessibleTabBarPage.idl @@ -47,7 +47,7 @@ service AccessibleTabBarPage <li>Children: There are no children.</li> <li>Parent: The parent of a tabbar page is the tabbar page list, whose accessible context supports the service - <type>AccessibleTabBarPageList</type>.</li> + AccessibleTabBarPageList.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessibleTabBarPageList.idl b/offapi/com/sun/star/awt/AccessibleTabBarPageList.idl index 8adcd5b5826c..150e8a106a67 100644 --- a/offapi/com/sun/star/awt/AccessibleTabBarPageList.idl +++ b/offapi/com/sun/star/awt/AccessibleTabBarPageList.idl @@ -45,10 +45,10 @@ service AccessibleTabBarPageList <li>Description: There is no description.</li> <li>Children: The children of a tabbar page list are tabbar pages, whose accessible context supports the service - <type>AccessibleTabBarPage</type>.</li> + AccessibleTabBarPage.</li> <li>Parent: The parent of a tabbar page list is the tabbar, whose accessible context supports the service - <type>AccessibleTabBar</type>.</li> + AccessibleTabBar.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessibleTabControl.idl b/offapi/com/sun/star/awt/AccessibleTabControl.idl index e77539c2faf3..f5eb6f4cd601 100644 --- a/offapi/com/sun/star/awt/AccessibleTabControl.idl +++ b/offapi/com/sun/star/awt/AccessibleTabControl.idl @@ -46,7 +46,7 @@ service AccessibleTabControl help text.</li> <li>Children: The children of a tab control are tab pages, whose accessible context supports the service - <type>AccessibleTabPage</type>.</li> + AccessibleTabPage.</li> <li>Parent: The parent is the window that contains the tab control.</li> <li>Relations: There are no relations.</li> diff --git a/offapi/com/sun/star/awt/AccessibleTabPage.idl b/offapi/com/sun/star/awt/AccessibleTabPage.idl index 1d4d54355479..f844cda1a489 100644 --- a/offapi/com/sun/star/awt/AccessibleTabPage.idl +++ b/offapi/com/sun/star/awt/AccessibleTabPage.idl @@ -47,7 +47,7 @@ service AccessibleTabPage <li>Children: The child of a tab page is a panel.</li> <li>Parent: The parent of a tab page is the tab control, whose accessible context supports the service - <type>AccessibleTabControl</type>.</li> + AccessibleTabControl.</li> <li>Relations: There are no relations.</li> <li>States: The states supported by this service are <ul> diff --git a/offapi/com/sun/star/awt/AccessibleTextField.idl b/offapi/com/sun/star/awt/AccessibleTextField.idl index a8c02767f37a..4957847cb130 100644 --- a/offapi/com/sun/star/awt/AccessibleTextField.idl +++ b/offapi/com/sun/star/awt/AccessibleTextField.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module awt { /** Text fields are like edit fields as described by the - <type>AccessibleEdit</type> service but without the ability to edit the + AccessibleEdit service but without the ability to edit the text. @see com::sun::star::accessibility::AccessibleContext @see com::sun::star::accessibility::XAccessibleComponent diff --git a/offapi/com/sun/star/awt/ActionEvent.idl b/offapi/com/sun/star/awt/ActionEvent.idl index 2cff4f9ba4d5..f938e713dd79 100644 --- a/offapi/com/sun/star/awt/ActionEvent.idl +++ b/offapi/com/sun/star/awt/ActionEvent.idl @@ -30,11 +30,11 @@ <p>This high-level event is generated by a component (such as a Button) when the component-specific action occurs (such as being pressed). - The event is passed to every <type>XActionListener</type> object + The event is passed to every XActionListener object that registered to receive such events using the component's <code>addActionListener</code> method.</p> - <p>The object that implements the <type>XActionListener</type> interface + <p>The object that implements the XActionListener interface gets this ActionEvent when the event occurs. The listener is therefore spared the details of processing individual mouse movements and mouse clicks, and can instead process a "meaningful" (semantic) event like diff --git a/offapi/com/sun/star/awt/AnimatedImagesControl.idl b/offapi/com/sun/star/awt/AnimatedImagesControl.idl index 5470af68a73a..99ccd222e6ca 100644 --- a/offapi/com/sun/star/awt/AnimatedImagesControl.idl +++ b/offapi/com/sun/star/awt/AnimatedImagesControl.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { interface XAnimation; -/** is the default control used for an <type>AnimatedImagesControlModel</type>, displayed a series of +/** is the default control used for an AnimatedImagesControlModel, displayed a series of images. @since OOo 3.4 diff --git a/offapi/com/sun/star/awt/FieldUnit.idl b/offapi/com/sun/star/awt/FieldUnit.idl index 0c0c9035ea65..4813f128c2fa 100644 --- a/offapi/com/sun/star/awt/FieldUnit.idl +++ b/offapi/com/sun/star/awt/FieldUnit.idl @@ -26,7 +26,7 @@ /** specifies attributes for the MetricField map units. <p><b>IMPORTANT:</b> These constants have to be disjunct with - constants in <type>util/MeasureUnit</type>.</p> + constants in util/MeasureUnit.</p> */ constants FieldUnit { diff --git a/offapi/com/sun/star/awt/FocusEvent.idl b/offapi/com/sun/star/awt/FocusEvent.idl index 34bd2fb69dcc..9c303b786b99 100644 --- a/offapi/com/sun/star/awt/FocusEvent.idl +++ b/offapi/com/sun/star/awt/FocusEvent.idl @@ -48,7 +48,7 @@ published struct FocusEvent: com::sun::star::lang::EventObject { /** specifies the reason for the focus change as an arithmetic-or - combination of <type>FocusChangeReason</type>. + combination of FocusChangeReason. @see FocusChangeReason */ diff --git a/offapi/com/sun/star/awt/ItemListEvent.idl b/offapi/com/sun/star/awt/ItemListEvent.idl index e8b8406676f9..e372fe45a8d6 100644 --- a/offapi/com/sun/star/awt/ItemListEvent.idl +++ b/offapi/com/sun/star/awt/ItemListEvent.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { -/** is the event broadcasted by a <type>XListItems</type> implementation for changes +/** is the event broadcasted by a XListItems implementation for changes in its item list. */ struct ItemListEvent : ::com::sun::star::lang::EventObject diff --git a/offapi/com/sun/star/awt/KeyEvent.idl b/offapi/com/sun/star/awt/KeyEvent.idl index 66a6cfb4beb6..3f1489d2c8bc 100644 --- a/offapi/com/sun/star/awt/KeyEvent.idl +++ b/offapi/com/sun/star/awt/KeyEvent.idl @@ -35,7 +35,7 @@ published struct KeyEvent: com::sun::star::awt::InputEvent /** contains the integer code representing the key of the event. - <p>This is a constant from the constant group <type>Key</type>.</p> + <p>This is a constant from the constant group Key.</p> */ short KeyCode; @@ -48,7 +48,7 @@ published struct KeyEvent: com::sun::star::awt::InputEvent /** contains the function type of the key event. <p>This is a constant from the constant group - <type>KeyFunction</type>.</p> + KeyFunction.</p> */ short KeyFunc; diff --git a/offapi/com/sun/star/awt/SpinningProgressControlModel.idl b/offapi/com/sun/star/awt/SpinningProgressControlModel.idl index 0dbc93af57a0..7d553867b122 100644 --- a/offapi/com/sun/star/awt/SpinningProgressControlModel.idl +++ b/offapi/com/sun/star/awt/SpinningProgressControlModel.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module awt { -/** is a specialization of the <type>AnimatedImagesControlModel</type> which provides standard image sets +/** is a specialization of the AnimatedImagesControlModel which provides standard image sets for displaying a non-procentual progress. <p>Three image sets are provided, of size 16x16, 32x32, and 64x64 pixels.</p> diff --git a/offapi/com/sun/star/awt/UnoControl.idl b/offapi/com/sun/star/awt/UnoControl.idl index 8427f92c61f4..06d8e5abbab4 100644 --- a/offapi/com/sun/star/awt/UnoControl.idl +++ b/offapi/com/sun/star/awt/UnoControl.idl @@ -38,7 +38,7 @@ <p>You must set a model and a stub to the UnoControl before using other methods. The implementation only allows the change of the - graphics (<type>XView</type>) if the window is not visible. The + graphics (XView) if the window is not visible. The change of the graphics in visible state should redirect the output to these graphics, but this behavior is implementation-specific.</p> diff --git a/offapi/com/sun/star/awt/UnoControlButtonModel.idl b/offapi/com/sun/star/awt/UnoControlButtonModel.idl index a53ac74bf943..22ee55da1447 100644 --- a/offapi/com/sun/star/awt/UnoControlButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlButtonModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlButton</type>. +/** specifies the standard model of an UnoControlButton. */ published service UnoControlButtonModel { @@ -103,14 +103,14 @@ published service UnoControlButtonModel /** specifies the alignment of the image inside the button as - <type>ImageAlign</type> value. + ImageAlign value. */ [property] short ImageAlign; /** specifies the position of the image, if any, relative to the text, if any - <p>Valid values of this property are specified with <type>ImagePosition</type>.</p> + <p>Valid values of this property are specified with ImagePosition.</p> <p>If this property is present, it supersedes the <member>ImageAlign</member> property - setting one of both properties sets the other one to the best possible match.</p> @@ -157,7 +157,7 @@ published service UnoControlButtonModel [property] boolean Printable; - /** specifies the default action of the button as <type>PushButtonType</type> value. + /** specifies the default action of the button as PushButtonType value. */ [property] short PushButtonType; diff --git a/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl b/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl index 9d277f321fb2..3e658588b55f 100644 --- a/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlCheckBoxModel.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlCheckBox</type>. +/** specifies the standard model of an UnoControlCheckBox. */ published service UnoControlCheckBoxModel { @@ -88,7 +88,7 @@ published service UnoControlCheckBoxModel /** specifies the position of the image, if any, relative to the text, if any - <p>Valid values of this property are specified with <type>ImagePosition</type>.</p> + <p>Valid values of this property are specified with ImagePosition.</p> */ [optional, property] short ImagePosition; @@ -172,8 +172,8 @@ published service UnoControlCheckBoxModel /** specifies a visual effect to apply to the check box control - <p>Possible values for this property are <type>VisualEffect</type>::FLAT and - <type>VisualEffect</type>::LOOK3D.</p> + <p>Possible values for this property are VisualEffect::FLAT and + VisualEffect::LOOK3D.</p> @see com::sun::star::awt::VisualEffect diff --git a/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl b/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl index 8132e7d74a76..a21e8d7e3af9 100644 --- a/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlComboBoxModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlComboBox</type>. +/** specifies the standard model of an UnoControlComboBox. */ published service UnoControlComboBoxModel { @@ -183,7 +183,7 @@ published service UnoControlComboBoxModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel scroll through the control's entry list. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlContainerModel.idl b/offapi/com/sun/star/awt/UnoControlContainerModel.idl index 98e0481e5206..5c69a0da8a6f 100644 --- a/offapi/com/sun/star/awt/UnoControlContainerModel.idl +++ b/offapi/com/sun/star/awt/UnoControlContainerModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlContainer</type>. +/** specifies the standard model of an UnoControlContainer. */ published service UnoControlContainerModel { diff --git a/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl b/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl index 9342dec2f8df..54a0862207f9 100644 --- a/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlCurrencyFieldModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlCurrencyField</type>. +/** specifies the standard model of an UnoControlCurrencyField. */ published service UnoControlCurrencyFieldModel { @@ -212,7 +212,7 @@ published service UnoControlCurrencyFieldModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl b/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl index 60e8e641022b..97779f991c8e 100644 --- a/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlDateFieldModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlDateField</type>. +/** specifies the standard model of an UnoControlDateField. */ published service UnoControlDateFieldModel { @@ -225,7 +225,7 @@ published service UnoControlDateFieldModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlDialogElement.idl b/offapi/com/sun/star/awt/UnoControlDialogElement.idl index 1d1fdcfcc70c..ea84602f0bd8 100644 --- a/offapi/com/sun/star/awt/UnoControlDialogElement.idl +++ b/offapi/com/sun/star/awt/UnoControlDialogElement.idl @@ -24,8 +24,8 @@ /** specifies a set of properties to describe the model of an - <type>UnoControl</type> which is embedded in a - <type>UnoControlDialogModel</type>. + UnoControl which is embedded in a + UnoControlDialogModel. */ published service UnoControlDialogElement { diff --git a/offapi/com/sun/star/awt/UnoControlDialogModel.idl b/offapi/com/sun/star/awt/UnoControlDialogModel.idl index 9c4dd99a4642..76229b168564 100644 --- a/offapi/com/sun/star/awt/UnoControlDialogModel.idl +++ b/offapi/com/sun/star/awt/UnoControlDialogModel.idl @@ -32,14 +32,14 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlDialog</type>. +/** specifies the standard model of an UnoControlDialog. */ published service UnoControlDialogModel { service com::sun::star::awt::UnoControlModel; /** allows to create control models, which support the - <type>UnoControlDialogElement</type> service and can be inserted into + UnoControlDialogElement service and can be inserted into this container. */ interface com::sun::star::lang::XMultiServiceFactory; diff --git a/offapi/com/sun/star/awt/UnoControlEditModel.idl b/offapi/com/sun/star/awt/UnoControlEditModel.idl index c90a5d57c579..056fba9030da 100644 --- a/offapi/com/sun/star/awt/UnoControlEditModel.idl +++ b/offapi/com/sun/star/awt/UnoControlEditModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlEdit</type>. +/** specifies the standard model of an UnoControlEdit. */ published service UnoControlEditModel { @@ -154,7 +154,7 @@ published service UnoControlEditModel setting, so that the <member>Text</member> property always contains only line ends in the format specified.</p> - <p>Possible values are all constants from the <type>LineEndFormat</type> group.</p> + <p>Possible values are all constants from the LineEndFormat group.</p> <p>Note that this setting is usually not relevant when you set new text via the API. No matter which line end format is used in this new text then, usual control implementations diff --git a/offapi/com/sun/star/awt/UnoControlFileControl.idl b/offapi/com/sun/star/awt/UnoControlFileControl.idl index 69513e59701e..20af4b387e2f 100644 --- a/offapi/com/sun/star/awt/UnoControlFileControl.idl +++ b/offapi/com/sun/star/awt/UnoControlFileControl.idl @@ -28,7 +28,7 @@ /** specifies a file control. - <p>A file control extends the <type>UnoControlEdit</type> with a file + <p>A file control extends the UnoControlEdit with a file dialog.</p> */ published service UnoControlFileControl diff --git a/offapi/com/sun/star/awt/UnoControlFileControlModel.idl b/offapi/com/sun/star/awt/UnoControlFileControlModel.idl index 007891b71cd4..d304a7a7f621 100644 --- a/offapi/com/sun/star/awt/UnoControlFileControlModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFileControlModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlFileControl</type>. +/** specifies the standard model of an UnoControlFileControl. */ published service UnoControlFileControlModel { diff --git a/offapi/com/sun/star/awt/UnoControlFixedHyperlinkModel.idl b/offapi/com/sun/star/awt/UnoControlFixedHyperlinkModel.idl index a79082f1130b..57a7d74cb875 100644 --- a/offapi/com/sun/star/awt/UnoControlFixedHyperlinkModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFixedHyperlinkModel.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlFixedHyperlink</type>. +/** specifies the standard model of an UnoControlFixedHyperlink. */ service UnoControlFixedHyperlinkModel { diff --git a/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl b/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl index af3e5b002122..c4e19275b109 100644 --- a/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFixedLineModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlFixedLine</type>. +/** specifies the standard model of an UnoControlFixedLine. */ published service UnoControlFixedLineModel { diff --git a/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl b/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl index 25e3a66980f6..f15a9862fdb6 100644 --- a/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFixedTextModel.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlFixedText</type>. +/** specifies the standard model of an UnoControlFixedText. */ published service UnoControlFixedTextModel { diff --git a/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl b/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl index f1a94ea84917..1d0d75b48e48 100644 --- a/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlFormattedFieldModel.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlFormattedField </type>. +/** specifies the standard model of an UnoControlFormattedField . */ published service UnoControlFormattedFieldModel { @@ -250,7 +250,7 @@ published service UnoControlFormattedFieldModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl b/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl index c30743136d17..bce9a038eed5 100644 --- a/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlGroupBoxModel.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlGroupBox</type>. +/** specifies the standard model of an UnoControlGroupBox. */ published service UnoControlGroupBoxModel { diff --git a/offapi/com/sun/star/awt/UnoControlImageControlModel.idl b/offapi/com/sun/star/awt/UnoControlImageControlModel.idl index bc482d4ab479..b48d86d6209f 100644 --- a/offapi/com/sun/star/awt/UnoControlImageControlModel.idl +++ b/offapi/com/sun/star/awt/UnoControlImageControlModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlImageControl</type>. +/** specifies the standard model of an UnoControlImageControl. */ published service UnoControlImageControlModel { @@ -112,7 +112,7 @@ published service UnoControlImageControlModel <p>If this property is present, it supersedes the <member>ScaleImage</member> property.</p> - <p>The value of this property is one of the <type>ImageScaleMode</type> constants.</p> + <p>The value of this property is one of the ImageScaleMode constants.</p> @since OOo 3.1 */ diff --git a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl index 51dd15e7c3ab..c489ad02c459 100644 --- a/offapi/com/sun/star/awt/UnoControlListBoxModel.idl +++ b/offapi/com/sun/star/awt/UnoControlListBoxModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlListBox</type>. +/** specifies the standard model of an UnoControlListBox. */ published service UnoControlListBoxModel { @@ -166,7 +166,7 @@ published service UnoControlListBoxModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel scroll through the control's entry list. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlModel.idl b/offapi/com/sun/star/awt/UnoControlModel.idl index 08072036d82e..5cf925867a9d 100644 --- a/offapi/com/sun/star/awt/UnoControlModel.idl +++ b/offapi/com/sun/star/awt/UnoControlModel.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControl</type> +/** specifies the standard model of an UnoControl in the <em>Smalltalk model view controller design</em>. <p>The interfaces <type scope="com::sun::star::beans">XPropertySet</type> @@ -49,7 +49,7 @@ published service UnoControlModel { /** This service is present when the control model is embedded in an - <type>UnoControlDialogModel</type>. + UnoControlDialogModel. */ [optional] service com::sun::star::awt::UnoControlDialogElement; diff --git a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl index f6c9cf596162..fc82f07aae35 100644 --- a/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlNumericFieldModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlNumericField</type>. +/** specifies the standard model of an UnoControlNumericField. */ published service UnoControlNumericFieldModel { @@ -202,7 +202,7 @@ published service UnoControlNumericFieldModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl b/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl index 4356e60bd832..9837c8f4fd40 100644 --- a/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlPatternFieldModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlPatternField</type>. +/** specifies the standard model of an UnoControlPatternField. */ published service UnoControlPatternFieldModel { @@ -166,7 +166,7 @@ published service UnoControlPatternFieldModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl b/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl index 565cd0bbe2a0..12e111eccae6 100644 --- a/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl +++ b/offapi/com/sun/star/awt/UnoControlProgressBarModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlProgressBar</type>. +/** specifies the standard model of an UnoControlProgressBar. */ published service UnoControlProgressBarModel { diff --git a/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl b/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl index c218e6cc1064..4f3675bf6b85 100644 --- a/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlRadioButton</type>. +/** specifies the standard model of an UnoControlRadioButton. */ published service UnoControlRadioButtonModel { @@ -89,7 +89,7 @@ published service UnoControlRadioButtonModel /** specifies the position of the image, if any, relative to the text, if any - <p>Valid values of this property are specified with <type>ImagePosition</type>.</p> + <p>Valid values of this property are specified with ImagePosition.</p> */ [optional, property] short ImagePosition; @@ -167,8 +167,8 @@ published service UnoControlRadioButtonModel /** specifies a visual effect to apply to the radio button control. - <p>Possible values for this property are <type>VisualEffect</type>::FLAT and - <type>VisualEffect</type>::LOOK3D.</p> + <p>Possible values for this property are VisualEffect::FLAT and + VisualEffect::LOOK3D.</p> @see com::sun::star::awt::VisualEffect diff --git a/offapi/com/sun/star/awt/UnoControlRoadmap.idl b/offapi/com/sun/star/awt/UnoControlRoadmap.idl index 7e706a8b9dde..2cbc3ceae82a 100644 --- a/offapi/com/sun/star/awt/UnoControlRoadmap.idl +++ b/offapi/com/sun/star/awt/UnoControlRoadmap.idl @@ -30,7 +30,7 @@ /** specifies a Roadmap control. The model of the Roadmap control must be a - <type>UnoControlRoadmapModel</type> + UnoControlRoadmapModel <p>The model properties are implemented in the control as follows: <ul><li>CurrentItem: The RGB code of the background color is RGB(194, 211, 238)</li> @@ -39,7 +39,7 @@ <li>Graphic: The graphic is placed in the lower right corner of the control.</li> <li>Complete: When set to <FALSE/> a non interactive RoadmapItem is appended after the last roadmap item, labeled with three dots, indicating incompleteness.</li> - <li>Interactive: When activating a RoadmapItem (see <type>RoadmapItem</type>) the + <li>Interactive: When activating a RoadmapItem (see RoadmapItem) the information about which Item has been selected is passed over when an itemlistener has been registered at the control.</li> </ul></p> diff --git a/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl b/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl index 118e545397b2..62f05cc900d3 100644 --- a/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl +++ b/offapi/com/sun/star/awt/UnoControlRoadmapModel.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlContainer</type>. +/** specifies the standard model of an UnoControlContainer. */ service UnoControlRoadmapModel { diff --git a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl index 3615fb053d4f..41268ae3e078 100644 --- a/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl +++ b/offapi/com/sun/star/awt/UnoControlScrollBarModel.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlScrollBar</type>. +/** specifies the standard model of an UnoControlScrollBar. */ published service UnoControlScrollBarModel { @@ -99,7 +99,7 @@ published service UnoControlScrollBarModel [optional, property] boolean LiveScroll; - /** specifies the <type>ScrollBarOrientation</type> of the control. + /** specifies the ScrollBarOrientation of the control. */ [property] long Orientation; diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl index a8b5b3c75a50..94bcf2f06541 100644 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl +++ b/offapi/com/sun/star/awt/UnoControlSimpleAnimation.idl @@ -30,7 +30,7 @@ /** @since OOo 2.2 @deprecated - You should use <type>AnimatedImagesControl</type>. + You should use AnimatedImagesControl. */ published service UnoControlSimpleAnimation { diff --git a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl b/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl index d1f54e59dbf0..8eda31c21ada 100644 --- a/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl +++ b/offapi/com/sun/star/awt/UnoControlSimpleAnimationModel.idl @@ -29,7 +29,7 @@ /** @since OOo 2.2 @deprecated - You should use <type>AnimatedImagesControlModel</type>. + You should use AnimatedImagesControlModel. */ published service UnoControlSimpleAnimationModel diff --git a/offapi/com/sun/star/awt/UnoControlSpinButton.idl b/offapi/com/sun/star/awt/UnoControlSpinButton.idl index c14a9c50b944..09a046a6f3b6 100644 --- a/offapi/com/sun/star/awt/UnoControlSpinButton.idl +++ b/offapi/com/sun/star/awt/UnoControlSpinButton.idl @@ -29,8 +29,8 @@ /** specifies a spin button control. - <p>The model of an <type>UnoControlSpinButton</type> control must support - the <type>UnoControlSpinButtonModel</type> service. + <p>The model of an UnoControlSpinButton control must support + the UnoControlSpinButtonModel service. */ service UnoControlSpinButton { diff --git a/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl b/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl index 66e14d148af3..69f66843cacc 100644 --- a/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl +++ b/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlSpinButton</type>. +/** specifies the standard model of an UnoControlSpinButton. <p>A spin button is a control which has a numeric value associated with it, and allows to change this value using two spin buttons.</p> @@ -85,7 +85,7 @@ service UnoControlSpinButtonModel [property] long SpinIncrement; - /** specifies the <type>ScrollBarOrientation</type> of the control. + /** specifies the ScrollBarOrientation of the control. */ [property] long Orientation; @@ -140,7 +140,7 @@ service UnoControlSpinButtonModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/UnoControlThrobber.idl b/offapi/com/sun/star/awt/UnoControlThrobber.idl index d986623a8adf..6f8123058d4c 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobber.idl +++ b/offapi/com/sun/star/awt/UnoControlThrobber.idl @@ -30,7 +30,7 @@ /** @since OOo 2.2 @deprecatd - You should use <type>AnimatedImagesControl</type>. + You should use AnimatedImagesControl. */ published service UnoControlThrobber { diff --git a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl b/offapi/com/sun/star/awt/UnoControlThrobberModel.idl index cf3471cd7c1d..3e172f77c83f 100644 --- a/offapi/com/sun/star/awt/UnoControlThrobberModel.idl +++ b/offapi/com/sun/star/awt/UnoControlThrobberModel.idl @@ -29,7 +29,7 @@ /** @since OOo 2.2 @deprecatd - You should use <type>SpinningAnimationControlModel</type>. + You should use SpinningAnimationControlModel. */ published service UnoControlThrobberModel diff --git a/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl b/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl index 443349cf4e1b..cefa3497910b 100644 --- a/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl +++ b/offapi/com/sun/star/awt/UnoControlTimeFieldModel.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module awt { -/** specifies the standard model of an <type>UnoControlTimeField</type>. +/** specifies the standard model of an UnoControlTimeField. */ published service UnoControlTimeFieldModel { @@ -207,7 +207,7 @@ published service UnoControlTimeFieldModel /** defines how the mouse wheel can be used to scroll through the control's content. <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, - and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances + and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.</p> */ [optional, property] short MouseWheelBehavior; diff --git a/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl b/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl index 06afc48b0fb2..350c4b904874 100644 --- a/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl +++ b/offapi/com/sun/star/awt/VclWindowPeerAttribute.idl @@ -27,7 +27,7 @@ /** specifies attributes for the VCL window implementation. <p><b>IMPORTANT:</b> These constants have to be disjunct with - constants in <type>WindowAttribute</type>.</p> + constants in WindowAttribute.</p> @deprecated */ diff --git a/offapi/com/sun/star/awt/WindowAttribute.idl b/offapi/com/sun/star/awt/WindowAttribute.idl index 556d09a2f9e6..4af42d832aca 100644 --- a/offapi/com/sun/star/awt/WindowAttribute.idl +++ b/offapi/com/sun/star/awt/WindowAttribute.idl @@ -27,7 +27,7 @@ /** These values are used to specify the decorations of a window. <p><b>IMPORTANT:</b> These constants have to be disjunct with - constants in <type>VclWindowPeerAttribute</type>.</p> + constants in VclWindowPeerAttribute.</p> */ published constants WindowAttribute { diff --git a/offapi/com/sun/star/awt/XAnimatedImages.idl b/offapi/com/sun/star/awt/XAnimatedImages.idl index 53fa512de1f0..49323f4fa759 100644 --- a/offapi/com/sun/star/awt/XAnimatedImages.idl +++ b/offapi/com/sun/star/awt/XAnimatedImages.idl @@ -56,7 +56,7 @@ interface XAnimatedImages /** controls the way the images are scaled up or down, when the available space is larger or smaller than what is needed for them. - <p>Allowed values are those from the <type>ImageScaleMode</type> constants group.</p> + <p>Allowed values are those from the ImageScaleMode constants group.</p> */ [attribute] short ScaleMode { diff --git a/offapi/com/sun/star/awt/XControlContainer.idl b/offapi/com/sun/star/awt/XControlContainer.idl index 9667a7b6007e..8c31ce8795af 100644 --- a/offapi/com/sun/star/awt/XControlContainer.idl +++ b/offapi/com/sun/star/awt/XControlContainer.idl @@ -29,7 +29,7 @@ /** Provides access to the controls within an - <type>UnoControlContainer</type>. + UnoControlContainer. */ published interface XControlContainer: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/awt/XDialogProvider2.idl b/offapi/com/sun/star/awt/XDialogProvider2.idl index eb676024fcd9..462460fd7a58 100644 --- a/offapi/com/sun/star/awt/XDialogProvider2.idl +++ b/offapi/com/sun/star/awt/XDialogProvider2.idl @@ -99,8 +99,8 @@ interface XDialogProvider2 : ::com::sun::star::awt::XDialogProvider { /** creates a dialog for the given URL, accepting additional creation parameters <p>The arguments accepted so far are - <ul><li><em>ParentWindow</em> - must be a component supporting the <type>XWindowPeer</type> interface, - or a component supporting the <type>XControl</type> interface, so an <code>XWindowPeer</code> can be + <ul><li><em>ParentWindow</em> - must be a component supporting the XWindowPeer interface, + or a component supporting the XControl interface, so an <code>XWindowPeer</code> can be obtained from it. The given window will be used as parent window for the to-be-created dialog.</li> <li><em>EventHandler</em> - specifies a component handling events in the dialog. See <member>createDialogWithHandler</member> for a detailed specification of dialog event handling.</li> diff --git a/offapi/com/sun/star/awt/XExtendedToolkit.idl b/offapi/com/sun/star/awt/XExtendedToolkit.idl index ccdbf5720098..df1500d4f685 100644 --- a/offapi/com/sun/star/awt/XExtendedToolkit.idl +++ b/offapi/com/sun/star/awt/XExtendedToolkit.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module awt { -/** The <type>XExtendedToolkit</type> is an extension of the <type +/** The XExtendedToolkit is an extension of the <type scope="::com::sun::star::awt">XToolkit</type> interface. It basically provides access to three event broadcasters which are used for instance in the context of accessibility. It is, however, not restricted to diff --git a/offapi/com/sun/star/awt/XFont2.idl b/offapi/com/sun/star/awt/XFont2.idl index 117bd0559389..c75ff2e60e70 100644 --- a/offapi/com/sun/star/awt/XFont2.idl +++ b/offapi/com/sun/star/awt/XFont2.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module awt { -/** extends the <type>XFont</type> interface and provides additional +/** extends the XFont interface and provides additional information for a font. @since OOo 3.0 diff --git a/offapi/com/sun/star/awt/XImageProducer.idl b/offapi/com/sun/star/awt/XImageProducer.idl index f47eca7ebe46..ac7f0f771237 100644 --- a/offapi/com/sun/star/awt/XImageProducer.idl +++ b/offapi/com/sun/star/awt/XImageProducer.idl @@ -37,7 +37,7 @@ published interface XImageProducer: com::sun::star::uno::XInterface the image data during a later reconstruction of the image. <p>The image producer may, at its discretion, start delivering the - image data to the consumer using the <type>XImageConsumer</type> + image data to the consumer using the XImageConsumer interface immediately, or when the next available image reconstruction is triggered by a call to the startProduction method.</p> */ diff --git a/offapi/com/sun/star/awt/XInfoPrinter.idl b/offapi/com/sun/star/awt/XInfoPrinter.idl index 34edec024b7c..577d882681e2 100644 --- a/offapi/com/sun/star/awt/XInfoPrinter.idl +++ b/offapi/com/sun/star/awt/XInfoPrinter.idl @@ -33,7 +33,7 @@ published interface XInfoPrinter: com::sun::star::awt::XPrinterPropertySet { - /** creates a new object which implements an <type>XDevice</type>. + /** creates a new object which implements an XDevice. <p>The current settings are used as a template.</p> */ diff --git a/offapi/com/sun/star/awt/XItemListListener.idl b/offapi/com/sun/star/awt/XItemListListener.idl index 96143a38a779..d72e655b13fa 100644 --- a/offapi/com/sun/star/awt/XItemListListener.idl +++ b/offapi/com/sun/star/awt/XItemListListener.idl @@ -60,7 +60,7 @@ interface XItemListListener : ::com::sun::star::lang::XEventListener in single events. <p>Consumers of this event should discard their cached information about the current item list, - and completely refresh it from the <type>XItemList</type>'s current state.</p> + and completely refresh it from the XItemList's current state.</p> */ void itemListChanged( [in] ::com::sun::star::lang::EventObject Event diff --git a/offapi/com/sun/star/awt/XMenuExtended2.idl b/offapi/com/sun/star/awt/XMenuExtended2.idl index 53adf71c38dc..32a1d942184c 100644 --- a/offapi/com/sun/star/awt/XMenuExtended2.idl +++ b/offapi/com/sun/star/awt/XMenuExtended2.idl @@ -43,10 +43,10 @@ interface XMenuExtended2 - /** checks whether an <type>XMenu</type> is an <type>XPopupMenu</type>. + /** checks whether an XMenu is an XPopupMenu. @return - <TRUE/> if the menu is a <type>PopupMenu</type>, <FALSE/> if it is a <type>MenuBar</type>. + <TRUE/> if the menu is a PopupMenu, <FALSE/> if it is a MenuBar. */ boolean isPopupMenu(); diff --git a/offapi/com/sun/star/awt/XPointer.idl b/offapi/com/sun/star/awt/XPointer.idl index f937ff565fd4..3cc8cdd2c27c 100644 --- a/offapi/com/sun/star/awt/XPointer.idl +++ b/offapi/com/sun/star/awt/XPointer.idl @@ -31,12 +31,12 @@ published interface XPointer: com::sun::star::uno::XInterface { - /** selects a <type>SystemPointer</type> for this mouse pointer. + /** selects a SystemPointer for this mouse pointer. */ void setType( [in] long nType ); - /** returns the currently set <type>SystemPointer</type> of this mouse + /** returns the currently set SystemPointer of this mouse pointer. */ long getType(); diff --git a/offapi/com/sun/star/awt/XPopupMenuExtended.idl b/offapi/com/sun/star/awt/XPopupMenuExtended.idl index f0dc8efc8f80..2796cfe08732 100644 --- a/offapi/com/sun/star/awt/XPopupMenuExtended.idl +++ b/offapi/com/sun/star/awt/XPopupMenuExtended.idl @@ -50,7 +50,7 @@ interface XPopupMenuExtended /** queries if the <type scope="com::sun::star::awt">PopupMenu</type> is being executed as a result of invoking <member scope="com::sun::star::awt">XPopupMenu::execute()</member>; that is, - for a <type>PopupMenu</type> activated by a <type>MenuBar</type> item, + for a PopupMenu activated by a MenuBar item, this methods returns <FALSE/>. @return @@ -73,19 +73,19 @@ interface XPopupMenuExtended void endExecute(); - /** sets the <type>MenuLogo</type> for this <type>PopupMenu</type>. + /** sets the MenuLogo for this PopupMenu. @param aMenuLogo - the <type>MenuLogo</type>. + the MenuLogo. @since OOo 3.1 */ void setLogo( [in] ::com::sun::star::awt::MenuLogo aMenuLogo ); - /** retrieves the <type>MenuLogo</type> for this <type>PopupMenu</type>. + /** retrieves the MenuLogo for this PopupMenu. @return - the <type>MenuLogo</type>. + the MenuLogo. @since OOo 3.1 */ @@ -103,19 +103,19 @@ interface XPopupMenuExtended - /** sets the <type>KeyEvent</type> for the menu item. + /** sets the KeyEvent for the menu item. - <p>The <type>KeyEvent</type> is <b>only</b> used as a container to transport + <p>The KeyEvent is <b>only</b> used as a container to transport the shortcut information, this method only draws the text corresponding to this keyboard shortcut. The client code is responsible for listening to - keyboard events (typically done via <type>XUserInputInterception</type>), + keyboard events (typically done via XUserInputInterception), and dispatch the respective command.</p> @param nItemId - specifies the menu item identifier for which the <type>KeyEvent</type> should be set. + specifies the menu item identifier for which the KeyEvent should be set. @param aKeyEvent - specifies the <type>KeyEvent</type> for the menu item. + specifies the KeyEvent for the menu item. @throws <type scope="com::sun::star::container">NoSuchElementException</type> if there is no menu item with the identifier specified in <var>nItemId</var>. @@ -125,17 +125,17 @@ interface XPopupMenuExtended void setAcceleratorKeyEvent( [in] short nItemId, [in] ::com::sun::star::awt::KeyEvent aKeyEvent ) raises ( ::com::sun::star::container::NoSuchElementException ); - /** retrieves the <type>KeyEvent</type> for the menu item. + /** retrieves the KeyEvent for the menu item. - <p>The <type>KeyEvent</type> is <b>only</b> used as a container to transport + <p>The KeyEvent is <b>only</b> used as a container to transport the shortcut information, so that in this case <member scope="::com::sun::star::lang::">EventObject::Source</member> is <NULL/>.</p> @param nItemId - specifies the menu item identifier for which the <type>KeyEvent</type> should be retrieved. + specifies the menu item identifier for which the KeyEvent should be retrieved. @return - the <type>KeyEvent</type> struct assigned to the requested menu item. + the KeyEvent struct assigned to the requested menu item. @throws <type scope="com::sun::star::container">NoSuchElementException</type> if there is no menu item with the identifier specified in <var>nItemId</var>. diff --git a/offapi/com/sun/star/awt/XReschedule.idl b/offapi/com/sun/star/awt/XReschedule.idl index a369df4860e7..b9363d7815c4 100644 --- a/offapi/com/sun/star/awt/XReschedule.idl +++ b/offapi/com/sun/star/awt/XReschedule.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { -/** The <type>XReschedule</type> interface can be used to give control to the main +/** The XReschedule interface can be used to give control to the main thread to allow events processing. @deprecated diff --git a/offapi/com/sun/star/awt/XScrollBar.idl b/offapi/com/sun/star/awt/XScrollBar.idl index 33c8bd4eed4a..6682c5cf8996 100644 --- a/offapi/com/sun/star/awt/XScrollBar.idl +++ b/offapi/com/sun/star/awt/XScrollBar.idl @@ -102,12 +102,12 @@ published interface XScrollBar: com::sun::star::uno::XInterface long getVisibleSize(); - /** sets the <type>ScrollBarOrientation</type> of the scroll bar. + /** sets the ScrollBarOrientation of the scroll bar. */ void setOrientation( [in] long n ); - /** returns the currently set <type>ScrollBarOrientation</type> of the + /** returns the currently set ScrollBarOrientation of the scroll bar. */ long getOrientation(); diff --git a/offapi/com/sun/star/awt/XSimpleAnimation.idl b/offapi/com/sun/star/awt/XSimpleAnimation.idl index ee79d7e456ca..1d2b2ba64294 100644 --- a/offapi/com/sun/star/awt/XSimpleAnimation.idl +++ b/offapi/com/sun/star/awt/XSimpleAnimation.idl @@ -28,7 +28,7 @@ /** @deprecated - You should use <type>XAnimation</type>, <type>AnimatedImagesControl</type>, and <type>AnimatedImagesControlModel</type>. + You should use XAnimation, AnimatedImagesControl, and AnimatedImagesControlModel. */ published interface XSimpleAnimation: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/awt/XSpinValue.idl b/offapi/com/sun/star/awt/XSpinValue.idl index 449135ebbf8a..1001ce0d8ce7 100644 --- a/offapi/com/sun/star/awt/XSpinValue.idl +++ b/offapi/com/sun/star/awt/XSpinValue.idl @@ -96,7 +96,7 @@ interface XSpinValue : com::sun::star::uno::XInterface /** controls the orientation of the control @param orientation - one of the <type>ScrollBarOrientation</type> values specifying the orientation + one of the ScrollBarOrientation values specifying the orientation @throws com::sun::star::lang::NoSupportException in case the given orientation is not supported */ diff --git a/offapi/com/sun/star/awt/XThrobber.idl b/offapi/com/sun/star/awt/XThrobber.idl index 8dbf53ad0ce4..46df9099aba0 100644 --- a/offapi/com/sun/star/awt/XThrobber.idl +++ b/offapi/com/sun/star/awt/XThrobber.idl @@ -28,7 +28,7 @@ /** @deprecatd - You should use <type>XAnimation</type>, <type>AnimatedImagesControl</type>, and <type>AnimatedImagesControlModel</type>. + You should use XAnimation, AnimatedImagesControl, and AnimatedImagesControlModel. */ published interface XThrobber: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/awt/XToggleButton.idl b/offapi/com/sun/star/awt/XToggleButton.idl index f815a85b1f28..5d71e6062e5c 100644 --- a/offapi/com/sun/star/awt/XToggleButton.idl +++ b/offapi/com/sun/star/awt/XToggleButton.idl @@ -30,7 +30,7 @@ /** is supported by buttons which can be toggled between a "pressed" and an "unpressed" state - <p>Changes in the toggle state are broadcasted to <type>XItemListener</type> instances.</p> + <p>Changes in the toggle state are broadcasted to XItemListener instances.</p> */ interface XToggleButton: XItemEventBroadcaster { diff --git a/offapi/com/sun/star/awt/XUnitConversion.idl b/offapi/com/sun/star/awt/XUnitConversion.idl index afde22b6c8c6..116c550268f0 100644 --- a/offapi/com/sun/star/awt/XUnitConversion.idl +++ b/offapi/com/sun/star/awt/XUnitConversion.idl @@ -34,20 +34,20 @@ */ interface XUnitConversion: com::sun::star::uno::XInterface { - /** converts the given <type>Point</type>, which is specified in pixels, into the given logical unit + /** converts the given Point, which is specified in pixels, into the given logical unit @param Point - A given <type>Point</type> in a well known type + A given Point in a well known type @param TargetUnit A type from <type scope="com::sun::star::util">MeasureUnit</type> in which the Point will convert to. @return - Returns a new <type>Point</type> in the TargetUnit type format. + Returns a new Point in the TargetUnit type format. */ com::sun::star::awt::Point convertPointToLogic( [in] com::sun::star::awt::Point Point, [in] short TargetUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); - /** converts the given <type>Point</type>, which is specified in the given logical unit, into pixels + /** converts the given Point, which is specified in the given logical unit, into pixels @param Point A given Point in the SourceUnit type @@ -55,34 +55,34 @@ interface XUnitConversion: com::sun::star::uno::XInterface The type from <type scope="com::sun::star::util">MeasureUnit</type> of the Point. @return - Return a new <type>Point</type> in Pixel type format. + Return a new Point in Pixel type format. */ com::sun::star::awt::Point convertPointToPixel( [in] com::sun::star::awt::Point aPoint, [in] short SourceUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); - /** converts the given <type>Size</type>, which is specified in pixels, into the given logical unit + /** converts the given Size, which is specified in pixels, into the given logical unit @param aSize - A given <type>Size</type> in a well known type + A given Size in a well known type @param TargetUnit A type from <type scope="com::sun::star::util">MeasureUnit</type> in which the Size will convert to. @return - Returns a new <type>Size</type> in the TargetUnit type format. + Returns a new Size in the TargetUnit type format. */ com::sun::star::awt::Size convertSizeToLogic( [in] com::sun::star::awt::Size aSize, [in] short TargetUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); - /** converts the given <type>Size</type>, which is specified in the given logical unit, into pixels + /** converts the given Size, which is specified in the given logical unit, into pixels @param Size - A given <type>Size</type> in a well known type + A given Size in a well known type @param TargetUnit The type from <type scope="com::sun::star::util">MeasureUnit</type> of the Size. @return - Returns a new <type>Size</type> in the TargetUnit type format. + Returns a new Size in the TargetUnit type format. */ com::sun::star::awt::Size convertSizeToPixel( [in] com::sun::star::awt::Size aSize, [in] short SourceUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/awt/XUnoControlContainer.idl b/offapi/com/sun/star/awt/XUnoControlContainer.idl index 32e1037d4641..9c9b3860872d 100644 --- a/offapi/com/sun/star/awt/XUnoControlContainer.idl +++ b/offapi/com/sun/star/awt/XUnoControlContainer.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { -/** gives access to the tab controllers of a <type>UnoControlContainer</type>. +/** gives access to the tab controllers of a UnoControlContainer. */ published interface XUnoControlContainer: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/awt/XWindow.idl b/offapi/com/sun/star/awt/XWindow.idl index b5df8adbb088..fc9a27ffc2d8 100644 --- a/offapi/com/sun/star/awt/XWindow.idl +++ b/offapi/com/sun/star/awt/XWindow.idl @@ -65,7 +65,7 @@ published interface XWindow: com::sun::star::lang::XComponent the height of the window. @param Flags - Flags are of type <type>PosSize</type> and specify, which parameters + Flags are of type PosSize and specify, which parameters are taken into account when setting the outer bounds of the window. */ void setPosSize( [in] long X, @@ -98,7 +98,7 @@ published interface XWindow: com::sun::star::lang::XComponent /** adds a window listener to the object. @param xListener - the listener to add. If this listener also supports the <type>XWindowListener2</type> interface, + the listener to add. If this listener also supports the XWindowListener2 interface, it will receive the additional events declared in XWindowListener2. */ void addWindowListener( [in] com::sun::star::awt::XWindowListener xListener ); diff --git a/offapi/com/sun/star/awt/XWindowListener2.idl b/offapi/com/sun/star/awt/XWindowListener2.idl index 07ed257969d8..79e36a8de693 100644 --- a/offapi/com/sun/star/awt/XWindowListener2.idl +++ b/offapi/com/sun/star/awt/XWindowListener2.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { -/** allows receive window-related events, additional to the ones received by an <type>XWindowListener</type> +/** allows receive window-related events, additional to the ones received by an XWindowListener */ interface XWindowListener2: XWindowListener { diff --git a/offapi/com/sun/star/awt/XWindowPeer.idl b/offapi/com/sun/star/awt/XWindowPeer.idl index 20cff9099586..d379232fb9aa 100644 --- a/offapi/com/sun/star/awt/XWindowPeer.idl +++ b/offapi/com/sun/star/awt/XWindowPeer.idl @@ -52,13 +52,13 @@ published interface XWindowPeer: com::sun::star::lang::XComponent /** invalidates the whole window with the specified - <type>InvalidateStyle</type>. + InvalidateStyle. */ void invalidate( [in] short Flags ); /** invalidates a rectangular area of the window with the specified - <type>InvalidateStyle</type>. + InvalidateStyle. */ void invalidateRect( [in] Rectangle Rect, [in] short Flags ); diff --git a/offapi/com/sun/star/awt/grid/DefaultGridColumnModel.idl b/offapi/com/sun/star/awt/grid/DefaultGridColumnModel.idl index faf81433b887..3ff19f0128ad 100644 --- a/offapi/com/sun/star/awt/grid/DefaultGridColumnModel.idl +++ b/offapi/com/sun/star/awt/grid/DefaultGridColumnModel.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module grid { -/** If you do not want to implement the <type>XGridColumnModel</type> yourself, use this service. +/** If you do not want to implement the XGridColumnModel yourself, use this service. @since OOo 3.3 */ service DefaultGridColumnModel diff --git a/offapi/com/sun/star/awt/grid/DefaultGridDataModel.idl b/offapi/com/sun/star/awt/grid/DefaultGridDataModel.idl index e9029b08123c..08c17b3ec8e5 100644 --- a/offapi/com/sun/star/awt/grid/DefaultGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/DefaultGridDataModel.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module grid { -/** If you do not want to implement the <type>XGridDataModel</type> yourself, use this service. +/** If you do not want to implement the XGridDataModel yourself, use this service. <p>The <code>DefaultGridDataModel</code> implementation is a dumb container of tabular data. You can add and remove rows, modify cell values, and the like.</p> diff --git a/offapi/com/sun/star/awt/grid/GridColumn.idl b/offapi/com/sun/star/awt/grid/GridColumn.idl index 5ec80bbca7ff..d346047813ef 100644 --- a/offapi/com/sun/star/awt/grid/GridColumn.idl +++ b/offapi/com/sun/star/awt/grid/GridColumn.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module grid { -/** Represents a column as used by the <type>DefaultGridColumnModel</type> +/** Represents a column as used by the DefaultGridColumnModel @since OOo 3.3 */ diff --git a/offapi/com/sun/star/awt/grid/GridColumnEvent.idl b/offapi/com/sun/star/awt/grid/GridColumnEvent.idl index bed6efd8c15f..2d8dd74e76e7 100644 --- a/offapi/com/sun/star/awt/grid/GridColumnEvent.idl +++ b/offapi/com/sun/star/awt/grid/GridColumnEvent.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module awt { module grid { -/** An event used by a <type>XGridColumn</type> to notify changes in the column. +/** An event used by a XGridColumn to notify changes in the column. @since OOo 3.3 */ diff --git a/offapi/com/sun/star/awt/grid/GridDataEvent.idl b/offapi/com/sun/star/awt/grid/GridDataEvent.idl index 88793106af10..922dd34fac13 100644 --- a/offapi/com/sun/star/awt/grid/GridDataEvent.idl +++ b/offapi/com/sun/star/awt/grid/GridDataEvent.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module grid { -/** used to notify changes in the data represented by an <type>XMutableGridDataModel</type>. +/** used to notify changes in the data represented by an XMutableGridDataModel. <p>Effectively, a <code>GridDataEvent</code> denotes a continuous two-dimensional cell range within a grid's data model, which is affected by a certain change.</p> diff --git a/offapi/com/sun/star/awt/grid/GridSelectionEvent.idl b/offapi/com/sun/star/awt/grid/GridSelectionEvent.idl index 38af99175c1f..dc441d83f15f 100644 --- a/offapi/com/sun/star/awt/grid/GridSelectionEvent.idl +++ b/offapi/com/sun/star/awt/grid/GridSelectionEvent.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module grid { -/** An event used by a <type>XGridControl</type> to notify changes in its row selection. +/** An event used by a XGridControl to notify changes in its row selection. @see XGridRowSelection @see XGridSelectionListener diff --git a/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl b/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl index 81da86c0c9e5..f14794ee24f4 100644 --- a/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl @@ -30,7 +30,7 @@ interface XSortableMutableGridDataModel; interface XMutableGridDataModel; -/** provides a default implementation of a <type>XSortableGridData</type>. +/** provides a default implementation of a XSortableGridData. <p>This service must be created with a secondary grid data model, which all actual data requests are delegated to. But before providing this data to the service's own clients, it is sorted, according to the sort order defined @@ -44,7 +44,7 @@ interface XMutableGridDataModel; <p>Consequently, you cannot use this service with data sets containing heterogenous data in a given column.</p> - <p>All requests made via the <type>XMutableGridDataModel</type> are delegated to the <code>XMutableGridDataModel</code> + <p>All requests made via the XMutableGridDataModel are delegated to the <code>XMutableGridDataModel</code> instance passed in the service constructor.</p> <p>Note that changing the data might result in the sort order being destroyed. If you want to ensure diff --git a/offapi/com/sun/star/awt/grid/UnoControlGrid.idl b/offapi/com/sun/star/awt/grid/UnoControlGrid.idl index 98e30d5df5f1..44d30e68840c 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGrid.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGrid.idl @@ -34,20 +34,20 @@ <h4>The Column Model</h4> - <p>The horizontal structure of the grid is defined by the <type>XGridColumnModel</type> implemented in <type>DefaultGridColumnModel</type> - The <type>XGridColumn</type> implemented in <type>GridColumn</type> describes the properties and behavior of a single column. Use the <member>XGridColumnModel::addColumn()</member> to add a column to the column model. + <p>The horizontal structure of the grid is defined by the XGridColumnModel implemented in DefaultGridColumnModel + The XGridColumn implemented in GridColumn describes the properties and behavior of a single column. Use the <member>XGridColumnModel::addColumn()</member> to add a column to the column model. </p> <h4>The Data Model</h4> - <p> All row data are stored in the <type>XGridDataModel</type>. - Use the <type>DefaultGridDataModel</type> to add <member>XGridDataModel::addRow()</member> or remove <member>XGridDataModel::removeRow()</member> rows. + <p> All row data are stored in the XGridDataModel. + Use the DefaultGridDataModel to add <member>XGridDataModel::addRow()</member> or remove <member>XGridDataModel::removeRow()</member> rows. </p> <p>The column and data model must be set at the <member>UnoControlGridModel::ColumnModel</member> and <member>UnoControlGridModel::GridDataModel</member> properties.</p> <h4>Selection</h4> <p>If you are interested in knowing when the selection changes implement a - <type>XGridSelectionListener</type> and add the instance with the method + XGridSelectionListener and add the instance with the method <member>XGridRowSelection::addSelectionListener()</member>. You than will be notified for any selection change.</p> diff --git a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl index b3f8cb82f76c..ffeecce4406d 100644 --- a/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl +++ b/offapi/com/sun/star/awt/grid/UnoControlGridModel.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module awt { module grid { -/** specifies the standard model of a <type>UnoControlGrid</type> control. +/** specifies the standard model of a UnoControlGrid control. @since OOo 3.3 */ @@ -77,27 +77,27 @@ published service UnoControlGridModel */ [property, maybevoid] long RowHeight; - /** Specifies the <type>XGridColumnModel</type> that is providing the column structure. + /** Specifies the XGridColumnModel that is providing the column structure. - <p>You can implement your own instance of <type>XGridColumnModel</type> or use - the <type>DefaultGridColumnModel</type>. + <p>You can implement your own instance of XGridColumnModel or use + the DefaultGridColumnModel. <p>The column model is in the ownership of the grid model: When you set a new column model, or dispose the grid model, then the (old) column model is disposed, too.</p> - <p>The default for this property is an empty instance of the <type>DefaultGridColumnModel</type>.</p> + <p>The default for this property is an empty instance of the DefaultGridColumnModel.</p> */ [property] XGridColumnModel ColumnModel; - /** Specifies the <type>XGridDataModel</type> that is providing the hierarchical data. + /** Specifies the XGridDataModel that is providing the hierarchical data. - <p>You can implement your own instance of <type>XGridDataModel</type> or use - the <type>DefaultGridDataModel</type>. + <p>You can implement your own instance of XGridDataModel or use + the DefaultGridDataModel. <p>The data model is in the ownership of the grid model: When you set a new data model, or dispose the grid model, then the (old) data model is disposed, too.</p> - <p>The default for this property is an empty instance of the <type>DefaultGridDataModel</type>.</p> + <p>The default for this property is an empty instance of the DefaultGridDataModel.</p> */ [property] XGridDataModel GridDataModel; diff --git a/offapi/com/sun/star/awt/grid/XGridColumn.idl b/offapi/com/sun/star/awt/grid/XGridColumn.idl index b627051bbc5a..e3fae1137f08 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumn.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumn.idl @@ -119,7 +119,7 @@ published interface XGridColumn */ [attribute] long DataColumnIndex; - /** Adds a listener for the <type>GridColumnEvent</type> posted after the grid changes. + /** Adds a listener for the GridColumnEvent posted after the grid changes. @param Listener the listener to add. */ diff --git a/offapi/com/sun/star/awt/grid/XGridColumnListener.idl b/offapi/com/sun/star/awt/grid/XGridColumnListener.idl index bc5687a5f1ca..13a38229c631 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumnListener.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumnListener.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module awt { module grid { -/** An instance of this interface is used by the <type>XGridColumnModel</type> to +/** An instance of this interface is used by the XGridColumnModel to get notifications about column model changes. @since OOo 3.3 diff --git a/offapi/com/sun/star/awt/grid/XGridColumnModel.idl b/offapi/com/sun/star/awt/grid/XGridColumnModel.idl index 1037df3150c3..16344dea1d4d 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumnModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumnModel.idl @@ -31,10 +31,10 @@ module com { module sun { module star { module awt { module grid { -/** An instance of this interface is used by the <type>UnoControlGrid</type> to +/** An instance of this interface is used by the UnoControlGrid to retrieve the column structure that is displayed in the actual control. - If you do not need your own model implementation, you can also use the <type>DefaultGridColumnModel</type>. + If you do not need your own model implementation, you can also use the DefaultGridColumnModel. @since OOo 3.3 */ @@ -71,7 +71,7 @@ published interface XGridColumnModel <p>You should use the <member>createColumn</member> member to create a new column. This gives implementations of the <code>XGridColumnModel</code> interface the possibility to provide own column - implementations which extend the basic <type>GridColumn</type> type.</p> + implementations which extend the basic GridColumn type.</p> <p>As soon as the column has been inserted into the model, the model takes ownership of it. This means when the column is removed, or when the column model is disposed, the grid column is disposed as well.</p> @@ -101,7 +101,7 @@ published interface XGridColumnModel /** Returns all columns of the model. @returns - all columns associated with the model in a sequence of <type>XGridColumn</type>. + all columns associated with the model in a sequence of XGridColumn. */ sequence<XGridColumn> getColumns(); diff --git a/offapi/com/sun/star/awt/grid/XGridDataListener.idl b/offapi/com/sun/star/awt/grid/XGridDataListener.idl index 604f63777652..0c89a5abf016 100644 --- a/offapi/com/sun/star/awt/grid/XGridDataListener.idl +++ b/offapi/com/sun/star/awt/grid/XGridDataListener.idl @@ -26,11 +26,11 @@ module com { module sun { module star { module awt { module grid { -/** An instance of this interface is used by the <type>XGridDataModel</type> to +/** An instance of this interface is used by the XGridDataModel to get notifications about data model changes. <p>Usually you must not implement this interface yourself, but you must notify it correctly if - you implement the <type>XGridDataModel</type> yourself</p>. + you implement the XGridDataModel yourself</p>. @since OOo 3.3 */ diff --git a/offapi/com/sun/star/awt/grid/XGridDataModel.idl b/offapi/com/sun/star/awt/grid/XGridDataModel.idl index f03f626feebf..94f6981f748e 100644 --- a/offapi/com/sun/star/awt/grid/XGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridDataModel.idl @@ -28,10 +28,10 @@ module com { module sun { module star { module awt { module grid { -/** An instance of this interface is used by the <type>UnoControlGrid</type> to +/** An instance of this interface is used by the UnoControlGrid to retrieve the content data that is displayed in the actual control. - If you do not need your own model implementation, you can also use the <type>DefaultGridDataModel</type>. + If you do not need your own model implementation, you can also use the DefaultGridDataModel. @since OOo 3.3 */ diff --git a/offapi/com/sun/star/awt/grid/XGridRowSelection.idl b/offapi/com/sun/star/awt/grid/XGridRowSelection.idl index 18c140cc30b2..3ed65208d92d 100644 --- a/offapi/com/sun/star/awt/grid/XGridRowSelection.idl +++ b/offapi/com/sun/star/awt/grid/XGridRowSelection.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module awt { module grid { -/** This interfaces provides access to the selection of row for <type>UnoControlGrid</type>. +/** This interfaces provides access to the selection of row for UnoControlGrid. @since LibreOffice 3.4 */ @@ -82,7 +82,7 @@ published interface XGridRowSelection */ boolean isRowSelected( [in] long RowIndex ); - /** Adds a listener for the <type>GridSelectionEvent</type> posted after the grid changes. + /** Adds a listener for the GridSelectionEvent posted after the grid changes. @param listener the listener to add. */ diff --git a/offapi/com/sun/star/awt/grid/XGridSelectionListener.idl b/offapi/com/sun/star/awt/grid/XGridSelectionListener.idl index 2ef8d8eab032..248da0a6bd01 100644 --- a/offapi/com/sun/star/awt/grid/XGridSelectionListener.idl +++ b/offapi/com/sun/star/awt/grid/XGridSelectionListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { module grid { -/** An instance of this interface is used by the <type>XGridRowSelection</type> to +/** An instance of this interface is used by the XGridRowSelection to get notifications about selection changes. */ published interface XGridSelectionListener: com::sun::star::lang::XEventListener diff --git a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl index a5ff88bdbd20..0b650b5c51a6 100644 --- a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { module grid { -/** allows to modify the data represented by a <type>XGridDataModel</type> +/** allows to modify the data represented by a XGridDataModel */ published interface XMutableGridDataModel : XGridDataModel { diff --git a/offapi/com/sun/star/awt/grid/XSortableGridData.idl b/offapi/com/sun/star/awt/grid/XSortableGridData.idl index 648833064201..21030e3cafcb 100644 --- a/offapi/com/sun/star/awt/grid/XSortableGridData.idl +++ b/offapi/com/sun/star/awt/grid/XSortableGridData.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { module grid { -/** allows to sort the data represented by a <type>XGridDataModel</type> +/** allows to sort the data represented by a XGridDataModel */ interface XSortableGridData { diff --git a/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl b/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl index 2665ab1fcacb..522b4033c6cc 100644 --- a/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl @@ -37,7 +37,7 @@ interface XSortableMutableGridDataModel /** provides means to sort the data represented by the model. - <p>If you set a new column sort order, the implementation will notify the registered <type>XGridDataListener</type>s + <p>If you set a new column sort order, the implementation will notify the registered XGridDataListeners via a call to its <member>XGridDataListener::dataChanged</member> method.</p> */ interface XSortableGridData; diff --git a/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl b/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl index 030815b7da43..959b12dddd54 100644 --- a/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl +++ b/offapi/com/sun/star/awt/tab/TabPageActivatedEvent.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module tab { -/** An event used by a <type>XTabPageContainer</type> to notify changes in tab page activation. +/** An event used by a XTabPageContainer to notify changes in tab page activation. @since OOo 3.4 */ diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl index c70b5d5ac132..d8cafa3009ab 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl @@ -67,7 +67,7 @@ published interface XTabPageContainer XTabPage getTabPageByID([in] short tabPageID); - /** Adds a listener for the <type>TabPageActivedEvent</type> posted after + /** Adds a listener for the TabPageActivedEvent posted after the tab page was activated. @param listener the listener to add. diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl b/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl index 175ab2354cad..7b1396e981f5 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainerListener.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module awt { module tab { -/** An instance of this interface is used by the <type>XTabPageContainer</type> to +/** An instance of this interface is used by the XTabPageContainer to get notifications about changes in activation of tab pages. @since OOo 3.4 diff --git a/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl b/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl index eba0867f82e6..5901dd8e9664 100644 --- a/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl +++ b/offapi/com/sun/star/awt/tree/MutableTreeDataModel.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module awt { module tree { -/** If you do not want to implement the <type>XTreeDataModel</type> yourself, use this service. - This implementation uses <type>MutableTreeNode</type> for its nodes. +/** If you do not want to implement the XTreeDataModel yourself, use this service. + This implementation uses MutableTreeNode for its nodes. */ service MutableTreeDataModel : XMutableTreeDataModel { diff --git a/offapi/com/sun/star/awt/tree/MutableTreeNode.idl b/offapi/com/sun/star/awt/tree/MutableTreeNode.idl index 7971558761dc..646f4de25d2c 100644 --- a/offapi/com/sun/star/awt/tree/MutableTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/MutableTreeNode.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module awt { module tree { -/** Represents an editable tree node as used by the <type>MutableTreeDataModel</type> +/** Represents an editable tree node as used by the MutableTreeDataModel */ service MutableTreeNode : XMutableTreeNode { diff --git a/offapi/com/sun/star/awt/tree/TreeControl.idl b/offapi/com/sun/star/awt/tree/TreeControl.idl index 88e702d22627..abf1d0dc4ccb 100644 --- a/offapi/com/sun/star/awt/tree/TreeControl.idl +++ b/offapi/com/sun/star/awt/tree/TreeControl.idl @@ -29,16 +29,16 @@ module com { module sun { module star { module awt { module tree { <p> <h4>The Data Model</h4> - <p>A specific node in a tree is identified by a <type>XTreeNode</type>. + <p>A specific node in a tree is identified by a XTreeNode. A leaf node is a node without any children and that returns <FALSE/> when calling <member>XTreeNode::hasChildrenOnDemand()</member>. An expanded node is a non-leaf node that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A node is visible when all parent nodes are expanded and the node itself is in the display area. </p> - <p>The nodes are retrieved from a <type>XTreeDataModel</type>. - You can implement it yourself or use the <type>MutableTreeDataModel</type> - which uses <type>XMutableTreeNode</type> and <type>XMutableTreeDataModel</type> + <p>The nodes are retrieved from a XTreeDataModel. + You can implement it yourself or use the MutableTreeDataModel + which uses XMutableTreeNode and XMutableTreeDataModel for a simple and mutable data model. <p>The data model must be set at the <member>TreeControlModel::TreeDataModel</member> property.</p> @@ -62,16 +62,16 @@ module com { module sun { module star { module awt { module tree { <p>If you want to add child nodes to your tree on demand you can do the following. <ul> <li>Make sure the parent node returns <TRUE/> for <member>XTreeNode::hasChildrenOnDemand()</member> either - by implementing <type>XTreeNode</type> yourself or if you use the <type>MutableTreeDataModel</type>, + by implementing XTreeNode yourself or if you use the MutableTreeDataModel, use <member>XMutableTreeNode::setHasChildrenOnDemand()</member>.</li> - <li>Implement a <type>XTreeExpansionListener</type> and add the instance with the method + <li>Implement a XTreeExpansionListener and add the instance with the method <member>XTreeControl::addTreeExpansionListener()</member>.</li> </ul> Now you get called when the node will become expanded or collapsed. So on <member>XTreeExpansionListener::treeExpanding()</member> you can - check the <type>TreeExpansionEvent</type> if the parent node with children on demand is going to + check the TreeExpansionEvent if the parent node with children on demand is going to be expanded and in that case add the missing child nodes. You can also veto the expansion or - collapsing of a parent node by using the <type>ExpandVetoException</type>. + collapsing of a parent node by using the ExpandVetoException. </p> */ service TreeControl: XTreeControl diff --git a/offapi/com/sun/star/awt/tree/TreeControlModel.idl b/offapi/com/sun/star/awt/tree/TreeControlModel.idl index b6a53e089eda..3e078ec549b6 100644 --- a/offapi/com/sun/star/awt/tree/TreeControlModel.idl +++ b/offapi/com/sun/star/awt/tree/TreeControlModel.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module awt { module tree { -/** specifies the standard model of a <type>TreeControl</type>. +/** specifies the standard model of a TreeControl. */ service TreeControlModel { @@ -39,17 +39,17 @@ service TreeControlModel */ [property] ::com::sun::star::view::SelectionType SelectionType; - /** Specifies the <type>XTreeDataModel</type> that is providing the hierarchical data. + /** Specifies the XTreeDataModel that is providing the hierarchical data. - <p>You can implement your own instance of <type>XTreeDataModel</type> or use - the <type>MutableTreeDataModel</type>. + <p>You can implement your own instance of XTreeDataModel or use + the MutableTreeDataModel. */ [property] XTreeDataModel DataModel; /** Specifies if the root node of the tree is displayed. <p>If <var>RootDisplayed</var> is set to <FALSE/>, the root node of a model is no longer - a valid node for the <type>XTreeControl</type> and can't be used with any method of - <type>XTreeControl</type>. + a valid node for the XTreeControl and can't be used with any method of + XTreeControl. <p>The default value is <TRUE/></p> */ [property] boolean RootDisplayed; diff --git a/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl b/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl index bff3a5496193..06b20c0e29de 100644 --- a/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl +++ b/offapi/com/sun/star/awt/tree/TreeDataModelEvent.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module awt { module tree { -/** An event used by a <type>XTreeDataModel</type> to notify changes in the data - model to the <type>XTreeControl</type>. - You usually need to fill this event only if you implement the <type>XTreeDataModel</type> +/** An event used by a XTreeDataModel to notify changes in the data + model to the XTreeControl. + You usually need to fill this event only if you implement the XTreeDataModel yourself. @see XTreeDataModel diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl index ed04c1ce9394..7773ed2dc8d6 100644 --- a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl +++ b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module awt { module tree { -/** This is the editable version of the <type>XTreeDataModel</type>. +/** This is the editable version of the XTreeDataModel. - <p>Note that only <type>XTreeNode</type> created from the same instance with <member>createNode</member> + <p>Note that only XTreeNode created from the same instance with <member>createNode</member> are valid nodes for this instance.</p> */ interface XMutableTreeDataModel : XTreeDataModel @@ -36,15 +36,15 @@ interface XMutableTreeDataModel : XTreeDataModel /** creates a new tree node with the given value and given settings. @param DisplayValue - should be convertible to a string and is used by the <type>XTreeControl</type> + should be convertible to a string and is used by the XTreeControl as a textual representation of the created node. @param ChildrenOnDemand if <TRUE/> is used as a parameter, the created node will be treated as a non-leaf - node by the <type>XTreeControl</type>, even when it has no child nodes. + node by the XTreeControl, even when it has no child nodes. @returns - a new <type>XMutableTreeNode</type> that can be used for this model. + a new XMutableTreeNode that can be used for this model. @see XTreeNode::getDisplayValue() @see XTreeNode::hasChildrenOnDemand() @@ -54,10 +54,10 @@ interface XMutableTreeDataModel : XTreeDataModel /** changes the root node of this model to <var>RootNode</var>. @param RootNode - the <type>XMutableTreeNode</type> that becomes the new root node of this model. + the XMutableTreeNode that becomes the new root node of this model. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>RootNode</var> is not a valid node of this <type>XTreeDataModel</type>. + if <var>RootNode</var> is not a valid node of this XTreeDataModel. */ void setRoot( [in] XMutableTreeNode RootNode ) raises( ::com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl index 7cd0fc7b5a97..ffe24bdb05a4 100644 --- a/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XMutableTreeNode.idl @@ -28,14 +28,14 @@ module com { module sun { module star { module awt { module tree { -/** Represents a mutable tree node as used by the <type>MutableTreeDataModel</type> +/** Represents a mutable tree node as used by the MutableTreeDataModel */ interface XMutableTreeNode : XTreeNode { /** appends <var>ChildNode</var> to this instance. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>ChildNode</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel. */ void appendChild( [in] XMutableTreeNode ChildNode ) raises( com::sun::star::lang::IllegalArgumentException ); @@ -46,7 +46,7 @@ interface XMutableTreeNode : XTreeNode the index where the node will be inserted to this instance. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>ChildNode</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>ChildNode</var> is not a valid node of the corresponding XTreeDataModel. @throws ::com::sun::star::lang::IndexOutOfBoundsException if <var>Index</var> is less than 0 or greater then <member>XTreeNode::getChildCount()</member>. diff --git a/offapi/com/sun/star/awt/tree/XTreeControl.idl b/offapi/com/sun/star/awt/tree/XTreeControl.idl index 7be90e6af4fa..03333cca1f32 100644 --- a/offapi/com/sun/star/awt/tree/XTreeControl.idl +++ b/offapi/com/sun/star/awt/tree/XTreeControl.idl @@ -37,11 +37,11 @@ interface XTreeControl /** This interfaces provides access to the selection of tree nodes for this control. <p>valid selection values for this interface are - <type>XTreeNode</type> or sequence<<type>XTreeNode</type>>.</p> + XTreeNode or sequence<XTreeNode>.</p> <method scope="::com::sun::star::view">XSelectionSupplier::getSelection()</method> - returns an empty any for no selection, an any with <type>XTreeNode</type> for - a single selection and a sequence<<type>XTreeNode</type>> for a multiselection. + returns an empty any for no selection, an any with XTreeNode for + a single selection and a sequence<XTreeNode> for a multiselection. */ interface ::com::sun::star::view::XMultiSelectionSupplier; @@ -50,14 +50,14 @@ interface XTreeControl /** Returns <TRUE/> if <var>Node</var> is currently expanded. @param Node - the <type>XTreeNode</type> specifying the node to check. + the XTreeNode specifying the node to check. @returns <FALSE/> if <var>Node</var> or at least one of its parent nodes are collapsed, <TRUE/> if <var>Node</var> and all of its parent nodes are expanded. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. */ boolean isNodeExpanded( [in] XTreeNode Node ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -65,14 +65,14 @@ interface XTreeControl /** Returns <TRUE/> if <var>Node</var> is currently collapsed. @param Node - the <type>XTreeNode</type> specifying the node to check + the XTreeNode specifying the node to check @returns <TRUE/> if <var>Node</var> or at least one of its parent nodes are collapsed, <FALSE/> if <var>Node</var> and all of its parent nodes are expanded @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. */ boolean isNodeCollapsed( [in] XTreeNode Node ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -82,15 +82,15 @@ interface XTreeControl node is visible in the controls display area.</p> @param Node - the <type>XTreeNode</type> specifying the node to make visible. + the XTreeNode specifying the node to make visible. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. @throws ExpandVetoException if <var>Node</var>can't be made visible since at least one of the parent nodes are collapsed and expanding failed because at least one of the registered - <type>XTreeExpansionListener</type> raised a <type>ExpandVetoException</type>. + XTreeExpansionListener raised a ExpandVetoException. */ void makeNodeVisible( [in] XTreeNode Node ) raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); @@ -102,7 +102,7 @@ interface XTreeControl <TRUE/> if <var>Node</var> is visible, otherwise <FALSE/> @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. */ boolean isNodeVisible( [in] XTreeNode Node ) raises( com::sun::star::lang::IllegalArgumentException ); @@ -111,14 +111,14 @@ interface XTreeControl <p>If <var>Node</var> is a leaf node, this will have no effect.</p> @param Node - the <type>XTreeNode</type> identifying a node. + the XTreeNode identifying a node. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. @throws ExpandVetoException if expanding <var>Node</var> failed because at least one of the registered - <type>XTreeExpansionListener</type> raised a <type>ExpandVetoException</type>. + XTreeExpansionListener raised a ExpandVetoException. */ void expandNode( [in] XTreeNode Node ) raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); @@ -126,30 +126,30 @@ interface XTreeControl /** Ensures that <var>Node</var> is collapsed. @param Node - the <type>XTreeNode</type> identifying a node + the XTreeNode identifying a node @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. @throws ExpandVetoException if collapsing <var>Node</var> failed because at least one of the registered - <type>XTreeExpansionListener</type> raised a <type>ExpandVetoException</type>. + XTreeExpansionListener raised a ExpandVetoException. */ void collapseNode( [in] XTreeNode Node ) raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException ); - /** Adds a listener for <type>TreeExpansion</type> events. + /** Adds a listener for TreeExpansion events. @param Listener - a <type>XTreeExpansionListener</type> that will be notified when a tree + a XTreeExpansionListener that will be notified when a tree node is expanded or collapsed. */ void addTreeExpansionListener( [in] XTreeExpansionListener Listener ); - /** Removes a listener for <type>TreeExpansion</type> events. + /** Removes a listener for TreeExpansion events. @param Listener - the <type>XTreeExpansionListener</type> to remove. + the XTreeExpansionListener to remove. */ void removeTreeExpansionListener( [in] XTreeExpansionListener Listener ); @@ -176,7 +176,7 @@ interface XTreeControl @param y an integer giving the number of pixels vertically from the top edge of the controls display area @returns - the <type>XTreeNode</type> for the node at that location, or 0 if there is no node at the given position + the XTreeNode for the node at that location, or 0 if there is no node at the given position */ XTreeNode getNodeForLocation( [in] long x, [in] long y ); @@ -190,7 +190,7 @@ interface XTreeControl @para y an integer giving the number of pixels vertically from the top edge of the controls display area @returns - the <type>XTreeNode</type> for the node closest to that location, null if nothing is viewable or there is no model + the XTreeNode for the node closest to that location, null if nothing is viewable or there is no model */ XTreeNode getClosestNodeForLocation( [in] long x, [in] long y ); @@ -216,7 +216,7 @@ interface XTreeControl boolean isEditing(); /** Ends the current editing session. - <p>All registered <type>XTreeEditListener</type> are notified if an editing session was in progress</p> + <p>All registered XTreeEditListener are notified if an editing session was in progress</p> <p>Has no effect if the tree isn't being edited.</p> @returns @@ -232,31 +232,31 @@ interface XTreeControl /** Selects <var>Node</var> and initiates editing. <p>If <member>TreeControlModel::Editable</member> is <FALSE/> or if there are no - registered <type>XTreeEditListener</type>, this call has no effect.</p> + registered XTreeEditListener, this call has no effect.</p> <p>Calling this method also ensures that <var>Node</var> will become visible.</p> @param Node - the <type>XTreeNode</type> identifying a node. + the XTreeNode identifying a node. @throws ::com::sun::star::lang::IllegalArgumentException - if <var>Node</var> is not a valid node of the corresponding <type>XTreeDataModel</type>. + if <var>Node</var> is not a valid node of the corresponding XTreeDataModel. */ void startEditingAtNode( [in] XTreeNode Node ) raises( ::com::sun::star::lang::IllegalArgumentException ); - /** Adds a <type>XTreeEditListener</type>. + /** Adds a XTreeEditListener. @param xListener - a <type>XTreeEditListener</type> that will be notified + a XTreeEditListener that will be notified before and after a tree node is edited. */ void addTreeEditListener( [in] XTreeEditListener Listener ); - /** Removes a <type>XTreeEditListener</type>. + /** Removes a XTreeEditListener. @param xListener - the <type>XTreeEditListener</type> to remove + the XTreeEditListener to remove */ void removeTreeEditListener( [in] XTreeEditListener Listener ); }; diff --git a/offapi/com/sun/star/awt/tree/XTreeDataModel.idl b/offapi/com/sun/star/awt/tree/XTreeDataModel.idl index 1d51fc2a410c..beb8f1907446 100644 --- a/offapi/com/sun/star/awt/tree/XTreeDataModel.idl +++ b/offapi/com/sun/star/awt/tree/XTreeDataModel.idl @@ -28,14 +28,14 @@ module com { module sun { module star { module awt { module tree { -/** An instance of this interface is used by the <type>TreeControl</type> to +/** An instance of this interface is used by the TreeControl to retrieve the hierarchical outline data that is displayed in the actual control. - <p>If you implement your own <type>XTreeDataModel</type> you need to notify registered - <type>XTreeDataModelListener</type> if your model changes after the control is created. - If this is not done correctly the <type>TreeControl</type> will not update the data properly.</p> + <p>If you implement your own XTreeDataModel you need to notify registered + XTreeDataModelListener if your model changes after the control is created. + If this is not done correctly the TreeControl will not update the data properly.</p> - If you do not need your own model implementation, you can also use the <type>MutableTreeDataModel</type>. + If you do not need your own model implementation, you can also use the MutableTreeDataModel. */ interface XTreeDataModel : ::com::sun::star::lang::XComponent { @@ -47,7 +47,7 @@ interface XTreeDataModel : ::com::sun::star::lang::XComponent */ XTreeNode getRoot(); - /** Adds a listener for the <type>TreeDataModelEvent</type> posted after the tree changes. + /** Adds a listener for the TreeDataModelEvent posted after the tree changes. @param Listener the listener to add. diff --git a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl index 3480dc0c98d3..aa9734feef06 100644 --- a/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeDataModelListener.idl @@ -28,12 +28,12 @@ module com { module sun { module star { module awt { module tree { -/** An instance of this interface is used by the <type>TreeControl</type> to +/** An instance of this interface is used by the TreeControl to get notifications about data model changes. <p>Usually you must not implement this interface yourself as it is already handled - by the <type>TreeControl</type>, but you must notify it correctly if - you implement the <type>XTreeDataModel</type> yourself</p>. + by the TreeControl, but you must notify it correctly if + you implement the XTreeDataModel yourself</p>. */ interface XTreeDataModelListener: com::sun::star::lang::XEventListener { diff --git a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl index 9355cd5487e1..2a72a6b6f000 100644 --- a/offapi/com/sun/star/awt/tree/XTreeEditListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeEditListener.idl @@ -35,11 +35,11 @@ module com { module sun { module star { module awt { module tree { */ interface XTreeEditListener : ::com::sun::star::lang::XEventListener { - /** This method is called from the <type>TreeControl</type> implementation when editing of + /** This method is called from the TreeControl implementation when editing of <var>Node</var> is requested by calling <member>XTreeControl::startEditingAtNode()</member>. @param Node - the <type>XTreeNode</type> for that an edit request was fired by calling + the XTreeNode for that an edit request was fired by calling <method scope="XTreeControl">startEditingAtNode</method> @throws VetoException @@ -48,14 +48,14 @@ interface XTreeEditListener : ::com::sun::star::lang::XEventListener void nodeEditing( [in] XTreeNode Node ) raises ( ::com::sun::star::util::VetoException ); - /** This method is called from the <type>TreeControl</type> implementation when editing + /** This method is called from the TreeControl implementation when editing of <var>Node</var> is finished and was not canceled. - <p>Implementations that register a <type>XTreeEditListener</type> must update the + <p>Implementations that register a XTreeEditListener must update the display value at the Node.</p> @param Node - the <type>XTreeNode</type> for that an edit request was fired by calling + the XTreeNode for that an edit request was fired by calling <method scope="XTreeControl">startEditingAtNode</method> @param NewText diff --git a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl index 7efb78daec57..be933ce0ba0b 100644 --- a/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl +++ b/offapi/com/sun/star/awt/tree/XTreeExpansionListener.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { module tree { -/** An instance of this interface can get notifications from a <type>TreeControl</type> +/** An instance of this interface can get notifications from a TreeControl when nodes are expanded or collapsed. @see XTreeControl::addTreeExpansionListener @@ -46,7 +46,7 @@ interface XTreeExpansionListener: com::sun::star::lang::XEventListener /** Invoked whenever a node in the tree is about to be expanded. @throws ExpandVetoException - to notify the calling <type>XTreeControl</type> that expanding + to notify the calling XTreeControl that expanding <member>TreeExpansionEvent::Node</member> should fail. */ void treeExpanding( [in] TreeExpansionEvent Event ) @@ -55,7 +55,7 @@ interface XTreeExpansionListener: com::sun::star::lang::XEventListener /** Invoked whenever a node in the tree is about to be collapsed. @throws ExpandVetoException - to notify the calling <type>XTreeControl</type> that collapsing + to notify the calling XTreeControl that collapsing <member>TreeExpansionEvent::Node</member> should fail. */ void treeCollapsing( [in] TreeExpansionEvent Event ) diff --git a/offapi/com/sun/star/awt/tree/XTreeNode.idl b/offapi/com/sun/star/awt/tree/XTreeNode.idl index 00ba0a7e97bd..8cbb27a07de1 100644 --- a/offapi/com/sun/star/awt/tree/XTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XTreeNode.idl @@ -27,10 +27,10 @@ module com { module sun { module star { module awt { module tree { /** An instance implementing this interface represents the model data for an entry in a - <type>XTreeDataModel</type>. - <p>The <type>TreeControl</type> uses this interface to retrieve the model + XTreeDataModel. + <p>The TreeControl uses this interface to retrieve the model information needed to display a hierarchical outline</p> - <p>Each XTreeNode in a <type>XTreeDataModel</type> must be unique. + <p>Each XTreeNode in a XTreeDataModel must be unique. */ interface XTreeNode { @@ -55,7 +55,7 @@ interface XTreeNode long getIndex( [in] XTreeNode Node); /** Returns <TRUE/> if the children of this node are created on demand. - <p>A <type>TreeControl</type> will handle a node that returns <TRUE/> always + <p>A TreeControl will handle a node that returns <TRUE/> always like a node that has child nodes, even if <member>getChildCount</member> returns 0.</p> diff --git a/offapi/com/sun/star/chart/AccessibleChartDocumentView.idl b/offapi/com/sun/star/chart/AccessibleChartDocumentView.idl index 0c5606d7fed8..9db36d573696 100644 --- a/offapi/com/sun/star/chart/AccessibleChartDocumentView.idl +++ b/offapi/com/sun/star/chart/AccessibleChartDocumentView.idl @@ -26,11 +26,11 @@ module com { module sun { module star { module chart { -/** The <type>AccessibleChartDocumentView</type> service is supported +/** The AccessibleChartDocumentView service is supported by a Component that represents the view of a Chart document to provide an entry point to the document tree for accessibility. - <p>An object that implements the <type>AccessibleChartDocumentView</type> + <p>An object that implements the AccessibleChartDocumentView service provides information about itself and about the chart subcomponents contained in the chart document displayed in a window. This service gives a simplified view on the underlying @@ -67,7 +67,7 @@ service AccessibleChartDocumentView titles, a legend and the diagram. The diagram and the legend are the only children that themselves contain children. The Chart subcomponents support the service - <type>AccessibleChartElement</type>. Additionally, there may be + AccessibleChartElement. Additionally, there may be shapes a user added via the clipboard. For details see the <type scope="::com::sun::star::drawing">AccessibleShape</type>. </dd> @@ -117,7 +117,7 @@ service AccessibleChartDocumentView subcomponents of a chart that cover a given test point.</p> <p>The accessible Chart subcomponents all support the service - <type>AccessibleChartElement</type></p> + AccessibleChartElement</p> @see AccessibleChartElement */ diff --git a/offapi/com/sun/star/chart/ChartArea.idl b/offapi/com/sun/star/chart/ChartArea.idl index 9abfa8f1b3b7..d2484dc5bc78 100644 --- a/offapi/com/sun/star/chart/ChartArea.idl +++ b/offapi/com/sun/star/chart/ChartArea.idl @@ -39,7 +39,7 @@ published service ChartArea service com::sun::star::drawing::FillProperties; service com::sun::star::drawing::LineProperties; - /** If the <type>ChartArea</type> may be stored as XML element, + /** If the ChartArea may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/ChartAxis.idl b/offapi/com/sun/star/chart/ChartAxis.idl index e0b240bc78c1..111aa0c6cfcb 100644 --- a/offapi/com/sun/star/chart/ChartAxis.idl +++ b/offapi/com/sun/star/chart/ChartAxis.idl @@ -54,7 +54,7 @@ published service ChartAxis */ service com::sun::star::style::CharacterProperties; - /** If a <type>ChartAxis</type> may be stored as XML element, this + /** If a ChartAxis may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/ChartDataChangeType.idl b/offapi/com/sun/star/chart/ChartDataChangeType.idl index aa38c4fbd74b..e4c7bb6c7558 100644 --- a/offapi/com/sun/star/chart/ChartDataChangeType.idl +++ b/offapi/com/sun/star/chart/ChartDataChangeType.idl @@ -35,30 +35,30 @@ published enum ChartDataChangeType /** The range of columns and rows, given in the - <type>ChartDataChangeEvent</type>, has changed. + ChartDataChangeEvent, has changed. */ DATA_RANGE, - /** The column given in the <type>ChartDataChangeEvent</type>, was + /** The column given in the ChartDataChangeEvent, was inserted. */ COLUMN_INSERTED, - /** The row given in the <type>ChartDataChangeEvent</type>, was + /** The row given in the ChartDataChangeEvent, was inserted. */ ROW_INSERTED, - /** The column given in the <type>ChartDataChangeEvent</type>, was + /** The column given in the ChartDataChangeEvent, was deleted. */ COLUMN_DELETED, - /** The row given in the <type>ChartDataChangeEvent</type>, was + /** The row given in the ChartDataChangeEvent, was deleted. */ ROW_DELETED diff --git a/offapi/com/sun/star/chart/ChartDataPointProperties.idl b/offapi/com/sun/star/chart/ChartDataPointProperties.idl index 51dbb0096bcf..ce66389de470 100644 --- a/offapi/com/sun/star/chart/ChartDataPointProperties.idl +++ b/offapi/com/sun/star/chart/ChartDataPointProperties.idl @@ -39,7 +39,7 @@ <p>Text properties correlate to the data description of the data point. There is a similar service for a group of graphic elements - called <type>ChartDataRowProperties</type> for the properties of + called ChartDataRowProperties for the properties of whole data rows.</p> @see ChartDataRowProperties @@ -58,7 +58,7 @@ published service ChartDataPointProperties */ service com::sun::star::style::CharacterProperties; - /** If <type>ChartDataPointProperties</type> may be stored as XML + /** If ChartDataPointProperties may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes. @@ -68,7 +68,7 @@ published service ChartDataPointProperties /** is only available if the chart is of type - <type>BarDiagram</type> and <type>Dim3DDiagram</type> and the + BarDiagram and Dim3DDiagram and the property <member>ChartDataPointProperties::Dim3D</member> is set to <TRUE/>. @@ -128,7 +128,7 @@ published service ChartDataPointProperties */ [optional, property] string SymbolBitmapURL; - /** the offset by which pie segments in a <type>PieDiagram</type> + /** the offset by which pie segments in a PieDiagram are dragged outside from the center. This value is given in percent of the radius. */ diff --git a/offapi/com/sun/star/chart/ChartDataRowProperties.idl b/offapi/com/sun/star/chart/ChartDataRowProperties.idl index 3fedbdcb7d16..332094d6bbe2 100644 --- a/offapi/com/sun/star/chart/ChartDataRowProperties.idl +++ b/offapi/com/sun/star/chart/ChartDataRowProperties.idl @@ -35,7 +35,7 @@ belong to a data row (also known as data series). <p>For this service, the properties supported by - <type>ChartDataPointProperties</type> are applied to all data + ChartDataPointProperties are applied to all data point elements contained in this group. They serve as a template; thus, when changing a data point property afterwards</p> @@ -49,7 +49,7 @@ published service ChartDataRowProperties */ [optional] service com::sun::star::chart::ChartStatistics; - /** If <type>ChartDataRowProperties</type> may be stored as XML + /** If ChartDataRowProperties may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/ChartDataRowSource.idl b/offapi/com/sun/star/chart/ChartDataRowSource.idl index 265b7f22b808..db58691b2425 100644 --- a/offapi/com/sun/star/chart/ChartDataRowSource.idl +++ b/offapi/com/sun/star/chart/ChartDataRowSource.idl @@ -26,7 +26,7 @@ /** specifies if the data rows (aka data series) displayed in the chart, take their values from the row or the column in the underlying - data source (<type>ChartDataArray</type>). + data source (ChartDataArray). */ published enum ChartDataRowSource { diff --git a/offapi/com/sun/star/chart/ChartDocument.idl b/offapi/com/sun/star/chart/ChartDocument.idl index c8d091f8cf03..0fe548cb15c2 100644 --- a/offapi/com/sun/star/chart/ChartDocument.idl +++ b/offapi/com/sun/star/chart/ChartDocument.idl @@ -41,7 +41,7 @@ */ published service ChartDocument { - /** If a <type>ChartDocument</type> may be stored as XML file, + /** If a ChartDocument may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/ChartGrid.idl b/offapi/com/sun/star/chart/ChartGrid.idl index be4bbac9c513..238c85f230e7 100644 --- a/offapi/com/sun/star/chart/ChartGrid.idl +++ b/offapi/com/sun/star/chart/ChartGrid.idl @@ -34,13 +34,13 @@ <p>The distance between the grid lines depends on the distance of the help - or main tick marks, which may be set in <type>ChartAxis</type>.</p>@see ChartAxis + or main tick marks, which may be set in ChartAxis.</p>@see ChartAxis */ published service ChartGrid { service com::sun::star::drawing::LineProperties; - /** If a <type>ChartGrid</type> may be stored as XML element, this + /** If a ChartGrid may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/ChartLegend.idl b/offapi/com/sun/star/chart/ChartLegend.idl index 1a056e4a012f..81b485eaf377 100644 --- a/offapi/com/sun/star/chart/ChartLegend.idl +++ b/offapi/com/sun/star/chart/ChartLegend.idl @@ -54,7 +54,7 @@ published service ChartLegend service com::sun::star::style::CharacterProperties; - /** If a <type>ChartLegend</type> may be stored as XML file, + /** If a ChartLegend may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl b/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl index 13fceb7cf41f..c20c65271e9f 100644 --- a/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl +++ b/offapi/com/sun/star/chart/ChartPieSegmentProperties.idl @@ -41,7 +41,7 @@ published service ChartPieSegmentProperties - <p>The default value for all the segments of a <type>PieDiagram</type> + <p>The default value for all the segments of a PieDiagram is 0. If you change this value from 0 to 100 the segment is pulled out from the center by its radius. diff --git a/offapi/com/sun/star/chart/ChartStatistics.idl b/offapi/com/sun/star/chart/ChartStatistics.idl index 09d9de5e4661..e8c4bce77f13 100644 --- a/offapi/com/sun/star/chart/ChartStatistics.idl +++ b/offapi/com/sun/star/chart/ChartStatistics.idl @@ -134,13 +134,13 @@ published service ChartStatistics [property] com::sun::star::chart::ChartRegressionCurveType RegressionCurves; /** contains a cell range string for positive error bars. This - property is used when the <type>ErrorBarCategory</type> is set + property is used when the ErrorBarCategory is set to <member>ErrorBarCategory::FROM_DATA</member>. */ [optional, property] string ErrorBarRangePositive; /** contains a cell range string for negative error bars. This - property is used when the <type>ErrorBarCategory</type> is set + property is used when the ErrorBarCategory is set to <member>ErrorBarCategory::FROM_DATA</member>. */ [optional, property] string ErrorBarRangeNegative; diff --git a/offapi/com/sun/star/chart/ChartTitle.idl b/offapi/com/sun/star/chart/ChartTitle.idl index d3019ca6654d..ab7c06ee0807 100644 --- a/offapi/com/sun/star/chart/ChartTitle.idl +++ b/offapi/com/sun/star/chart/ChartTitle.idl @@ -43,7 +43,7 @@ published service ChartTitle [optional, property] boolean AutomaticPosition; - /** If a <type>ChartTitle</type> may be stored as XML element, + /** If a ChartTitle may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/Diagram.idl b/offapi/com/sun/star/chart/Diagram.idl index c0ce8551b6df..3e43a99a5e4d 100644 --- a/offapi/com/sun/star/chart/Diagram.idl +++ b/offapi/com/sun/star/chart/Diagram.idl @@ -38,10 +38,10 @@ <p>The diagram is the object that contains the actual plot.</p> - <p>Different Diagram Types, e.g., <type>PieDiagram</type> or - <type>LineDiagram</type>, can be instantiated by the + <p>Different Diagram Types, e.g., PieDiagram or + LineDiagram, can be instantiated by the <type scope="com::sun::star::lang">XMultiServiceFactory</type> of - the <type>XChartDocument</type>.</p> + the XChartDocument.</p> */ published service Diagram @@ -82,7 +82,7 @@ published service Diagram interface com::sun::star::beans::XPropertySet; - /** If a <type>Diagram</type> may be stored as XML file, this + /** If a Diagram may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes. diff --git a/offapi/com/sun/star/chart/LineDiagram.idl b/offapi/com/sun/star/chart/LineDiagram.idl index 76855813c814..7c006b8baf55 100644 --- a/offapi/com/sun/star/chart/LineDiagram.idl +++ b/offapi/com/sun/star/chart/LineDiagram.idl @@ -61,8 +61,8 @@ published service LineDiagram <p>If you set this property to <member>ChartSymbolType::AUTO</member>, you can change the symbol shape for objects supporting the service - <type>ChartDataPointProperties</type> or - <type>ChartDataRowProperties</type>.</p> + ChartDataPointProperties or + ChartDataRowProperties.</p> @see ChartDataPointProperties @see ChartDataRowProperties diff --git a/offapi/com/sun/star/chart/StockDiagram.idl b/offapi/com/sun/star/chart/StockDiagram.idl index a83b8c0d0263..bf291acc9670 100644 --- a/offapi/com/sun/star/chart/StockDiagram.idl +++ b/offapi/com/sun/star/chart/StockDiagram.idl @@ -91,7 +91,7 @@ published service StockDiagram volume of stocks. <p>The values of the volume are represented as columns like - those of a <type>BarDiagram</type>.</p> + those of a BarDiagram.</p> <p>If this property is set to <TRUE/>, the values of the first series of the chart data are interpreted as volume.</p> diff --git a/offapi/com/sun/star/chart/TimeIncrement.idl b/offapi/com/sun/star/chart/TimeIncrement.idl index c9813f5d97c5..fec1def0cad0 100644 --- a/offapi/com/sun/star/chart/TimeIncrement.idl +++ b/offapi/com/sun/star/chart/TimeIncrement.idl @@ -30,19 +30,19 @@ module com { module sun { module star { module chart { */ published struct TimeIncrement { - /** if the any contains a struct of type <type>::com::sun::star::chart::TimeInterval</type> + /** if the any contains a struct of type ::com::sun::star::chart::TimeInterval this is used as a fixed distance value for the major tickmarks. Otherwise, if the any is empty or contains an incompatible type, the distance between major tickmarks is calculated automatically by the application. */ any MajorTimeInterval; - /** if the any contains a struct of type <type>::com::sun::star::chart::TimeInterval</type> + /** if the any contains a struct of type ::com::sun::star::chart::TimeInterval this is used as a fixed distance value for the minor tickmarks. Otherwise, if the any is empty or contains an incompatible type, the distance between minor tickmarks is calculated automatically by the application. */ any MinorTimeInterval; - /** if the any contains a constant of type <type>::com::sun::star::chart::TimeUnit</type> + /** if the any contains a constant of type ::com::sun::star::chart::TimeUnit this is the smallest time unit that is displayed on the date-time axis. Otherwise, if the any is empty or contains an incompatible type, the resolution is choosen automatically by the application. diff --git a/offapi/com/sun/star/chart/TimeInterval.idl b/offapi/com/sun/star/chart/TimeInterval.idl index b5a8cc737746..28ef553cacc2 100644 --- a/offapi/com/sun/star/chart/TimeInterval.idl +++ b/offapi/com/sun/star/chart/TimeInterval.idl @@ -35,7 +35,7 @@ published struct TimeInterval long Number; /** specifies a unit for the interval - <p>is a value out of the constant group <type>::com::sun::star::chart::TimeUnit</type>.</p> + <p>is a value out of the constant group ::com::sun::star::chart::TimeUnit.</p> */ long TimeUnit; }; diff --git a/offapi/com/sun/star/chart/XAxis.idl b/offapi/com/sun/star/chart/XAxis.idl index 17725b72dbe2..adb973a053da 100644 --- a/offapi/com/sun/star/chart/XAxis.idl +++ b/offapi/com/sun/star/chart/XAxis.idl @@ -30,17 +30,17 @@ module com { module sun { module star { module chart { interface XAxis : ::com::sun::star::uno::XInterface { /** @returns - the title of the axis. The returned object supports the properties described in service <type>ChartTitle</type>. + the title of the axis. The returned object supports the properties described in service ChartTitle. */ com::sun::star::beans::XPropertySet getAxisTitle(); /** @returns - the properties of the major grid of the axis. The returned object supports service <type>ChartGrid</type>. + the properties of the major grid of the axis. The returned object supports service ChartGrid. */ com::sun::star::beans::XPropertySet getMajorGrid(); /** @returns - the properties of the minor grid of the axis. The returned object supports service <type>ChartGrid</type>. + the properties of the minor grid of the axis. The returned object supports service ChartGrid. */ com::sun::star::beans::XPropertySet getMinorGrid(); }; diff --git a/offapi/com/sun/star/chart/XAxisSupplier.idl b/offapi/com/sun/star/chart/XAxisSupplier.idl index 88f14db321eb..c7858f401fc7 100644 --- a/offapi/com/sun/star/chart/XAxisSupplier.idl +++ b/offapi/com/sun/star/chart/XAxisSupplier.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module chart { interface XAxisSupplier : ::com::sun::star::uno::XInterface { /** @returns - the primary axis of the specified dimension. The returned object supports service <type>ChartAxis</type>. + the primary axis of the specified dimension. The returned object supports service ChartAxis. @param nDimensionIndex Parameter nDimensionIndex says whether it is a x, y or z-axis (0 for x). @@ -38,7 +38,7 @@ interface XAxisSupplier : ::com::sun::star::uno::XInterface com::sun::star::chart::XAxis getAxis( [in] long nDimensionIndex ); /** @returns - the secondary axis of the specified dimension. The returned object supports service <type>ChartAxis</type>. + the secondary axis of the specified dimension. The returned object supports service ChartAxis. @param nDimensionIndex Parameter nDimensionIndex says whether it is a x, y or z-axis (0 for x). diff --git a/offapi/com/sun/star/chart/XAxisXSupplier.idl b/offapi/com/sun/star/chart/XAxisXSupplier.idl index 4f1311812c6b..113c409a41ce 100644 --- a/offapi/com/sun/star/chart/XAxisXSupplier.idl +++ b/offapi/com/sun/star/chart/XAxisXSupplier.idl @@ -33,7 +33,7 @@ /** gives access to the <i>x</i>-axis of a chart. <p>Note that not all diagrams are capable of displaying an - <i>x</i>-axis, e.g., the <type>PieDiagram</type>.</p> + <i>x</i>-axis, e.g., the PieDiagram.</p> @see XDiagram */ diff --git a/offapi/com/sun/star/chart/XAxisYSupplier.idl b/offapi/com/sun/star/chart/XAxisYSupplier.idl index 93cb0bfaaca6..9e2e14ff5fc1 100644 --- a/offapi/com/sun/star/chart/XAxisYSupplier.idl +++ b/offapi/com/sun/star/chart/XAxisYSupplier.idl @@ -33,7 +33,7 @@ /** gives access to the <i>y</i>-axis of a chart. <p>Note that not all diagrams are capable of displaying a - <i>y</i>-axis, e.g., the <type>PieDiagram</type>.</p> + <i>y</i>-axis, e.g., the PieDiagram.</p> @see XDiagram */ diff --git a/offapi/com/sun/star/chart/XChartData.idl b/offapi/com/sun/star/chart/XChartData.idl index 11b2a6587294..fa49818bf568 100644 --- a/offapi/com/sun/star/chart/XChartData.idl +++ b/offapi/com/sun/star/chart/XChartData.idl @@ -36,9 +36,9 @@ published interface XChartData: com::sun::star::uno::XInterface { /** allows a component supporting the - <type>XChartDataChangeEventListener</type> interface to + XChartDataChangeEventListener interface to register as listener. The component will be notified with a - <type>ChartDataChangeEvent</type> every time the chart's data + ChartDataChangeEvent every time the chart's data changes.</p> @param aListener diff --git a/offapi/com/sun/star/chart/XChartDataArray.idl b/offapi/com/sun/star/chart/XChartDataArray.idl index 9c2f5cb12f2d..9764c85bd773 100644 --- a/offapi/com/sun/star/chart/XChartDataArray.idl +++ b/offapi/com/sun/star/chart/XChartDataArray.idl @@ -27,9 +27,9 @@ /** gives access to data represented as an array of rows. - <p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p> + <p>Can be obtained from interface XChartDocument via method getData().</p> - <p>If used for an <type>XYDiagram</type>, the row number 0 + <p>If used for an XYDiagram, the row number 0 represents the <i>x</i>-values.</p> */ published interface XChartDataArray: XChartData diff --git a/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl b/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl index 95ac72d3c256..d1899ca3f0bb 100644 --- a/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl +++ b/offapi/com/sun/star/chart/XChartDataChangeEventListener.idl @@ -37,7 +37,7 @@ published interface XChartDataChangeEventListener: com::sun::star::lang::XEventL <p>This interface must be implemented by components that wish to get notified of changes in chart data. They can be - registered at an <type>XChartData</type> component.</p> + registered at an XChartData component.</p> @param aEvent the event that gives further information on what changed. diff --git a/offapi/com/sun/star/chart/XChartDocument.idl b/offapi/com/sun/star/chart/XChartDocument.idl index 0d63d023e588..7e22b4187bea 100644 --- a/offapi/com/sun/star/chart/XChartDocument.idl +++ b/offapi/com/sun/star/chart/XChartDocument.idl @@ -77,7 +77,7 @@ published interface XChartDocument: com::sun::star::frame::XModel want to access properties of the background area of the diagram, in which the actual data is represented, you have to change the chart wall which you get from the - <type>X3DDisplay</type>.</p> + X3DDisplay.</p> @see ChartArea @see X3DDisplay @@ -103,7 +103,7 @@ published interface XChartDocument: com::sun::star::frame::XModel create such a diagram component, you can use the <type scope="com::sun::star::lang">XMultiServiceFactory</type>, which should be implemented by an - <type>XChartDocument</type>. + XChartDocument. */ void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram ); @@ -111,13 +111,13 @@ published interface XChartDocument: com::sun::star::frame::XModel /** @returns the data of the chart. - <p>The returned object supports interface <type>XChartDataArray</type> + <p>The returned object supports interface XChartDataArray which can be used to access the concrete data.</p> - <p>Since OOo 3.3 the returned object also supports interface <type>XComplexDescriptionAccess</type> + <p>Since OOo 3.3 the returned object also supports interface XComplexDescriptionAccess which can be used to access complex hierarchical axis descriptions.</p> - <p>Since OOo 3.4 the returned object also supports interface <type>XDateCategories</type>.</p> + <p>Since OOo 3.4 the returned object also supports interface XDateCategories.</p> @see XChartData @see XChartDataArray @@ -129,12 +129,12 @@ published interface XChartDocument: com::sun::star::frame::XModel /** attaches data to the chart. - <p>The given object needs to support interface <type>XChartDataArray</type>.</p> + <p>The given object needs to support interface XChartDataArray.</p> - <p>Since OOo 3.3 if the given object might support interface <type>XComplexDescriptionAccess</type> + <p>Since OOo 3.3 if the given object might support interface XComplexDescriptionAccess which allows to set complex hierarchical axis descriptions.</p> - <p>Since OOo 3.4 if the given object might support interface <type>XDateCategories</type> + <p>Since OOo 3.4 if the given object might support interface XDateCategories which allows to set date values as x values for category charts.</p> <p>The given data is copied before it is applied to the chart. diff --git a/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl b/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl index c12ae700f18c..80c33ba6d2b8 100644 --- a/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl +++ b/offapi/com/sun/star/chart/XComplexDescriptionAccess.idl @@ -27,7 +27,7 @@ /** Offers access to complex column and row descriptions. -<p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p> +<p>Can be obtained from interface XChartDocument via method getData().</p> @since OOo 3.3 */ diff --git a/offapi/com/sun/star/chart/XDateCategories.idl b/offapi/com/sun/star/chart/XDateCategories.idl index 1565a75fe279..fa81062aae86 100644 --- a/offapi/com/sun/star/chart/XDateCategories.idl +++ b/offapi/com/sun/star/chart/XDateCategories.idl @@ -27,7 +27,7 @@ /** Allows to set date values as categories. -<p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p> +<p>Can be obtained from interface XChartDocument via method getData().</p> @since OOo 3.4 */ diff --git a/offapi/com/sun/star/chart/XStatisticDisplay.idl b/offapi/com/sun/star/chart/XStatisticDisplay.idl index 7b27872544be..4bfab0da6b75 100644 --- a/offapi/com/sun/star/chart/XStatisticDisplay.idl +++ b/offapi/com/sun/star/chart/XStatisticDisplay.idl @@ -31,7 +31,7 @@ /** gives access to statistical elements for the chart. <p>Statistical elements are used by a - <type>StockDiagram</type>.</p> + StockDiagram.</p> @see XChartDocument @see StockDiagram diff --git a/offapi/com/sun/star/chart2/Axis.idl b/offapi/com/sun/star/chart2/Axis.idl index 9fb4a20f6c1b..5f36118a6193 100644 --- a/offapi/com/sun/star/chart2/Axis.idl +++ b/offapi/com/sun/star/chart2/Axis.idl @@ -99,7 +99,7 @@ service Axis means linked to the source format.</p> <p>To determine a source format, the axis can query the - <type>XDataSequence</type>s used by the data series attached + XDataSequences used by the data series attached to it (see <member>XDataSequence::getNumberFormatKeyByIndex</member>). </p> */ @@ -109,13 +109,13 @@ service Axis /** determines what kind of tickmarks should be shown for major ticks. - @see <type>TickmarkStyle</type>. + @see TickmarkStyle. */ [property] long MajorTickmarks; /** determines what kind of tickmarks should be shown for minor ticks. - @see <type>TickmarkStyle</type>. + @see TickmarkStyle. */ [property] long MinorTickmarks; diff --git a/offapi/com/sun/star/chart2/ChartDocumentWrapper.idl b/offapi/com/sun/star/chart2/ChartDocumentWrapper.idl index e3bb47035cfe..7ade4b6dc577 100644 --- a/offapi/com/sun/star/chart2/ChartDocumentWrapper.idl +++ b/offapi/com/sun/star/chart2/ChartDocumentWrapper.idl @@ -40,13 +40,13 @@ module chart2 service ChartDocumentWrapper { /** This service will be available for a - <type>ChartDocument</type> (of namespace chart2) through this + ChartDocument (of namespace chart2) through this wrapper. */ service ::com::sun::star::chart::ChartDocument; /** provides the possibility to forward requests to a - <type>ChartDocument</type>. + ChartDocument. */ interface ::com::sun::star::uno::XAggregation; }; diff --git a/offapi/com/sun/star/chart2/ChartTypeManager.idl b/offapi/com/sun/star/chart2/ChartTypeManager.idl index 12b90737aa59..cba0f3fed88e 100644 --- a/offapi/com/sun/star/chart2/ChartTypeManager.idl +++ b/offapi/com/sun/star/chart2/ChartTypeManager.idl @@ -30,12 +30,12 @@ module star module chart2 { -/** A factory for creating <type>ChartTypeTemplate</type>s. +/** A factory for creating ChartTypeTemplates. */ service ChartTypeManager { /** A factory for creating objects the support the service - <type>ChartTypeTemplate</type>. + ChartTypeTemplate. */ service ::com::sun::star::lang::MultiServiceFactory; }; diff --git a/offapi/com/sun/star/chart2/DataPoint.idl b/offapi/com/sun/star/chart2/DataPoint.idl index 805509025094..507e0d16c20b 100644 --- a/offapi/com/sun/star/chart2/DataPoint.idl +++ b/offapi/com/sun/star/chart2/DataPoint.idl @@ -47,7 +47,7 @@ service DataPoint the service <type scope="com::sun::star::style">Style</type>. <p>It should provide templates for all properties in this - service, thus it must also support <type>DataPoint</type>.</p> + service, thus it must also support DataPoint.</p> */ // [property] ::com::sun::star::style::XStyle Style; diff --git a/offapi/com/sun/star/chart2/DataPointProperties.idl b/offapi/com/sun/star/chart2/DataPointProperties.idl index b23bd97adc70..7c7b15e644df 100644 --- a/offapi/com/sun/star/chart2/DataPointProperties.idl +++ b/offapi/com/sun/star/chart2/DataPointProperties.idl @@ -133,7 +133,7 @@ service DataPointProperties "com.sun.star.drawing.LineDashTable", that can be created via the <type scope="com::sun::star::uno">XMultiServiceFactory</type> - of the <type>ChartDocument</type>. + of the ChartDocument. */ [optional, property] string BorderDashName; @@ -163,7 +163,7 @@ service DataPointProperties "com.sun.star.drawing.LineDashTable", that can be created via the <type scope="com::sun::star::uno">XMultiServiceFactory</type> - of the <type>ChartDocument</type>. + of the ChartDocument. */ [optional, property] string LineDashName; @@ -240,7 +240,7 @@ service DataPointProperties [optional, property] double Offset; /** describes the geometry of a 3 dimensional data point. - Number is one of constant group <type>DataPointGeometry3D</type>. + Number is one of constant group DataPointGeometry3D. <p>This is especially used for 3D bar-charts.</p> <p>CUBOID==0 CYLINDER==1 CONE==2 PYRAMID==3 CUBOID==else</p> */ @@ -281,7 +281,7 @@ service DataPointProperties x-direction. <p>The <type scope="com::sun::star::beans">XPropertySet</type> - must support the service <type>ErrorBar</type>.</p> + must support the service ErrorBar.</p> */ [optional, maybevoid, property] com::sun::star::beans::XPropertySet ErrorBarX; @@ -289,7 +289,7 @@ service DataPointProperties y-direction. <p>The <type scope="com::sun::star::beans">XPropertySet</type> - must support the service <type>ErrorBar</type>.</p> + must support the service ErrorBar.</p> */ [optional, maybevoid, property] com::sun::star::beans::XPropertySet ErrorBarY; diff --git a/offapi/com/sun/star/chart2/DataSeries.idl b/offapi/com/sun/star/chart2/DataSeries.idl index b79781ae36d8..1f1d9a048dde 100644 --- a/offapi/com/sun/star/chart2/DataSeries.idl +++ b/offapi/com/sun/star/chart2/DataSeries.idl @@ -46,10 +46,10 @@ module chart2 /** reflects the model data of the object that has all the information - for a <type>DataRenderer</type> to create a visible data series in + for a DataRenderer to create a visible data series in a chart. - <p>It combines one or more <type>DataSequence</type>s which are + <p>It combines one or more DataSequences which are interpreted by evaluating their role-string.</p> @see DataSequenceRole @@ -101,7 +101,7 @@ service DataSeries are of type <type scope="com::sun::star::beans">XPropertySet</type> and support the service - <type>DataPoint</type>. + DataPoint. */ // interface ::com::sun::star::container::XIndexContainer; @@ -141,7 +141,7 @@ service DataSeries in the data series.</p> <p>The indexes in this sequence match the indexes used by the - <type>XIndexContainer</type>.</p> + XIndexContainer.</p> <p>This property is especially useful for large data series with only some formatted data points, because you do not have diff --git a/offapi/com/sun/star/chart2/IncrementData.idl b/offapi/com/sun/star/chart2/IncrementData.idl index bb3b3e5c9752..25b2c930d4f6 100644 --- a/offapi/com/sun/star/chart2/IncrementData.idl +++ b/offapi/com/sun/star/chart2/IncrementData.idl @@ -28,10 +28,10 @@ module com { module sun { module star { module chart2 { /** An IncrementData describes how tickmarks are positioned on the scale of an axis. -@see <type>Axis</type> -@see <type>Grid</type> -@see <type>Scale</type> -@see <type>XScaling</type> +@see Axis +@see Grid +@see Scale +@see XScaling */ struct IncrementData { @@ -48,10 +48,10 @@ struct IncrementData describes a distance before or after the scaling is applied. <p>If <member>PostEquidistant</member> equals <TRUE/> <member>Distance</member> - is given in values after <type>XScaling</type> is applied, thus resulting + is given in values after XScaling is applied, thus resulting main tickmarks will always look equidistant on the screen. If <member>PostEquidistant</member> equals <FALSE/> <member>Distance</member> - is given in values before <type>XScaling</type> is applied.</p> + is given in values before XScaling is applied.</p> */ any PostEquidistant; diff --git a/offapi/com/sun/star/chart2/Legend.idl b/offapi/com/sun/star/chart2/Legend.idl index 748a2d1b4fd8..ab6ed46ccedc 100644 --- a/offapi/com/sun/star/chart2/Legend.idl +++ b/offapi/com/sun/star/chart2/Legend.idl @@ -36,7 +36,7 @@ module star module chart2 { -/** Describes a legend for a <type>Diagram</type>. +/** Describes a legend for a Diagram. */ service Legend { diff --git a/offapi/com/sun/star/chart2/RelativeSize.idl b/offapi/com/sun/star/chart2/RelativeSize.idl index 29ffe4ddeeee..f83e40997728 100644 --- a/offapi/com/sun/star/chart2/RelativeSize.idl +++ b/offapi/com/sun/star/chart2/RelativeSize.idl @@ -39,14 +39,14 @@ struct RelativeSize defined by the object using this point. <p>Typically, the direction is determined by an - <type>Orientation</type>. Another typical use would be the + Orientation. Another typical use would be the direction of a given orientation-angle.</p> <p>The values are relative to the page or an object. Values between 0 and 1 span the complete bounding rectangle of the page/object.</p> - <p>For a western <type>Orientation</type> this is the + <p>For a western Orientation this is the width.</p> */ double Primary; @@ -55,14 +55,14 @@ struct RelativeSize defined by the object using this point. <p>Typically, the direction is determined by an - <type>Orientation</type>. Another typical use would be the + Orientation. Another typical use would be the direction perpendicular to a given orientation-angle.</p> <p>The values are relative to the page or an object. Values between 0 and 1 span the complete bounding rectangle of the page/object.</p> - <p>For a western <type>Orientation</type> this is the + <p>For a western Orientation this is the height.</p> */ double Secondary; diff --git a/offapi/com/sun/star/chart2/ScaleData.idl b/offapi/com/sun/star/chart2/ScaleData.idl index b241679d4328..d4e9a484045f 100644 --- a/offapi/com/sun/star/chart2/ScaleData.idl +++ b/offapi/com/sun/star/chart2/ScaleData.idl @@ -81,7 +81,7 @@ struct ScaleData /** describes the type of the axis. <p>It can be a real number axis or a category axis or something else. - AxisType is one value out of the constant group <type>AxisType</type>.</p> + AxisType is one value out of the constant group AxisType.</p> */ long AxisType; diff --git a/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl b/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl index a9e467210ec6..916885053e1a 100644 --- a/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl +++ b/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl @@ -35,7 +35,7 @@ module chart2 */ service StandardDiagramCreationParameters { - /** States whether the first <type>XLabeledDataSequence</type> in + /** States whether the first XLabeledDataSequence in a data-source is used as categories. */ [optional, property] boolean HasCategories; diff --git a/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl b/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl index c1b580741d75..551709daf2ce 100644 --- a/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl +++ b/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl @@ -28,7 +28,7 @@ /** Offers any access to column and row descriptions. This allows to set date values as categories. -<p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p> +<p>Can be obtained from interface XChartDocument via method getData().</p> @since OOo 3.4 */ diff --git a/offapi/com/sun/star/chart2/XAxis.idl b/offapi/com/sun/star/chart2/XAxis.idl index 4f8316fdff16..9be21e31bdac 100644 --- a/offapi/com/sun/star/chart2/XAxis.idl +++ b/offapi/com/sun/star/chart2/XAxis.idl @@ -43,21 +43,21 @@ interface XAxis : ::com::sun::star::uno::XInterface ScaleData getScaleData(); /** the returned property set must support the service - <type>GridProperties</type> + GridProperties */ com::sun::star::beans::XPropertySet getGridProperties(); /** the returned property sets must support the service - <type>GridProperties</type> + GridProperties <p>If you do not want to render certain a sub-grid, in the - corresponding <type>XPropertySet</type> the property + corresponding XPropertySet the property <member>GridProperties::Show</member> must be <FALSE/>.</p> */ sequence< com::sun::star::beans::XPropertySet > getSubGridProperties(); /** the returned property sets must support the service - <type>TickProperties</type> + TickProperties */ sequence< com::sun::star::beans::XPropertySet > getSubTickProperties(); }; diff --git a/offapi/com/sun/star/chart2/XChartDocument.idl b/offapi/com/sun/star/chart2/XChartDocument.idl index 1810ccf1d81c..5566c8130cc7 100644 --- a/offapi/com/sun/star/chart2/XChartDocument.idl +++ b/offapi/com/sun/star/chart2/XChartDocument.idl @@ -100,13 +100,13 @@ interface XChartDocument : ::com::sun::star::frame::XModel /** sets a new component that is able to create different chart type templates (components of type - <type>ChartTypeTemplate</type>) + ChartTypeTemplate) */ void setChartTypeManager( [in] XChartTypeManager xNewManager ); /** retrieves the component that is able to create different chart type templates (components of type - <type>ChartTypeTemplate</type>) + ChartTypeTemplate) */ XChartTypeManager getChartTypeManager(); diff --git a/offapi/com/sun/star/chart2/XChartType.idl b/offapi/com/sun/star/chart2/XChartType.idl index 27e7af03fbe6..802fbe48324a 100644 --- a/offapi/com/sun/star/chart2/XChartType.idl +++ b/offapi/com/sun/star/chart2/XChartType.idl @@ -72,9 +72,9 @@ interface XChartType : com::sun::star::uno::XInterface */ sequence< string > getSupportedOptionalRoles(); - /** Returns the role of the <type>XLabeledDataSequence</type> of + /** Returns the role of the XLabeledDataSequence of which the label will be taken to identify the - <type>DataSeries</type> in dialogs or the legend. + DataSeries in dialogs or the legend. */ string getRoleOfSequenceForSeriesLabel(); }; diff --git a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl index b2765e2885aa..555794e16d4a 100644 --- a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl +++ b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl @@ -42,7 +42,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface @param xDataSource This data source will be interpreted in a chart-type - specific way and appropriate <type>DataSeries</type> will + specific way and appropriate DataSeries will be created which serve as input for the new diagram. @param aArguments @@ -51,12 +51,12 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface service. <p>For standard parameters that may be used, see the - service <type>StandardDiagramCreationParameters</type>. + service StandardDiagramCreationParameters. </p> @return The new diagram which represents this - <type>ChartTypeTemplate</type>. + ChartTypeTemplate. */ XDiagram createDiagramByDataSource( [in] com::sun::star::chart2::data::XDataSource xDataSource, @@ -68,16 +68,16 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface boolean supportsCategories(); /** Analyses the given diagram and reinterprets its - <type>DataSeries</type> and <type>Categories</type> and + DataSeries and Categories and creates a new diagram based on these series. <p>Note, that if <member>matchesTemplate</member> returns - <TRUE/> for the given <type>XDiagram</type>, the latter should + <TRUE/> for the given XDiagram, the latter should not be changed.</p> @param xDiagram The diagram given will be modified such that it represents - this <type>ChartTypeTemplate</type>. + this ChartTypeTemplate. */ void changeDiagram( [in] XDiagram xDiagram ); @@ -96,7 +96,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface @param xDataSource This data source will be interpreted in a chart-type - specific way and the <type>DataSeries</type> found in + specific way and the DataSeries found in <code>xDiagram</code> will be adapted to the new data. Missing data series will be created and unused ones will be deleted in <code>xDiagram</code>. @@ -107,7 +107,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface service. <p>For standard parameters that may be used, see the - service <type>StandardDiagramCreationParameters</type>. + service StandardDiagramCreationParameters. </p> */ void changeDiagramData( @@ -118,7 +118,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface /** States whether the given diagram could have been created by the template. - <p>The template will parse the <type>DataSeriesTree</type> of + <p>The template will parse the DataSeriesTree of the diagram to determine if the structure matches the one which would have been created by <member>createDiagramByDataSource</member>.</p> diff --git a/offapi/com/sun/star/chart2/XDataInterpreter.idl b/offapi/com/sun/star/chart2/XDataInterpreter.idl index 6f406b041d2f..1c8efd676c30 100644 --- a/offapi/com/sun/star/chart2/XDataInterpreter.idl +++ b/offapi/com/sun/star/chart2/XDataInterpreter.idl @@ -47,7 +47,7 @@ interface XDataInterpreter : ::com::sun::star::uno::XInterface service. <p>For standard parameters that may be used, see the - service <type>StandardDiagramCreationParameters</type>. + service StandardDiagramCreationParameters. </p> @param aSeriesToReUse diff --git a/offapi/com/sun/star/chart2/XDiagram.idl b/offapi/com/sun/star/chart2/XDiagram.idl index f14fdf8afb68..a878759be40d 100644 --- a/offapi/com/sun/star/chart2/XDiagram.idl +++ b/offapi/com/sun/star/chart2/XDiagram.idl @@ -63,12 +63,12 @@ interface XDiagram : ::com::sun::star::uno::XInterface */ void setLegend( [in] XLegend xLegend ); - /** returns an <type>XColorScheme</type> that defines the default + /** returns an XColorScheme that defines the default colors for data series (or data points) in the diagram. */ XColorScheme getDefaultColorScheme(); - /** sets an <type>XColorScheme</type> that defines the default + /** sets an XColorScheme that defines the default colors for data series (or data points) in the diagram. */ void setDefaultColorScheme( [in] XColorScheme xColorScheme ); @@ -77,7 +77,7 @@ interface XDiagram : ::com::sun::star::uno::XInterface @param xDataSource This data source will be interpreted in a chart-type - specific way and the <type>DataSeries</type> found in + specific way and the DataSeries found in <code>xDiagram</code> will be adapted to the new data. Missing data series will be created and unused ones will be deleted. @@ -86,7 +86,7 @@ interface XDiagram : ::com::sun::star::uno::XInterface Arguments tells how to slice the given data. <p>For standard parameters that may be used, see the - service <type>StandardDiagramCreationParameters</type>. + service StandardDiagramCreationParameters. </p> */ void setDiagramData( [in] com::sun::star::chart2::data::XDataSource xDataSource, diff --git a/offapi/com/sun/star/chart2/XTitled.idl b/offapi/com/sun/star/chart2/XTitled.idl index 3a5ec1883c26..80f03254c91c 100644 --- a/offapi/com/sun/star/chart2/XTitled.idl +++ b/offapi/com/sun/star/chart2/XTitled.idl @@ -32,7 +32,7 @@ module chart2 { /** Interface to be implemented by objects that support having a title of type - <type>XTitle</type>. + XTitle. */ interface XTitled : ::com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/chart2/data/DataSequence.idl b/offapi/com/sun/star/chart2/data/DataSequence.idl index ae27b05c39de..8a3e97741aaf 100644 --- a/offapi/com/sun/star/chart2/data/DataSequence.idl +++ b/offapi/com/sun/star/chart2/data/DataSequence.idl @@ -41,13 +41,13 @@ module data /** describes a container for a sequence of values. - <p>With the interface <type>XDataSequence</type> it is possible to + <p>With the interface XDataSequence it is possible to transfer a complete sequence of values. <p>With the optional <type scope="com::sun::star::container">XIndexReplace</type> it is possible to modify single elements, if the corresponding - <type>DataProvider</type> supports modification of its values.</p> + DataProvider supports modification of its values.</p> */ service DataSequence { @@ -72,7 +72,7 @@ service DataSequence <p>Only when supporting this interface, it is possible for client applications to modify the content of the data that is - provided by this <type>DataSequence</type>.</p> + provided by this DataSequence.</p> */ [optional] interface ::com::sun::star::container::XIndexReplace; @@ -86,7 +86,7 @@ service DataSequence one.</p> <p>Note that, when this interface is not implemented the - releasing of identifiers at the <type>XDataProvider</type> + releasing of identifiers at the XDataProvider will not work properly, because more than one object may use the same identifier. So, when an object releases the identifier, another object might use a stale identifier.</p> diff --git a/offapi/com/sun/star/chart2/data/DataSequenceRole.idl b/offapi/com/sun/star/chart2/data/DataSequenceRole.idl index c459bf479a05..90fd2abd9401 100644 --- a/offapi/com/sun/star/chart2/data/DataSequenceRole.idl +++ b/offapi/com/sun/star/chart2/data/DataSequenceRole.idl @@ -30,7 +30,7 @@ module chart2 module data { -/** a string that states in what way a <type>DataSequence</type> +/** a string that states in what way a DataSequence should be used. If this property is an empty string, no proposition about usage is made. diff --git a/offapi/com/sun/star/chart2/data/DataSink.idl b/offapi/com/sun/star/chart2/data/DataSink.idl index 35eea528c550..24b26aa21f16 100644 --- a/offapi/com/sun/star/chart2/data/DataSink.idl +++ b/offapi/com/sun/star/chart2/data/DataSink.idl @@ -33,7 +33,7 @@ module data { /** describes a service that allows reading two-dimensional data in - the form of a sequence of <type>DataSequence</type>s. + the form of a sequence of DataSequences. */ service DataSink { diff --git a/offapi/com/sun/star/chart2/data/DataSource.idl b/offapi/com/sun/star/chart2/data/DataSource.idl index 27bd9dbf703f..9ea7669c33cb 100644 --- a/offapi/com/sun/star/chart2/data/DataSource.idl +++ b/offapi/com/sun/star/chart2/data/DataSource.idl @@ -33,7 +33,7 @@ module data { /** describes a service that allows reading two-dimensional data in - the form of a sequence of <type>DataSequence</type>s. + the form of a sequence of DataSequences. */ service DataSource { diff --git a/offapi/com/sun/star/chart2/data/RangeHighlightListener.idl b/offapi/com/sun/star/chart2/data/RangeHighlightListener.idl index 3d5837d5a98b..2ad0c27a493c 100644 --- a/offapi/com/sun/star/chart2/data/RangeHighlightListener.idl +++ b/offapi/com/sun/star/chart2/data/RangeHighlightListener.idl @@ -33,7 +33,7 @@ module data { /** A selection change listener that is attached to a - <type>XRangeHighlighter</type> in order to get notified about + XRangeHighlighter in order to get notified about selection changes that affect range highlighting. */ service RangeHighlightListener diff --git a/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl b/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl index 62f5de9e4184..d2382256ae50 100644 --- a/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl +++ b/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl @@ -39,7 +39,7 @@ service TabularDataProviderArguments /** the range address string spanning all data. <p>The range address string must be interpretable by the - component that implements <type>XDataProvider</type> and gets + component that implements XDataProvider and gets this property as argument to <member>XDataProvider::detectArguments</member>.</p> @@ -54,7 +54,7 @@ service TabularDataProviderArguments <p>When used as output of <member>XDataProvider::detectArguments</member> this is the range that spans the ranges of all given - <type>XDataSequence</type>s. If the result is ambiguous, + XDataSequences. If the result is ambiguous, i.e., a splitting of this range would not yield the same result, this property should be empty. The latter is the case, when ranges are overlapping, the lengths of sequences @@ -77,7 +77,7 @@ service TabularDataProviderArguments column will provide the labels for all sequences. <p>Even if this property is false, the - <type>XLabeledDataSequence</type> may contain a label, but + XLabeledDataSequence may contain a label, but this will not be the first cell of the selection. It may be a generic string like "Column C".</p> @@ -117,7 +117,7 @@ service TabularDataProviderArguments returned if it doesn't.</p> <p>The generic category labeled sequence returned should be - the first one in the returned <type>XDataSource</type>. It + the first one in the returned XDataSource. It needs no label. The values should have their role set to "categories". The generic strings returned should also be localized.</p> diff --git a/offapi/com/sun/star/chart2/data/XDataProvider.idl b/offapi/com/sun/star/chart2/data/XDataProvider.idl index fe81c03dbe78..d06aebadae08 100644 --- a/offapi/com/sun/star/chart2/data/XDataProvider.idl +++ b/offapi/com/sun/star/chart2/data/XDataProvider.idl @@ -60,15 +60,15 @@ interface XDataProvider : ::com::sun::star::uno::XInterface separate service. <p>For spreadsheets and text document tables there exists a - service <type>TabularDataProviderArguments</type> + service TabularDataProviderArguments describing valid values for this list.</p> @return - a data source containing <type>DataSequence</type>s that + a data source containing DataSequences that span the entire region given in <code>aArguments</code>. @throws ::com::sun::star::lang::IllegalArgumentException - may be raised by the <type>XDataProvider</type> if it is + may be raised by the XDataProvider if it is unable to interpret the arguments passed in <code>aArguments</code> appropriately. */ @@ -77,7 +77,7 @@ interface XDataProvider : ::com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); /** Tries to find out with what parameters the passed - <type>DataSource</type> most probably was created. + DataSource most probably was created. <p>if xDataSource is a data source that was created with <member>createDataSource</member>, the arguments returned here @@ -137,7 +137,7 @@ interface XDataProvider : ::com::sun::star::uno::XInterface @return The component for selecting a new range. It must support - <type>XComponent</type>, in order to inform the receiver + XComponent, in order to inform the receiver about its lifetime.</p> */ com::sun::star::sheet::XRangeSelection getRangeSelection(); diff --git a/offapi/com/sun/star/chart2/data/XDataReceiver.idl b/offapi/com/sun/star/chart2/data/XDataReceiver.idl index 5e29044c51a3..ae7cf13c15c5 100644 --- a/offapi/com/sun/star/chart2/data/XDataReceiver.idl +++ b/offapi/com/sun/star/chart2/data/XDataReceiver.idl @@ -68,8 +68,8 @@ interface XDataReceiver : ::com::sun::star::uno::XInterface */ XDataSource getUsedData(); - /** attaches an <type>XNumberFormatsSupplier</type> to this - <type>XDataReceiver</type>. + /** attaches an XNumberFormatsSupplier to this + XDataReceiver. <p>The given number formats will be used for display purposes.</p> */ diff --git a/offapi/com/sun/star/chart2/data/XDataSequence.idl b/offapi/com/sun/star/chart2/data/XDataSequence.idl index 858222f281a5..a2cddc401619 100644 --- a/offapi/com/sun/star/chart2/data/XDataSequence.idl +++ b/offapi/com/sun/star/chart2/data/XDataSequence.idl @@ -52,14 +52,14 @@ interface XDataSequence : ::com::sun::star::uno::XInterface sequence< any > getData(); /** returns the (UI) range representation string used by this - <type>XDataSequence</type>. + XDataSequence. */ string getSourceRangeRepresentation(); /** creates a label that describes the origin of this data sequence. - <p>This is useful, if a <type>XLabeledDataSequence</type> has + <p>This is useful, if a XLabeledDataSequence has no label sequence. In this case you can call this method at the value sequence to obtain a fitting replacement label.</p> @@ -113,7 +113,7 @@ interface XDataSequence : ::com::sun::star::uno::XInterface <p>The number format key must be valid for the <type scope="com::sun::star::util">XNumberFormatsSupplier</type> - given by the <type>XDataProvider</type>, or 0 which is assumed + given by the XDataProvider, or 0 which is assumed to be always valid.</p> */ long getNumberFormatKeyByIndex( [in] long nIndex ) diff --git a/offapi/com/sun/star/chart2/data/XDataSink.idl b/offapi/com/sun/star/chart2/data/XDataSink.idl index 05094340f12a..6595109f2d67 100644 --- a/offapi/com/sun/star/chart2/data/XDataSink.idl +++ b/offapi/com/sun/star/chart2/data/XDataSink.idl @@ -37,20 +37,20 @@ module data can only be written to. <p>If you want to be able to also read the data set here, your - component must also implement <type>XDataSource</type>.</p> + component must also implement XDataSource.</p> */ interface XDataSink : ::com::sun::star::uno::XInterface { /** sets new data sequences. The elements set here must support - the service <type>DataSequence</type>. + the service DataSequence. <p>If the data consist only of floating point numbers (double values), the instances set here should also support the - service <type>NumericalDataSequence</type>.</p> + service NumericalDataSequence.</p> <p>If the data consist only of strings, the instances set here should also support the service - <type>TextualDataSequence</type>.</p> + TextualDataSequence.</p> <p>If one of the derived services is supported by one element of the sequence, it should be available for all elements in diff --git a/offapi/com/sun/star/chart2/data/XDataSource.idl b/offapi/com/sun/star/chart2/data/XDataSource.idl index cecffea3ccbd..4312460ee77c 100644 --- a/offapi/com/sun/star/chart2/data/XDataSource.idl +++ b/offapi/com/sun/star/chart2/data/XDataSource.idl @@ -39,11 +39,11 @@ module data <p>If the data stored consists only of floating point numbers (double values), the returned instances should also support the service - <type>NumericalDataSequence</type>.</p> + NumericalDataSequence.</p> <p>If the data stored consists only of strings, the returned instances should also support the service - <type>TextualDataSequence</type>.</p> + TextualDataSequence.</p> */ interface XDataSource : ::com::sun::star::uno::XInterface // : ::com::sun::star::container::XIndexAccess @@ -51,15 +51,15 @@ interface XDataSource : ::com::sun::star::uno::XInterface /** returns data sequences. @return a sequence of objects that support at least the - service <type>DataSequence</type>. + service DataSequence. <p>If the data stored consist only of floating point numbers (double values), the returned instances should also support - the service <type>NumericalDataSequence</type>.</p> + the service NumericalDataSequence.</p> <p>If the data stored consist only of strings, the returned instances should also support the service - <type>TextualDataSequence</type>.</p> + TextualDataSequence.</p> */ sequence< XLabeledDataSequence > getDataSequences(); }; diff --git a/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl b/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl index 0710ff50e074..a2926f3abfad 100644 --- a/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl +++ b/offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module chart2 { module data { -/** identifies a <type>XDataProvider</type> for result sets. +/** identifies a XDataProvider for result sets. @see XDataProvider @see DataProvider @@ -135,7 +135,7 @@ interface XDatabaseDataProvider <p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p> <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member> - are specified, a <type>RowSet</type> can be created with this information. If the results provided by the + are specified, a RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used.</p> <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified diff --git a/offapi/com/sun/star/chart2/data/XLabeledDataSequence.idl b/offapi/com/sun/star/chart2/data/XLabeledDataSequence.idl index d52c2a6bade9..f856c9dd514d 100644 --- a/offapi/com/sun/star/chart2/data/XLabeledDataSequence.idl +++ b/offapi/com/sun/star/chart2/data/XLabeledDataSequence.idl @@ -40,22 +40,22 @@ module data */ interface XLabeledDataSequence : ::com::sun::star::uno::XInterface { - /** returns an <type>XDataSequence</type> containing the actual + /** returns an XDataSequence containing the actual data. */ XDataSequence getValues(); - /** sets a new <type>XDataSequence</type> containing the actual + /** sets a new XDataSequence containing the actual data. */ void setValues( [in] XDataSequence xSequence ); - /** returns an <type>XDataSequence</type> containing the label for + /** returns an XDataSequence containing the label for the labeled sequence. */ XDataSequence getLabel(); - /** sets a new <type>XDataSequence</type> containing the label for + /** sets a new XDataSequence containing the label for the labeled sequence. */ void setLabel( [in] XDataSequence xSequence ); diff --git a/offapi/com/sun/star/chart2/data/XLabeledDataSequence2.idl b/offapi/com/sun/star/chart2/data/XLabeledDataSequence2.idl index 40e6ab4d8264..b15c654c0f79 100644 --- a/offapi/com/sun/star/chart2/data/XLabeledDataSequence2.idl +++ b/offapi/com/sun/star/chart2/data/XLabeledDataSequence2.idl @@ -56,7 +56,7 @@ interface XLabeledDataSequence2 is not supported, the same object will be shared if used by multiple objects. - <p>If a <type>LabeledDataSequence</type> is cloned, it has to + <p>If a LabeledDataSequence is cloned, it has to query its contents for the <type scope="com::sun::star::util">XCloneable</type> interface and use it if available.</p> diff --git a/offapi/com/sun/star/chart2/data/XRangeXMLConversion.idl b/offapi/com/sun/star/chart2/data/XRangeXMLConversion.idl index 8ec6f1e6403d..1bdffa1b931d 100644 --- a/offapi/com/sun/star/chart2/data/XRangeXMLConversion.idl +++ b/offapi/com/sun/star/chart2/data/XRangeXMLConversion.idl @@ -48,7 +48,7 @@ interface XRangeXMLConversion : ::com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); /** converts an XML-style range into the internal - <type>DataProvider</type>'s format. + DataProvider's format. */ string convertRangeFromXML( [in] string aXMLRange ) raises( com::sun::star::lang::IllegalArgumentException ); 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 diff --git a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl index 3dfa5e869fc5..33230edef2ea 100644 --- a/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/DataFormatTranslator.idl @@ -29,12 +29,12 @@ module com { module sun { module star { module datatransfer { /** Different platforms use different types to describe data formats available during data exchange operations like clipboard or drag&drop. Implementations of this service do convert system dependent data types to a - <type>DataFlavor</type> and vice versa. + DataFlavor and vice versa. @see com::sun::star::datatransfer::XDataFormatTranslator @see com::sun::star::datatransfer::DataFlavor - Converts a <type>DataFlavor</type> to system data types and vice versa. + Converts a DataFlavor to system data types and vice versa. */ published service DataFormatTranslator : XDataFormatTranslator; diff --git a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl index e3cc4c1daf6f..8bc8a6cac8e0 100644 --- a/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/MimeContentTypeFactory.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module datatransfer { published interface XMimeContentTypeFactory; /** Used to create an instance that implement the interface - <type>XMimeContentType</type> from a string + XMimeContentType from a string representation of such a MIME content-type that conforms to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. diff --git a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl index a1003a7313c0..4e36b4789d4f 100644 --- a/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl +++ b/offapi/com/sun/star/datatransfer/UnsupportedFlavorException.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module datatransfer { /** Exception will be thrown if there is a request for data in a - <type>DataFlavor</type> that is not supported by a data source. + DataFlavor that is not supported by a data source. @see com::sun::star::datatransfer::DataFlavor @see com::sun::star::datatransfer::XTransferable diff --git a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl index 0cd62443a12b..6e0cbc1d6dde 100644 --- a/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl +++ b/offapi/com/sun/star/datatransfer/XDataFormatTranslator.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module datatransfer { -/** Interface to be implemented by objects used to translate a <type>DataFlavor</type> to +/** Interface to be implemented by objects used to translate a DataFlavor to a system dependent data transfer type and vice versa. <p>Different platforms use different types to describe data formats available @@ -37,27 +37,27 @@ module com { module sun { module star { module datatransfer { published interface XDataFormatTranslator : com::sun::star::uno::XInterface { - /** Converts a <type>DataFlavor</type> to system dependent data type. + /** Converts a DataFlavor to system dependent data type. @param aDataFlavor Describes the format for which a system dependent data types is requested. @returns - A system dependent data transfer type for the given <type>DataFlavor</type> + A system dependent data transfer type for the given DataFlavor if there is one available. - <p>If the is no system dependent data type for a given <type>DataFlavor</type> + <p>If the is no system dependent data type for a given DataFlavor the returned any is empty.</p> */ any getSystemDataTypeFromDataFlavor( [in] DataFlavor aDataFlavor ); - /** Converts a system dependent data type to a <type>DataFlavor</type>. + /** Converts a system dependent data type to a DataFlavor. @param aSysDataType - A system dependent data type. If aSysDataType is empty so is the returned <type>DataFlavor</type>. + A system dependent data type. If aSysDataType is empty so is the returned DataFlavor. @returns - A <type>DataFlavor</type> for the given system dependent data transfer type. - <p>If there is no appropriate mapping for a system dependent data type, the returned <type>DataFlavor</type> will be empty.</p> + A DataFlavor for the given system dependent data transfer type. + <p>If there is no appropriate mapping for a system dependent data type, the returned DataFlavor will be empty.</p> */ DataFlavor getDataFlavorFromSystemDataType( [in] any aSysDataType ); }; diff --git a/offapi/com/sun/star/datatransfer/XMimeContentType.idl b/offapi/com/sun/star/datatransfer/XMimeContentType.idl index ea8373c0994b..4c3fc9f43486 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentType.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentType.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module datatransfer { conforms to <a href="ftp://ftp.isi.edu/in-notes/rfc2045.txt">Rfc2045</a> and <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. Instances that implement this interface could be created using the - interface <type>XMimeContentTypeFactory</type>. + interface XMimeContentTypeFactory. */ published interface XMimeContentType : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl index 4a894d4d94a6..b3184d26c0bc 100644 --- a/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl +++ b/offapi/com/sun/star/datatransfer/XMimeContentTypeFactory.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module datatransfer { */ published interface XMimeContentTypeFactory : com::sun::star::uno::XInterface { - /** Creates an object that implements <type>XMimeContentType</type>. + /** Creates an object that implements XMimeContentType. @param aContentType A string that represents a MIME content-type as specified in @@ -44,7 +44,7 @@ published interface XMimeContentTypeFactory : com::sun::star::uno::XInterface <a href="ftp://ftp.isi.edu/in-notes/rfc2046.txt">Rfc2046</a>. @returns - An object that implements <type>XMimeContentType</type>. + An object that implements XMimeContentType. @throws com::sun::star::lang::IllegalArgumentException if the string does not conform to diff --git a/offapi/com/sun/star/datatransfer/XSystemTransferable.idl b/offapi/com/sun/star/datatransfer/XSystemTransferable.idl index cb75592f6f97..1c976e7f8be0 100644 --- a/offapi/com/sun/star/datatransfer/XSystemTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XSystemTransferable.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module datatransfer { /** Interface to be implemented by objects used to provide system dependent data - for a transfer operation. Those objects usually also implement <type>XTransferable</type>. + for a transfer operation. Those objects usually also implement XTransferable. */ published interface XSystemTransferable: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl index b3ce22a5370f..b2a84bb651a7 100644 --- a/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl +++ b/offapi/com/sun/star/datatransfer/XTransferDataAccess.idl @@ -35,26 +35,26 @@ module com { module sun { module star { module datatransfer { published interface XTransferDataAccess: com::sun::star::uno::XInterface { - /** To query for the summarized data size in bytes of a sequence of <type>DataFlavor</type>. + /** To query for the summarized data size in bytes of a sequence of DataFlavor. @param aFlavorList - A sequence of requested <type>DataFlavor</type>. - <p>An unsupported <type>DataFlavor</type> will be ignored.</p> + A sequence of requested DataFlavor. + <p>An unsupported DataFlavor will be ignored.</p> @returns - The number of bytes of the transfer data in the specified sequence of <type>DataFlavor</type>. + The number of bytes of the transfer data in the specified sequence of DataFlavor. */ hyper queryDataSize( [in] sequence < DataFlavor > aFlavorList ); - /** To get all the data of a sequence of <type>DataFlavor</type>. + /** To get all the data of a sequence of DataFlavor. @param aFlavorList - The sequence of requested <type>DataFlavor</type>. - <p>An unsupported <type>DataFlavor</type> will be ignored.</p> + The sequence of requested DataFlavor. + <p>An unsupported DataFlavor will be ignored.</p> @returns - The data in the requested <type>DataFlavor</type>. - <p>For unsupported <type>DataFlavor</type> an + The data in the requested DataFlavor. + <p>For unsupported DataFlavor an empty any will be returned.</p> */ sequence < any > getData( [in] sequence < DataFlavor > aFlavorList ); diff --git a/offapi/com/sun/star/datatransfer/XTransferable.idl b/offapi/com/sun/star/datatransfer/XTransferable.idl index 13c69e2c10ad..f21cb90cfe7a 100644 --- a/offapi/com/sun/star/datatransfer/XTransferable.idl +++ b/offapi/com/sun/star/datatransfer/XTransferable.idl @@ -43,21 +43,21 @@ published interface XTransferable: com::sun::star::uno::XInterface Describes the requested data format @returns - The data in the specified <type>DataFlavor</type>. + The data in the specified DataFlavor. @throws com::sun::star::io::IOException if the data is no longer available in the requested flavor. @throws com::sun::star::datatransfer::UnsupportedFlavorException - if the requested <type>DataFlavor</type> is not supported. + if the requested DataFlavor is not supported. */ any getTransferData( [in] DataFlavor aFlavor ) raises ( UnsupportedFlavorException, com::sun::star::io::IOException ); - /** Returns a sequence of supported <type>DataFlavor</type>. + /** Returns a sequence of supported DataFlavor. @returns - The sequence of supported <type>DataFlavor</type>. + The sequence of supported DataFlavor. @see com::sun::star::datatransfer::DataFlavor */ @@ -69,8 +69,8 @@ published interface XTransferable: com::sun::star::uno::XInterface Describes the format that should be checked @returns - A value of <TRUE/> if the <type>DataFlavor</type> is supported by the transfer source. - <p>A value of <FALSE/> if the <type>DataFlavor</type> is unsupported by the transfer source.</p> + A value of <TRUE/> if the DataFlavor is supported by the transfer source. + <p>A value of <FALSE/> if the DataFlavor is unsupported by the transfer source.</p> <br/><br/><p><strong>Note: </strong>This method is only for analogy with the JAVA Clipboard interface. To avoid many calls, the caller should instead use diff --git a/offapi/com/sun/star/datatransfer/XTransferableEx.idl b/offapi/com/sun/star/datatransfer/XTransferableEx.idl index b0dcaff38865..ed57da8a27a9 100644 --- a/offapi/com/sun/star/datatransfer/XTransferableEx.idl +++ b/offapi/com/sun/star/datatransfer/XTransferableEx.idl @@ -37,12 +37,12 @@ module com { module sun { module star { module datatransfer { published interface XTransferableEx: com::sun::star::uno::XInterface { /** @param requestedFlavors - Sequence of <type>DataFlavor</type> of interest. Specify an empty sequence for interest + Sequence of DataFlavor of interest. Specify an empty sequence for interest in all data flavors with top-level MIME content-types. To get all MIME content-types, call <member scope="com::sun::star::datatransfer">XTransferable::getTransferDataFlavors()</member>. @returns - The list of the matching supported <type>DataFlavor</type> that were requested. For + The list of the matching supported DataFlavor that were requested. For each requested top-level MIME content-type, all supported subtypes are returned. */ sequence < DataFlavor > queryTransferDataFlavors( [in] sequence< DataFlavor > requestedFlavors ); diff --git a/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl b/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl index 8992e390a0f4..7fb9fa24c751 100644 --- a/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl +++ b/offapi/com/sun/star/datatransfer/clipboard/XClipboardFactory.idl @@ -39,7 +39,7 @@ published interface XClipboardFactory: com::sun::star::uno::XInterface /** Creates a new named clipboard instance. @returns - A newly created instance of a <type>GenericClipboard</type> + A newly created instance of a GenericClipboard implementation. @param aName diff --git a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl index 483e42ac2693..a6279963ee76 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSource; /** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member> - when a particular <type>XDragGestureRecognizer</type> detects that a platform + when a particular XDragGestureRecognizer detects that a platform dependent drag initiating gesture has occurred on the component that it is tracking. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl index 1f9caad368dc..ea1bb42ebeae 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module datatransfer { module dnd { -/** The <type>DragSourceDragEvent</type> is delivered from an object that - implements the <type>XDragSourceContext</type> to the +/** The DragSourceDragEvent is delivered from an object that + implements the XDragSourceContext to the currently registered drag source listener. <p>It contains state regarding the current state of the operation to enable diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl index b0fbb20ea473..3ed36c4edce5 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceDropEvent.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module datatransfer { module dnd { -/** The <type>DragSourceDropEvent</type> is delivered from an object that implements - <type>XDragSourceContext</type> to its currently registered drag source listener's. +/** The DragSourceDropEvent is delivered from an object that implements + XDragSourceContext to its currently registered drag source listener's. <p>It contains sufficient information for the originator of the operation to provide appropriate feedback to the end user when the operation completes.</p> diff --git a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl index 5e8c6686dd8d..c088620ae0fa 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DragSourceEvent.idl @@ -28,9 +28,9 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSource; published interface XDragSourceContext; -/** This class is the base class for <type>DragSourceDragEvent</type> and <type>DragSourceDropEvent</type>. +/** This class is the base class for DragSourceDragEvent and DragSourceDropEvent. - <p>To access the <type>XDragSource</type> that originated this event, use the + <p>To access the XDragSource that originated this event, use the <member scope="com::sun::star::lang">EventObject::Source</member> member of this object.</p> */ diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl index 1773dfa3f2d1..1de0087fca09 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module datatransfer { module dnd { -/** The <type>DropTargetDragEnterEvent</type> is delivered from the drop target to the +/** The DropTargetDragEnterEvent is delivered from the drop target to the currently registered drop target listeners whenever the logical cursor associated with a Drag and Drop operation enters the visible geometry of a window associated with a drop target. diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl index 05d620ee615d..547144175b65 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDropTargetDragContext; -/** The <type>DropTargetDragEvent</type> is delivered from the drop target +/** The DropTargetDragEvent is delivered from the drop target to the currently registered drop target listener. <p>It contains information regarding the current state of the operation to enable diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl index b6a8294c8494..d51a92693451 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDropTargetDropContext; -/** The <type>DropTargetDropEvent</type> is delivered from the drop target to +/** The DropTargetDropEvent is delivered from the drop target to its currently registered drop target listener. <p>It contains sufficient information for the originator of the operation to @@ -47,7 +47,7 @@ published struct DropTargetDropEvent: com::sun::star::datatransfer::dnd::DropTar /** This value represents the action or actions selected by the user at the time of the drop. - <p>If more than one action is specified, the <type>XDropTargetListener</type> + <p>If more than one action is specified, the XDropTargetListener should raise a dialog to ask the user which action to use.</p> @see com::sun::star::datatransfer::dnd::DNDConstants diff --git a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl index 77e855e32abc..14cf7c2b1f40 100644 --- a/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl +++ b/offapi/com/sun/star/datatransfer/dnd/DropTargetEvent.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module datatransfer { module dnd { -/** This class is the base class for <type>DropTargetDragEvent</type> and - <type>DropTargetDropEvent</type>. +/** This class is the base class for DropTargetDragEvent and + DropTargetDropEvent. - <p>To access the <type>XDropTarget</type> that originated this event, use the + <p>To access the XDropTarget that originated this event, use the <member scope="com::sun::star::lang">EventObject::Source</member> member of this object.</p> */ diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl index a1bd9e53581c..23b2adb56cf7 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureListener.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module datatransfer { module dnd { -/** This interface will be used by a <type>XDragGestureRecognizer</type> +/** This interface will be used by a XDragGestureRecognizer when it detects a drag initiating gesture. <p>The implementor of this interface is responsible for starting the drag @@ -36,7 +36,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragGestureListener: com::sun::star::lang::XEventListener { - /** A <type>XDragGestureRecognizer</type> has detected a platform-dependent + /** A XDragGestureRecognizer has detected a platform-dependent drag initiating gesture and is notifying this listener in order for it to initiate the action for the user. diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl index 9e7560d7542f..abc99c61f276 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragGestureRecognizer.idl @@ -38,20 +38,20 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragGestureRecognizer: com::sun::star::uno::XInterface { - /** Registers a new <type>XDragGestureListener</type>. + /** Registers a new XDragGestureListener. @param dgl - The <type>XDragGestureListener</type> to register with this - <type>XDragGestureRecognizer</type>. + The XDragGestureListener to register with this + XDragGestureRecognizer. */ void addDragGestureListener( [in] XDragGestureListener dgl ); - /** Unregisters the specified <type>XDragGestureListener</type>. + /** Unregisters the specified XDragGestureListener. @param dgl - The <type>XDragGestureListener</type> to register with this - <type>XDragGestureRecognizer</type>. + The XDragGestureListener to register with this + XDragGestureRecognizer. */ void removeDragGestureListener( [in] XDragGestureListener dgl ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl index 84534b6ca845..dc5ab0cdbfe1 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSource.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module datatransfer { module dnd { published interface XDragSourceListener; /** This interface is implemented by a view or window that supports drag - operations and will be received as part of a <type>DragGestureEvent</type> + operations and will be received as part of a DragGestureEvent through a <member scope="com::sun::star::datatransfer::dnd">XDragGestureListener::dragGestureRecognized()</member> callback. @@ -56,7 +56,7 @@ published interface XDragSource: com::sun::star::uno::XInterface /** To get the default cursor for a specified drag action. @param dragAction - A drag action as specified in <type>DNDConstants</type>. + A drag action as specified in DNDConstants. @returns The default drag cursor for the specified drag action. @@ -78,11 +78,11 @@ published interface XDragSource: com::sun::star::uno::XInterface on the parameter listener with a DragSourceDragEvent showing a failure.</p> @param trigger - The <type>DragGestureEvent</type> that initiated the drag. + The DragGestureEvent that initiated the drag. @param sourceActions The action or actions supported for this transferable as defined - in <type>DNDConstants</type>. + in DNDConstants. @param cursor The initial drag cursor id or 0 as default. @@ -94,7 +94,7 @@ published interface XDragSource: com::sun::star::uno::XInterface The transferable object dragged. @param listener - The <type>XDragSourceListener</type>. + The XDragSourceListener. @see com::sun::star::datatransfer::XTransferable */ diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl index e60c19ec0ac4..3424902323d8 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl @@ -40,7 +40,7 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener complete. @param dsde - The <type>DragSourceDropEvent</type> + The DragSourceDropEvent */ void dragDropEnd( [in] DragSourceDropEvent dsde ); @@ -51,7 +51,7 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener implementations. Do not rely on it ! </p> @param dsde - The <type>DragSourceDragEvent</type>. + The DragSourceDragEvent. */ void dragEnter( [in] DragSourceDragEvent dsde ); @@ -62,7 +62,7 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener implementations. Do not rely on it ! </p> @param dse - The <type>DragSourceEvent</type>. + The DragSourceEvent. */ void dragExit( [in] DragSourceEvent dse ); @@ -70,7 +70,7 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener /** Called as the hotspot moves over a platform dependent drop site. @param dsde - The <type>DragSourceEvent</type> + The DragSourceEvent */ void dragOver( [in] DragSourceDragEvent dsde ); @@ -78,7 +78,7 @@ published interface XDragSourceListener: com::sun::star::lang::XEventListener /** Called when the user has modified the drop gesture. @param dsde - The <type>DragSourceEvent</type>. + The DragSourceEvent. */ void dropActionChanged( [in] DragSourceDragEvent dsde ); diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl index 4d0fad33cd66..b0c2ca11e21e 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTarget.idl @@ -41,7 +41,7 @@ published interface XDropTarget: com::sun::star::uno::XInterface { /** Add a DropTargetListener. - <p>The listener will be queried for the <type>XAutoscroll</type> interface + <p>The listener will be queried for the XAutoscroll interface to see if it supports autoscrolling.</p> @param dtl diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl index 06f0204ace5a..3c298b8ce31c 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.idl @@ -41,7 +41,7 @@ published interface XDropTargetDragContext: com::sun::star::uno::XInterface { /** Accept the Drag. - <p>This method should be called from the methods of <type>XDropTargetListener</type> + <p>This method should be called from the methods of XDropTargetListener <ul> <li><member>XDropTargetListener::dragEnter()</member></li> <li><member>XDropTargetListener::dragOver()</member></li> diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl index bd9dba037001..79857d48c0a8 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl @@ -43,12 +43,12 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener has to wait until the method <method>XDropTargetDropContext::dropComplete</method> is called before releasing the data for the drop operation. This should occur before returning from drop in a normal flow of operation. - Also, the implementor of <type>XDropTargetListener</type> should not assume - the <type>DropTargetDropEvent</type> to be meaningful after returning + Also, the implementor of XDropTargetListener should not assume + the DropTargetDropEvent to be meaningful after returning from the <member>XDropTargetListener::drop()</member> method.</p> @param dtde - The <type>DropTargetDropEvent</type>. + The DropTargetDropEvent. */ void drop( [in] DropTargetDropEvent dtde ); @@ -56,7 +56,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener /** Called when a drag operation has encountered the drop target. @param dtde - The <type>DropTargetDragEvent</type>. + The DropTargetDragEvent. */ void dragEnter( [in] DropTargetDragEnterEvent dtdee ); @@ -64,7 +64,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener /** The drag operation has departed the drop target without dropping. @param dte - The <type>DropTargetEvent</type>. + The DropTargetEvent. */ void dragExit( [in] DropTargetEvent dte ); @@ -72,7 +72,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener /** Called when a drag operation is ongoing on the drop target. @param dtde - The <type>DropTargetEvent</type>. + The DropTargetEvent. */ void dragOver( [in] DropTargetDragEvent dtde ); @@ -80,7 +80,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener /** Called when the user has modified the drop gesture. @param dtde - The <type>DropTargetEvent</type>. + The DropTargetEvent. */ void dropActionChanged( [in] DropTargetDragEvent dtde ); diff --git a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl index 329874eb2a52..f619aed600e3 100644 --- a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl +++ b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl @@ -29,18 +29,18 @@ interface XPackage; /** indicates that <member>XPackageRegistry::bindPackage</member> was previously called with a different value for the <code>removed</code> parameter and that - the <type>XPackage</type> object created by that call still exist. + the XPackage object created by that call still exist. @since OOo 3.3 */ exception InvalidRemovedParameterException: com::sun::star::uno::Exception { /** the value of the <code>removed</code> parameter which was used in <member>XPackageRegistry::bindPackage</member> to create the currently - existing <type>XPackage</type> object. + existing XPackage object. */ boolean PreviousValue; /** - the <type>XPackage</type> that was already bound to the provided + the XPackage that was already bound to the provided <code>url</code> parameter during <member>XPackageRegistry::bindPackage</member>. diff --git a/offapi/com/sun/star/deployment/PackageRegistryBackend.idl b/offapi/com/sun/star/deployment/PackageRegistryBackend.idl index e4c6f2333851..e80419b5c6b8 100644 --- a/offapi/com/sun/star/deployment/PackageRegistryBackend.idl +++ b/offapi/com/sun/star/deployment/PackageRegistryBackend.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module deployment { -/** The <type>PackageRegistryBackend</type> service is used to bind - a specific type of <type>XPackage</type> which can be registered or revoked. +/** The PackageRegistryBackend service is used to bind + a specific type of XPackage which can be registered or revoked. <p> - All <type>PackageRegistryBackend</type> objects - are related to a <type>XPackageManager</type> instance. + All PackageRegistryBackend objects + are related to a XPackageManager instance. </p> @since OOo 2.0 diff --git a/offapi/com/sun/star/deployment/UpdateInformationEntry.idl b/offapi/com/sun/star/deployment/UpdateInformationEntry.idl index f70f6e4b7998..c930d79e3a77 100644 --- a/offapi/com/sun/star/deployment/UpdateInformationEntry.idl +++ b/offapi/com/sun/star/deployment/UpdateInformationEntry.idl @@ -26,7 +26,7 @@ interface XElement; module com { module sun { module star { module deployment { /** Objects of this type are used as elements of the enumeration - returned by <type>XUpdateInformationProvider</type>. + returned by XUpdateInformationProvider. @since OOo 2.3 */ diff --git a/offapi/com/sun/star/deployment/XExtensionManager.idl b/offapi/com/sun/star/deployment/XExtensionManager.idl index a77f716acc98..ffb4e756eba1 100644 --- a/offapi/com/sun/star/deployment/XExtensionManager.idl +++ b/offapi/com/sun/star/deployment/XExtensionManager.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module deployment { -/** The <type>XExtensionManager</type> interface is used to manage extensions +/** The XExtensionManager interface is used to manage extensions in the user, shared and bundled repository. @see ExtensionManager @@ -51,10 +51,10 @@ interface XExtensionManager interface com::sun::star::util::XModifyBroadcaster; - /** gets the supported <type>XPackageTypeInfo</type>s. + /** gets the supported XPackageTypeInfos. @return - supported <type>XPackageTypeInfo</type>s. + supported XPackageTypeInfos. */ sequence<XPackageTypeInfo> getSupportedPackageTypes(); @@ -199,7 +199,7 @@ interface XExtensionManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> object + XPackage object */ XPackage getDeployedExtension( [in] string repository, diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index ef04b73cfabe..2dcf2a9b6751 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module deployment { /** Objects of this interface reflect a bound package and are issued by a - <type>PackageRegistryBackend</type>. + PackageRegistryBackend. @since OOo 2.0 */ @@ -129,7 +129,7 @@ interface XPackage com::sun::star::ucb::CommandFailedException, com::sun::star::ucb::CommandAbortedException); - /** registers this <type>XPackage</type>. + /** registers this XPackage. NEVER call this directly. This is done by the extension manager if necessary. @@ -153,7 +153,7 @@ interface XPackage com::sun::star::ucb::CommandAbortedException, com::sun::star::lang::IllegalArgumentException); - /** revokes this <type>XPackage</type>. + /** revokes this XPackage. NEVER call this directly. This is done by the extension manager if necessary. @@ -289,7 +289,7 @@ interface XPackage ::com::sun::star::beans::StringPair getPublisherInfo() raises (ExtensionRemovedException); - /** returns the <type>XPackageTypeInfo</type>, e.g. media-type etc. + /** returns the XPackageTypeInfo, e.g. media-type etc. @return media type of package diff --git a/offapi/com/sun/star/deployment/XPackageManager.idl b/offapi/com/sun/star/deployment/XPackageManager.idl index 40fd7f7724b7..65ff863df21d 100644 --- a/offapi/com/sun/star/deployment/XPackageManager.idl +++ b/offapi/com/sun/star/deployment/XPackageManager.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module deployment { -/** The <type>XPackageManager</type> interface is used to add or remove +/** The XPackageManager interface is used to add or remove packages to a specific repository. This interface represents a particular repository. Packages are deployable files, e.g. scripts or UNO components. @@ -48,11 +48,11 @@ module com { module sun { module star { module deployment { </p> <p> All interface methods do neither register nor revoke an extension. - This happens exclusively by <type>XExtensionManager</type>. + This happens exclusively by XExtensionManager. </p> <p> Objects of this interface are created using the - <type>XPackageManagerFactory</type> service resp. the singleton + XPackageManagerFactory service resp. the singleton <code> /singletons/com.sun.star.deployment.thePackageManagerFactory </code>. @@ -61,7 +61,7 @@ module com { module sun { module star { module deployment { @see thePackageManagerFactory @since OOo 2.0 @deprecated - Use <type>XExtensionManager</type>. + Use XExtensionManager. */ interface XPackageManager { @@ -82,10 +82,10 @@ interface XPackageManager */ string getContext(); - /** gets the supported <type>XPackageTypeInfo</type>s. + /** gets the supported XPackageTypeInfos. @return - supported <type>XPackageTypeInfo</type>s. + supported XPackageTypeInfos. */ sequence<XPackageTypeInfo> getSupportedPackageTypes(); @@ -115,7 +115,7 @@ interface XPackageManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage addPackage( [in] string url, [in] sequence<com::sun::star::beans::NamedValue> properties, @@ -141,7 +141,7 @@ interface XPackageManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage importExtension( [in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, @@ -181,7 +181,7 @@ interface XPackageManager @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage getDeployedPackage( [in] string identifier, @@ -291,7 +291,7 @@ interface XPackageManager The extension must be managed by this package manager, that is, it must be recorded in its database. The package manager calls XPackage::checkPrerequisites and updates its data base with the - result. The result, which is from <type>Prerequisites</type> will be + result. The result, which is from Prerequisites will be returned. */ long checkPrerequisites( diff --git a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl index b81aa7043ada..e54cd53fe41b 100644 --- a/offapi/com/sun/star/deployment/XPackageManagerFactory.idl +++ b/offapi/com/sun/star/deployment/XPackageManagerFactory.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module deployment { -/** The <type>XPackageManagerFactory</type> interface is used to obtain - <type>XPackageManager</type> instances. +/** The XPackageManagerFactory interface is used to obtain + XPackageManager instances. <p> You have to use the singleton <code> @@ -38,12 +38,12 @@ module com { module sun { module star { module deployment { @since OOo 2.0 @deprecated - Use <type>XExtensionManager</type>. + Use XExtensionManager. */ interface XPackageManagerFactory { /** Method to create (or reusing and already existing) - <type>XPackageManager</type> object to add or remove UNO packages + XPackageManager object to add or remove UNO packages persistently. <p> Packages for context strings <code>"user"</code> and @@ -52,7 +52,7 @@ interface XPackageManagerFactory </p> <!-- p> Document contexts (<code>"vnd.sun.star.tdoc:..."</code>) will get a - <type>XPackageManager</type> object that stores packages + XPackageManager object that stores packages in the given document and modify the manifest. </p --> <p> @@ -79,7 +79,7 @@ interface XPackageManagerFactory </li --> </ul> @return - <type>XPackageManager</type> object + XPackageManager object @throws ::com::sun::star::lang::IllegalArgumentException in case of an invalid context */ diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index b9f1f9a781dc..cd7a9e520d7f 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module deployment { */ interface XPackageRegistry { - /** binds a package URL to a <type>XPackage</type> handle. + /** binds a package URL to a XPackage handle. The returned UNO package handle ought to late-initialize itself, thus the process of binding must not be an expensive operation, because it is not abortable. @@ -48,7 +48,7 @@ interface XPackageRegistry may still contain all registration data of that extension, but the actual extension files do not exist anymore. The registration data must then be cleaned of all the remains of that extension. To to that one - creates an <type>XPackage</type> object on behalf of that extension and + creates an XPackage object on behalf of that extension and calls <member>XPackage::revokePakage</member>. The parameter <code>removed</code> indicates this case. The returned object may not rely on the file or folder to which refers <code>url</url>. Instead it @@ -56,7 +56,7 @@ interface XPackageRegistry of this object (<member>XPackage::revokePackage</member>). The implementation must ensure that there is only one instance of - <type>XPackage</type> for the same <code>url</code> at any + XPackage for the same <code>url</code> at any time. Therefore calling <member>bindPackage</member> again with the same <code>url</code> but different <code>mediaType<code> (the exception is, if previously an empty string was provided to cause the determination @@ -64,7 +64,7 @@ interface XPackageRegistry exception. An <type scope="com::sun::star::lang">IllegalArgumentException</type> will be thrown in case of a different <code>mediaType</code> parameter and a - <type>InvalidRemovedParameterException</type> is thrown if the + InvalidRemovedParameterException is thrown if the <code>removed</code> parameter is different. The <code>identifier</code> parameter must be provided when @@ -88,7 +88,7 @@ interface XPackageRegistry @param xCmdEnv command environment for error and progress handling @return - <type>XPackage</type> handle + XPackage handle */ XPackage bindPackage( [in] string url, @@ -101,10 +101,10 @@ interface XPackageRegistry com::sun::star::ucb::CommandFailedException, com::sun::star::lang::IllegalArgumentException); - /** gets the supported <type>XPackageTypeInfo</type>s. + /** gets the supported XPackageTypeInfos. @return - supported <type>XPackageTypeInfo</type>s. + supported XPackageTypeInfos. */ sequence<XPackageTypeInfo> getSupportedPackageTypes(); diff --git a/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl b/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl index 15ba3614b8fb..aecbe0594ab6 100644 --- a/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl +++ b/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl @@ -91,7 +91,7 @@ interface XUpdateInformationProvider attribute of the atom:category tag matches extensionId are returned. @returns - an enumeration of <type>UpdateInformationEntry</type>. + an enumeration of UpdateInformationEntry. */ com::sun::star::container::XEnumeration getUpdateInformationEnumeration( [in] sequence< string > repositories, diff --git a/offapi/com/sun/star/deployment/thePackageManagerFactory.idl b/offapi/com/sun/star/deployment/thePackageManagerFactory.idl index 4257a60cbeb0..7b9f106d646c 100644 --- a/offapi/com/sun/star/deployment/thePackageManagerFactory.idl +++ b/offapi/com/sun/star/deployment/thePackageManagerFactory.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module deployment { -/** <type>thePackageManagerFactory</type> denotes the one and only - <type>XPackageManagerFactory</type> object to be used. +/** thePackageManagerFactory denotes the one and only + XPackageManagerFactory object to be used. <p> The component context entry is <code> @@ -36,7 +36,7 @@ module com { module sun { module star { module deployment { @since OOo 2.0 @deprecated - Use <type>XExtensionManager</type>. + Use XExtensionManager. */ singleton thePackageManagerFactory : XPackageManagerFactory; diff --git a/offapi/com/sun/star/deployment/ui/LicenseDialog.idl b/offapi/com/sun/star/deployment/ui/LicenseDialog.idl index f1c8f2c842fa..223a3086c1ea 100644 --- a/offapi/com/sun/star/deployment/ui/LicenseDialog.idl +++ b/offapi/com/sun/star/deployment/ui/LicenseDialog.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module deployment { module ui { -/** The <type>LicenseDialog</type> is used to display a license text. +/** The LicenseDialog is used to display a license text. @since OOo 2.0.4 */ diff --git a/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl b/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl index cf8fa6c40f17..1e56b23fb882 100644 --- a/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl +++ b/offapi/com/sun/star/deployment/ui/PackageManagerDialog.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module deployment { module ui { -/** The <type>PackageManagerDialog</type> is used to visually manage installed +/** The PackageManagerDialog is used to visually manage installed packages of the user and shared installation as well as currently open documents. diff --git a/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl b/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl index 297fcb6428a0..fba9e4cad5be 100644 --- a/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl +++ b/offapi/com/sun/star/deployment/ui/UpdateRequiredDialog.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module deployment { module ui { -/** The <type>UpdateRequiredDialog</type> is used to show a list of extensions not compatible with this office version. +/** The UpdateRequiredDialog is used to show a list of extensions not compatible with this office version. @since OOo 3.2 */ diff --git a/offapi/com/sun/star/document/AmbigousFilterRequest.idl b/offapi/com/sun/star/document/AmbigousFilterRequest.idl index bd704a99e1c9..d89c8b2724c8 100644 --- a/offapi/com/sun/star/document/AmbigousFilterRequest.idl +++ b/offapi/com/sun/star/document/AmbigousFilterRequest.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module document { Given URL can be used to decide between given two filters. Decision can be made e.g. by a dialog, on which the user must select one of these filters. - A possible continuation of type <type>XInteractionFilterSelect</type> + A possible continuation of type XInteractionFilterSelect transport this decision back to source of started interaction. </p> diff --git a/offapi/com/sun/star/document/DocumentEvent.idl b/offapi/com/sun/star/document/DocumentEvent.idl index 710789e35d63..98bd92d1e1a3 100644 --- a/offapi/com/sun/star/document/DocumentEvent.idl +++ b/offapi/com/sun/star/document/DocumentEvent.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module document { -/** describes an event happening in an <type>OfficeDocument</type> +/** describes an event happening in an OfficeDocument <p>The <member scope="com::sun::star::lang">EventObject::Source</member> member of the base type refers to the document which broadcasts the event.</p> @@ -42,7 +42,7 @@ struct DocumentEvent : ::com::sun::star::lang::EventObject { /** specifies the name of the event. - <p>It's the responsibility of the component supporting the <type>XDocumentEventBroadcaster</type> + <p>It's the responsibility of the component supporting the XDocumentEventBroadcaster interface to specify which events it supports.</p> */ string EventName; diff --git a/offapi/com/sun/star/document/DocumentProperties.idl b/offapi/com/sun/star/document/DocumentProperties.idl index 29aa896d29d9..f4705ba7638c 100644 --- a/offapi/com/sun/star/document/DocumentProperties.idl +++ b/offapi/com/sun/star/document/DocumentProperties.idl @@ -28,8 +28,8 @@ module com { module sun { module star { module document { and user-defined fields. <p> - This service replaces the deprecated <type>DocumentInfo</type> and - <type>StandaloneDocumentInfo</type> services. + This service replaces the deprecated DocumentInfo and + StandaloneDocumentInfo services. </p> @since OOo 3.0 diff --git a/offapi/com/sun/star/document/EventObject.idl b/offapi/com/sun/star/document/EventObject.idl index 1aef3cfc2d2f..cb406d316a3d 100644 --- a/offapi/com/sun/star/document/EventObject.idl +++ b/offapi/com/sun/star/document/EventObject.idl @@ -37,7 +37,7 @@ published struct EventObject: com::sun::star::lang::EventObject /** specifies the name of the occurred event <p> - For a list of possible event names see <type>Events</type>. + For a list of possible event names see Events. </p> */ string EventName; diff --git a/offapi/com/sun/star/document/Events.idl b/offapi/com/sun/star/document/Events.idl index 2bab3b2e919d..ec8875c7a295 100644 --- a/offapi/com/sun/star/document/Events.idl +++ b/offapi/com/sun/star/document/Events.idl @@ -28,13 +28,13 @@ module com { module sun { module star { module document { document <p> - Such Events will be broadcasted by a <type>XEventBroadcaster</type> - to any <type>XEventListener</type> packed as <type>EventObject</type>s. + Such Events will be broadcasted by a XEventBroadcaster + to any XEventListener packed as EventObjects. </p> */ published service Events { - /** offers access to the list of <type>EventDescriptor</type>s + /** offers access to the list of EventDescriptors <p> The following events are usually available: diff --git a/offapi/com/sun/star/document/ExportFilter.idl b/offapi/com/sun/star/document/ExportFilter.idl index 91fdd650ef96..5653a0ea5ff7 100644 --- a/offapi/com/sun/star/document/ExportFilter.idl +++ b/offapi/com/sun/star/document/ExportFilter.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module document { <p> Such filters can be used for exporting a content. - Of course it's possible to combine it with the service <type>ImportFilter</type> + Of course it's possible to combine it with the service ImportFilter if import functionality should be available at same implementation too. </p> @@ -53,15 +53,15 @@ published service ExportFilter <p> It's used to filter a document at saving time. The source document should be already set by using another interface - <type>XExporter</type> which is supported by this service too. + XExporter which is supported by this service too. </p> <p> Tip:<br> - If same implementation provides the service <type>ImportFilter</type> too, + If same implementation provides the service ImportFilter too, code must distinguish between filtering from a source document (for export) or filtering to a target document (for import). This can be recognized by saving - state of used interfaces <type>XExporter</type> or <type>XImporter</type>! + state of used interfaces XExporter or XImporter! Otherwise it's not clear which action is required here. </p> */ @@ -70,14 +70,14 @@ published service ExportFilter /** support initialization of filter with its own configuration <p> - A filter object must be created by global service <type>FilterFactory</type>. + A filter object must be created by global service FilterFactory. If filter supports this optional interface, he will be initialized by the factory directly after creation. The factory will pass the following information to this new instance: <ul> <li>first item will be a set of configuration data of the filter</li> <li>after that will follow may given optional parameters of call <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> - of service <type>FilterFactory</type>. + of service FilterFactory. </li> </ul> See description of service <member>FilterFactory::XNameContainer</member> for a description of @@ -89,7 +89,7 @@ published service ExportFilter /** provides access to the internal name of this filter <p> - This internal filter name can be used on service <type>FilterFactory</type> + This internal filter name can be used on service FilterFactory to get further information about it (e.g. his registration for mime types or extensions etc.) It's important that returned string is the "internal name" of the filter which must be unambiguous against all other registered filters in current installation. diff --git a/offapi/com/sun/star/document/ExtendedTypeDetection.idl b/offapi/com/sun/star/document/ExtendedTypeDetection.idl index 8f1034b50c5f..9638f2b05dc0 100644 --- a/offapi/com/sun/star/document/ExtendedTypeDetection.idl +++ b/offapi/com/sun/star/document/ExtendedTypeDetection.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module document { -/** describes a class of service which will be used for deep <type>TypeDetection</type> +/** describes a class of service which will be used for deep TypeDetection in a generic way <p> - Due to the registered types, flat <type>TypeDetection</type> is already possible, i.e. + Due to the registered types, flat TypeDetection is already possible, i.e. the assignment of types (e.g. to a URL) only on the basis of configuration data. If, however, you imagine special cases (e.g. modifying the file extension of a Writer file from .sdw to .doc), it quickly becomes clear that you cannot always @@ -57,7 +57,7 @@ module com { module sun { module star { module document { You can also implement and register detectors for groups of types. </li> </ul> - See service <type>TypeDetection</type> and his configuration for further information. + See service TypeDetection and his configuration for further information. </p> @see TypeDetection @@ -69,7 +69,7 @@ published service ExtendedTypeDetection <p> Generic type detection searches for a registered DetectService for an already flat detected type. If any could be found it will be created and - used by calling methods of this interface. It gets a <type>MediaDescriptor</type> + used by calling methods of this interface. It gets a MediaDescriptor which contains information about the document which should be detected and must return <ul> <li>an internal type name for detected format</li> diff --git a/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl b/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl index ba526315d88d..dc7a0fccd9f4 100644 --- a/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl +++ b/offapi/com/sun/star/document/ExtendedTypeDetectionFactory.idl @@ -85,7 +85,7 @@ published service ExtendedTypeDetectionFactory <td><em>Types</em></td> <td>[sequence< string >]</td> <td>It's a list of all types, which can be detected by this extended detection component. - All items of this list must match an item of the <type>TypeDetection</type> container service.</td> + All items of this list must match an item of the TypeDetection container service.</td> </tr> </table> </p> diff --git a/offapi/com/sun/star/document/FilterFactory.idl b/offapi/com/sun/star/document/FilterFactory.idl index ab518e01311c..289a5709bb54 100644 --- a/offapi/com/sun/star/document/FilterFactory.idl +++ b/offapi/com/sun/star/document/FilterFactory.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module document { /** factory to create filter components. <p> - After a generic <type>TypeDetection</type> an internal type name + After a generic TypeDetection an internal type name will be known. Further a generic <type scope="com::sun::star::frame">FrameLoader</type> can use this information, to search a suitable filter (may the default filter) at this factory and use it for loading the document into a specified frame. @@ -141,7 +141,7 @@ published service FilterFactory <td><em>Type</em></td> <td>[string]</td> <td>Every filter is registered for a type. This value contains the internal name of it. - (see service <type>TypeDetection</type> for further information)</td> + (see service TypeDetection for further information)</td> </tr> <tr> <td><em>DocumentService</em></td> diff --git a/offapi/com/sun/star/document/ImportFilter.idl b/offapi/com/sun/star/document/ImportFilter.idl index da21501d0a59..7b7dc1602716 100644 --- a/offapi/com/sun/star/document/ImportFilter.idl +++ b/offapi/com/sun/star/document/ImportFilter.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module document { <p> Such filters can be used for importing a content. - Of course it's possible to combine it with the service <type>ExportFilter</type> + Of course it's possible to combine it with the service ExportFilter if export functionality should be available at same implementation too. </p> @@ -58,10 +58,10 @@ published service ImportFilter <p> Tip:<br> - If same implementation provides the service <type>ExportFilter</type> too, + If same implementation provides the service ExportFilter too, code must distinguish between filtering into a target document (for import) or filtering from a source document (for export). This can be recognized by saving - state of used interfaces <type>XExporter</type> or <type>XImporter</type>! + state of used interfaces XExporter or XImporter! Otherwise it's not clear which action is required here. </p> */ @@ -70,14 +70,14 @@ published service ImportFilter /** support initialization of filter with its own configuration <p> - A filter object must be created by global service <type>FilterFactory</type>. + A filter object must be created by global service FilterFactory. If filter supports this optional interface, he will be initialized by the factory directly after creation. The factory will pass follow information to this new instance: <ul> <li>first item will be a set of configuration data of the filter</li> <li>after that will follow may given optional parameters of call <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member> - of service <type>FilterFactory</type>. + of service FilterFactory. </li> </ul> See description of service <member>FilterFactory::XNameContainer</member> for a description of @@ -89,7 +89,7 @@ published service ImportFilter /** provides access to the internal name of this filter <p> - This internal filter name can be used on service <type>FilterFactory</type> + This internal filter name can be used on service FilterFactory to get further information about it (e.g. his registration for mime types or extensions etc.) It's important that returned string is the "internal name" of the filter which must be unambiguous against all other registered filters in current installation. diff --git a/offapi/com/sun/star/document/LinkTargets.idl b/offapi/com/sun/star/document/LinkTargets.idl index e6e084e5fa63..ffe258dc8629 100644 --- a/offapi/com/sun/star/document/LinkTargets.idl +++ b/offapi/com/sun/star/document/LinkTargets.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module document { <p>The <type scope="com::sun::star::container">XNameAccess</type> returns elements of <type scope="com::sun::star::beans">XPropertySet</type> that implement - the service <type>LinkTarget</type>. </p> + the service LinkTarget. </p> */ published service LinkTargets { diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl index d8326669dc2f..11cef721a891 100644 --- a/offapi/com/sun/star/document/MediaDescriptor.idl +++ b/offapi/com/sun/star/document/MediaDescriptor.idl @@ -156,7 +156,7 @@ service MediaDescriptor <p> Name of a filter that should be used for loading or storing the component. - Names must match the names of the <type>TypeDetection</type> configuration, + Names must match the names of the TypeDetection configuration, invalid names are ignored. If a name is specified on loading, it still will be verified by a filter detection, but in case of doubt it will be preferred. @@ -259,7 +259,7 @@ service MediaDescriptor <p> Type of the medium to load, that must match to one of the types defined - in the <type>TypeDetection</type> configuration (otherwise it's ignored). + in the TypeDetection configuration (otherwise it's ignored). This bypasses the type detection of the <type scope="com::sun::star::frame">Desktop</type> environment, so passing a wrong MediaType will cause failure of loading. </p> diff --git a/offapi/com/sun/star/document/NoSuchFilterRequest.idl b/offapi/com/sun/star/document/NoSuchFilterRequest.idl index 7ef01545c8c0..f62498c003e4 100644 --- a/offapi/com/sun/star/document/NoSuchFilterRequest.idl +++ b/offapi/com/sun/star/document/NoSuchFilterRequest.idl @@ -29,10 +29,10 @@ module com { module sun { module star { module document { <p> If during loading time the filter can't be detected and wasn't given at calling time, a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used. - (it's a a part of used <type>MediaDescriptor</type>) + (it's a a part of used MediaDescriptor) Such "NoSuchFilterRequest" will be used then to start right interaction on that to get a decision which filter should be used for given URL. A possible continuation - of type <type>XInteractionFilterSelect</type> will transport this decision back to + of type XInteractionFilterSelect will transport this decision back to generic filter detection and force using of it. Of course it's possible to abort the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>. </p> diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl index 96de71875c5b..6628e1b3c833 100644 --- a/offapi/com/sun/star/document/OfficeDocument.idl +++ b/offapi/com/sun/star/document/OfficeDocument.idl @@ -89,7 +89,7 @@ published service OfficeDocument */ interface com::sun::star::view::XPrintable; - /** is an old and deprecated version of the <type>XDocumentEventBroadcaster</type> interface + /** is an old and deprecated version of the XDocumentEventBroadcaster interface @deprecated */ [optional] interface XEventBroadcaster; @@ -119,7 +119,7 @@ published service OfficeDocument */ [optional] interface XEmbeddedScripts; - /** access to the <type>DocumentProperties</type>. + /** access to the DocumentProperties. @since OOo 3.0 */ diff --git a/offapi/com/sun/star/document/Settings.idl b/offapi/com/sun/star/document/Settings.idl index 81e44498ef14..843bafb1dbdc 100644 --- a/offapi/com/sun/star/document/Settings.idl +++ b/offapi/com/sun/star/document/Settings.idl @@ -62,7 +62,7 @@ published service Settings /** specifies the update mode for links when loading text documents. <p>For supported values see the constants group - <type>LinkUpdateModes</type>.</p> + LinkUpdateModes.</p> */ [optional, property] short LinkUpdateMode; @@ -230,7 +230,7 @@ published service Settings /** forbid use of printer metrics for layout <p>For supported values see the constants group - <type>PrinterIndependentLayout</type>.</p> + PrinterIndependentLayout.</p> */ [optional, property] short PrinterIndependentLayout; diff --git a/offapi/com/sun/star/document/TypeDetection.idl b/offapi/com/sun/star/document/TypeDetection.idl index afe74c5e90da..bb958dea1933 100644 --- a/offapi/com/sun/star/document/TypeDetection.idl +++ b/offapi/com/sun/star/document/TypeDetection.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module document { <p> It's possible to make a "flat" detection which may use internal configuration - data only - or a "deep" detection which use special <type>ExtendedTypeDetection</type> + data only - or a "deep" detection which use special ExtendedTypeDetection services to look into the document stream. Last mode can be suppressed to perform the operation. Of course the results can't be guaranteed then. (e.g. in case the extension was changed) </p> @@ -97,7 +97,7 @@ published service TypeDetection <td><em>ContentFormat</em></td> <td>[string]</td> <td>It's and identifier, which is used for a deep format detection. - An <type>ExtendedTypeDetection</type> use this value to match + An ExtendedTypeDetection use this value to match a given content to this type. e.g. It's interpreted as the doc type of an XML stream or as an identifier inside a file header. </td> @@ -108,7 +108,7 @@ published service TypeDetection <td>This list contains different URL patterns, which identify this type. E.g. data base contents can be described by an new defined protocol like "sql://select*". In combination with a suitable <type scope="com::sun::star::frame">FrameLoader</type> or - <type>ImportFilter</type>/<type>ExportFilter</type> it would be possible then, to + ImportFilter/ExportFilter it would be possible then, to layout a SQL query output into an office frame.</td> </tr> <tr> diff --git a/offapi/com/sun/star/document/UndoContextNotClosedException.idl b/offapi/com/sun/star/document/UndoContextNotClosedException.idl index 339ff846f223..fbccfc018c7c 100644 --- a/offapi/com/sun/star/document/UndoContextNotClosedException.idl +++ b/offapi/com/sun/star/document/UndoContextNotClosedException.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module document { -/** is thrown when an operation is attempted at an <type>XUndoManager</type> which requires all undo +/** is thrown when an operation is attempted at an XUndoManager which requires all undo contexts to be closed, but this requirement is not fullfilled. */ exception UndoContextNotClosedException : ::com::sun::star::util::InvalidStateException diff --git a/offapi/com/sun/star/document/UndoManagerEvent.idl b/offapi/com/sun/star/document/UndoManagerEvent.idl index 81105cc3cf4c..37e466fe07ff 100644 --- a/offapi/com/sun/star/document/UndoManagerEvent.idl +++ b/offapi/com/sun/star/document/UndoManagerEvent.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module document { -/** is an event sent by an <type>XUndoManager</type> implementation when the Undo/Redo stacks of the manager are +/** is an event sent by an XUndoManager implementation when the Undo/Redo stacks of the manager are modified. @see XUndoManager @see XUndoManagerListener diff --git a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl index 48198912904c..05c154503840 100644 --- a/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl +++ b/offapi/com/sun/star/document/XDocumentEventBroadcaster.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module document { interface XDocumentEventListener; -/** allows to be notified of events happening in an <type>OfficeDocument</type>, and to cause notification +/** allows to be notified of events happening in an OfficeDocument, and to cause notification of such events. <p>This interface is the successor of the XEventBroadcaster interface, which should not be used @@ -60,7 +60,7 @@ interface XDocumentEventBroadcaster /** causes the broadcaster to notify all registered listeners of the given event - <p>The method will create a <type>DocumentEvent</type> instance with the given parameters, + <p>The method will create a DocumentEvent instance with the given parameters, and fill in the <code>Source</code> member (denoting the broadcaster) as appropriate.</p> <p>Whether the actual notification happens synchronously or asynchronously is up to the @@ -85,7 +85,7 @@ interface XDocumentEventBroadcaster @throws ::com::sun::star::lang::NoSupportException if the broadcaster implementation does not supported broadcasting events induced externally. This is usually used for components which multiplex events from multiple sources, and thus would - be unable to fill in the <code>Source</code> member of the <type>DocumentEvent</type> instance. + be unable to fill in the <code>Source</code> member of the DocumentEvent instance. */ void notifyDocumentEvent( [in] string _EventName, diff --git a/offapi/com/sun/star/document/XDocumentEventListener.idl b/offapi/com/sun/star/document/XDocumentEventListener.idl index cb26a7661346..b3c249f60805 100644 --- a/offapi/com/sun/star/document/XDocumentEventListener.idl +++ b/offapi/com/sun/star/document/XDocumentEventListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module document { -/** allows to be notified of events happening in an <type>OfficeDocument</type> +/** allows to be notified of events happening in an OfficeDocument <p>This interface is the successor of the XEventListener interface, which should not be used anymore.</p> diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl index 764d30f1457f..63ab8e0e81fb 100644 --- a/offapi/com/sun/star/document/XDocumentProperties.idl +++ b/offapi/com/sun/star/document/XDocumentProperties.idl @@ -259,7 +259,7 @@ published interface XDocumentProperties /** provides access to a container for user-defined properties. <p> The returned object also implements the interface - <type>com::sun::star::beans::XPropertySet</type>. + com::sun::star::beans::XPropertySet. </p> @returns a container that provides access to user-defined properties */ @@ -273,11 +273,11 @@ published interface XDocumentProperties </p> @param Storage - the <type>com::sun::star::embed::Storage</type> representing the + the com::sun::star::embed::Storage representing the ODF package @param Medium - the <type>com::sun::star::document::MediaDescriptor</type> + the com::sun::star::document::MediaDescriptor representing the source <p> This is unfortunately necessary in order to properly resolve @@ -312,7 +312,7 @@ published interface XDocumentProperties </p> @param Medium - the <type>com::sun::star::document::MediaDescriptor</type> + the com::sun::star::document::MediaDescriptor representing the source @throws com::sun::star::io::WrongFormatException @@ -335,15 +335,15 @@ published interface XDocumentProperties someone else, e.g., a document. Note that the implementation may choose to store the meta-data in either OOo or ODF format, depending on the MediaType property - of the given <type>Storage</type> argument. + of the given Storage argument. </p> @param Storage - the <type>com::sun::star::embed::Storage</type> representing the + the com::sun::star::embed::Storage representing the ODF package @param Medium - the <type>com::sun::star::document::MediaDescriptor</type> + the com::sun::star::document::MediaDescriptor representing the source <p> This is unfortunately necessary in order to properly resolve @@ -375,7 +375,7 @@ published interface XDocumentProperties </p> @param Medium - the <type>com::sun::star::document::MediaDescriptor</type> + the com::sun::star::document::MediaDescriptor representing the target @throws com::sun::star::lang::WrappedTargetException diff --git a/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl b/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl index 3566a5449bf1..29c29d9cd82a 100644 --- a/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl +++ b/offapi/com/sun/star/document/XDocumentPropertiesSupplier.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module document { -/** provides access to the <type>XDocumentProperties</type> instance of a +/** provides access to the XDocumentProperties instance of a document. <p> - A <type>DocumentProperties</type> instance is available on loaded documents + A DocumentProperties instance is available on loaded documents via this supplier interface. </p> @@ -42,7 +42,7 @@ published interface XDocumentPropertiesSupplier /** provides the document properties object. @returns - an object of type <type>XDocumentProperties</type> + an object of type XDocumentProperties */ XDocumentProperties getDocumentProperties(); }; diff --git a/offapi/com/sun/star/document/XEmbeddedScripts.idl b/offapi/com/sun/star/document/XEmbeddedScripts.idl index e28a4dff4884..c7ef5ea4e51e 100644 --- a/offapi/com/sun/star/document/XEmbeddedScripts.idl +++ b/offapi/com/sun/star/document/XEmbeddedScripts.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module document { -/** is supported by <type>OfficeDocument</type>s which allow to embed scripts +/** is supported by OfficeDocuments which allow to embed scripts @since OOo 2.4 */ @@ -42,7 +42,7 @@ interface XEmbeddedScripts /** determines whether executing macros from this document is allowed. - <p>Effectively, this attribute is an evaluation of the document's <type>MacroExecMode</type> + <p>Effectively, this attribute is an evaluation of the document's MacroExecMode against possibly applicable configuration settings, the document location in relation to the trusted location, and the like.</p> diff --git a/offapi/com/sun/star/document/XEventBroadcaster.idl b/offapi/com/sun/star/document/XEventBroadcaster.idl index 947d4f796f8b..140b0b6abde2 100644 --- a/offapi/com/sun/star/document/XEventBroadcaster.idl +++ b/offapi/com/sun/star/document/XEventBroadcaster.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module document { /** makes it possible to register listeners which are called whenever - a document event (see <type>EventObject</type>) occurs + a document event (see EventObject) occurs @deprecated @see XDocumentEventBroadcaster diff --git a/offapi/com/sun/star/document/XEventListener.idl b/offapi/com/sun/star/document/XEventListener.idl index df73a89154c7..213583c110d0 100644 --- a/offapi/com/sun/star/document/XEventListener.idl +++ b/offapi/com/sun/star/document/XEventListener.idl @@ -28,14 +28,14 @@ module com { module sun { module star { module document { /** makes it possible to register listeners, which are called whenever a document or document content event occurs - <p>Such events will be broadcasted by a <type>XEventBroadcaster</type>.</p> + <p>Such events will be broadcasted by a XEventBroadcaster.</p> @deprecated @see XDocumentEventListener */ published interface XEventListener: com::sun::star::lang::XEventListener { - /** is called whenever a document event (see <type>EventObject</type>) occurs + /** is called whenever a document event (see EventObject) occurs @param Event specifies the event type diff --git a/offapi/com/sun/star/document/XEventsSupplier.idl b/offapi/com/sun/star/document/XEventsSupplier.idl index 9b0ad083a078..46d3035585a7 100644 --- a/offapi/com/sun/star/document/XEventsSupplier.idl +++ b/offapi/com/sun/star/document/XEventsSupplier.idl @@ -32,7 +32,7 @@ published interface XEventsSupplier: com::sun::star::uno::XInterface this object @returns - an <type>Events</type> description object + an Events description object */ com::sun::star::container::XNameReplace getEvents(); }; diff --git a/offapi/com/sun/star/document/XExporter.idl b/offapi/com/sun/star/document/XExporter.idl index d5f50edfc47d..ca175d787768 100644 --- a/offapi/com/sun/star/document/XExporter.idl +++ b/offapi/com/sun/star/document/XExporter.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module document { -/** makes it possible to connect a document with an <type>ExportFilter</type> +/** makes it possible to connect a document with an ExportFilter <p> - An <type>ExportFilter</type> must know the source of his filter operation. + An ExportFilter must know the source of his filter operation. To set this on a filter is part of this interface. Same mechanism exist for import too. </p> diff --git a/offapi/com/sun/star/document/XExtendedFilterDetection.idl b/offapi/com/sun/star/document/XExtendedFilterDetection.idl index 4462c5640769..879c839378e5 100644 --- a/offapi/com/sun/star/document/XExtendedFilterDetection.idl +++ b/offapi/com/sun/star/document/XExtendedFilterDetection.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module document { <p> A "deep" filter detection means looking into the document stream to detect - the format of it. Services of type <type>ExtendedTypeDetection</type> must support this + the format of it. Services of type ExtendedTypeDetection must support this interface to be called from generic load mechanism of the office for that. </p> @@ -39,19 +39,19 @@ module com { module sun { module star { module document { */ published interface XExtendedFilterDetection: com::sun::star::uno::XInterface { - /** controls agreement of a "flat" <type>TypeDetection</type> + /** controls agreement of a "flat" TypeDetection with given URL or arguments <p> Registered services in configuration, which support this interface for different mime types, will be called automatically to look into the document stream and decide which format it represent. - Add the collected information about detected documents in given <type>MediaDescriptor</type> + Add the collected information about detected documents in given MediaDescriptor <var>Descriptor</var>. The decision must be returned as any valid type name (which specifies the detected format) or an empty value for unknown formats. </p> @param Descriptor - represent a <type>MediaDescriptor</type> which can be used to get/set information + represent a MediaDescriptor which can be used to get/set information about the detected document @returns diff --git a/offapi/com/sun/star/document/XFilter.idl b/offapi/com/sun/star/document/XFilter.idl index 7b3ba03c2bf9..9a17b2bf53e8 100644 --- a/offapi/com/sun/star/document/XFilter.idl +++ b/offapi/com/sun/star/document/XFilter.idl @@ -28,11 +28,11 @@ module com { module sun { module star { module document { /** interface to filter documents <p> - This interface will be used by service <type>ImportFilter</type> or - <type>ExportFilter</type> to support loading/saving of documents in + This interface will be used by service ImportFilter or + ExportFilter to support loading/saving of documents in different formats. The target/source of such filter operations must be known <em>before</em> filtering will be started. - (see <type>XImporter</type> and <type>XExporter</type> too) + (see XImporter and XExporter too) Otherwise this interface can't work right. <p> @@ -46,7 +46,7 @@ published interface XFilter: com::sun::star::uno::XInterface /** filter the document. <p> - The given <type>MediaDescriptor</type> holds all necessary information + The given MediaDescriptor holds all necessary information about the document. Don't hold hard references to the descriptor items. You must copy needed information! diff --git a/offapi/com/sun/star/document/XImporter.idl b/offapi/com/sun/star/document/XImporter.idl index 7d1f7bd19ab2..3325bb789c16 100644 --- a/offapi/com/sun/star/document/XImporter.idl +++ b/offapi/com/sun/star/document/XImporter.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module document { -/** makes it possible to connect a document with an <type>ImportFilter</type> +/** makes it possible to connect a document with an ImportFilter <p> - An <type>ImportFilter</type> must know the target of his filter operation. + An ImportFilter must know the target of his filter operation. To set this on a filter is part of this interface. Same mechanism exist for export too. </p> diff --git a/offapi/com/sun/star/document/XInteractionFilterSelect.idl b/offapi/com/sun/star/document/XInteractionFilterSelect.idl index cb2c376ab99f..53fe6a36697d 100644 --- a/offapi/com/sun/star/document/XInteractionFilterSelect.idl +++ b/offapi/com/sun/star/document/XInteractionFilterSelect.idl @@ -30,8 +30,8 @@ module com { module sun { module star { module document { <p> If during loading time the filter can't be detected and wasn't given at calling time, a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used. - (it's a a part of used <type>MediaDescriptor</type>) - A <type>NoSuchFilterRequest</type> will be used then to start right interaction on that to + (it's a a part of used MediaDescriptor) + A NoSuchFilterRequest will be used then to start right interaction on that to get a decision which filter should be used for given URL. A possible continuation of that can be this XInteractionFilterSelect. It will transport the decision back to generic filter detection and force using of it. Of course it's possible to abort diff --git a/offapi/com/sun/star/document/XLinkTargetSupplier.idl b/offapi/com/sun/star/document/XLinkTargetSupplier.idl index fb46d46b5e25..31e44ca0f405 100644 --- a/offapi/com/sun/star/document/XLinkTargetSupplier.idl +++ b/offapi/com/sun/star/document/XLinkTargetSupplier.idl @@ -31,13 +31,13 @@ module com { module sun { module star { module document { /** interface is supplied by objects inside a document object model that have children that can be the target of a link inside a document. - <p>These targets implement the service <type>LinkTarget</type>. </p> + <p>These targets implement the service LinkTarget. </p> */ published interface XLinkTargetSupplier: com::sun::star::uno::XInterface { /** @returns the names of possible links to children of this object inside a - document object model. It implements the service <type>LinkTargets</type>. + document object model. It implements the service LinkTargets. */ com::sun::star::container::XNameAccess getLinks(); diff --git a/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl b/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl index ef886ec98ad8..8ec55a557942 100644 --- a/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl +++ b/offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.idl @@ -37,7 +37,7 @@ interface XOOXMLDocumentPropertiesImporter: com::sun::star::uno::XInterface <p> The implementation should parse the document properties from OOXML format storage and set them to the target - <type>XDocumentProperties</type> implementation. + XDocumentProperties implementation. </p> <p> @@ -52,7 +52,7 @@ interface XOOXMLDocumentPropertiesImporter: com::sun::star::uno::XInterface the source storage representing OOXML document @param xDocumentProperties - the target <type>XDocumentProperties</type> interface implementation + the target XDocumentProperties interface implementation @throws ::com::sun::star::lang::IllegalArgumentException the exception is thrown in case unexpected arguments are provided diff --git a/offapi/com/sun/star/document/XScriptInvocationContext.idl b/offapi/com/sun/star/document/XScriptInvocationContext.idl index 5f141429de3f..e950c9b614f1 100644 --- a/offapi/com/sun/star/document/XScriptInvocationContext.idl +++ b/offapi/com/sun/star/document/XScriptInvocationContext.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module document { <p>If the component implementing it is a document, which supports embedding scripts into itself, then <member>ScriptContainer</member> refers to the document itself. Implementing this - interface is unnecessary then, instead the document should simply implement <type>XEmbeddedScripts</type> directly.</p> + interface is unnecessary then, instead the document should simply implement XEmbeddedScripts directly.</p> <p>If the interface is implemented by a document which does not itself support embedding scripts into it, but which is associated unambiguously with a document which does, diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl index 4d7eb7dad8b3..64613f5830da 100644 --- a/offapi/com/sun/star/document/XTypeDetection.idl +++ b/offapi/com/sun/star/document/XTypeDetection.idl @@ -58,11 +58,11 @@ published interface XTypeDetection: com::sun::star::uno::XInterface string queryTypeByURL( [in] string URL ); /** make a "deep" detection or optional a "flat" detection by using a - <type>MediaDescriptor</type> + MediaDescriptor <p> Instead of <member>XTypeDetection::queryTypeByURL()</member> this function - use a <type>MediaDescriptor</type> to specify the document for detection. + use a MediaDescriptor to specify the document for detection. Such descriptor hold different information about the document. He will be passed to any part of made detection process and every part can change it to actualize it. @@ -83,7 +83,7 @@ published interface XTypeDetection: com::sun::star::uno::XInterface </p> @param Descriptor - means the <type>MediaDescriptor</type> which specify the resource for detection + means the MediaDescriptor which specify the resource for detection @param AllowDeep if it is set to <TRUE/> a "deep" detection will be follow a "flat" detection diff --git a/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl b/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl index 4a7579408a96..001a3bae76ea 100644 --- a/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl +++ b/offapi/com/sun/star/drawing/AccessibleDrawDocumentView.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleDrawDocumentView</type> service is implemented by +/** The AccessibleDrawDocumentView service is implemented by views of Draw and Impress documents. - <p>An object that implements the <type>AccessibleDrawDocumentView</type> + <p>An object that implements the AccessibleDrawDocumentView service provides information about the view of a Draw or Impress document in one of the various view modes. With its children it gives access to the current page and the shapes on that page.</p> @@ -115,7 +115,7 @@ service AccessibleDrawDocumentView of the currently visible area and to let the user find children (i.e. shapes) that cover a given test point. The more interesting part of the graphical representation of a draw page lies in its - children. See the <type>AccessibleShape</type> service for more + children. See the AccessibleShape service for more information about shapes.</p> @see AccessibleShape diff --git a/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl b/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl index 6a92e1610569..9fe1021ffb3e 100644 --- a/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl +++ b/offapi/com/sun/star/drawing/AccessibleGraphicShape.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleGraphicShape</type> service is implemented by the +/** The AccessibleGraphicShape service is implemented by the graphic object shapes shapes com.sun.star.drawing.GraphicObjectShape and com.sun.star.presentation.GraphicObjectShape. - <p>It differs from the included <type>AccessibleShape</type> "base" + <p>It differs from the included AccessibleShape "base" service by the additional support of the <type scope="::com::sun::star::accessibility">XAccessibleImage</type> @@ -41,7 +41,7 @@ service AccessibleGraphicShape { /** Give access to information of generic shapes. - <p>See <type>AccessibleShape</type> for documentation and support of + <p>See AccessibleShape for documentation and support of the interfaces <type scope="::com::sun::star::accessibility">XAccessible</type>, <type scope="::com::sun::star::accessibility">XAccessibleContext</type>, @@ -60,7 +60,7 @@ service AccessibleGraphicShape requires the shape to provide a description of the displayed image and the image's size in the screen coordinate system (pixel). At the time being this interface does not provide information that is - not available through the <type>AccessibleShape</type> service: + not available through the AccessibleShape service: the size returned by the <member scope="::com::sun::star::accessibility" >XAccessibleImage::getWidth</member> and <member diff --git a/offapi/com/sun/star/drawing/AccessibleOLEShape.idl b/offapi/com/sun/star/drawing/AccessibleOLEShape.idl index f24e51ff0516..5a202670b383 100644 --- a/offapi/com/sun/star/drawing/AccessibleOLEShape.idl +++ b/offapi/com/sun/star/drawing/AccessibleOLEShape.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleOLEShape</type> service is implemented by +/** The AccessibleOLEShape service is implemented by OLE shapes. <p>This includes generic OLE shapes, frames, plug-ins, and applets.</p> @@ -50,7 +50,7 @@ service AccessibleOLEShape { /** Give access to information of generic shapes. - <p>See <type>AccessibleShape</type> for basic documentation and + <p>See AccessibleShape for basic documentation and support of the <type scope="::com::sun::star::accessibility" >XAccessibleContext</type>, and diff --git a/offapi/com/sun/star/drawing/AccessibleShape.idl b/offapi/com/sun/star/drawing/AccessibleShape.idl index 122bd44e2b57..e19e93d820d7 100644 --- a/offapi/com/sun/star/drawing/AccessibleShape.idl +++ b/offapi/com/sun/star/drawing/AccessibleShape.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleShape</type> service is implemented by UNO shapes to +/** The AccessibleShape service is implemented by UNO shapes to provide accessibility information that describe the shape's features. A UNO shape is any object that implements the <type scope="::com::sun::star::drawing">XShape</type> interface. @@ -35,14 +35,14 @@ module com { module sun { module star { module drawing { and accessible text paragraphs. The root of this (sub-)tree is the accessible draw document view. An accessible shape implements either this service or one of the "derived" services - <type>AccessibleGraphicShape</type> or <type>AccessibleOLEShape</type>. + AccessibleGraphicShape or AccessibleOLEShape. See the section Children in the description of the <type scope="::com::sun::star::accessibility" >XAccessibleContext</type> interface support for more details.</p> <p>There are two services that extend this one: the - <type>AccessibleGraphicShape</type> and the - <type>AccessibleOLEShape</type> services provide additional interfaces. + AccessibleGraphicShape and the + AccessibleOLEShape services provide additional interfaces. See there for details.</p> <p>A shape object is either fully or partially visible on the screen or @@ -84,7 +84,7 @@ service AccessibleShape >AccessibleParagraphView</type> for details of how this text is represented.</li> <li>Parent: The parent is either the document view as represented by - <type>AccessibleDrawDocumentView</type> or a group shape, 3D + AccessibleDrawDocumentView or a group shape, 3D scene shape, or OLE shape.</li> <li>Relations: Are set and maintained from the outside. See the service description of the object that has accessible shapes as diff --git a/offapi/com/sun/star/drawing/AccessibleSlideView.idl b/offapi/com/sun/star/drawing/AccessibleSlideView.idl index 6ff48387d7a6..a5b248d214c6 100644 --- a/offapi/com/sun/star/drawing/AccessibleSlideView.idl +++ b/offapi/com/sun/star/drawing/AccessibleSlideView.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleSlideView</type> service is implemented by +/** The AccessibleSlideView service is implemented by slide views of Impress documents. <p>An accessible slide view gives access to all visible slides of a diff --git a/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl b/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl index 952a30c56fbc..3adaba8e7bb7 100644 --- a/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl +++ b/offapi/com/sun/star/drawing/AccessibleSlideViewObject.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module drawing { -/** The <type>AccessibleSlideViewObject</type> service is implemented by +/** The AccessibleSlideViewObject service is implemented by the slides of the slide view of Impress documents. <p>An accessible slide view object gives access to one of the visible diff --git a/offapi/com/sun/star/drawing/Alignment.idl b/offapi/com/sun/star/drawing/Alignment.idl index 4c9819f3fab4..4150f517d50a 100644 --- a/offapi/com/sun/star/drawing/Alignment.idl +++ b/offapi/com/sun/star/drawing/Alignment.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>Alignment</type> enumeration is a general way to specify the +/** The Alignment enumeration is a general way to specify the alignment of an object or sub-object relative to another object. */ published enum Alignment diff --git a/offapi/com/sun/star/drawing/AppletShape.idl b/offapi/com/sun/star/drawing/AppletShape.idl index 71c3d8833c20..baa256adbd82 100644 --- a/offapi/com/sun/star/drawing/AppletShape.idl +++ b/offapi/com/sun/star/drawing/AppletShape.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** This <type>Shape</type> encapsulates an applet. +/** This Shape encapsulates an applet. <p> An applet is a small Java-based program that is executed and rendered embedded in a document. @@ -34,7 +34,7 @@ published service AppletShape { /** basic service for position, size and z-order. - <p>A <type>AppletShape</type> cannot be rotated. + <p>A AppletShape cannot be rotated. */ service com::sun::star::drawing::Shape; diff --git a/offapi/com/sun/star/drawing/BitmapMode.idl b/offapi/com/sun/star/drawing/BitmapMode.idl index 9a4172ae24f3..0172bc2b89e0 100644 --- a/offapi/com/sun/star/drawing/BitmapMode.idl +++ b/offapi/com/sun/star/drawing/BitmapMode.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { -/** The <type>BitmapMode</type> selects an algorithm for filling an area with +/** The BitmapMode selects an algorithm for filling an area with a bitmap. */ published enum BitmapMode diff --git a/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl b/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl index 30dd4133ba98..ff9fd4e5c9b3 100644 --- a/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl +++ b/offapi/com/sun/star/drawing/CaptionEscapeDirection.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { /** this flags describe escape direction for - the line of a <type>CaptionShape</type>. + the line of a CaptionShape. @see CaptionShape */ diff --git a/offapi/com/sun/star/drawing/CaptionShape.idl b/offapi/com/sun/star/drawing/CaptionShape.idl index 38817aa56143..1b0998d0e92a 100644 --- a/offapi/com/sun/star/drawing/CaptionShape.idl +++ b/offapi/com/sun/star/drawing/CaptionShape.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module drawing { -/** The <type>CaptionShape</type> represents a rectangular drawing shape +/** The CaptionShape represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing. */ diff --git a/offapi/com/sun/star/drawing/CaptionType.idl b/offapi/com/sun/star/drawing/CaptionType.idl index 99d92425c412..5a881b4a36f0 100644 --- a/offapi/com/sun/star/drawing/CaptionType.idl +++ b/offapi/com/sun/star/drawing/CaptionType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** This constants specifies the geometry of the line of a <type>CaptionShape</type>. +/** This constants specifies the geometry of the line of a CaptionShape. @see CaptionShape */ diff --git a/offapi/com/sun/star/drawing/ColorMode.idl b/offapi/com/sun/star/drawing/ColorMode.idl index df688b62636d..90288b6b4b77 100644 --- a/offapi/com/sun/star/drawing/ColorMode.idl +++ b/offapi/com/sun/star/drawing/ColorMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>ColorMode</type> defines the output style of colors +/** The ColorMode defines the output style of colors for a graphic. */ published enum ColorMode diff --git a/offapi/com/sun/star/drawing/ConnectorShape.idl b/offapi/com/sun/star/drawing/ConnectorShape.idl index fd3f8302daae..61112ffe8701 100644 --- a/offapi/com/sun/star/drawing/ConnectorShape.idl +++ b/offapi/com/sun/star/drawing/ConnectorShape.idl @@ -37,8 +37,8 @@ module com { module sun { module star { module drawing { -/** This service is for a <type>ConnectorShape</type>, a specialized <type>Shape</type>, - which can be connected to other <type>Shape</type>s or <type>GluePoint</type>s. +/** This service is for a ConnectorShape, a specialized Shape, + which can be connected to other Shapes or GluePoints. */ published service ConnectorShape { diff --git a/offapi/com/sun/star/drawing/ConnectorType.idl b/offapi/com/sun/star/drawing/ConnectorType.idl index 1d4d704d9dd4..c693ad22d014 100644 --- a/offapi/com/sun/star/drawing/ConnectorType.idl +++ b/offapi/com/sun/star/drawing/ConnectorType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>ConnectorType</type> specifies the appearance of a connector. +/** The ConnectorType specifies the appearance of a connector. */ published enum ConnectorType { diff --git a/offapi/com/sun/star/drawing/ControlShape.idl b/offapi/com/sun/star/drawing/ControlShape.idl index 39df9249294a..4ecb5f3d62ec 100644 --- a/offapi/com/sun/star/drawing/ControlShape.idl +++ b/offapi/com/sun/star/drawing/ControlShape.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** This service is for a <type>Shape</type> which contains a control. +/** This service is for a Shape which contains a control. <p> @see Shape @see XControlShape diff --git a/offapi/com/sun/star/drawing/DashTable.idl b/offapi/com/sun/star/drawing/DashTable.idl index 76f90d08b005..2e140c42bb46 100644 --- a/offapi/com/sun/star/drawing/DashTable.idl +++ b/offapi/com/sun/star/drawing/DashTable.idl @@ -25,9 +25,9 @@ module com { module sun { module star { module drawing { -/** this is a container for <type>LineDash</type>s +/** this is a container for LineDashs - <p>It is used for example to access the <type>LineDash</type>s that + <p>It is used for example to access the LineDashs that are used inside a document. @see DrawingDocumentFactory @@ -35,7 +35,7 @@ */ published service DashTable { - /** this container lets you access the <type>LineDash</type>s that + /** this container lets you access the LineDashs that are indexed with a name. <p>Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/DrawPage.idl b/offapi/com/sun/star/drawing/DrawPage.idl index bba8b71a115f..50d3b153e154 100644 --- a/offapi/com/sun/star/drawing/DrawPage.idl +++ b/offapi/com/sun/star/drawing/DrawPage.idl @@ -41,7 +41,7 @@ published service DrawPage */ service com::sun::star::drawing::GenericDrawPage; - /** provides the link to a <type>MasterPage</type>. + /** provides the link to a MasterPage. */ interface com::sun::star::drawing::XMasterPageTarget; diff --git a/offapi/com/sun/star/drawing/DrawPages.idl b/offapi/com/sun/star/drawing/DrawPages.idl index ede769622917..17b9587e8721 100644 --- a/offapi/com/sun/star/drawing/DrawPages.idl +++ b/offapi/com/sun/star/drawing/DrawPages.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module drawing { -/** provides access to a container of <type>DrawPage</type>s +/** provides access to a container of DrawPages and makes it possible for you to manipulate them. @see XDrawPagesSupplier @@ -37,7 +37,7 @@ */ published service DrawPages { - /** lets you access and create <type>DrawPage</type>s + /** lets you access and create DrawPages */ interface com::sun::star::drawing::XDrawPages; diff --git a/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl b/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl index 198c813c86ac..674ac7ed3d66 100644 --- a/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl +++ b/offapi/com/sun/star/drawing/DrawingDocumentDrawView.idl @@ -39,8 +39,8 @@ module com { module sun { module star { module view { module com { module sun { module star { module drawing { -/** This component integrates a view to a <type>DrawPage</type>s or - <type>MasterPage</type> from a <type>DrawingDocument</type>. +/** This component integrates a view to a DrawPages or + MasterPage from a DrawingDocument. */ published service DrawingDocumentDrawView { diff --git a/offapi/com/sun/star/drawing/GenericDrawPage.idl b/offapi/com/sun/star/drawing/GenericDrawPage.idl index dab995e29e34..8183cff457ec 100644 --- a/offapi/com/sun/star/drawing/GenericDrawPage.idl +++ b/offapi/com/sun/star/drawing/GenericDrawPage.idl @@ -39,11 +39,11 @@ module com { module sun { module star { module drawing { /** This abstract service is implemented by every page of a - <type>DrawingDocument</type>. + DrawingDocument. - @example create and insert a couple of <type>LineShape</type>s: + @example create and insert a couple of LineShapes: <listing> xPage = xDoc.DrawPages(0) @@ -60,28 +60,28 @@ published service GenericDrawPage { - /** manages the <type>Shape</type>s of this page. + /** manages the Shapes of this page. - <p>It also lets you add new <type>Shape</type>s. The program currently - requires that these <type>Shape</type>s be created by the factory of + <p>It also lets you add new Shapes. The program currently + requires that these Shapes be created by the factory of the document. - @see <type>DrawingDocument</type> + @see DrawingDocument */ interface com::sun::star::drawing::XShapes; /** With this interface you can group/ungroup a collection of - <type>Shape</type>s. + Shapes. */ interface com::sun::star::drawing::XShapeGrouper; /** With this interface you can combine/split a collection of - <type>Shape</type>s. + Shapes. */ [optional] interface com::sun::star::drawing::XShapeCombiner; /** With this interface you can bind/unbind a collection of - <type>Shape</type>s. + Shapes. */ [optional] interface com::sun::star::drawing::XShapeBinder; @@ -92,7 +92,7 @@ published service GenericDrawPage [optional] interface com::sun::star::container::XNamed; /** gives you access to the properties of this - <type>DrawPage</type>. + DrawPage. */ [optional] interface com::sun::star::beans::XPropertySet; diff --git a/offapi/com/sun/star/drawing/GenericDrawingDocument.idl b/offapi/com/sun/star/drawing/GenericDrawingDocument.idl index 61773c52bdd2..46d27fd57875 100644 --- a/offapi/com/sun/star/drawing/GenericDrawingDocument.idl +++ b/offapi/com/sun/star/drawing/GenericDrawingDocument.idl @@ -48,30 +48,30 @@ service GenericDrawingDocument /** this factory lets you create various services that are used inside a drawing document - <p>The following services are <type>Shape</type>s. + <p>The following services are Shapes. They are created by the documents factory and must - be inserted into a <type>DrawPage</type> or <type>MasterPage</type> + be inserted into a DrawPage or MasterPage of this document. <ul> - <li><type>RectangleShape</type></li> - <li><type>EllipseShape</type></li> - <li><type>ControlShape</type></li> - <li><type>ConnectorShape</type></li> - <li><type>MeasureShape</type></li> - <li><type>LineShape</type></li> - <li><type>PolyPolygonShape</type></li> - <li><type>PolyLineShape</type></li> - <li><type>OpenBezierShape</type></li> - <li><type>ClosedBezierShape</type></li> - <li><type>GraphicObjectShape</type></li> - <li><type>GroupShape</type></li> - <li><type>TextShape</type></li> - <li><type>OLE2Shape</type></li> - <li><type>PageShape</type></li> - <li><type>CaptionShape</type></li> - <li><type>PluginShape</type></li> - <li><type>AppletShape</type></li> + <li>RectangleShape</li> + <li>EllipseShape</li> + <li>ControlShape</li> + <li>ConnectorShape</li> + <li>MeasureShape</li> + <li>LineShape</li> + <li>PolyPolygonShape</li> + <li>PolyLineShape</li> + <li>OpenBezierShape</li> + <li>ClosedBezierShape</li> + <li>GraphicObjectShape</li> + <li>GroupShape</li> + <li>TextShape</li> + <li>OLE2Shape</li> + <li>PageShape</li> + <li>CaptionShape</li> + <li>PluginShape</li> + <li>AppletShape</li> </ul> <p>The following services are all <type scope="com::sun::star::text">TextField</type> @@ -112,7 +112,7 @@ service GenericDrawingDocument inside the document. <br>A <type scope="com::sun::star::image">ImageMap</type> can be obtained from a - <type>GraphicObjectShape</type> + GraphicObjectShape <ul> <li><type scope="com::sun::star::image">ImageMapRectangleObject</type></li> @@ -139,22 +139,22 @@ service GenericDrawingDocument /** provides an object that is implementing the service - <type>DrawPage</type>s. With this service you have access to the - <type>DrawPage</type>s inside a document. + DrawPages. With this service you have access to the + DrawPages inside a document. */ interface com::sun::star::drawing::XDrawPagesSupplier; /** returns an object that is implementing the service - <type>MasterPages</type>. With this service you have access to the - <type>MasterPage</type>s inside a document. + MasterPages. With this service you have access to the + MasterPages inside a document. */ interface com::sun::star::drawing::XMasterPagesSupplier; /** returns an object that is implementing the service - <type>LayerManager</type>. This service lets you manipulate the - <type>Layer</type>s of this document. + LayerManager. This service lets you manipulate the + Layers of this document. */ interface com::sun::star::drawing::XLayerSupplier; diff --git a/offapi/com/sun/star/drawing/GluePoint.idl b/offapi/com/sun/star/drawing/GluePoint.idl index 7f1d486e4d1c..d5931f68ede1 100644 --- a/offapi/com/sun/star/drawing/GluePoint.idl +++ b/offapi/com/sun/star/drawing/GluePoint.idl @@ -25,29 +25,29 @@ module com { module sun { module star { module drawing { -/** A <type>GluePoint</type> could be attached to a shape or to a page. +/** A GluePoint could be attached to a shape or to a page. - <p>If a <type>GluePoint</type> is attached to a shape, it is moved when + <p>If a GluePoint is attached to a shape, it is moved when the shape moves. - The ends of connectors can be attached to <type>GluePoint</type>.</p> + The ends of connectors can be attached to GluePoint.</p> @deprecated @see GluePoint2 */ published struct GluePoint { - /** This is the position of this <type>GluePoint</type>. + /** This is the position of this GluePoint. */ com::sun::star::awt::Point Position; /** This is the direction in which the connector line leaves the - <type>GluePoint</type>. + GluePoint. */ short EscapeDirection; - /** If this is <TRUE/>, then the position of this <type>GluePoint</type> is + /** If this is <TRUE/>, then the position of this GluePoint is absolute on a page and is not relative to a shape. */ boolean PositionAbsolute; diff --git a/offapi/com/sun/star/drawing/GraphicExportFilter.idl b/offapi/com/sun/star/drawing/GraphicExportFilter.idl index 947260348130..190f189d29fe 100644 --- a/offapi/com/sun/star/drawing/GraphicExportFilter.idl +++ b/offapi/com/sun/star/drawing/GraphicExportFilter.idl @@ -26,7 +26,7 @@ /** a component that supports this service lets you export pages, shapes, or - groups of shapes from a <type>DrawingDocument</type> to a file in one of the + groups of shapes from a DrawingDocument to a file in one of the file formats supported by the component. */ published service GraphicExportFilter : XGraphicExportFilter; diff --git a/offapi/com/sun/star/drawing/GroupShape.idl b/offapi/com/sun/star/drawing/GroupShape.idl index 93937bf0d3ce..96a0ded1bfac 100644 --- a/offapi/com/sun/star/drawing/GroupShape.idl +++ b/offapi/com/sun/star/drawing/GroupShape.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module drawing { -/** This service is for a group of <type>Shape</type>s. +/** This service is for a group of Shapes. @see XShapeGroup @see XShapes */ @@ -45,7 +45,7 @@ published service GroupShape interface com::sun::star::drawing::XShapeGroup; - /** lets you access the <type>Shape</type>s in this Group. + /** lets you access the Shapes in this Group. */ interface com::sun::star::drawing::XShapes; diff --git a/offapi/com/sun/star/drawing/Hatch.idl b/offapi/com/sun/star/drawing/Hatch.idl index 2bada9607bf5..99c1da0b029f 100644 --- a/offapi/com/sun/star/drawing/Hatch.idl +++ b/offapi/com/sun/star/drawing/Hatch.idl @@ -33,7 +33,7 @@ */ published struct Hatch { - /** The <type>HatchStyle</type> defines the kind of lines used to draw + /** The HatchStyle defines the kind of lines used to draw this hatch. */ com::sun::star::drawing::HatchStyle Style; diff --git a/offapi/com/sun/star/drawing/HatchStyle.idl b/offapi/com/sun/star/drawing/HatchStyle.idl index b274880a65f1..e254379905f8 100644 --- a/offapi/com/sun/star/drawing/HatchStyle.idl +++ b/offapi/com/sun/star/drawing/HatchStyle.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>HatchStyle</type> defines the style of the lines in a hatch. +/** The HatchStyle defines the style of the lines in a hatch. */ published enum HatchStyle { diff --git a/offapi/com/sun/star/drawing/HatchTable.idl b/offapi/com/sun/star/drawing/HatchTable.idl index 59c799834822..9e709c1cf52b 100644 --- a/offapi/com/sun/star/drawing/HatchTable.idl +++ b/offapi/com/sun/star/drawing/HatchTable.idl @@ -25,9 +25,9 @@ module com { module sun { module star { module drawing { -/** this is a container for <type>Hatch</type>s +/** this is a container for Hatchs - <p>It is used for example to access the <type>Hatch</type>s that + <p>It is used for example to access the Hatchs that are used inside a document. @see DrawingDocumentFactory @@ -35,7 +35,7 @@ */ published service HatchTable { - /** this container lets you access the <type>Hatch</type>s that + /** this container lets you access the Hatchs that are indexed with a name. <p>Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/HomogenMatrixLine.idl b/offapi/com/sun/star/drawing/HomogenMatrixLine.idl index 0af612541c38..2a3063366d26 100644 --- a/offapi/com/sun/star/drawing/HomogenMatrixLine.idl +++ b/offapi/com/sun/star/drawing/HomogenMatrixLine.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** specifies a single line for a <type>HomogenMatrix</type>. +/** specifies a single line for a HomogenMatrix. */ published struct HomogenMatrixLine { diff --git a/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl b/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl index c28f7b18efc9..607e800fd513 100644 --- a/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl +++ b/offapi/com/sun/star/drawing/HomogenMatrixLine3.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { -/** specifies a single line for a <type>HomogenMatrix3</type>. +/** specifies a single line for a HomogenMatrix3. */ published struct HomogenMatrixLine3 { diff --git a/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl b/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl index 0d68f94efafc..52c97fa5d062 100644 --- a/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl +++ b/offapi/com/sun/star/drawing/HomogenMatrixLine4.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { -/** specifies a single line for a <type>HomogenMatrix4</type>. +/** specifies a single line for a HomogenMatrix4. */ published struct HomogenMatrixLine4 { diff --git a/offapi/com/sun/star/drawing/HorizontalDimensioning.idl b/offapi/com/sun/star/drawing/HorizontalDimensioning.idl index 4a01570254e3..4e083b2d4f85 100644 --- a/offapi/com/sun/star/drawing/HorizontalDimensioning.idl +++ b/offapi/com/sun/star/drawing/HorizontalDimensioning.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>HorizontalDimensioning</type> specifies the horizontal position +/** The HorizontalDimensioning specifies the horizontal position of the text of a dimensioning shape. */ published enum HorizontalDimensioning diff --git a/offapi/com/sun/star/drawing/Layer.idl b/offapi/com/sun/star/drawing/Layer.idl index 8d7d0b30175b..32dcde6e613e 100644 --- a/offapi/com/sun/star/drawing/Layer.idl +++ b/offapi/com/sun/star/drawing/Layer.idl @@ -28,11 +28,11 @@ /** A layer is an entity inside a document which contains shapes. - <p>There could be zero or more <type>Shape</type>s attached to + <p>There could be zero or more Shapes attached to such a layer. </p> - <p>The properties of a <type>Layer</type> instance affect all <type>Shape</type>s + <p>The properties of a Layer instance affect all Shapes attached to the Layer. </p> @@ -43,28 +43,28 @@ published service Layer { - /** The properties in this set affect all <type>Shape</type>s attached to + /** The properties in this set affect all Shapes attached to this Layer. */ interface com::sun::star::beans::XPropertySet; - /** The name of a <type>Layer</type> is used to identify the - <type>Layer</type> in the user interface. + /** The name of a Layer is used to identify the + Layer in the user interface. */ [property] string Name; - /** If a <type>Layer</type> is not visible, the objects in this - <type>Layer</type> are not shown in the user interface. + /** If a Layer is not visible, the objects in this + Layer are not shown in the user interface. */ [property] boolean IsVisible; - /** If a <type>Layer</type> is not printable, the objects in - this <type>Layer</type> are not printed. + /** If a Layer is not printable, the objects in + this Layer are not printed. */ [property] boolean IsPrintable; - /** If a <type>Layer</type> is locked, the objects in this - <type>Layer</type> cannot be edited in the user interface. + /** If a Layer is locked, the objects in this + Layer cannot be edited in the user interface. */ [property] boolean IsLocked; diff --git a/offapi/com/sun/star/drawing/LayerManager.idl b/offapi/com/sun/star/drawing/LayerManager.idl index d58241015f08..0bbf88f94862 100644 --- a/offapi/com/sun/star/drawing/LayerManager.idl +++ b/offapi/com/sun/star/drawing/LayerManager.idl @@ -27,26 +27,26 @@ module com { module sun { module star { module drawing { -/** This service is provided by documents to support <type>Layer</type>s. +/** This service is provided by documents to support Layers. @see DrawingDocument */ published service LayerManager { - /** gives you access to the existing <type>Layer</type>s by - index and makes it possible to add and remove <type>Layer</type>s and - to attach <type>Shape</type>s to <type>Layer</type>s. + /** gives you access to the existing Layers by + index and makes it possible to add and remove Layers and + to attach Shapes to Layers. - <p>The contents of the collection all support <type>Layer</type> - returned by <type>XLayer</type>. + <p>The contents of the collection all support Layer + returned by XLayer. */ interface com::sun::star::drawing::XLayerManager; - /** gives access to the existing <type>Layer</type>s by name. + /** gives access to the existing Layers by name. - <p>The contents of the collection all support <type>Layer</type> - returned by <type>XLayer</type>. + <p>The contents of the collection all support Layer + returned by XLayer. */ interface com::sun::star::container::XNameAccess; diff --git a/offapi/com/sun/star/drawing/LineCap.idl b/offapi/com/sun/star/drawing/LineCap.idl index b5dd5e78e399..a0bac79072f2 100644 --- a/offapi/com/sun/star/drawing/LineCap.idl +++ b/offapi/com/sun/star/drawing/LineCap.idl @@ -22,7 +22,7 @@ //============================================================================= module com { module sun { module star { module drawing { -/** The <type>LineCap</type> defines rendering of ends of thick lines +/** The LineCap defines rendering of ends of thick lines */ published enum LineCap { diff --git a/offapi/com/sun/star/drawing/LineDash.idl b/offapi/com/sun/star/drawing/LineDash.idl index 1633895c2553..ea0dd48f4ea0 100644 --- a/offapi/com/sun/star/drawing/LineDash.idl +++ b/offapi/com/sun/star/drawing/LineDash.idl @@ -25,15 +25,15 @@ module com { module sun { module star { module drawing { -/** A <type>LineDash</type> defines a non-continuous line. +/** A LineDash defines a non-continuous line. */ published struct LineDash { - /** This sets the style of this <type>LineDash</type>. + /** This sets the style of this LineDash. */ com::sun::star::drawing::DashStyle Style; - /** This is the number of dots in this <type>LineDash</type>. + /** This is the number of dots in this LineDash. */ short Dots; diff --git a/offapi/com/sun/star/drawing/LineEndType.idl b/offapi/com/sun/star/drawing/LineEndType.idl index 5bfe4298e807..cf817f7bfcf2 100644 --- a/offapi/com/sun/star/drawing/LineEndType.idl +++ b/offapi/com/sun/star/drawing/LineEndType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>LineEndType</type> specifies the appearance of the bullet at the +/** The LineEndType specifies the appearance of the bullet at the end of a line. @deprecated diff --git a/offapi/com/sun/star/drawing/LineJoint.idl b/offapi/com/sun/star/drawing/LineJoint.idl index f51f1b9f8934..276ddd7e9752 100644 --- a/offapi/com/sun/star/drawing/LineJoint.idl +++ b/offapi/com/sun/star/drawing/LineJoint.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>LineJoint</type> defines rendering of joints between thick lines +/** The LineJoint defines rendering of joints between thick lines */ published enum LineJoint { diff --git a/offapi/com/sun/star/drawing/LineShape.idl b/offapi/com/sun/star/drawing/LineShape.idl index 7cfdd1046cbb..24672c2342cf 100644 --- a/offapi/com/sun/star/drawing/LineShape.idl +++ b/offapi/com/sun/star/drawing/LineShape.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module drawing { -/** This service is for a simple <type>Shape</type> with lines. +/** This service is for a simple Shape with lines. */ published service LineShape { diff --git a/offapi/com/sun/star/drawing/MarkerTable.idl b/offapi/com/sun/star/drawing/MarkerTable.idl index fa8a7e6354d1..fe4761407035 100644 --- a/offapi/com/sun/star/drawing/MarkerTable.idl +++ b/offapi/com/sun/star/drawing/MarkerTable.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** this is a container for <type>PointSequence</type>s +/** this is a container for PointSequences <p>It is used for example to access the line ends that are used inside a document. @@ -35,7 +35,7 @@ */ published service MarkerTable { - /** this container lets you access the <type>PointSequence</type>s that + /** this container lets you access the PointSequences that are indexed with a name. <p>Note: You can add new entries for later use, but you cannot diff --git a/offapi/com/sun/star/drawing/MasterPage.idl b/offapi/com/sun/star/drawing/MasterPage.idl index 8f92600828ce..db99527ff964 100644 --- a/offapi/com/sun/star/drawing/MasterPage.idl +++ b/offapi/com/sun/star/drawing/MasterPage.idl @@ -28,18 +28,18 @@ /** This service is a single master page inside a drawing document. - <p>It serves as a background page for zero or more <type>DrawPage</type>s. - Since this service is derived from the service <type>GenericDrawPage</type>, + <p>It serves as a background page for zero or more DrawPages. + Since this service is derived from the service GenericDrawPage, it can be used as a draw page with three differences: </p> <ol> - <li>It is not linked to any other <type>MasterPage</type>. + <li>It is not linked to any other MasterPage. </li> <li>It cannot be removed from a document as long as one or - more instances of <type>DrawPage</type> are linked to it. + more instances of DrawPage are linked to it. </li> - <li>Modifications to a <type>MasterPage</type> are instantly visible on - every <type>DrawPage</type> that is linked to it. + <li>Modifications to a MasterPage are instantly visible on + every DrawPage that is linked to it. </li> </ol> */ diff --git a/offapi/com/sun/star/drawing/MasterPages.idl b/offapi/com/sun/star/drawing/MasterPages.idl index a10d26d1eadb..989c1c436cf1 100644 --- a/offapi/com/sun/star/drawing/MasterPages.idl +++ b/offapi/com/sun/star/drawing/MasterPages.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** provides access to a container of <type>MasterPage</type>s +/** provides access to a container of MasterPages and makes it possible for them to be manipulated. @see XMasterPagesSupplier @@ -34,7 +34,7 @@ */ published service MasterPages { - /** lets you access and create <type>MasterPage</type>s + /** lets you access and create MasterPages */ interface com::sun::star::drawing::XDrawPages; diff --git a/offapi/com/sun/star/drawing/MeasureProperties.idl b/offapi/com/sun/star/drawing/MeasureProperties.idl index 2cac68d3f3af..0e9b87f6e4be 100644 --- a/offapi/com/sun/star/drawing/MeasureProperties.idl +++ b/offapi/com/sun/star/drawing/MeasureProperties.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module drawing { -/** This service describes a <type>MeasureShape</type>. +/** This service describes a MeasureShape. */ published service MeasureProperties { @@ -56,7 +56,7 @@ published service MeasureProperties */ [property] long MeasureHelpLineOverhang; - /** This enumeration specifies the <type>MeasureKind</type>. + /** This enumeration specifies the MeasureKind. */ [property] com::sun::star::drawing::MeasureKind MeasureKind; diff --git a/offapi/com/sun/star/drawing/PluginShape.idl b/offapi/com/sun/star/drawing/PluginShape.idl index 0a5f14d32263..5dbaf86c0aaf 100644 --- a/offapi/com/sun/star/drawing/PluginShape.idl +++ b/offapi/com/sun/star/drawing/PluginShape.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { -/** This <type>Shape</type> encapsulates a plugin. +/** This Shape encapsulates a plugin. <p>A plugin is a binary object that is plugged into a document to represent a media-type that is not handled natively by the application. @@ -34,7 +34,7 @@ published service PluginShape { /** basic service for position, size and z-order. - <p>A <type>PluginShape</type> cannot be rotated. + <p>A PluginShape cannot be rotated. */ service com::sun::star::drawing::Shape; diff --git a/offapi/com/sun/star/drawing/RectangleShape.idl b/offapi/com/sun/star/drawing/RectangleShape.idl index ffdca52e35d8..1b186580188a 100644 --- a/offapi/com/sun/star/drawing/RectangleShape.idl +++ b/offapi/com/sun/star/drawing/RectangleShape.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module drawing { -/** This service is for a rectangle <type>Shape</type>. +/** This service is for a rectangle Shape. */ published service RectangleShape { @@ -52,7 +52,7 @@ published service RectangleShape service com::sun::star::drawing::RotationDescriptor; - /** For <type>Shape</type>s with rounded corners, this is the radius + /** For Shapes with rounded corners, this is the radius of the corners. */ [property] long CornerRadius; diff --git a/offapi/com/sun/star/drawing/RotationDescriptor.idl b/offapi/com/sun/star/drawing/RotationDescriptor.idl index e183fe0038a1..1697053e88be 100644 --- a/offapi/com/sun/star/drawing/RotationDescriptor.idl +++ b/offapi/com/sun/star/drawing/RotationDescriptor.idl @@ -25,30 +25,30 @@ /** This abstract service specifies the general characteristics of an optional - rotation and shearing for a <type>Shape</type>. + rotation and shearing for a Shape. This service is deprecated, instead please use the <code>Transformation</code> - property of the service <type>Shape</type>. + property of the service Shape. @deprecated */ published service RotationDescriptor { - /** This is the angle for rotation of this <type>Shape</type>. + /** This is the angle for rotation of this Shape. The shape is rotated counter-clockwise around the center of the bounding box. This property contains an error, the rotation angle is mathematically inverted when You take into account that the Y-Axis of the coordinate system is pointing down. Please use the <code>Transformation</code> - property of the service <type>Shape</type> instead. + property of the service Shape instead. @deprecated */ [property] long RotateAngle; - /** This is the amount of shearing for this <type>Shape</type>. + /** This is the amount of shearing for this Shape. The shape is sheared counter-clockwise around the center of the bounding box diff --git a/offapi/com/sun/star/drawing/ShadeMode.idl b/offapi/com/sun/star/drawing/ShadeMode.idl index 50fc0b127386..6a6c2fe88e26 100644 --- a/offapi/com/sun/star/drawing/ShadeMode.idl +++ b/offapi/com/sun/star/drawing/ShadeMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>ShadeMode</type> determines the quality of displaying the object. +/** The ShadeMode determines the quality of displaying the object. */ published enum ShadeMode { diff --git a/offapi/com/sun/star/drawing/ShadowProperties.idl b/offapi/com/sun/star/drawing/ShadowProperties.idl index 838a9f5322d1..f0d783966730 100644 --- a/offapi/com/sun/star/drawing/ShadowProperties.idl +++ b/offapi/com/sun/star/drawing/ShadowProperties.idl @@ -31,14 +31,14 @@ published service ShadowProperties { - /** enables/disables the shadow of a <type>Shape</type>. + /** enables/disables the shadow of a Shape. <p>The other shadow properties are only applied if this is set to <TRUE/>.</p> */ [property] boolean Shadow; - /** This is the color of the shadow of this <type>Shape</type>. + /** This is the color of the shadow of this Shape. */ [property] com::sun::star::util::Color ShadowColor; @@ -49,13 +49,13 @@ published service ShadowProperties /** This is the horizontal distance of the left edge of the - <type>Shape</type> to the shadow. + Shape to the shadow. */ [property] long ShadowXDistance; /** This is the vertical distance of the top edge of the - <type>Shape</type> to the shadow. + Shape to the shadow. */ [property] long ShadowYDistance; diff --git a/offapi/com/sun/star/drawing/Shape.idl b/offapi/com/sun/star/drawing/Shape.idl index ded92712bb9a..3f7b16d32946 100644 --- a/offapi/com/sun/star/drawing/Shape.idl +++ b/offapi/com/sun/star/drawing/Shape.idl @@ -33,7 +33,7 @@ /** This abstract service specifies the general characteristics of all - <type>Shape</type>s. + Shapes. @see XShape @see com::sun::star::lang::XComponent @@ -48,20 +48,20 @@ published service Shape interface com::sun::star::beans::XPropertySet; - /** This gives you the size and position of this <type>Shape</type> + /** This gives you the size and position of this Shape and lets you change it. You can use <member>getShapeType</member> to determine what kind of shape this is. */ interface com::sun::star::drawing::XShape; - /** is used for lifetime control of this <type>Shape</type>. + /** is used for lifetime control of this Shape. */ interface com::sun::star::lang::XComponent; - /** The <type>XShapeDescriptor</type> tells you what kind of - <type>Shape</type> this instance is. + /** The XShapeDescriptor tells you what kind of + Shape this instance is. */ interface com::sun::star::drawing::XShapeDescriptor; @@ -76,47 +76,47 @@ published service Shape [optional] interface com::sun::star::beans::XTolerantMultiPropertySet; - /** is used to query or change the ZOrder of this <type>Shape</type>. */ + /** is used to query or change the ZOrder of this Shape. */ [optional, property] long ZOrder; - /** This is the ID of the <type>Layer</type> to which this - <type>Shape</type> is attached. + /** This is the ID of the Layer to which this + Shape is attached. */ [optional, property] short LayerID; - /** This is the name of the <type>Layer</type> to which this - <type>Shape</type> is attached. + /** This is the name of the Layer to which this + Shape is attached. */ [optional, property] string LayerName; - /** If this is <FALSE/>, the <type>Shape</type> is not visible - on screen outputs. Please note that the <type>Shape</type> may still + /** If this is <FALSE/>, the Shape is not visible + on screen outputs. Please note that the Shape may still be visible when printed, see <member>Printable</member>. */ [optional, property] boolean Visible; - /** If this is <FALSE/>, the <type>Shape</type> is not visible + /** If this is <FALSE/>, the Shape is not visible on printer outputs. */ [optional, property] boolean Printable; - /** With this set to <TRUE/>, this <type>Shape</type> + /** With this set to <TRUE/>, this Shape cannot be moved interactively in the user interface. */ [optional, property] boolean MoveProtect; - /** This is the name of this <type>Shape</type>. + /** This is the name of this Shape. */ [optional, property] string Name; - /** With this set to <TRUE/>, this <type>Shape</type> may not be + /** With this set to <TRUE/>, this Shape may not be sized interactively in the user interface. */ [optional, property] boolean SizeProtect; diff --git a/offapi/com/sun/star/drawing/ShapeCollection.idl b/offapi/com/sun/star/drawing/ShapeCollection.idl index b126177458dd..38acd173c3de 100644 --- a/offapi/com/sun/star/drawing/ShapeCollection.idl +++ b/offapi/com/sun/star/drawing/ShapeCollection.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module drawing { /** This service describes a generic container to manage collections of - <type>Shape</type>. The <type>Shape</type> that are added to this + Shape. The Shape that are added to this collection are not owned by the collection. This service is used by the view f.e. to return a collection of - <type>Shape</type> that are selected at the ui. + Shape that are selected at the ui. */ published service ShapeCollection : com::sun::star::drawing::XShapes; diff --git a/offapi/com/sun/star/drawing/Text.idl b/offapi/com/sun/star/drawing/Text.idl index dbc4e98902af..0749c4610a10 100644 --- a/offapi/com/sun/star/drawing/Text.idl +++ b/offapi/com/sun/star/drawing/Text.idl @@ -28,7 +28,7 @@ /** This abstract service specifies the general characteristics of an optional - text inside a <type>Shape</type>. + text inside a Shape. */ published service Text { diff --git a/offapi/com/sun/star/drawing/TextProperties.idl b/offapi/com/sun/star/drawing/TextProperties.idl index ddde3987cf88..6cb102034e52 100644 --- a/offapi/com/sun/star/drawing/TextProperties.idl +++ b/offapi/com/sun/star/drawing/TextProperties.idl @@ -52,42 +52,42 @@ published service TextProperties { /** The properties in this service set default formats for text - inside the <type>Shape</type>. + inside the Shape. */ service com::sun::star::style::CharacterProperties; /** The properties in this service set default formats for Asian text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::CharacterPropertiesAsian; /** The properties in this service set default formats for complex text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::CharacterPropertiesComplex; /** The properties in this service set default formats for text - inside the <type>Shape</type>. + inside the Shape. */ service com::sun::star::style::ParagraphProperties; /** The properties in this service set default formats for Asian text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::ParagraphPropertiesAsian; /** The properties in this service set default formats for complex text - inside the <type>Shape</type>. + inside the Shape. */ [optional] service com::sun::star::style::ParagraphPropertiesComplex; /** If this is <TRUE/>, numbering is ON for the text of - this <type>Shape</type>. + this Shape. */ [optional, property] boolean IsNumbering; @@ -101,44 +101,44 @@ published service TextProperties [optional, property] com::sun::star::container::XIndexReplace NumberingRules; - /** If this value is <TRUE/>, the height of the <type>Shape</type> is + /** If this value is <TRUE/>, the height of the Shape is automatically expanded/shrunk when text is added to or removed from - the <type>Shape</type>. + the Shape. */ [property] boolean TextAutoGrowHeight; - /** If this value is <TRUE/>, the width of the <type>Shape</type> is + /** If this value is <TRUE/>, the width of the Shape is automatically expanded/shrunk when text is added to or removed from - the <type>Shape</type>. + the Shape. */ [property] boolean TextAutoGrowWidth; /** If this value is <TRUE/>, the left edge of every line of text is - aligned with the left edge of this <type>Shape</type>. + aligned with the left edge of this Shape. */ [property] boolean TextContourFrame; - /** With this set to <TRUE/>, the text inside of the <type>Shape</type> - is stretched to fit into the <type>Shape</type>. + /** With this set to <TRUE/>, the text inside of the Shape + is stretched to fit into the Shape. */ [property] com::sun::star::drawing::TextFitToSizeType TextFitToSize; /** adjusts the horizontal position of the text inside of - the <type>Shape</type>. + the Shape. */ [property] com::sun::star::drawing::TextHorizontalAdjust TextHorizontalAdjust; /** adjusts the vertical position of the text inside of - the <type>Shape</type>. + the Shape. */ [property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust; - /** This is the distance from the left edge of the <type>Shape</type> + /** This is the distance from the left edge of the Shape to the left edge of the text. <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is <const>BLOCK</const> or <const>STRETCH</const> or if @@ -147,7 +147,7 @@ published service TextProperties [property] long TextLeftDistance; - /** This is the distance from the right edge of the <type>Shape</type> + /** This is the distance from the right edge of the Shape to the right edge of the text. <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is @@ -157,7 +157,7 @@ published service TextProperties [property] long TextRightDistance; - /** This is the distance from the upper edge of the <type>Shape</type> to + /** This is the distance from the upper edge of the Shape to the upper edge of the text. <p>This is only useful if <member>Text::TextVerticalAdjust</member> is @@ -167,7 +167,7 @@ published service TextProperties [property] long TextUpperDistance; - /** This is the distance from the lower edge of the <type>Shape</type> to the + /** This is the distance from the lower edge of the Shape to the lower edge of the text. diff --git a/offapi/com/sun/star/drawing/TextureKind.idl b/offapi/com/sun/star/drawing/TextureKind.idl index 26df3ddd1d15..5d2e0e19ba66 100644 --- a/offapi/com/sun/star/drawing/TextureKind.idl +++ b/offapi/com/sun/star/drawing/TextureKind.idl @@ -28,7 +28,7 @@ */ published enum TextureKind { - /** With <type>TextureKind</type> <const>LUMINANCE</const>, the texture + /** With TextureKind <const>LUMINANCE</const>, the texture and the lighting information are mixed to produce the image, so a lit, textured object is achieved. */ diff --git a/offapi/com/sun/star/drawing/TextureKind2.idl b/offapi/com/sun/star/drawing/TextureKind2.idl index a0ac83cdc9b7..9b49a967ef64 100644 --- a/offapi/com/sun/star/drawing/TextureKind2.idl +++ b/offapi/com/sun/star/drawing/TextureKind2.idl @@ -29,13 +29,13 @@ published enum TextureKind2 { - /** With <type>TextureKind</type> <const>LUMINANCE</const>, the texture + /** With TextureKind <const>LUMINANCE</const>, the texture and the lighting information are mixed to produce the image, so a lit, textured object is achieved. */ LUMINANCE, - /** With <type>TextureKind</type> <const>INTENSITY</const>, each texture + /** With TextureKind <const>INTENSITY</const>, each texture pixel is used as an intensity value. */ INTENSITY, diff --git a/offapi/com/sun/star/drawing/TextureMode.idl b/offapi/com/sun/star/drawing/TextureMode.idl index 1aa72debd0c8..31f39869fe60 100644 --- a/offapi/com/sun/star/drawing/TextureMode.idl +++ b/offapi/com/sun/star/drawing/TextureMode.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module drawing { -/** The <type>TextureMode</type> defines in which way the texture color data +/** The TextureMode defines in which way the texture color data replaces the object color data. */ published enum TextureMode diff --git a/offapi/com/sun/star/drawing/XConnectorShape.idl b/offapi/com/sun/star/drawing/XConnectorShape.idl index 299634b90aab..9e89224860bb 100644 --- a/offapi/com/sun/star/drawing/XConnectorShape.idl +++ b/offapi/com/sun/star/drawing/XConnectorShape.idl @@ -44,12 +44,12 @@ published interface XConnectorShape: com::sun::star::drawing::XShape void connectEnd( [in] com::sun::star::drawing::XConnectableShape xShape, [in] com::sun::star::drawing::ConnectionType nPos ); - /** disconnects the given <type>Shape</type> from the start of + /** disconnects the given Shape from the start of this instance. */ void disconnectBegin( [in] com::sun::star::drawing::XConnectableShape xShape ); - /** disconnects the given <type>Shape</type> from the end of + /** disconnects the given Shape from the end of this instance. */ void disconnectEnd( [in] com::sun::star::drawing::XConnectableShape xShape ); diff --git a/offapi/com/sun/star/drawing/XControlShape.idl b/offapi/com/sun/star/drawing/XControlShape.idl index f4ab56a02248..11d64077992b 100644 --- a/offapi/com/sun/star/drawing/XControlShape.idl +++ b/offapi/com/sun/star/drawing/XControlShape.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** is implemented by a <type>ControlShape</type> to access the controls model. +/** is implemented by a ControlShape to access the controls model. @see com::sun::star::drawing::ControlShape @see com::sun::star::awt::UnoControlModel @@ -36,23 +36,23 @@ published interface XControlShape: com::sun::star::drawing::XShape { - /** returns the control model of this <type>Shape</type>. + /** returns the control model of this Shape. @return if there is already a control model assigned - to this <type>ControlShape</type>, than its returned. + to this ControlShape, than its returned. Otherwise you get an empty reference. */ com::sun::star::awt::XControlModel getControl(); - /** sets the control model for this <type>Shape</type>. + /** sets the control model for this Shape. @param xControl this will be the new control model that is displayed with this shape. You may change the model more than once during the lifetime - of a <type>ControlShape</type> + of a ControlShape */ void setControl( [in] com::sun::star::awt::XControlModel xControl ); diff --git a/offapi/com/sun/star/drawing/XDrawPage.idl b/offapi/com/sun/star/drawing/XDrawPage.idl index 897e17be770f..1ebf020e4f8d 100644 --- a/offapi/com/sun/star/drawing/XDrawPage.idl +++ b/offapi/com/sun/star/drawing/XDrawPage.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** identifies an <type>XShapes</type> as a <type>DrawPage</type>. +/** identifies an XShapes as a DrawPage. */ published interface XDrawPage: com::sun::star::drawing::XShapes { diff --git a/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl b/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl index 42ea2d5ff596..e1ee7014a138 100644 --- a/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl +++ b/offapi/com/sun/star/drawing/XDrawPageDuplicator.idl @@ -33,17 +33,17 @@ published interface XDrawPageDuplicator: com::sun::star::uno::XInterface { - /** creates a duplicate of a <type>DrawPage</type> or <type>MasterPage</type>, - including the <type>Shape</type>s on that page and inserts it into the + /** creates a duplicate of a DrawPage or MasterPage, + including the Shapes on that page and inserts it into the same model. @param xPage - that is the source <type>DrawPage</type> or <type>MasterPage</type> + that is the source DrawPage or MasterPage that will be duplicated @return - a newly created <type>DrawPage</type> or <type>MasterPage</type> - that as all properties and copies of all <type>Shape</type>s from + a newly created DrawPage or MasterPage + that as all properties and copies of all Shapes from the source page. */ com::sun::star::drawing::XDrawPage duplicate( [in] com::sun::star::drawing::XDrawPage xPage ); diff --git a/offapi/com/sun/star/drawing/XDrawPageExpander.idl b/offapi/com/sun/star/drawing/XDrawPageExpander.idl index 59c1127a94e1..383ca343dabf 100644 --- a/offapi/com/sun/star/drawing/XDrawPageExpander.idl +++ b/offapi/com/sun/star/drawing/XDrawPageExpander.idl @@ -31,8 +31,8 @@ /** is implemented by documents that can expand the contents - of a summary on a <type>DrawPage</type> into a collection of - <type>DrawPage</type>s. + of a summary on a DrawPage into a collection of + DrawPages. @see XDrawPageSummarizer @@ -41,9 +41,9 @@ published interface XDrawPageExpander: com::sun::star::uno::XInterface { - /** creates a collection of <type>DrawPage</type>s from the - summary inside the given <type>DrawPage</type> and adds - them to the same model as the source <type>DrawPage</type>. + /** creates a collection of DrawPages from the + summary inside the given DrawPage and adds + them to the same model as the source DrawPage. */ com::sun::star::drawing::XDrawPages expand( [in] com::sun::star::drawing::XDrawPage xPage ); diff --git a/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl b/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl index 3bb732743c01..5da5018aa06c 100644 --- a/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl +++ b/offapi/com/sun/star/drawing/XDrawPageSummarizer.idl @@ -30,14 +30,14 @@ module com { module sun { module star { module drawing { /** is implemented by documents that can create summaries - of their <type>DrawPage</type>s. + of their DrawPages. @deprecated */ published interface XDrawPageSummarizer: com::sun::star::uno::XInterface { - /** creates a new <type>DrawPage</type> with a summary of all - <type>DrawPage</type>s in the given collection. + /** creates a new DrawPage with a summary of all + DrawPages in the given collection. */ com::sun::star::drawing::XDrawPage summarize( [in] com::sun::star::drawing::XDrawPages xPages ); diff --git a/offapi/com/sun/star/drawing/XDrawPageSupplier.idl b/offapi/com/sun/star/drawing/XDrawPageSupplier.idl index f20bd9cdb155..6c4856986dfc 100644 --- a/offapi/com/sun/star/drawing/XDrawPageSupplier.idl +++ b/offapi/com/sun/star/drawing/XDrawPageSupplier.idl @@ -27,18 +27,18 @@ module com { module sun { module star { module drawing { -/** represents something that provides a <type>DrawPage</type>. +/** represents something that provides a DrawPage. <p>This interface is provided if the container only supports exactly - one <type>DrawPage</type>. For containers which support multiple - <type>DrawPage</type>s interface <type>XDrawPagesSupplier</type> is + one DrawPage. For containers which support multiple + DrawPages interface XDrawPagesSupplier is supported.</p> @deprecated */ published interface XDrawPageSupplier: com::sun::star::uno::XInterface { - /** returns the <type>DrawPage</type>. + /** returns the DrawPage. */ com::sun::star::drawing::XDrawPage getDrawPage(); diff --git a/offapi/com/sun/star/drawing/XDrawPages.idl b/offapi/com/sun/star/drawing/XDrawPages.idl index b5134d25c6ba..4ee185dd4549 100644 --- a/offapi/com/sun/star/drawing/XDrawPages.idl +++ b/offapi/com/sun/star/drawing/XDrawPages.idl @@ -28,37 +28,37 @@ module com { module sun { module star { module drawing { -/** gives access to a container of <type>DrawPage</type>s or <type>MasterPage</type>s. +/** gives access to a container of DrawPages or MasterPages. <p>The pages are stored in an index container. The order is determined by the index. You usually get this interface if you use the - <type>XDrawPagesSupplier</type> or the <type>XMasterPagesSupplier</type> - at a model that contains <type>DrawPage</type>s or <type>MasterPage</type>s + XDrawPagesSupplier or the XMasterPagesSupplier + at a model that contains DrawPages or MasterPages */ published interface XDrawPages: com::sun::star::container::XIndexAccess { - /** creates and inserts a new <type>DrawPage</type> or <type>MasterPage</type> + /** creates and inserts a new DrawPage or MasterPage into this container @param nIndex - the index at which the newly created <type>DrawPage</type> or - <type>MasterPage</type> will be inserted. + the index at which the newly created DrawPage or + MasterPage will be inserted. @return - the newly created and already inserted <type>DrawPage</type> or - <type>MasterPage</type>. + the newly created and already inserted DrawPage or + MasterPage. */ com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex ); - /** removes a <type>DrawPage</type> or <type>MasterPage</type> from this + /** removes a DrawPage or MasterPage from this container. @param xPage - this <type>DrawPage</type> or <type>MasterPage</type> must be + this DrawPage or MasterPage must be contained and will be removed from this container. It will also be disposed and shouldn't be used any further. */ diff --git a/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl b/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl index 32ba7da84401..33d21b137ce2 100644 --- a/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl +++ b/offapi/com/sun/star/drawing/XDrawPagesSupplier.idl @@ -34,7 +34,7 @@ published interface XDrawPagesSupplier: com::sun::star::uno::XInterface { /** @returns - an indexed container with the service <type>DrawPages</type>. + an indexed container with the service DrawPages. */ com::sun::star::drawing::XDrawPages getDrawPages(); diff --git a/offapi/com/sun/star/drawing/XDrawView.idl b/offapi/com/sun/star/drawing/XDrawView.idl index 6aa8cd08cb85..40ebfe024cf0 100644 --- a/offapi/com/sun/star/drawing/XDrawView.idl +++ b/offapi/com/sun/star/drawing/XDrawView.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** is implemented by views that display <type>DrawPage</type>s or <type>MasterPage</type>s. +/** is implemented by views that display DrawPages or MasterPages. */ published interface XDrawView: com::sun::star::uno::XInterface { @@ -36,7 +36,7 @@ published interface XDrawView: com::sun::star::uno::XInterface /** changes the current page. @param xPage - this <type>DrawPage</type> or <type>MasterPage</type> will be + this DrawPage or MasterPage will be displayed inside this view. */ void setCurrentPage( [in] com::sun::star::drawing::XDrawPage xPage ); @@ -45,7 +45,7 @@ published interface XDrawView: com::sun::star::uno::XInterface /** returns the current page. @return - the <type>DrawPage</type> or <type>MasterPage</type> that is + the DrawPage or MasterPage that is currently displayed. */ com::sun::star::drawing::XDrawPage getCurrentPage(); diff --git a/offapi/com/sun/star/drawing/XGluePointsSupplier.idl b/offapi/com/sun/star/drawing/XGluePointsSupplier.idl index 7343a414c40c..8e129ba12a64 100644 --- a/offapi/com/sun/star/drawing/XGluePointsSupplier.idl +++ b/offapi/com/sun/star/drawing/XGluePointsSupplier.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module drawing { -/** must be supported to provide access to a container of <type>GluePoint2</type>. +/** must be supported to provide access to a container of GluePoint2. */ published interface XGluePointsSupplier: com::sun::star::uno::XInterface { /** @return - a container of <type>GluePoint2</type> structs. + a container of GluePoint2 structs. */ com::sun::star::container::XIndexContainer getGluePoints(); diff --git a/offapi/com/sun/star/drawing/XGraphicExportFilter.idl b/offapi/com/sun/star/drawing/XGraphicExportFilter.idl index 81418c413221..8adff804d2bc 100644 --- a/offapi/com/sun/star/drawing/XGraphicExportFilter.idl +++ b/offapi/com/sun/star/drawing/XGraphicExportFilter.idl @@ -76,8 +76,8 @@ published interface XGraphicExportFilter interface ::com::sun::star::document::XFilter; /** sets the source component for this export filter. - <p>This could either be a <type>DrawPage</type>, a <type>Shape</type> - or a <type>Shapes</type>.</p> + <p>This could either be a DrawPage, a Shape + or a Shapes.</p> */ interface ::com::sun::star::document::XExporter; diff --git a/offapi/com/sun/star/drawing/XLayer.idl b/offapi/com/sun/star/drawing/XLayer.idl index b72ef53c8d8a..82933d37e8cc 100644 --- a/offapi/com/sun/star/drawing/XLayer.idl +++ b/offapi/com/sun/star/drawing/XLayer.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module drawing { -/** identifies the object as a <type>Layer</type>. +/** identifies the object as a Layer. */ published interface XLayer: com::sun::star::beans::XPropertySet { diff --git a/offapi/com/sun/star/drawing/XLayerManager.idl b/offapi/com/sun/star/drawing/XLayerManager.idl index c2f7539e1c12..58c0d4db00e3 100644 --- a/offapi/com/sun/star/drawing/XLayerManager.idl +++ b/offapi/com/sun/star/drawing/XLayerManager.idl @@ -33,53 +33,53 @@ /** This interface makes it possible to access and manage the - <type>Layer</type>s of a document. + Layers of a document. @see LayerManager */ published interface XLayerManager: com::sun::star::container::XIndexAccess { - /** creates a new <type>Layer</type> + /** creates a new Layer @param nIndex the index at which the new layer is inserted @returns - the new created <type>Layer</type> + the new created Layer */ com::sun::star::drawing::XLayer insertNewByIndex( [in] long nIndex ); - /** removes a <type>Layer</type> and all <type>Shape</type>s on - this <type>Layer</type>. + /** removes a Layer and all Shapes on + this Layer. @param xLayer - this <type>Layer</type> will be removed and disposed + this Layer will be removed and disposed */ void remove( [in] com::sun::star::drawing::XLayer xLayer ) raises( com::sun::star::container::NoSuchElementException ); - /** attaches a <type>Shape</type> to the given <type>Layer</type>. + /** attaches a Shape to the given Layer. @param xShape - this is the <type>Shape</type> that will be attached to a <type>Layer</type> + this is the Shape that will be attached to a Layer @param xLayer - this is the <type>Layer</type> that will be attached to a <type>Shape</type> + this is the Layer that will be attached to a Shape */ void attachShapeToLayer( [in] com::sun::star::drawing::XShape xShape, [in] com::sun::star::drawing::XLayer xLayer ); - /** queries the <type>Layer</type> that a <type>Shape</type> is attached to + /** queries the Layer that a Shape is attached to @param xShape - specifies the <type>Shape</type> for which the layer is requested. + specifies the Shape for which the layer is requested. @returns - the <type>Layer</type> to which the <type>Shape</type> is + the Layer to which the Shape is attached. */ diff --git a/offapi/com/sun/star/drawing/XLayerSupplier.idl b/offapi/com/sun/star/drawing/XLayerSupplier.idl index 416040904393..3e2bfe151247 100644 --- a/offapi/com/sun/star/drawing/XLayerSupplier.idl +++ b/offapi/com/sun/star/drawing/XLayerSupplier.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module drawing { -/** gives access to a <type>LayerManager</type>. +/** gives access to a LayerManager. @see LayerManager */ @@ -36,7 +36,7 @@ published interface XLayerSupplier: com::sun::star::uno::XInterface { /** @returns - the <type>LayerManager</type>. + the LayerManager. */ com::sun::star::container::XNameAccess getLayerManager(); diff --git a/offapi/com/sun/star/drawing/XMasterPageTarget.idl b/offapi/com/sun/star/drawing/XMasterPageTarget.idl index 63246307f875..849a339eef7b 100644 --- a/offapi/com/sun/star/drawing/XMasterPageTarget.idl +++ b/offapi/com/sun/star/drawing/XMasterPageTarget.idl @@ -29,22 +29,22 @@ /** is implemented by objects that can be linked to a - <type>MasterPage</type>. + MasterPage. @see DrawPage */ published interface XMasterPageTarget: com::sun::star::uno::XInterface { - /** @returns the <type>MasterPage</type> linked to this object. + /** @returns the MasterPage linked to this object. */ com::sun::star::drawing::XDrawPage getMasterPage(); - /** links a <type>MasterPage</type> to this object. + /** links a MasterPage to this object. @param xMasterPage - the <type>MasterPage</type> that is linked to this object + the MasterPage that is linked to this object */ void setMasterPage( [in] com::sun::star::drawing::XDrawPage xMasterPage ); diff --git a/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl b/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl index fe05296ccdae..74d3474d1ab0 100644 --- a/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl +++ b/offapi/com/sun/star/drawing/XMasterPagesSupplier.idl @@ -29,13 +29,13 @@ /** must be supported to provide access to the - <type>MasterPage</type>s of a multi-page drawing-layer. + MasterPages of a multi-page drawing-layer. */ published interface XMasterPagesSupplier: com::sun::star::uno::XInterface { /** @returns - an indexed container with the service <type>MasterPages</type>. + an indexed container with the service MasterPages. */ com::sun::star::drawing::XDrawPages getMasterPages(); diff --git a/offapi/com/sun/star/drawing/XPresenterHelper.idl b/offapi/com/sun/star/drawing/XPresenterHelper.idl index 6d40c6af3c9b..12f1bc25457b 100644 --- a/offapi/com/sun/star/drawing/XPresenterHelper.idl +++ b/offapi/com/sun/star/drawing/XPresenterHelper.idl @@ -92,7 +92,7 @@ interface XPresenterHelper The canvas is created for this window. Must not be <NULL/> @param nRequestedCanvasFeatureList List of requested features that the new canvas should (has to) - provide. Use only values from the <type>CanvasFeature</type> + provide. Use only values from the CanvasFeature constants group. @param sOptionalCanvasServiceName When an explicit service name is given then a new object of this diff --git a/offapi/com/sun/star/drawing/XShape.idl b/offapi/com/sun/star/drawing/XShape.idl index 2af303f9e809..6be9c01c50d9 100644 --- a/offapi/com/sun/star/drawing/XShape.idl +++ b/offapi/com/sun/star/drawing/XShape.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module drawing { -/** lets you do a basic transformation on a <type>Shape</type> and +/** lets you do a basic transformation on a Shape and get its type. */ published interface XShape: com::sun::star::drawing::XShapeDescriptor diff --git a/offapi/com/sun/star/drawing/XShapeAligner.idl b/offapi/com/sun/star/drawing/XShapeAligner.idl index 97642697dbb0..b667b4b7bcd2 100644 --- a/offapi/com/sun/star/drawing/XShapeAligner.idl +++ b/offapi/com/sun/star/drawing/XShapeAligner.idl @@ -30,13 +30,13 @@ module com { module sun { module star { module drawing { /** Objects implementing this interface can be used to align - <type>Shape</type>s. + Shapes. @deprecated */ published interface XShapeAligner: com::sun::star::uno::XInterface { - /** aligns the specified <type>Shape</type>s. + /** aligns the specified Shapes. */ void alignShapes( [inout] com::sun::star::drawing::XShapes aShapes, [in] com::sun::star::drawing::Alignment eType ); diff --git a/offapi/com/sun/star/drawing/XShapeArranger.idl b/offapi/com/sun/star/drawing/XShapeArranger.idl index 742a0b84d3ec..8079ffd3ba9e 100644 --- a/offapi/com/sun/star/drawing/XShapeArranger.idl +++ b/offapi/com/sun/star/drawing/XShapeArranger.idl @@ -32,44 +32,44 @@ module com { module sun { module star { module drawing { /** Objects implementing this interface can be used to arrange - <type>Shape</type>s. + Shapes. @deprecated */ published interface XShapeArranger: com::sun::star::uno::XInterface { - /** applies the specified <type>Arrangement</type> to - the specified collection of <type>Shape</type>s. + /** applies the specified Arrangement to + the specified collection of Shapes. */ void arrange( [in] com::sun::star::drawing::XShapes xShapes, [in] com::sun::star::drawing::Arrangement eType ); - /** moves the specified <type>Shape</type>s by a specified number + /** moves the specified Shapes by a specified number of objects more to the front. */ void bringToFront( [in] com::sun::star::drawing::XShapes xShapes, [in] short nSteps ); - /** moves the specified <type>Shape</type>s + /** moves the specified Shapes <var>nSteps</var> objects more to the back. */ void sendToBack( [in] com::sun::star::drawing::XShapes xShapes, [in] short nSteps ); - /** moves the specified collection of <type>Shape</type>s - behind the specified single <type>Shape</type>. + /** moves the specified collection of Shapes + behind the specified single Shape. */ void setBehindShape( [in] com::sun::star::drawing::XShapes xShapes, [in] com::sun::star::drawing::XShape xShape ); - /** moves the specified collection of <type>Shape</type>s in - front of the specified single <type>Shape</type>. + /** moves the specified collection of Shapes in + front of the specified single Shape. */ void setInFrontOf( [in] com::sun::star::drawing::XShapes xShapes, [in] com::sun::star::drawing::XShape xShape ); /** reverses the order of the specified collection of - <type>Shape</type>s. + Shapes. */ void reverseOrder( [in] com::sun::star::drawing::XShapes xShapes ); diff --git a/offapi/com/sun/star/drawing/XShapeBinder.idl b/offapi/com/sun/star/drawing/XShapeBinder.idl index bb56bdecaa78..92f4acce80e4 100644 --- a/offapi/com/sun/star/drawing/XShapeBinder.idl +++ b/offapi/com/sun/star/drawing/XShapeBinder.idl @@ -30,34 +30,34 @@ module com { module sun { module star { module drawing { -/** connects or breaks the lines of <type>Shape</type>s +/** connects or breaks the lines of Shapes */ published interface XShapeBinder: com::sun::star::uno::XInterface { - /** binds <type>Shape</type>s together. + /** binds Shapes together. @param xShapes - a container with <type>Shape</type>s that will be bind together. - All <type>Shapes</type> will be converted to a <type>PolyPolygonBezierShape</type> + a container with Shapes that will be bind together. + All Shapes will be converted to a PolyPolygonBezierShape and the lines will be connected. The <type>Shape</types>s in xShape will be - removed from the <type>GenericDrawPage</type> and disposed. + removed from the GenericDrawPage and disposed. @returns - a newly created <type>PolyPolygonBezierShape</type> which contains all - line segment from the supplied <type>Shape</type>s. It is also added - to the <type>GenericDrawPage</type> of the source <type>Shape</type>s. + a newly created PolyPolygonBezierShape which contains all + line segment from the supplied Shapes. It is also added + to the GenericDrawPage of the source Shapes. */ com::sun::star::drawing::XShape bind( [in] com::sun::star::drawing::XShapes xShapes ); - /** breaks a <type>Shape</type> into its line segments + /** breaks a Shape into its line segments @param xShape - the given <type>Shape</type> will be converted to a <type>PolyPolygonBezierShape</type> - and the line segments of this <type>Shape</type> will be used to create - new <type>PolyPolygonBezierShape</type> shapes. The original <type>Shape</type> - will be removed from its <type>GenericDrawPage</type> and disposed. + the given Shape will be converted to a PolyPolygonBezierShape + and the line segments of this Shape will be used to create + new PolyPolygonBezierShape shapes. The original Shape + will be removed from its GenericDrawPage and disposed. */ void unbind( [in] com::sun::star::drawing::XShape xShape ); diff --git a/offapi/com/sun/star/drawing/XShapeCombiner.idl b/offapi/com/sun/star/drawing/XShapeCombiner.idl index 299335d6261b..9940fc3c6421 100644 --- a/offapi/com/sun/star/drawing/XShapeCombiner.idl +++ b/offapi/com/sun/star/drawing/XShapeCombiner.idl @@ -35,32 +35,32 @@ published interface XShapeCombiner: com::sun::star::uno::XInterface { - /** combines <type>Shape</type>s + /** combines Shapes @param xShapes - the <type>Shape</type>s inside this container are converted - to <type>PolyPolygonBezierShape</type>s and are than combined - into one <type>PolyPolygonBezierShape</type>. + the Shapes inside this container are converted + to PolyPolygonBezierShapes and are than combined + into one PolyPolygonBezierShape. The <type>Shape</types>s in xShape will be removed from the - <type>GenericDrawPage</type> and disposed. + GenericDrawPage and disposed. @returns - a newly created <type>PolyPolygonBezierShape</type> which contains all - converted <type>PolyPolygonBezierShape</type> combined. It is also added - to the <type>GenericDrawPage</type> of the source <type>Shape</type>s. + a newly created PolyPolygonBezierShape which contains all + converted PolyPolygonBezierShape combined. It is also added + to the GenericDrawPage of the source Shapes. */ com::sun::star::drawing::XShape combine( [in] com::sun::star::drawing::XShapes xShapes ); - /** splits <type>Shape</type>s. + /** splits Shapes. @param xShapes - the <type>Shape</type> is converted to a - <type>PolyPolygonBezierShape</type>s and then split into - several <type>PolyPolygonBezierShape</type>s + the Shape is converted to a + PolyPolygonBezierShapes and then split into + several PolyPolygonBezierShapes The <type>Shape</types>s in xShape will be removed from the - <type>GenericDrawPage</type> and disposed. + GenericDrawPage and disposed. */ void split( [in] com::sun::star::drawing::XShape xGroup ); diff --git a/offapi/com/sun/star/drawing/XShapeGroup.idl b/offapi/com/sun/star/drawing/XShapeGroup.idl index a3165d52428e..75ba24dec228 100644 --- a/offapi/com/sun/star/drawing/XShapeGroup.idl +++ b/offapi/com/sun/star/drawing/XShapeGroup.idl @@ -26,15 +26,15 @@ module com { module sun { module star { module drawing { -/** is implemented by <type>Shape</type>s that contain other - <type>Shape</type>s. +/** is implemented by Shapes that contain other + Shapes. @deprecated */ published interface XShapeGroup: com::sun::star::drawing::XShape { /** enters the group which enables the editing function - for the parts of a grouped <type>Shape</type>. Then the parts can + for the parts of a grouped Shape. Then the parts can be edited instead of the group as a whole. @@ -46,7 +46,7 @@ published interface XShapeGroup: com::sun::star::drawing::XShape void enterGroup(); /** leaves the group, which disables the editing function - for the parts of a grouped <type>Shape</type>. Then only the + for the parts of a grouped Shape. Then only the group as a whole can be edited. diff --git a/offapi/com/sun/star/drawing/XShapeGrouper.idl b/offapi/com/sun/star/drawing/XShapeGrouper.idl index d22e6b0a1b2f..c2bf90a1efea 100644 --- a/offapi/com/sun/star/drawing/XShapeGrouper.idl +++ b/offapi/com/sun/star/drawing/XShapeGrouper.idl @@ -35,7 +35,7 @@ published interface XShapeGrouper: com::sun::star::uno::XInterface { - /** groups the <type>Shape</type>s inside a collection. + /** groups the Shapes inside a collection. <p>Grouping of objects in text documents works only if none of the objects has an anchor of type @@ -43,25 +43,25 @@ published interface XShapeGrouper: com::sun::star::uno::XInterface </p>. @param xShapes - the <type>Shape</type>s that will be grouped. They - must all be inserted into the same <type>GenericDrawPage</type>. + the Shapes that will be grouped. They + must all be inserted into the same GenericDrawPage. @returns - a newly created <type>GroupShape</type> that contains all - <type>Shape</type>s from xShapes and is also added to the - <type>GenericDrawPage</type> of the <type>Shape</type>s + a newly created GroupShape that contains all + Shapes from xShapes and is also added to the + GenericDrawPage of the Shapes in xShapes. */ com::sun::star::drawing::XShapeGroup group( [in] com::sun::star::drawing::XShapes xShapes ); - /** ungroups a given <type>GroupShape</type>. + /** ungroups a given GroupShape. @param aGroup - moves all <type>Shape</type>s from this <type>GroupShape</type> - to the parent <type>XShapes</type> of the <type>GroupShape</type>. - The <type>GroupShape</type> is than removed from the - <type>GenericDrawPage</type> and disposed. + moves all Shapes from this GroupShape + to the parent XShapes of the GroupShape. + The GroupShape is than removed from the + GenericDrawPage and disposed. */ void ungroup( [in] com::sun::star::drawing::XShapeGroup aGroup ); diff --git a/offapi/com/sun/star/drawing/XShapeMirror.idl b/offapi/com/sun/star/drawing/XShapeMirror.idl index 713f840c08f5..efe8a6058d2f 100644 --- a/offapi/com/sun/star/drawing/XShapeMirror.idl +++ b/offapi/com/sun/star/drawing/XShapeMirror.idl @@ -33,21 +33,21 @@ /** Objects implementing this interface can be used to mirror - <type>Shape</type>s. + Shapes. @deprecated */ published interface XShapeMirror: com::sun::star::uno::XInterface { - /** mirrors the given <type>Shape</type>s + /** mirrors the given Shapes at the given axis. */ void mirror( [inout] com::sun::star::drawing::XShapes aShapes, [in] com::sun::star::drawing::MirrorAxis eAxis ); - /** mirrors the given <type>Shape</type>s at + /** mirrors the given Shapes at the given axis. */ void mirrorAtAxis( [inout] com::sun::star::drawing::XShapes aShapes, diff --git a/offapi/com/sun/star/drawing/XShapes.idl b/offapi/com/sun/star/drawing/XShapes.idl index 8d377618b287..54bb1d9c8074 100644 --- a/offapi/com/sun/star/drawing/XShapes.idl +++ b/offapi/com/sun/star/drawing/XShapes.idl @@ -29,7 +29,7 @@ /** makes it possible to access, add, and remove the - <type>Shape</type>s in a collection. + Shapes in a collection. @see DrawPage @see MasterPage @@ -38,18 +38,18 @@ published interface XShapes: com::sun::star::container::XIndexAccess { - /** inserts a <type>Shape</type> into this collection. + /** inserts a Shape into this collection. @param xShape - a <type>Shape</type> that will be inserted. + a Shape that will be inserted. */ void add( [in] com::sun::star::drawing::XShape xShape ); - /** removes a <type>Shape</type> from this collection. + /** removes a Shape from this collection. @param xShape - the <type>Shape</type> will be removed from the + the Shape will be removed from the collection and disposed. */ void remove( [in] com::sun::star::drawing::XShape xShape ); diff --git a/offapi/com/sun/star/drawing/XSlideRenderer.idl b/offapi/com/sun/star/drawing/XSlideRenderer.idl index 319cc63f0148..ef3e1d7ecb53 100644 --- a/offapi/com/sun/star/drawing/XSlideRenderer.idl +++ b/offapi/com/sun/star/drawing/XSlideRenderer.idl @@ -67,8 +67,8 @@ interface XSlideRenderer /** Exactly the same functionality as <member>createPreview()</member>, only a different return type: - <type>com::sun::star::rendering::XBitmap</type> instead - of <type>com::sun::star::awt::XBitmap</type>. + com::sun::star::rendering::XBitmap instead + of com::sun::star::awt::XBitmap. @see createPreview @param xCanvas This canvas is used create a canvas specific bitmap. diff --git a/offapi/com/sun/star/drawing/XSlideSorterBase.idl b/offapi/com/sun/star/drawing/XSlideSorterBase.idl index 339a0f0c3dae..08efe55f1047 100644 --- a/offapi/com/sun/star/drawing/XSlideSorterBase.idl +++ b/offapi/com/sun/star/drawing/XSlideSorterBase.idl @@ -32,17 +32,17 @@ module com { module sun { module star { module drawing { /** This interface exists only because services do not directly support multiple inheritance and attributes. <p>It provides the interfaces and attributes that every object that - implements the <type>SlideSorter</type> service.</p> + implements the SlideSorter service.</p> */ interface XSlideSorterBase { - /** This interface is included to mark a <type>SlideSorter</type> object + /** This interface is included to mark a SlideSorter object as view of the drawing framework and to provide a - <type>ResourceId</type>. + ResourceId. */ interface ::com::sun::star::drawing::framework::XView; - /** The <type>XDrawView</type> interface is included to provide access + /** The XDrawView interface is included to provide access to the current slide (especially write access). */ interface ::com::sun::star::drawing::XDrawView; diff --git a/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl b/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl index 4ef84a8d9259..97ff237c8cca 100644 --- a/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicPaneFactory.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module drawing { module framework { <code>private:resource/floater/CenterPane</code> and <code>private:resource/floater/RightPane</code> respectively.</p> <p>This factory is typically created indirectly by registering it in the - configuration and have the <type>XModuleController</type> create it on + configuration and have the XModuleController create it on demand.</p> */ service BasicPaneFactory : XResourceFactory diff --git a/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl b/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl index b028c2ebd247..55e1d5004b53 100644 --- a/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicToolBarFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { module framework { -/** The <type>BasicToolBarFactory</type> is a resource factory that provides +/** The BasicToolBarFactory is a resource factory that provides (some of) the tool bars used by the Draw and Impress applications. <p>The factory recognizes the following URLs:<ul> @@ -37,7 +37,7 @@ module com { module sun { module star { module drawing { module framework { </p> <p>This factory is typically created indirectly by registering it in the - configuration and have the <type>XModuleController</type> create it on + configuration and have the XModuleController create it on demand.</p> */ service BasicToolBarFactory : XResourceFactory diff --git a/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl b/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl index a41544fe2f6e..84f59a810e8e 100644 --- a/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl +++ b/offapi/com/sun/star/drawing/framework/BasicViewFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module drawing { module framework { -/** The <type>BasicViewFactory</type> is a view factory that provides the +/** The BasicViewFactory is a view factory that provides the panes used by the Draw and Impress applications. <p>The factory recognizes the following URLs:<ul> diff --git a/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl b/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl index 1c81a708e5e1..f32a5f3cc030 100644 --- a/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl +++ b/offapi/com/sun/star/drawing/framework/ConfigurationChangeEvent.idl @@ -39,7 +39,7 @@ interface XResourceId; <p>The set of used members and the exact meaning of their values is not the same for all types. Therefore, the descriptions of the members are just - general guidelines. See <type>XConfigurationController</type> for a + general guidelines. See XConfigurationController for a list of event types used by the basic drawing framework.</p> */ struct ConfigurationChangeEvent diff --git a/offapi/com/sun/star/drawing/framework/ConfigurationController.idl b/offapi/com/sun/star/drawing/framework/ConfigurationController.idl index 594062087f81..5d676ada0720 100644 --- a/offapi/com/sun/star/drawing/framework/ConfigurationController.idl +++ b/offapi/com/sun/star/drawing/framework/ConfigurationController.idl @@ -26,11 +26,11 @@ module com { module sun { module star { module drawing { module framework { -/** See <type>XConfigurationController</type> for a description of the +/** See XConfigurationController for a description of the configuration controller. <p>This service is used at the moment by the - <type>XControllerManager</type> to create a configuration controller. + XControllerManager to create a configuration controller. This allows developers to replace the default implementation of the configuration controller with their own. This may not be a useful feature. Furthermore the sub controllers may need a tighter coupling diff --git a/offapi/com/sun/star/drawing/framework/ModuleController.idl b/offapi/com/sun/star/drawing/framework/ModuleController.idl index a810ecabf6d6..493b284e2422 100644 --- a/offapi/com/sun/star/drawing/framework/ModuleController.idl +++ b/offapi/com/sun/star/drawing/framework/ModuleController.idl @@ -25,19 +25,19 @@ module com { module sun { module star { module drawing { module framework { -/** See <type>XModuleController</type> for a description of the module +/** See XModuleController for a description of the module controller. - <p>See <type>ConfigurationController</type> for a comment why this + <p>See ConfigurationController for a comment why this service may be removed in the future.</p> - <p>The <type>ModuleController</type> object for an application can be - obtained via the <type>XControllerManager</type> interface.</type> + <p>The ModuleController object for an application can be + obtained via the XControllerManager interface.</type> */ service ModuleController : XModuleController { - /** Create a new instance of a <type>ModuleController</type> as sub - controller of the given <type>XController</type> object. + /** Create a new instance of a ModuleController as sub + controller of the given XController object. */ create ([in] ::com::sun::star::frame::XController xController); }; diff --git a/offapi/com/sun/star/drawing/framework/ResourceId.idl b/offapi/com/sun/star/drawing/framework/ResourceId.idl index 6b5f7ddd9ee1..8a70d4515d0a 100644 --- a/offapi/com/sun/star/drawing/framework/ResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/ResourceId.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module drawing { module framework { -/** The <type>ResourceId</type> service provides several constructors for +/** The ResourceId service provides several constructors for resource ids. <p>They mainly differ in how the anchor is specified.</p> */ @@ -42,7 +42,7 @@ service ResourceId create ([in] string sResourceURL); /** Create a resource id for an anchor that is given as - <type>XResourceId</type> object. This is the most general of the + XResourceId object. This is the most general of the constructor variants. */ createWithAnchor ([in] string sResourceURL, [in] XResourceId xAnchor); diff --git a/offapi/com/sun/star/drawing/framework/TabBarButton.idl b/offapi/com/sun/star/drawing/framework/TabBarButton.idl index 7654d99bf23d..769296496737 100644 --- a/offapi/com/sun/star/drawing/framework/TabBarButton.idl +++ b/offapi/com/sun/star/drawing/framework/TabBarButton.idl @@ -28,7 +28,7 @@ interface XResourceId; offer the user the choice between different views to be displayed in one pane. <p>For identification only the <member>ResourceId</member> is used, so for - some methods of the <type>XTabBar</type> interface only the + some methods of the XTabBar interface only the <member>ResourceId</member> member is evaluated.</p> */ struct TabBarButton @@ -42,9 +42,9 @@ struct TabBarButton */ string HelpText; - /** <type>XResourceId</type> object of the resource that is requested to be + /** XResourceId object of the resource that is requested to be displayed when the tab bar button is activated. - <p>For some methods of the <type>XTabBar</type> interface only this + <p>For some methods of the XTabBar interface only this member is evaluated. That is because only this member is used to identify a tab bar button.</p> */ diff --git a/offapi/com/sun/star/drawing/framework/XConfiguration.idl b/offapi/com/sun/star/drawing/framework/XConfiguration.idl index 89b577d9e388..b45c03449053 100644 --- a/offapi/com/sun/star/drawing/framework/XConfiguration.idl +++ b/offapi/com/sun/star/drawing/framework/XConfiguration.idl @@ -35,8 +35,8 @@ interface XResourceId; configuration but also a requested configuration can be represented. <p>Direct manipulation of a configuration object is not advised with the - exception of the <type>ConfigurationController</type> and objects that - implement the <type>XConfigurationChangeRequest</type> interface.</p> + exception of the ConfigurationController and objects that + implement the XConfigurationChangeRequest interface.</p> @see XConfigurationController */ @@ -48,8 +48,8 @@ interface XConfiguration returned resource ids. @param xAnchorId This anchor typically is either a pane or an empty - <type>XResourceId</type> object. An - empty reference is treated like an <type>XResourceId</type> object. + XResourceId object. An + empty reference is treated like an XResourceId object. @param sURLPrefix When a non-empty string is given then resource ids are returned only when their resource URL matches this prefix, i.e. when it @@ -82,7 +82,7 @@ interface XConfiguration active, i.e. has a visible representation in the GUI. @param xResourceId The id of a resource. May be empty (empty reference or empty - <type>XResourceId</type> object) in which case <FALSE/> is + XResourceId object) in which case <FALSE/> is returned. @return Returns <TRUE/> when the resource is part of the configuration @@ -92,7 +92,7 @@ interface XConfiguration /** Add a resource to the configuration. <p>This method should be used only by objects that implement the - <type>XConfigurationRequest</type> interface or by the configuration + XConfigurationRequest interface or by the configuration controller.</p> @param xResourceId The resource to add to the configuration. When the specified @@ -106,7 +106,7 @@ interface XConfiguration /** Remove a resource from the configuration. <p>This method should be used only by objects that implement the - <type>XConfigurationRequest</type> interface or by the configuration + XConfigurationRequest interface or by the configuration controller.</p> @param xResourceId The resource to remove from the configuration. When the diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl index bc8d976843db..fa371428647d 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl @@ -33,13 +33,13 @@ interface XConfiguration; <member>execute()</member> method is called. Configuration change requests are executed asynchronously. This is done to avoid reentrance problems with objects that are registered as - <type>XConfigurationChangeListener</type> and at the same time make + XConfigurationChangeListener and at the same time make configuration change requests. When the requests were executed synchronously then the listeners would be notified of the changes while their request call has not yet returned.</p> <p>This interface is typically used internally by the - <type>XConfigurationController</type></p> @see XConfigurationController + XConfigurationController</p> @see XConfigurationController */ interface XConfigurationChangeRequest { diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl index 13135d796e52..edd1efbd452b 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationController.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationController.idl @@ -63,12 +63,12 @@ interface XResource; <member>requestResourceActivation()</member> or <member>requestResourceDeactivation()</member> results in one or more function objects, that each implement the - <type>XConfigurationChangeRequest</type> interface. These are inserted + XConfigurationChangeRequest interface. These are inserted into a queue. The request objects in the queue are processed asynchronously one at a time in the order in which they are inserted. Only when one request object is processed a change to the requested configuration is made. These changes are broadcasted to registered - <type>XConfigurationChangeListener</type> objects. Listeners may + XConfigurationChangeListener objects. Listeners may decide to make requests that then are added to the queue. For example when the view in the center pane is replaced by another view, some listeners may want to turn some side panes on or off, or show other @@ -129,13 +129,13 @@ interface XResource; activated, i.e. when a new object of a resource is created (or taken from a cash).</p> <p>The <member>ResourceId</member> and <member>ResourceObject</member> - members are set to the <type>XResourceId</type> and object reference of + members are set to the XResourceId and object reference of the activated resource.</p></li> <li><const>ResourceDeactivation</const> is sent when a resource is deactivated, i.e. when an object that previously was part of the configuration is removed from the configuration.</p> <p>The <member>ResourceId</member> and <member>ResourceObject</member> - members are set to <type>XResourceId</type> and object reference of the + members are set to XResourceId and object reference of the deactivated resource.</p></li> </ul></p> */ diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl index 3c6d5831bde4..26f59084057b 100644 --- a/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl +++ b/offapi/com/sun/star/drawing/framework/XConfigurationControllerRequestQueue.idl @@ -32,7 +32,7 @@ interface XConfigurationChangeRequest; <p>This interface allows callers to add requests to the back of the queue and to determine whether the queue is empty. Using this interface should normally not be necessary for anyone else than the - <type>XConfigurationController</type>. It may be removed in the future.</p> + XConfigurationController. It may be removed in the future.</p> */ interface XConfigurationControllerRequestQueue { diff --git a/offapi/com/sun/star/drawing/framework/XControllerManager.idl b/offapi/com/sun/star/drawing/framework/XControllerManager.idl index 0a7f4e66a99c..d6530788df3c 100644 --- a/offapi/com/sun/star/drawing/framework/XControllerManager.idl +++ b/offapi/com/sun/star/drawing/framework/XControllerManager.idl @@ -29,19 +29,19 @@ interface XModuleController; /** The XControllerManager gives access to the controllers of the drawing framework. - <p>The <type>XControllerManager</type> interface is typically + <p>The XControllerManager interface is typically implemented by the same object that implements <type scope="com::sun::star::frame">XController</type>.</p> */ interface XControllerManager { - /** Return the <type>XConfigurationController</type> object. + /** Return the XConfigurationController object. @return The returned reference is never empty. */ XConfigurationController getConfigurationController (); - /** Return the <type>XModuleController</type> object. + /** Return the XModuleController object. @return The returned reference is never empty. */ diff --git a/offapi/com/sun/star/drawing/framework/XResource.idl b/offapi/com/sun/star/drawing/framework/XResource.idl index 6d924c4f56a5..0620bc49c5f1 100644 --- a/offapi/com/sun/star/drawing/framework/XResource.idl +++ b/offapi/com/sun/star/drawing/framework/XResource.idl @@ -31,7 +31,7 @@ interface XResourceId; */ interface XResource { - /** Return an <type>XResourceId</type> object for the called resource. + /** Return an XResourceId object for the called resource. The returned id unambiguously identifies the resource. */ XResourceId getResourceId (); diff --git a/offapi/com/sun/star/drawing/framework/XResourceFactory.idl b/offapi/com/sun/star/drawing/framework/XResourceFactory.idl index 086b70bfa093..0c7c270de692 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceFactory.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceFactory.idl @@ -31,13 +31,13 @@ interface XResourceId; /** Factory and possibly cache for creating and releasing resources. <p>A resource factory is created and used by the - <type>XConfigurationController</type> object.</p> + XConfigurationController object.</p> <p>A factory may want to implement a cache to reuse previously released resources.</p> */ interface XResourceFactory { - /** Create a resource for the given <type>XResourceId</type> object. + /** Create a resource for the given XResourceId object. @param xResourceId The resource URL of this id specifies the type of resource to create. The anchor can be used to obtain the associated object @@ -45,7 +45,7 @@ interface XResourceFactory created, then the new object can be initialized with the pane that is its anchor. <p>Valid values are those for which the factory has previously been - registered at the <type>XConfigurationController</type></p>. + registered at the XConfigurationController</p>. @return Returns a resource object that has been just created or was taken from a cache. When the requested resource can not be diff --git a/offapi/com/sun/star/drawing/framework/XResourceId.idl b/offapi/com/sun/star/drawing/framework/XResourceId.idl index 87b5df2a891b..5a9be782fd2e 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceId.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module drawing { module framework { views), or it is empty (for panes).</p> <p>The resource URL may be empty. In this case the anchor is empty, too. Such an empty resource id does not describe a resource but rather - the absence of one. Instead of an empty <type>XResourceId</type> object + the absence of one. Instead of an empty XResourceId object an empty reference can be used in many places.</p> <p>The resource URL may have arguments that are passed to the factory method on its creation. Arguments are only available through the @@ -73,7 +73,7 @@ interface XResourceId */ string getResourceTypePrefix (); - /** Compare the called <type>XResourceId</type> object with the given + /** Compare the called XResourceId object with the given one. <p>The two resource ids A and B are compared so that if A<B (return value is -1) then either A and B are unrelated or A is a direct or diff --git a/offapi/com/sun/star/embed/Actions.idl b/offapi/com/sun/star/embed/Actions.idl index 58a36996b4ca..cf47a3b50a74 100644 --- a/offapi/com/sun/star/embed/Actions.idl +++ b/offapi/com/sun/star/embed/Actions.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module embed { /** This constant set contains possible actions that could be approved by -<type>ActionsApproval</type> implementation. +ActionsApproval implementation. */ published constants Actions { diff --git a/offapi/com/sun/star/embed/Aspects.idl b/offapi/com/sun/star/embed/Aspects.idl index f48cf3620754..87f615b96f42 100644 --- a/offapi/com/sun/star/embed/Aspects.idl +++ b/offapi/com/sun/star/embed/Aspects.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module embed { can be used to specify the kind of object view. It can be used for example by container to request view representation of a certain kind from - <type>XEmbeddedObject</type>. + XEmbeddedObject. </p> <p> diff --git a/offapi/com/sun/star/embed/BaseStorage.idl b/offapi/com/sun/star/embed/BaseStorage.idl index c44cb96c3ed9..52de6a080799 100644 --- a/offapi/com/sun/star/embed/BaseStorage.idl +++ b/offapi/com/sun/star/embed/BaseStorage.idl @@ -44,7 +44,7 @@ published service BaseStorage /** allows to get the mode the storage is opened in. <p> - Can be a combination of values from <type>ElementModes</type>. + Can be a combination of values from ElementModes. </p> */ [property, readonly] long OpenMode; diff --git a/offapi/com/sun/star/embed/ElementModes.idl b/offapi/com/sun/star/embed/ElementModes.idl index 4232bab4ea79..f4bf21f32768 100644 --- a/offapi/com/sun/star/embed/ElementModes.idl +++ b/offapi/com/sun/star/embed/ElementModes.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module embed { are base modes. A result mode must include one of base modes. </p> - @see <type>XStorage</type> + @see XStorage */ published constants ElementModes { @@ -42,7 +42,7 @@ published constants ElementModes /** specifies opening of a seekable element. <p> - This mode is ignored for <type>Storage</type> elements. + This mode is ignored for Storage elements. This flag makes sense only in combination with <const>ElementModes::READ</const> and/or <const>ElementModes::WRITE</const>. diff --git a/offapi/com/sun/star/embed/EmbedStates.idl b/offapi/com/sun/star/embed/EmbedStates.idl index a559900ad994..a7b920826d1a 100644 --- a/offapi/com/sun/star/embed/EmbedStates.idl +++ b/offapi/com/sun/star/embed/EmbedStates.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module embed { /** This constant set contains possible states for -<type>EmbeddedObject</type>. +EmbeddedObject. */ published constants EmbedStates { diff --git a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl index b0063f65bfb1..ff046d1fa249 100644 --- a/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl +++ b/offapi/com/sun/star/embed/EmbeddedObjectDescriptor.idl @@ -64,7 +64,7 @@ published service EmbeddedObjectDescriptor /** denotes the storage from which the embedded object is to be recovered. <p>Upon activating the embedded object, it is normally loaded from a storage as denoted by - the parameters to the <type>XEmbedObjectCreator</type> method calls.</p> + the parameters to the XEmbedObjectCreator method calls.</p> <p>You can pass a non-<NULL/> <code>RecoveryStorage</code> in the object descriptor if you wish to load the embedded object from an alternate storage.</p> diff --git a/offapi/com/sun/star/embed/FileSystemStorage.idl b/offapi/com/sun/star/embed/FileSystemStorage.idl index 0dcd0399ca9c..9263642323e1 100644 --- a/offapi/com/sun/star/embed/FileSystemStorage.idl +++ b/offapi/com/sun/star/embed/FileSystemStorage.idl @@ -43,7 +43,7 @@ published service FileSystemStorage <dd> <p> A file system storage is created either by - <type>StorageFactory</type> or by <type>XStorage</type> + StorageFactory or by XStorage interface and is controlled by refcounting. In case refcounting is decreased to zero the storage will be disposed automatically. @@ -54,12 +54,12 @@ published service FileSystemStorage ( substorages and substreams ) are not affected. </p> </dd> - <dt>interface <type>XStorage</type></dt> + <dt>interface XStorage</dt> <dd> <dl> <dt><method>XStorage::openStorageElement</method></dt> <dd> - This method returns <type>FileSystemStorage</type> + This method returns FileSystemStorage service implementation. </dd> diff --git a/offapi/com/sun/star/embed/FileSystemStorageFactory.idl b/offapi/com/sun/star/embed/FileSystemStorageFactory.idl index 42575ff2025a..fb3b88b25051 100644 --- a/offapi/com/sun/star/embed/FileSystemStorageFactory.idl +++ b/offapi/com/sun/star/embed/FileSystemStorageFactory.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module embed { -/** The <type>FileSystemStorageFactory</type> is a service that allows to - create a <type>FileSystemStorage</type> based on URL. The URL must point +/** The FileSystemStorageFactory is a service that allows to + create a FileSystemStorage based on URL. The URL must point to a folder. <p> @@ -53,7 +53,7 @@ <dt>parameter 2</dt> <dd> specifies mode the storage should be open in, can take - values from <type>ElementModes</type> constant set. + values from ElementModes constant set. </dd> <dt>parameter 3</dt> diff --git a/offapi/com/sun/star/embed/InstanceLocker.idl b/offapi/com/sun/star/embed/InstanceLocker.idl index 6e416cdbafea..7e2614cf9609 100644 --- a/offapi/com/sun/star/embed/InstanceLocker.idl +++ b/offapi/com/sun/star/embed/InstanceLocker.idl @@ -49,8 +49,8 @@ published service InstanceLocker : com::sun::star::lang::XComponent specifies the actions that should be done ( prevent closing, prevent termination and/or etc. ). It must not be empty and can currently contain following values or their combination: - <type>Actions</type>::PREVENT_CLOSE and - <type>Actions</type>::PREVENT_TERMINATION. + Actions::PREVENT_CLOSE and + Actions::PREVENT_TERMINATION. */ InstanceLockerCtor1( [in] com::sun::star::uno::XInterface xInstance, [in] long nActions ) @@ -68,17 +68,17 @@ published service InstanceLocker : com::sun::star::lang::XComponent specifies the actions that should be done ( prevent closing, prevent termination and/or etc. ). It must not be empty and can currently contain following values or their combination: - <type>Actions</type>::PREVENT_CLOSE and - <type>Actions</type>::PREVENT_TERMINATION. + Actions::PREVENT_CLOSE and + Actions::PREVENT_TERMINATION. @param xApprove - The object implementing <type>XActionsApproval</type> interface. + The object implementing XActionsApproval interface. If this parameter is an empty reference the object will proceed with the specified in the first parameter action until it is disposed ( just like in the case of the first constructor ). If the instance is provided, it will be asked for approval each time before proceeding with the action ( the action is - specified using <type>string</type> and can take following + specified using string and can take following values in this case: "PreventClose", "PreventTermination" ). */ InstanceLockerCtor2( [in] com::sun::star::uno::XInterface xInstance, diff --git a/offapi/com/sun/star/embed/StateChangeInProgressException.idl b/offapi/com/sun/star/embed/StateChangeInProgressException.idl index c03f50845617..ec45cef9cc4e 100644 --- a/offapi/com/sun/star/embed/StateChangeInProgressException.idl +++ b/offapi/com/sun/star/embed/StateChangeInProgressException.idl @@ -35,7 +35,7 @@ published exception StateChangeInProgressException: com::sun::star::embed::Wrong /** contains the target state the object tries to reach currently. <p> - Contains a value from <type>EmbedStates</type> constant set. + Contains a value from EmbedStates constant set. </p> */ long TargetState; diff --git a/offapi/com/sun/star/embed/Storage.idl b/offapi/com/sun/star/embed/Storage.idl index 5466e358aab9..4fe0d962692e 100644 --- a/offapi/com/sun/star/embed/Storage.idl +++ b/offapi/com/sun/star/embed/Storage.idl @@ -37,8 +37,8 @@ hierarchy. <p> - A root storage should be retrieved by using <type>StorageFactory</type> - service. Substorages are created through <type>XStorage</type> interface + A root storage should be retrieved by using StorageFactory + service. Substorages are created through XStorage interface of a parent storage. </p> */ @@ -56,7 +56,7 @@ published service Storage </dt> <dd> <p> - A root storage is created by <type>StorageFactory</type> + A root storage is created by StorageFactory and is controlled by refcounting. In case refcounting is decreased to zero the storage will be disposed automatically. It is still strongly recommended that @@ -67,7 +67,7 @@ published service Storage </p> <p> - A substorage is created by <type>XStorage</type> + A substorage is created by XStorage interface of storage. Each time a substorage is opened it is locked ( in case it is opened in readonly mode it is locked for writing, in case it is opened in @@ -85,20 +85,20 @@ published service Storage read-write mode all non-commited changes will be lost. </p> </dd> - <dt>interface <type>XStorage</type></dt> + <dt>interface XStorage</dt> <dd> <dl> <dt><method>XStorage::openStreamElement</method></dt> <dd> <p> - This method returns <type>StorageStream</type> + This method returns StorageStream service implementation. </p> <p> If the child stream is an encrypted one a correct common storage password should be set through - <type>XEncryptionProtectedSource</type> interface to + XEncryptionProtectedSource interface to this storage or to a one of storages in parent hierarchy. In case the password is not set or is a wrong one an exception will be thrown. @@ -111,21 +111,21 @@ published service Storage stream explicitly. The password will be used to read the stream. It is possible to specify a new password for stream storing through - <type>XEncryptionProtectedSource</type> interface. In + XEncryptionProtectedSource interface. In case a new password is not specified an old one will be used for storing. </dd> <dt><method>XStorage::openStorageElement</method></dt> <dd> - This method returns <type>Storage</type> service + This method returns Storage service implementation. </dd> <dt><method>XStorage::cloneStreamElement</method></dt> <dd> <p> - This method returns <type>StorageStream</type> service + This method returns StorageStream service implementation. </p> @@ -149,7 +149,7 @@ published service Storage <p> If the child stream is an encrypted one a correct common storage password should be set through - <type>XEncryptionProtectedSource</type> interface to + XEncryptionProtectedSource interface to this storage or to a one of storages in parent hierarchy. In case the password is not set or is a wrong one an exception will be thrown. @@ -159,7 +159,7 @@ published service Storage <dt><method>XStorage::cloneEncryptedStreamElement</method></dt> <dd> <p> - This method returns <type>StorageStream</type> service + This method returns StorageStream service implementation. </p> @@ -183,7 +183,7 @@ published service Storage <dt><method>XStorage::copyLastCommitTo</method></dt> <dd> - This method gets <type>Storage</type> service + This method gets Storage service implementation and fills it in with the latest commited version of this storage. So in case the storage was not commited after it was changed, the @@ -193,7 +193,7 @@ published service Storage <dt><method>XStorage::copyStorageElementLastCommitTo</method></dt> <dd> <p> - This method gets <type>Storage</type> service + This method gets Storage service implementation and fills it in with the contents of the requested substorage. The latest commited version of child storage will be used. So in case the child @@ -297,7 +297,7 @@ published service Storage In case it is set to <TRUE/> the storage itself and/or a tree of substorages contain encrypted streams. Usually in case this property is supported the implementation supports - <type>XEncryptionProtectedSource</type> interface. + XEncryptionProtectedSource interface. </p> */ [property, optional, readonly] boolean HasEncryptedEntries; @@ -308,7 +308,7 @@ published service Storage In case it is set to <TRUE/> the storage itself and/or a tree of substorages contains non-encrypted streams. Usually in case this property is supported the implementation supports - <type>XEncryptionProtectedSource</type> interface. + XEncryptionProtectedSource interface. </p> */ [property, optional, readonly] boolean HasNonEncryptedEntries; diff --git a/offapi/com/sun/star/embed/StorageFactory.idl b/offapi/com/sun/star/embed/StorageFactory.idl index 08b189e476d0..a07e9777b986 100644 --- a/offapi/com/sun/star/embed/StorageFactory.idl +++ b/offapi/com/sun/star/embed/StorageFactory.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module embed { -/** The <type>StorageFactory</type> is a service that allows to create +/** The StorageFactory is a service that allows to create a storage based on either stream or URL. <p> @@ -60,7 +60,7 @@ <dt>parameter 2</dt> <dd> specifies mode the storage should be open in, can take - values from <type>ElementModes</type> constant set. + values from ElementModes constant set. </dd> <dt>parameter 3</dt> diff --git a/offapi/com/sun/star/embed/StorageFormats.idl b/offapi/com/sun/star/embed/StorageFormats.idl index b5806bcf736b..89703ceb70b3 100644 --- a/offapi/com/sun/star/embed/StorageFormats.idl +++ b/offapi/com/sun/star/embed/StorageFormats.idl @@ -24,9 +24,9 @@ module com { module sun { module star { module embed { /** The constant set contains IDs of formats that are supported by - <type>StorageFactory</type>. + StorageFactory. - @see <type>StorageFactory</type> + @see StorageFactory @since OOo 3.3 */ published constants StorageFormats diff --git a/offapi/com/sun/star/embed/StorageStream.idl b/offapi/com/sun/star/embed/StorageStream.idl index 30c949867bac..3ccefdaede24 100644 --- a/offapi/com/sun/star/embed/StorageStream.idl +++ b/offapi/com/sun/star/embed/StorageStream.idl @@ -32,8 +32,8 @@ module com { module sun { module star { module embed { /** This is a service that represents a stream that can be provided by - <type>XStorage</type>::openStreamElement() call implemented by - <type>Storage</type> service. + XStorage::openStreamElement() call implemented by + Storage service. <p> In case a stream is open with read-write access only one instance @@ -148,7 +148,7 @@ published service StorageStream <p> If somebody sets a password explicitly by using - <type>XEncryptionProtectedSource</type> interface the value is + XEncryptionProtectedSource interface the value is automatically set to <TRUE/>. If the interface is used to remove the encryption - the value is automatically set to <FALSE/>. </p> @@ -178,7 +178,7 @@ published service StorageStream <p> If somebody sets a password explicitly by using - <type>XEncryptionProtectedSource</type> interface the value is + XEncryptionProtectedSource interface the value is automatically set to <FALSE/> and the stream becomes encrypted with specified password immediately. </p> diff --git a/offapi/com/sun/star/embed/StorageWrappedTargetException.idl b/offapi/com/sun/star/embed/StorageWrappedTargetException.idl index d6a33077706b..86fd261be5f6 100644 --- a/offapi/com/sun/star/embed/StorageWrappedTargetException.idl +++ b/offapi/com/sun/star/embed/StorageWrappedTargetException.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module embed { -/** This exception can wrap an exception thrown during <type>XStorage</type> +/** This exception can wrap an exception thrown during XStorage methods execution. */ published exception StorageWrappedTargetException: com::sun::star::lang::WrappedTargetException diff --git a/offapi/com/sun/star/embed/VerbDescriptor.idl b/offapi/com/sun/star/embed/VerbDescriptor.idl index 794133e41c73..f6fe3608fed8 100644 --- a/offapi/com/sun/star/embed/VerbDescriptor.idl +++ b/offapi/com/sun/star/embed/VerbDescriptor.idl @@ -47,7 +47,7 @@ published struct VerbDescriptor /** specifies the attributes of the verb. <p> - It can take values from <type>VerbAttributes</type>. + It can take values from VerbAttributes. </p> */ long VerbAttributes; diff --git a/offapi/com/sun/star/embed/XActionsApproval.idl b/offapi/com/sun/star/embed/XActionsApproval.idl index 8d35d45f0229..12f9fbdea791 100644 --- a/offapi/com/sun/star/embed/XActionsApproval.idl +++ b/offapi/com/sun/star/embed/XActionsApproval.idl @@ -38,10 +38,10 @@ published interface XActionsApproval: com::sun::star::uno::XInterface @param nAction a value specifying the action that should be approved. Could take - values from <type>Actions</type> constants set. The explicit set + values from Actions constants set. The explicit set of the actions should be documented by the object that is going to use this interface for approval as for example - <type>InstanceLocker</type> does. + InstanceLocker does. @return returns <TRUE/> in case the specified action is approved. diff --git a/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl b/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl index 96d76c275912..4c3861250979 100644 --- a/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl +++ b/offapi/com/sun/star/embed/XEmbedObjectClipboardCreator.idl @@ -48,7 +48,7 @@ published interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterfac <p> The clipboard can provide a number of choices that are container related. This information will be returned in the - <type>InsertedObjectInfo</type> object. + InsertedObjectInfo object. <p> @param xStorage @@ -60,7 +60,7 @@ published interface XEmbedObjectClipboardCreator: com::sun::star::uno::XInterfac @param aObjectArgs optional parameters for the object persistence initialization see also - <type>EmbeddedObjectDescriptor</type> + EmbeddedObjectDescriptor @returns the structure containing the object and container related options diff --git a/offapi/com/sun/star/embed/XEmbedObjectCreator.idl b/offapi/com/sun/star/embed/XEmbedObjectCreator.idl index f4e801b03d6e..65c4681e4800 100644 --- a/offapi/com/sun/star/embed/XEmbedObjectCreator.idl +++ b/offapi/com/sun/star/embed/XEmbedObjectCreator.idl @@ -59,7 +59,7 @@ published interface XEmbedObjectCreator: com::sun::star::uno::XInterface @param aObjectArgs optional parameters for the object persistence initialization see also - <type>EmbeddedObjectDescriptor</type> + EmbeddedObjectDescriptor @throws ::com::sun::star::lang::IllegalArgumentException one of arguments is illegal @@ -102,7 +102,7 @@ published interface XEmbedObjectCreator: com::sun::star::uno::XInterface object should be loaded from storage entry @param aObjectArgs - an object of type <type>EmbeddedObjectDescriptor</type> + an object of type EmbeddedObjectDescriptor contains object related properties @throws ::com::sun::star::lang::IllegalArgumentException @@ -146,7 +146,7 @@ published interface XEmbedObjectCreator: com::sun::star::uno::XInterface specifies source @param aObjectArgs - an object of type <type>EmbeddedObjectDescriptor</type> + an object of type EmbeddedObjectDescriptor contains object related properties @throws ::com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/embed/XEmbedObjectFactory.idl b/offapi/com/sun/star/embed/XEmbedObjectFactory.idl index 63a687d00309..0f741cc52eb6 100644 --- a/offapi/com/sun/star/embed/XEmbedObjectFactory.idl +++ b/offapi/com/sun/star/embed/XEmbedObjectFactory.idl @@ -46,7 +46,7 @@ published interface XEmbedObjectFactory: com::sun::star::uno::XInterface <p> If the service implementation does not support - <type>XEmbedObjectCreator</type> interface, it must accept the empty + XEmbedObjectCreator interface, it must accept the empty aClassID parameter in case of loading from existing entry. </p> @@ -64,7 +64,7 @@ published interface XEmbedObjectFactory: com::sun::star::uno::XInterface @param nEntryConnectionMode a mode in which the object should be initialized from entry - can take values from <type>EntryInitModes</type> constant set + can take values from EntryInitModes constant set @param aArgs optional parameters for the embedded document persistence diff --git a/offapi/com/sun/star/embed/XEmbeddedObject.idl b/offapi/com/sun/star/embed/XEmbeddedObject.idl index 12483c561c19..9d6a3ebeaf0a 100644 --- a/offapi/com/sun/star/embed/XEmbeddedObject.idl +++ b/offapi/com/sun/star/embed/XEmbeddedObject.idl @@ -121,7 +121,7 @@ published interface XEmbeddedObject @param nVerbID specifies an action to perform, can take values from - <type>EmbedVerbs</type> + EmbedVerbs @throws ::com::sun::star::lang::IllegalArgumentException the verb is not supported @@ -196,7 +196,7 @@ published interface XEmbeddedObject @param nMode the new update mode, can take values from - <type>EmbeddedUpdateModes</type> + EmbeddedUpdateModes @throws ::com::sun::star::embed::WrongStateException the object is in wrong state @@ -211,7 +211,7 @@ published interface XEmbeddedObject @return the value specifying the status of the object for specified aspect - can take values from <type>EmbedMisc</type> constant set + can take values from EmbedMisc constant set @throws com::sun::star::embed::WrongStateException the object is in wrong state diff --git a/offapi/com/sun/star/embed/XExtendedStorageStream.idl b/offapi/com/sun/star/embed/XExtendedStorageStream.idl index e8eafe39e4a8..a22e6fd8857f 100644 --- a/offapi/com/sun/star/embed/XExtendedStorageStream.idl +++ b/offapi/com/sun/star/embed/XExtendedStorageStream.idl @@ -80,7 +80,7 @@ published interface XExtendedStorageStream /** allows to register a listener for transaction actions. <p> - If <type>XTransactedObject</type> interface is implemented this + If XTransactedObject interface is implemented this interface must be implemented as well. </p> */ diff --git a/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl b/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl index d1053310585a..551d206f5c6e 100644 --- a/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl +++ b/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl @@ -67,7 +67,7 @@ published interface XHierarchicalStorageAccess @param nOpenMode a mode the stream should be open in, - can be a combination of <type>ElementModes</type> values + can be a combination of ElementModes values @throws ::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason @@ -112,7 +112,7 @@ published interface XHierarchicalStorageAccess @param nOpenMode a mode the stream should be open in, - can be a combination of <type>ElementModes</type> values + can be a combination of ElementModes values @param sPassword this parameter allows to specify a reading password for the diff --git a/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl b/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl index 83578acdd8ec..e0914af8f5ce 100644 --- a/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl +++ b/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl @@ -48,7 +48,7 @@ interface XHierarchicalStorageAccess2 : XHierarchicalStorageAccess @param nOpenMode a mode the stream should be open in, - can be a combination of <type>ElementModes</type> values + can be a combination of ElementModes values @param aEncryptionData this parameter allowes to specify an encryption data for the diff --git a/offapi/com/sun/star/embed/XInsertObjectDialog.idl b/offapi/com/sun/star/embed/XInsertObjectDialog.idl index 5196298e6c50..caed57f1d0b1 100644 --- a/offapi/com/sun/star/embed/XInsertObjectDialog.idl +++ b/offapi/com/sun/star/embed/XInsertObjectDialog.idl @@ -39,7 +39,7 @@ published interface XInsertObjectDialog: com::sun::star::uno::XInterface <p> The dialog allows for user to do a number of choices that are container related. This information will be returned in the - <type>InsertedObjectInfo</type> object. + InsertedObjectInfo object. <p> @param xStorage diff --git a/offapi/com/sun/star/embed/XLinkageSupport.idl b/offapi/com/sun/star/embed/XLinkageSupport.idl index 05f11e028dc2..b606a7e52e3b 100644 --- a/offapi/com/sun/star/embed/XLinkageSupport.idl +++ b/offapi/com/sun/star/embed/XLinkageSupport.idl @@ -40,7 +40,7 @@ published interface XLinkageSupport: XCommonEmbedPersist the whole set of embedded object interfaces. Usually the sets of interfaces are the same for links and objects. An example of exception from this are OOo links that do not implement - <type>XEmbedPersist</type> interface. For such cases the method will + XEmbedPersist interface. For such cases the method will throw an exception. </p> diff --git a/offapi/com/sun/star/embed/XOLESimpleStorage.idl b/offapi/com/sun/star/embed/XOLESimpleStorage.idl index 7f9f816a0f13..4ea4f69b1259 100644 --- a/offapi/com/sun/star/embed/XOLESimpleStorage.idl +++ b/offapi/com/sun/star/embed/XOLESimpleStorage.idl @@ -37,32 +37,32 @@ module com { module sun { module star { module embed { published interface XOLESimpleStorage { //INTERFACES - /** interface <type>XNameContainer</type> is the generic interface for + /** interface XNameContainer is the generic interface for supporting the insertion and removal of named elements. <p>The access to the elements is provided though - <type>XNameContainer</type> methods.</p> + XNameContainer methods.</p> */ interface ::com::sun::star::container::XNameContainer; - /** interface <type>XComponent</type> allows to explicitly free resources + /** interface XComponent allows to explicitly free resources and break cyclic references. */ interface ::com::sun::star::lang::XComponent; - /** interface <type>XTransactedObject</type> allows transacted access to + /** interface XTransactedObject allows transacted access to an object. <p>The storages are always opened in transacted mode, the - <type>XTransactedObject</type> interface allows to commit the storage. + XTransactedObject interface allows to commit the storage. </p> */ interface XTransactedObject; - /** interface <type>XClassifiedObject</type> represents common + /** interface XClassifiedObject represents common functionality for embedded objects - <p>the <type>XClassifiedObject</type> interface allows to set/get the + <p>the XClassifiedObject interface allows to set/get the ClassID of the storage.</p> */ interface XClassifiedObject; diff --git a/offapi/com/sun/star/embed/XStorage.idl b/offapi/com/sun/star/embed/XStorage.idl index 5798a82d106b..d4b1d5029f83 100644 --- a/offapi/com/sun/star/embed/XStorage.idl +++ b/offapi/com/sun/star/embed/XStorage.idl @@ -50,7 +50,7 @@ published interface XStorage It is also possible to use this interface to get read access to a child element by <method scope="com::sun::star::container">XNameAccess::getByName</method> - call. But the recommended way is to use <type>XStorage</type> + call. But the recommended way is to use XStorage interface for this purpose. </p> */ @@ -109,7 +109,7 @@ published interface XStorage @param nOpenMode a mode the stream should be open in, - can be a combination of <type>ElementModes</type> values + can be a combination of ElementModes values @throws ::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason @@ -153,7 +153,7 @@ published interface XStorage @param nOpenMode a mode the stream should be open in, - can be a combination of <type>ElementModes</type> values + can be a combination of ElementModes values @param sPassword this parameter allows to specify a reading password for the diff --git a/offapi/com/sun/star/embed/XStorage2.idl b/offapi/com/sun/star/embed/XStorage2.idl index 1bf135be2c30..b247fa3f40d2 100644 --- a/offapi/com/sun/star/embed/XStorage2.idl +++ b/offapi/com/sun/star/embed/XStorage2.idl @@ -48,7 +48,7 @@ interface XStorage2 : XStorage @param nOpenMode a mode the stream should be open in, - can be a combination of <type>ElementModes</type> values + can be a combination of ElementModes values @param aEncryptionData this parameter allowes to specify an encryption data to decrypt the diff --git a/offapi/com/sun/star/embed/XVisualObject.idl b/offapi/com/sun/star/embed/XVisualObject.idl index eb305b6823af..81536a92bb7c 100644 --- a/offapi/com/sun/star/embed/XVisualObject.idl +++ b/offapi/com/sun/star/embed/XVisualObject.idl @@ -47,7 +47,7 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface @param nAspect the aspect specifying the form of object representation. - Can take values from <type>Aspects</type> constant set. + Can take values from Aspects constant set. @param aSize the new size of the visual area @@ -76,7 +76,7 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface @param nAspect the aspect specifying the form of object representation. - Can take values from <type>Aspects</type> constant set. + Can take values from Aspects constant set. @return the size of visual area @@ -101,7 +101,7 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface @param nAspect the aspect the representation is requested for. - Can take values from <type>Aspects</type> constant set. + Can take values from Aspects constant set. @return the visual representation of the object in the default format and @@ -127,11 +127,11 @@ published interface XVisualObject: ::com::sun::star::uno::XInterface @param nAspect the aspect the map mode is requested for. - Can take values from <type>Aspects</type> constant set. + Can take values from Aspects constant set. @return the map mode the object communicates in, it can take values from - <type>EmbedMapUnits</type> constant + EmbedMapUnits constant @throws ::com::sun::star::embed::WrongStateException the object is in wrong state diff --git a/offapi/com/sun/star/form/DataAwareControlModel.idl b/offapi/com/sun/star/form/DataAwareControlModel.idl index b29b6e5232a9..21219f01067c 100644 --- a/offapi/com/sun/star/form/DataAwareControlModel.idl +++ b/offapi/com/sun/star/form/DataAwareControlModel.idl @@ -34,13 +34,13 @@ module com { module sun { module star { module form { -/** is an abstract service for specialized <type>FormControlModel</type>s +/** is an abstract service for specialized FormControlModels which are data aware and thus can be bound to a data source. <p>The connection between a data-aware control model and a form whose data the control should display is made by parentship relations. The parent of a data-aware control model (see <type scope="com::sun::star::container">XChild</type>, inherited - via the <type>FormControlModel</type> and <type>FormComponent</type> services) has + via the FormControlModel and FormComponent services) has always to be a <type scope="com::sun::star::form::component">DataForm</type>.</p> */ published service DataAwareControlModel @@ -65,10 +65,10 @@ published service DataAwareControlModel interface com::sun::star::form::XLoadListener; - /** Each <type>DataAwareControlModel</type> should be resettable for setting default values. + /** Each DataAwareControlModel should be resettable for setting default values. <p>In the context of a control model which is data-aware, the semantics of <em>default value</em> - (see <type>XReset</type>) is as follows:<br/> + (see XReset) is as follows:<br/> If (and only if) the control is valid bound to a column of it's <type scope="com::sun::star::form::component">DataForm</type>, and the form is not positioned on a new record (see <member scope="com::sun::star::sdb">RowSet::IsNew</member>), then <member>XReset::reset</member> does not reset the model's value to it's default value, but uses the @@ -82,7 +82,7 @@ published service DataAwareControlModel <p>In the context of a <type scope="com::sun::star::form::component">DataForm</type>, controls are automatically reset when one of the following applies - <ul><li>The form is reset by invoking it's <type>XReset</type> interface.</li> + <ul><li>The form is reset by invoking it's XReset interface.</li> <li>The form moves to a new record.</li> <li>The changes in the current record of the form are undone</li> </ul> @@ -99,7 +99,7 @@ published service DataAwareControlModel This member here describes the column of this result set which the control should act for.</p> <p>Not every control model can be bound to every database column. Usually, super services of the - <type>DataAwareControlModel</type> restrict the column types they can be used with.</p> + DataAwareControlModel restrict the column types they can be used with.</p> @see DataAwareControlModel::BoundField */ diff --git a/offapi/com/sun/star/form/FormComponents.idl b/offapi/com/sun/star/form/FormComponents.idl index 6fc6ddf645bc..17dd0e9b3a98 100644 --- a/offapi/com/sun/star/form/FormComponents.idl +++ b/offapi/com/sun/star/form/FormComponents.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module form { -/** specifies the capabilities of a collection of <type>FormComponent</type>s. +/** specifies the capabilities of a collection of FormComponents. <p>The collection must provide the possibility of adding and removing components by name and by index. The name of a component is not @@ -60,9 +60,9 @@ published service FormComponents for the contained components. <p>The interface allows managing of scripts associated with dependent components, accessed by index. - However, as a client of the <type>FormComponents</type> service, there's no need to bother with + However, as a client of the FormComponents service, there's no need to bother with the container aspect of the <type scope="com::sun::star::script">XEventAttacherManager</type> - directly. A <type>FormComponents</type> container will automatically synchronize the elements + directly. A FormComponents container will automatically synchronize the elements you put into it with the scripting information obtained at the <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> diff --git a/offapi/com/sun/star/form/FormControlModel.idl b/offapi/com/sun/star/form/FormControlModel.idl index 1eacba7a35f7..f2ff078b7d9b 100644 --- a/offapi/com/sun/star/form/FormControlModel.idl +++ b/offapi/com/sun/star/form/FormControlModel.idl @@ -69,7 +69,7 @@ published service FormControlModel <p>Each component which supports a tabstop must provide a <member>FormControlModel::TabIndex</member> property.</p> - <p>Normally, a <type>FormController</type> instance is evaluating this property.</p> + <p>Normally, a FormController instance is evaluating this property.</p> */ [optional, property] short TabIndex; diff --git a/offapi/com/sun/star/form/Forms.idl b/offapi/com/sun/star/form/Forms.idl index 2b86048ac2c2..eccec74e7a7b 100644 --- a/offapi/com/sun/star/form/Forms.idl +++ b/offapi/com/sun/star/form/Forms.idl @@ -27,7 +27,7 @@ /** specifies the capabilities of a collection of forms. - <p>Basically, a <type>Forms</type> is a <type>FormComponents</type>, + <p>Basically, a Forms is a FormComponents, with the additional restriction that the contained elements support the <type scope="com::sun::star::form::component">Form</type> service.</p> diff --git a/offapi/com/sun/star/form/NavigationBarMode.idl b/offapi/com/sun/star/form/NavigationBarMode.idl index ce6e148fb177..c6a7906c4b49 100644 --- a/offapi/com/sun/star/form/NavigationBarMode.idl +++ b/offapi/com/sun/star/form/NavigationBarMode.idl @@ -32,7 +32,7 @@ published enum NavigationBarMode /** no navigation bar is provided and navigation on the current form is only possible with the keyboard (TAB/SHIFT TAB). - <p>Note that when this mode is set, a simultaneous <type>TabulatorCycle</type> + <p>Note that when this mode is set, a simultaneous TabulatorCycle value of <member>TabulatorCycle::CURRENT</member> means that you cannot travel between records anymore.</p> diff --git a/offapi/com/sun/star/form/PropertyBrowserController.idl b/offapi/com/sun/star/form/PropertyBrowserController.idl index 45fd26fe696d..1ef3164d82e2 100644 --- a/offapi/com/sun/star/form/PropertyBrowserController.idl +++ b/offapi/com/sun/star/form/PropertyBrowserController.idl @@ -33,7 +33,7 @@ <p>The controller can be plugged into an <type scope="com::sun::star::frame">XFrame</type>, and will provide a visual component for inspecting control properties. This means it allows to interactively control - several aspects of a <type>FormControlModel</type> or <type>DataAwareControlModel</type>, such as it's + several aspects of a FormControlModel or DataAwareControlModel, such as it's data binding, it's layout, and it's event binding</p> <p>For using a PropertyBrowserController, you need to @@ -83,7 +83,7 @@ published service PropertyBrowserController /** controls the actually visible page. - <p>The aspects of a <type>DataAwareControlModel</type> which can be browsed and modified + <p>The aspects of a DataAwareControlModel which can be browsed and modified using this controller can be separated into 3 groups: common aspects, data-awareness related aspects, and bound events.</br> The appearance of the visual component created by the controller is that 3 tab pages, one for diff --git a/offapi/com/sun/star/form/TabulatorCycle.idl b/offapi/com/sun/star/form/TabulatorCycle.idl index c3367183d6bc..f6ab1e94a85c 100644 --- a/offapi/com/sun/star/form/TabulatorCycle.idl +++ b/offapi/com/sun/star/form/TabulatorCycle.idl @@ -27,10 +27,10 @@ /** specifies how the TAB key should be used in a form. <p>If the last control of a form is focused, and the user pressed the TAB key, there are - several possibilities how a <type>FormController</type> should handle this. - <type>TabulatorCycle</type> specifies these possibilities.</p> + several possibilities how a FormController should handle this. + TabulatorCycle specifies these possibilities.</p> - <p>Note that the <type>TabulatorCycle</type> determines what happens when SHIFT-TAB + <p>Note that the TabulatorCycle determines what happens when SHIFT-TAB is pressed on the <em>first</em> control of a form, as well as when TAB is pressed on the <em>last</em> control.</p> diff --git a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl index bf990cba4dd1..88ecbef06311 100644 --- a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl +++ b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl @@ -31,7 +31,7 @@ /** allows to probably veto actions to be performed on components. <p> Usually, a component which supports the - <type>XApproveActionBroadcaster</type> interface implements + XApproveActionBroadcaster interface implements <type scope="com::sun::star::awt">XActionListener</type> as well.</p> */ published interface XApproveActionBroadcaster: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/form/XBoundComponent.idl b/offapi/com/sun/star/form/XBoundComponent.idl index 8acb4501c2c8..4f3bd6dc8221 100644 --- a/offapi/com/sun/star/form/XBoundComponent.idl +++ b/offapi/com/sun/star/form/XBoundComponent.idl @@ -30,13 +30,13 @@ <p>The interface provides the possibility of committing its respective data to a data source it is bound to. A <member>commit</member> will be - performed by the environment (usually, a <type>FormController</type>).<br/> + performed by the environment (usually, a FormController).<br/> For example, suppose you have a data-bound control that is connected to a database field. Each time the control loses its focus, the model (component) of the control is triggered by the environment to store its value in the database field.</p> - <p>A commit may fail if an <type>XUpdateListener</type> vetoes the it.</p> + <p>A commit may fail if an XUpdateListener vetoes the it.</p> @see com::sun::star::form::XUpdateListener */ diff --git a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl index afbbe886e19d..868c7e68fe66 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl @@ -34,7 +34,7 @@ <type scope="com::sun::star::form::component">DataForm</type> is such a component. When it is bound to a statement which contains parameters, or to a query which is based upon a parametrized statement, it needs values to fill in the parameters with actual values when it is being loaded. - One method to gather these values is calling the <type>XDatabaseParameterListener</type> listeners, which + One method to gather these values is calling the XDatabaseParameterListener listeners, which can fill them in.</p> */ published interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl index 7da6fc4a5435..549f99240952 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module form { /** provides the possibility of receiving an event for configuration of parameters. <p>Note that this interface provides exactly the same functionality as the - <type>XDatabaseParameterBroadcaster</type> interface. It exists purely for compatibility + XDatabaseParameterBroadcaster interface. It exists purely for compatibility with the <member scope="com::sun::star::script">XEventAttacher::attachSingleEventListener</member>: It expects the methods for adding and removing listeners to follow a certain naming scheme, respective to the name of the listener which is being added/removed.</p> diff --git a/offapi/com/sun/star/form/XForm.idl b/offapi/com/sun/star/form/XForm.idl index 2d1a708317d4..4964ab1cdadc 100644 --- a/offapi/com/sun/star/form/XForm.idl +++ b/offapi/com/sun/star/form/XForm.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module form { -/** identifies a <type>FormComponent</type> as being a (sub-) form. +/** identifies a FormComponent as being a (sub-) form. <p>This interface does not really provide an own functionality, it is only for easier runtime identification of form components.</p> diff --git a/offapi/com/sun/star/form/XFormControllerListener.idl b/offapi/com/sun/star/form/XFormControllerListener.idl index 7945132c43d0..2d4262747f95 100644 --- a/offapi/com/sun/star/form/XFormControllerListener.idl +++ b/offapi/com/sun/star/form/XFormControllerListener.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module form { -/** allows to be notified when the activation status of a <type>FormController</type> changes. +/** allows to be notified when the activation status of a FormController changes. <p> A form controller is activated if a form control gains the focus and none of its controls currently owned the focus before.</p> diff --git a/offapi/com/sun/star/form/XForms.idl b/offapi/com/sun/star/form/XForms.idl index 4571d9c28d6c..577c1b699963 100644 --- a/offapi/com/sun/star/form/XForms.idl +++ b/offapi/com/sun/star/form/XForms.idl @@ -57,9 +57,9 @@ published interface XForms for the contained components. <p>The interface allows managing of scripts associated with dependent components, accessed by index. - However, as a client of the <type>FormComponents</type> service, there's no need to bother with + However, as a client of the FormComponents service, there's no need to bother with the container aspect of the <type scope="com::sun::star::script">XEventAttacherManager</type> - directly. A <type>FormComponents</type> container will automatically synchronize the elements + directly. A FormComponents container will automatically synchronize the elements you put into it with the scripting information obtained at the <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> diff --git a/offapi/com/sun/star/form/XFormsSupplier2.idl b/offapi/com/sun/star/form/XFormsSupplier2.idl index a587d0f02232..1d7efaf1e582 100644 --- a/offapi/com/sun/star/form/XFormsSupplier2.idl +++ b/offapi/com/sun/star/form/XFormsSupplier2.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module form { -/** extends the <type>XFormsSupplier</type> with convenience methods +/** extends the XFormsSupplier with convenience methods */ interface XFormsSupplier2: XFormsSupplier { diff --git a/offapi/com/sun/star/form/XResetListener.idl b/offapi/com/sun/star/form/XResetListener.idl index 10869ee24667..ef7c6b4e326d 100644 --- a/offapi/com/sun/star/form/XResetListener.idl +++ b/offapi/com/sun/star/form/XResetListener.idl @@ -31,7 +31,7 @@ /** is the interface for receiving notifications about reset events. <p>The listener is called if a component implementing the - <type>XReset</type> interface performs a reset.</br> + XReset interface performs a reset.</br> Order of events: <ul><li>a reset is triggered on a component</li> <li>the component calls <member>XReset::approveReset</member> on all its listeners</li> diff --git a/offapi/com/sun/star/form/XUpdateListener.idl b/offapi/com/sun/star/form/XUpdateListener.idl index c3e224ea4d5f..24731f6ff2a7 100644 --- a/offapi/com/sun/star/form/XUpdateListener.idl +++ b/offapi/com/sun/star/form/XUpdateListener.idl @@ -39,7 +39,7 @@ published interface XUpdateListener: com::sun::star::lang::XEventListener /** is invoked to check the current data. - <p>For a given update process, if one of the <type>XUpdateListener</type>s + <p>For a given update process, if one of the XUpdateListeners vetoes the change, the update is canceled, and no further notification happens.</p> @param aEvent diff --git a/offapi/com/sun/star/form/binding/BindableControlModel.idl b/offapi/com/sun/star/form/binding/BindableControlModel.idl index c2d1b4bac9ca..1c808d143f67 100644 --- a/offapi/com/sun/star/form/binding/BindableControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableControlModel.idl @@ -44,7 +44,7 @@ service BindableControlModel /** specifies support for being bound to an external value - <p>When a <type>BindableControlModel</type> is bound to an external value, + <p>When a BindableControlModel is bound to an external value, then every change in the control model's value is <em>immediately</em> reflected in the external binding.</p> diff --git a/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl b/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl index fda817d8223a..89a5a9b51534 100644 --- a/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl @@ -50,13 +50,13 @@ module com { module sun { module star { module form { module binding { data of the control model is written into the associated <type scope="com::sun::star::form::component">DataForm</type> column.</p> - <p><type>BindableDataAwareControlModel</type>'s additionally support an alternative value + <p>BindableDataAwareControlModel's additionally support an alternative value binding, which forces them to exchange their value with another foreign instance. In some sense, they are an abstraction of the data aware control models, which only support a specialized, hard-coded value binding (namely the binding to a <type scope="com::sun::star::form::component">DataForm</type> column).</p> - <p>For this, they provide the <type>XBindableValue</type> interface which allows to + <p>For this, they provide the XBindableValue interface which allows to set an external component to exchange the value with.</p> <p>The following rules apply when a data aware control model is bound to an external value binding: @@ -71,26 +71,26 @@ module com { module sun { module star { module form { module binding { of the control model is loaded (<type scope="com::sun::star::form">XLoadable</type>). </li> <li><b>Immediacy</b><br/> - When a <type>BindableDataAwareControlModel</type> is bound to an external value, + When a BindableDataAwareControlModel is bound to an external value, then every change in the control model's value is <em>immediately</em> reflected in the external binding. This is a difference to SQL bindings of most <type scope="com::sun::star::form">DataAwareControlModel</type>'s, where changes in the control model's value are only propagated to the bound column upon explicit request via <member scope="com::sun::star::form">XBoundComponent::commit</member>.<br/> - Note that this restriction is inherited from the <type>BindableControlModel</type>. + Note that this restriction is inherited from the BindableControlModel. </li> <li><b>Cloning</b><br/> <type scope="com::sun::star::form">FormControlModel</type>s support cloning themselves via the <type scope="com::sun::star::util">XCloneable</type> interface which they inherit from the <type scope="com::sun::star::awt">UnoControlModel</type> service.</br> - When a <type>BindableDataAwareControlModel</type> is cloned while it has an active + When a BindableDataAwareControlModel is cloned while it has an active external value binding, then the clone is also bound to the same binding instance.<br/> - Note that this restriction is inherited from the <type>BindableControlModel</type>. + Note that this restriction is inherited from the BindableControlModel. </li> </ul> </p> - <p>When a <type>BindableDataAwareControlModel</type> is being bound to an external value, + <p>When a BindableDataAwareControlModel is being bound to an external value, using <member>XBindableValue::setValueBinding</member>, then the control model (it's value property, respectively) and the external value are initially synchronized by setting the external value (<member>XValueBinding::getValue</member>) diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl index e75cd919c43c..0b628c9f5ae9 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module form { module binding { database field, and additionally supports binding to arbitrary external values. <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which - can be associated with a <type>BindableDatabaseCheckBox</type> must support exchanging + can be associated with a BindableDatabaseCheckBox must support exchanging boolean values. The following mapping between external values and control states apply: <ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li> <li><FALSE/> will be mapped to it being unchecked, and vice versa</li> @@ -40,7 +40,7 @@ module com { module sun { module star { module form { module binding { mapped to <NULL/> when writing the external value.</li> </ul></p> - <p>If the value binding associated with a <type>BindableDatabaseCheckBox</type> + <p>If the value binding associated with a BindableDatabaseCheckBox supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">CheckBox::RefValue</member> is <em>not</em> empty, then the radio button will exchange it's value as string: <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li> diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl index f92f5671b476..37fedc23ac5d 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module form { module binding { database field, and additionally supports binding to arbitrary external values. <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which - can be associated with a <type>BindableDatabaseFormattedField</type> must support exchanging + can be associated with a BindableDatabaseFormattedField must support exchanging values of type <em>double</em>.</p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl index 4540dde132a4..c683fb1a96c3 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseListBox.idl @@ -29,9 +29,9 @@ module com { module sun { module star { module form { module binding { /** This service specifies a list box model which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>There are six possible ways that a <type>BindableDatabaseListBox</type> exchanges + <p>There are six possible ways that a BindableDatabaseListBox exchanges values with an external binding. If a new binding - is set at a <type>BindableDatabaseListBox</type>, the types from the following list are + 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>: diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl index 0e5e0a1a121d..511acfb6e3fd 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module form { module binding { database field, and additionally supports binding to arbitrary external values. <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which - can be associated with a <type>BindableDatabaseNumericField</type> must support exchanging + can be associated with a BindableDatabaseNumericField must support exchanging values of type <em>double</em>.</p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl index 91260f240db2..c7eb5fbb2b0c 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl @@ -31,14 +31,14 @@ module com { module sun { module star { module form { module binding { database field, and additionally supports binding to arbitrary external values. <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which - can be associated with a <type>BindableDatabaseRadioButton</type> must support exchanging + can be associated with a BindableDatabaseRadioButton must support exchanging boolean values. The following mapping between external values and control states apply: <ul><li><TRUE/> will be mapped to the button being checked, and vice versa</li> <li><FALSE/> will be mapped to it being unchecked, and vice versa</li> <li><NULL/> will be mapped to it being in undetermined state</li> </ul></p> - <p>If the value binding associated with a <type>BindableDatabaseRadioButton</type> + <p>If the value binding associated with a BindableDatabaseRadioButton supports exchanging string values, <em>and</em> the <member scope="com::sun::star::form::component">RadioButton::RefValue</member> is <em>not</em> empty, then the radio button will exchange it's value as string: <ul><li>A string equal to the reference value will be mapped to the button being checked, and vice versa</li> diff --git a/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl b/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl index 120c54f92676..37ebd2a74470 100644 --- a/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl +++ b/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module form { module binding { -/** this service specifies a <type>BindableControlModel</type> which reflects +/** this service specifies a BindableControlModel which reflects an integer value, out of a range of permitted integer values. - <p><type>BindableIntegerValueRange</type>s have a value property, a minimum, and a maximum, + <p>BindableIntegerValueRanges have a value property, a minimum, and a maximum, all of type integer.</p> */ service BindableIntegerValueRange diff --git a/offapi/com/sun/star/form/binding/IncompatibleTypesException.idl b/offapi/com/sun/star/form/binding/IncompatibleTypesException.idl index 5b19afb81a12..93a57e44c263 100644 --- a/offapi/com/sun/star/form/binding/IncompatibleTypesException.idl +++ b/offapi/com/sun/star/form/binding/IncompatibleTypesException.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module form { module binding { -/** thrown to indicate that the types of an <type>XValueBinding</type> and - an <type>XBindableValue</type> are incompatible +/** thrown to indicate that the types of an XValueBinding and + an XBindableValue are incompatible */ exception IncompatibleTypesException: com::sun::star::uno::Exception { diff --git a/offapi/com/sun/star/form/binding/InvalidBindingStateException.idl b/offapi/com/sun/star/form/binding/InvalidBindingStateException.idl index e7979450f7fc..18bda6070d6d 100644 --- a/offapi/com/sun/star/form/binding/InvalidBindingStateException.idl +++ b/offapi/com/sun/star/form/binding/InvalidBindingStateException.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module form { module binding { -/** thrown when an <type>XValueBinding</type> cannot perform a requested +/** thrown when an XValueBinding cannot perform a requested operation due to an invalid state. */ exception InvalidBindingStateException: com::sun::star::uno::Exception diff --git a/offapi/com/sun/star/form/binding/ListEntrySource.idl b/offapi/com/sun/star/form/binding/ListEntrySource.idl index 70ed83d96e5d..b4873ca465ef 100644 --- a/offapi/com/sun/star/form/binding/ListEntrySource.idl +++ b/offapi/com/sun/star/form/binding/ListEntrySource.idl @@ -38,14 +38,14 @@ service ListEntrySource /** allows life time control for the component - <p>An <type>ListEntrySource</type> will be known to one ore more components - supporting the <type>XListEntrySink</type> interface, which all work with - this source. However, they will not <em>own</em> the <type>ListEntrySource</type>. + <p>An ListEntrySource will be known to one ore more components + supporting the XListEntrySink interface, which all work with + this source. However, they will not <em>own</em> the ListEntrySource. The ownership is with another instance, which may also decide to obsolete - the <type>ListEntrySource</type> for whatever reasons (e.g. because the data model - which the binding reflected died). For this reason, a <type>ListEntrySource</type> + the ListEntrySource for whatever reasons (e.g. because the data model + which the binding reflected died). For this reason, a ListEntrySource must offer a possibility to be obsoleted by it's owner, and to notify this - obsoleteness to other interested parties, such as <type>XListEntrySink</type>s.</p> + obsoleteness to other interested parties, such as XListEntrySinks.</p> */ interface com::sun::star::lang::XComponent; }; diff --git a/offapi/com/sun/star/form/binding/ValueBinding.idl b/offapi/com/sun/star/form/binding/ValueBinding.idl index 4107f7afa21b..34b3b565d672 100644 --- a/offapi/com/sun/star/form/binding/ValueBinding.idl +++ b/offapi/com/sun/star/form/binding/ValueBinding.idl @@ -38,12 +38,12 @@ service ValueBinding { /** determines whether the value is currently readonly - <p>For instance, you could imagine a <type>ValueBinding</type> which + <p>For instance, you could imagine a ValueBinding which represents a cell in a spreadsheet document, and whose value is readonly as long as the spreadsheet is locked.</p> <p>As long as this property is <TRUE/>, the value binding should throw - a <type>InvalidBindingStateException</type> when its + a InvalidBindingStateException when its <member>XValueBinding::setValue</member> method is invoked.</p> */ [optional, property, bound, readonly] boolean ReadOnly; @@ -55,11 +55,11 @@ service ValueBinding data structure may not be relevant currently. This is indicated by the <member>Relevant</member> property being <FALSE/>.</p> - <p><type>XBindableValue</type>s which are bound to this binding may or may not + <p>XBindableValues which are bound to this binding may or may not react in certain ways on the (ir)relevance of their bound value.</p> <p>One possible reaction could be that user interface elements which are associated - with the <type>XBindableValue</type> are disabled as long as <member>Relevant</member> + with the XBindableValue are disabled as long as <member>Relevant</member> is <FALSE/>.</p> */ [optional, property, bound, readonly] boolean Relevant; @@ -73,7 +73,7 @@ service ValueBinding interface XValueBinding; /** allows other components to be notified when the value represented - by the <type>ValueBinding</type> instance changes. + by the ValueBinding instance changes. <p>This interface is optional, since a binding may not support actively notifying changes in it's value. Note, however, that in case @@ -85,14 +85,14 @@ service ValueBinding /** allows life time control for the component - <p>An <type>ValueBinding</type> may be known to one ore more components - supporting the <type>XBindableValue</type> interface, which all work with - this binding. However, they will not <em>own</em> the <type>ValueBinding</type>. + <p>An ValueBinding may be known to one ore more components + supporting the XBindableValue interface, which all work with + this binding. However, they will not <em>own</em> the ValueBinding. The ownership is with another instance, which may also decide to obsolete - the <type>ValueBinding</type> for whatever reasons (e.g. because the data model - which the binding reflected died). For this reason, a <type>ValueBinding</type> + the ValueBinding for whatever reasons (e.g. because the data model + which the binding reflected died). For this reason, a ValueBinding must offer a possibility to be obsoleted by it's owner, and to notify this - obsoleteness to other interested parties, such as <type>XBindableValue</type>s.</p> + obsoleteness to other interested parties, such as XBindableValues.</p> */ interface com::sun::star::lang::XComponent; }; diff --git a/offapi/com/sun/star/form/binding/XBindableValue.idl b/offapi/com/sun/star/form/binding/XBindableValue.idl index 5bc227c63637..708084a61aff 100644 --- a/offapi/com/sun/star/form/binding/XBindableValue.idl +++ b/offapi/com/sun/star/form/binding/XBindableValue.idl @@ -43,7 +43,7 @@ interface XBindableValue : com::sun::star::uno::XInterface the new binding which is to be used by the component. May be <NULL/>, in this case only the current binding is revoked. - @throws <type>IncompatibleTypesException</type> + @throws IncompatibleTypesException if the new binding (provided it's not <NULL/>) supports only types which are incompatible with the types of the bindable component. */ diff --git a/offapi/com/sun/star/form/binding/XValueBinding.idl b/offapi/com/sun/star/form/binding/XValueBinding.idl index ec03f73606e4..68400f583156 100644 --- a/offapi/com/sun/star/form/binding/XValueBinding.idl +++ b/offapi/com/sun/star/form/binding/XValueBinding.idl @@ -51,7 +51,7 @@ interface XValueBinding : com::sun::star::uno::XInterface /** retrieves the current value - @throws <type>IncompatibleTypesException</type> + @throws IncompatibleTypesException if the requested value type is not supported by the binding @see getSupportedValueTypes @see supportsType @@ -61,9 +61,9 @@ interface XValueBinding : com::sun::star::uno::XInterface /** sets the current value - @throws <type>IncompatibleTypesException</type> + @throws IncompatibleTypesException if the given value type is not supported by the binding - @throws <type>InvalidBindingStateException</type> + @throws InvalidBindingStateException if the value currently cannot be changed, since the binding is not fully operational. Possible reasons for this include the binding being readonly, or the target of the binding not being present. diff --git a/offapi/com/sun/star/form/component/CheckBox.idl b/offapi/com/sun/star/form/component/CheckBox.idl index d374a9a2162c..57acd34180e6 100644 --- a/offapi/com/sun/star/form/component/CheckBox.idl +++ b/offapi/com/sun/star/form/component/CheckBox.idl @@ -31,7 +31,7 @@ /** specifies the model of a check box control <p>The model supports the properties required for HTML, thus you can build up - <type>HTMLForm</type>s with it</p> + HTMLForms with it</p> */ published service CheckBox { @@ -59,7 +59,7 @@ published service CheckBox /** contains a reference value which is used for submission in a HTML form - <p>When submitting a <type>HTMLForm</type> which contains a check box, + <p>When submitting a HTMLForm which contains a check box, which is checked, the RefValue is used for submission. */ [property] string RefValue; diff --git a/offapi/com/sun/star/form/component/DataForm.idl b/offapi/com/sun/star/form/component/DataForm.idl index 71a043b96f19..477af290900f 100644 --- a/offapi/com/sun/star/form/component/DataForm.idl +++ b/offapi/com/sun/star/form/component/DataForm.idl @@ -51,16 +51,16 @@ published service DataForm /** is used to reset controls belonging to the form, and to reset database fields to which the controls are bound - <p>A <type>DataForm</type> is reset either on explicit request, or after it is moved + <p>A DataForm is reset either on explicit request, or after it is moved to the insertion row.</p> <p>The insertion row is a virtual row which is used to insert new records. It is reached by calling <member scope="com::sun::star::sdbc">XResultSetUpdate::moveToInsertRow</member>. The <type scope="com::sun::star::sdb">RowSet</type> service specifies exactly which notifications happen in which order when calling <member scope="com::sun::star::sdbc">XResultSetUpdate::moveToInsertRow</member>, - and a <type>DataForm</type> implementation extends this with the following contract: + and a DataForm implementation extends this with the following contract: <ul><li>After all notifications as defined in the <type scope="com::sun::star::sdb">RowSet</type> - service have been sent, the <type>DataForm</type> resets itself, if all + service have been sent, the DataForm resets itself, if all <type scope="com::sun::star::form">XResetListeners</type> approve this.</li> <li>After the reset happened, the <member scope="com::sun::star::sdb">RowSet::IsModified</member> property is reset to <FALSE/>. This property might have been switched to <TRUE/> during listener diff --git a/offapi/com/sun/star/form/component/DatabaseListBox.idl b/offapi/com/sun/star/form/component/DatabaseListBox.idl index ba6e17197f70..ba078d84150f 100644 --- a/offapi/com/sun/star/form/component/DatabaseListBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseListBox.idl @@ -32,7 +32,7 @@ /** This service specifies a data-aware list box control model. - <p>The base service for list boxes (<type>ListBox</type>) offers only + <p>The base service for list boxes (ListBox) offers only one possibility to specify the list entries: The display strings in the <member scope="com::sun::star::awt">UnoControlListBoxModel::StringItemList</member> diff --git a/offapi/com/sun/star/form/component/GridControl.idl b/offapi/com/sun/star/form/component/GridControl.idl index fa4766c67681..5f9c8a3aaea5 100644 --- a/offapi/com/sun/star/form/component/GridControl.idl +++ b/offapi/com/sun/star/form/component/GridControl.idl @@ -53,7 +53,7 @@ display not only the current row of the form, but all rows (at least potentially, limited by the control size, of course).</p> - <p>The table rows in a grid control correspond to the rows in the <type>DataForm</type> + <p>The table rows in a grid control correspond to the rows in the DataForm the control belongs to, and the columns correspond to single columns of the form's row set.</p> <p>Columns of a grid control are modeled by own objects, too. They are very similar to usual @@ -67,7 +67,7 @@ published service GridControl /** provides basic functionality of a container of <type scope="com::sun::star::form">FormComponent</type>s. <p>All the container-related methods of this service related to control models, - this is what are the container elements for a <type>GridControl</type>.</p> + this is what are the container elements for a GridControl.</p> <p>As the <type scope="com::sun::star::form">FormComponents</type> service also specifies the <type scope"com::sun::star::script">XEventAttacherManager</type> service, grid control models diff --git a/offapi/com/sun/star/form/component/HTMLForm.idl b/offapi/com/sun/star/form/component/HTMLForm.idl index 785d7f1a45d3..acb40e5df95a 100644 --- a/offapi/com/sun/star/form/component/HTMLForm.idl +++ b/offapi/com/sun/star/form/component/HTMLForm.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module form { module component { -/** This service specifies the special kind of <type>Form</type>s for HTML documents. +/** This service specifies the special kind of Forms for HTML documents. <p>An HTMLForm fulfills the specification of forms in HTML. It supplies the possibility of submitting or resetting the contents of a form. diff --git a/offapi/com/sun/star/form/component/ImageButton.idl b/offapi/com/sun/star/form/component/ImageButton.idl index 04d0e087d661..ee804b18e34d 100644 --- a/offapi/com/sun/star/form/component/ImageButton.idl +++ b/offapi/com/sun/star/form/component/ImageButton.idl @@ -59,7 +59,7 @@ published service ImageButton at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with the binary data of the image.<br/> - Usually, controls acting for an <type>ImageButton</type> model are consumers, and use the + Usually, controls acting for an ImageButton model are consumers, and use the data stream to display the image</p> */ interface com::sun::star::form::XImageProducerSupplier; diff --git a/offapi/com/sun/star/form/component/NavigationToolBar.idl b/offapi/com/sun/star/form/component/NavigationToolBar.idl index 8f25befa50c2..275f17627103 100644 --- a/offapi/com/sun/star/form/component/NavigationToolBar.idl +++ b/offapi/com/sun/star/form/component/NavigationToolBar.idl @@ -27,7 +27,7 @@ /** This service specifies the model for control which provides controller - functionality for a <type>DataForm</type>, such as navigating or filtering + functionality for a DataForm, such as navigating or filtering the form. */ service NavigationToolBar diff --git a/offapi/com/sun/star/form/component/RadioButton.idl b/offapi/com/sun/star/form/component/RadioButton.idl index dbc820437461..25017b23e0ba 100644 --- a/offapi/com/sun/star/form/component/RadioButton.idl +++ b/offapi/com/sun/star/form/component/RadioButton.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module component { -/** specifies a component which acts as a radio button as needed in <type>HTMLForm</type>s. +/** specifies a component which acts as a radio button as needed in HTMLForms. <p>Radio buttons are controls which can be grouped together, and in every group, only one of the controls can be check. This means if one of them diff --git a/offapi/com/sun/star/form/component/SubmitButton.idl b/offapi/com/sun/star/form/component/SubmitButton.idl index 7053f1fd561d..eed9c7bcd5ed 100644 --- a/offapi/com/sun/star/form/component/SubmitButton.idl +++ b/offapi/com/sun/star/form/component/SubmitButton.idl @@ -41,7 +41,7 @@ service SubmitButton <p>Note that the control model itself will not make any use of the submission. Instead, submissions are triggered by a control (not a control <em>model</em>). Thus, the <type scope="com::sun::star::form::control">SubmitButton</type> - control associated with a <type>SubmitButton</type> model is responsible for + control associated with a SubmitButton model is responsible for using the submission supplied at this model.</p> */ interface com::sun::star::form::submission::XSubmissionSupplier; diff --git a/offapi/com/sun/star/form/component/TextField.idl b/offapi/com/sun/star/form/component/TextField.idl index 1f8fce2e0fb2..c297f799fd23 100644 --- a/offapi/com/sun/star/form/component/TextField.idl +++ b/offapi/com/sun/star/form/component/TextField.idl @@ -41,7 +41,7 @@ published service TextField /** specifies optional capabilities for displaying and inputting formatted text. <p>If the <member>RichTextControl::RichText</member> property is set to <TRUE/>, - then the <type>TextField</type> component will disable it's reset capabilities. This means + then the TextField component will disable it's reset capabilities. This means that all calls to <member scope="com::sun::star::form">XReset::reset</member> will be ignored.</p> */ [optional] service RichTextControl; diff --git a/offapi/com/sun/star/form/control/SubmitButton.idl b/offapi/com/sun/star/form/control/SubmitButton.idl index 816efda2f9ac..d9157b4a490f 100644 --- a/offapi/com/sun/star/form/control/SubmitButton.idl +++ b/offapi/com/sun/star/form/control/SubmitButton.idl @@ -48,7 +48,7 @@ module com { module sun { module star { module form { module control { is present, it's <member scope="com::sun::star::form">XSubmit::submit</member> method is invoked.<br/> Since the parent object of a submit button can only be a <type scope="com::sun::star::form::component">Form</type>, - this means that <type>SubmitButton</type>s are also able to submit <type scope="com::sun::star::form::component">HTMLForm</type>s. + this means that SubmitButtons are also able to submit <type scope="com::sun::star::form::component">HTMLForm</type>s. </li> </ol> </p> diff --git a/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl index 2f434e4d9837..1d82d7a80fe7 100644 --- a/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module form { module inspection { <p>The handler expects a value named "ContextDocument" in the context in which it is created. That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the - <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + CellBindingPropertyHandler is examined for a value with this name. If the object in this value denotes a spreadsheet document (indicated by supporting the <type scope="com::sun::star::sheet">XSpreadsheetDocument</type> interface), this document is used to create the <type scope="com::sun::star::form::binding">ValueBinding</type>s to bind the inspected object to cells in this document.</p> diff --git a/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl index 6be180019633..63e785427454 100644 --- a/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl +++ b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl @@ -27,18 +27,18 @@ module com { module sun { module star { module form { module inspection { /** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for - inspecting form components, in particular all components implementing the <type>FormComponent</type> + inspecting form components, in particular all components implementing the FormComponent service. - <p>A <type>DefaultFormComponentInspectorModel</type> provides the following handlers by default: - <ul><li><type>ButtonNavigationHandler</type></li> - <li><type>CellBindingPropertyHandler</type></li> - <li><type>EditPropertyHandler</type></li> - <li><type>EventHandler</type></li> - <li><type>FormComponentPropertyHandler</type></li> - <li><type>SubmissionPropertyHandler</type></li> - <li><type>XMLFormsPropertyHandler</type></li> - <li><type>XSDValidationPropertyHandler</type></li> + <p>A DefaultFormComponentInspectorModel provides the following handlers by default: + <ul><li>ButtonNavigationHandler</li> + <li>CellBindingPropertyHandler</li> + <li>EditPropertyHandler</li> + <li>EventHandler</li> + <li>FormComponentPropertyHandler</li> + <li>SubmissionPropertyHandler</li> + <li>XMLFormsPropertyHandler</li> + <li>XSDValidationPropertyHandler</li> </ul></p> @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories diff --git a/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl index 4684c1bb4c25..d27640bd9c76 100644 --- a/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module form { module inspection { <p>The handler expects a value named "ContextDocument" in the context in which it is created. That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the - <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + CellBindingPropertyHandler is examined for a value with this name. If the object in this value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> interface), this document is used to examine the XML submissions which the button can be bound to.</p> diff --git a/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl index 172dedab8919..0662637c1ee1 100644 --- a/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module form { module inspection { <p>The handler expects a value named "ContextDocument" in the context in which it is created. That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the - <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + CellBindingPropertyHandler is examined for a value with this name. If the object in this value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> interface), this document is used to do XML binding related work.</p> diff --git a/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl index 5b6aaf533545..a7b68694a696 100644 --- a/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl @@ -30,17 +30,17 @@ module com { module sun { module star { module form { module inspection { which provides properties related to binding form control models to XForm bindings and validating the form control content. - <p>By using an <type>XMLFormsPropertyHandler</type>, an <type scope="com::sun::star::inspection">ObjectInspector</type> + <p>By using an XMLFormsPropertyHandler, an <type scope="com::sun::star::inspection">ObjectInspector</type> can be used to bind form components to <type scope="com::sun::star::xforms">Binding</type> instances. Since those instances also support validating form control content (by supporting an <type scope="com::sun::star::form::validation">XValidator</type> interface), it seems reasonable to edit those validate-related properties (like the XSD data type to validate against) in the - <type scope="com::sun::star::inspection">ObjectInspector</type>, too. This is what an <type>XSDValidationPropertyHandler</type> + <type scope="com::sun::star::inspection">ObjectInspector</type>, too. This is what an XSDValidationPropertyHandler is good for.</p> <p>The handler expects a value named "ContextDocument" in the context in which it is created. That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the - <type>CellBindingPropertyHandler</type> is examined for a value with this name. If the object in this + CellBindingPropertyHandler is examined for a value with this name. If the object in this value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> interface), this document is used to do XML binding related work.</p> diff --git a/offapi/com/sun/star/form/runtime/FeatureState.idl b/offapi/com/sun/star/form/runtime/FeatureState.idl index fc1d2184725a..246258109752 100644 --- a/offapi/com/sun/star/form/runtime/FeatureState.idl +++ b/offapi/com/sun/star/form/runtime/FeatureState.idl @@ -37,7 +37,7 @@ struct FeatureState boolean Enabled; /** determines the state of the feature. The concrete semantics depends - on the concrete <type>FormFeature</type>. + on the concrete FormFeature. */ any State; }; diff --git a/offapi/com/sun/star/form/runtime/FormFeature.idl b/offapi/com/sun/star/form/runtime/FormFeature.idl index 50601e4acffb..6e9bb37428b2 100644 --- a/offapi/com/sun/star/form/runtime/FormFeature.idl +++ b/offapi/com/sun/star/form/runtime/FormFeature.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module form { module runtime { /** specifies the operations on a user interface form, as supported by the - <type>XFormOperations</type> interface. + XFormOperations interface. @since OOo 2.2 */ @@ -44,7 +44,7 @@ constants FormFeature including the potentially active insertion row. <p>This is not strictly an operation you can do on a form, but rather a - state you can retrieve (and display to the user) using the <type>XFormOperations</type>'s + state you can retrieve (and display to the user) using the XFormOperations's respective methods.</p> <p>The state obtained here is a string, not a number. This is because in an UI diff --git a/offapi/com/sun/star/form/runtime/XFeatureInvalidation.idl b/offapi/com/sun/star/form/runtime/XFeatureInvalidation.idl index 16885665b8ec..70d62892b375 100644 --- a/offapi/com/sun/star/form/runtime/XFeatureInvalidation.idl +++ b/offapi/com/sun/star/form/runtime/XFeatureInvalidation.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module form { module runtime { -/** implements a callback for a <type>XFormOperations</type> instance, which is called - when the state of one or more <type>FormFeature</type>s might have changed. +/** implements a callback for a XFormOperations instance, which is called + when the state of one or more FormFeatures might have changed. @see XFormOperations @@ -35,7 +35,7 @@ module com { module sun { module star { module form { module runtime { */ interface XFeatureInvalidation { - /** invalidates the given <type>FormFeature</type>s + /** invalidates the given FormFeatures <p>Invalidation means that any user interface representation (such as toolbox buttons), or any dispatches associated with the features in question are potentially out-of-date, and diff --git a/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl b/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl index 652f2899acef..db1384a1c7f0 100644 --- a/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl +++ b/offapi/com/sun/star/form/runtime/XFilterControllerListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module form { module runtime { -/** is implemented by components listening for events fired by an <type>XFilterController</type>. +/** is implemented by components listening for events fired by an XFilterController. @since OOo 3.3 */ diff --git a/offapi/com/sun/star/form/runtime/XFormController.idl b/offapi/com/sun/star/form/runtime/XFormController.idl index 0be5f6699fdc..79f4cf81eb8b 100644 --- a/offapi/com/sun/star/form/runtime/XFormController.idl +++ b/offapi/com/sun/star/form/runtime/XFormController.idl @@ -50,9 +50,9 @@ interface XFormControllerContext; Such a <code>FormController</code> is responsible for dialog processing, like controlling the tab order and the grouping of controls.</p> - <p>As a form may contain one or many subforms, a <type>FormController</type> may - contain one or more other <type>FormController</type>s, so the form model structure or hierarchy - is reflected in the structure of <type>FormController</type>s. That is, retrieving the parent of + <p>As a form may contain one or many subforms, a FormController may + contain one or more other FormControllers, so the form model structure or hierarchy + is reflected in the structure of FormControllers. That is, retrieving the parent of the model of a controller will give you the same object as retrieving the model of the parent of the controller. Similarly, retrieving the model of the <code>n</code><sup>th</sup> child of a controller gives you the same object as retrieving the <code>n</code><sup>th</sup> child of @@ -65,7 +65,7 @@ interface XFormControllerContext; <p>This interface supersedes the <type scope="com::sun::star::form">FormController</type>.</p> <h3>Responsibilities</h3> - <p>A <type>FormController</type> is responsible for a <type scope="com::sun::star::awt">UnoControlContainer</type>, + <p>A FormController is responsible for a <type scope="com::sun::star::awt">UnoControlContainer</type>, and all controls therein.</p> <p>Furthermore, a form controller is responsible for preventing invalid user input. That is, if the form @@ -313,7 +313,7 @@ interface XFormController /** allows controlling the filter mode. <p>If the form controller supports a <a href="#mode_selector">form based filter mode</a>, then it shall also - support the <type>XFilterController</type> interface, which allows controlling this mode.</p> + support the XFilterController interface, which allows controlling this mode.</p> */ [optional] interface XFilterController; diff --git a/offapi/com/sun/star/form/runtime/XFormControllerContext.idl b/offapi/com/sun/star/form/runtime/XFormControllerContext.idl index b4e0cded8b6b..5cce866a4dfb 100644 --- a/offapi/com/sun/star/form/runtime/XFormControllerContext.idl +++ b/offapi/com/sun/star/form/runtime/XFormControllerContext.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module form { module runtime { -/** provides a context for a <type>FormController</type> +/** provides a context for a FormController -<p>A <type>FormController</type> knows about the controls it is responsible +<p>A FormController knows about the controls it is responsible for, and about the control container which those controls live in. However, it doesn't know about a possible larger context, like a scrollable view which the controls are embedded into. To compensate this, it can be provided a <code>XFormControllerContext</code>.</p> diff --git a/offapi/com/sun/star/form/runtime/XFormOperations.idl b/offapi/com/sun/star/form/runtime/XFormOperations.idl index 535f420271c3..2e550a9f24cd 100644 --- a/offapi/com/sun/star/form/runtime/XFormOperations.idl +++ b/offapi/com/sun/star/form/runtime/XFormOperations.idl @@ -96,9 +96,9 @@ interface XFormOperations : ::com::sun::star::lang::XComponent evaluating to <TRUE/>.<p> @param Feature - the feature whose state is to be determined. Must be one of the <type>FormFeature</type> + the feature whose state is to be determined. Must be one of the FormFeature constants.<br/> - An invalid value here will be silently ignored, and simply return a <type>FeatureState</type> + An invalid value here will be silently ignored, and simply return a FeatureState indicating <em>disabled</em> with a <NULL/> state.</p> */ FeatureState getState( @@ -111,7 +111,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent <member>FeatureState::Enabled</member> member.</p> @param Feature - the feature whose state is to be determined. Must be one of the <type>FormFeature</type> + the feature whose state is to be determined. Must be one of the FormFeature constants.<br/> An invalid value here will be silently ignored, and simply return <FALSE/>. */ @@ -122,7 +122,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent /** executes the operation associated with the given feature @param Feature - the feature which is to be executed. Must be one of the <type>FormFeature</type> + the feature which is to be executed. Must be one of the FormFeature constants. @throws ::com::sun::star::lang::IllegalArgumentException @@ -149,11 +149,11 @@ interface XFormOperations : ::com::sun::star::lang::XComponent /** executes the operation associated with the given feature, with passing arguments for execution @param Feature - the feature which is to be executed. Must be one of the <type>FormFeature</type> + the feature which is to be executed. Must be one of the FormFeature constants. @param Arguments - the named arguments for the feature to execute. See the <type>FormFeature</type> list + the named arguments for the feature to execute. See the FormFeature list for features which require arguments. @throws ::com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/form/submission/XSubmissionSupplier.idl b/offapi/com/sun/star/form/submission/XSubmissionSupplier.idl index 355eb3abbe8d..61ef2d8eea48 100644 --- a/offapi/com/sun/star/form/submission/XSubmissionSupplier.idl +++ b/offapi/com/sun/star/form/submission/XSubmissionSupplier.idl @@ -35,7 +35,7 @@ interface XSubmission; */ interface XSubmissionSupplier : com::sun::star::uno::XInterface { - /** specifies the <type>XSubmission</type> instance to which the submission + /** specifies the XSubmission instance to which the submission request should be delegated. */ [attribute] XSubmission Submission; diff --git a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl index 0eaec046187b..910dc9f6b10f 100644 --- a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl @@ -32,10 +32,10 @@ module com { module sun { module star { module form { module validation { can interact with other components (well, except the trivial ones accessible by using <type scope="com::sun::star::beans">XPropertySet</type>): <ul><li>binding the value to an external component via <type scope="com::sun::star::form::binding">XBindableValue</type></li> - <li>validating the current value by an external component, via <type>XValidatable</type> and <type>XValidator</type></li> + <li>validating the current value by an external component, via XValidatable and XValidator</li> </ul></p> - <p>The <type>ValidatableBindableControlModel</type> services describes the interaction of these concepts + <p>The ValidatableBindableControlModel services describes the interaction of these concepts for control models which support both of them.</p> */ service ValidatableBindableControlModel @@ -49,7 +49,7 @@ service ValidatableBindableControlModel <p>If a value binding is established at the control model (by using <member scope="com::sun::star::form::binding">XBindableValue::setValueBinding</member> with a non-<NULL/> binding), this binding is analyzed for validation support. If it is present (read: if the - binding also supports the <type>XValidator</type> interface), the binding is also + binding also supports the XValidator interface), the binding is also established as validator, as if it has been passed to <member>XValidatable::setValidator</member>.<br/> If, while this binding is active (in both its roles as value binding and validator), an attempt is made to establish another validator, this is blocked with raising a diff --git a/offapi/com/sun/star/form/validation/ValidatableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableControlModel.idl index e630cfbcec47..e290947efa89 100644 --- a/offapi/com/sun/star/form/validation/ValidatableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableControlModel.idl @@ -50,8 +50,8 @@ service ValidatableControlModel /** enables support for validating the value of the control model <p>Setting an retrieving the current validator of the control model is - possible via the <type>XValidatable</type> interface (which - <type>XValidatableFormComponent</type> is derived from).</p> + possible via the XValidatable interface (which + XValidatableFormComponent is derived from).</p> <p>Easy access to the current value of the control, as well as it's validity (relative to the active validator), is provided by the methods <member>XValidatableFormComponent::isValid</member> @@ -66,8 +66,8 @@ service ValidatableControlModel <p>As soon as a validator is set via <member>XValidatable::setValidator</member>, the validatable control model registers itself as listener. If the validity constraint of the validator - changes, the <type>ValidatableControlModel</type> re-validates it's current valid, and - broadcasts any resuling changes to all its <type>XFormComponentValidityListener</type>, if + changes, the ValidatableControlModel re-validates it's current valid, and + broadcasts any resuling changes to all its XFormComponentValidityListener, if necessary.</p> */ interface XValidityConstraintListener; diff --git a/offapi/com/sun/star/form/validation/XFormComponentValidityListener.idl b/offapi/com/sun/star/form/validation/XFormComponentValidityListener.idl index 5289f9d10e0e..e8bcc5154d5d 100644 --- a/offapi/com/sun/star/form/validation/XFormComponentValidityListener.idl +++ b/offapi/com/sun/star/form/validation/XFormComponentValidityListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module form { module validation { -/** is the listener interface to be notified of changes of a <type>XValidatableFormComponent</type> +/** is the listener interface to be notified of changes of a XValidatableFormComponent */ interface XFormComponentValidityListener : com::sun::star::lang::XEventListener { @@ -36,7 +36,7 @@ interface XFormComponentValidityListener : com::sun::star::lang::XEventListener @param Source The member <member scope="com::sun::star::lang">EventObject::Source</member> - represents the <type>XValidatableFormComponent</type> whose validity, value, or text changed. + represents the XValidatableFormComponent whose validity, value, or text changed. */ void componentValidityChanged( [in] com::sun::star::lang::EventObject Source ); }; diff --git a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl index 5747e6060dc9..4aac6820129d 100644 --- a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl +++ b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl @@ -45,7 +45,7 @@ interface XFormComponentValidityListener; </ul> </p> - <p>An <type>XValidatableFormComponent</type> allows to easily access both of these aspects.</p> + <p>An XValidatableFormComponent allows to easily access both of these aspects.</p> <p>Note that all of the information provided at this interface can also obtained by other means, but much more inconveniently.</p> @@ -83,7 +83,7 @@ interface XValidatableFormComponent : XValidatable /** registers the given listener. - <p><type>XFormComponentValidityListener</type>s are called whenever <em>any</em> of the aspects + <p>XFormComponentValidityListeners are called whenever <em>any</em> of the aspects of the validatable form component (the validity flag, or the value) changed.</p> @throws <type scope="com::sun::star::lang">NullPointerException</type> diff --git a/offapi/com/sun/star/form/validation/XValidator.idl b/offapi/com/sun/star/form/validation/XValidator.idl index d5963260b636..31a2f95e43d1 100644 --- a/offapi/com/sun/star/form/validation/XValidator.idl +++ b/offapi/com/sun/star/form/validation/XValidator.idl @@ -36,7 +36,7 @@ interface XValidityConstraintListener; <p>Validators may additionally support dynamic validity constraints. In such a case, the validity of a given value may change, without the value changing itself.<br/> - To be notified about this, interested components should register as <type>XValidityConstraintListener</type>. + To be notified about this, interested components should register as XValidityConstraintListener. @see XValidatable */ @@ -62,7 +62,7 @@ interface XValidator : com::sun::star::uno::XInterface /** registers the given validity listener. - <p>Usually, an <type>XValidatable</type> instance will also add itself as validity listener, + <p>Usually, an XValidatable instance will also add itself as validity listener, as soon as the validator is introduced to it.</p> <p>Implementations which do not support dynamic validity constraints should simply ignore this diff --git a/offapi/com/sun/star/form/validation/XValidityConstraintListener.idl b/offapi/com/sun/star/form/validation/XValidityConstraintListener.idl index d22b935b0eb9..c3b67632f48d 100644 --- a/offapi/com/sun/star/form/validation/XValidityConstraintListener.idl +++ b/offapi/com/sun/star/form/validation/XValidityConstraintListener.idl @@ -27,11 +27,11 @@ module com { module sun { module star { module form { module validation { /** specifies an interface for listening for changes in the validity constraints - represented by an <type>XValidator</type>. + represented by an XValidator. */ interface XValidityConstraintListener : com::sun::star::lang::XEventListener { - /** called when the validity constraint represented by an <type>XValidator</type>, + /** called when the validity constraint represented by an XValidator, at which the listener is registered, changed. @param Source diff --git a/offapi/com/sun/star/frame/Components.idl b/offapi/com/sun/star/frame/Components.idl index b30b2a23f734..2a36d01db306 100644 --- a/offapi/com/sun/star/frame/Components.idl +++ b/offapi/com/sun/star/frame/Components.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module frame { <p> One important instance of this service is available from the - <type>Desktop</type> object via the <type>XDesktop</type> interface. + Desktop object via the XDesktop interface. </p> @see com::sun::star::lang::XComponent diff --git a/offapi/com/sun/star/frame/ContentHandler.idl b/offapi/com/sun/star/frame/ContentHandler.idl index 1df594e8eca6..027e1047ad93 100644 --- a/offapi/com/sun/star/frame/ContentHandler.idl +++ b/offapi/com/sun/star/frame/ContentHandler.idl @@ -41,7 +41,7 @@ published service ContentHandler /** provides handling of dispatches with defined result state <p> - Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + Base interface of XNotifyingDispatch is XDispatch and can be called for requests if result isn't necessary for dispatch operation. </p> diff --git a/offapi/com/sun/star/frame/Controller.idl b/offapi/com/sun/star/frame/Controller.idl index f0ac072c9b86..06f05d646c35 100644 --- a/offapi/com/sun/star/frame/Controller.idl +++ b/offapi/com/sun/star/frame/Controller.idl @@ -35,9 +35,9 @@ can offer <p> - Such components can be loaded into a <type>Frame</type> inside a <type>Desktop</type> + Such components can be loaded into a Frame inside a Desktop environment. A controller is a richer component then a pure window, but full featured - components need a <type>XModel</type> interface too. + components need a XModel interface too. <br> (see service <type scope="com::sun::star::document">OfficeDocument</type> for further information) <p> @@ -46,7 +46,7 @@ */ published service Controller { - /** with this interface, components viewed in a <type>Frame</type> can serve + /** with this interface, components viewed in a Frame can serve events (by supplying dispatches) */ interface XController; @@ -54,7 +54,7 @@ published service Controller /** for certain functions which are useful at the UI <p> - Mostly used by the <type>Frame</type> service, which contains this + Mostly used by the Frame service, which contains this controller object. There will be an interception mechanism for dispatches available too. </p> @@ -68,7 +68,7 @@ published service Controller change context menus or prevent them from being executed <p> - Don't mix it with <type>XDispatchProviderInterception</type> which + Don't mix it with XDispatchProviderInterception which intercept calls of <member>XDispatch::dispatch()</member>. </p> */ diff --git a/offapi/com/sun/star/frame/DesktopTask.idl b/offapi/com/sun/star/frame/DesktopTask.idl index 3b8134133567..693d7694a99f 100644 --- a/offapi/com/sun/star/frame/DesktopTask.idl +++ b/offapi/com/sun/star/frame/DesktopTask.idl @@ -30,25 +30,25 @@ module com { module sun { module star { module frame { -/** use the <type>Frame</type> service instead of this +/** use the Frame service instead of this @deprecated */ published service DesktopTask { - /** use <type>Frame</type> service */ + /** use Frame service */ interface com::sun::star::frame::XDesktopTask; - /** use the same interface at the <type>Frame</type> service */ + /** use the same interface at the Frame service */ interface com::sun::star::frame::XFrame; - /** use the same interface at the <type>Frame</type> service */ + /** use the same interface at the Frame service */ interface com::sun::star::beans::XPropertySet; /** - */ interface com::sun::star::frame::XWindowArranger; - /** use the same interface at the <type>Desktop</type> or - <type>Frame</type> service */ + /** use the same interface at the Desktop or + Frame service */ interface com::sun::star::frame::XFramesSupplier; /** use property <member>Frame::Title</member> instead of that */ diff --git a/offapi/com/sun/star/frame/DispatchProvider.idl b/offapi/com/sun/star/frame/DispatchProvider.idl index 8b4f69bbe8f9..b2c9bbe6fe12 100644 --- a/offapi/com/sun/star/frame/DispatchProvider.idl +++ b/offapi/com/sun/star/frame/DispatchProvider.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module frame { -/** provides <type>XDispatch</type> objects for certain functions which +/** provides XDispatch objects for certain functions which are useful at the UI <p> Such dispatch objects must be queried explicitly and used for queried purposes only. They can handle requests with guaranteed - notifications (<type>XNotifyingDispatch</type>) or with possible - (but not guaranteed) notifications (<type>XDispatch</type>). + notifications (XNotifyingDispatch) or with possible + (but not guaranteed) notifications (XDispatch). </p> @see XNotifyingDispatch @@ -44,7 +44,7 @@ published service DispatchProvider /** provides handling of dispatches with defined result state <p> - Base interface of <type>XNotifyingDispatch</type> is <type>XDispatch</type> + Base interface of XNotifyingDispatch is XDispatch and can be called for requests if result isn't necessary for dispatch operation. </p> @@ -55,8 +55,8 @@ published service DispatchProvider /** provides dispatch interception <p> - It makes it possible to register an <type>XDispatchProvider</type> which - intercepts all requests of <type>XDispatch</type> to this instance. + It makes it possible to register an XDispatchProvider which + intercepts all requests of XDispatch to this instance. </p> */ [optional] interface XDispatchProviderInterception; diff --git a/offapi/com/sun/star/frame/DispatchRecorder.idl b/offapi/com/sun/star/frame/DispatchRecorder.idl index 2038477adb94..8377682d16c1 100644 --- a/offapi/com/sun/star/frame/DispatchRecorder.idl +++ b/offapi/com/sun/star/frame/DispatchRecorder.idl @@ -31,7 +31,7 @@ and generate code which can be executed at later time to run same operations again. Which code will be generated depends from real implementation. So it's possible to generate e.g. Java/Basic or may Perl code. - By using of a <type>DispatchRecorderSupplier</type>, which is available on + By using of a DispatchRecorderSupplier, which is available on a property of a <member>Frame::DispatchRecorderSupplier</member>, it's possible to change such code generation for further requests or disable it in general by setting this property to <NULL/>. </p> diff --git a/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl b/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl index d0c258971516..dd601e9b6ada 100644 --- a/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl +++ b/offapi/com/sun/star/frame/DispatchRecorderSupplier.idl @@ -24,13 +24,13 @@ module com { module sun { module star { module frame { -/** provides a <type>DispatchRecorder</type> +/** provides a DispatchRecorder <p> This supplier regulate macro recording of <member>XDispatch::dispatch()</member> - calls. For that it encapsulates a reference to a <type>DispatchRecorder</type>. + calls. For that it encapsulates a reference to a DispatchRecorder. Such recorder is used internally and can be used externally too. - A supplier will be available on a <type>Frame</type> if recording was enabled, + A supplier will be available on a Frame if recording was enabled, otherwise not. A frame supports a special property for that. This modular concept of recorder, supplier and frame makes it possible to implement local recording on one frame; global recording by using all currently diff --git a/offapi/com/sun/star/frame/DispatchResultEvent.idl b/offapi/com/sun/star/frame/DispatchResultEvent.idl index ef3467fdaab5..7601c8f8e28e 100644 --- a/offapi/com/sun/star/frame/DispatchResultEvent.idl +++ b/offapi/com/sun/star/frame/DispatchResultEvent.idl @@ -30,7 +30,7 @@ <p> The type of the result is dispatch action dependent. The member State - can be set to one of the values defined in <type>DispatchResultState</type>. + can be set to one of the values defined in DispatchResultState. If State is set to <const>DispatchResultState::FAILURE</const>, Result may specify the reason (or is empty). The type is also dispatch action dependent. If State is set to <const>DispatchResultState::DONTKNOW</const>, Result is empty. diff --git a/offapi/com/sun/star/frame/DispatchResultState.idl b/offapi/com/sun/star/frame/DispatchResultState.idl index 4c8e730d5228..8b117621c09e 100644 --- a/offapi/com/sun/star/frame/DispatchResultState.idl +++ b/offapi/com/sun/star/frame/DispatchResultState.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module frame { -/** possible values for <type>DispatchResultEvent</type> +/** possible values for DispatchResultEvent */ published constants DispatchResultState { diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl index b021f9ce3cc6..781847affd7e 100644 --- a/offapi/com/sun/star/frame/FeatureStateEvent.idl +++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module frame { -/** This event is broadcast by a <type>Controller</type> whenever the state of +/** This event is broadcast by a Controller whenever the state of the feature changes @see XController @@ -46,10 +46,10 @@ published struct FeatureStateEvent: com::sun::star::lang::EventObject */ boolean IsEnabled; - /** specifies whether the <type>XDispatch</type> has to be requeried. + /** specifies whether the XDispatch has to be requeried. <p> - Interest code should listen for <type>FrameActionEvent</type> + Interest code should listen for FrameActionEvent too, to update own feature states and dispatch listener on <const>FrameAction::CONTEXT_CHANGED</const>. </p> diff --git a/offapi/com/sun/star/frame/Frame.idl b/offapi/com/sun/star/frame/Frame.idl index a354fed10754..e5b9bce1559d 100644 --- a/offapi/com/sun/star/frame/Frame.idl +++ b/offapi/com/sun/star/frame/Frame.idl @@ -32,7 +32,7 @@ to the outside world. They create a skeleton for the whole office API infrastructure by building frame hierarchies. These hierarchies contains all currently loaded documents and make it possible to walk during these trees. - A special service <type>Desktop</type> can(!) combine different of such trees + A special service Desktop can(!) combine different of such trees to a global one which life time will be controlled by it. </p> diff --git a/offapi/com/sun/star/frame/FrameAction.idl b/offapi/com/sun/star/frame/FrameAction.idl index d2f9631aa044..4f478132c8a0 100644 --- a/offapi/com/sun/star/frame/FrameAction.idl +++ b/offapi/com/sun/star/frame/FrameAction.idl @@ -28,7 +28,7 @@ <p> Interest listener can get information about loaded/reloaded or unloaded - components into a <type>Frame</type>. + components into a Frame. </p> @see XFrame diff --git a/offapi/com/sun/star/frame/FrameControl.idl b/offapi/com/sun/star/frame/FrameControl.idl index 10316295802a..739e66fb7dcd 100644 --- a/offapi/com/sun/star/frame/FrameControl.idl +++ b/offapi/com/sun/star/frame/FrameControl.idl @@ -48,7 +48,7 @@ published service FrameControl /** the frame held by this control <p> - The <type>Frame</type> is created if the control + The Frame is created if the control is shown and the <member>ComponentUrl</member> is set. </p> */ diff --git a/offapi/com/sun/star/frame/FrameLoader.idl b/offapi/com/sun/star/frame/FrameLoader.idl index c0f2023f64c6..45d716d1c8f1 100644 --- a/offapi/com/sun/star/frame/FrameLoader.idl +++ b/offapi/com/sun/star/frame/FrameLoader.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module frame { /** derivations of this abstract service are used to load components - into <type>Frame</type>s of the environment + into Frames of the environment <p> Concrete implementations of this service register, for example, for file name extensions or MIME types to load appropriate - components. The components loaded are at least <type>Controller</type>. - Instead of <type>SynchronousFrameLoader</type> this one use asynchronous + components. The components loaded are at least Controller. + Instead of SynchronousFrameLoader this one use asynchronous processes to load the component. </p> @@ -49,7 +49,7 @@ published service FrameLoader <p> Concrete implementations should use it to get her own configuration data - directly after creation by the <type>FrameLoaderFactory</type>. + directly after creation by the FrameLoaderFactory. Otherwise they must use normal configuration API to do so. </p> */ @@ -59,10 +59,10 @@ published service FrameLoader <p> The internal name is a part of his configuration and will be passed by - the <type>FrameLoaderFactory</type> after creation + the FrameLoaderFactory after creation if optional interface <type scope="com::sun::star::lang">XInitialization</type> is supported. Value of function <member scope="com::sun::star::container">XNamed::getName()</member> - can be used on service <type>FrameLoaderFactory</type> to get further information about this loader. + can be used on service FrameLoaderFactory to get further information about this loader. Setting of this name by calling <member scope="com::sun::star::container">XNamed::setName()</member> must be forwarded to same factory service. He should decide, if it's allowed or not. The reason: prevent code against name ambiguities. diff --git a/offapi/com/sun/star/frame/FramesContainer.idl b/offapi/com/sun/star/frame/FramesContainer.idl index bcb33b2559e1..01265ad8d8d6 100644 --- a/offapi/com/sun/star/frame/FramesContainer.idl +++ b/offapi/com/sun/star/frame/FramesContainer.idl @@ -29,7 +29,7 @@ <p> All elements in this container support the service frame. Implementations of this service are available by interface - <type>XFramesSupplier</type>. + XFramesSupplier. </p> @see XFramesSupplier diff --git a/offapi/com/sun/star/frame/LayoutManager.idl b/offapi/com/sun/star/frame/LayoutManager.idl index c688e69bf358..0b4490cbc1ab 100644 --- a/offapi/com/sun/star/frame/LayoutManager.idl +++ b/offapi/com/sun/star/frame/LayoutManager.idl @@ -29,7 +29,7 @@ <p> Layout management is the process of determining the size and position of - user interface elements. By default, each <type>Frame</type> has a layout + user interface elements. By default, each Frame has a layout manager -- it performs layout management for the user interface elements within the frame. User interface elements can provide size and alignment hints to layout managers, but layout managers have the final decision on diff --git a/offapi/com/sun/star/frame/ProtocolHandler.idl b/offapi/com/sun/star/frame/ProtocolHandler.idl index 7bb52082d496..cc0b547e7da0 100644 --- a/offapi/com/sun/star/frame/ProtocolHandler.idl +++ b/offapi/com/sun/star/frame/ProtocolHandler.idl @@ -28,7 +28,7 @@ /** special dispatch provider registered for URL protocols <p> - The generic dispatch mechanism on a <type>Frame</type> + The generic dispatch mechanism on a Frame search for such registered protocol handler and use it if it agrees with the dispatched URL. </p> diff --git a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl index d6cc210d7627..da93868e9eec 100644 --- a/offapi/com/sun/star/frame/SynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/SynchronousFrameLoader.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module frame { /** derivations of this abstract service are used to load components - into <type>Frame</type>s of the environment + into Frames of the environment <p> Concrete implementations of this service register, for example, for file name extensions or MIME types to load appropriate - components. The components loaded are at least <type>Controller</type>. - Instead of service <type>FrameLoader</type> this one use synchronous + components. The components loaded are at least Controller. + Instead of service FrameLoader this one use synchronous processes to load the component. </p> @@ -49,7 +49,7 @@ published service SynchronousFrameLoader <p> Concrete implementations should use it to get her own configuration data - directly after creation by the <type>FrameLoaderFactory</type>. + directly after creation by the FrameLoaderFactory. Otherwise they must use normal configuration API to do so. </p> */ @@ -59,10 +59,10 @@ published service SynchronousFrameLoader <p> The internal name is a part of his configuration and will be passed by - the <type>FrameLoaderFactory</type> after creation + the FrameLoaderFactory after creation if optional interface <type scope="com::sun::star::lang">XInitialization</type> is supported. Value of function <member scope="com::sun::star::container">XNamed::getName()</member> can be - used on service <type>FrameLoaderFactory</type> to get further information about this loader. + used on service FrameLoaderFactory to get further information about this loader. Setting of this name by calling <member scope="com::sun::star::container">XNamed::setName()</member> must be forwarded to same factory service. He should decide, if it's allowed or not. The reason: prevent code against name ambiguities. diff --git a/offapi/com/sun/star/frame/TerminationVetoException.idl b/offapi/com/sun/star/frame/TerminationVetoException.idl index 70408e43449e..99f58d58acf3 100644 --- a/offapi/com/sun/star/frame/TerminationVetoException.idl +++ b/offapi/com/sun/star/frame/TerminationVetoException.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module frame { -/** can be thrown by a <type>XTerminateListener</type> to prevent the environment +/** can be thrown by a XTerminateListener to prevent the environment (e.g., desktop) from terminating <p> - If a <type>XTerminateListener</type> use this exception for a veto against + If a XTerminateListener use this exception for a veto against the termination of the office, he will be the new "owner" of it. After his own operation will be finished, he MUST try to terminate the office again. Any other veto listener can intercept that again or office diff --git a/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl b/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl index 69917c3807a8..a622ea0066b0 100644 --- a/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl +++ b/offapi/com/sun/star/frame/TransientDocumentsDocumentContentFactory.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module frame { */ service TransientDocumentsDocumentContentFactory { - /** a factory for <type>TransientDocumentsDocumentContent</type>s. + /** a factory for TransientDocumentsDocumentContents. */ interface com::sun::star::frame::XTransientDocumentsDocumentContentFactory; }; diff --git a/offapi/com/sun/star/frame/XComponentLoader.idl b/offapi/com/sun/star/frame/XComponentLoader.idl index 2f4213f565f9..bf7ff5ff67e1 100644 --- a/offapi/com/sun/star/frame/XComponentLoader.idl +++ b/offapi/com/sun/star/frame/XComponentLoader.idl @@ -85,7 +85,7 @@ published interface XComponentLoader: com::sun::star::uno::XInterface </table> @param SearchFlags - use the values of <type>FrameSearchFlag</type> to specify + use the values of FrameSearchFlag to specify how to find the specified <var>TargetFrameName</var> <p> @@ -123,7 +123,7 @@ published interface XComponentLoader: com::sun::star::uno::XInterface only an interacting user can do this by closing the frame's window. </li> <li> - <type>XController</type> for richer components<br/> + XController for richer components<br/> Should be used for real editable components which doesn't need a model. It is not allowed to dispose it after use directly, because the frame containing the component is its owner. Here the object can be disposed @@ -132,7 +132,7 @@ published interface XComponentLoader: com::sun::star::uno::XInterface should be asked for permission by calling <member>XController::suspend()</member> before. </li> <li> - <type>XModel</type> for full featured components<br/> + XModel for full featured components<br/> A model that in general can be shared between several view/controller pairs, does not have an explicit owner. Every view and also the component that loaded the document may consider itself as an owner. diff --git a/offapi/com/sun/star/frame/XController.idl b/offapi/com/sun/star/frame/XController.idl index 7b601074d7d1..591201587355 100644 --- a/offapi/com/sun/star/frame/XController.idl +++ b/offapi/com/sun/star/frame/XController.idl @@ -27,7 +27,7 @@ published interface XFrame; published interface XModel; -/** With this interface, components viewed in a <type>Frame</type> can serve +/** With this interface, components viewed in a Frame can serve events (by supplying dispatches). @see XFrame diff --git a/offapi/com/sun/star/frame/XController2.idl b/offapi/com/sun/star/frame/XController2.idl index eb9f3a171f63..1bf0481ccbac 100644 --- a/offapi/com/sun/star/frame/XController2.idl +++ b/offapi/com/sun/star/frame/XController2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module frame { -/** extends the <type>XController</type> interface +/** extends the XController interface @since OOo 3.0 */ diff --git a/offapi/com/sun/star/frame/XControllerBorder.idl b/offapi/com/sun/star/frame/XControllerBorder.idl index 00c7a46a7cf3..1254d54a3115 100644 --- a/offapi/com/sun/star/frame/XControllerBorder.idl +++ b/offapi/com/sun/star/frame/XControllerBorder.idl @@ -34,7 +34,7 @@ interface XControllerBorder: com::sun::star::uno::XInterface /** allows to get current border sizes of the document. @return - <type>BorderWidths</type> representing the sizes of border + BorderWidths representing the sizes of border */ BorderWidths getBorder(); diff --git a/offapi/com/sun/star/frame/XDesktop.idl b/offapi/com/sun/star/frame/XDesktop.idl index 07a2030266ba..127747a3f5ee 100644 --- a/offapi/com/sun/star/frame/XDesktop.idl +++ b/offapi/com/sun/star/frame/XDesktop.idl @@ -46,7 +46,7 @@ published interface XDesktop: com::sun::star::uno::XInterface <p> First, every terminate listener is called by his <member>XTerminateListener::queryTermination()</member> method. - Throwing of a <type>TerminationVetoException</type> can break the termination process and the listener how has + Throwing of a TerminationVetoException can break the termination process and the listener how has done that will be the new "controller" of the desktop lifetime. He should try to terminate it by himself after his own processes will be finished. If nobody disagree with the termination request, every listener will be called by his @@ -90,7 +90,7 @@ published interface XDesktop: com::sun::star::uno::XInterface The component is, by definition, the model of the control which is loaded into a frame, or if no model exists, into the control itself. - The service <type>Components</type> which is available from this + The service Components which is available from this method is a collection of all components of the desktop which are open within a frame of the desktop. </p> diff --git a/offapi/com/sun/star/frame/XDesktop2.idl b/offapi/com/sun/star/frame/XDesktop2.idl index 4d81cc774185..3b80f042a1b2 100644 --- a/offapi/com/sun/star/frame/XDesktop2.idl +++ b/offapi/com/sun/star/frame/XDesktop2.idl @@ -40,11 +40,11 @@ published interface XDesktop2 <p> What kind of URLs a frame accepts in the calls to <member>XDispatchProvider::queryDispatch()</member>, and how the returned dispatcher handles dispatches is completely implementation dependent - (though of course the restrictions of <type>XDispatchProvider</type> must be met). + (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to <member>XDispatchProvider::queryDispatch()</member>. Such special targets are passed as target frame name. They may, in addition, - require special frame search flags (see <type>FrameSearchFlag</type>), or, + require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags.<br> Common special targets include: <ul> @@ -65,7 +65,7 @@ published interface XDesktop2 <p> Registered objects can intercept, suppress or reroute dispatched URLs. - If they support another interface too (<type>XInterceptorInfo</type>) + If they support another interface too (XInterceptorInfo) it's possible to perform it by directly calling of right interceptor without using list of all registered ones. </p> diff --git a/offapi/com/sun/star/frame/XDesktopTask.idl b/offapi/com/sun/star/frame/XDesktopTask.idl index 95cece6ad91c..fbe5305f69a9 100644 --- a/offapi/com/sun/star/frame/XDesktopTask.idl +++ b/offapi/com/sun/star/frame/XDesktopTask.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module frame { -/** use <type>XFrame</type> instead of this +/** use XFrame instead of this @deprecated */ published interface XDesktopTask: com::sun::star::lang::XComponent diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl index 9c9e96d53975..e7113086b81a 100644 --- a/offapi/com/sun/star/frame/XDispatch.idl +++ b/offapi/com/sun/star/frame/XDispatch.idl @@ -45,7 +45,7 @@ module com { module sun { module star { module frame { whenever this state changes or the control should re-get the value for the URL it is connected to. Additionally, a context-switch-event is to be broadcasted whenever the object may be out of scope, - to force the state listener to requery the <type>XDispatch</type>. + to force the state listener to requery the XDispatch. </p> @see Frame @@ -56,7 +56,7 @@ published interface XDispatch: com::sun::star::uno::XInterface /** dispatches (executes) an URL asynchronously. <p> - It is only allowed to dispatch URLs for which this <type>XDispatch</type> + It is only allowed to dispatch URLs for which this XDispatch was explicitly queried. Additional arguments ("'#..." or "?...") are allowed. </p> @@ -97,10 +97,10 @@ published interface XDispatch: com::sun::star::uno::XInterface at this object to receive status events. <p> - It is only allowed to register URLs for which this <type>XDispatch</type> + It is only allowed to register URLs for which this XDispatch was explicitly queried. Additional arguments ("#..." or "?...") will be ignored. </p> - Note: Notifications can't be guaranteed! This will be a part of interface <type>XNotifyingDispatch</type>. + Note: Notifications can't be guaranteed! This will be a part of interface XNotifyingDispatch. @param Control listener that wishes to be informed diff --git a/offapi/com/sun/star/frame/XDispatchInformationProvider.idl b/offapi/com/sun/star/frame/XDispatchInformationProvider.idl index 2cd64ab62903..aaa94be3b823 100644 --- a/offapi/com/sun/star/frame/XDispatchInformationProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchInformationProvider.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module frame { supported commands. This interface is normally used by configuration implementations to retrieve all supported commands. A dispatch information provider is normally supported by a - <type>Frame</type> service. + Frame service. </p> @see Frame diff --git a/offapi/com/sun/star/frame/XDispatchProvider.idl b/offapi/com/sun/star/frame/XDispatchProvider.idl index 31497067a3f8..502549e7d429 100644 --- a/offapi/com/sun/star/frame/XDispatchProvider.idl +++ b/offapi/com/sun/star/frame/XDispatchProvider.idl @@ -28,14 +28,14 @@ module com { module sun { module star { module frame { -/** provides <type>XDispatch</type> interfaces for certain functions which +/** provides XDispatch interfaces for certain functions which are useful at the UI. @see XDispatch */ published interface XDispatchProvider: com::sun::star::uno::XInterface { - /** searches for an <type>XDispatch</type> for the specified URL within + /** searches for an XDispatch for the specified URL within the specified target frame. @param URL diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl index 6ce0b76da888..f900cb6f5f1d 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterception.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterception.idl @@ -26,13 +26,13 @@ module com { module sun { module star { module frame { -/** makes it possible to register an <type>XDispatchProvider</type> which - intercepts all requests of <type>XDispatch</type> to this instance. +/** makes it possible to register an XDispatchProvider which + intercepts all requests of XDispatch to this instance. <p> Note: Nobody can guarantee order of used interceptor objects if more then ones exist. Later registered ones will be used at first. But it's possible to increase the chance - for that by providing the optional interface <type>XInterceptorInfo</type>. + for that by providing the optional interface XInterceptorInfo. </p> @see XDispatchProvider @@ -41,7 +41,7 @@ */ published interface XDispatchProviderInterception: com::sun::star::uno::XInterface { - /** registers an <type>XDispatchProviderInterceptor</type>, which will become + /** registers an XDispatchProviderInterceptor, which will become the first interceptor in the chain of registered interceptors. @param Interceptor @@ -51,7 +51,7 @@ published interface XDispatchProviderInterception: com::sun::star::uno::XInterfa */ void registerDispatchProviderInterceptor( [in] XDispatchProviderInterceptor Interceptor ); - /** removes an <type>XDispatchProviderInterceptor</type> which was previously registered + /** removes an XDispatchProviderInterceptor which was previously registered <p> The order of removals is arbitrary. It is not necessary to remove the last diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl index 8f36052369b6..33b58e7390b5 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -25,17 +25,17 @@ module com { module sun { module star { module frame { -/** makes it possible to intercept request of <type>XDispatch</type>. +/** makes it possible to intercept request of XDispatch. <p> - Can be registered as an interceptor by using interface <type>XDispatchProviderInterception</type>. + Can be registered as an interceptor by using interface XDispatchProviderInterception. </p> @see XDispatchProviderInterception */ published interface XDispatchProviderInterceptor: XDispatchProvider { - /** access to the slave <type>XDispatchProvider</type> of this interceptor + /** access to the slave XDispatchProvider of this interceptor @returns the slave of this interceptor @@ -44,7 +44,7 @@ published interface XDispatchProviderInterceptor: XDispatchProvider */ XDispatchProvider getSlaveDispatchProvider(); - /** sets the slave <type>XDispatchProvider</type> to which calls to + /** sets the slave XDispatchProvider to which calls to <member>XDispatchProvider::queryDispatch()</member> can be forwarded under control of this dispatch provider. @@ -55,7 +55,7 @@ published interface XDispatchProviderInterceptor: XDispatchProvider */ void setSlaveDispatchProvider( [in] XDispatchProvider NewDispatchProvider ); - /** access to the master <type>XDispatchProvider</type> of this interceptor + /** access to the master XDispatchProvider of this interceptor @returns the master of this interceptor @@ -64,7 +64,7 @@ published interface XDispatchProviderInterceptor: XDispatchProvider */ XDispatchProvider getMasterDispatchProvider(); - /** sets the master <type>XDispatchProvider</type>, which may forward + /** sets the master XDispatchProvider, which may forward calls to its <member>XDispatchProvider::queryDispatch()</member> to this dispatch provider. diff --git a/offapi/com/sun/star/frame/XDispatchRecorder.idl b/offapi/com/sun/star/frame/XDispatchRecorder.idl index d287512b754a..6b007f512fc2 100644 --- a/offapi/com/sun/star/frame/XDispatchRecorder.idl +++ b/offapi/com/sun/star/frame/XDispatchRecorder.idl @@ -32,11 +32,11 @@ module com { module sun { module star { module frame { <p> With such recorder it will be possible to record requests of type - <type>XDispatch</type> by using additional interface - <type>XRecordableDispatch</type>. The result of that will be a + XDispatch by using additional interface + XRecordableDispatch. The result of that will be a a script which can be used to start the dispatch at later time again. - Such recorder objects are available on a <type>XDispatchRecorderSupplier</type> - which is provided by the <type>Frame</type> service. + Such recorder objects are available on a XDispatchRecorderSupplier + which is provided by the Frame service. </p> @see Frame diff --git a/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl b/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl index 3890212579eb..5fc10ab3b5cd 100644 --- a/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl +++ b/offapi/com/sun/star/frame/XDispatchRecorderSupplier.idl @@ -29,7 +29,7 @@ /** provides access to the record mechanism of dispatches <p> - With a <type>XDispatchRecorder</type> it's possible to record calls + With a XDispatchRecorder it's possible to record calls of <member>XDispatch::dispatch()</member>. The recorded data (may a script) can be used to automate recorded dispatch and start it at later time again. This supplier provides access to the recorder and supports some functionality @@ -47,7 +47,7 @@ published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface Setting of a new recorder make it possible to change recording mode. May there can exist different implementations of a recorder (e.g. to generate Java, Basic or other formats). Changing between local recording - inside one <type>Frame</type> or global one by using more then ones can be + inside one Frame or global one by using more then ones can be forced too. </p> @@ -79,7 +79,7 @@ published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface call. Otherwise follow algorithm is used: <ul> <li>If <var>Dispatcher</var> doesn't support the interface - <type>XRecordableDispatch</type> a normal dispatch() call + XRecordableDispatch a normal dispatch() call will be made and depend from the result state of that the request will be recorded. In this case it's possible to record the incoming parameter (<var>URL</var> and @@ -87,7 +87,7 @@ published interface XDispatchRecorderSupplier: com::sun::star::uno::XInterface can't be recorded then and will be lost. </li> <li>If <var>Dispatcher</var> support the interface - <type>XRecordableDispatch</type> it will be used + XRecordableDispatch it will be used to dispatch and record all necessary parameters of the whole process. </li> diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index 6fb9345ea961..68228b5f9a3f 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -35,7 +35,7 @@ <p> A frame can be (it's not a must!) a part of a frame tree. If not this frame won't be accessible by using the API. This mode make sense for previews. - The root node of the tree can be a <type>Desktop</type> implementation. + The root node of the tree can be a Desktop implementation. </p> @see Desktop @@ -203,10 +203,10 @@ published interface XFrame: com::sun::star::lang::XComponent <p> At first the frame sets itself as the active frame of its creator by calling <member>XFramesSupplier::setActiveFrame()</member>, - then it broadcasts an <type>FrameActionEvent</type> with + then it broadcasts an FrameActionEvent with <const>FrameAction::FRAME_ACTIVATED</const>. The component within this frame may listen to this event to grab the focus on activation; - for simple components this can be done by the <type>FrameLoader</type>. + for simple components this can be done by the FrameLoader. </p> <p> @@ -223,7 +223,7 @@ published interface XFrame: com::sun::star::lang::XComponent <p> At first the frame deactivates its active sub-frame, if any. - Then broadcasts a <type>FrameActionEvent</type> with + Then broadcasts a FrameActionEvent with <const>FrameAction::FRAME_DEACTIVATING</const>. </p> diff --git a/offapi/com/sun/star/frame/XFrame2.idl b/offapi/com/sun/star/frame/XFrame2.idl index d90d00b1e9b4..2d53e9302935 100644 --- a/offapi/com/sun/star/frame/XFrame2.idl +++ b/offapi/com/sun/star/frame/XFrame2.idl @@ -44,11 +44,11 @@ published interface XFrame2 <p> What kind of URLs a frame accepts in the calls to <member>XDispatchProvider::queryDispatch()</member>, and how the returned dispatcher handles dispatches is completely implementation dependent - (though of course the restrictions of <type>XDispatchProvider</type> must be met). + (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to <member>XDispatchProvider::queryDispatch()</member>. Such special targets are passed as target frame name. They may, in addition, - require special frame search flags (see <type>FrameSearchFlag</type>), or, + require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags.<br> Common special targets include: <ul> @@ -75,7 +75,7 @@ published interface XFrame2 <p> Registered objects can intercept, suppress or reroute dispatched URLs. - If they support another interface too (<type>XInterceptorInfo</type>) + If they support another interface too (XInterceptorInfo) it's possible to perform it by directly calling of right interceptor without using list of all registered ones. </p> @@ -111,7 +111,7 @@ published interface XFrame2 Such recorder can be used to record dispatch requests. The supplier contains a dispatch recorder and provide the functionality to use it for any dispatch object from outside which supports the interface - <type>XDispatch</type>. A supplier is available only, if recording was enabled. + XDispatch. A supplier is available only, if recording was enabled. That means: if someone wishes to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. @@ -131,7 +131,7 @@ published interface XFrame2 */ [attribute] XDispatchRecorderSupplier DispatchRecorderSupplier; - /** Provides access to the <type>LayoutManager</type> of the frame. + /** Provides access to the LayoutManager of the frame. This is actually of type XLayoutManager, but this API is still experimental (unpublished). */ [attribute] com::sun::star::uno::XInterface LayoutManager; diff --git a/offapi/com/sun/star/frame/XFrameLoader.idl b/offapi/com/sun/star/frame/XFrameLoader.idl index 92c933640f50..e3cd181151ae 100644 --- a/offapi/com/sun/star/frame/XFrameLoader.idl +++ b/offapi/com/sun/star/frame/XFrameLoader.idl @@ -31,7 +31,7 @@ /** load components into a frame <p> - It's an asynchronous loading. For synchronous processes use <type>XSynchronousFrameLoader</type> + It's an asynchronous loading. For synchronous processes use XSynchronousFrameLoader instead of this one. The generic load algorithm of the office supports both ones - but preferred the synchronous interface. </p> @@ -40,7 +40,7 @@ */ published interface XFrameLoader: com::sun::star::uno::XInterface { - /** starts the loading of the specified resource into the specified <type>Frame</type>. + /** starts the loading of the specified resource into the specified Frame. @param Frame specifies the loading target @@ -73,7 +73,7 @@ published interface XFrameLoader: com::sun::star::uno::XInterface Because only the owner of this process who called load method before can cancel this process. And he doesn't need any notification about that. On the other hand - nobody then this owner himself can be registered as an - <type>XLoadEventListener</type> here. + XLoadEventListener here. </p> */ void cancel(); diff --git a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl index f7fb57d68004..6f34c11be9bf 100644 --- a/offapi/com/sun/star/frame/XFrameLoaderQuery.idl +++ b/offapi/com/sun/star/frame/XFrameLoaderQuery.idl @@ -29,25 +29,25 @@ module star { module frame { -/** use service <type>FrameLoaderFactory</type> instead of this +/** use service FrameLoaderFactory instead of this @deprecated */ published interface XFrameLoaderQuery: com::sun::star::uno::XInterface { /** use member <member scope="com::sun::star::container">XNameAccess::getElementNames()</member> - provided by service <type>FrameLoaderFactory</type> instead of this + provided by service FrameLoaderFactory instead of this @deprecated */ sequence< string > getAvailableFilterNames(); /** use member <member scope="com::sun::star::container">XNameAccess::getByName()</member> - provided by service <type>FrameLoaderFactory</type> instead of this + provided by service FrameLoaderFactory instead of this @deprecated */ sequence< ::com::sun::star::beans::PropertyValue > getLoaderProperties( [in] string sFilterName ); /** use member <type scope="com::sun::star::container">XContainerQuery</type> - provided by service <type>FrameLoaderFactory</type> instead of this + provided by service FrameLoaderFactory instead of this @deprecated */ string searchFilter( [in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > seqArguments ); diff --git a/offapi/com/sun/star/frame/XFrameSetModel.idl b/offapi/com/sun/star/frame/XFrameSetModel.idl index bc17d3fdac8e..132b5ce96d33 100644 --- a/offapi/com/sun/star/frame/XFrameSetModel.idl +++ b/offapi/com/sun/star/frame/XFrameSetModel.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module frame { -/** use <type>XModel</type> instead of this +/** use XModel instead of this @deprecated */ published interface XFrameSetModel: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/frame/XFrames.idl b/offapi/com/sun/star/frame/XFrames.idl index d0e71dfaf19c..394cc07b2f4c 100644 --- a/offapi/com/sun/star/frame/XFrames.idl +++ b/offapi/com/sun/star/frame/XFrames.idl @@ -29,7 +29,7 @@ /** manages and creates frames. <p> - Frames may contain other frames (by implementing an <type>XFrames</type> + Frames may contain other frames (by implementing an XFrames interface) and may be contained in other frames. </p> @@ -38,7 +38,7 @@ */ published interface XFrames: com::sun::star::container::XIndexAccess { - /** appends the specified <type>Frame</type> to the list of sub-frames. + /** appends the specified Frame to the list of sub-frames. @param xFrame new frame for inserting into this container @@ -49,7 +49,7 @@ published interface XFrames: com::sun::star::container::XIndexAccess frames inside this container and her sub frames @param nSearchFlags - use combinations of <type>FrameSearchFlag</type> to specify which + use combinations of FrameSearchFlag to specify which frames should be found @return diff --git a/offapi/com/sun/star/frame/XFramesSupplier.idl b/offapi/com/sun/star/frame/XFramesSupplier.idl index 5e4daf24f01a..1a7e8650e2e2 100644 --- a/offapi/com/sun/star/frame/XFramesSupplier.idl +++ b/offapi/com/sun/star/frame/XFramesSupplier.idl @@ -32,12 +32,12 @@ */ published interface XFramesSupplier: XFrame { - /** provides access to this container and to all other <type>XFramesSupplier</type> + /** provides access to this container and to all other XFramesSupplier which are available from this node of frame tree @returns the collection of frames which is represented by - a <type>FramesContainer</type>. + a FramesContainer. */ XFrames getFrames(); @@ -54,7 +54,7 @@ published interface XFramesSupplier: XFrame </p> @returns - the <type>Frame</type> which is active within this frame. + the Frame which is active within this frame. */ XFrame getActiveFrame(); @@ -70,7 +70,7 @@ published interface XFramesSupplier: XFrame <p> In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member> at the creator frame with <var>this</var> as the current argument. Then it broadcasts - the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>. + the FrameActionEvent <const>FrameAction::FRAME_ACTIVATED</const>. </p> <p> diff --git a/offapi/com/sun/star/frame/XInterceptorInfo.idl b/offapi/com/sun/star/frame/XInterceptorInfo.idl index ee0f4ab07ec5..318a1eb9782d 100644 --- a/offapi/com/sun/star/frame/XInterceptorInfo.idl +++ b/offapi/com/sun/star/frame/XInterceptorInfo.idl @@ -30,7 +30,7 @@ <p> Frame can call right interceptor directly without calling all of registered ones. - Use it as an additional interface to <type>XDispatchProviderInterceptor</type>. + Use it as an additional interface to XDispatchProviderInterceptor. If any interceptor in list doesn't support this interface - these mechanism will be broken and normal list of master-slave interceptor objects will be used from top to the bottom. </p> diff --git a/offapi/com/sun/star/frame/XModel.idl b/offapi/com/sun/star/frame/XModel.idl index 87d23123bc26..f4c0d39e48cf 100644 --- a/offapi/com/sun/star/frame/XModel.idl +++ b/offapi/com/sun/star/frame/XModel.idl @@ -42,7 +42,7 @@ <p> Models can be controlled by controller components, which are usually views of the model. - (see <type>Controller</type> for further details) + (see Controller for further details) </p> <p> diff --git a/offapi/com/sun/star/frame/XModuleManager.idl b/offapi/com/sun/star/frame/XModuleManager.idl index c54b34de2852..3474698e9e15 100644 --- a/offapi/com/sun/star/frame/XModuleManager.idl +++ b/offapi/com/sun/star/frame/XModuleManager.idl @@ -36,14 +36,14 @@ interface XModuleManager : com::sun::star::uno::XInterface /** @short identifies the given module. - @descr This identifier can then be used at the service <type>ModuleManager</type> + @descr This identifier can then be used at the service ModuleManager to get more information about this module. For identification the interface <type scope="com::sun::star::lang">XServiceInfo</type> is requested on the given module. Because all module service registrations must be unique this value can be queried and checked against the configuration. - Since OOo 2.3.0 also the optional interface <type>XModule</type> will be used. + Since OOo 2.3.0 also the optional interface XModule will be used. If its exists it will be preferred. @param Module @@ -75,7 +75,7 @@ interface XModuleManager : com::sun::star::uno::XInterface <li>or does not provide the needed interface XServiceInfo.</li> </ul> - @throws <type>UnknownModuleException</type> + @throws UnknownModuleException if the given module could not be identified. Note: If the module represent a XFrame instance with does not contain a document, this exception is thrown too! diff --git a/offapi/com/sun/star/frame/XNotifyingDispatch.idl b/offapi/com/sun/star/frame/XNotifyingDispatch.idl index 2c41413732d5..f80815ed3a6f 100644 --- a/offapi/com/sun/star/frame/XNotifyingDispatch.idl +++ b/offapi/com/sun/star/frame/XNotifyingDispatch.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module frame { -/** dispatch with guaranteed notify (instead of <type>XDispatch</type>) +/** dispatch with guaranteed notify (instead of XDispatch) @see XDispatch @see XStatusListener diff --git a/offapi/com/sun/star/frame/XRecordableDispatch.idl b/offapi/com/sun/star/frame/XRecordableDispatch.idl index 04b90284fc49..24ddc6fc90ca 100644 --- a/offapi/com/sun/star/frame/XRecordableDispatch.idl +++ b/offapi/com/sun/star/frame/XRecordableDispatch.idl @@ -26,12 +26,12 @@ module com { module sun { module star { module frame { -/** extends an existing <type>XDispatch</type> implementation with functionality +/** extends an existing XDispatch implementation with functionality for dispatch recording <p> This interface can be implemented as an additional one beside an existing - <type>XDispatch</type> one to provide record functionality of dispatches. + XDispatch one to provide record functionality of dispatches. Because it's an additional interface the status events are available there and not at this interface. </p> @@ -39,7 +39,7 @@ <p> But normally this interface mustn't be used directly. If a dispatch object is well known and recording was enabled - on a <type>XDispatchRecorderSupplier</type> it's possible to use method + on a XDispatchRecorderSupplier it's possible to use method <member>XDispatchRecorderSupplier::dispatchAndRecord()</member> of it to make dispatch and recording automatically. The interface XRecordableDispatch is used transparently there. diff --git a/offapi/com/sun/star/frame/XStatusListener.idl b/offapi/com/sun/star/frame/XStatusListener.idl index c80589ff1afb..ee53f9d78744 100644 --- a/offapi/com/sun/star/frame/XStatusListener.idl +++ b/offapi/com/sun/star/frame/XStatusListener.idl @@ -29,8 +29,8 @@ /** makes it possible to receive events when the state of a feature changes. <p> - Nobody guarantee any notification. Use combination of <type>XNotifyingDispatch</type> - and <type>XDispatchResultListener</type> for that. + Nobody guarantee any notification. Use combination of XNotifyingDispatch + and XDispatchResultListener for that. </p> @see XDispatch diff --git a/offapi/com/sun/star/frame/XStorable2.idl b/offapi/com/sun/star/frame/XStorable2.idl index 7915c2fa04a1..7d8d70e25746 100644 --- a/offapi/com/sun/star/frame/XStorable2.idl +++ b/offapi/com/sun/star/frame/XStorable2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module frame { -/** extends <type>XStorable</type>. +/** extends XStorable. */ published interface XStorable2: XStorable { diff --git a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl index 16fdbaa8056f..991e7669cc1e 100644 --- a/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl +++ b/offapi/com/sun/star/frame/XSynchronousFrameLoader.idl @@ -26,17 +26,17 @@ module com { module sun { module star { module frame { -/** loads a resource into a <type>Frame</type>. +/** loads a resource into a Frame. <p> - Unlike the <type>XFrameLoader</type> interface, this loading will be synchronous. + Unlike the XFrameLoader interface, this loading will be synchronous. </p> @see XFrameLoader */ published interface XSynchronousFrameLoader: com::sun::star::uno::XInterface { - /** starts the loading of the specified resource into the specified <type>Frame</type>. + /** starts the loading of the specified resource into the specified Frame. @param Descriptor describes the resource which should be loaded diff --git a/offapi/com/sun/star/frame/XTask.idl b/offapi/com/sun/star/frame/XTask.idl index 4ddf53d02a60..8fbbb54d4cb7 100644 --- a/offapi/com/sun/star/frame/XTask.idl +++ b/offapi/com/sun/star/frame/XTask.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module frame { -/** use <type>XFrame</type> instead of this one +/** use XFrame instead of this one @deprecated */ published interface XTask: XFrame { /** use <type scope="com::sun::star::util">XCloseable</type> or <member scope="com::sun::star::lang">XComponent::dispose()</member> - at a <type>Frame</type> instead of this one + at a Frame instead of this one @deprecated */ boolean close(); diff --git a/offapi/com/sun/star/frame/XTasksSupplier.idl b/offapi/com/sun/star/frame/XTasksSupplier.idl index 88852b5deb9b..d47acf2537e0 100644 --- a/offapi/com/sun/star/frame/XTasksSupplier.idl +++ b/offapi/com/sun/star/frame/XTasksSupplier.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module frame { -/** use <type>XFramesSupplier</type> instead of that +/** use XFramesSupplier instead of that @deprecated */ published interface XTasksSupplier: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/frame/XTerminateListener.idl b/offapi/com/sun/star/frame/XTerminateListener.idl index f225486e1f78..cf07630bb481 100644 --- a/offapi/com/sun/star/frame/XTerminateListener.idl +++ b/offapi/com/sun/star/frame/XTerminateListener.idl @@ -39,7 +39,7 @@ published interface XTerminateListener: com::sun::star::lang::XEventListener /** is called when the master environment (e.g., desktop) is about to terminate. <p> - Termination can be intercepted by throwing <type>TerminationVetoException</type>. + Termination can be intercepted by throwing TerminationVetoException. Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member> after finishing his own operations. </p> diff --git a/offapi/com/sun/star/frame/XTerminateListener2.idl b/offapi/com/sun/star/frame/XTerminateListener2.idl index 1f74ae903825..6c61fdcea227 100644 --- a/offapi/com/sun/star/frame/XTerminateListener2.idl +++ b/offapi/com/sun/star/frame/XTerminateListener2.idl @@ -33,7 +33,7 @@ interface XTerminateListener2 : ::com::sun::star::frame::XTerminateListener it's terminate request. <p> - Termination can be intercepted by throwing <type>TerminationVetoException</type>. + Termination can be intercepted by throwing TerminationVetoException. But if a listener was queried for termination .. doesn't throw a veto exception ... it doesn't know if termination will be real next time. Because any other listener can throw those exception too ... and so it can happen diff --git a/offapi/com/sun/star/frame/status/ItemState.idl b/offapi/com/sun/star/frame/status/ItemState.idl index b090e3742d9e..16a2046950e0 100644 --- a/offapi/com/sun/star/frame/status/ItemState.idl +++ b/offapi/com/sun/star/frame/status/ItemState.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module frame { module status { -/** these constants describe a state of a <type>ItemStatus</type>. +/** these constants describe a state of a ItemStatus. @see ItemStatus diff --git a/offapi/com/sun/star/frame/status/ItemStatus.idl b/offapi/com/sun/star/frame/status/ItemStatus.idl index 76704f374b39..11772833d25f 100644 --- a/offapi/com/sun/star/frame/status/ItemStatus.idl +++ b/offapi/com/sun/star/frame/status/ItemStatus.idl @@ -32,7 +32,7 @@ struct ItemStatus /** numerical value which describes the current state of an item. - @see <type>ItemState</type> + @see ItemState */ short State; diff --git a/offapi/com/sun/star/gallery/GalleryThemeProvider.idl b/offapi/com/sun/star/gallery/GalleryThemeProvider.idl index fdd883d97419..dbb2156f56ee 100644 --- a/offapi/com/sun/star/gallery/GalleryThemeProvider.idl +++ b/offapi/com/sun/star/gallery/GalleryThemeProvider.idl @@ -27,14 +27,14 @@ module com { module sun { module star { module gallery { -/** provides access to a container of <type>GalleryTheme</type>s +/** provides access to a container of GalleryThemes and makes it possible for you to manipulate them. @see XGalleryThemeProvider */ service GalleryThemeProvider { - /** lets you access and create <type>GalleryTheme</type>s + /** lets you access and create GalleryThemes */ interface com::sun::star::gallery::XGalleryThemeProvider; diff --git a/offapi/com/sun/star/geometry/AffineMatrix2D.idl b/offapi/com/sun/star/geometry/AffineMatrix2D.idl index 4c2bd43f4456..1d7df6fc031d 100644 --- a/offapi/com/sun/star/geometry/AffineMatrix2D.idl +++ b/offapi/com/sun/star/geometry/AffineMatrix2D.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module geometry { </code><p> Thus, in common matrix language, with M being the - <type>AffineMatrix2D</type> and vs=[xs,ys]^T, vd=[xd,yd]^T two 2D + AffineMatrix2D and vs=[xs,ys]^T, vd=[xd,yd]^T two 2D vectors, the affine transformation is written as vd=M*vs. Concatenation of transformations amounts to multiplication of matrices, i.e. a translation, given by T, diff --git a/offapi/com/sun/star/geometry/AffineMatrix3D.idl b/offapi/com/sun/star/geometry/AffineMatrix3D.idl index 4efa52b10484..4602907c3452 100644 --- a/offapi/com/sun/star/geometry/AffineMatrix3D.idl +++ b/offapi/com/sun/star/geometry/AffineMatrix3D.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module geometry { </code><p> Thus, in common matrix language, with M being the - <type>AffineMatrix3D</type> and vs=[xs,ys,zs]^T, vd=[xd,yd,zd]^T two 3D + AffineMatrix3D and vs=[xs,ys,zs]^T, vd=[xd,yd,zd]^T two 3D vectors, the affine transformation is written as vd=M*vs. Concatenation of transformations amounts to multiplication of matrices, i.e. a translation, given by T, diff --git a/offapi/com/sun/star/geometry/IntegerRectangle2D.idl b/offapi/com/sun/star/geometry/IntegerRectangle2D.idl index 3d6397991595..010a8e7a8ec2 100644 --- a/offapi/com/sun/star/geometry/IntegerRectangle2D.idl +++ b/offapi/com/sun/star/geometry/IntegerRectangle2D.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module geometry { /* Removed, because XCanvas is private API until further notice. The values are stored as integers. Please note that the - <type>com.sun.star.rendering.XCanvas</type> defines the + com.sun.star.rendering.XCanvas defines the screen representation of rectangles in such a way that the lower and the rightmost line of the rectangle are not drawn on screen. Thus, if for two rectangles R1 and R2, R1.x2 equals R2.x1, diff --git a/offapi/com/sun/star/geometry/Matrix2D.idl b/offapi/com/sun/star/geometry/Matrix2D.idl index 16b5b5fb54e4..d64e155c3f00 100644 --- a/offapi/com/sun/star/geometry/Matrix2D.idl +++ b/offapi/com/sun/star/geometry/Matrix2D.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module geometry { The matrix defined by this structure constitutes a linear mapping of a point in 2D to another point in 2D. In contrast to - the <type>com.sun.star.geometry.AffineMatrix2D</type>, this + the com.sun.star.geometry.AffineMatrix2D, this matrix does not include any translational components.<p> A linear mapping, as performed by this matrix, can be written out @@ -41,7 +41,7 @@ module com { module sun { module star { module geometry { </code><p> Thus, in common matrix language, with M being the - <type>Matrix2D</type> and vs=[xs,ys]^T, vd=[xd,yd]^T two 2D + Matrix2D and vs=[xs,ys]^T, vd=[xd,yd]^T two 2D vectors, the linear mapping is written as vd=M*vs. Concatenation of transformations amounts to multiplication of matrices, i.e. a scaling, given by S, diff --git a/offapi/com/sun/star/geometry/RealRectangle2D.idl b/offapi/com/sun/star/geometry/RealRectangle2D.idl index dee9b4e713b2..19f38e0c38ca 100644 --- a/offapi/com/sun/star/geometry/RealRectangle2D.idl +++ b/offapi/com/sun/star/geometry/RealRectangle2D.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module geometry { /* Removed, because XCanvas is private API until further notice. The values are stored as reals. Please note that the - <type>com.sun.star.rendering.XCanvas</type> defines the + com.sun.star.rendering.XCanvas defines the screen representation of rectangles in such a way that the lower and the rightmost line of the rectangle are not drawn on screen. Thus, if for two rectangles R1 and R2, R1.x2 equals R2.x1, diff --git a/offapi/com/sun/star/geometry/XMapping2D.idl b/offapi/com/sun/star/geometry/XMapping2D.idl index b77a32b5238b..92aa12a44a4f 100644 --- a/offapi/com/sun/star/geometry/XMapping2D.idl +++ b/offapi/com/sun/star/geometry/XMapping2D.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module geometry { This interface provides methods to define an arbitrary bijective mapping from R^2 to R^2, i.e. from the two-dimensional space of real numbers onto itself, as is representable by the - <type>double</type> floating point type. The mapping must be + double floating point type. The mapping must be bijective, i.e. map a pair of real numbers to exactly one other pair of real numbers an vice versa, to facilitate a working inverse. Bijectiveness also implies completeness, i.e. for every diff --git a/offapi/com/sun/star/graphic/Graphic.idl b/offapi/com/sun/star/graphic/Graphic.idl index fe49807c8dfc..a1ee565d2f58 100644 --- a/offapi/com/sun/star/graphic/Graphic.idl +++ b/offapi/com/sun/star/graphic/Graphic.idl @@ -29,9 +29,9 @@ module com { module sun { module star { module graphic /** This service acts as a container for graphics <p>The main interface that has to be implemented for this service - is the <type>XGraphic</type> interface, which itself exposes only - a few methods. Beside this, a <type>Graphic</type> service - incorporates the <type>GraphicDescriptor</type> to give + is the XGraphic interface, which itself exposes only + a few methods. Beside this, a Graphic service + incorporates the GraphicDescriptor to give access to the attributes of the graphic. @see XGraphic diff --git a/offapi/com/sun/star/graphic/GraphicDescriptor.idl b/offapi/com/sun/star/graphic/GraphicDescriptor.idl index 84140a7ea7e3..91724ca0c3b9 100644 --- a/offapi/com/sun/star/graphic/GraphicDescriptor.idl +++ b/offapi/com/sun/star/graphic/GraphicDescriptor.idl @@ -116,7 +116,7 @@ published service GraphicDescriptor <p>This property is always <TRUE/> for vector graphics. The status of this flag is not always clear if the graphic was not loaded at all, e.g. in case of just - querying for the <type>GraphicDescriptor</type>.</p> + querying for the GraphicDescriptor.</p> */ [optional, property] boolean Transparent; @@ -124,7 +124,7 @@ published service GraphicDescriptor <p>The status of this flag is not always clear if the graphic was not loaded at all, e.g. in case of just - querying for the <type>GraphicDescriptor</type></p> + querying for the GraphicDescriptor</p> */ [optional, property] boolean Alpha; @@ -133,7 +133,7 @@ published service GraphicDescriptor <p>The status of this flag is not always clear if the graphic was not loaded at all, e.g. in case of just - querying for the <type>GraphicDescriptor</type></p> + querying for the GraphicDescriptor</p> */ [optional, property] boolean Animated; }; diff --git a/offapi/com/sun/star/graphic/GraphicObject.idl b/offapi/com/sun/star/graphic/GraphicObject.idl index 65e3da2267d8..b6339348bcc6 100644 --- a/offapi/com/sun/star/graphic/GraphicObject.idl +++ b/offapi/com/sun/star/graphic/GraphicObject.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module graphic { -/** The <code>GraphicObject</code> service can be used to create <type>XGraphicObject</type> instances. +/** The <code>GraphicObject</code> service can be used to create XGraphicObject instances. - <p><type>XGraphicObject</type> objects are accessible using GraphicObject scheme URLs like + <p>XGraphicObject objects are accessible using GraphicObject scheme URLs like <code>vnd.sun.star.GraphicObject:10000000000001940000012FB99807BD</code>. - As long as at least one instance of <type>XGraphicObject</type> with a particular UniqueID exists, + As long as at least one instance of XGraphicObject with a particular UniqueID exists, the associated image/graphic is available.</p> @see GraphicObject @@ -38,14 +38,14 @@ module com { module sun { module star { module graphic service GraphicObject : XGraphicObject { - /** Creates an <type>GraphicObject</type> + /** Creates an GraphicObject */ create(); - /** Creates an <type>GraphicObject</type> with <code>uniqueId</code> + /** Creates an GraphicObject with <code>uniqueId</code> @param uniqueId - If another <type>XGraphicObject</type> with <code>uniqueId</code> exists, this GraphicObject - is populated with the other <type>GraphicObject</type>'s data. + If another XGraphicObject with <code>uniqueId</code> exists, this GraphicObject + is populated with the other GraphicObject's data. */ createWithId( [in] string uniqueId ); }; diff --git a/offapi/com/sun/star/graphic/GraphicProvider.idl b/offapi/com/sun/star/graphic/GraphicProvider.idl index 9c12ef9d9190..1c0664708b33 100644 --- a/offapi/com/sun/star/graphic/GraphicProvider.idl +++ b/offapi/com/sun/star/graphic/GraphicProvider.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module graphic <p>This service allows to load graphics from and to store graphics to any location. The one and only interface that has to be implemented - is the <type>XGraphicProvider</type> interface, that exposes the necessary + is the XGraphicProvider interface, that exposes the necessary methods for loading and storing the graphic contents and descriptors</p> @see XGraphicProvider diff --git a/offapi/com/sun/star/graphic/GraphicRasterizer.idl b/offapi/com/sun/star/graphic/GraphicRasterizer.idl index ed9a84687798..63ee501d0295 100644 --- a/offapi/com/sun/star/graphic/GraphicRasterizer.idl +++ b/offapi/com/sun/star/graphic/GraphicRasterizer.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module graphic { /** Service that describes the necessary interfaces and properties - to convert arbitrary graphic data to a <type>XGraphic</type> + to convert arbitrary graphic data to a XGraphic interface containing a pixel graphic, that can be rendered the usual ways. */ diff --git a/offapi/com/sun/star/graphic/GraphicRendererVCL.idl b/offapi/com/sun/star/graphic/GraphicRendererVCL.idl index dd7f8baa84b1..09ba9bd841fc 100644 --- a/offapi/com/sun/star/graphic/GraphicRendererVCL.idl +++ b/offapi/com/sun/star/graphic/GraphicRendererVCL.idl @@ -28,11 +28,11 @@ module com { module sun { module star { module graphic { /** Service that describes the necessary interfaces and properties - to render a graphic container of <type>XGraphic</type> type + to render a graphic container of XGraphic type - <p>To render a <type>XGraphic</type> container, just create an + <p>To render a XGraphic container, just create an instance of this service, set the appropriate properties and use - the <type>XGraphicRenderer</type> interface to initiate the rendering + the XGraphicRenderer interface to initiate the rendering process itself</p> */ service GraphicRendererVCL @@ -46,7 +46,7 @@ service GraphicRendererVCL */ interface ::com::sun::star::beans::XPropertySet; - /** Holds the device onto which the <type>XGraphic</type> + /** Holds the device onto which the XGraphic container should be rendered <p>In case of using VCL Devices, this property should diff --git a/offapi/com/sun/star/graphic/MediaProperties.idl b/offapi/com/sun/star/graphic/MediaProperties.idl index 1f7cbe79aeec..3a60b29f5ee9 100644 --- a/offapi/com/sun/star/graphic/MediaProperties.idl +++ b/offapi/com/sun/star/graphic/MediaProperties.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module graphic { /** This service describes the properties that are used - when using the <type>XGraphicProvider</type> interface methods + when using the XGraphicProvider interface methods */ published service MediaProperties { diff --git a/offapi/com/sun/star/graphic/XGraphic.idl b/offapi/com/sun/star/graphic/XGraphic.idl index b12d4414c746..3acabcf2f2d7 100644 --- a/offapi/com/sun/star/graphic/XGraphic.idl +++ b/offapi/com/sun/star/graphic/XGraphic.idl @@ -29,12 +29,12 @@ module com { module sun { module star { module graphic /** This interface acts as a container for the loaded graphic. <p>The interface itself can be retrieved by using the appropriate - methods of <type>XGraphicProvider</type> interface. - <type>XGraphicProvider</type> also offers a method to store + methods of XGraphicProvider interface. + XGraphicProvider also offers a method to store the graphic content at a specific location</p> <p>To render the graphic content onto a specific device, you - have to create a <type>XGraphicRenderer</type> interface and pass + have to create a XGraphicRenderer interface and pass this interface appropriately</p> @see XGraphicProvider diff --git a/offapi/com/sun/star/graphic/XGraphicProvider.idl b/offapi/com/sun/star/graphic/XGraphicProvider.idl index 60f6a369d4af..db5550aa56c7 100644 --- a/offapi/com/sun/star/graphic/XGraphicProvider.idl +++ b/offapi/com/sun/star/graphic/XGraphicProvider.idl @@ -66,7 +66,7 @@ published interface XGraphicProvider : ::com::sun::star::uno::XInterface - /** Calling this method returns a <type>XGraphic</type> interface + /** Calling this method returns a XGraphic interface that holds the graphic content after loading the graphic @param MediaProperties @@ -74,7 +74,7 @@ published interface XGraphicProvider : ::com::sun::star::uno::XInterface of the graphic from which the graphic is to be loaded @returns - The <type>XGraphic</type> interface + The XGraphic interface @see MediaProperties @see XGraphic @@ -85,7 +85,7 @@ published interface XGraphicProvider : ::com::sun::star::uno::XInterface ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException ); - /** Store the graphic content, represented through the <type>XGraphic</type> + /** Store the graphic content, represented through the XGraphic interface at the specified location @param Graphic diff --git a/offapi/com/sun/star/graphic/XGraphicRasterizer.idl b/offapi/com/sun/star/graphic/XGraphicRasterizer.idl index 0ad7e65d4e9a..19c0c491debc 100644 --- a/offapi/com/sun/star/graphic/XGraphicRasterizer.idl +++ b/offapi/com/sun/star/graphic/XGraphicRasterizer.idl @@ -79,13 +79,13 @@ interface XGraphicRasterizer : ::com::sun::star::uno::XInterface [in] unsigned long DPI_Y, [out] com::sun::star::awt::Size DefaultSizePixel ); - /** Rasterizing the initialized data into a <type>XGraphic</type> container. + /** Rasterizing the initialized data into a XGraphic container. - <p>The <type>XGraphic</type> container will contain a pixel + <p>The XGraphic container will contain a pixel type graphic after a successful rasterization process</p> <p>In case of any fault during the rasterization process, - the <type>XGraphic</type> container will be empty afterwards and + the XGraphic container will be empty afterwards and the method will return false</p> @param Width diff --git a/offapi/com/sun/star/graphic/XGraphicRenderer.idl b/offapi/com/sun/star/graphic/XGraphicRenderer.idl index d8f7e4fd983c..08e337958d64 100644 --- a/offapi/com/sun/star/graphic/XGraphicRenderer.idl +++ b/offapi/com/sun/star/graphic/XGraphicRenderer.idl @@ -27,11 +27,11 @@ module com { module sun { module star { module graphic { /** This interfaces exposes just one method to render - a <type>XGraphic</type> container + a XGraphic container */ interface XGraphicRenderer : ::com::sun::star::uno::XInterface { - /** Renders the <type>XGraphic</type> container + /** Renders the XGraphic container @param Graphic The graphic container to be rendered diff --git a/offapi/com/sun/star/graphic/XGraphicTransformer.idl b/offapi/com/sun/star/graphic/XGraphicTransformer.idl index d6dbaaec42e7..11b2896967a3 100644 --- a/offapi/com/sun/star/graphic/XGraphicTransformer.idl +++ b/offapi/com/sun/star/graphic/XGraphicTransformer.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module graphic { -/** This interface is allowing to transform a <type>XGraphic</type> +/** This interface is allowing to transform a XGraphic - <p>To transform a <type>XGraphic</type>, just the corresponding + <p>To transform a XGraphic, just the corresponding method has to be used, a new XGraphic instance will be returned </p> */ diff --git a/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl b/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl index 7b0f84f4ec53..6dfcc424af2f 100644 --- a/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl +++ b/offapi/com/sun/star/graphic/XPrimitiveFactory2D.idl @@ -42,7 +42,7 @@ interface XPrimitive2D; */ interface XPrimitiveFactory2D : ::com::sun::star::uno::XInterface { - /** Create primitives from <type>::com::sun::star::drawing::XShape</type> + /** Create primitives from ::com::sun::star::drawing::XShape @param xShape The XShape, for which the primitives are to be @@ -60,7 +60,7 @@ interface XPrimitiveFactory2D : ::com::sun::star::uno::XInterface [in] ::com::sun::star::drawing::XShape xShape, [in] sequence< ::com::sun::star::beans::PropertyValue > aParms ); - /** Create primitives from <type>::com::sun::star::drawing::XDrawPage</type> + /** Create primitives from ::com::sun::star::drawing::XDrawPage @param xDrawPage The XDrawPage, for which the primitives are to be diff --git a/offapi/com/sun/star/i18n/Calendar.idl b/offapi/com/sun/star/i18n/Calendar.idl index 900ce249bd06..496eea036c2c 100644 --- a/offapi/com/sun/star/i18n/Calendar.idl +++ b/offapi/com/sun/star/i18n/Calendar.idl @@ -36,11 +36,11 @@ module com { module sun { module star { module i18n { published struct Calendar { - /// the days of the week, see also <type>CalendarItem</type>. + /// the days of the week, see also CalendarItem. sequence< CalendarItem > Days; - /// the months of the year, see also <type>CalendarItem</type>. + /// the months of the year, see also CalendarItem. sequence< CalendarItem > Months; - /// the possible eras, see also <type>CalendarItem</type>. + /// the possible eras, see also CalendarItem. sequence< CalendarItem > Eras; /// the ID of the day with which the week begins. string StartOfWeek; diff --git a/offapi/com/sun/star/i18n/CalendarFieldIndex.idl b/offapi/com/sun/star/i18n/CalendarFieldIndex.idl index 71fe8a66d920..017f1f5cad95 100644 --- a/offapi/com/sun/star/i18n/CalendarFieldIndex.idl +++ b/offapi/com/sun/star/i18n/CalendarFieldIndex.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** - Field indices to be passed to various <type>XCalendar</type> methods. + Field indices to be passed to various XCalendar methods. <p> Field is writable only if marked both Get/Set. </p> @@ -44,7 +44,7 @@ module com { module sun { module star { module i18n { */ published constants CalendarFieldIndex { - /// Get <type>AmPmValue</type>. + /// Get AmPmValue. const short AM_PM = 0; /// Get/Set day of month [1-31]. const short DAY_OF_MONTH = 1; diff --git a/offapi/com/sun/star/i18n/CharType.idl b/offapi/com/sun/star/i18n/CharType.idl index 20d8f9b28147..6d12a5eea642 100644 --- a/offapi/com/sun/star/i18n/CharType.idl +++ b/offapi/com/sun/star/i18n/CharType.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Constants to specify the character type that starts a character block. - Character type is Unicode type defined in <type>UnicodeType</type> + Character type is Unicode type defined in UnicodeType <p> Used with <member>XBreakIterator::beginOfCharBlock()</member>, <member>XBreakIterator::endOfCharBlock()</member>, diff --git a/offapi/com/sun/star/i18n/CollatorOptions.idl b/offapi/com/sun/star/i18n/CollatorOptions.idl index 5915a5ffb316..50694c486dc4 100644 --- a/offapi/com/sun/star/i18n/CollatorOptions.idl +++ b/offapi/com/sun/star/i18n/CollatorOptions.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module i18n { -/** Options to be used with <type>XCollator</type> methods. +/** Options to be used with XCollator methods. */ published constants CollatorOptions { diff --git a/offapi/com/sun/star/i18n/ForbiddenCharacters.idl b/offapi/com/sun/star/i18n/ForbiddenCharacters.idl index 975b33322546..98f31cbeb290 100644 --- a/offapi/com/sun/star/i18n/ForbiddenCharacters.idl +++ b/offapi/com/sun/star/i18n/ForbiddenCharacters.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module i18n { <p> Returned by <method>XLocaleData::getForbiddenCharacters</method> and used with - <type>XForbiddenCharacters</type> methods. + XForbiddenCharacters methods. */ published struct ForbiddenCharacters diff --git a/offapi/com/sun/star/i18n/FormatElement.idl b/offapi/com/sun/star/i18n/FormatElement.idl index 70ca66eebcb5..bb0decccee13 100644 --- a/offapi/com/sun/star/i18n/FormatElement.idl +++ b/offapi/com/sun/star/i18n/FormatElement.idl @@ -49,11 +49,11 @@ published struct FormatElement string formatType; /** Usage category, for example, "DATE" or "FIXED_NUMBER", - corresponding with <type>KNumberFormatUsage</type> values. */ + corresponding with KNumberFormatUsage values. */ string formatUsage; /** The index used by the number formatter, predefined values - corresponding with <type>NumberFormatIndex</type> values. */ + corresponding with NumberFormatIndex values. */ short formatIndex; /** If a format code is the default code of a <em>formatType</em> diff --git a/offapi/com/sun/star/i18n/KCharacterType.idl b/offapi/com/sun/star/i18n/KCharacterType.idl index acb2a6905202..0b7e10f7ae08 100644 --- a/offapi/com/sun/star/i18n/KCharacterType.idl +++ b/offapi/com/sun/star/i18n/KCharacterType.idl @@ -57,7 +57,7 @@ published constants KCharacterType /// base form const long BASE_FORM = 0x00000040; - /** any <type>UnicodeType</type>::..._LETTER. + /** any UnicodeType::..._LETTER. Note that a LETTER must not necessarily be ALPHA */ const long LETTER = 0x00000080; }; diff --git a/offapi/com/sun/star/i18n/KParseTokens.idl b/offapi/com/sun/star/i18n/KParseTokens.idl index 2b641b8f487a..58ab6c4283ed 100644 --- a/offapi/com/sun/star/i18n/KParseTokens.idl +++ b/offapi/com/sun/star/i18n/KParseTokens.idl @@ -62,7 +62,7 @@ published constants KParseTokens /** Special value to allow anything below 128 except control characters. <strong>Not</strong> set in - <type>ParseResult</type>. */ + ParseResult. */ const long ASC_ANY_BUT_CONTROL = 0x00000400; /** Additional flag set in <member>ParseResult::StartFlags</member> @@ -117,7 +117,7 @@ published constants KParseTokens <method>ChararacterClassification::parseAnyToken</method> and <method>ChararacterClassification::parsePredefinedToken</method>, ignored on <em>nContCharFlags</em> parameter. - <strong>Not</strong> set in <type>ParseResult</type>. */ + <strong>Not</strong> set in ParseResult. */ const long IGNORE_LEADING_WS = 0x40000000; diff --git a/offapi/com/sun/star/i18n/LineBreakResults.idl b/offapi/com/sun/star/i18n/LineBreakResults.idl index 5b1ebc5d457b..33702bf3f2d0 100644 --- a/offapi/com/sun/star/i18n/LineBreakResults.idl +++ b/offapi/com/sun/star/i18n/LineBreakResults.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module i18n { */ published struct LineBreakResults { - /// Type of line break, see <type>BreakType</type>. + /// Type of line break, see BreakType. short breakType; /// Position of the calculated line break. diff --git a/offapi/com/sun/star/i18n/LocaleItem.idl b/offapi/com/sun/star/i18n/LocaleItem.idl index 73da534a35ba..97f6d586a667 100644 --- a/offapi/com/sun/star/i18n/LocaleItem.idl +++ b/offapi/com/sun/star/i18n/LocaleItem.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module i18n { Constant values identifying specific locale data items. <p> These are not used with the API but with an OOo internal wrapper class - that caches the contents of an instance of <type>LocaleDataItem</type> and + that caches the contents of an instance of LocaleDataItem and uses these values to access it's members for faster access. </p> <p> Whenever locale data items were added these values and the wrapper diff --git a/offapi/com/sun/star/i18n/NativeNumberMode.idl b/offapi/com/sun/star/i18n/NativeNumberMode.idl index 44cd30e2ba91..c8907de14816 100644 --- a/offapi/com/sun/star/i18n/NativeNumberMode.idl +++ b/offapi/com/sun/star/i18n/NativeNumberMode.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module i18n { /** Constants to use with <member>XExtendedCalendar::getDisplayString()</member> and the - <type>XNativeNumberSupplier</type> methods. + XNativeNumberSupplier methods. <p> The constants have different meanings if used with different locales. However, <const>NATNUM1</const> always tries to convert to diff --git a/offapi/com/sun/star/i18n/NumberFormatCode.idl b/offapi/com/sun/star/i18n/NumberFormatCode.idl index b63b994046e3..594c7dc4c3d8 100644 --- a/offapi/com/sun/star/i18n/NumberFormatCode.idl +++ b/offapi/com/sun/star/i18n/NumberFormatCode.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module i18n { /** Number format code information returned by various - <type>XNumberFormatCode</type> methods. + XNumberFormatCode methods. */ published struct NumberFormatCode { - /// One of <type>KNumberFormatType</type> values. + /// One of KNumberFormatType values. short Type; - /// One of <type>KNumberFormatUsage</type> values. + /// One of KNumberFormatUsage values. short Usage; /// Format code, for example, "YYYY-MM-DD". string Code; @@ -40,7 +40,7 @@ published struct NumberFormatCode string DefaultName; /// Message identifier to be used if the name of the format is localized. string NameID; - /// Index of the code as defined in <type>NumberFormatIndex</type>. + /// Index of the code as defined in NumberFormatIndex. short Index; /// If this format is the default format of the <em>Usage</em> group. boolean Default; diff --git a/offapi/com/sun/star/i18n/ParseResult.idl b/offapi/com/sun/star/i18n/ParseResult.idl index 7718209826d4..c94867ba10e1 100644 --- a/offapi/com/sun/star/i18n/ParseResult.idl +++ b/offapi/com/sun/star/i18n/ParseResult.idl @@ -45,11 +45,11 @@ published struct ParseResult /** Value of token in case of numeric. */ double Value; - /** <type>KParseType</type> token type like + /** KParseType token type like <const>KParseType::IDENTNAME</const>. */ long TokenType; - /** <type>KParseTokens</type> flags of first character of actual + /** KParseTokens flags of first character of actual token matched. If <em>TokenType</em> is a <const>KParseType::SINGLE_QUOTE_NAME</const> or a <const>KParseType::DOUBLE_QUOTE_STRING</const> the first @@ -57,7 +57,7 @@ published struct ParseResult quote itself. */ long StartFlags; - /** <type>KParseTokens</type> flags of remaining characters of + /** KParseTokens flags of remaining characters of actual token matched. */ long ContFlags; diff --git a/offapi/com/sun/star/i18n/ScriptDirection.idl b/offapi/com/sun/star/i18n/ScriptDirection.idl index 2b31de6de646..958f87a3c382 100644 --- a/offapi/com/sun/star/i18n/ScriptDirection.idl +++ b/offapi/com/sun/star/i18n/ScriptDirection.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** Script direction constants to use with - <type>XScriptTypeDetector</type> methods. + XScriptTypeDetector methods. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/i18n/TextConversionOption.idl b/offapi/com/sun/star/i18n/TextConversionOption.idl index 3d3d72bc8480..29f446cf648e 100644 --- a/offapi/com/sun/star/i18n/TextConversionOption.idl +++ b/offapi/com/sun/star/i18n/TextConversionOption.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module i18n { -/** Text conversion options to be used with <type>XTextConversion</type>. +/** Text conversion options to be used with XTextConversion. <p>These text conversion options are usually selected by end users. The options can be combined and may be related to - <type>TextConversionType</type>. </p> + TextConversionType. </p> @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/i18n/TextConversionResult.idl b/offapi/com/sun/star/i18n/TextConversionResult.idl index 86bd06d138d8..9df551b9a1f6 100644 --- a/offapi/com/sun/star/i18n/TextConversionResult.idl +++ b/offapi/com/sun/star/i18n/TextConversionResult.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module i18n { -/** Text conversion result to be used with <type>XTextConversion</type>. +/** Text conversion result to be used with XTextConversion. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/i18n/TextConversionType.idl b/offapi/com/sun/star/i18n/TextConversionType.idl index cf9b225f30a3..1282568626c8 100644 --- a/offapi/com/sun/star/i18n/TextConversionType.idl +++ b/offapi/com/sun/star/i18n/TextConversionType.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module i18n { /** These constants specify the conversion type to be used with - <type>XTextConversion</type>. + XTextConversion. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl index 491c600b140b..7859c2b9cb12 100644 --- a/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl +++ b/offapi/com/sun/star/i18n/TransliterationModulesExtra.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module i18n { <member>XTransliteration::loadModule()</member> The values used in this group need to be different from the ones in - <type>TransliterationModules</type> and <type>TransliterationModulesNew</type>! + TransliterationModules and TransliterationModulesNew! */ diff --git a/offapi/com/sun/star/i18n/XBreakIterator.idl b/offapi/com/sun/star/i18n/XBreakIterator.idl index 0c9a302b9c66..80814e54e5a6 100644 --- a/offapi/com/sun/star/i18n/XBreakIterator.idl +++ b/offapi/com/sun/star/i18n/XBreakIterator.idl @@ -40,7 +40,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface { /** Traverses specified number of characters/cells in Text from <em>nStartPos</em> forwards. - <type>CharacterIteratorMode</type> can be cell based or + CharacterIteratorMode can be cell based or character based. A cell is made of more than one character. @param nCount @@ -55,7 +55,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses specified number of characters/cells in Text from <em>nStartPos</em> backwards. - <type>CharacterIteratorMode</type> can be cell based or + CharacterIteratorMode can be cell based or character based. A cell is made of more than one character. @param nCount @@ -71,11 +71,11 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Traverses one word in Text from <em>nStartPos</em> forwards. @param nWordType - One of <type>WordType</type>, specifies the type of + One of WordType, specifies the type of traveling. @returns - The <type>Boundary</type> of the found word. Normally used for + The Boundary of the found word. Normally used for CTRL-Right. */ Boundary nextWord( [in] string aText, [in] long nStartPos, @@ -106,11 +106,11 @@ published interface XBreakIterator: com::sun::star::uno::XInterface This is fixed in later versions. </p> @param nWordType - One of <type>WordType</type>, specifies the type of + One of WordType, specifies the type of traveling. @returns - The <type>Boundary</type> of the found word. Normally used for + The Boundary of the found word. Normally used for CTRL-Left. */ Boundary previousWord( [in] string aText, [in] long nStartPos, @@ -129,7 +129,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface we look forwards for the end of the word. </p> @param nWordType - One of <type>WordType</type>. + One of WordType. @returns The Boundary of the current word. @@ -140,10 +140,10 @@ published interface XBreakIterator: com::sun::star::uno::XInterface [in] boolean bPreferForward ); /** @deprecated - Get the <type>WordType</type> of the word that starts at + Get the WordType of the word that starts at position <em>nPos</em>. - <p> This method is mis-defined, since <type>WordType</type> + <p> This method is mis-defined, since WordType is not an attribute of a word, but a way to break words, like excluding or including tail spaces for spell checker or cursor traveling. It returns 0 always. @@ -196,7 +196,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface Defines a minimum break position for hyphenated line break. When the position for hyphenated line break is less than <em>nMinBreakPos</em>, break position in - <type>LineBreakResults</type> is set to -1. + LineBreakResults is set to -1. @param aHyphOptions Defines if the hyphenator is to be used. @@ -206,8 +206,8 @@ published interface XBreakIterator: com::sun::star::uno::XInterface characters at the start/end of a line. @returns - The <type>LineBreakResults</type> contain the break - position of the line, <type>BreakType</type> and + The LineBreakResults contain the break + position of the line, BreakType and <type scope="com::sun::star::linguistic2">XHyphenatedWord</type> */ LineBreakResults getLineBreak( [in] string aText, [in] long nStartPos, @@ -220,7 +220,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface the specified script type. @param nScriptType - One of <type>ScriptType</type>. + One of ScriptType. @returns The position where the script type starts. @@ -232,7 +232,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface specified script type. @param nScriptType - One of <type>ScriptType</type>. + One of ScriptType. @returns The position where the script type ends. @@ -244,7 +244,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface the specified script type. @param nScriptType - One of <type>ScriptType</type>. + One of ScriptType. @returns The position where the next script type starts. @@ -256,7 +256,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface of the specified script type. @param nScriptType - One of <type>ScriptType</type>. + One of ScriptType. @returns The position where the previous script type starts. @@ -267,7 +267,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface /** Get the script type of the character at position <em>nPos</em>. @returns - One of <type>ScriptType</type>. + One of ScriptType. */ short getScriptType( [in] string aText, [in] long nPos); @@ -275,7 +275,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface the specified character type. @param nCharType - One of <type>CharType</type> + One of CharType @returns The position where the character type starts @@ -288,7 +288,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface specified character type. @param nCharType - One of <type>CharType</type> + One of CharType @returns The position where the character type ends. @@ -301,7 +301,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface the specified character type. @param nCharType - One of <type>CharType</type> + One of CharType @returns The position where the next character type starts. @@ -314,7 +314,7 @@ published interface XBreakIterator: com::sun::star::uno::XInterface of the specified character type. @param nCharType - One of <type>CharType</type> + One of CharType @returns The position where the previous character type starts. diff --git a/offapi/com/sun/star/i18n/XCalendar.idl b/offapi/com/sun/star/i18n/XCalendar.idl index df7a76f85a99..584ad96f43f6 100644 --- a/offapi/com/sun/star/i18n/XCalendar.idl +++ b/offapi/com/sun/star/i18n/XCalendar.idl @@ -41,7 +41,7 @@ published interface XCalendar : com::sun::star::uno::XInterface void loadCalendar( [in] string uniqueID, [in] ::com::sun::star::lang::Locale rLocale ); - /// Get the currently loaded <type>Calendar</type>. + /// Get the currently loaded Calendar. Calendar getLoadedCalendar(); /// Returns all available calendars for the given locale. @@ -72,7 +72,7 @@ published interface XCalendar : com::sun::star::uno::XInterface Set the value of a field. @param nCalendarFieldIndex - One of <type>CalendarFieldIndex</type> values. + One of CalendarFieldIndex values. @param nValue A value of the allowed range for the field index. @@ -83,7 +83,7 @@ published interface XCalendar : com::sun::star::uno::XInterface Get the value of a field. @param nCalendarFieldIndex - One of <type>CalendarFieldIndex</type> values. + One of CalendarFieldIndex values. */ short getValue( [in] short nCalendarFieldIndex ); @@ -99,19 +99,19 @@ published interface XCalendar : com::sun::star::uno::XInterface Add an amount to a field. @param nCalendarFieldIndex - One of <type>CalendarFieldIndex</type> values. + One of CalendarFieldIndex values. @param nAmount The amount to add. */ void addValue( [in] short nCalendarFieldIndex, [in] long nAmount ); - /** returns the first day of a week, one of <type>Weekdays</type> + /** returns the first day of a week, one of Weekdays values. */ short getFirstDayOfWeek(); - /** Set the first day of a week, one of <type>Weekdays</type> + /** Set the first day of a week, one of Weekdays values. */ void setFirstDayOfWeek( [in] short nDay ); @@ -132,12 +132,12 @@ published interface XCalendar : com::sun::star::uno::XInterface /// returns the number of days in a week, e.g. <b>7</b> short getNumberOfDaysInWeek(); - /** returns a sequence of <type>CalendarItem</type> describing the + /** returns a sequence of CalendarItem describing the month names. */ sequence< CalendarItem > getMonths(); - /** returns a sequence of <type>CalendarItem</type> describing the + /** returns a sequence of CalendarItem describing the day names. */ sequence< CalendarItem > getDays(); @@ -146,19 +146,19 @@ published interface XCalendar : com::sun::star::uno::XInterface Returns a string (name to display) matching the given parameters. @param nCalendarDisplayIndex - One of <type>CalendarDisplayIndex</type> values + One of CalendarDisplayIndex values @param nIdx A value matching the <em>nCalendarDisplayIndex</em> type: <dl> <dt><const>CalendarDisplayIndex::AM_PM</const></dt> - <dd>one of <type>AmPmValue</type></dd> + <dd>one of AmPmValue</dd> <dt><const>CalendarDisplayIndex::DAY</const></dt> - <dd>one of <type>Weekdays</type> or a number used as + <dd>one of Weekdays or a number used as an offset into the corresponding <member>Calendar::Days</member> sequence</dd> <dt><const>CalendarDisplayIndex::MONTH</const></dt> - <dd>one of <type>Months</type> or a number used as + <dd>one of Months or a number used as an offset into the corresponding <member>Calendar::Months</member> sequence</dd> <dt><const>CalendarDisplayIndex::YEAR</const></dt> @@ -175,12 +175,12 @@ published interface XCalendar : com::sun::star::uno::XInterface <p> The value should be obtained by a previous call to <member>XCalendar::getValue()</member> with an appropriate - <type>CalendarFieldIndex</type> argument. </p> + CalendarFieldIndex argument. </p> @param nNameType A value indicating whether to return the abbreviated or the full name, or the narrow name for some - <type>CalendarDisplayIndex</type> values. + CalendarDisplayIndex values. <dl> <dt> 0 </dt> <dd>abbreviated name, e.g. <b>"Jan"</b></dd> diff --git a/offapi/com/sun/star/i18n/XCalendar3.idl b/offapi/com/sun/star/i18n/XCalendar3.idl index b3f290127e3a..db6cf31b7615 100644 --- a/offapi/com/sun/star/i18n/XCalendar3.idl +++ b/offapi/com/sun/star/i18n/XCalendar3.idl @@ -24,33 +24,33 @@ module com { module sun { module star { module i18n { <p> It is derived from <type scope="::com::sun::star::i18n">XExtendedCalendar</type> and - provides additional methods to obtain <type>Calendar2</type> items + provides additional methods to obtain Calendar2 items that include the possessive genitive case month names and sequences - of <type>CalendarItem2</type> items.. </p> + of CalendarItem2 items.. </p> @since LibreOffice 3.5 */ published interface XCalendar3 : com::sun::star::i18n::XExtendedCalendar { - /// Get the currently loaded <type>Calendar2</type>. + /// Get the currently loaded Calendar2. Calendar2 getLoadedCalendar2(); - /** returns a sequence of <type>CalendarItem2</type> describing the + /** returns a sequence of CalendarItem2 describing the day names. */ sequence< CalendarItem2 > getDays2(); - /** returns a sequence of <type>CalendarItem2</type> describing the + /** returns a sequence of CalendarItem2 describing the month names. */ sequence< CalendarItem2 > getMonths2(); - /** returns a sequence of <type>CalendarItem2</type> describing the + /** returns a sequence of CalendarItem2 describing the genitive case month names. */ sequence< CalendarItem2 > getGenitiveMonths2(); - /** returns a sequence of <type>CalendarItem2</type> describing the + /** returns a sequence of CalendarItem2 describing the partitive case month names. */ sequence< CalendarItem2 > getPartitiveMonths2(); diff --git a/offapi/com/sun/star/i18n/XCharacterClassification.idl b/offapi/com/sun/star/i18n/XCharacterClassification.idl index 269b5741ef36..97677a3aecbf 100644 --- a/offapi/com/sun/star/i18n/XCharacterClassification.idl +++ b/offapi/com/sun/star/i18n/XCharacterClassification.idl @@ -91,22 +91,22 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface string toTitle( [in] string aText, [in] long nPos, [in] long nCount, [in] com::sun::star::lang::Locale aLocale ); - /// Get <type>UnicodeType</type> of character at position <em>nPos</em>. + /// Get UnicodeType of character at position <em>nPos</em>. short getType( [in] string aText, [in] long nPos ); - /** Get <type>DirectionProperty</type> of character at position + /** Get DirectionProperty of character at position <em>nPos</em>. */ short getCharacterDirection( [in] string aText, [in] long nPos ); - /// Get <type>UnicodeScript</type> of character at position <em>nPos</em>. + /// Get UnicodeScript of character at position <em>nPos</em>. short getScript( [in] string aText, [in] long nPos ); - /// Get <type>KCharacterType</type> of character at position <em>nPos</em>. + /// Get KCharacterType of character at position <em>nPos</em>. long getCharacterType( [in] string aText, [in] long nPos, [in] com::sun::star::lang::Locale aLocale ); - /** Get accumulated <type>KCharacterType</type>s of string starting + /** Get accumulated KCharacterTypes of string starting at position <em>nPos</em> of length <em>nCount</em> code points. @returns @@ -122,7 +122,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface Parse a string for a token starting at position <em>nPos</em>. <p> A name or identifier must match the - <type>KParseTokens</type> criteria passed in + KParseTokens criteria passed in <em>nStartCharFlags</em> and <em>nContCharFlags</em> and may additionally contain characters of <em>aUserDefinedCharactersStart</em> and/or @@ -130,7 +130,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface @returns - A filled <type>ParseResult</type> structure. If no + A filled ParseResult structure. If no unambiguous token could be parsed, <member>ParseResult::TokenType</member> will be set to <b>0</b> (zero), other fields will contain the values parsed @@ -154,7 +154,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface character type determination. @param nStartCharFlags - A set of <type>KParseTokens</type> constants determining the + A set of KParseTokens constants determining the allowed characters a name or identifier may start with. @param aUserDefinedCharactersStart @@ -162,7 +162,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface identifier may start with. @param nContCharFlags - A set of <type>KParseTokens</type> constants determining the + A set of KParseTokens constants determining the allowed characters a name or identifier may continue with. @param aUserDefinedCharactersCont @@ -218,7 +218,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface is returned. </p> @param nTokenType - One or more of the <type>KParseType</type> constants. + One or more of the KParseType constants. @example:C++ <listing> diff --git a/offapi/com/sun/star/i18n/XCollator.idl b/offapi/com/sun/star/i18n/XCollator.idl index 66c1937a000d..6e9cd30eb315 100644 --- a/offapi/com/sun/star/i18n/XCollator.idl +++ b/offapi/com/sun/star/i18n/XCollator.idl @@ -80,7 +80,7 @@ published interface XCollator: com::sun::star::uno::XInterface The locale for this collator. @param nCollatorOptions - A mask of <type>CollatorOptions</type>. + A mask of CollatorOptions. @returns Returns 0 when loading was successful, @@ -99,7 +99,7 @@ published interface XCollator: com::sun::star::uno::XInterface The locale for this collator. @param nCollatorOptions - A mask of <type>CollatorOptions</type>. + A mask of CollatorOptions. @returns Returns 0 when loading was successful, diff --git a/offapi/com/sun/star/i18n/XExtendedCalendar.idl b/offapi/com/sun/star/i18n/XExtendedCalendar.idl index c0bccfc3a0dd..c0989f7297de 100644 --- a/offapi/com/sun/star/i18n/XExtendedCalendar.idl +++ b/offapi/com/sun/star/i18n/XExtendedCalendar.idl @@ -53,10 +53,10 @@ published interface XExtendedCalendar : ::com::sun::star::i18n::XCalendar digits. <p/> @param nCalendarDisplayCode - One of <type>CalendarDisplayCode</type> + One of CalendarDisplayCode @param nNativeNumberMode - One of <type>NativeNumberMode</type>. <br/> + One of NativeNumberMode. <br/> This argument designates the basic transliteration mode as if specified for the year representation. However, depending on the locale, different conversions for year and month, for diff --git a/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl b/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl index f046ff4d16bf..4b6af56f303e 100644 --- a/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl +++ b/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl @@ -42,7 +42,7 @@ published interface XExtendedInputSequenceChecker : ::com::sun::star::i18n::XInp Next nPos, or length of aText if nothing is corrected. @param nInputCheckMode - One of <type>InputSequenceCheckMode</type> constants. + One of InputSequenceCheckMode constants. */ long correctInputSequence( [inout] string aText, [in] long nPos, [in] char cInputChar, [in] short nInputCheckMode ); diff --git a/offapi/com/sun/star/i18n/XInputSequenceChecker.idl b/offapi/com/sun/star/i18n/XInputSequenceChecker.idl index 75bb13e296fe..a1e09fe4fe96 100644 --- a/offapi/com/sun/star/i18n/XInputSequenceChecker.idl +++ b/offapi/com/sun/star/i18n/XInputSequenceChecker.idl @@ -37,7 +37,7 @@ published interface XInputSequenceChecker : ::com::sun::star::uno::XInterface /** @returns true/false for the input check @param nInputCheckMode - One of <type>InputSequenceCheckMode</type> constants. + One of InputSequenceCheckMode constants. */ boolean checkInputSequence( [in] string aText, [in] long nPos, [in] char cInputChar, [in] short nInputCheckMode ); diff --git a/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl b/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl index 860e3c330f3a..e9886f3499d1 100644 --- a/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl +++ b/offapi/com/sun/star/i18n/XNativeNumberSupplier.idl @@ -38,7 +38,7 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface /** Returns native number string for given number string. @param nNativeNumberMode - One of <type>NativeNumberMode</type> values. + One of NativeNumberMode values. */ string getNativeNumberString( [in] string aNumberString, @@ -48,7 +48,7 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface /** Check if the NatNum is valid for the given locale. @param nNativeNumberMode - One of <type>NativeNumberMode</type> values. + One of NativeNumberMode values. */ boolean isValidNatNum( [in] ::com::sun::star::lang::Locale aLocale, @@ -58,7 +58,7 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface in the XML file format. @param nNativeNumberMode - One of <type>NativeNumberMode</type> values. + One of NativeNumberMode values. */ NativeNumberXmlAttributes convertToXmlAttributes( @@ -68,7 +68,7 @@ published interface XNativeNumberSupplier : ::com::sun::star::uno::XInterface /** Convert XML attributes to a NatNum value. @returns - One of <type>NativeNumberMode</type> + One of NativeNumberMode */ short convertFromXmlAttributes( [in] NativeNumberXmlAttributes aAttr ); diff --git a/offapi/com/sun/star/i18n/XNumberFormatCode.idl b/offapi/com/sun/star/i18n/XNumberFormatCode.idl index d201f3e11543..b6feea9da0aa 100644 --- a/offapi/com/sun/star/i18n/XNumberFormatCode.idl +++ b/offapi/com/sun/star/i18n/XNumberFormatCode.idl @@ -39,10 +39,10 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface (usage group) for a given locale and format length type. @param nFormatType - one of the constants listed in <type>KNumberFormatType</type> + one of the constants listed in KNumberFormatType @param nFormatUsage - one of <type>KNumberFormatUsage</type> values + one of KNumberFormatUsage values */ NumberFormatCode getDefault( [in] short nFormatType, [in] short nFormatUsage, @@ -53,7 +53,7 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface a given locale. @param nFormatIndex - one of <type>NumberFormatIndex</type> values + one of NumberFormatIndex values */ NumberFormatCode getFormatCode( [in] short nFormatIndex, [in] com::sun::star::lang::Locale rLocale ); @@ -62,7 +62,7 @@ published interface XNumberFormatCode : com::sun::star::uno::XInterface returns all format codes for a given <em>nFormatUsage</em> and locale. @param nFormatUsage - one of <type>KNumberFormatUsage</type> values + one of KNumberFormatUsage values */ sequence< NumberFormatCode > getAllFormatCode( [in] short nFormatUsage, diff --git a/offapi/com/sun/star/i18n/XScriptTypeDetector.idl b/offapi/com/sun/star/i18n/XScriptTypeDetector.idl index 6a5e4ce8df8c..d96f428c2c8f 100644 --- a/offapi/com/sun/star/i18n/XScriptTypeDetector.idl +++ b/offapi/com/sun/star/i18n/XScriptTypeDetector.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module i18n { <p> Assumption - StartPos is inclusive and EndPos is exclusive. </p> <p> The <em>nScriptDirection</em> parameters are of type - <type>ScriptDirection</type></p> + ScriptDirection</p> @since OOo 1.1.2 */ @@ -64,7 +64,7 @@ published interface XScriptTypeDetector : ::com::sun::star::uno::XInterface long endOfCTLScriptType( [in] string aText, [in] long nPos); /** @returns the CTL script type of the current position. <br/> - One of <type>CTLScriptType</type> constants. + One of CTLScriptType constants. */ short getCTLScriptType ([in] string aText, [in] long nPos); }; diff --git a/offapi/com/sun/star/i18n/XTextConversion.idl b/offapi/com/sun/star/i18n/XTextConversion.idl index dc6b218d7568..e809cebb9973 100644 --- a/offapi/com/sun/star/i18n/XTextConversion.idl +++ b/offapi/com/sun/star/i18n/XTextConversion.idl @@ -48,11 +48,11 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface @param aLocal Locale the conversion is referring to. @param nTextConversionType - One of <type>TextConversionType</type> values. + One of TextConversionType values. @param nTextConversionOptions - Combination of <type>TextConversionOption</type> values. + Combination of TextConversionOption values. @returns - <type>TextConversionResult</type> + TextConversionResult @throws NoSupportException when <var>nConversionDictionaryType</var> is not known by the implementation, @@ -81,9 +81,9 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface @param aLocal Locale the conversion is referring to. @param nTextConversionType - One of <type>TextConversionType</type> values. + One of TextConversionType values. @param nTextConversionOptions - Combination of <type>TextConversionOption</type> values. + Combination of TextConversionOption values. @returns Converted text @@ -107,9 +107,9 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface @param aLocal Locale the conversion is referring to. @param nTextConversionType - One of <type>TextConversionType</type> values. + One of TextConversionType values. @param nTextConversionOptions - Combination of <type>TextConversionOption</type> values. + Combination of TextConversionOption values. @returns <TRUE/> if the entry is a valid entry for the dictionary <FALSE/> otherwise. diff --git a/offapi/com/sun/star/i18n/XTransliteration.idl b/offapi/com/sun/star/i18n/XTransliteration.idl index 364e8dc46b46..12246b8fbba2 100644 --- a/offapi/com/sun/star/i18n/XTransliteration.idl +++ b/offapi/com/sun/star/i18n/XTransliteration.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module i18n { <p> In order to select transliteration modules for different purposes, they are classified with attributes of - <type>TransliterationType</type>. <p/> + TransliterationType. <p/> <p> For Western languages there would be three transliteration modules available to compare two mixed case strings: upper to lower, @@ -101,7 +101,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface string getName(); /** Return the attribute(s) associated with this transliteration - object, as defined in <type>TransliterationType</type>. The + object, as defined in TransliterationType. The value is determined by the transliteration modules. For example, for UPPERCASE_LOWERCASE, a ONE_TO_ONE is returned, for IGNORE_CASE, IGNORE is returned. @@ -130,7 +130,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface available transliteration modules for the locale. There are some transliteration modules that are always available. The names of those modules are listed as enum - <type>TransliterationModules</type> names. For modules not + TransliterationModules names. For modules not listed there it is possible to load them directly by their implName. @@ -144,7 +144,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface /** Load a sequence of instances of transliteration modules. Output of one module is fed as input to the next module in the sequence. The object created by this call has - <type>TransliterationType</type> CASCADE and IGNORE types. + TransliterationType CASCADE and IGNORE types. @param aImplNameList Only IGNORE type modules can be specified. @@ -157,7 +157,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface @param nType A bitmask field of values defined in - <type>TransliterationType</type> + TransliterationType */ sequence<string> getAvailableModules( [in] ::com::sun::star::lang::Locale aLocale, @@ -165,7 +165,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface /** Transliterate a substring. This method can be called if the - object doesn't have <type>TransliterationType</type> IGNORE + object doesn't have TransliterationType IGNORE attribute. @param aStr @@ -198,7 +198,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface transliteration. <p> This method can be called if the object has - <type>TransliterationType</type> IGNORE attribute. </p> + TransliterationType IGNORE attribute. </p> <p> Returns the number of matched code points in any case, even if strings are not equal, for example: <br/> @@ -245,7 +245,7 @@ published interface XTransliteration: com::sun::star::uno::XInterface /** Transliterate one set of characters to another. <p> This method is intended for getting corresponding ranges and - can be called if the object has <type>TransliterationType</type> + can be called if the object has TransliterationType IGNORE attribute. </p> <p> For example: generic CASE_IGNORE transliterateRange( "a", "i" ) diff --git a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl index 2884d32d7b92..2e365def0c46 100644 --- a/offapi/com/sun/star/inspection/DefaultHelpProvider.idl +++ b/offapi/com/sun/star/inspection/DefaultHelpProvider.idl @@ -28,11 +28,11 @@ interface XObjectInspectorUI; /** implements a component which can default-fill the help section of an - <type>ObjectInspector</type>. + ObjectInspector. - <p>The component registers a <type>XPropertyControlObserver</type> at an - <type>XObjectInspectoryUI</type> interface. Whenever it then is notified - of a <type>XPropertyControl</type> getting the focus, it will try to deduce + <p>The component registers a XPropertyControlObserver at an + XObjectInspectoryUI interface. Whenever it then is notified + of a XPropertyControl getting the focus, it will try to deduce the extended help text of this control's window, and set this help text at the object inspector's help section.</p> */ diff --git a/offapi/com/sun/star/inspection/LineDescriptor.idl b/offapi/com/sun/star/inspection/LineDescriptor.idl index fc86f0acec47..fcfb133c774b 100644 --- a/offapi/com/sun/star/inspection/LineDescriptor.idl +++ b/offapi/com/sun/star/inspection/LineDescriptor.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module inspection { interface XPropertyControl; -/** describes the appearance of a line representing a single property in an <type>ObjectInspector</type>. +/** describes the appearance of a line representing a single property in an ObjectInspector. Such a line consists of <ul><li>a label with a human-readable name for the property</li> @@ -160,20 +160,20 @@ struct LineDescriptor can be used to visually represent this fact. For this, the dependent property's indent level would be one larger than the indent level of the other property.</p> - <p>Normally, <type>XPropertyHandler</type>s will set this to <code>0</code> when describing + <p>Normally, XPropertyHandlers will set this to <code>0</code> when describing the UI for a normal property. */ short IndentLevel; - /** describes the category into which the property should be sorted by the <type>ObjectInspector</type>. + /** describes the category into which the property should be sorted by the ObjectInspector. - <p>An <type>ObjectInspector</type> can visually group properties which semantically belong + <p>An ObjectInspector can visually group properties which semantically belong together (for instance using tab pages). The decision which properties actually belong together is made using this <member>Category</member> attribute.</p> - <p>For your implementation of <type>XPropertyHandler</type>, it's recommended that you document the programmatic + <p>For your implementation of XPropertyHandler, it's recommended that you document the programmatic names used for property categories. This way, your handler might be re-used in - different contexts, where only the <type>XObjectInspectorModel</type> needs to provide consistent + different contexts, where only the XObjectInspectorModel needs to provide consistent UI names for the categories.</p> @see XObjectInspectorModel::describeCategories diff --git a/offapi/com/sun/star/inspection/ObjectInspector.idl b/offapi/com/sun/star/inspection/ObjectInspector.idl index 8681b73aa3c2..bb013894c985 100644 --- a/offapi/com/sun/star/inspection/ObjectInspector.idl +++ b/offapi/com/sun/star/inspection/ObjectInspector.idl @@ -42,7 +42,7 @@ module com { module sun { module star { module inspection { <p>Even more, the inspector can optionally display a help section at the bottom of its window, which can display arbitrary (context-sensitive) help texts.</p> - <p>An <type>ObjectInspector</type> needs one or more property handlers which describe + <p>An ObjectInspector needs one or more property handlers which describe the facets of an inspected component - without such handlers, the inspector window will simply stay empty.</p> @@ -53,7 +53,7 @@ module com { module sun { module star { module inspection { <p>Since property handlers might have the need to raise UI, they will be created with a context value named "DialogParentWindow", which contains an XWindow which should be used as parent of any windows to raise.<br/> - If the <type scope="com::sun::star::uno">XComponentContext</type> in which the <type>ObjectInspector</type> + If the <type scope="com::sun::star::uno">XComponentContext</type> in which the ObjectInspector was created already contains such a value, it is not overwritten. Only if it doesn't, the inspector will add an own value - which contains the inspector's main window - to the context when creating handlers.</p> @@ -75,7 +75,7 @@ service ObjectInspector : XObjectInspector */ createDefault(); - /** creates an instance of the ObjectInspector, using a given <type>ObjectInspectorModel</type> + /** creates an instance of the ObjectInspector, using a given ObjectInspectorModel @throws ::com::sun::star::lang::IllegalArgumentException if <arg>Model</arg> is <NULL/>. diff --git a/offapi/com/sun/star/inspection/ObjectInspectorModel.idl b/offapi/com/sun/star/inspection/ObjectInspectorModel.idl index 21e717453d4e..4aaf87b0a5d9 100644 --- a/offapi/com/sun/star/inspection/ObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/ObjectInspectorModel.idl @@ -27,9 +27,9 @@ module com { module sun { module star { module inspection { /** describes a default implementation of an ObjectInspectorModel - <p>This service simplifies usage of an <type>ObjectInspector</type>.</p> + <p>This service simplifies usage of an ObjectInspector.</p> - <p>The <type>XObjectInspectorModel</type> implemented by this service will not provide any property + <p>The XObjectInspectorModel implemented by this service will not provide any property categories, nor apply any particular order to the properties provided by its handler(s).</p> @see ObjectInspector @@ -42,7 +42,7 @@ module com { module sun { module star { module inspection { service ObjectInspectorModel : XObjectInspectorModel { /** creates a default ObjectInspectorModel, whose one and only handler factory - creates a <type>GenericPropertyHandler</type>. + creates a GenericPropertyHandler. */ createDefault(); diff --git a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl index 05d782820dc2..54bf61b0c8c7 100644 --- a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl +++ b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl @@ -34,7 +34,7 @@ struct PropertyCategoryDescriptor <p>This programmatic name is used internally: <member>XPropertyHandler::describePropertyLine</member> sets a programmatic category name at <member>LineDescriptor::Category</member>, - and an object inspector uses this to find the proper <type>PropertyCategoryDescriptor</type>.</p> + and an object inspector uses this to find the proper PropertyCategoryDescriptor.</p> */ string ProgrammaticName; diff --git a/offapi/com/sun/star/inspection/PropertyControlType.idl b/offapi/com/sun/star/inspection/PropertyControlType.idl index 5691885fd9de..de6ac8bb3d50 100644 --- a/offapi/com/sun/star/inspection/PropertyControlType.idl +++ b/offapi/com/sun/star/inspection/PropertyControlType.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module inspection { /** describes pre-defined possible control types to be used to display and enter - property values within a <type>ObjectInspector</type>. + property values within a ObjectInspector. <p>The type of a control determines its visual appearance, its behavior, and - important for property handlers using a control - the expected type when reading and writing the @@ -42,7 +42,7 @@ constants PropertyControlType <p>Controls of type <member>ListBox</member> exchange their values as <code>string</code>.</p> - <p>Additionally, those controls support the <type>XStringListControl</type> interface.</p> + <p>Additionally, those controls support the XStringListControl interface.</p> */ const short ListBox = 1; @@ -52,7 +52,7 @@ constants PropertyControlType <p>Controls of type <member>ComboBox</member> exchange their values as <code>string</code>.</p> - <p>Additionally, those controls support the <type>XStringListControl</type> interface.</p> + <p>Additionally, those controls support the XStringListControl interface.</p> */ const short ComboBox = 2; @@ -86,11 +86,11 @@ constants PropertyControlType <p>Controls of type <member>ColorListBox</member> usually exchange their values as <type scope="com::sun::star::util">Color</type>.</p> - <p>Additionally, those controls support the <type>XStringListControl</type> interface. If you use + <p>Additionally, those controls support the XStringListControl interface. If you use this interface to add additional entries to the list box, which have no color associated with it, then you can also exchange values as <code>string</code>. That is, if you write a string into <member>XPropertyControl::Value</member>, and if this string has previously been added to the list - using the <type>XStringListControl</type> interface, this string is selected. Vice versa, if the user + using the XStringListControl interface, this string is selected. Vice versa, if the user selects one of those non-color strings in the list, then reading <member>XPropertyControl::Value</member> will retrieve you this string.</p> */ @@ -100,7 +100,7 @@ constants PropertyControlType <p>Controls of type <member>NumericField</member> exchange their values as <code>double</code>.</p> - <p>Additionally, those controls support the <type>XNumericControl</type> interface.</p> + <p>Additionally, those controls support the XNumericControl interface.</p> */ const short NumericField = 8; @@ -126,11 +126,11 @@ constants PropertyControlType <p>Controls of type <member>HyperlinkField</member> exchange their values as <code>string</code>.</p> - <p>Additionally, those controls support the <type>XHyperlinkControl</type> interface.</p> + <p>Additionally, those controls support the XHyperlinkControl interface.</p> */ const short HyperlinkField = 12; - /** denotes a non-standard property control, which is usually provided by an <type>XPropertyHandler</type> + /** denotes a non-standard property control, which is usually provided by an XPropertyHandler */ const short Unknown = 13; }; diff --git a/offapi/com/sun/star/inspection/XHyperlinkControl.idl b/offapi/com/sun/star/inspection/XHyperlinkControl.idl index b3e876c06a19..3e1114e1330e 100644 --- a/offapi/com/sun/star/inspection/XHyperlinkControl.idl +++ b/offapi/com/sun/star/inspection/XHyperlinkControl.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module inspection { -/** defines the interface for an <type>XPropertyControl</type> which displays its value +/** defines the interface for an XPropertyControl which displays its value in a hyperlink-like way <p>Hyperlink controls exchange their value (<member>XPropertyControl::Value</member>) as strings.</p> diff --git a/offapi/com/sun/star/inspection/XNumericControl.idl b/offapi/com/sun/star/inspection/XNumericControl.idl index 755c8d55822b..c2f64bb5e2fc 100644 --- a/offapi/com/sun/star/inspection/XNumericControl.idl +++ b/offapi/com/sun/star/inspection/XNumericControl.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module inspection { -/** defines the interface for an <type>XPropertyControl</type> which supports +/** defines the interface for an XPropertyControl which supports displaying and entering numerical values. @since OOo 2.0.3 diff --git a/offapi/com/sun/star/inspection/XObjectInspector.idl b/offapi/com/sun/star/inspection/XObjectInspector.idl index 7c1cf5fe5ee8..e005874b0a4d 100644 --- a/offapi/com/sun/star/inspection/XObjectInspector.idl +++ b/offapi/com/sun/star/inspection/XObjectInspector.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module inspection { interface XObjectInspectorModel; interface XObjectInspectorUI; -/** describes the main interface of an <type>ObjectInspector</type>. +/** describes the main interface of an ObjectInspector. @see ObjectInspector @@ -40,7 +40,7 @@ interface XObjectInspector /** allows to plug the inspector into an <type scope="com::sun::star::frame">XFrame</type> <p>The <member scope="com::sun::star::frame">XController::setModel</member> method - accepts only <type>XObjectInspectorModel</type>s, and will return <FALSE/> if the + accepts only XObjectInspectorModels, and will return <FALSE/> if the to-be-attached model is not <NULL/>, but does not support this interface.</p> <p>If you do not want to support a full-blown <type scope="com::sun::star::frame">XModel</type>, @@ -55,7 +55,7 @@ interface XObjectInspector /** allows to intercept functionality <p>This interface is inherited from the <type scope="com::sun::star::frame">Controller</type> - service, currently, there is no functionality to intercept at an <type>XObjectInspector</type>.</p> + service, currently, there is no functionality to intercept at an XObjectInspector.</p> */ interface com::sun::star::frame::XDispatchProvider; @@ -87,17 +87,17 @@ interface XObjectInspector /** inspects a new collection of one or more objects. - <p>If the sequence is empty, the UI of the <type>ObjectInspector</type> will be + <p>If the sequence is empty, the UI of the ObjectInspector will be cleared.</p> - <p>If the sequence contains more than one object, the <type>XObjectInspector</type> + <p>If the sequence contains more than one object, the XObjectInspector will create a complete set of property handlers (as indicated by <member>XObjectInspectorModel::HandlerFactories</member>) for <em>every</em> of the objects, and compose their output.</p> @throws com::sun::star::util::VetoException if the inspector cannot switch to another object set. This typically happens if - one of the active <type>XPropertyHandler</type>'s raised a non-modal user interface, + one of the active XPropertyHandler's raised a non-modal user interface, and vetoed suspension of this UI. @see XPropertyHandler::isComposable diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index 362c6056b9a7..d59c19326d51 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module inspection { interface XPropertyHandler; -/** describes the model of an <type>ObjectInspector</type> +/** describes the model of an ObjectInspector @see ObjectInspector @@ -35,10 +35,10 @@ interface XPropertyHandler; */ interface XObjectInspectorModel { - /** describes a set of factories for creating <type>XPropertyHandler</type>s + /** describes a set of factories for creating XPropertyHandlers <p>Every element of the sequence must contain information to create a - <type>XPropertyHandler</type> instance. Two ways are currently supported: + XPropertyHandler instance. Two ways are currently supported: <ul> <li>A service name:</br> If a sequence element contains a string, this string is interpreted @@ -50,7 +50,7 @@ interface XObjectInspectorModel is used to create a property handler.</li> </ul></p> - <p>This attribute is usually only evaluated by the <type>ObjectInspector</type> instance + <p>This attribute is usually only evaluated by the ObjectInspector instance which the model is currently bound to.</p> <p>The order of factories is important: If two property handlers declare themselves responsible @@ -69,13 +69,13 @@ interface XObjectInspectorModel attribute, which is filled in <member>XPropertyHandler::describePropertyLine</member> method of your property handler.<br/> Those names provided by the handlers are programmatic names. All other information - about categories is part of the <type>PropertyCategoryDescriptor</type>, and + about categories is part of the PropertyCategoryDescriptor, and <member>describeCategories</member> assembles information about all categories which all property handlers provided by the model use.</p> @return a sequence of category descriptors. Their relative ordering also describes - the relative ordering of the categories in the <type>ObjectInspector</type>'s + the relative ordering of the categories in the ObjectInspector's user interface.<br/> The sequence must not contain two entries with the same programmatic name.<br/> <br/> @@ -92,7 +92,7 @@ interface XObjectInspectorModel <p>In the user interface of an ObjectInspector, single properties are represented by single lines, and those lines are displayed successively. To determine an order of the property lines, the inspector model can associate an "order index" with each property. - The <type>ObjectInspector</type> will then sort the property lines in a way that they + The ObjectInspector will then sort the property lines in a way that they have the same relative ordering as the "order indexes" of their properties.</p> <p>Note that the concrete value the model returns for a given property does not @@ -101,7 +101,7 @@ interface XObjectInspectorModel of <code>Foo</code> should be greater than the order index of <code>Bar</code>. <p>If for two different properties the same order index is returned, the - <type>ObjectInspector</type> will assume the order in which those properties + ObjectInspector will assume the order in which those properties were provided by the respective property handler (<member>XPropertyHandler::getSupportedProperties</member>).<br/> If two such properties originate from different handlers, they will be ordered according @@ -129,10 +129,10 @@ interface XObjectInspectorModel /** denotes the minimum number of lines of text to be reserved for the help section. - <p>This property is ignored by the <type>ObjectInspector</type> if + <p>This property is ignored by the ObjectInspector if <member>HasHelpSection</member> is <FALSE/>.</p> - <p>The layout of the <type>ObjectInspector</type> is undefined if + <p>The layout of the ObjectInspector is undefined if <member>MinHelpTextLines</member> is larger than <member>MaxHelpTextLines</member>.</p> @@ -143,10 +143,10 @@ interface XObjectInspectorModel /** denotes the maximum number of lines of text to be reserved for the help section. - <p>This property is ignored by the <type>ObjectInspector</type> if + <p>This property is ignored by the ObjectInspector if <member>HasHelpSection</member> is <FALSE/>.</p> - <p>The layout of the <type>ObjectInspector</type> is undefined if + <p>The layout of the ObjectInspector is undefined if <member>MaxHelpTextLines</member> is smaller than <member>MinHelpTextLines</member>.</p> diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index e0bdc352ccae..f696fdb2d93e 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -31,12 +31,12 @@ interface XPropertyControlObserver; /** grants access to certain aspects of the user interface of an object inspector - <p>This interface is used as callback for <type>XPropertyHandler</type>s.</p> + <p>This interface is used as callback for XPropertyHandlers.</p> <p>As a consequence, methods operating on the UI for a property, and taking the name of this property, are tolerant against properties which do not exist. For instance, if a property handler tries to disable the UI for property <code>Foo</code>, but another handler has superseded this property, then - the <type>ObjectInspector</type> will not <em>have</em> any UI for it. In this case, the call to + the ObjectInspector will not <em>have</em> any UI for it. In this case, the call to <code>enablePropertyUI( "Foo" )</code> will simply be ignored.</p> @since OOo 2.0.3 @@ -45,7 +45,7 @@ interface XObjectInspectorUI { /** enables or disables all components belonging to the UI representation of a property - <p>This is usually used by an <type>XPropertyHandler</type> if it handles properties, + <p>This is usually used by an XPropertyHandler if it handles properties, where one does only make sense if another one has a certain value.</p> @param PropertyName @@ -65,7 +65,7 @@ interface XObjectInspectorUI the name of the property whose user interface elements are to be enabled or disabled @param Elements - a combination of <type>PropertyLineElement</type> flags specifying which elements are to be + a combination of PropertyLineElement flags specifying which elements are to be enabled or disabled.<br/> Note that if you don't set a particular bit here (say, <member>PropertyLineElement::PrimaryButton</member>), this does mean that this element's state is not affected by the call - it does @@ -82,8 +82,8 @@ interface XObjectInspectorUI /** completely rebuilds the UI for the given property. - <p>This method might be used by an <type>XPropertyHandler</type> if it wants to change the type - of control (see <type>PropertyControlType</type>) used to display a certain property.</p> + <p>This method might be used by an XPropertyHandler if it wants to change the type + of control (see PropertyControlType) used to display a certain property.</p> <p>The object inspector will then call describePropertyLine again, and update its UI accordingly.</p> @@ -123,7 +123,7 @@ interface XObjectInspectorUI the name of the property whose control should be retrieved @return - the <type>XPropertyControl</type> representing the given property, or <NULL/> + the XPropertyControl representing the given property, or <NULL/> if there is no such property control. */ XPropertyControl diff --git a/offapi/com/sun/star/inspection/XPropertyControl.idl b/offapi/com/sun/star/inspection/XPropertyControl.idl index 354f053d4254..8543bc8e9e76 100644 --- a/offapi/com/sun/star/inspection/XPropertyControl.idl +++ b/offapi/com/sun/star/inspection/XPropertyControl.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module inspection { interface XPropertyControlContext; -/** defines the interface for a single control in an <type>ObjectInspector</type> +/** defines the interface for a single control in an ObjectInspector @since OOo 2.0.3 */ interface XPropertyControl { - /** denotes the type of the control, as one of the <type>PropertyControlType</type> + /** denotes the type of the control, as one of the PropertyControlType constants */ [attribute, readonly] short ControlType; @@ -58,7 +58,7 @@ interface XPropertyControl */ [attribute, readonly] type ValueType; - /** specifies the context of the control within the <type>ObjectInspector</type>. + /** specifies the context of the control within the ObjectInspector. <p>The property control should actively notify its state changes to the context. In particular, changes in the focus and the value of the control must be notified. @@ -67,7 +67,7 @@ interface XPropertyControl /** determines whether the control content is currently modified - <p>An <type>XPropertyControl</type> internally manages a flag indicating whether + <p>An XPropertyControl internally manages a flag indicating whether its content is modified. This flag is reset to <FALSE/> every time our <member>ControlContext</member> is notified of our current value. Also, the control implementation must set this flag to <TRUE/> if and only if the user changed the @@ -90,7 +90,7 @@ interface XPropertyControl /** denotes the window which is the real UI representation of the property control. - <p>The <type>ObjectInspector</type> will automatically position and size this control + <p>The ObjectInspector will automatically position and size this control as needed, care for its Z-order, and so on.</p> <p>This Window must not be <NULL/>, else the whole control is not usable.</p> diff --git a/offapi/com/sun/star/inspection/XPropertyControlContext.idl b/offapi/com/sun/star/inspection/XPropertyControlContext.idl index 2fe3753f4f7a..878710c0b658 100644 --- a/offapi/com/sun/star/inspection/XPropertyControlContext.idl +++ b/offapi/com/sun/star/inspection/XPropertyControlContext.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module inspection { -/** specifies the interface of the context of an <type>XPropertyControl</type>. +/** specifies the interface of the context of an XPropertyControl. @see XPropertyControl::ControlContext @@ -32,7 +32,7 @@ module com { module sun { module star { module inspection { */ interface XPropertyControlContext : XPropertyControlObserver { - /** instructs the <type>XPropertyControlContext</type> to active the next control + /** instructs the XPropertyControlContext to active the next control @param CurrentControl denotes the control which initiated the request. diff --git a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl index 69aa638ea9a0..955dc6a42748 100644 --- a/offapi/com/sun/star/inspection/XPropertyControlFactory.idl +++ b/offapi/com/sun/star/inspection/XPropertyControlFactory.idl @@ -26,16 +26,16 @@ module com { module sun { module star { module inspection { interface XPropertyControl; -/** a factory for <type>XPropertyControl</type>s +/** a factory for XPropertyControls @since OOo 2.0.3 */ interface XPropertyControlFactory { - /** creates a <type>XPropertyControl</type> + /** creates a XPropertyControl - <p>A <type>XPropertyControlFactory</type> can create any of the control types denoted by - the <type>PropertyControlType</type> constants.</p> + <p>A XPropertyControlFactory can create any of the control types denoted by + the PropertyControlType constants.</p> @param ControlType the type of the requested control @@ -44,7 +44,7 @@ interface XPropertyControlFactory determines whether the newly created control should be readonly. <p>If this argument is <TRUE/>, this does not necessarily mean that the property cannot be - changed at all in the <type>ObjectInspector</type>. Instead, an <type>XPropertyHandler</type> + changed at all in the ObjectInspector. Instead, an XPropertyHandler can still decide that there is a dedicated UI for entering the property value, which is usually triggered by a <member>LineDescriptor::PrimaryButton</member>.</p> @@ -55,7 +55,7 @@ interface XPropertyControlFactory a control of the given type. @throws com::sun::star::lang::IllegalArgumentException - if the given <arg>ControlType</arg> is not a value <type>PropertyControlType</type> + if the given <arg>ControlType</arg> is not a value PropertyControlType */ XPropertyControl createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/inspection/XPropertyControlObserver.idl b/offapi/com/sun/star/inspection/XPropertyControlObserver.idl index 3e99e74c5d19..d9805dbd0638 100644 --- a/offapi/com/sun/star/inspection/XPropertyControlObserver.idl +++ b/offapi/com/sun/star/inspection/XPropertyControlObserver.idl @@ -29,13 +29,13 @@ interface XPropertyControl; /** specifies an interface for components to observer certain aspects - of an <type>XPropertyControl</type>. + of an XPropertyControl. @since OOo 2.2 */ interface XPropertyControlObserver { - /** notifies the observer that a certain <type>XPropertyControl</type>'s UI + /** notifies the observer that a certain XPropertyControl's UI representation gained the focus. @param Control @@ -43,7 +43,7 @@ interface XPropertyControlObserver */ void focusGained( [in] XPropertyControl Control ); - /** notifies the observer that a certain <type>XPropertyControl</type>'s value + /** notifies the observer that a certain XPropertyControl's value changed. @param Control diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl index 40f721068641..febaf2419e02 100644 --- a/offapi/com/sun/star/inspection/XPropertyHandler.idl +++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl @@ -36,8 +36,8 @@ interface XPropertyControlFactory; /** is the basic interface for object inspection. - <p>The <type>ObjectInspector</type> itself does not know anything about the object - it is inspecting, all information is obtained via <type>XPropertyHandler</type>s. + <p>The ObjectInspector itself does not know anything about the object + it is inspecting, all information is obtained via XPropertyHandlers. Also, property handlers are responsible for describing the user interface which should be used to interact with the user, with respect to a given aspect of the inspected component.</p> @@ -106,7 +106,7 @@ interface XPropertyHandler the name of the property whose user interface is to be described implementation @param ControlFactory - a factory for creating <type>XPropertyControl</type> instances. Must not be <NULL/>. + a factory for creating XPropertyControl instances. Must not be <NULL/>. @return the descriptor of the property line. @throws com::sun::star::beans::UnknownPropertyException @@ -136,7 +136,7 @@ interface XPropertyHandler @param PropertyName The name of the conversion's target property. @param ControlValue - The to-be-converted control value. This value has been obtained from an <type>XPropertyControl</type>, + The to-be-converted control value. This value has been obtained from an XPropertyControl, using its <member>Value</member> attribute. @throws com::sun::star::beans::UnknownPropertyException @@ -163,7 +163,7 @@ interface XPropertyHandler <p>This method converts a property value, which has previously been obtained using <member>getPropertyValue</member>, into a control-compatible value, which can be used - with <type>XPropertyControl</type>'s <member>XPropertyControl::Value</member> attribute.</p> + with XPropertyControl's <member>XPropertyControl::Value</member> attribute.</p> <p>A usual application of this method are list boxes: There is a generic list box implementation, which is able to display a simple list of strings. Usually, every string represents one @@ -181,9 +181,9 @@ interface XPropertyHandler The target type of the conversion. This type is determined by the control which is used to display the property, which in turn is determined by the handler itself in <member>describePropertyLine</member>.<br/> - Speaking strictly, this is passed for convenience only, since every <type>XPropertyHandler</type> + Speaking strictly, this is passed for convenience only, since every XPropertyHandler implementation should know exactly which type to expect, since it implicitly determined this type - in <member>describePropertyLine</member> by creating an appropriate <type>XPropertyControl</type>. + in <member>describePropertyLine</member> by creating an appropriate XPropertyControl. @throws com::sun::star::beans::UnknownPropertyException if the given property is not supported by the property handler @@ -203,7 +203,7 @@ interface XPropertyHandler /** registers a listener for notification about property value changes - <p>An <type>XPropertyHandler</type> implementation might decide to ignore this call. + <p>An XPropertyHandler implementation might decide to ignore this call. However, in this case property value changes made by third party components are not reflected in the object inspector.</p> @@ -253,7 +253,7 @@ interface XPropertyHandler <p>In such a case, simply return those properties here.</p> - <p>There is a precedence in the property handlers used by an <type>ObjectInspector</type>, + <p>There is a precedence in the property handlers used by an ObjectInspector, which also is important for the superseded properties. This precedence is implied by the precedence of factories to create the property handlers, as denoted in the <member>XObjectInspectorModel::HandlerFactories</member> attribute.</p> @@ -261,7 +261,7 @@ interface XPropertyHandler <p>With this in mind, property handlers can only supersede properties which are supported by a handler preceding them, but not properties of handlers succeeding them.</p> - <p>For instance, imaging an <type>XObjectInspectorModel</type> which provides three + <p>For instance, imaging an XObjectInspectorModel which provides three factories, for handler <code>A</code>, <code>B</code>, and <code>C</code> - in this order. Now if <code>A</code> supports the property <code>Foo</code>, <code>C</code> supports <code>Bar</code>, and <code>B</code> supersedes both <code>Foo</code> and <code>Bar</code>, @@ -316,11 +316,11 @@ interface XPropertyHandler Usually, this will be a modal dialog, but it can also be a non-modal user interface component.</p> <p>Availability of this feature is indicated by the <member>LineDescriptor::HasPrimaryButton</member> - and <member>LineDescriptor::HasSecondaryButton</member> members of a <type>LineDescriptor</type>, - which the <type>XPropertyHandler</type> fills in its <member>describePropertyLine</member> method.</p> + and <member>LineDescriptor::HasSecondaryButton</member> members of a LineDescriptor, + which the XPropertyHandler fills in its <member>describePropertyLine</member> method.</p> <p>When this method is called, the property handler should raise the UI needed to enter the - property value, and return the result of this (see <type>InteractiveSelectionResult</type>).</p> + property value, and return the result of this (see InteractiveSelectionResult).</p> <p>It is recommended that property handlers do not directly set the property value which has been obtained from the user, but store it in the output-parameter Data, and return @@ -412,7 +412,7 @@ interface XPropertyHandler /** suspends the handler - <p>A <type>XPropertyHandler</type> is used by a <type>XObjectInspector</type> instance, + <p>A XPropertyHandler is used by a XObjectInspector instance, which implements the XController interface. By definition, a XObjectInspector always forwards all suspend requests (<member scope="com::sun::star::frame">XController::suspend</member>) to all it's handlers.</p> @@ -421,7 +421,7 @@ interface XPropertyHandler for property value input. Such a component might have been opened during <member>onInteractivePropertySelection</member>. If a property handler receives a <member>suspend</member> call, it should forward the suspension request to the UI - component, and veto suspension of the <type>XObjectInspector</type> as appropriate.</p> + component, and veto suspension of the XObjectInspector as appropriate.</p> <p>If suspension is not to be vetoed, then all non-modal UI components opened by the handler should have been closed when it returns from the <member>suspend</member> call.</p> diff --git a/offapi/com/sun/star/inspection/XStringListControl.idl b/offapi/com/sun/star/inspection/XStringListControl.idl index b6b21d2e9375..caf38d601a6a 100644 --- a/offapi/com/sun/star/inspection/XStringListControl.idl +++ b/offapi/com/sun/star/inspection/XStringListControl.idl @@ -24,12 +24,12 @@ module com { module sun { module star { module inspection { -/** defines the interface for an <type>XPropertyControl</type> which, additionally +/** defines the interface for an XPropertyControl which, additionally to the basic behavior, supports a list of strings interpreted as possible property values. <p>A control which would canonically implement this interface is a list box control: - The string list defined by <type>XStringListControl</type> would in the control be + The string list defined by XStringListControl would in the control be represented as drop-down list containing all the strings.</p> @since OOo 2.0.3 diff --git a/offapi/com/sun/star/linguistic2/ConversionDictionaryType.idl b/offapi/com/sun/star/linguistic2/ConversionDictionaryType.idl index cc73f0067038..a4f1c81b4505 100644 --- a/offapi/com/sun/star/linguistic2/ConversionDictionaryType.idl +++ b/offapi/com/sun/star/linguistic2/ConversionDictionaryType.idl @@ -22,7 +22,7 @@ module com { module sun { module star { module linguistic2 { -/** specifies the conversion dictionary type to be used with <type>XConversionDictionary</type>. +/** specifies the conversion dictionary type to be used with XConversionDictionary. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/linguistic2/ConversionDirection.idl b/offapi/com/sun/star/linguistic2/ConversionDirection.idl index d48546b24b01..68cdf9a4bdd2 100644 --- a/offapi/com/sun/star/linguistic2/ConversionDirection.idl +++ b/offapi/com/sun/star/linguistic2/ConversionDirection.idl @@ -22,7 +22,7 @@ module com { module sun { module star { module linguistic2 { -/** Conversion direction to be used with <type>XConversionDictionary</type> +/** Conversion direction to be used with XConversionDictionary when looking for conversions. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/logging/FileHandler.idl b/offapi/com/sun/star/logging/FileHandler.idl index 5a327bd3bfba..03e305a8e1f4 100644 --- a/offapi/com/sun/star/logging/FileHandler.idl +++ b/offapi/com/sun/star/logging/FileHandler.idl @@ -32,7 +32,7 @@ interface XLogHandler; /** specifies a component implementing a log handler whose output channel is a file. - <p>The handler will use the <code>Encoding</code> attribute of <type>XLogHandler</type> + <p>The handler will use the <code>Encoding</code> attribute of XLogHandler to determine how to encode strings before actually writing them to the output file.</p> diff --git a/offapi/com/sun/star/logging/LogLevel.idl b/offapi/com/sun/star/logging/LogLevel.idl index b6702aec65fb..dc3beaaa0009 100644 --- a/offapi/com/sun/star/logging/LogLevel.idl +++ b/offapi/com/sun/star/logging/LogLevel.idl @@ -34,7 +34,7 @@ constants LogLevel { /** specifies that no messages are to be logged at all - <p>This level can be set at an <type>XLogger</type> to completely prevent + <p>This level can be set at an XLogger to completely prevent logging. You will usually not use it with a concrete log event.</p> */ const long OFF = 0x7FFFFFFF; @@ -62,7 +62,7 @@ constants LogLevel /** specifies that all messages should be logged - <p>This level can be set at an <type>XLogger</type> to enable logging + <p>This level can be set at an XLogger to enable logging of absolutely all events. You will usually not use it with a concrete log event.</p> */ const long ALL = -0x80000000; diff --git a/offapi/com/sun/star/logging/LogRecord.idl b/offapi/com/sun/star/logging/LogRecord.idl index 4fc1046bb104..d0ae88e1b00e 100644 --- a/offapi/com/sun/star/logging/LogRecord.idl +++ b/offapi/com/sun/star/logging/LogRecord.idl @@ -40,14 +40,14 @@ struct LogRecord /** specifies the name of the class, in which the record was logged. This name might be empty, in case the caller to one of the various - <code>log</code> methods of <type>XLogger</type> did not specify it. + <code>log</code> methods of XLogger did not specify it. */ string SourceClassName; /** specifies the name of the method, in which the record was logged. This name might be empty, in case the caller to one of the various - <code>log</code> methods of <type>XLogger</type> did not specify it. + <code>log</code> methods of XLogger did not specify it. */ string SourceMethodName; @@ -60,7 +60,7 @@ struct LogRecord /** specifies the number of the log event. - Subsequent events get assigned increasing sequence numbers by the <type>XLogger</type> + Subsequent events get assigned increasing sequence numbers by the XLogger at which they're logged. */ hyper SequenceNumber; diff --git a/offapi/com/sun/star/logging/LoggerPool.idl b/offapi/com/sun/star/logging/LoggerPool.idl index de212662ec66..10f76e120adb 100644 --- a/offapi/com/sun/star/logging/LoggerPool.idl +++ b/offapi/com/sun/star/logging/LoggerPool.idl @@ -26,12 +26,12 @@ module com { module sun { module star { module logging { -/** the global pool of named <type>XLogger</type> instances +/** the global pool of named XLogger instances <p>The one and only <code>LoggerPool</code> instance is available at a component context as value with the key <code>/singletons/com.sun.star.logging.LoggerPool</code>.</p> */ -/** the global pool of named <type>XLogger</type> instances +/** the global pool of named XLogger instances <p>The one and only <code>LoggerPool</code> instance is available at a component context as value with the key <code>/singletons/com.sun.star.logging.LoggerPool</code>.</p> diff --git a/offapi/com/sun/star/logging/XConsoleHandler.idl b/offapi/com/sun/star/logging/XConsoleHandler.idl index af5c1afd6a9e..39863e202244 100644 --- a/offapi/com/sun/star/logging/XConsoleHandler.idl +++ b/offapi/com/sun/star/logging/XConsoleHandler.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module logging { */ interface XConsoleHandler : XLogHandler { - /** denotes the <type>LogLevel</type> threshold used to determine to which + /** denotes the LogLevel threshold used to determine to which console the events should be logged. <p>Events with a level greater or equal to <code>Threshold</code> will be diff --git a/offapi/com/sun/star/logging/XLogFormatter.idl b/offapi/com/sun/star/logging/XLogFormatter.idl index 255eca2ac0a2..1bc474caadb5 100644 --- a/offapi/com/sun/star/logging/XLogFormatter.idl +++ b/offapi/com/sun/star/logging/XLogFormatter.idl @@ -37,9 +37,9 @@ interface XLogFormatter { /** returns the header string for the log - <p>This can be used to generate a header string, which by the <type>XLogHandler</type> + <p>This can be used to generate a header string, which by the XLogHandler is emitted to its output channel before actually logging any concrete - <type>LogRecord</type>.</p> + LogRecord.</p> <p>For instance, a formatter might produce table-like plain text output, and could return a table-head string (potentially including line breaks) @@ -49,7 +49,7 @@ interface XLogFormatter /** formats the given log record for output - <p>A <type>XLogHandler</type> will call this method to format a given + <p>A XLogHandler will call this method to format a given log record. The resulting string will be emitted to the handler's output channel, without processing it any further (except possibly encoding it with the handler's <code>Encoding</code>).</p> @@ -58,7 +58,7 @@ interface XLogFormatter /** returns the footer string for the log - <p>This can be used to generate a footer string, which by the <type>XLogHandler</type> + <p>This can be used to generate a footer string, which by the XLogHandler is emitted to its output channel before it is finally being closed.</p> */ string getTail(); diff --git a/offapi/com/sun/star/logging/XLogHandler.idl b/offapi/com/sun/star/logging/XLogHandler.idl index 28987f130bc2..2a93d1bca923 100644 --- a/offapi/com/sun/star/logging/XLogHandler.idl +++ b/offapi/com/sun/star/logging/XLogHandler.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module logging { -/** provides possibilities to send <type>LogRecord</type>s to an arbitrary output +/** provides possibilities to send LogRecords to an arbitrary output channel. @see XLogger @@ -60,7 +60,7 @@ interface XLogHandler /** specifies the log level of this handler <p>Different handlers can have different log levels, which again might be - different from the log level of the <type>XLogger</type> for which the handlers + different from the log level of the XLogger for which the handlers are used.</p> */ [attribute] long Level; diff --git a/offapi/com/sun/star/logging/XLogger.idl b/offapi/com/sun/star/logging/XLogger.idl index d32e66b3e4ab..048a60dd6c62 100644 --- a/offapi/com/sun/star/logging/XLogger.idl +++ b/offapi/com/sun/star/logging/XLogger.idl @@ -55,7 +55,7 @@ interface XLogger /** adds the given handler to the list of handlers. - <p>When an event is logged, the logger will create a <type>LogRecord</type> + <p>When an event is logged, the logger will create a LogRecord for this event, and pass this record to all registered handlers. Single handlers might or might not log those records at their own discretion, and depending on additional restrictions such as filters specified at handler level.</p> diff --git a/offapi/com/sun/star/logging/XLoggerPool.idl b/offapi/com/sun/star/logging/XLoggerPool.idl index 8e05a5186659..fa995847d885 100644 --- a/offapi/com/sun/star/logging/XLoggerPool.idl +++ b/offapi/com/sun/star/logging/XLoggerPool.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module logging { interface XLogger; -/** implements a pool for named <type>XLogger</type> instances +/** implements a pool for named XLogger instances @since OOo 2.3 */ diff --git a/offapi/com/sun/star/mail/MailAttachment.idl b/offapi/com/sun/star/mail/MailAttachment.idl index 8a81133c698f..e6b696727a09 100644 --- a/offapi/com/sun/star/mail/MailAttachment.idl +++ b/offapi/com/sun/star/mail/MailAttachment.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module mail { /** - A <type>MailAttachment</type> specifies a mail message attachment. + A MailAttachment specifies a mail message attachment. @see ::com::sun::star::mail::XMailMessage diff --git a/offapi/com/sun/star/mail/NoMailServiceProviderException.idl b/offapi/com/sun/star/mail/NoMailServiceProviderException.idl index 85bef2ccbc3f..3a3827b9fd3f 100644 --- a/offapi/com/sun/star/mail/NoMailServiceProviderException.idl +++ b/offapi/com/sun/star/mail/NoMailServiceProviderException.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module mail { /** - A <type>NoMailServiceProviderException</type> will be thrown if an + A NoMailServiceProviderException will be thrown if an appropriate provider for requested mail service could not be found or could not be created. diff --git a/offapi/com/sun/star/mail/NoMailTransportProviderException.idl b/offapi/com/sun/star/mail/NoMailTransportProviderException.idl index 53c931164cb2..6a45dd177410 100644 --- a/offapi/com/sun/star/mail/NoMailTransportProviderException.idl +++ b/offapi/com/sun/star/mail/NoMailTransportProviderException.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module mail { /** - A <type>NoMailTransportProviderException</type> will be thrown if an + A NoMailTransportProviderException will be thrown if an appropriate provider for sending mail messages could not be found or could not be created. diff --git a/offapi/com/sun/star/mail/XMailMessage.idl b/offapi/com/sun/star/mail/XMailMessage.idl index 9d26b3d618df..9dee0393b35f 100644 --- a/offapi/com/sun/star/mail/XMailMessage.idl +++ b/offapi/com/sun/star/mail/XMailMessage.idl @@ -129,7 +129,7 @@ interface XMailMessage: ::com::sun::star::uno::XInterface { void addAttachment([in] MailAttachment aMailAttachment); /** - Return a sequence of <type>MailAttachment</type>'s that will + Return a sequence of MailAttachment's that will be attached to this mail message. @see com::sun::star::mail::MailAttachment diff --git a/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl b/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl index 65ecbb2d58dc..10dbc777eab1 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module mozilla { -/** This interface is an extension for <type>XPluginInstancePeer</type> interface. - An object can support this interface in addition to <type>XPluginInstancePeer</type> interface. +/** This interface is an extension for XPluginInstancePeer interface. + An object can support this interface in addition to XPluginInstancePeer interface. */ published interface XPluginInstanceSyncPeer : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/packages/Package.idl b/offapi/com/sun/star/packages/Package.idl index 82ddbb3ef2c7..933a8d0bbf1a 100644 --- a/offapi/com/sun/star/packages/Package.idl +++ b/offapi/com/sun/star/packages/Package.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module packages { -/** The <type>Package</type> is a service that provides access to a set of +/** The Package is a service that provides access to a set of files and folders contained within a Package. One instance of the Package service exists for each Package file to be manipulated. diff --git a/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl b/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl index 934a6a04daff..e4c0de8346bf 100644 --- a/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl +++ b/offapi/com/sun/star/packages/XDataSinkEncrSupport.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module packages { -/** Allows to get access to the stream of a <type>PackageStream</type>. +/** Allows to get access to the stream of a PackageStream. */ interface XDataSinkEncrSupport: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/plugin/PluginDescription.idl b/offapi/com/sun/star/plugin/PluginDescription.idl index fcf0758f79c1..b40467235231 100644 --- a/offapi/com/sun/star/plugin/PluginDescription.idl +++ b/offapi/com/sun/star/plugin/PluginDescription.idl @@ -25,7 +25,7 @@ /** Describes a specific plugin. If there are multiple mimetypes and/or - extensions, multiple <type>PluginDescription</type>s will be created. + extensions, multiple PluginDescriptions will be created. */ published struct PluginDescription { diff --git a/offapi/com/sun/star/plugin/XPluginContext.idl b/offapi/com/sun/star/plugin/XPluginContext.idl index a1a7d90a0902..1fd6103e7cd9 100644 --- a/offapi/com/sun/star/plugin/XPluginContext.idl +++ b/offapi/com/sun/star/plugin/XPluginContext.idl @@ -37,7 +37,7 @@ /** Interface receiving calls from a plugin library. - A default context can be created using the <type>PluginManager</type>. + A default context can be created using the PluginManager. */ published interface XPluginContext: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/presentation/CustomPresentationAccess.idl b/offapi/com/sun/star/presentation/CustomPresentationAccess.idl index d6c49c794965..053a78647203 100644 --- a/offapi/com/sun/star/presentation/CustomPresentationAccess.idl +++ b/offapi/com/sun/star/presentation/CustomPresentationAccess.idl @@ -34,14 +34,14 @@ published service CustomPresentationAccess /** This is the container of the custom presentations. <p>Each instance in this container implements the service - <type>CustomPresentation</type>. + CustomPresentation. <p>The methods insertByName and replaceByName both replace - the name of the given <type>CustomPresentation</type> + the name of the given CustomPresentation */ interface com::sun::star::container::XNameContainer; /** This interface lets you create empty instances of - the service <type>CustomPresentation</type>. + the service CustomPresentation. <p>These services are needed for the <code>insertByName</code> and <code>replaceByName</code> methods of this service diff --git a/offapi/com/sun/star/presentation/DrawPage.idl b/offapi/com/sun/star/presentation/DrawPage.idl index 2abde0f3906d..6ee4f665174f 100644 --- a/offapi/com/sun/star/presentation/DrawPage.idl +++ b/offapi/com/sun/star/presentation/DrawPage.idl @@ -33,7 +33,7 @@ /** This is the service provided by a <type scope="com::sun::star::drawing">DrawPage</type> inside a - <type>PresentationDocument</type>. + PresentationDocument. @see PresentationDocument */ diff --git a/offapi/com/sun/star/presentation/Presentation.idl b/offapi/com/sun/star/presentation/Presentation.idl index 1cc5930aae8b..7bfba46e6367 100644 --- a/offapi/com/sun/star/presentation/Presentation.idl +++ b/offapi/com/sun/star/presentation/Presentation.idl @@ -29,8 +29,8 @@ /** This service is a presentation that is available from a - <type>PresentationDocument</type> via the - <type>XPresentationSupplier</type> interface. + PresentationDocument via the + XPresentationSupplier interface. */ published service Presentation { diff --git a/offapi/com/sun/star/presentation/Presentation2.idl b/offapi/com/sun/star/presentation/Presentation2.idl index 1feb0c7533e3..406f042450f5 100644 --- a/offapi/com/sun/star/presentation/Presentation2.idl +++ b/offapi/com/sun/star/presentation/Presentation2.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module presentation { -/** enhances the Presentation service to give access to a <type>XPresentation2</type> interface. +/** enhances the Presentation service to give access to a XPresentation2 interface. @since OOo 3.0 */ @@ -35,7 +35,7 @@ service Presentation2 service Presentation; /** enhances the XPresentation interface to give access to - a <type>XSlideShowController</type> and + a XSlideShowController and to start a presentation with arguments. */ interface com::sun::star::presentation::XPresentation2; diff --git a/offapi/com/sun/star/presentation/PresentationDocument.idl b/offapi/com/sun/star/presentation/PresentationDocument.idl index 97640aae6f3e..77be179a427e 100644 --- a/offapi/com/sun/star/presentation/PresentationDocument.idl +++ b/offapi/com/sun/star/presentation/PresentationDocument.idl @@ -40,20 +40,20 @@ service PresentationDocument only in a presentation application <ul> - <li><type>TitleTextShape</type></li> - <li><type>OutlinerShape</type></li> - <li><type>SubtitleShape</type></li> - <li><type>GraphicObjectShape</type></li> - <li><type>PageShape</type></li> - <li><type>OLE2Shape</type></li> - <li><type>ChartShape</type></li> - <li><type>NotesShape</type></li> - <li><type>HandoutShape</type></li> - <li><type>HeaderShape</type></li> - <li><type>FooterShape</type></li> - <li><type>SlideNumberShape</type></li> - <li><type>DateTimeShape</type></li> - <li><type>DocumentSettings</type></li> + <li>TitleTextShape</li> + <li>OutlinerShape</li> + <li>SubtitleShape</li> + <li>GraphicObjectShape</li> + <li>PageShape</li> + <li>OLE2Shape</li> + <li>ChartShape</li> + <li>NotesShape</li> + <li>HandoutShape</li> + <li>HeaderShape</li> + <li>FooterShape</li> + <li>SlideNumberShape</li> + <li>DateTimeShape</li> + <li>DocumentSettings</li> <li><type scope="textfield">Header</type></li> <li><type scope="textfield">Footer</type></li> <li><type scope="textfield">DateTime</type></li> diff --git a/offapi/com/sun/star/presentation/Shape.idl b/offapi/com/sun/star/presentation/Shape.idl index 4629be15971a..69cc0fa6ba79 100644 --- a/offapi/com/sun/star/presentation/Shape.idl +++ b/offapi/com/sun/star/presentation/Shape.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module presentation { -/** this service is supported from all shapes inside a <type>PresentationDocument</type>. +/** this service is supported from all shapes inside a PresentationDocument. This usually enhances objects of type <type scope="com::sun::star::drawing">Shape</type> with diff --git a/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl b/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl index 8dfe2cf82ffb..aca8f8a33dc2 100644 --- a/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl +++ b/offapi/com/sun/star/presentation/XCustomPresentationSupplier.idl @@ -38,7 +38,7 @@ published interface XCustomPresentationSupplier: com::sun::star::uno::XInterface { /** @returns - the <type>CustomPresentation</type>. + the CustomPresentation. */ com::sun::star::container::XNameContainer getCustomPresentations(); diff --git a/offapi/com/sun/star/presentation/XHandoutMasterSupplier.idl b/offapi/com/sun/star/presentation/XHandoutMasterSupplier.idl index 2dece8cff3e6..bc3c2cb46ac2 100644 --- a/offapi/com/sun/star/presentation/XHandoutMasterSupplier.idl +++ b/offapi/com/sun/star/presentation/XHandoutMasterSupplier.idl @@ -32,7 +32,7 @@ */ published interface XHandoutMasterSupplier: com::sun::star::uno::XInterface { - /** returns the <type>DrawPage</type>. + /** returns the DrawPage. */ com::sun::star::drawing::XDrawPage getHandoutMasterPage(); }; diff --git a/offapi/com/sun/star/presentation/XPresentation.idl b/offapi/com/sun/star/presentation/XPresentation.idl index 21f851d07967..c673fe278d52 100644 --- a/offapi/com/sun/star/presentation/XPresentation.idl +++ b/offapi/com/sun/star/presentation/XPresentation.idl @@ -27,7 +27,7 @@ /** With this interface you can control any object that implements - a <type>Presentation</type>. + a Presentation. */ published interface XPresentation: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/presentation/XPresentation2.idl b/offapi/com/sun/star/presentation/XPresentation2.idl index ab9acda0db65..f6712362ff6c 100644 --- a/offapi/com/sun/star/presentation/XPresentation2.idl +++ b/offapi/com/sun/star/presentation/XPresentation2.idl @@ -30,7 +30,7 @@ /** enhances the XPresentation interface to give access to - a <type>XSlideShowController</type> and + a XSlideShowController and to start a presentation with arguments. @since OOo 3.0 diff --git a/offapi/com/sun/star/presentation/XSlideShow.idl b/offapi/com/sun/star/presentation/XSlideShow.idl index 0cc95dbd7a47..da8a12c73e4f 100644 --- a/offapi/com/sun/star/presentation/XSlideShow.idl +++ b/offapi/com/sun/star/presentation/XSlideShow.idl @@ -41,7 +41,7 @@ module com { module sun { module star { module presentation { be displayed simultaneously on multiple targets.<p> Note: To control a running slide show inside a presentation, please - use <type>XPresentation2</type> and <type>XSlideShowController</type>. + use XPresentation2 and XSlideShowController. @since OOo 3.0 */ diff --git a/offapi/com/sun/star/presentation/XSlideShowController.idl b/offapi/com/sun/star/presentation/XSlideShowController.idl index 0dfc70c4a9ef..c0c557866a01 100644 --- a/offapi/com/sun/star/presentation/XSlideShowController.idl +++ b/offapi/com/sun/star/presentation/XSlideShowController.idl @@ -39,7 +39,7 @@ interface XSlideShowController /** returns true if the slide show is still running. If this returns false, this component is already disposed. You can start a new slide show and get a new instance - of <type>XSlideShowController</type> from <type>XPresentation2</type> + of XSlideShowController from XPresentation2 */ boolean isRunning(); @@ -239,10 +239,10 @@ interface XSlideShowController [attribute] long PenColor; - /** returns the actual <type>XSlideShow</type> instance that runs the + /** returns the actual XSlideShow instance that runs the slide show. <br>Normally all navigation should be done using this controller and - not the <type>XSlideShow</type> itself. */ + not the XSlideShow itself. */ XSlideShow getSlideShow(); }; diff --git a/offapi/com/sun/star/rdf/URI.idl b/offapi/com/sun/star/rdf/URI.idl index 0ebf47b21f41..c39fa47a4e38 100644 --- a/offapi/com/sun/star/rdf/URI.idl +++ b/offapi/com/sun/star/rdf/URI.idl @@ -65,10 +65,10 @@ service URI : XURI /** creates an URI RDF node for a well-known URI. @param Id - the URI, represented as a constant from <type>URIs</type>. + the URI, represented as a constant from URIs. @throws com::sun::star::lang::IllegalArgumentException - if the argument is not a valid constant from <type>URIs</type> + if the argument is not a valid constant from URIs @see URIs */ diff --git a/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl b/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl index 4d1589b47225..6322300b7027 100644 --- a/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl +++ b/offapi/com/sun/star/rdf/XDocumentMetadataAccess.idl @@ -50,7 +50,7 @@ module com { module sun { module star { module rdf { </p> <p> - Note that this interface inherits from <type>XURI</type>: the + Note that this interface inherits from XURI: the base URI of the document is the string value of the RDF node. This is so that you can easily make RDF statements about the document. </p> @@ -342,7 +342,7 @@ interface XDocumentMetadataAccess error reporting.</p> @param Medium - the <type>com::sun::star::document::MediaDescriptor</type> + the com::sun::star::document::MediaDescriptor representing the source @throws com::sun::star::lang::IllegalArgumentException @@ -361,7 +361,7 @@ interface XDocumentMetadataAccess /** stores document metadata to a medium. @param Medium - the <type>com::sun::star::document::MediaDescriptor</type> + the com::sun::star::document::MediaDescriptor representing the target @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/rdf/XDocumentRepository.idl b/offapi/com/sun/star/rdf/XDocumentRepository.idl index f056d38f2b01..c5c001faf60c 100644 --- a/offapi/com/sun/star/rdf/XDocumentRepository.idl +++ b/offapi/com/sun/star/rdf/XDocumentRepository.idl @@ -28,10 +28,10 @@ module com { module sun { module star { module rdf { -/** extends <type>XRepository</type> with document-specific functionality. +/** extends XRepository with document-specific functionality. <p> - This subclass of <type>XRepository</type> provides some methods which + This subclass of XRepository provides some methods which only make sense for repositories that are attached to a document. For example, the methods allow for manipulating in-content metadata, which is stored as RDFa. @@ -79,7 +79,7 @@ interface XDocumentRepository : XRepository Also, they have rather unusual semantics; just using <member>XNamedGraph::addStatement</member> would be ambiguous: - if the object is a <type>XMetadatable</type>, do we insert + if the object is a XMetadatable, do we insert the object itself (URI) or its literal content (RDFa)? </p> @@ -197,7 +197,7 @@ interface XDocumentRepository : XRepository @returns an iterator over all RDFa statements in the repository that match the parameters, represented as an - enumeration of <type>Statement</type> + enumeration of Statement @throws RepositoryException if an error occurs when accessing the repository. diff --git a/offapi/com/sun/star/rdf/XMetadatable.idl b/offapi/com/sun/star/rdf/XMetadatable.idl index 84c359e692a6..fc80bef99aa8 100644 --- a/offapi/com/sun/star/rdf/XMetadatable.idl +++ b/offapi/com/sun/star/rdf/XMetadatable.idl @@ -33,14 +33,14 @@ module com { module sun { module star { module rdf { <p> To make using ODF elements as part of RDF statements more convenient, - this interface inherits from <type>XURI</type>. + this interface inherits from XURI. The URI is constructed by concatenating the URI of the document, the stream name, a fragment separator, and the XML ID. </p> <p> - Note that using the <type>XURI</type> interface on an instance of - <type>XMetadatable</type> may have the side effect of creating a metadata + Note that using the XURI interface on an instance of + XMetadatable may have the side effect of creating a metadata reference for the instance. </p> diff --git a/offapi/com/sun/star/rdf/XNamedGraph.idl b/offapi/com/sun/star/rdf/XNamedGraph.idl index e604e2354996..b579b5a2548c 100644 --- a/offapi/com/sun/star/rdf/XNamedGraph.idl +++ b/offapi/com/sun/star/rdf/XNamedGraph.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module rdf { /** represents an RDF named graph that is stored in an RDF Repository. <p> - Note that this interface inherits from <type>XResource</type>: the + Note that this interface inherits from XResource: the name of the graph is the string value of the RDF node. This is so that you can easily make RDF statements about named graphs. </p> @@ -80,8 +80,8 @@ interface XNamedGraph : XURI <p> Note that the ODF elements that can have metadata attached all - implement the interface <type>XMetadatable</type>, which inherits - from <type>XResource</type>, meaning that you can simply pass them + implement the interface XMetadatable, which inherits + from XResource, meaning that you can simply pass them in as arguments here, and it will magically work. </p> @@ -114,8 +114,8 @@ interface XNamedGraph : XURI <p> Note that the ODF elements that can have metadata attached all - implement the interface <type>XMetadatable</type>, which inherits - from <type>XResource</type>, meaning that you can simply pass them + implement the interface XMetadatable, which inherits + from XResource, meaning that you can simply pass them in as arguments here, and it will magically work. </p> @@ -150,8 +150,8 @@ interface XNamedGraph : XURI <p> Note that the ODF elements that can have metadata attached all - implement the interface <type>XMetadatable</type>, which inherits - from <type>XResource</type>, meaning that you can simply pass them + implement the interface XMetadatable, which inherits + from XResource, meaning that you can simply pass them in as arguments here, and it will magically work. </p> @@ -173,7 +173,7 @@ interface XNamedGraph : XURI @returns an iterator over all RDF statements in the graph that match the parameters, represented as an - enumeration of <type>Statement</type> + enumeration of Statement @throws com::sun::star::container::NoSuchElementException if this graph does not exist in the repository any more diff --git a/offapi/com/sun/star/rdf/XRepository.idl b/offapi/com/sun/star/rdf/XRepository.idl index 867055ff4420..9c9491d17d1a 100644 --- a/offapi/com/sun/star/rdf/XRepository.idl +++ b/offapi/com/sun/star/rdf/XRepository.idl @@ -247,7 +247,7 @@ interface XRepository repository. <p> - This invalidates any instances of <type>XNamedGraph</type> + This invalidates any instances of XNamedGraph for the argument. </p> @@ -288,7 +288,7 @@ interface XRepository @returns an iterator over all RDF statements in the repository that match the parameters, represented as an - enumeration of <type>Statement</type> + enumeration of Statement @throws RepositoryException if an error occurs when accessing the repository. @@ -347,7 +347,7 @@ interface XRepository @returns an iterator over the query result graph, represented as an - enumeration of <type>Statement</type> + enumeration of Statement @throws QueryException if the query is malformed, or evaluation fails diff --git a/offapi/com/sun/star/rdf/XRepositorySupplier.idl b/offapi/com/sun/star/rdf/XRepositorySupplier.idl index 51692c1c522b..6218385f8e46 100644 --- a/offapi/com/sun/star/rdf/XRepositorySupplier.idl +++ b/offapi/com/sun/star/rdf/XRepositorySupplier.idl @@ -37,7 +37,7 @@ interface XRepositorySupplier /** provides the RDF Repository associated with this object. @returns - an object of type <type>XRepository</type> + an object of type XRepository */ XRepository getRDFRepository(); diff --git a/offapi/com/sun/star/rendering/AnimationAttributes.idl b/offapi/com/sun/star/rendering/AnimationAttributes.idl index 38d2affaac40..2aab339b73fb 100644 --- a/offapi/com/sun/star/rendering/AnimationAttributes.idl +++ b/offapi/com/sun/star/rendering/AnimationAttributes.idl @@ -37,7 +37,7 @@ struct AnimationAttributes This value determines how the [0,1] parameter space of the animation should be swept through. Permissible values are given in - <type>AnimationRepeat</type>.<p> + AnimationRepeat.<p> @see AnimationRepeat. */ @@ -48,7 +48,7 @@ struct AnimationAttributes This value specifies the size of the animation when rendered with the identity view transform. This permits - e.g. <type>XSprite</type> implementations to cache rendered + e.g. XSprite implementations to cache rendered animation content in finite-sized bitmaps.<p> */ ::com::sun::star::geometry::RealSize2D UntransformedSize; diff --git a/offapi/com/sun/star/rendering/BitmapCanvas.idl b/offapi/com/sun/star/rendering/BitmapCanvas.idl index dd3e2f451f17..4d75b2c2b3ff 100644 --- a/offapi/com/sun/star/rendering/BitmapCanvas.idl +++ b/offapi/com/sun/star/rendering/BitmapCanvas.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module rendering { // TODO: Multiple-inheritance interfaces -/** This service provides the interfaces for a <type>XBitmapCanvas</type> +/** This service provides the interfaces for a XBitmapCanvas */ service BitmapCanvas { diff --git a/offapi/com/sun/star/rendering/BlendMode.idl b/offapi/com/sun/star/rendering/BlendMode.idl index b6c61127db12..664626ef748d 100644 --- a/offapi/com/sun/star/rendering/BlendMode.idl +++ b/offapi/com/sun/star/rendering/BlendMode.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module rendering { /** These constants determine some extra ways how the primitive color is combined with the background.<p> - @see <type>CompositeOperation</type> + @see CompositeOperation Please refer to the PDF specification for explanations of this constants.<p> diff --git a/offapi/com/sun/star/rendering/Canvas.idl b/offapi/com/sun/star/rendering/Canvas.idl index e69ed2f9e1d4..0fdd03820fd6 100644 --- a/offapi/com/sun/star/rendering/Canvas.idl +++ b/offapi/com/sun/star/rendering/Canvas.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module rendering { -/// Service providing an <type>XCanvas</type> interface +/// Service providing an XCanvas interface service Canvas: XCanvas; }; }; }; }; diff --git a/offapi/com/sun/star/rendering/CanvasFactory.idl b/offapi/com/sun/star/rendering/CanvasFactory.idl index 24fe0c8e8222..96ba84ca7495 100644 --- a/offapi/com/sun/star/rendering/CanvasFactory.idl +++ b/offapi/com/sun/star/rendering/CanvasFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module rendering { -/** The <type>CanvasFactory</type> is used to create the <type>Canvas</type> +/** The CanvasFactory is used to create the Canvas objects, evaluating the user's configuration preferences from <code>/org.openoffice.VCL/Settings/Canvas/PreferredServices</code>. @@ -35,7 +35,7 @@ module com { module sun { module star { module rendering { <p> Instantiating this service, you can use its <type scope="com::sun::star::lang">XMultiComponentFactory</type> - interface to create <type>Canvas</type> objects, passing an empty string + interface to create Canvas objects, passing an empty string as service specifier (default). If you want to manually override the configured service list, you can pass a service name to try first. diff --git a/offapi/com/sun/star/rendering/Caret.idl b/offapi/com/sun/star/rendering/Caret.idl index ef6677f5f149..5677e798e5a8 100644 --- a/offapi/com/sun/star/rendering/Caret.idl +++ b/offapi/com/sun/star/rendering/Caret.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module rendering { /** This structure contains the caret information.<p> - This structure is used from the <type>XTextLayout</type> interface + This structure is used from the XTextLayout interface to transport information regarding a text caret.<p> @since OOo 2.0 diff --git a/offapi/com/sun/star/rendering/FloatingPointBitmapLayout.idl b/offapi/com/sun/star/rendering/FloatingPointBitmapLayout.idl index 006f2a700b33..586f141c7245 100644 --- a/offapi/com/sun/star/rendering/FloatingPointBitmapLayout.idl +++ b/offapi/com/sun/star/rendering/FloatingPointBitmapLayout.idl @@ -84,14 +84,14 @@ struct FloatingPointBitmapLayout /** Endianness of the pixel values. - This value must be one of the <type>Endianness</type> constants + This value must be one of the Endianness constants */ byte Endianness; /** Format type of this bitmap.<p> This value must be one of the - <type>FloatingPointBitmapFormat</type> constants.<p> + FloatingPointBitmapFormat constants.<p> */ byte Format; }; diff --git a/offapi/com/sun/star/rendering/FontRequest.idl b/offapi/com/sun/star/rendering/FontRequest.idl index ba5aa470d331..689f1efb5a83 100644 --- a/offapi/com/sun/star/rendering/FontRequest.idl +++ b/offapi/com/sun/star/rendering/FontRequest.idl @@ -68,8 +68,8 @@ struct FontRequest used. That is, the size specified here corresponds to device pixel only if the combined render transformation during text output equals the identity transform. This also applies to all - query methods, for both <type>XCanvasFont</type> and - <type>XTextLayout</type>.<p> + query methods, for both XCanvasFont and + XTextLayout.<p> */ double CellSize; diff --git a/offapi/com/sun/star/rendering/Panose.idl b/offapi/com/sun/star/rendering/Panose.idl index dadf75c9bf4a..cb70fce00fb2 100644 --- a/offapi/com/sun/star/rendering/Panose.idl +++ b/offapi/com/sun/star/rendering/Panose.idl @@ -23,34 +23,34 @@ module com { module sun { module star { module rendering { struct Panose { - /// <type>PanoseFamilyTypes</type> + /// PanoseFamilyTypes byte FamilyType; - /// <type>PanoseSerifStyle</type> + /// PanoseSerifStyle byte SerifStyle; - /// <type>PanoseWeight</type> + /// PanoseWeight byte Weight; - /// <type>PanoseProportion</type> + /// PanoseProportion byte Proportion; - /// <type>PanoseContrast</type> + /// PanoseContrast byte Contrast; - /// <type>PanoseStrokeVariation</type> + /// PanoseStrokeVariation byte StrokeVariation; - /// <type>PanoseArmStyle</type> + /// PanoseArmStyle byte ArmStyle; - /// <type>PanoseLetterForm</type> + /// PanoseLetterForm byte Letterform; - /// <type>PanoseMidline</type> + /// PanoseMidline byte Midline; - /// <type>PanoseXHeight</type> + /// PanoseXHeight byte XHeight; }; diff --git a/offapi/com/sun/star/rendering/RenderState.idl b/offapi/com/sun/star/rendering/RenderState.idl index e032d95bc6c6..1438757e421e 100644 --- a/offapi/com/sun/star/rendering/RenderState.idl +++ b/offapi/com/sun/star/rendering/RenderState.idl @@ -27,11 +27,11 @@ module com { module sun { module star { module rendering { interface XPolyPolygon2D; /** This structure contains information passed to each - <type>XCanvas</type> render operation.<p> + XCanvas render operation.<p> This structure contains information considered as the render state, i.e. the common setup required to render each individual - <type>XCanvas</type> primitive.<p> + XCanvas primitive.<p> @since OOo 2.0 */ @@ -82,7 +82,7 @@ struct RenderState The composite mode determines in which way the primitive and possibly existing background is combined. The permissible - values must be one out of the <type>CompositeOperation</type> + values must be one out of the CompositeOperation constants.<p> */ byte CompositeOperation; diff --git a/offapi/com/sun/star/rendering/RepaintResult.idl b/offapi/com/sun/star/rendering/RepaintResult.idl index 61b68bcde969..d876ba812d53 100644 --- a/offapi/com/sun/star/rendering/RepaintResult.idl +++ b/offapi/com/sun/star/rendering/RepaintResult.idl @@ -22,7 +22,7 @@ module com { module sun { module star { module rendering { /** These constants specify the result of the - <type>XCachedPrimitive</type> render operation.<p> + XCachedPrimitive render operation.<p> @since OOo 2.0 */ diff --git a/offapi/com/sun/star/rendering/StrokeAttributes.idl b/offapi/com/sun/star/rendering/StrokeAttributes.idl index 927c29239d6b..441a5eec76a3 100644 --- a/offapi/com/sun/star/rendering/StrokeAttributes.idl +++ b/offapi/com/sun/star/rendering/StrokeAttributes.idl @@ -97,7 +97,7 @@ struct StrokeAttributes The start point is the first point of every polygon of the path poly-polygon.<p> - @see <type>PathCapType</type> + @see PathCapType */ byte StartCapType; @@ -107,7 +107,7 @@ struct StrokeAttributes The end point is the last point of every polygon of the path poly-polygon.<p> - @see <type>PathCapType</type> + @see PathCapType */ byte EndCapType; @@ -121,7 +121,7 @@ struct StrokeAttributes connected, and therefore also not joined via the shape specified here.<p> - @see <type>PathJoinType</type> + @see PathJoinType */ byte JoinType; diff --git a/offapi/com/sun/star/rendering/TextHit.idl b/offapi/com/sun/star/rendering/TextHit.idl index d9f059d8c391..fbf44fb41aef 100644 --- a/offapi/com/sun/star/rendering/TextHit.idl +++ b/offapi/com/sun/star/rendering/TextHit.idl @@ -21,9 +21,9 @@ module com { module sun { module star { module rendering { -/** This structure contains hit information for <type>XTextLayout</type>.<p> +/** This structure contains hit information for XTextLayout.<p> - This structure is used from the <type>XTextLayout</type> interface + This structure is used from the XTextLayout interface to transport information regarding hit tests.<p> @since OOo 2.0 diff --git a/offapi/com/sun/star/rendering/Texture.idl b/offapi/com/sun/star/rendering/Texture.idl index f2e365bff670..78f223dd3293 100644 --- a/offapi/com/sun/star/rendering/Texture.idl +++ b/offapi/com/sun/star/rendering/Texture.idl @@ -118,7 +118,7 @@ struct Texture The repeat mode is separated into x and y direction, this is the x direction part. Permissible values are from the - <type>TexturingMode</type> constants.<p> + TexturingMode constants.<p> */ byte RepeatModeX; @@ -126,7 +126,7 @@ struct Texture The repeat mode is separated into x and y direction, this is the y direction part. Permissible values are from the - <type>TexturingMode</type> constants.<p> + TexturingMode constants.<p> */ byte RepeatModeY; diff --git a/offapi/com/sun/star/rendering/XAnimatedSprite.idl b/offapi/com/sun/star/rendering/XAnimatedSprite.idl index 82d81b219a2a..a0c16c94db7a 100644 --- a/offapi/com/sun/star/rendering/XAnimatedSprite.idl +++ b/offapi/com/sun/star/rendering/XAnimatedSprite.idl @@ -45,7 +45,7 @@ interface XAnimatedSprite : XSprite full [0,1] range of the <member>XAnimation::render</member>'s t parameter, or a full sequence of sprite bitmaps drawn). Once an animation is running, the associated - <type>XSpriteCanvas</type> handles screen updates + XSpriteCanvas handles screen updates automatically. That means, changes to position or alpha are reflected on screen automatically. Please note further that sprite visibility and animation are unrelated, i.e. a hidden @@ -67,7 +67,7 @@ interface XAnimatedSprite : XSprite A subsequent <member>XAnimatedSprite::startAnimation</member> will commence the sequence at the point where it was stopped with here. Once an animation is stopped, the associated - <type>XSpriteCanvas</type> does not update changed sprites + XSpriteCanvas does not update changed sprites anymore.<p> */ void stopAnimation(); @@ -78,7 +78,7 @@ interface XAnimatedSprite : XSprite If the animation is currently running, the next frame that is drawn after this method has finished, will be the first one. Please note that if an animation is not started, the - associated <type>XSpriteCanvas</type> does not update changed + associated XSpriteCanvas does not update changed sprites automatically.<p> */ void resetAnimation(); @@ -89,7 +89,7 @@ interface XAnimatedSprite : XSprite This method has no effect when called for a bitmap-sequence sprite. Please note that if an animation is not started, the - associated <type>XSpriteCanvas</type> does not update changed + associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> */ @@ -105,7 +105,7 @@ interface XAnimatedSprite : XSprite <member>XSpriteCanvas::updateAnimation()</member> after this method, as it automatically rerenders, if necessary. Please note that if an animation is not started, the associated - <type>XSpriteCanvas</type> does not update changed sprites + XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> @@ -114,7 +114,7 @@ interface XAnimatedSprite : XSprite <member>XAnimation::render()</member> method, or when drawing the sprite's bitmaps, respectively. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the view transformation matrix is singular. */ void setViewState( [in] ViewState aViewState ) @@ -128,7 +128,7 @@ interface XAnimatedSprite : XSprite redraws for every state change.<p> Please note that if an animation is not started, the - associated <type>XSpriteCanvas</type> does not update changed + associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> @@ -154,7 +154,7 @@ interface XAnimatedSprite : XSprite Whether this method should implicitly call <member>XSpriteCanvas::updateAnimation</member> or not. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the passed parameters does not lie in the specified, permissible range. */ diff --git a/offapi/com/sun/star/rendering/XAnimation.idl b/offapi/com/sun/star/rendering/XAnimation.idl index 715c0a4a38e0..af01a6f7bd49 100644 --- a/offapi/com/sun/star/rendering/XAnimation.idl +++ b/offapi/com/sun/star/rendering/XAnimation.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module rendering { /** This interface defines an animation sequence.<p> This interface must be implemented by every animation object. It - is used by the <type>XCanvas</type> interface to render generic + is used by the XCanvas interface to render generic animations.<p> @since OOo 2.0 @@ -79,7 +79,7 @@ interface XAnimation : ::com::sun::star::uno::XInterface range must always be [0,1], where 0 denotes the very beginning, and 1 the end of the animation sequence. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the passed parameters does not lie in the specified, permissible range. */ @@ -89,11 +89,11 @@ interface XAnimation : ::com::sun::star::uno::XInterface /** Request the attribute information for this animation.<p> - This method returns the <type>AnimationAttributes</type> + This method returns the AnimationAttributes structure, which defines more closely how to play this animation.<p> - @returns the requested <type>AnimationAttributes</type> + @returns the requested AnimationAttributes structure. */ AnimationAttributes getAnimationAttributes(); diff --git a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl index f3125bc093b5..b4b0058352bb 100644 --- a/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XBezierPolyPolygon2D.idl @@ -33,9 +33,9 @@ module com { module sun { module star { module rendering { cubic Bezier curves and straight lines. As the straight line is a special case of a cubic Bezier curve (control points collinear with the line through start and end point), this can be expressed - uniformly with a sequence of <type>RealBezierSegment2D</type>s.<p> + uniformly with a sequence of RealBezierSegment2Ds.<p> - By convention, a <type>RealBezierSegment2D</type> is a straight + By convention, a RealBezierSegment2D is a straight line segment, if all three contained points are strictly equal.<p> @since OOo 2.0 @@ -69,7 +69,7 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D @returns the sequence of extracted points. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if one of the given values exceed the permissible range. */ sequence< sequence < ::com::sun::star::geometry::RealBezierSegment2D > > getBezierSegments( [in] long nPolygonIndex, [in] long nNumberOfPolygons, [in] long nPointIndex, [in] long nNumberOfPoints ) @@ -94,7 +94,7 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D such that after this method completes, it contains exactly the specified Bezier segment data. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if one of the given values exceed the permissible range. */ void setBezierSegments( [in] sequence< sequence< ::com::sun::star::geometry::RealBezierSegment2D > > points, [in] long nPolygonIndex ) @@ -115,7 +115,7 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D @returns the requested point. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if one of the given values exceed the permissible range. */ @@ -144,7 +144,7 @@ interface XBezierPolyPolygon2D : XPolyPolygon2D nPolygonIndex, which is to be set. This value must not exceed the number of points in this polygon. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if one of the given values exceed the permissible range. */ void setBezierSegment( [in] ::com::sun::star::geometry::RealBezierSegment2D point, [in] long nPolygonIndex, [in] long nPointIndex ) diff --git a/offapi/com/sun/star/rendering/XBitmap.idl b/offapi/com/sun/star/rendering/XBitmap.idl index 8612b58040ff..0f963128894b 100644 --- a/offapi/com/sun/star/rendering/XBitmap.idl +++ b/offapi/com/sun/star/rendering/XBitmap.idl @@ -30,10 +30,10 @@ module com { module sun { module star { module rendering { /** This is a generic interface to a bitmap.<p> This interface contains the generic functionality to be used on - every <type>XCanvas</type> bitmap object. More format-specific - methods can be found at the <type>XIntegerBitmap</type>, - <type>XIeeeDoubleBitmap</type>, <type>XIeeeFloatBitmap</type> and - <type>XHalfFloatBitmap</type> interfaces.<p> + every XCanvas bitmap object. More format-specific + methods can be found at the XIntegerBitmap, + XIeeeDoubleBitmap, XIeeeFloatBitmap and + XHalfFloatBitmap interfaces.<p> @since OOo 2.0 */ @@ -52,7 +52,7 @@ interface XBitmap : ::com::sun::star::uno::XInterface The method checks, whether the bitmap contains any alpha information. The same information is also available at the - <type>XColorSpace</type> associated with this bitmap, though + XColorSpace associated with this bitmap, though much easier to access here (the color space then has a component flagged <member>ColorComponentTag::ALPHA</member>).<p> @@ -76,10 +76,10 @@ interface XBitmap : ::com::sun::star::uno::XInterface @returns the new scaled bitmap. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the size components are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the contents of a volatile bitmap have been destroyed, and thus cannot be read to generate the scaled bitmap. */ diff --git a/offapi/com/sun/star/rendering/XBitmapCanvas.idl b/offapi/com/sun/star/rendering/XBitmapCanvas.idl index 1ead7c07e3c8..8c567ae598cd 100644 --- a/offapi/com/sun/star/rendering/XBitmapCanvas.idl +++ b/offapi/com/sun/star/rendering/XBitmapCanvas.idl @@ -73,7 +73,7 @@ interface XBitmapCanvas : XCanvas The render state to apply to the source of this copy operation. The render transformation must be non-singular, and the compositing mode must be one of the - <type>CompositingOperation</type> values. + CompositingOperation values. @param destRect Rectangle into which to copy the bitmap data. This rectangle @@ -93,9 +93,9 @@ interface XBitmapCanvas : XCanvas The render state to apply to the destination of this copy operation. The render transformation must be non-singular, and the compositing mode must be one of the - <type>CompositingOperation</type> values. + CompositingOperation values. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the parameters are not within the specified range. */ void copyRect( [in] XBitmapCanvas sourceCanvas, diff --git a/offapi/com/sun/star/rendering/XBitmapPalette.idl b/offapi/com/sun/star/rendering/XBitmapPalette.idl index 9be0fc9bbd15..d0154646867a 100644 --- a/offapi/com/sun/star/rendering/XBitmapPalette.idl +++ b/offapi/com/sun/star/rendering/XBitmapPalette.idl @@ -56,7 +56,7 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface transparency, by flagging certain palette entries to be fully transparent when displaying the bitmap. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than <member>XBitmapPalette::getNumberOfEntries()</member>-1. */ @@ -82,11 +82,11 @@ interface XBitmapPalette : ::com::sun::star::uno::XInterface @return whether the palette entry was changed. For read-only entries, this method always returns <FALSE/>. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than <member>XBitmapPalette::getNumberOfEntries()</member>-1. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given sequence of color components does not match the associated bitmap's device color format. */ diff --git a/offapi/com/sun/star/rendering/XBufferController.idl b/offapi/com/sun/star/rendering/XBufferController.idl index 04989a402e2f..bb49143ee5c9 100644 --- a/offapi/com/sun/star/rendering/XBufferController.idl +++ b/offapi/com/sun/star/rendering/XBufferController.idl @@ -47,7 +47,7 @@ interface XBufferController : ::com::sun::star::uno::XInterface @return the number of actually generated buffers, which might be between 0 (no double-buffering available) and nBuffers. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if nBuffers is smaller than one. */ long createBuffers( [in] long nBuffers ) @@ -78,7 +78,7 @@ interface XBufferController : ::com::sun::star::uno::XInterface @return whether the switch was performed successfully. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if nBuffer is outside the permissible range. */ boolean showBuffer( [in] boolean bUpdateAll ); diff --git a/offapi/com/sun/star/rendering/XCachedPrimitive.idl b/offapi/com/sun/star/rendering/XCachedPrimitive.idl index d33337c04d69..ace6d73638b6 100644 --- a/offapi/com/sun/star/rendering/XCachedPrimitive.idl +++ b/offapi/com/sun/star/rendering/XCachedPrimitive.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module rendering { -/** Interface for cached repaint of already drawn <type>XCanvas</type> +/** Interface for cached repaint of already drawn XCanvas primitives.<p> This interface provides a method to quickly redraw some - <type>XCanvas</type> primitives, using cached data.<p> + XCanvas primitives, using cached data.<p> @since OOo 2.0 */ @@ -44,10 +44,10 @@ interface XCachedPrimitive : ::com::sun::star::uno::XInterface view state is of course permitted to differ from the one used for initial rendering. - @return a value of type <type>RepaintResult</type>, denoting + @return a value of type RepaintResult, denoting the result of this operation. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the view transformation matrix is singular. */ byte redraw( [in] ViewState aState ) diff --git a/offapi/com/sun/star/rendering/XCanvas.idl b/offapi/com/sun/star/rendering/XCanvas.idl index 749bbed47e1a..9b9730988e05 100644 --- a/offapi/com/sun/star/rendering/XCanvas.idl +++ b/offapi/com/sun/star/rendering/XCanvas.idl @@ -55,34 +55,34 @@ interface XTextLayout; the place where all draw methods are located.<p> Some notes are in order to explain the concepts used here. The - <type>XCanvas</type> interface is free of client-modifiable state, + XCanvas interface is free of client-modifiable state, i.e. it can be used safely and without external synchronization in a multi-threaded environment. On the other hand, this implies that for nearly every canvas operation, external state is - required. This is provided by <type>ViewState</type> and - <type>RenderState</type> in a unified fashion, supplemented by a + required. This is provided by ViewState and + RenderState in a unified fashion, supplemented by a few extra state parameters for some methods (e.g. textured polygons or text rendering).<p> When used careless, this scheme can be inefficient to some extend, because internally, view, render and other states have to be combined before rendering. This is especially expensive for - complex clip polygons, i.e. when both <type>ViewState</type> and - <type>RenderState</type> have a complex clip polygon set, which + complex clip polygons, i.e. when both ViewState and + RenderState have a complex clip polygon set, which have to be intersected before rendering. It is therefore - recommended to combine <type>ViewState</type> and - <type>RenderState</type> already at the client side, when objects + recommended to combine ViewState and + RenderState already at the client side, when objects are organized in a hierarchical way: the classic example are grouped draw shapes, whose parent group object imposes a common clipping and a common transformation on its siblings. The - group object would therefore merge the <type>ViewState</type> and - the <type>RenderState</type> it is called with into a new - <type>ViewState</type>, and call its siblings with a - <type>RenderState</type> containing only the local offset (and no + group object would therefore merge the ViewState and + the RenderState it is called with into a new + ViewState, and call its siblings with a + RenderState containing only the local offset (and no extra clipping).<p> Further on, this stateless nature provides easy ways for - caching. Every non-trivial operation on <type>XCanvas</type> can + caching. Every non-trivial operation on XCanvas can return a cache object, which, when called to redraw, renders the primitive usually much more quickly than the original method. Note that such caching is a lot more complicated, should the actual @@ -91,7 +91,7 @@ interface XTextLayout; <type scope="::com::sun::star::drawing">::com::sun::star::drawing::XGraphics</type> interface). Please note, though, that deciding whether to return - an <type>XCachedPrimitive</type> is completely up to the + an XCachedPrimitive is completely up to the implementation - don't rely on the methods returning something (this is because there might be cases when returning such a cache object will actually be a pessimization, since it involves memory @@ -102,9 +102,9 @@ interface XTextLayout; can, in principle, roll your own implementations of these interfaces, wrap it around your internal representation of polygons and bitmaps, and render them. It might just not be overly - fast, because the <type>XCanvas</type> would need to convert for + fast, because the XCanvas would need to convert for each render call. It is therefore recommended to create such - objects via the <type>XGraphicDevice</type> factory (to be + objects via the XGraphicDevice factory (to be retrieved from every canvas object via the <member>getDevice()</member> call) - they will then internally optimize to the underlying graphics subsystem.<p> @@ -117,7 +117,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface This method clears the whole canvas area to the device default color (e.g. white for a printer, transparent for an - <type>XCustomSprite</type>). + XCustomSprite). */ void clear(); @@ -132,7 +132,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The render state to be used when drawing this point. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -155,7 +155,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The render state to be used when drawing this line. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -178,7 +178,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The render state to be used when drawing this curve. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -200,7 +200,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -212,8 +212,8 @@ interface XCanvas : ::com::sun::star::uno::XInterface specified stroke attributes.<p> This method considers the stroking of all polygons as an - atomic operation in relation to the <type>RenderState</type>'s - <type>CompositeOperationy</type> operation. That means, + atomic operation in relation to the RenderState's + CompositeOperationy operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.<p> @@ -232,7 +232,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -245,8 +245,8 @@ interface XCanvas : ::com::sun::star::uno::XInterface with the specified texture graphics.<p> This method considers the stroking of all polygons as an - atomic operation in relation to the <type>RenderState</type>'s - <type>CompositeOp</type> operation. That means, overlapping + atomic operation in relation to the RenderState's + CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency.<p> @@ -269,11 +269,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -288,8 +288,8 @@ interface XCanvas : ::com::sun::star::uno::XInterface outline via the specified texture mapping.<p> This method considers the stroking of all polygons as an - atomic operation in relation to the <type>RenderState</type>'s - <type>CompositeOp</type> operation. That means, overlapping + atomic operation in relation to the RenderState's + CompositeOp operation. That means, overlapping strokes from distinct polygons will look exactly as overlapping segments of the same polygon, even with transparency. @@ -316,11 +316,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -352,7 +352,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a poly-polygon describing the outline of the stroked area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -363,7 +363,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface /** Fill the given poly-polygon.<p> This method fills the given poly-polygon according to the - <type>RenderState</type>'s color and the poly-polygon's fill + RenderState's color and the poly-polygon's fill rule.<p> @param xPolyPolygon @@ -377,7 +377,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -388,7 +388,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface /** Fill the given poly-polygon with a texture.<p> This method fills the given poly-polygon according to the - <type>RenderState</type>'s color, the given textures and + RenderState's color, the given textures and poly-polygon's fill rule.<p> @param xPolyPolygon @@ -406,11 +406,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -422,7 +422,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface /** Fill the given poly-polygon with a mapped texture.<p> This method fills the given poly-polygon according to the - <type>RenderState</type>'s color, the given textures and + RenderState's color, the given textures and poly-polygon's fill rule. The texture is mapped to the poly-polygon's interior via the given texture mapping.<p> @@ -445,11 +445,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -468,16 +468,16 @@ interface XCanvas : ::com::sun::star::uno::XInterface the following properties are recognized: <ul> - <il>Kerning: a <type>double</type> between 0 and 1, where + <il>Kerning: a double between 0 and 1, where 0 completely disables kerning. Whether kerning is on or off by default is font-dependent.</il> - <il>IsEmphasisMarks: a <type>boolean</type>, where <TRUE/> + <il>IsEmphasisMarks: a boolean, where <TRUE/> enables automatic placements of emphasis marks, e.g. for Hebrew. The default value, if this property is not specified, is <FALSE/>.</il> - <il>ExpandedSpacing: a <type>double</type> value which is added + <il>ExpandedSpacing: a double value which is added between all cell distances for this font. The default value for this property is zero. Use negative values for condensed output, and positive values for expanded output.</il> @@ -496,7 +496,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @returns the requested font, or an invalid reference, if the request failed. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the parameters is not within the allowed range. */ XCanvasFont createFont( [in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix ) @@ -507,7 +507,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aFilter Filter parameter to reduce the list of returned fonts. Every - member of <type>FontInfo</type> that is not the empty string + member of FontInfo that is not the empty string or the "don't care" value restricts the list of returned fonts to contain only those that have the specified attribute. @@ -517,9 +517,9 @@ interface XCanvas : ::com::sun::star::uno::XInterface @returns the list of fonts matching the filter set. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the font properties are invalid or not recognized, - or if one of the <type>FontInfo</type> members is not within + or if one of the FontInfo members is not within the permitted range. */ sequence< FontInfo > queryAvailableFonts( [in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties ) @@ -548,7 +548,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface The render state to be used when drawing this text. @param nTextDirection - A value from the <type>TextDirection</type> collection, + A value from the TextDirection collection, denoting the main writing direction for this string. The main writing direction determines the origin of the text output, i.e. the left edge for left-to-right and the right edge for @@ -556,7 +556,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -576,7 +576,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param xLayoutetText An interface to the readily layouted text, obtained from a - <type>XCanvasFont</type> created at this canvas. The text + XCanvasFont created at this canvas. The text layout already carries intrinsic font information. @param aViewState @@ -587,7 +587,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -600,7 +600,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface This method renders the bitmap, at a position and shape as specified by the combined view and render transformations. For fast render speed, the bitmap should be created by the - corresponding <type>XGraphicDevice</type>'s + corresponding XGraphicDevice's <member>XGraphicDevice::createCompatibleBitmap()</member> method.<p> @@ -615,11 +615,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -632,7 +632,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface This method renders the bitmap, at a position and shape as specified by the combined view and render transformations. For fast render speed, the bitmap should be created by the - corresponding <type>XGraphicDevice</type>'s + corresponding XGraphicDevice's <member>XGraphicDevice::createCompatibleBitmap()</member> method. The bitmap's color channel values are multiplied with the device color values as specified in the render state.<p> @@ -654,11 +654,11 @@ interface XCanvas : ::com::sun::star::uno::XInterface @return a handle to the cached rendering output. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if a texture bitmap was volatile, and the content was destroyed before the rendering could take place. */ @@ -674,7 +674,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface rendering to such a device. This includes device resolution, color space, or bitmap formats. - @return the associated <type>XGraphicDevice</type>. + @return the associated XGraphicDevice. */ XGraphicDevice getDevice(); }; diff --git a/offapi/com/sun/star/rendering/XColorSpace.idl b/offapi/com/sun/star/rendering/XColorSpace.idl index 32152e1aa957..6fe4d786cb02 100644 --- a/offapi/com/sun/star/rendering/XColorSpace.idl +++ b/offapi/com/sun/star/rendering/XColorSpace.idl @@ -41,14 +41,14 @@ module com { module sun { module star { module rendering { All canvas interfaces standardize to sequences of IEEE doubles for color representation. As this is overly verbose when used for bitmap data, derived interfaces exist, - e.g. <type>XIntegerBitmapColorSpace</type>, which use sequences of + e.g. XIntegerBitmapColorSpace, which use sequences of integers for color representation.<p> */ interface XColorSpace { /** Query type of this color space.<p> - @return a value from the <type>ColorSpaceType</type> constant + @return a value from the ColorSpaceType constant group. */ byte getType(); @@ -60,7 +60,7 @@ interface XColorSpace in the final output color. This method returns a sequence of tags, specifying for each component of a color value, to what color attribute (if any) it corresponds. The values must be - one of the <type>ColorComponentTag</type> constants.<p> + one of the ColorComponentTag constants.<p> At the same time, the number of elements in this sequence corresponds to the number of color channels for this color @@ -74,7 +74,7 @@ interface XColorSpace /** Query rendering intent of this color space.<p> - @return a value from the <type>RenderingIntent</type> constant + @return a value from the RenderingIntent constant group. */ byte getRenderingIntent(); @@ -103,7 +103,7 @@ interface XColorSpace <type>sequence<byte></type>). @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format (e.g. if the number of components is wrong) */ @@ -112,7 +112,7 @@ interface XColorSpace /** Convert color value in this color space to sRGB color values.<p> - Any information not representable in the <type>RGBColor</type> + Any information not representable in the RGBColor struct is discarded during the conversion. This includes alpha information. @@ -125,7 +125,7 @@ interface XColorSpace space. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. @see <member>convertToARGB</member> @@ -147,7 +147,7 @@ interface XColorSpace space. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ARGBColor> convertToARGB( [in] sequence<ColorComponent> deviceColor ) @@ -171,7 +171,7 @@ interface XColorSpace space. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ARGBColor> convertToPARGB( [in] sequence<ColorComponent> deviceColor ) @@ -189,7 +189,7 @@ interface XColorSpace @return the corresponding sequence of device colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ColorComponent> convertFromRGB( [in] sequence<RGBColor> rgbColor ) @@ -207,7 +207,7 @@ interface XColorSpace @return the corresponding sequence of device colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ColorComponent> convertFromARGB( [in] sequence<ARGBColor> rgbColor ) @@ -228,7 +228,7 @@ interface XColorSpace @return the corresponding sequence of device colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ColorComponent> convertFromPARGB( [in] sequence<ARGBColor> rgbColor ) diff --git a/offapi/com/sun/star/rendering/XGraphicDevice.idl b/offapi/com/sun/star/rendering/XGraphicDevice.idl index 83f0769ebb3a..b3ae86908176 100644 --- a/offapi/com/sun/star/rendering/XGraphicDevice.idl +++ b/offapi/com/sun/star/rendering/XGraphicDevice.idl @@ -131,7 +131,7 @@ interface XGraphicDevice : ::com::sun::star::uno::XInterface (e.g. generated via createCompatibleBitmap()) is the fact that its content might vanish at any point in time (making any operation with them produce a - <type>VolatileContentDestroyedException</type>). The benefit, + VolatileContentDestroyedException). The benefit, on the other hand, is that they might be easy to hardware-accelerate on certain platforms, without the need to keep a safety copy of the content internally. @@ -162,7 +162,7 @@ interface XGraphicDevice : ::com::sun::star::uno::XInterface (e.g. generated via createCompatibleBitmap()) is the fact that its content might vanish at any point in time (making any operation with them produce a - <type>VolatileContentDestroyedException</type>). The benefit, + VolatileContentDestroyedException). The benefit, on the other hand, is that they might be easy to hardware-accelerate on certain platforms, without the need to keep a safety copy of the content internally. @@ -207,7 +207,7 @@ interface XGraphicDevice : ::com::sun::star::uno::XInterface * "EllipticalGradient" - this gradient has zeroth color index in the middle, and varies linearly between center and final color. The services takes an additional - parameter named "AspectRatio" of <type>double</type> + parameter named "AspectRatio" of double (width divided by height), if this aspect ratio is 1, the gradient is circular. If it's not 1, the gradient is elliptical, with the special twist that the aspect ratio @@ -222,7 +222,7 @@ interface XGraphicDevice : ::com::sun::star::uno::XInterface index in the middle, and varies linearly between center and final color via rectangular boxes around the center point. The services takes an additional - parameter named "AspectRatio" of <type>double</type> + parameter named "AspectRatio" of double (width divided by height), if this aspect ratio is 1, the gradient is quadratic. If it's not 1, the gradient is rectangular, with the special twist that the aspect ratio diff --git a/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl b/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl index 851f30e25f18..0e107574c1b0 100644 --- a/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl +++ b/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module rendering { /** Specialized interface for bitmaps containing half floats as their color components. Half floats are 16 bit wide, and some high-end GPUs already have them as supported frame buffer format. In - contrast to <type>XHalfFloatBitmap</type>, this interface only + contrast to XHalfFloatBitmap, this interface only permits read-only access.<p> Use this interface for e.g. bitmaps that are calculated @@ -40,11 +40,11 @@ module com { module sun { module star { module rendering { modified.<p> If you get passed an instance of - <type>XHalfFloatReadOnlyBitmap</type> that also supports the - <type>XVolatileBitmap</type> interface, things become a bit more + XHalfFloatReadOnlyBitmap that also supports the + XVolatileBitmap interface, things become a bit more complicated. When reading data, one has to check for both - <type>VolatileContentDestroyedException</type> and mismatching - <type>FloatingPointBitmapLayout</type> return values. If either of them + VolatileContentDestroyedException and mismatching + FloatingPointBitmapLayout return values. If either of them occurs, the whole bitmap read operation should be repeated.<p> */ interface XHalfFloatReadOnlyBitmap : XBitmap @@ -60,7 +60,7 @@ interface XHalfFloatReadOnlyBitmap : XBitmap integers across the API (which requires casting on both sides).<p> - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. */ sequence<short> getData( [in] ::com::sun::star::geometry::IntegerRectangle2D rect ) @@ -71,7 +71,7 @@ interface XHalfFloatReadOnlyBitmap : XBitmap /** Get a single pixel of the bitmap, returning its color value.<p> - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. */ sequence<short> getPixel( [in] ::com::sun::star::geometry::IntegerPoint2D pos ) diff --git a/offapi/com/sun/star/rendering/XIeeeDoubleBitmap.idl b/offapi/com/sun/star/rendering/XIeeeDoubleBitmap.idl index a08ab28569ac..6c938d1b954e 100644 --- a/offapi/com/sun/star/rendering/XIeeeDoubleBitmap.idl +++ b/offapi/com/sun/star/rendering/XIeeeDoubleBitmap.idl @@ -63,11 +63,11 @@ interface XIeeeDoubleBitmap : XIeeeDoubleReadOnlyBitmap Destination rectangle, within the bounds of the bitmap, to set the data in. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given memory layout does not match this bitmap's layout, or if the given data sequence has too few or too much elements. @@ -98,10 +98,10 @@ interface XIeeeDoubleBitmap : XIeeeDoubleReadOnlyBitmap @param pos Pixel position with the bounds of the bitmap to set. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given point is outside the permissible bitmap area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given memory layout does not match this bitmap's layout, or if the given data sequence has too few or too much elements. diff --git a/offapi/com/sun/star/rendering/XIeeeDoubleReadOnlyBitmap.idl b/offapi/com/sun/star/rendering/XIeeeDoubleReadOnlyBitmap.idl index 79552af2a5f7..6df739bcea3a 100644 --- a/offapi/com/sun/star/rendering/XIeeeDoubleReadOnlyBitmap.idl +++ b/offapi/com/sun/star/rendering/XIeeeDoubleReadOnlyBitmap.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module rendering { /** This is a specialized interface for bitmaps containing IEEE doubles for their color components. In contrast to - <type>XIeeeDoubleBitmap</type>, this interface only permits + XIeeeDoubleBitmap, this interface only permits read-only access.<p> Use this interface for e.g. bitmaps that are calculated @@ -40,11 +40,11 @@ module com { module sun { module star { module rendering { modified.<p> If you get passed an instance of - <type>XHalfFloatReadOnlyBitmap</type> that also supports the - <type>XVolatileBitmap</type> interface, things become a bit more + XHalfFloatReadOnlyBitmap that also supports the + XVolatileBitmap interface, things become a bit more complicated. When reading data, one has to check for both - <type>VolatileContentDestroyedException</type> and mismatching - <type>FloatingPointBitmapLayout</type> return values. If either of them + VolatileContentDestroyedException and mismatching + FloatingPointBitmapLayout return values. If either of them occurs, the whole bitmap read operation should be repeated.<p> */ interface XIeeeDoubleReadOnlyBitmap : XBitmap @@ -67,10 +67,10 @@ interface XIeeeDoubleReadOnlyBitmap : XBitmap A rectangle, within the bounds of the bitmap, to retrieve the consent from. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area. */ @@ -92,10 +92,10 @@ interface XIeeeDoubleReadOnlyBitmap : XBitmap A position, within the bounds of the bitmap, to retrieve the color from. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given position is outside the permissible bitmap area. */ sequence<double> getPixel( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos ) diff --git a/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl b/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl index 03582b364f16..92a1547f1be8 100644 --- a/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl +++ b/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl @@ -63,11 +63,11 @@ interface XIeeeFloatBitmap : XIeeeFloatReadOnlyBitmap Destination rectangle, within the bounds of the bitmap, to set the data in. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given memory layout does not match this bitmap's layout, or if the given data sequence has too few or too much elements. @@ -98,10 +98,10 @@ interface XIeeeFloatBitmap : XIeeeFloatReadOnlyBitmap @param pos Pixel position with the bounds of the bitmap to set. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given point is outside the permissible bitmap area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given memory layout does not match this bitmap's layout, or if the given data sequence has too few or too much elements. diff --git a/offapi/com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl b/offapi/com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl index 8b189cc9279a..c010d43265a2 100644 --- a/offapi/com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl +++ b/offapi/com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module rendering { /** Specialized interface for bitmaps containing IEEE floats as their - color components. In contrast to <type>XIeeeFloatBitmap</type>, + color components. In contrast to XIeeeFloatBitmap, this interface only permits read-only access.<p> Use this interface for e.g. bitmaps that are calculated @@ -39,11 +39,11 @@ module com { module sun { module star { module rendering { modified.<p> If you get passed an instance of - <type>XHalfFloatReadOnlyBitmap</type> that also supports the - <type>XVolatileBitmap</type> interface, things become a bit more + XHalfFloatReadOnlyBitmap that also supports the + XVolatileBitmap interface, things become a bit more complicated. When reading data, one has to check for both - <type>VolatileContentDestroyedException</type> and mismatching - <type>FloatingPointBitmapLayout</type> return values. If either of them + VolatileContentDestroyedException and mismatching + FloatingPointBitmapLayout return values. If either of them occurs, the whole bitmap read operation should be repeated.<p> */ interface XIeeeFloatReadOnlyBitmap : XBitmap @@ -66,10 +66,10 @@ interface XIeeeFloatReadOnlyBitmap : XBitmap A rectangle, within the bounds of the bitmap, to retrieve the consent from. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area. */ @@ -91,10 +91,10 @@ interface XIeeeFloatReadOnlyBitmap : XBitmap A position, within the bounds of the bitmap, to retrieve the color from. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given position is outside the permissible bitmap area. */ sequence<float> getPixel( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos ) diff --git a/offapi/com/sun/star/rendering/XIntegerBitmap.idl b/offapi/com/sun/star/rendering/XIntegerBitmap.idl index cdad34c3fc92..2f4c6ae92e00 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmap.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmap.idl @@ -67,11 +67,11 @@ interface XIntegerBitmap : XIntegerReadOnlyBitmap Destination rectangle, within the bounds of the bitmap, to set the data in. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given memory layout does not match this bitmap's layout, or if the given data sequence has too few or too many elements. @@ -107,10 +107,10 @@ interface XIntegerBitmap : XIntegerReadOnlyBitmap @param pos Pixel position with the bounds of the bitmap to set. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given point is outside the permissible bitmap area. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given memory layout does not match this bitmap's layout, or if the given data sequence has too few or too many elements. diff --git a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl index 60bdd5225cc1..c6eb20704280 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl @@ -37,7 +37,7 @@ interface XIntegerBitmapColorSpace : XColorSpace /** Query number of bits used per bitmap pixel.<p> This method yields the total number of bits used for a color - value. At the associated <type>XIntegerBitmap</type>, the + value. At the associated XIntegerBitmap, the <member>XIntegerBitmap::setPixel()</member> method will expect a sequence of ceil(BitsPerPixel/8) bytes, and the <member>XIntegerReadOnlyBitmap::getPixel()</member> will @@ -55,7 +55,7 @@ interface XIntegerBitmapColorSpace : XColorSpace returned from <member>getBitsPerPixel()</member>. If the sum is less, excess bits are always kept in the most significant bits of a pixel. Color components will appear in the byte sequences - returned from the <type>XIntegerBitmap</type> methods in the + returned from the XIntegerBitmap methods in the order defined here, with the first element starting from the least significant bits of the pixel, etc.<p> @@ -70,7 +70,7 @@ interface XIntegerBitmapColorSpace : XColorSpace /** Query whether color data bytes need to be swapped.<p> @return <TRUE/>, This method returns the endianness of the color - data. The value is one of the <type>Endianness</type> + data. The value is one of the Endianness constants. If color data is represented using more than one byte, the actual channel positions are specified using bit positions. Therefore, depending on the architecture, the @@ -100,7 +100,7 @@ interface XIntegerBitmapColorSpace : XColorSpace target color space @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ColorComponent> convertFromIntegerColorSpace( [in] sequence<byte> deviceColor, [in] XColorSpace targetColorSpace ) @@ -121,7 +121,7 @@ interface XIntegerBitmapColorSpace : XColorSpace target color space @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<byte> convertToIntegerColorSpace( [in] sequence<byte> deviceColor, [in] XIntegerBitmapColorSpace targetColorSpace ) @@ -129,7 +129,7 @@ interface XIntegerBitmapColorSpace : XColorSpace /** Convert color value in this color space to sRGB color values.<p> - Any information not representable in the <type>RGBColor</type> + Any information not representable in the RGBColor struct is discarded during the conversion. This includes alpha information. Color values are properly rounded and clipped, to be valid in the target color space.<p> @@ -144,7 +144,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @see <member>XIntegerBitmapColorSpace::convertIntegerToARGB</member> @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<RGBColor> convertIntegerToRGB( [in] sequence<byte> deviceColor ) @@ -166,7 +166,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @return the corresponding sequence of sRGB colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ARGBColor> convertIntegerToARGB( [in] sequence<byte> deviceColor ) @@ -190,7 +190,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @return the corresponding sequence of sRGB colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<ARGBColor> convertIntegerToPARGB( [in] sequence<byte> deviceColor ) @@ -211,7 +211,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @return the corresponding sequence of device colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<byte> convertIntegerFromRGB( [in] sequence<RGBColor> rgbColor ) @@ -231,7 +231,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @return the corresponding sequence of device colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<byte> convertIntegerFromARGB( [in] sequence<ARGBColor> rgbColor ) @@ -254,7 +254,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @return the corresponding sequence of device colors. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. */ sequence<byte> convertIntegerFromPARGB( [in] sequence<ARGBColor> rgbColor ) diff --git a/offapi/com/sun/star/rendering/XIntegerReadOnlyBitmap.idl b/offapi/com/sun/star/rendering/XIntegerReadOnlyBitmap.idl index 3be29a09b15a..616389f3944a 100644 --- a/offapi/com/sun/star/rendering/XIntegerReadOnlyBitmap.idl +++ b/offapi/com/sun/star/rendering/XIntegerReadOnlyBitmap.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module rendering { interface XBitmapPalette; /** This is a specialized interface for bitmaps having integer color - channels. In contrast to <type>XIntegerBitmap</type>, this + channels. In contrast to XIntegerBitmap, this interface only permits read-only access.<p> Use this interface for e.g. bitmaps that are calculated @@ -41,11 +41,11 @@ interface XBitmapPalette; modified.<p> If you get passed an instance of - <type>XIntegerReadOnlyBitmap</type> that also supports the - <type>XVolatileBitmap</type> interface, things become a bit more + XIntegerReadOnlyBitmap that also supports the + XVolatileBitmap interface, things become a bit more complicated. When reading data, one has to check for both - <type>VolatileContentDestroyedException</type> and mismatching - <type>IntegerBitmapLayout</type> return values. If either of them + VolatileContentDestroyedException and mismatching + IntegerBitmapLayout return values. If either of them occurs, the whole bitmap read operation should be repeated, if you need consistent information.<p> */ @@ -70,16 +70,16 @@ interface XIntegerReadOnlyBitmap : XBitmap space returned therein needs to always match the current color space as would have been returned by getMemoryLayout(). This is necessary to ensure correct operation under changing - <type>XVolatileBitmap</type>. + XVolatileBitmap. @param rect A rectangle, within the bounds of the bitmap, to retrieve the consent from. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if parts of the given rectangle are outside the permissible bitmap area. */ @@ -106,16 +106,16 @@ interface XIntegerReadOnlyBitmap : XBitmap space returned therein needs to always match the current color space as would have been returned by getMemoryLayout(). This is necessary to ensure correct operation under changing - <type>XVolatileBitmap</type>. + XVolatileBitmap. @param pos A position, within the bounds of the bitmap, to retrieve the color from. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if the bitmap is volatile, and the content has been destroyed by the system. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given position is outside the permissible bitmap area. */ sequence<byte> getPixel( [out] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos ) diff --git a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl index 1070b945a683..551051c42e66 100644 --- a/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XLinePolyPolygon2D.idl @@ -79,7 +79,7 @@ interface XLinePolyPolygon2D : XPolyPolygon2D such that after this method completes, it contains exactly the specified point data. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if one of the given values exceed the permissible range. */ void setPoints( [in] sequence< sequence< ::com::sun::star::geometry::RealPoint2D > > points, [in] long nPolygonIndex ) diff --git a/offapi/com/sun/star/rendering/XParametricPolyPolygon2D.idl b/offapi/com/sun/star/rendering/XParametricPolyPolygon2D.idl index f736745acfb4..97b8190b8942 100644 --- a/offapi/com/sun/star/rendering/XParametricPolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XParametricPolyPolygon2D.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module rendering { The returned poly-polygon should normally be contained in the [0,1]x[0,1] rectangle. At least that is the dimension expected at - other places. e.g. <type>Texture</type>. + other places. e.g. Texture. */ interface XParametricPolyPolygon2D : ::com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/rendering/XPolyPolygon2D.idl b/offapi/com/sun/star/rendering/XPolyPolygon2D.idl index a22da2ac5e73..c286a1648086 100644 --- a/offapi/com/sun/star/rendering/XPolyPolygon2D.idl +++ b/offapi/com/sun/star/rendering/XPolyPolygon2D.idl @@ -57,11 +57,11 @@ interface XPolyPolygon2D : ::com::sun::star::uno::XInterface no effect on the poly-polygon it was added to. @throws a - <type>com::sun::star::lang::IllegalArgumentException</type>, + com::sun::star::lang::IllegalArgumentException, if the XPolyPolygon2D parameter does not support one of the data-providing derivative interfaces - (<type>XBezierPolyPolygon2D</type>, - <type>XLinePolyPolygon2D</type>). + (XBezierPolyPolygon2D, + XLinePolyPolygon2D). */ void addPolyPolygon( [in] ::com::sun::star::geometry::RealPoint2D position, [in] XPolyPolygon2D polyPolygon ) raises (com::sun::star::lang::IllegalArgumentException); diff --git a/offapi/com/sun/star/rendering/XSimpleCanvas.idl b/offapi/com/sun/star/rendering/XSimpleCanvas.idl index 32dfefab8b00..0e81b7f8cb24 100644 --- a/offapi/com/sun/star/rendering/XSimpleCanvas.idl +++ b/offapi/com/sun/star/rendering/XSimpleCanvas.idl @@ -39,12 +39,12 @@ interface XPolyPolygon2D; /** Provides the basic graphical output operations for a canvas.<p> - This interface is a simplified version of the <type>XCanvas</type> + This interface is a simplified version of the XCanvas interface. It holds explicit state, i.e. the pen and fill color, the current transformation, clip and font are persistently remembered.<p> - In contrast to the <type>XCanvas</type> interface, XSimpleCanvas + In contrast to the XCanvas interface, XSimpleCanvas does not distinguish between stroke and fill operations; instead, switching between stroke and fill (or taking both) works by setting appropriate pen and fill colors.<p> @@ -137,7 +137,7 @@ interface XSimpleCanvas: com::sun::star::uno::XInterface relative to the font baseline. @param nTextDirection - A value from the <type>TextDirection</type> collection, + A value from the TextDirection collection, denoting the main writing direction for this string. The main writing direction determines the origin of the text output, i.e. the left edge for left-to-right and the right edge for @@ -167,12 +167,12 @@ interface XSimpleCanvas: com::sun::star::uno::XInterface rendering to such a device. This includes device resolution, color space, or bitmap formats.<p> - @return the associated <type>XGraphicDevice</type>. + @return the associated XGraphicDevice. */ XGraphicDevice getDevice(); - /** Query the underlying <type>XCanvas</type>.<p> + /** Query the underlying XCanvas.<p> @return the canvas interface this object is internally based on. diff --git a/offapi/com/sun/star/rendering/XSprite.idl b/offapi/com/sun/star/rendering/XSprite.idl index c9d5ee12b960..5db147915ce7 100644 --- a/offapi/com/sun/star/rendering/XSprite.idl +++ b/offapi/com/sun/star/rendering/XSprite.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module rendering { /** Interface to control a sprite object.<p> This is the basic interface to control a sprite object on a - <type>XSpriteCanvas</type>. Sprites are moving, back-buffered + XSpriteCanvas. Sprites are moving, back-buffered objects.<p> */ interface XSprite : ::com::sun::star::uno::XInterface @@ -41,7 +41,7 @@ interface XSprite : ::com::sun::star::uno::XInterface This method is useful for e.g. fading in/out of animations.<p> Please note that if this sprite is not animated, the - associated <type>XSpriteCanvas</type> does not update changed + associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> @@ -49,7 +49,7 @@ interface XSprite : ::com::sun::star::uno::XInterface New global alpha value to composite this sprite with the background. Valid range is [0,1]. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if nAlpha is not within the permissible range. */ void setAlpha( [in] double nAlpha ) @@ -64,7 +64,7 @@ interface XSprite : ::com::sun::star::uno::XInterface coordinates) of the rendered sprite content.<p> Please note that if this sprite is not animated, the - associated <type>XSpriteCanva</type> does not update changed sprites + associated XSpriteCanva does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> @@ -77,7 +77,7 @@ interface XSprite : ::com::sun::star::uno::XInterface @param aRenderState The render state to be used when interpreting aNewPos. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the view and render state parameters are outside the specified range. */ @@ -97,19 +97,19 @@ interface XSprite : ::com::sun::star::uno::XInterface cached representation of the sprite at hand, to transform only this cached representation (e.g. a bitmap), instead of re-rendering the sprite from first principles. This is usually - the case for an implementation of a <type>XCustomSprite</type> + the case for an implementation of a XCustomSprite interface, since it typically has no other cached pictorial information at hand.<p> Please note that if this sprite is not animated, the - associated <type>XSpriteCanvas</type> does not update changed + associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> @param aTransformation The transformation to apply to the sprite shape. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the given transformation matrix is singular. */ void transform( [in] com::sun::star::geometry::AffineMatrix2D aTransformation ) @@ -129,11 +129,11 @@ interface XSprite : ::com::sun::star::uno::XInterface clip-output only this cached representation (e.g. a bitmap), instead of re-rendering the sprite from first principles. This is usually the case for an implementation of a - <type>XCustomSprite</type> interface, since it typically has + XCustomSprite interface, since it typically has no other cached pictorial information at hand.<p> Please note that if this sprite is not animated, the - associated <type>XSpriteCanvas</type> does not update changed + associated XSpriteCanvas does not update changed sprites automatically, but has to be told to do so via <member>XSpriteCanvas::updateScreen()</member>.<p> diff --git a/offapi/com/sun/star/rendering/XSpriteCanvas.idl b/offapi/com/sun/star/rendering/XSpriteCanvas.idl index 26cb5ce5de42..53b9fa5696a0 100644 --- a/offapi/com/sun/star/rendering/XSpriteCanvas.idl +++ b/offapi/com/sun/star/rendering/XSpriteCanvas.idl @@ -67,11 +67,11 @@ interface XSpriteCanvas : XBitmapCanvas aligned. @param interpolationMode - Value of <type>InterpolationMode</type>, to determine whether + Value of InterpolationMode, to determine whether and how to interpolate between the provided bitmaps, if animation runs fast enough. - @throws <type>VolatileContentDestroyedException</type> + @throws VolatileContentDestroyedException if at least one of the bitmap is volatile, and its content has been destroyed by the system. */ XAnimatedSprite createSpriteFromBitmaps( [in] sequence<XBitmap> animationBitmaps, [in] byte interpolationMode ) diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index 83ff2e4df701..1296acc7284d 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -47,7 +47,7 @@ interface XPolyPolygon2D; or <member>XTextLayout::applyLogicalAdvancements()</member> are likely to change subsequent output of those query methods.<p> - Similar to <type>XCanvasFont</type>, all measurements and + Similar to XCanvasFont, all measurements and coordinates accepted and returned by this interface are relative to the font's local coordinate system (which only equals device coordinate space, if the combined render transformation used @@ -67,9 +67,9 @@ interface XTextLayout : ::com::sun::star::uno::XInterface /** Extract the polygonal shapes of the layouted text.<p> Each glyph is represented by a separate - <type>XPolyPolygon2D</type> in the returned sequence.<p> + XPolyPolygon2D in the returned sequence.<p> - @returns a sequence of <type>XPolyPolygon2D</type> in font + @returns a sequence of XPolyPolygon2D in font coordinate space, one for every glyph. */ sequence<XPolyPolygon2D> queryTextShapes(); @@ -80,7 +80,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface Ink, or tight bounding boxes in this case means that for e.g. an "a", the bounding box for the - <type>XPolyPolygon2D</type> describing the glyph "a" is + XPolyPolygon2D describing the glyph "a" is returned, not the logical dimensions of the character in the font.<p> @@ -121,7 +121,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface the layout via <member>XTextLayout::applyLogicalAdvancements()</member>.<p> - @returns a sequence of <type>double</type> specifying the + @returns a sequence of double specifying the advancements per character in font coordinate space. @see <member>XTextLayout::applyLogicalAdvancements()</member> @@ -145,7 +145,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @see <member>XTextLayout::queryLogicalAdvancements()</member> - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if the size of aAdvancements does not match the number of characters in the text. */ @@ -167,7 +167,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface /** Justify the text to the given size.<p> - This method is the core of the <type>XTextLayout</type> + This method is the core of the XTextLayout interface, because it layouts the text in a typographically correct way into the available space.<p> @@ -183,7 +183,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface justification algorithm could compress the text, this value might even be significantly larger than nSize. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if nSize is 0 or negative. */ double justify( [in] double nSize ) @@ -208,7 +208,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @param nSize The requested size of the text for <em>all</em> - <type>XTextLayout</type>s after justification in font + XTextLayouts after justification in font coordinate space (either width or height, depending on the writing mode). @@ -219,7 +219,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface justification algorithm could compress the text, this value might even be significantly larger than nSize. - @throws <type>com::sun::star::lang::IllegalArgumentException</type> + @throws com::sun::star::lang::IllegalArgumentException if one of the parameters are not in the valid range. */ double combinedJustify( [in] sequence< XTextLayout > aNextLayouts, [in] double nSize ) @@ -256,7 +256,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @returns the generated Caret structure. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if nInsertionIndex is outside the permissible range. */ Caret getCaret( [in] long nInsertionIndex, @@ -280,7 +280,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @returns the new insertion index. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if nStartIndex or nCaretAdvancement is outside the permissible range. */ @@ -304,7 +304,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @return the highlight polygon in the font coordinate space. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if nStartIndex or nEndIndex are outside the permissible range. */ @@ -329,7 +329,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface @return the highlight polygon in the font coordinate space. - @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if nStartIndex or nEndIndex are outside the permissible range. */ diff --git a/offapi/com/sun/star/report/XFunction.idl b/offapi/com/sun/star/report/XFunction.idl index 08f5808a9dba..8c961f5c1205 100644 --- a/offapi/com/sun/star/report/XFunction.idl +++ b/offapi/com/sun/star/report/XFunction.idl @@ -37,7 +37,7 @@ interface XFunction interface com::sun::star::lang::XComponent; /** allows the navigation to the functions object. - The method setParent from <type>XChild</type> is not supported and will throw an exception when called. + The method setParent from XChild is not supported and will throw an exception when called. */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/report/XFunctions.idl b/offapi/com/sun/star/report/XFunctions.idl index 2332d3bca636..cc299cbe9976 100644 --- a/offapi/com/sun/star/report/XFunctions.idl +++ b/offapi/com/sun/star/report/XFunctions.idl @@ -39,12 +39,12 @@ interface XFunctions */ interface com::sun::star::container::XContainer; /** gives access to the group elements. - The elements are of type <type>XFunction</type>. + The elements are of type XFunction. */ interface com::sun::star::container::XIndexContainer; /** allows the navigation to the report or group object. - The method setParent from <type>XChild</type> is not supported and will throw an exception when called. + The method setParent from XChild is not supported and will throw an exception when called. */ interface com::sun::star::container::XChild; @@ -52,7 +52,7 @@ interface XFunctions */ interface com::sun::star::lang::XComponent; - /** factory method for <type>XFunction</type>. + /** factory method for XFunction. */ com::sun::star::report::XFunction createFunction(); }; diff --git a/offapi/com/sun/star/report/XGroup.idl b/offapi/com/sun/star/report/XGroup.idl index 65285cf820e9..20962b632ea3 100644 --- a/offapi/com/sun/star/report/XGroup.idl +++ b/offapi/com/sun/star/report/XGroup.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module report { -/** identifies a <type>XGroup</type>. +/** identifies a XGroup. A group is always a child of the groups collection in the report. @see XReportDefinition @see XGroups diff --git a/offapi/com/sun/star/report/XGroups.idl b/offapi/com/sun/star/report/XGroups.idl index e8eae2d4b50d..02784eeea5c6 100644 --- a/offapi/com/sun/star/report/XGroups.idl +++ b/offapi/com/sun/star/report/XGroups.idl @@ -38,7 +38,7 @@ interface XGroups */ interface com::sun::star::container::XContainer; /** gives access to the group elements. - The elements are of type <type>XGroup</type>. + The elements are of type XGroup. */ interface com::sun::star::container::XIndexContainer; @@ -50,7 +50,7 @@ interface XGroups */ interface com::sun::star::lang::XComponent; - /** factory method for <type>XGroup</type>. + /** factory method for XGroup. */ com::sun::star::report::XGroup createGroup(); diff --git a/offapi/com/sun/star/report/XImageControl.idl b/offapi/com/sun/star/report/XImageControl.idl index 0bb3ca9fca32..3f8e9baf666d 100644 --- a/offapi/com/sun/star/report/XImageControl.idl +++ b/offapi/com/sun/star/report/XImageControl.idl @@ -39,7 +39,7 @@ interface XImageControl at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with the binary data of the image.<br/> - Usually, controls acting for an <type>ImageControl</type> model are consumers, and use the + Usually, controls acting for an ImageControl model are consumers, and use the data stream to display the image</p> */ interface com::sun::star::form::XImageProducerSupplier; diff --git a/offapi/com/sun/star/report/XReportDefinition.idl b/offapi/com/sun/star/report/XReportDefinition.idl index 9d6570080975..6a70ed7d966a 100644 --- a/offapi/com/sun/star/report/XReportDefinition.idl +++ b/offapi/com/sun/star/report/XReportDefinition.idl @@ -48,7 +48,7 @@ published interface XConnection; interface XSection; interface XGroups; -/** identifies a <type>XReportComponent</type> as being a (sub-) report. +/** identifies a XReportComponent as being a (sub-) report. <p>This interface does not really provide an own functionality, it is only for easier runtime identification of report components.</p> @@ -196,7 +196,7 @@ interface XReportDefinition <p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p> <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member> - are specified, a <type>RowSet</type> can be created with this information. If the results provided by the + are specified, a RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used.</p> <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified diff --git a/offapi/com/sun/star/report/XReportEngine.idl b/offapi/com/sun/star/report/XReportEngine.idl index e87969ebd182..10be29895995 100644 --- a/offapi/com/sun/star/report/XReportEngine.idl +++ b/offapi/com/sun/star/report/XReportEngine.idl @@ -32,7 +32,7 @@ #include <com/sun/star/uno/Exception.idl> module com { module sun { module star { module report { -/** identifies a <type>XReportEngine</type> which allows the creation of OpenDocument files. +/** identifies a XReportEngine which allows the creation of OpenDocument files. <p>The following events are supported by the report engine. OnPageStarted Is fired when a new page started. diff --git a/offapi/com/sun/star/report/XSection.idl b/offapi/com/sun/star/report/XSection.idl index eaf136c6aca2..76a1c9abd368 100644 --- a/offapi/com/sun/star/report/XSection.idl +++ b/offapi/com/sun/star/report/XSection.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module report { interface XGroup; -/** identifies a <type>XSection</type> inside a report. +/** identifies a XSection inside a report. <p>A section acts like a container of report components. This generic construction allows the definition of hierarchies of reports and their diff --git a/offapi/com/sun/star/report/XShape.idl b/offapi/com/sun/star/report/XShape.idl index ea245c3e349d..edcfe887155f 100644 --- a/offapi/com/sun/star/report/XShape.idl +++ b/offapi/com/sun/star/report/XShape.idl @@ -30,7 +30,7 @@ interface XShape { interface XReportControlModel; - /** is used to query or change the ZOrder of this <type>Shape</type>. */ + /** is used to query or change the ZOrder of this Shape. */ [attribute,bound] long ZOrder; /** this property lets you get and set the transformation matrix diff --git a/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl b/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl index ffa985c06f94..aedbb2c9e13d 100644 --- a/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl +++ b/offapi/com/sun/star/report/inspection/DefaultComponentInspectorModel.idl @@ -27,12 +27,12 @@ module com { module sun { module star { module report { module inspection { /** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for - inspecting form components, in particular all components implementing the <type>ReportComponent</type> + inspecting form components, in particular all components implementing the ReportComponent service. - <p>A <type>DefaultComponentInspectorModel</type> provides the following handlers by default: - <ul><li><type>GeometryHandler</type></li> - <li><type>ReportComponentHandler</type></li> + <p>A DefaultComponentInspectorModel provides the following handlers by default: + <ul><li>GeometryHandler</li> + <li>ReportComponentHandler</li> <li><type scope="com::sun::star::form::inspection">EditPropertyHandler</type></li> </ul></p> diff --git a/offapi/com/sun/star/report/meta/XFormulaParser.idl b/offapi/com/sun/star/report/meta/XFormulaParser.idl index d6df0b197dc1..e8c75697547e 100644 --- a/offapi/com/sun/star/report/meta/XFormulaParser.idl +++ b/offapi/com/sun/star/report/meta/XFormulaParser.idl @@ -26,7 +26,7 @@ #include <com/sun/star/sheet/XFormulaOpCodeMapper.idl> #include <com/sun/star/beans/XPropertySet.idl> module com { module sun { module star { module report { module meta { -/** identifies a <type>XFormulaParser</type> which allows to retrieve the meta data of all supported functions. +/** identifies a XFormulaParser which allows to retrieve the meta data of all supported functions. */ interface XFormulaParser diff --git a/offapi/com/sun/star/report/meta/XFunctionCategory.idl b/offapi/com/sun/star/report/meta/XFunctionCategory.idl index 852be6e4cc6c..d01029cf089d 100644 --- a/offapi/com/sun/star/report/meta/XFunctionCategory.idl +++ b/offapi/com/sun/star/report/meta/XFunctionCategory.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module report { module meta { interface XFunctionDescription; -/** identifies a <type>XFunctionCategory</type> which allows to retrieve the meta data of all supported functions. +/** identifies a XFunctionCategory which allows to retrieve the meta data of all supported functions. */ diff --git a/offapi/com/sun/star/report/meta/XFunctionDescription.idl b/offapi/com/sun/star/report/meta/XFunctionDescription.idl index 52f1f5dec32f..30b2f89f748a 100644 --- a/offapi/com/sun/star/report/meta/XFunctionDescription.idl +++ b/offapi/com/sun/star/report/meta/XFunctionDescription.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module report { module meta { interface XFunctionCategory; -/** identifies a <type>XFunctionDescription</type> which allows to retrieve the meta data of all supported functions. +/** identifies a XFunctionDescription which allows to retrieve the meta data of all supported functions. */ interface XFunctionDescription diff --git a/offapi/com/sun/star/report/meta/XFunctionManager.idl b/offapi/com/sun/star/report/meta/XFunctionManager.idl index 41736a54c034..ccfa752c80ec 100644 --- a/offapi/com/sun/star/report/meta/XFunctionManager.idl +++ b/offapi/com/sun/star/report/meta/XFunctionManager.idl @@ -27,7 +27,7 @@ #include <com/sun/star/report/meta/XFunctionDescription.idl> module com { module sun { module star { module report { module meta { -/** identifies a <type>XFunctionManager</type> which allows to retrieve the meta data of all supported functions. +/** identifies a XFunctionManager which allows to retrieve the meta data of all supported functions. */ interface XFunctionManager diff --git a/offapi/com/sun/star/resource/OfficeResourceLoader.idl b/offapi/com/sun/star/resource/OfficeResourceLoader.idl index 94e1e82556a5..cd95fde87784 100644 --- a/offapi/com/sun/star/resource/OfficeResourceLoader.idl +++ b/offapi/com/sun/star/resource/OfficeResourceLoader.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module resource { -/** describes a <type>XResourceBundleLoader</type> which provides access to the OpenOffice.org +/** describes a XResourceBundleLoader which provides access to the OpenOffice.org resource files. <p>An OpenOffice.org installation comes with a number of resource files in an proprietary - format, located inside the installation's program/resource directory. The <type>OfficeResoureLoader</type> + format, located inside the installation's program/resource directory. The OfficeResoureLoader singleton (available at a component context as value with the key <code>/singletons/com.sun.star.resource.OfficeResourceLoader</code>), provides access to some types of resources within those files.</p> @@ -39,7 +39,7 @@ module com { module sun { module star { module resource { resource file naming conventions, and look up the respective resource file, for the requested locale, in OpenOffice.org's installation.</p> - <p>The lookup process uses the fallback mechanism as described at the <type>XResourceBundle</type> interface, + <p>The lookup process uses the fallback mechanism as described at the XResourceBundle interface, except that <code>Locale.getDefault()</code> is not used.</p> <p>Resource keys, as passed to the <member>XResourceBundle::getDirectElement</member> or @@ -55,7 +55,7 @@ module com { module sun { module star { module resource { </p> <p>Since the numeric resource identifiers are highly build-dependent (e.g. can change with any next - OpenOffice.org build), you are <strong>strongly</strong> discouraged from using the <type>OfficeResoureLoader</type> + OpenOffice.org build), you are <strong>strongly</strong> discouraged from using the OfficeResoureLoader service in a component which targets more than one particular OpenOffice.org build.</p> @since OOo 2.0.3 diff --git a/offapi/com/sun/star/resource/XResourceBundle.idl b/offapi/com/sun/star/resource/XResourceBundle.idl index 899a0daed301..fa50b6d1ecfa 100644 --- a/offapi/com/sun/star/resource/XResourceBundle.idl +++ b/offapi/com/sun/star/resource/XResourceBundle.idl @@ -80,7 +80,7 @@ module com { module sun { module star { module resource { When your program needs a locale-specific object, it loads the <code>XResourceBundle</code> implementation using the - <type>XResourceBundleLoader</type> service: + XResourceBundleLoader service: <listing> XResourceBundle myResources = xLoader.getBundle("MyResources", currentLocale); diff --git a/offapi/com/sun/star/resource/XResourceBundleLoader.idl b/offapi/com/sun/star/resource/XResourceBundleLoader.idl index b531a6b80c81..fa25531647c1 100644 --- a/offapi/com/sun/star/resource/XResourceBundleLoader.idl +++ b/offapi/com/sun/star/resource/XResourceBundleLoader.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module resource { /** makes it possible to load resource bundles. <p>The search algorithm is specified in the documentation of - <type>XResourceBundle</type>. The implementations must follow + XResourceBundle. The implementations must follow the name scheme, but it is allowed to search in several locations. @see MissingResourceException diff --git a/offapi/com/sun/star/resource/XStringResourcePersistence.idl b/offapi/com/sun/star/resource/XStringResourcePersistence.idl index 237d2d72588f..386efaeddb2c 100644 --- a/offapi/com/sun/star/resource/XStringResourcePersistence.idl +++ b/offapi/com/sun/star/resource/XStringResourcePersistence.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module resource { basic persistence functionality limited to operations that are independent from a associated location or storage. - @see <type>XStringResourceManager</type>. + @see XStringResourceManager. */ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceManager { @@ -43,17 +43,17 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM in a single file following the format of Java properties files. This interface is supported by the services - <type>StringResourceWithLocation</type> and - <type>StringResourceWithStorage</type> + StringResourceWithLocation and + StringResourceWithStorage The StringResourceWithLocation is initialized with an URL specifying a location used to load data from and store data to, - see <type>StringResourceWithLocation</type>. + see StringResourceWithLocation. The StringResourceWithStorage is initialized with an instance of <type scope="com::sun::star::embed">XStorage</type> used to load data from and store data to, - see <type>StringResourceWithStorage</type>. + see StringResourceWithStorage. If the string table isn't modified (see <member>isModified</member>) this method does nothing. @@ -65,7 +65,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM not handled by a previously specified <type scope="com::sun::star::task">XInteractionHandler</type>. The handler to be used for the store operation can be specified - during initialization of <type>StringResourceWithLocation</type>. + during initialization of StringResourceWithLocation. @throws <type scope="com::sun::star::lang">NoSupportException</type> if no URL or no valid storage are provided. @@ -92,8 +92,8 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM This interface method can be used to overwrite the comment used during initialization of the services - <type>StringResourceWithLocation</type> or - <type>StringResourceWithStorage</type> + StringResourceWithLocation or + StringResourceWithStorage @param Comment Comment stored first in each properties file followed by a line @@ -109,9 +109,9 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM Stores all string table data to the provided storage. Calling this method does not affect the association with a location - (in case of a <type>StringResourceWithLocation</type> instance) + (in case of a StringResourceWithLocation instance) respectively with a storage (in case of a - <type>StringResourceWithStorage</type> instance). + StringResourceWithStorage instance). The modified state isn't affected either. This method can be used to make a copy of the current string @@ -147,9 +147,9 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM passed URL string. Calling this method does not affect the association with a location - (in case of a <type>StringResourceWithLocation</type> instance) + (in case of a StringResourceWithLocation instance) respectively with a storage (in case of a - <type>StringResourceWithStorage</type> instance). + StringResourceWithStorage instance). The modified state isn't affected either. This method can be used to make a copy of the current string diff --git a/offapi/com/sun/star/resource/XStringResourceWithLocation.idl b/offapi/com/sun/star/resource/XStringResourceWithLocation.idl index 3b075d5d0b59..c2f4d3e585c0 100644 --- a/offapi/com/sun/star/resource/XStringResourceWithLocation.idl +++ b/offapi/com/sun/star/resource/XStringResourceWithLocation.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module resource { /** - Extends <type>XStringResourcePersistence</type> by methods to handle an + Extends XStringResourcePersistence by methods to handle an associated location. - @see <type>XStringResourcePersistence</type>. + @see XStringResourcePersistence. */ interface XStringResourceWithLocation: com::sun::star::resource::XStringResourcePersistence { diff --git a/offapi/com/sun/star/resource/XStringResourceWithStorage.idl b/offapi/com/sun/star/resource/XStringResourceWithStorage.idl index 2aa203c926e1..9529dc71f621 100644 --- a/offapi/com/sun/star/resource/XStringResourceWithStorage.idl +++ b/offapi/com/sun/star/resource/XStringResourceWithStorage.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module resource { /** - Extends <type>XStringResourcePersistence</type> by methods to handle an + Extends XStringResourcePersistence by methods to handle an associated <type scope="com::sun::star::embed">XStorage</type> instance. - @see <type>XStringResourcePersistence</type>. + @see XStringResourcePersistence. */ interface XStringResourceWithStorage: com::sun::star::resource::XStringResourcePersistence { diff --git a/offapi/com/sun/star/scanner/XScannerManager2.idl b/offapi/com/sun/star/scanner/XScannerManager2.idl index e48a2cc59e0c..b7d53e44f2b9 100644 --- a/offapi/com/sun/star/scanner/XScannerManager2.idl +++ b/offapi/com/sun/star/scanner/XScannerManager2.idl @@ -17,7 +17,7 @@ module com { module sun { module star { module scanner { /** - Extension of <type>XScannerManager</type>. + Extension of XScannerManager. @since LibreOffice 3.5 */ diff --git a/offapi/com/sun/star/script/XLibraryContainer2.idl b/offapi/com/sun/star/script/XLibraryContainer2.idl index e533be323895..139ab02c46eb 100644 --- a/offapi/com/sun/star/script/XLibraryContainer2.idl +++ b/offapi/com/sun/star/script/XLibraryContainer2.idl @@ -27,7 +27,7 @@ /** - Extension of <type>XLibraryContainer</type> to provide additional information + Extension of XLibraryContainer to provide additional information about the libraries contained in a library container */ published interface XLibraryContainer2: com::sun::star::script::XLibraryContainer diff --git a/offapi/com/sun/star/script/XLibraryContainer3.idl b/offapi/com/sun/star/script/XLibraryContainer3.idl index e065614595a1..6d522cf3649b 100644 --- a/offapi/com/sun/star/script/XLibraryContainer3.idl +++ b/offapi/com/sun/star/script/XLibraryContainer3.idl @@ -27,7 +27,7 @@ /** - Extension of <type>XLibraryContainer2</type>. + Extension of XLibraryContainer2. */ published interface XLibraryContainer3: com::sun::star::script::XLibraryContainer2 { diff --git a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl index 40e94e4afaa7..28e37b1dabc7 100644 --- a/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl +++ b/offapi/com/sun/star/script/XStorageBasedLibraryContainer.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module script { -/** is the interface for an <type>XLibraryContainer</type> which can be made +/** is the interface for an XLibraryContainer which can be made persistent in an <type scope="com::sun::star::embed">XStorage</type>. <p>A persistent library container is associated with a root storage. The @@ -61,7 +61,7 @@ interface XStorageBasedLibraryContainer /** stores the libraries to a storage other than the current container storage <p>Note that the library container is not automatically associated with the - new root storage. Instead, you need to manually set the <type>RootStroage</type> + new root storage. Instead, you need to manually set the RootStroage attribute afterwards. This separation allows for Save-To as well Save-As operations.</p> diff --git a/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl b/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl index 69ec50872f84..e0f14739b734 100644 --- a/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl +++ b/offapi/com/sun/star/script/vba/XVBAEventProcessor.idl @@ -36,7 +36,7 @@ interface XVBAEventProcessor /** Returns whether a VBA event handler exists. @param nEventId - The identifier of the event. Must be a constant from <type>VBAEventId</type>. + The identifier of the event. Must be a constant from VBAEventId. @param aArgs Additional arguments needed to identify some event handlers, e.g. a @@ -56,7 +56,7 @@ interface XVBAEventProcessor /** Executes a VBA event handler. @param nEventId - The identifier of the event. Must be a constant from <type>VBAEventId</type>. + The identifier of the event. Must be a constant from VBAEventId. @param aArgs The input arguments needed to create the argument list of the VBA diff --git a/offapi/com/sun/star/sdb/BooleanComparisonMode.idl b/offapi/com/sun/star/sdb/BooleanComparisonMode.idl index d8e63d7fc175..0234e736ec6e 100644 --- a/offapi/com/sun/star/sdb/BooleanComparisonMode.idl +++ b/offapi/com/sun/star/sdb/BooleanComparisonMode.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sdb { /** specifies different mode how boolean comparison predicates are to be generated - by a <type>SingleSelectQueryComposer</type>. + by a SingleSelectQueryComposer. */ constants BooleanComparisonMode { diff --git a/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl b/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl index 4b99e3e2a0c9..dfaa66af893d 100644 --- a/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl +++ b/offapi/com/sun/star/sdb/ColumnDescriptorControlModel.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module sdb { -/** specifies the standard model of an <type>ColumnDescriptorControl</type>. +/** specifies the standard model of an ColumnDescriptorControl. */ service ColumnDescriptorControlModel { diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl index 59b308f2cdd1..066894d750c5 100644 --- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl +++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module sdb { The <code>DataAccessDescriptor</code> describes the super set of the properties for the most common data access objects.</p> - <p>Every component providing or requiring a <type>DataAccessDescriptor</type> for some functionality + <p>Every component providing or requiring a DataAccessDescriptor for some functionality is urged to specify which properties are mandatory, and which ones optional. Additionally, it's free to specify any additional requirements about the relations of properties.</p> @@ -46,7 +46,7 @@ published service DataAccessDescriptor { /** specifies the name of the datasource to access. - <p>This data source is usually used to create a <type>Connection</type>. If no DataSourceName is given + <p>This data source is usually used to create a Connection. If no DataSourceName is given and the <member>DatabaseLocation</member> and the <member>ConnectionResource</member> are empty, then an <member>ActiveConnection</member> is required.</p> @@ -57,7 +57,7 @@ published service DataAccessDescriptor /** specifies the URL of the database file. - <p>This database location is usually used to create a <type>Connection</type>. If no DatabaseLocation is given + <p>This database location is usually used to create a Connection. If no DatabaseLocation is given and the <member>ConnectionResource</member> is empty, then an <member>ActiveConnection</member> is required.</p> @see com::sun::star::sdb::DatabaseContext @@ -67,7 +67,7 @@ published service DataAccessDescriptor /** specifies the database URL which locates a database driver. - <p>This database URL is usually used to create a <type>Connection</type>. If no ConnectionResource is given, + <p>This database URL is usually used to create a Connection. If no ConnectionResource is given, then an <member>ActiveConnection</member> is required.</p> @see com::sun::star::sdb::DatabaseContext @@ -89,10 +89,10 @@ published service DataAccessDescriptor /** is a connection to use. <p>This object is guaranteed to be a <type scope="com::sun::star::sdbc">Connection</type>, but usually - it will be a <type>Connection</type> from the module com::sun::star::sdb.<br/> + it will be a Connection from the module com::sun::star::sdb.<br/> Especially in the case where no <member>DataSourceName</member> is given, but <member>CommandType</member> is <member>CommandType::QUERY</member>, the ActiveConnection needs - to fully support the <type>Connection</type> service, to actually retrieve the query specified by + to fully support the Connection service, to actually retrieve the query specified by <member>Command</member></p> <p>If no ActiveConnection is given, then a <member>DataSourceName</member> is required.</p> @@ -128,7 +128,7 @@ published service DataAccessDescriptor <code>WHERE</code>-string itself.</p> <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member> - are specified, a <type>RowSet</type> can be created with this information. If the results provided by the + are specified, a RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used.</p> <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified @@ -241,7 +241,7 @@ published service DataAccessDescriptor with the <member>ColumnName</member> property.</p> <p>The object will at least support the <type scope="com::sun::star::sdbcx">Column</type> service, but more - often it will even be a <type>Column</type> from the com::sun::star::sdb module.</p> + often it will even be a Column from the com::sun::star::sdb module.</p> */ [optional, property] com::sun::star::beans::XPropertySet Column; }; diff --git a/offapi/com/sun/star/sdb/DataSource.idl b/offapi/com/sun/star/sdb/DataSource.idl index de6ab1e7b425..6944d7604551 100644 --- a/offapi/com/sun/star/sdb/DataSource.idl +++ b/offapi/com/sun/star/sdb/DataSource.idl @@ -58,7 +58,7 @@ published service DataSource interface XCompletedConnection; /** useful for establishing isolated connections which are not shared among others - as it is the case when using <type>XCompletedConnection</type> or <type scope="com::sun::star::sdbc">XDataSource</type>. + as it is the case when using XCompletedConnection or <type scope="com::sun::star::sdbc">XDataSource</type>. @see XCompletedConnection @see com::sun::star::sdbc::XDataSource @since OOo 1.1.2 @@ -119,7 +119,7 @@ published service DataSource /** is a list of arbitrary string tag/value pairs as connection arguments - <p>The <type>DataSource</type> itself does not attempt to interpret any of those values.</p> + <p>The DataSource itself does not attempt to interpret any of those values.</p> <p>Instead, the values in this property have two use cases: <ul><li>Upon creating a connection, for every value in this sequence it's checked diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index fdd4519930cb..8cab0c7c8d9b 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -118,7 +118,7 @@ module com { module sun { module star { module sdb { </li> </ul> </p> - <p>For all kinds of URLs, the parameters supplied during dispatching build up a <type>DataAccessDescriptor</type>, + <p>For all kinds of URLs, the parameters supplied during dispatching build up a DataAccessDescriptor, where the following properties are present: <ul> <li><member>DataAccessDescriptor::DataSourceName</member></li> @@ -176,11 +176,11 @@ published service DataSourceBrowser plug the browser component into.</li> <li><b>DataSourceName</b><br/> - The name of the globally registered <type>DataSource</type> to be used for initial display. It is only + The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display.</li> <li><b>CommandType</b><br/> - This has to be a <type>CommandType</type> value, specifying the type of the object to display initially. + This has to be a CommandType value, specifying the type of the object to display initially. It is only meaningful together with the <em>DataSourceName</em> and the <em>Command</em> parameters.</li> <li><b>Command</b><br/> diff --git a/offapi/com/sun/star/sdb/DefinitionContent.idl b/offapi/com/sun/star/sdb/DefinitionContent.idl index d51333bbb201..263628ec7095 100644 --- a/offapi/com/sun/star/sdb/DefinitionContent.idl +++ b/offapi/com/sun/star/sdb/DefinitionContent.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { /** defines the basic functionality for an object in the hierarchy of sub documents - of a <type>OfficeDatabaseDocument</type>. + of a OfficeDatabaseDocument. @see DocumentDefinition @see DocumentContainer diff --git a/offapi/com/sun/star/sdb/DocumentDefinition.idl b/offapi/com/sun/star/sdb/DocumentDefinition.idl index 26d226fb0d17..c4f7ca780109 100644 --- a/offapi/com/sun/star/sdb/DocumentDefinition.idl +++ b/offapi/com/sun/star/sdb/DocumentDefinition.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sdb { interface XSubDocument; -/** specifies a sub document of a <type>OfficeDatabaseDocument</type>. +/** specifies a sub document of a OfficeDatabaseDocument. <p>Usual instances of a <code>DocumentDefinition</code> are forms and reports.</p> diff --git a/offapi/com/sun/star/sdb/ErrorCondition.idl b/offapi/com/sun/star/sdb/ErrorCondition.idl index 2b8c2796f163..b0e175a7f0d1 100644 --- a/offapi/com/sun/star/sdb/ErrorCondition.idl +++ b/offapi/com/sun/star/sdb/ErrorCondition.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module sdb { wherever possible.<br/> That is, if an <code>SQLException</code> is raised by such a component, caused by an error condition which is included in the - <type>ErrorCondition</type> group, then the respective <em>negative</em> value + ErrorCondition group, then the respective <em>negative</em> value will be used as <code>ErrorCode</code>.</p> <p>This allows to determine specific error conditions in your client code, and @@ -60,10 +60,10 @@ constants ErrorCondition { // = section ROW_SET - css.sdb.RowSet related error conditions - /** is used by and <type>RowSet</type> to indicate that an operation has been vetoed + /** is used by and RowSet to indicate that an operation has been vetoed by one of its approval listeners - <p>This error condition results in raising a <type>RowSetVetoException</type>.</p> + <p>This error condition results in raising a RowSetVetoException.</p> @see RowSet @see XRowSetApproveBroadcaster @see XRowSetApproveListener @@ -77,7 +77,7 @@ constants ErrorCondition <p>Imagine you have a client-side query <code>SELECT * FROM table</code>, which is saved as "query1". Additionally, there is a query "query2" defined as <code>SELECT * FROM query1</code>. Now if you try to change the statement of - <type>query1</type> to <code>SELECT * FROM query2</code>, this is prohibited, because + query1 to <code>SELECT * FROM query2</code>, this is prohibited, because it would lead to a cyclic sub query. */ const long PARSER_CYCLIC_SUB_QUERIES = 200; diff --git a/offapi/com/sun/star/sdb/InteractionHandler.idl b/offapi/com/sun/star/sdb/InteractionHandler.idl index 3c69f3bfebea..32f7b21bc62d 100644 --- a/offapi/com/sun/star/sdb/InteractionHandler.idl +++ b/offapi/com/sun/star/sdb/InteractionHandler.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module sdb { Do not use this service anymore. Instead, create a generic <type scope="com::sun::star::task">InteractionHandler</type> instance, and pass it your request. It will determine, based on configuration data, which concrete interaction handler implementation to use for a specific request. In particular, requests formerly server by this service here - are by default passed to a <type>DatabaseInteractionHandler</type>. + are by default passed to a DatabaseInteractionHandler. */ published service InteractionHandler: com::sun::star::task::XInteractionHandler; diff --git a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl index 7827abe34d16..748eff82f22a 100644 --- a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl @@ -36,9 +36,9 @@ module com { module sun { module star { module sdb { <ul> <li>forms</li> <li>reports</li> - <li>The table settings defined in <type>DataSettings</type></li> - <li>The query settings defined in <type>DataSettings</type></li> - <li>All properties of the service <type>DataSource</type></li> + <li>The table settings defined in DataSettings</li> + <li>The query settings defined in DataSettings</li> + <li>All properties of the service DataSource</li> </ul></p> @see com::sun::star::sdb::XOfficeDatabaseDocument @@ -77,7 +77,7 @@ service OfficeDatabaseDocument <li>calling <code>XLoadable::load</code></li> <li>calling <code>XStorable::storeAsURL</code></li> </ul> - The third option was added for compatibility reasons, since a <type>DatabaseDocument</type> + The third option was added for compatibility reasons, since a DatabaseDocument in earlier versions of OpenOffice.org did not support the <code>XLoadable</code> interface, so the usual way of creating a document from scratch was to create it, set properties as needed, and store it.</p> @@ -206,7 +206,7 @@ service OfficeDatabaseDocument /** implements life time control - <p>Whoever retrieves a <type>OfficeDatabaseDocument</type> should be aware of + <p>Whoever retrieves a OfficeDatabaseDocument should be aware of life time issues, since a document needs to be closed when nobody needs it anymore.</p> <p>This implies that clients of a document need to ensure that as soon as they don't diff --git a/offapi/com/sun/star/sdb/QueryDesign.idl b/offapi/com/sun/star/sdb/QueryDesign.idl index 1d57694455b5..acc7e533f7a9 100644 --- a/offapi/com/sun/star/sdb/QueryDesign.idl +++ b/offapi/com/sun/star/sdb/QueryDesign.idl @@ -70,7 +70,7 @@ module com { module sun { module star { module sdb { </li> <li><a name="data_source"></a><b>DataSourceName</b><br/> - specifies the name of the globally registered <type>DataSource</type> for which a query, view, or SQL + specifies the name of the globally registered DataSource for which a query, view, or SQL command is to be designed.<br/> The DataSourceName may be omitted if and only if a valid <a href="#active_connection">ActiveConnection</a> parameter is present.<br/> diff --git a/offapi/com/sun/star/sdb/RelationDesign.idl b/offapi/com/sun/star/sdb/RelationDesign.idl index bae01918b009..3b14141e9262 100644 --- a/offapi/com/sun/star/sdb/RelationDesign.idl +++ b/offapi/com/sun/star/sdb/RelationDesign.idl @@ -61,7 +61,7 @@ published service RelationDesign RelationDesign component into. </li> <li><b>DataSourceName</b><br> - The name of the globally registered <type>DataSource</type> to be used for initial display. It is only + The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display. </li> </ul> diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index f8e45ed74519..3c2d1794b93c 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -148,9 +148,9 @@ published interface XParametersSupplier; <h3>Deletions</h3> <p>Via <member scope="com::sun::star::sdbc">XResultSetUpdate::deleteRow</member>, you can delete the current row of a - <type>RowSet</type>. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to + RowSet. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to <member scope="com::sun::star::sdbc">XResultSet::rowDeleted</member> will return <TRUE/>. The deleted row "vanishes" from - the <type>RowSet</type> as soon as the cursor is moved away from it.<br/> + the RowSet as soon as the cursor is moved away from it.<br/> As a consequence, the behavior of several other methods is affected:<br/> <dl> <dt><member scope="com::sun::star::sdbc">XResultSet::getRow</member></dt> @@ -161,7 +161,7 @@ published interface XParametersSupplier; <dd>will let the deleted row vanish from the result set. As a consequence, the <member>RowCount</member> will decrease when you do such a move operation after deleting a row.<br/> A special case to note is the <code>next<code> call: When you delete row, say, - <code>15</code>, followed by <code>next</code>, then your <type>RowSet</type> afterwards + <code>15</code>, followed by <code>next</code>, then your RowSet afterwards still is on row 15, since the deleted row vanished with the move operation.</dd> <dt><member scope="com::sun::star::sdbc">XResultSet::refreshRow</member></dt> @@ -199,7 +199,7 @@ published service RowSet <p>If you want a row set to be based on a parametrized query, you will usually use the <type scope="com::sun::star::sdbc">XParameters</type> interface.<br/> However, you can also choose to let an interaction handler supply such data. For this, you may - for instance instantiate an <type>InteractionHandler</type>, which asks the user for the + for instance instantiate an InteractionHandler, which asks the user for the data, or you may write your own one, which supplies the data from somewhere else. The default implementation will only ask for parameters which aren't set before through the <type scope="com::sun::star::sdbc">XParameters</type> interface.</p> @@ -220,11 +220,11 @@ published service RowSet <p>The optional support of this interface is already implied with the support of the <type scope="com::sun::star::sdbc">ResultSet</type> service.</p> - <p>However, note that the additional support of the <type>XRowSetApproveBroadcaster</type> interface results + <p>However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the methods <member scope="com::sun::star::sdbc">XResultSetUpdate::insertRow</member>, <member scope="com::sun::star::sdbc">XResultSetUpdate::updateRow</member> and <member scope="com::sun::star::sdbc">XResultSetUpdate::deleteRow</member> - will now throw the <type>RowSetVetoException</type> if the action which is to be performed was vetoed - by one of the <type>XRowSetApproveListener</type>'s.</p> + will now throw the RowSetVetoException if the action which is to be performed was vetoed + by one of the XRowSetApproveListener's.</p> */ [optional] interface com::sun::star::sdbc::XResultSetUpdate; @@ -232,10 +232,10 @@ published service RowSet <p>The optional support of this interface is already implied with the support of the <type scope="com::sun::star::sdbcx">ResultSet</type> service.</p> - <p>However, note that the additional support of the <type>XRowSetApproveBroadcaster</type> interface results + <p>However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the method <member scope="com::sun::star::sdbcx">XDeleteRows::deleteRows</member> - will now throw the <type>RowSetVetoException</type> if the deletion was vetoed - by one of the <type>XRowSetApproveListener</type>'s.</p> + will now throw the RowSetVetoException if the deletion was vetoed + by one of the XRowSetApproveListener's.</p> */ [optional] interface com::sun::star::sdbcx::XDeleteRows; diff --git a/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl index 9a085f843f87..3cbd15b9c4b6 100644 --- a/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.idl @@ -52,10 +52,10 @@ service SingleSelectQueryAnalyzer <p>Note that OpenOffice.org since version 2.0.4 also supports queries which are based on other queries. For example, given that you have a database containing a query named <code>All Orders</code>, the SQL statement <code>SELECT * FROM "All Orders"</code> - is perfectly valid when used with a <type>SingleSelectQueryAnalyzer</type>.</p> + is perfectly valid when used with a SingleSelectQueryAnalyzer.</p> <p>In this case, the name container returned by <member scope="com::sun::star::sdbcx">XTablesSupplier::getTables</member> - will in fact not return a <type>Table</type>, but a <type>Query</type> object. Semantically, however, + will in fact not return a Table, but a Query object. Semantically, however, this object still acts as a table in the SQL statement.</p> @see XSingleSelectQueryAnalyzer::getQueryWithSubstitution diff --git a/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl index 26c29b2231bb..a158f0fa5380 100644 --- a/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/SingleSelectQueryComposer.idl @@ -33,7 +33,7 @@ interface XSingleSelectQueryComposer; criteria. To get the new extended statement use the methods from <type scope="com::sun::star::sdb">SingleSelectQueryAnalyzer</type>. </p> - <p>A <type>SingleSelectQueryComposer</type> is usually obtained from a <type>Connection</type> + <p>A SingleSelectQueryComposer is usually obtained from a Connection using the <type scope="com::sun::star::lang">XMultiServiceFactory</type> interface.</p> */ service SingleSelectQueryComposer diff --git a/offapi/com/sun/star/sdb/TableDesign.idl b/offapi/com/sun/star/sdb/TableDesign.idl index 08d5b8500cf0..3c615ad65191 100644 --- a/offapi/com/sun/star/sdb/TableDesign.idl +++ b/offapi/com/sun/star/sdb/TableDesign.idl @@ -61,7 +61,7 @@ published service TableDesign TableDesign component into. </li> <li><b>DataSourceName</b><br> - The name of the globally registered <type>DataSource</type> to be used for initial display. It is only + The name of the globally registered DataSource to be used for initial display. It is only meaningful together with the other parameters specifying the object to display. </li> <li><b>CurrentTable</b><br> diff --git a/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl b/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl index 227294e50323..8c43f8fb0701 100644 --- a/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl +++ b/offapi/com/sun/star/sdb/XDataAccessDescriptorFactory.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module sdb { */ interface XDataAccessDescriptorFactory { - /** creates a <type>DataAccessDescriptor</type> which supports all properties + /** creates a DataAccessDescriptor which supports all properties defined for this service, even if they're normally optional only. */ ::com::sun::star::beans::XPropertySet diff --git a/offapi/com/sun/star/sdb/XDocumentDataSource.idl b/offapi/com/sun/star/sdb/XDocumentDataSource.idl index 2d63888eb982..59e055938263 100644 --- a/offapi/com/sun/star/sdb/XDocumentDataSource.idl +++ b/offapi/com/sun/star/sdb/XDocumentDataSource.idl @@ -33,10 +33,10 @@ */ interface XDocumentDataSource { - /** provides access to the one and only <type>OfficeDatabaseDocument</type> + /** provides access to the one and only OfficeDatabaseDocument which the data source is based on. - <p>The component returned by this attribute is an <type>OfficeDatabaseDocument</type>.</p> + <p>The component returned by this attribute is an OfficeDatabaseDocument.</p> <p>Though there is a 1-to-1 relationship between database documents and data sources, each of the two can exist without its counterpart, but create this counterpart on request diff --git a/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl index 277b265daa00..3f94aeaedaaf 100644 --- a/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/XOfficeDatabaseDocument.idl @@ -45,7 +45,7 @@ interface XOfficeDatabaseDocument */ interface com::sun::star::document::XDocumentSubStorageSupplier; - /** provides access to the one and only <type>DataSource</type> + /** provides access to the one and only DataSource associated with this document */ [readonly, attribute] com::sun::star::sdbc::XDataSource DataSource; diff --git a/offapi/com/sun/star/sdb/XQueriesSupplier.idl b/offapi/com/sun/star/sdb/XQueriesSupplier.idl index 8d789f236d83..509a5e9240ec 100644 --- a/offapi/com/sun/star/sdb/XQueriesSupplier.idl +++ b/offapi/com/sun/star/sdb/XQueriesSupplier.idl @@ -33,10 +33,10 @@ published interface XQueriesSupplier: com::sun::star::uno::XInterface /** returns the container of queries. - <p>The single elements of the container support the <type>Query</type> service.</p> + <p>The single elements of the container support the Query service.</p> @return - the queries belonging to database connection at which the <type>XQueriesSupplier</type> interface + the queries belonging to database connection at which the XQueriesSupplier interface is exposed. */ com::sun::star::container::XNameAccess getQueries(); diff --git a/offapi/com/sun/star/sdb/XRowSetChangeListener.idl b/offapi/com/sun/star/sdb/XRowSetChangeListener.idl index 37e04c5cf69e..24b076087070 100644 --- a/offapi/com/sun/star/sdb/XRowSetChangeListener.idl +++ b/offapi/com/sun/star/sdb/XRowSetChangeListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { /** is implemented by components which want to be notified when the <code>RowSet</code> supplied - by a <type>XRowSetSupplier</type> changes. + by a XRowSetSupplier changes. @see XRowSetChangeBroadcaster @see XRowSetSupplier @@ -35,7 +35,7 @@ module com { module sun { module star { module sdb { */ interface XRowSetChangeListener : ::com::sun::star::lang::XEventListener { - /** notifies the listener that the <code>RowSet</code> associated with a <type>XRowSetSupplier</type> + /** notifies the listener that the <code>RowSet</code> associated with a XRowSetSupplier has changed. */ void onRowSetChanged( [in] ::com::sun::star::lang::EventObject i_Event ); diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index 9e6f0cab8b38..8bd9efc5cb0e 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -153,7 +153,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface /** returns the query previously set at the analyzer, with all application-level features being substituted by their database-level counterparts. - <p>The <type>XSingleSelectQueryAnalyzer</type> is an application-level component, + <p>The XSingleSelectQueryAnalyzer is an application-level component, which in some respect understands SQL features usually not present at the database level. As a prominent example, you might pass a <code>SELECT</code> statement to the analyzer which is based on another query.</p> @@ -166,7 +166,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface <p>For example, consider a database document which contains a client-side query named <code>All Orders</code>. This query is not known to the underlying database, so an SQL statement like <code>SELECT * from "All Orders"</code> would be rejected by the database. However, instantiating - a <type>SingleSelectQueryAnalyzer</type> at the <type>Connection</type> object, and passing it the above query, + a SingleSelectQueryAnalyzer at the Connection object, and passing it the above query, you can then use <code>getQueryWithSubstitution</code> to retrieve a statement where <code>"All Orders"</code> has been replaced with the <code>SELECT</code> statement which actually constitutes the <code>"All Orders"</code> query.</p> diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index 0846fdd28734..e47ddf6f4b41 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -206,11 +206,11 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer clauses.</p> <p>There are various use cases for this. For instance, you might want to use the - statement represented by a <type>QueryDefinition</type>, and extend it with additional + statement represented by a QueryDefinition, and extend it with additional filters or sort orders, while not touching the respective parts already present in <member>QueryDefinition::Command</member>. This can be achieved by setting the <member>QueryDefinition::Command</member> as <member>ElementaryQuery</member> of a - <type>SingleSelectQueryComposer</type>.</p> + SingleSelectQueryComposer.</p> <p>If, in such a scenario, you would be interested in the filter part of the <member>QueryDefinition::Command</member>, you would set it via @@ -220,7 +220,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer <p>If you'd be interested in the composed filter, you would set the <member>QueryDefinition::Command</member> as <member>ElementaryQuery</member>, add your filter, and propagate the resulting query (<member>XSingleSelectQueryAnalyzer::getQuery</member>) - to an <type>SingleSelectQueryAnalyzer</type> instance via + to an SingleSelectQueryAnalyzer instance via <member>XSingleSelectQueryAnalyzer::setQuery</member>.</p> */ [attribute] string ElementaryQuery diff --git a/offapi/com/sun/star/sdb/XSubDocument.idl b/offapi/com/sun/star/sdb/XSubDocument.idl index 5122c04229a5..8cfc92171b06 100644 --- a/offapi/com/sun/star/sdb/XSubDocument.idl +++ b/offapi/com/sun/star/sdb/XSubDocument.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdb { -/** allows operating on a sub document of an <type>OfficeDatabaseDocument</type> +/** allows operating on a sub document of an OfficeDatabaseDocument @since OOo 3.1 */ diff --git a/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl b/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl index d688fa2ad38d..dfc3423c070e 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableContinuation.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sdb { module application { /** specifies the possible continuations when copying a table row via a - <type>CopyTableWizard</type> failed. + CopyTableWizard failed. */ constants CopyTableContinuation { @@ -33,7 +33,7 @@ constants CopyTableContinuation */ const short Proceed = 0; - /** is used to indicate the next registered <type>XCopyTableListener</type> should be + /** is used to indicate the next registered XCopyTableListener should be called. */ const short CallNextHandler = 1; diff --git a/offapi/com/sun/star/sdb/application/CopyTableOperation.idl b/offapi/com/sun/star/sdb/application/CopyTableOperation.idl index 3579fa933466..0a5587439519 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableOperation.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableOperation.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module sdb { module application { -/** specifies the different basic operations a <type>CopyTableWizard</type> +/** specifies the different basic operations a CopyTableWizard can do. @since OOo 2.4 diff --git a/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl b/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl index 5c1c40005b8e..a6529557d3a3 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableRowEvent.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sdb { module application { /** specifies an event happening while copying table data between databases. - <p>Whenever this event is fired to an <type>XCopyTableListener</type>, + <p>Whenever this event is fired to an XCopyTableListener, <member scope="com::sun::star::lang">EventObject::Source</member> contains the wizard instance which actually does the copying.</p> diff --git a/offapi/com/sun/star/sdb/application/DefaultViewController.idl b/offapi/com/sun/star/sdb/application/DefaultViewController.idl index 289c9b2b08d0..46a30b39de6f 100644 --- a/offapi/com/sun/star/sdb/application/DefaultViewController.idl +++ b/offapi/com/sun/star/sdb/application/DefaultViewController.idl @@ -54,7 +54,7 @@ service DefaultViewController in other places cannot be intercepted.</p> <p>For the aforementioned tree view, the selection supplied by the <code>ContextMenuEvent::Selection</code> - component is an array of <type>NamedDatabaseObject</type> instances.</p> + component is an array of NamedDatabaseObject instances.</p> */ interface ::com::sun::star::ui::XContextMenuInterception; @@ -66,7 +66,7 @@ service DefaultViewController provides access to the current selection inside the application window, and allows to change it programmatically - <p>The selection is an array of <type>NamedDatabaseObject</type> instances.</p> + <p>The selection is an array of NamedDatabaseObject instances.</p> */ interface ::com::sun::star::view::XSelectionSupplier; diff --git a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl index 57ed158a434d..8087ed519c2e 100644 --- a/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl +++ b/offapi/com/sun/star/sdb/application/NamedDatabaseObject.idl @@ -32,7 +32,7 @@ struct NamedDatabaseObject { /** denotes the type of the object. - <p>This member is one of the <type>DatabaseObject</type> or <type>DatabaseObjectContainer</type> constants.</p> + <p>This member is one of the DatabaseObject or DatabaseObjectContainer constants.</p> */ long Type; diff --git a/offapi/com/sun/star/sdb/application/XCopyTableListener.idl b/offapi/com/sun/star/sdb/application/XCopyTableListener.idl index d6276bb9d792..c762b463aa88 100644 --- a/offapi/com/sun/star/sdb/application/XCopyTableListener.idl +++ b/offapi/com/sun/star/sdb/application/XCopyTableListener.idl @@ -69,7 +69,7 @@ interface XCopyTableListener : ::com::sun::star::lang::XEventListener happened. @return - how to continue with copying. Must be one of the <type>CopyTableContinuation</type> + how to continue with copying. Must be one of the CopyTableContinuation constants. */ short copyRowError( [in] CopyTableRowEvent Event ); diff --git a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl index 1ff10ddf1ee6..c5b462ec9605 100644 --- a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl @@ -47,7 +47,7 @@ interface XCopyTableWizard : ::com::sun::star::ui::dialogs::XExecutableDialog { /** specifies the basic operation for the wizard to execute. - <p>This must be one of the <type>CopyTableOperation</type> constants.</p> + <p>This must be one of the CopyTableOperation constants.</p> <p>At initialization time, you can use this attribute to control the initial operation in the wizard.</p> diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index 67ee447a24c3..be5507584cba 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -115,7 +115,7 @@ interface XDatabaseDocumentUI @return a record describing the sub component. The first element of the returned pair is the type - of the component, denoted by one of the <type>DatabaseObject</type> constants. The second + of the component, denoted by one of the DatabaseObject constants. The second element is the name of the component. For object types which support nested structures (forms and reports, actually), this might be a hierarchical name. If the sub component has been newly created, and not yet saved, this name is empty. @@ -173,7 +173,7 @@ interface XDatabaseDocumentUI @see connect @param ObjectType - specifies the type of the object, must be one of the <type>DatabaseObject</type> + specifies the type of the object, must be one of the DatabaseObject constants. @param ObjectName @@ -266,7 +266,7 @@ interface XDatabaseDocumentUI /** creates a new sub component of the given type @param ObjectType - specifies the type of the object, must be one of the <type>DatabaseObject</type> + specifies the type of the object, must be one of the DatabaseObject constants. @param DocumentDefinition @@ -290,7 +290,7 @@ interface XDatabaseDocumentUI services.</p> @param ObjectType - specifies the type of the object, must be one of the <type>DatabaseObject</type> + specifies the type of the object, must be one of the DatabaseObject constants. @param DocumentDefinition diff --git a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl index 0aaea1bb7bf2..8561c794a8ef 100644 --- a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl +++ b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl @@ -45,7 +45,7 @@ interface XDataSourceMetaData; <p>Most of the functionality provided here is meaningful only relative to a given database connection. For instance, for quoting table names, you need the meta data instance of the connection. Thus, the entry point for obtaining - a <type>XConnectionTools</type> instance is the + a XConnectionTools instance is the <type scope="com::sun::star::sdb">Connection</type> service.</p> <p>Note that nearly all functionality provided by this interface is also @@ -55,14 +55,14 @@ interface XDataSourceMetaData; */ interface XConnectionTools { - /** creates an instance supporting the <type>XTableName</type> interface, + /** creates an instance supporting the XTableName interface, which can be used to manipulate table names for various purposes. <p>The returned object is guaranteed to not be <NULL/>.</p> */ XTableName createTableName(); - /** returns an instance supporting the <type>XObjectNames</type> interface, + /** returns an instance supporting the XObjectNames interface, which provides access to functionality around table and query names. <p>The returned object is guaranteed to not be <NULL/>.</p> diff --git a/offapi/com/sun/star/sdb/tools/XTableName.idl b/offapi/com/sun/star/sdb/tools/XTableName.idl index a45ac32fa662..642a7ae13548 100644 --- a/offapi/com/sun/star/sdb/tools/XTableName.idl +++ b/offapi/com/sun/star/sdb/tools/XTableName.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module sdb { module tools { Additionally, you have to respect the client-side settings which tell OpenOffice.org to use or not use catalogs and schemas in <code>SELECT</code> at all.</p> - <p>The <type>XTableName</type> interface eases this and other, similar tasks around table + <p>The XTableName interface eases this and other, similar tasks around table names.</p> <p>The component itself does not have life-time control mechanisms, i.e. you @@ -80,7 +80,7 @@ interface XTableName @see CompositionType @throws com::sun::star::IllegalArgumentException - if the given <arg>Type</arg> does not denote a valid <type>CompositionType</type> + if the given <arg>Type</arg> does not denote a valid CompositionType */ string getComposedName( [in] long Type, [in] boolean Quote ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/sdbc/PreparedStatement.idl b/offapi/com/sun/star/sdbc/PreparedStatement.idl index 502365cbbeed..d5ac01dc0d04 100644 --- a/offapi/com/sun/star/sdbc/PreparedStatement.idl +++ b/offapi/com/sun/star/sdbc/PreparedStatement.idl @@ -111,7 +111,7 @@ published service PreparedStatement /** provides access to the description of the result set which would be generated by executing the - <type>PreparedStatement</type>. + PreparedStatement. */ interface XResultSetMetaDataSupplier; diff --git a/offapi/com/sun/star/sdbc/RowSet.idl b/offapi/com/sun/star/sdbc/RowSet.idl index cae4d1cd9d07..38c7a886e9a0 100644 --- a/offapi/com/sun/star/sdbc/RowSet.idl +++ b/offapi/com/sun/star/sdbc/RowSet.idl @@ -60,7 +60,7 @@ published service RowSet /** used to execute and to add/remove listeners. - <p>To refresh the content of a <type>RowSet</type>, use this interface's <member>XRowSet::execute</member> + <p>To refresh the content of a RowSet, use this interface's <member>XRowSet::execute</member> method.</p> */ interface XRowSet; diff --git a/offapi/com/sun/star/sdbc/XDatabaseMetaData2.idl b/offapi/com/sun/star/sdbc/XDatabaseMetaData2.idl index 29206891671a..591b307d560e 100644 --- a/offapi/com/sun/star/sdbc/XDatabaseMetaData2.idl +++ b/offapi/com/sun/star/sdbc/XDatabaseMetaData2.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sdbc { -/** extends the <type>XDatabaseMetaData</type> interface to allow retrieval of additional +/** extends the XDatabaseMetaData interface to allow retrieval of additional information. */ interface XDatabaseMetaData2 : XDatabaseMetaData diff --git a/offapi/com/sun/star/sdbc/XIsolatedConnection.idl b/offapi/com/sun/star/sdbc/XIsolatedConnection.idl index 89538b8d1778..5f24abe8b118 100644 --- a/offapi/com/sun/star/sdbc/XIsolatedConnection.idl +++ b/offapi/com/sun/star/sdbc/XIsolatedConnection.idl @@ -28,7 +28,7 @@ published interface XConnection; /** is used for establishing isolated connections via a factory. <p> - The <type>XIsolatedConnection</type> allows to create connections which are not shared among others + The XIsolatedConnection allows to create connections which are not shared among others as it is the case when creating connections in normal way. </p> @see com::sun::star::sdb::DataSource diff --git a/offapi/com/sun/star/security/CertificateContainer.idl b/offapi/com/sun/star/security/CertificateContainer.idl index cf6050627a84..0381fba69ef5 100644 --- a/offapi/com/sun/star/security/CertificateContainer.idl +++ b/offapi/com/sun/star/security/CertificateContainer.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module security { -/** the service to be used for <type>XCertificateContainer</type>. +/** the service to be used for XCertificateContainer. @since OOo 2.3.1 */ service CertificateContainer: XCertificateContainer; diff --git a/offapi/com/sun/star/sheet/AccessibleSpreadsheetDocumentView.idl b/offapi/com/sun/star/sheet/AccessibleSpreadsheetDocumentView.idl index 39e22ce3a88d..75b5371d06e0 100644 --- a/offapi/com/sun/star/sheet/AccessibleSpreadsheetDocumentView.idl +++ b/offapi/com/sun/star/sheet/AccessibleSpreadsheetDocumentView.idl @@ -58,7 +58,7 @@ service AccessibleSpreadsheetDocumentView an object that supports this service is returned for every shape that is at the current table. These objects are children of the - <type>AccessibleSpreadsheetDocumentView</type> regardless + AccessibleSpreadsheetDocumentView regardless whether they are bound to a table or a cell.</li> <li><type scope="::com::sun::star::text">AccessibleParagraphView</type>: A child where calling <method>getAccessibleChild</method> diff --git a/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl b/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl index 29a065010ee4..59aa2c601fa2 100644 --- a/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl +++ b/offapi/com/sun/star/sheet/AccessibleSpreadsheetPageView.idl @@ -71,7 +71,7 @@ service AccessibleSpreadsheetPageView an object that supports this service is returned for every shape that is at least partially visible. These objects are children of the - <type>AccessibleSpreadsheetPageView</type> regardless + AccessibleSpreadsheetPageView regardless whether they are bound to a table or a cell.</li> <li><type scope="::com::sun::star::text">AccessibleParagraphView</type>: A child where calling diff --git a/offapi/com/sun/star/sheet/AddIn.idl b/offapi/com/sun/star/sheet/AddIn.idl index a108bd8cbeda..d12eb38f0387 100644 --- a/offapi/com/sun/star/sheet/AddIn.idl +++ b/offapi/com/sun/star/sheet/AddIn.idl @@ -33,10 +33,10 @@ module com { module sun { module star { module sheet { <p>Any AddIn implementation must implement a service describing its specific set of functions. - That service must contain the <type>AddIn</type> service, and the + That service must contain the AddIn service, and the functions that are implemented, in one or more interfaces. The <type scope="com::sun::star::lang">XServiceName</type> interface - must describe that service, and the <type>XAddIn</type> interface + must describe that service, and the XAddIn interface must describe the individual functions.</p> <p>Each AddIn function can take parameters of the following types:</p> @@ -77,7 +77,7 @@ module com { module sun { module star { module sheet { <dt><type scope="com::sun::star::beans">XPropertySet</type></dt> <dd>for a <type scope="com::sun::star::beans">XPropertySet</type> - interface to the <type>SpreadsheetDocument</type> making the function + interface to the SpreadsheetDocument making the function call. Only one parameter of this type is allowed in each function. It can be used to query document settings like <member>SpreadsheetDocumentSettings::NullDate</member>.</dd> @@ -100,14 +100,14 @@ module com { module sun { module star { module sheet { <li><atom>double[][]</atom></li> <li><atom>string[][]</atom></li> <li><atom>any[][]</atom></li> - <li><type>XVolatileResult</type></li> + <li>XVolatileResult</li> <li><atom>any</atom></li> </ul> <p>The sequences must contain arrays as described above for the parameter types. - An <type>XVolatileResult</type> return value must contain an object - implementing the <type>VolatileResult</type> service, that contains + An XVolatileResult return value must contain an object + implementing the VolatileResult service, that contains a volatile result. Subsequent calls with the same parameters must return the same object. An <atom>any</atom> return value can contain any of the other types.</p> diff --git a/offapi/com/sun/star/sheet/ConditionOperator.idl b/offapi/com/sun/star/sheet/ConditionOperator.idl index a6e56d70eb65..fa643bda2b0e 100644 --- a/offapi/com/sun/star/sheet/ConditionOperator.idl +++ b/offapi/com/sun/star/sheet/ConditionOperator.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module sheet { -/** is used to specify the type of <type>XSheetCondition</type>. +/** is used to specify the type of XSheetCondition. */ published enum ConditionOperator { diff --git a/offapi/com/sun/star/sheet/ConditionOperator2.idl b/offapi/com/sun/star/sheet/ConditionOperator2.idl index f91887ccf14b..e4d42d4247a3 100644 --- a/offapi/com/sun/star/sheet/ConditionOperator2.idl +++ b/offapi/com/sun/star/sheet/ConditionOperator2.idl @@ -14,7 +14,7 @@ module com { module sun { module star { module sheet { -/** is used to specify the type of <type>XSheetCondition2</type>. +/** is used to specify the type of XSheetCondition2. */ constants ConditionOperator2 { diff --git a/offapi/com/sun/star/sheet/DataPilotDescriptor.idl b/offapi/com/sun/star/sheet/DataPilotDescriptor.idl index 2d817756ccd6..566214bed740 100644 --- a/offapi/com/sun/star/sheet/DataPilotDescriptor.idl +++ b/offapi/com/sun/star/sheet/DataPilotDescriptor.idl @@ -46,7 +46,7 @@ published service DataPilotDescriptor [optional] interface com::sun::star::beans::XPropertySet; - /** Provides access to the <type>DataPilotField</type> used to layout + /** Provides access to the DataPilotField used to layout multiple data fields. */ [optional] interface XDataPilotDataLayoutFieldSupplier; @@ -61,7 +61,7 @@ published service DataPilotDescriptor [optional, property] sequence< com::sun::star::beans::PropertyValue > ImportDescriptor; - /** specifies the name of a <type>DataPilotSource</type> implementation + /** specifies the name of a DataPilotSource implementation for the data pilot table. @since OOo 3.3 diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl index 140bbe30823b..036936073417 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroup.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module sheet { /** represents a collection of members in a data pilot field group. <p>The members (also called items) of this collection are instances of - <type>DataPilotFieldGroupItem</type>.</p> + DataPilotFieldGroupItem.</p> @see DataPilotField @see DataPilotFieldGroups @@ -86,7 +86,7 @@ published service DataPilotFieldGroup group member.</li> <li>an object supporting the <type scope="com::sun::star::container"> XNamed</type> interface, for example an instance of - <type>DataPilotFieldGroupItem</type> received from another group.</li> + DataPilotFieldGroupItem received from another group.</li> </ul></p> <p>The method <member scope="com::sun::star::container"> diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl index 9c997a82d259..fa81edaba65e 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupEnumeration.idl @@ -37,7 +37,7 @@ service DataPilotFieldGroupEnumeration /** provides methods to access the group members in the enumeration. <p>The elements of the enumeration are instances of - <type>DataPilotFieldGroupItem</type>.</p> + DataPilotFieldGroupItem.</p> */ interface com::sun::star::container::XEnumeration; diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl index 258470a76391..4ada3b65b44c 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupInfo.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module sheet { -/** contains the grouping information of a <type>DataPilotField</type>. +/** contains the grouping information of a DataPilotField. */ published struct DataPilotFieldGroupInfo { @@ -66,7 +66,7 @@ published struct DataPilotFieldGroupInfo <li>If <FALSE/> is set, and <member>GroupBy</member> contains zero, grouping is performed inplace on the item values.</li> <li>If <FALSE/> is set, and <member>GroupBy</member> contains one or - more flags from <type>DataPilotFieldGroupBy</type>, grouping is + more flags from DataPilotFieldGroupBy, grouping is performed on date or time.</li> <li>If <TRUE/> is set, <member>Step</member> contains a value greater than or equal to 1, and <member>GroupBy</member> set to <const> diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl index eafbf74bb572..a673ddd2c127 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroups.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module sheet { /** represents a collection of groups in a data pilot field. - <p>The members of this collection are instances of <type>DataPilotFieldGroup</type> + <p>The members of this collection are instances of DataPilotFieldGroup containing the names of all items in the group.</p> @see DataPilotField diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl index 5b4ffa124137..69e351c17c7f 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupsEnumeration.idl @@ -37,7 +37,7 @@ service DataPilotFieldGroupsEnumeration /** provides methods to access the field groups in the enumeration. <p>The elements of the enumeration are instances of - <type>DataPilotFieldGroup</type>.</p> + DataPilotFieldGroup.</p> */ interface com::sun::star::container::XEnumeration; diff --git a/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl b/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl index 923d7787d99d..3ddc67df6a5b 100644 --- a/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl +++ b/offapi/com/sun/star/sheet/DataPilotFieldLayoutInfo.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module sheet { -/** contains the layout information of a <type>DataPilotField</type>. +/** contains the layout information of a DataPilotField. */ published struct DataPilotFieldLayoutInfo { @@ -38,7 +38,7 @@ published struct DataPilotFieldLayoutInfo long LayoutMode; - /** If <TRUE/>, an empty row is inserted in the <type>DataPilotTable</type> + /** If <TRUE/>, an empty row is inserted in the DataPilotTable result table after the data (including the subtotals) for each item of the field. */ diff --git a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl index 054179b4ca32..4b362919dae0 100644 --- a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl +++ b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl @@ -44,7 +44,7 @@ struct DataPilotTablePositionData { /** This parameter specifies which sub-area of a DataPilot table a given - cell is positioned. See <type>DataPilotTablePositionType</type> + cell is positioned. See DataPilotTablePositionType for how to interpret the value of this parameter. @see com::sun::star::sheet::DataPilotTablePositionType @@ -57,7 +57,7 @@ struct DataPilotTablePositionData <p>When the value of <member>PositionType</member> is <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member> - contains an instance of type <type>DataPilotTableResultData</type>, + contains an instance of type DataPilotTableResultData, whereas when the value of <member>DataPilotTablePositionData::PositionType</member> is either <const>DataPilotTablePositionType::ROW_HEADER</const> or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the diff --git a/offapi/com/sun/star/sheet/DataPilotTableResultData.idl b/offapi/com/sun/star/sheet/DataPilotTableResultData.idl index 492db3b03485..02996678655a 100644 --- a/offapi/com/sun/star/sheet/DataPilotTableResultData.idl +++ b/offapi/com/sun/star/sheet/DataPilotTableResultData.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sheet { /** information about a cell positioned within the result area of a DataPilot table. - <p><type>DataPilotTableResultData</type> contains information about a + <p>DataPilotTableResultData contains information about a particular cell positioned within the result area of a DataPilot table.</p> @see com::sun::star::sheet::DataPilotTablePositionData @@ -58,7 +58,7 @@ struct DataPilotTableResultData /** more information about the result contained in the - <type>DataResult</type> type. + DataResult type. @see com::sun::star::sheet::DataResult */ diff --git a/offapi/com/sun/star/sheet/DocumentSettings.idl b/offapi/com/sun/star/sheet/DocumentSettings.idl index 22fd1f439c3b..36402ee95dc5 100644 --- a/offapi/com/sun/star/sheet/DocumentSettings.idl +++ b/offapi/com/sun/star/sheet/DocumentSettings.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module sheet { <p>For settings that affect view properties, these settings apply to subsequently created views and are saved with the document, while - <type>SpreadsheetViewSettings</type> can be used to alter a specific + SpreadsheetViewSettings can be used to alter a specific view that is already open.</p> */ published service DocumentSettings diff --git a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl index 10b347349c23..6bbae6e027b7 100644 --- a/offapi/com/sun/star/sheet/ExternalLinkInfo.idl +++ b/offapi/com/sun/star/sheet/ExternalLinkInfo.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module sheet { */ struct ExternalLinkInfo { - /** Link type, one of <type>ExternalLinkType</type> constants. + /** Link type, one of ExternalLinkType constants. */ long Type; @@ -48,7 +48,7 @@ struct ExternalLinkInfo quotes cover both, the document name and the sheet name.</li> <li>If <member>Type</member> is <const>ExternalLinkType::DDE</const>, - this member shall contain a <type>DDELinkInfo</type> describing + this member shall contain a DDELinkInfo describing service name, topic, and all known items of a DDE link.</li> </ol></p> */ diff --git a/offapi/com/sun/star/sheet/ExternalLinkType.idl b/offapi/com/sun/star/sheet/ExternalLinkType.idl index bb3443c62ecb..21fb3b74bb98 100644 --- a/offapi/com/sun/star/sheet/ExternalLinkType.idl +++ b/offapi/com/sun/star/sheet/ExternalLinkType.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sheet { /** Constants designating the link type in - <type>ExternalLinkInfo</type>, used with + ExternalLinkInfo, used with <member>FormulaParser::ExternalLinks</member>. @since OOo 3.1 diff --git a/offapi/com/sun/star/sheet/ExternalReference.idl b/offapi/com/sun/star/sheet/ExternalReference.idl index 0ba46d61b27f..ac31c8f87fdc 100644 --- a/offapi/com/sun/star/sheet/ExternalReference.idl +++ b/offapi/com/sun/star/sheet/ExternalReference.idl @@ -63,9 +63,9 @@ struct ExternalReference /** Reference data. - <p>This can store either <type>SingleReference</type> for a single - cell reference, <type>ComplexReference</type> for a cell range - reference, or simply a <type>string</type> for a defined name.</p> + <p>This can store either SingleReference for a single + cell reference, ComplexReference for a cell range + reference, or simply a string for a defined name.</p> <p>The <member>SingleReference::Sheet</member> member shall contain the index of the external sheet cache containing the values of the diff --git a/offapi/com/sun/star/sheet/FilterOperator2.idl b/offapi/com/sun/star/sheet/FilterOperator2.idl index 03c470163af6..01e63364e91a 100644 --- a/offapi/com/sun/star/sheet/FilterOperator2.idl +++ b/offapi/com/sun/star/sheet/FilterOperator2.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sheet { /** specifies the type of a single condition in a filter descriptor. - <p>This constants group extends the <type>FilterOperator</type> enum by + <p>This constants group extends the FilterOperator enum by additional filter operators.</p> @since OOo 3.2 diff --git a/offapi/com/sun/star/sheet/FormulaLanguage.idl b/offapi/com/sun/star/sheet/FormulaLanguage.idl index 1a0534bd0a6a..edd79c0355bd 100644 --- a/offapi/com/sun/star/sheet/FormulaLanguage.idl +++ b/offapi/com/sun/star/sheet/FormulaLanguage.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sheet { /** Constants designating the formula language used with - <type>XFormulaOpCodeMapper</type> methods. + XFormulaOpCodeMapper methods. */ constants FormulaLanguage { diff --git a/offapi/com/sun/star/sheet/FormulaMapGroup.idl b/offapi/com/sun/star/sheet/FormulaMapGroup.idl index a66ead69b443..c4f42ba540c8 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroup.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroup.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sheet { specify for which group of symbols the mappings are to be obtained. If no bit is set, a sequence of special mappings is returned in the - order that is defined by <type>FormulaMapGroupSpecialOffset</type>. + order that is defined by FormulaMapGroupSpecialOffset. Note that the special group and other groups are mutual exclusive. */ constants FormulaMapGroup diff --git a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl index 9dda523f1b74..c96a888da131 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl @@ -47,11 +47,11 @@ constants FormulaMapGroupSpecialOffset <li>A <atom dim="[][]">any</atom> for a literal array. The contained values shall be of type <atom>double</atom> or <atom>string</atom>. Floating-point values and strings may occur together in an array.</li> - <li>A struct of type <type>SingleReference</type> for a reference to a + <li>A struct of type SingleReference for a reference to a single cell in the own document.</li> - <li>A struct of type <type>ComplexReference</type> for a reference to + <li>A struct of type ComplexReference for a reference to a range of cells in the own document.</li> - <li>A struct of type <type>ExternalReference</type> for a reference to + <li>A struct of type ExternalReference for a reference to a cell, a range of cells, or a defined name in an external document.</li> </ul> */ diff --git a/offapi/com/sun/star/sheet/FunctionDescriptions.idl b/offapi/com/sun/star/sheet/FunctionDescriptions.idl index e1185d0b0608..a09a4a9efe37 100644 --- a/offapi/com/sun/star/sheet/FunctionDescriptions.idl +++ b/offapi/com/sun/star/sheet/FunctionDescriptions.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module sheet { <p>All container access methods return a sequence of <type scope="com::sun::star::beans">PropertyValue</type> structs. The properties contained in the sequence are collected in the - service <type>FunctionDescription</type>.</p> + service FunctionDescription.</p> */ published service FunctionDescriptions { diff --git a/offapi/com/sun/star/sheet/ResultEvent.idl b/offapi/com/sun/star/sheet/ResultEvent.idl index bfc9f467ecd9..c4c503e361e4 100644 --- a/offapi/com/sun/star/sheet/ResultEvent.idl +++ b/offapi/com/sun/star/sheet/ResultEvent.idl @@ -36,7 +36,7 @@ published struct ResultEvent: com::sun::star::lang::EventObject /** contains the value. <p>This can be any of the possible return types described for the - <type>AddIn</type> service, except <type>XVolatileResult</type>.</p> + AddIn service, except XVolatileResult.</p> */ any Value; diff --git a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl index 07901e00e0e9..c491b62471f8 100644 --- a/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl +++ b/offapi/com/sun/star/sheet/SheetFilterDescriptor.idl @@ -46,10 +46,10 @@ published service SheetFilterDescriptor /** provides access to the collection of filter fields. - <p>This interface provides a sequence of <type>TableFilterField2</type> + <p>This interface provides a sequence of TableFilterField2 structures supporting a wider range of comparison operators, compared - to the <type>TableFilterField</type> structure provided by interface - <type>XSheetFilterDescriptor</type>. + to the TableFilterField structure provided by interface + XSheetFilterDescriptor. @since OOo 3.2 */ diff --git a/offapi/com/sun/star/sheet/SheetLink.idl b/offapi/com/sun/star/sheet/SheetLink.idl index ba128d149335..084cccd92bcc 100644 --- a/offapi/com/sun/star/sheet/SheetLink.idl +++ b/offapi/com/sun/star/sheet/SheetLink.idl @@ -35,8 +35,8 @@ module com { module sun { module star { module sheet { <p>To create a linked sheet, the sheet which will be used as linked sheet has to exist already. The method - <member>XSheetLinkable::link</member> creates a <type>SheetLink</type> - object in the document's <type>SheetLinks</type> collection and links + <member>XSheetLinkable::link</member> creates a SheetLink + object in the document's SheetLinks collection and links the sheet to the specified external sheet.</p> */ published service SheetLink diff --git a/offapi/com/sun/star/sheet/SolverConstraintOperator.idl b/offapi/com/sun/star/sheet/SolverConstraintOperator.idl index 5bf61a94f4b8..c9258365381b 100644 --- a/offapi/com/sun/star/sheet/SolverConstraintOperator.idl +++ b/offapi/com/sun/star/sheet/SolverConstraintOperator.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module sheet { -/** is used to specify the type of <type>SolverConstraint</type>. +/** is used to specify the type of SolverConstraint. */ enum SolverConstraintOperator { diff --git a/offapi/com/sun/star/sheet/SpreadsheetDrawPage.idl b/offapi/com/sun/star/sheet/SpreadsheetDrawPage.idl index cb806ac3ed57..2dc2007b168f 100644 --- a/offapi/com/sun/star/sheet/SpreadsheetDrawPage.idl +++ b/offapi/com/sun/star/sheet/SpreadsheetDrawPage.idl @@ -27,7 +27,7 @@ /** This abstract service is implemented by every page of a - <type>SpreadsheetDocument</type>. + SpreadsheetDocument. @example create and insert a couple of <type scope="com::sun::star::drawing">LineShape</type>s: diff --git a/offapi/com/sun/star/sheet/TableFilterField2.idl b/offapi/com/sun/star/sheet/TableFilterField2.idl index ba89cf796be3..239b1fee5303 100644 --- a/offapi/com/sun/star/sheet/TableFilterField2.idl +++ b/offapi/com/sun/star/sheet/TableFilterField2.idl @@ -29,9 +29,9 @@ module com { module sun { module star { module sheet { /** describes a single condition in a filter descriptor. - <p>This struct has the <type>FilterOperator2</type> constants group as - member, whereas the <type>TableFilterField</type> struct uses the - <type>FilterOperator</type> enum.</p> + <p>This struct has the FilterOperator2 constants group as + member, whereas the TableFilterField struct uses the + FilterOperator enum.</p> @see SheetFilterDescriptor @since OOo 3.2 @@ -50,7 +50,7 @@ published struct TableFilterField2 /** specifies the type of the condition as defined in - <type>FilterOperator2</type>. + FilterOperator2. */ long Operator; diff --git a/offapi/com/sun/star/sheet/TableFilterField3.idl b/offapi/com/sun/star/sheet/TableFilterField3.idl index eb93fbf2a3da..731fb76dd30b 100644 --- a/offapi/com/sun/star/sheet/TableFilterField3.idl +++ b/offapi/com/sun/star/sheet/TableFilterField3.idl @@ -30,7 +30,7 @@ struct TableFilterField3 long Field; /** specifies the type of the condition as defined in - <type>FilterOperator2</type>. + FilterOperator2. */ long Operator; diff --git a/offapi/com/sun/star/sheet/TableValidation.idl b/offapi/com/sun/star/sheet/TableValidation.idl index 121d29e72ca9..2ad848e2cf58 100644 --- a/offapi/com/sun/star/sheet/TableValidation.idl +++ b/offapi/com/sun/star/sheet/TableValidation.idl @@ -103,7 +103,7 @@ published service TableValidation /** specifies if the list of possible values should be shown on the cell and how. - See also <type>TableValidationVisibility</type> + See also TableValidationVisibility */ [optional,property] short ShowList; diff --git a/offapi/com/sun/star/sheet/VolatileResult.idl b/offapi/com/sun/star/sheet/VolatileResult.idl index 20510ad868e5..c4e15da1a96e 100644 --- a/offapi/com/sun/star/sheet/VolatileResult.idl +++ b/offapi/com/sun/star/sheet/VolatileResult.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module sheet { /** represents a volatile function result. <p>A volatile function result can change its value over time. The - <type>XVolatileResult</type> interface allows the addition of + XVolatileResult interface allows the addition of listeners which are notified when the value changes.</p> @see com::sun::star::sheet::AddIn diff --git a/offapi/com/sun/star/sheet/XActivationBroadcaster.idl b/offapi/com/sun/star/sheet/XActivationBroadcaster.idl index 866a77851ad5..30b497cfa1db 100644 --- a/offapi/com/sun/star/sheet/XActivationBroadcaster.idl +++ b/offapi/com/sun/star/sheet/XActivationBroadcaster.idl @@ -37,9 +37,9 @@ published interface XActivationBroadcaster: com::sun::star::uno::XInterface { /** allows a component supporting the - <type>XActivationEventListener</type> interface to + XActivationEventListener interface to register as listener. The component will be notified with a - <type>ActivationEvent</type> every time the active sheet + ActivationEvent every time the active sheet changes.</p> @param aListener diff --git a/offapi/com/sun/star/sheet/XActivationEventListener.idl b/offapi/com/sun/star/sheet/XActivationEventListener.idl index 7ce329e26c00..531339ca6e1e 100644 --- a/offapi/com/sun/star/sheet/XActivationEventListener.idl +++ b/offapi/com/sun/star/sheet/XActivationEventListener.idl @@ -36,7 +36,7 @@ published interface XActivationEventListener: com::sun::star::lang::XEventListen <p>This interface must be implemented by components that wish to get notified of changes of the active Spreadsheet. - They can be registered at an <type>XSpreadsheetViewEventProvider</type> component.</p> + They can be registered at an XSpreadsheetViewEventProvider component.</p> @param aEvent the event that gives further information on which Spreadsheet is active now. diff --git a/offapi/com/sun/star/sheet/XCellRangesQuery.idl b/offapi/com/sun/star/sheet/XCellRangesQuery.idl index e659c51fa8e0..05c368e12719 100644 --- a/offapi/com/sun/star/sheet/XCellRangesQuery.idl +++ b/offapi/com/sun/star/sheet/XCellRangesQuery.idl @@ -58,9 +58,9 @@ published interface XCellRangesQuery: com::sun::star::uno::XInterface /** queries all cells with the specified content type(s). @param nContentFlags - a combination of <type>CellFlags</type> flags. + a combination of CellFlags flags. - <p>Attention: Despite the <type>CellFlags</type> flags are + <p>Attention: Despite the CellFlags flags are <atom>long</atom> values, this method expects a <atom>short</atom> parameter.</p> @@ -80,7 +80,7 @@ published interface XCellRangesQuery: com::sun::star::uno::XInterface /** queries all formula cells with the specified result type. @param nResultFlags - a combination of <type>FormulaResult</type> flags. + a combination of FormulaResult flags. @returns all formula cells of the current cell range(s) with the diff --git a/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl b/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl index 93df9f18f041..e718e40f42ed 100644 --- a/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl +++ b/offapi/com/sun/star/sheet/XDataPilotDataLayoutFieldSupplier.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sheet { -/** Provides access to the <type>DataPilotField</type> used to layout +/** Provides access to the DataPilotField used to layout multiple data fields. <p>This data field can be inserted into the rows dimension or columns @@ -42,7 +42,7 @@ module com { module sun { module star { module sheet { published interface XDataPilotDataLayoutFieldSupplier { - /** Returns the <type>DataPilotField</type> used to layout multiple data + /** Returns the DataPilotField used to layout multiple data fields. <p>If the field does not exist yet, it will be created. It is possible diff --git a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl index 0e762f84abb4..cadfeca1f363 100644 --- a/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl +++ b/offapi/com/sun/star/sheet/XDataPilotFieldGrouping.idl @@ -111,7 +111,7 @@ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface The fractional part of the value will be ignored.</li> <li>The member <member>DataPilotFieldGroupInfo::GroupBy</member> - must contain exactly one of the flags from <type>DataPilotFieldGroupBy</type>. + must contain exactly one of the flags from DataPilotFieldGroupBy. A combination of several flags will not be accepted. If <const>DataPilotFieldGroupBy::DAYS</const> is specified, the value of the member <member>DataPilotFieldGroupInfo::Step</member> diff --git a/offapi/com/sun/star/sheet/XDataPilotTable2.idl b/offapi/com/sun/star/sheet/XDataPilotTable2.idl index 5c3067e7c352..98957b3800ed 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTable2.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTable2.idl @@ -62,7 +62,7 @@ interface XDataPilotTable2: com::sun::star::sheet::XDataPilotTable @param aAddr address of the cell whose information is to be returned. - @returns <type>DataPilotTablePositionData</type> which contains the + @returns DataPilotTablePositionData which contains the position type and the information for that cell position. @see com::sun::star::sheet::DataPilotTablePositionData @@ -90,7 +90,7 @@ interface XDataPilotTable2: com::sun::star::sheet::XDataPilotTable per specified output range type.</p> @returns <type scope="com::sun::star::table">CellRangeAddress</type> depicting - the range specified. See <type>DataPilotOutputRangeType</type> for a set + the range specified. See DataPilotOutputRangeType for a set of possible output range types. @see com::sun::star::sheet::DataPilotOutputRangeType diff --git a/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl b/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl index deeb58c08dc4..4d0636d9da76 100644 --- a/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl +++ b/offapi/com/sun/star/sheet/XDrillDownDataSupplier.idl @@ -51,8 +51,8 @@ interface XDrillDownDataSupplier: com::sun::star::uno::XInterface @returns a filtered subset of the original source data as 2-dimensional sequences of <type scope="com::sun::star::uno">Any</any>. The first row must be the header row. Each <type scope="com::sun::star::uno">Any</type> - instance must contain either <type>double</type> value for a numeric cell, or - a <type>string</type> value for a string cell. + instance must contain either double value for a numeric cell, or + a string value for a string cell. @see com::sun::star::sheet::DataPilotFieldFilter @see com::sun::star::sheet::XDataPilotTable2 diff --git a/offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl b/offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl index 67ac9f9b37bd..b88244ee85a8 100644 --- a/offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl +++ b/offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl @@ -37,9 +37,9 @@ published interface XEnhancedMouseClickBroadcaster: com::sun::star::uno::XInterf { /** allows a component supporting the - <type>XEnhancedMouseClickHandler</type> interface to + XEnhancedMouseClickHandler interface to register as listener. The component will be notified with a - <type>EnhancedMouseEvent</type> every time the mouse is clicked + EnhancedMouseEvent every time the mouse is clicked in the spreadsheet</p> @param aListener diff --git a/offapi/com/sun/star/sheet/XExternalSheetCache.idl b/offapi/com/sun/star/sheet/XExternalSheetCache.idl index 48e4e45ed2f6..4c9e611d180b 100644 --- a/offapi/com/sun/star/sheet/XExternalSheetCache.idl +++ b/offapi/com/sun/star/sheet/XExternalSheetCache.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module sheet { interface XExternalSheetCache { /** It sets a cached value for a specified cell position. The value is expected - to be either of type <type>string</type> or of type <type>double</type>. No + to be either of type string or of type double. No other data types are supported. @param nRow row position (0-based) @@ -44,7 +44,7 @@ interface XExternalSheetCache raises (com::sun::star::lang::IllegalArgumentException); /** It retrieves a cached value from a specified cell position. The cached - value can be either <type>string</type> or <type>double</type>. + value can be either string or double. @return any cached cell value */ @@ -76,7 +76,7 @@ interface XExternalSheetCache external reference token. <p>Each external sheet cache has a unique index value inside the - <type>ExternalDocLink</type> instance.</p> + ExternalDocLink instance.</p> @see FormulaToken @see ExternalReference diff --git a/offapi/com/sun/star/sheet/XFilterFormulaParser.idl b/offapi/com/sun/star/sheet/XFilterFormulaParser.idl index 9e13c06eb025..008097fe3b20 100644 --- a/offapi/com/sun/star/sheet/XFilterFormulaParser.idl +++ b/offapi/com/sun/star/sheet/XFilterFormulaParser.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sheet { -/** Extends the interface <type>XFormulaParser</type> by an attribute that +/** Extends the interface XFormulaParser by an attribute that specifies the namespace URL of the supported formula language. */ interface XFilterFormulaParser : XFormulaParser diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl index 1668ca7a8ab8..e4250a0976ca 100644 --- a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl +++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl @@ -59,13 +59,13 @@ interface XFormulaOpCodeMapper knows. @param Language - Formula language to be used, one of <type>FormulaLanguage</type> + Formula language to be used, one of FormulaLanguage constants. If a constant unknown to the implementation is passed, <type scope="com::sun::star::lang">IllegalArgumentException</type> is thrown. @returns - a sequence of <type>FormulaToken</type> matching the input + a sequence of FormulaToken matching the input sequence in order. <p>Each string element in parameter Names according to the formula @@ -99,7 +99,7 @@ interface XFormulaOpCodeMapper a given formula language. @param Language - Formula language to be used, one of <type>FormulaLanguage</type> + Formula language to be used, one of FormulaLanguage constants. If a constant unknown to the implementation is passed, <type scope="com::sun::star::lang">IllegalArgumentException</type> is thrown. @@ -109,10 +109,10 @@ interface XFormulaOpCodeMapper FormulaMapGroup</type> constants. @returns - Sequence of <type>FormulaOpCodeMapEntry</type>. + Sequence of FormulaOpCodeMapEntry. <p>Each element of the formula language in parameter Language is - mapped to a <type>FormulaToken</type> containing the internal + mapped to a FormulaToken containing the internal OpCode used by the spreadsheet application in <member> FormulaToken::OpCode</member> and by contract maybe additional information in <member>FormulaToken::Data</member>. See <member> diff --git a/offapi/com/sun/star/sheet/XFunctionAccess.idl b/offapi/com/sun/star/sheet/XFunctionAccess.idl index 9616ac8390a2..d8bd0025a5f9 100644 --- a/offapi/com/sun/star/sheet/XFunctionAccess.idl +++ b/offapi/com/sun/star/sheet/XFunctionAccess.idl @@ -63,7 +63,7 @@ published interface XFunctionAccess: com::sun::star::uno::XInterface type.</dd> <dt><type scope="com::sun::star::table">XCellRange</type></dt> - <dd>for a <type>SheetCellRange</type> object that contains the + <dd>for a SheetCellRange object that contains the data.</dd> </dl> diff --git a/offapi/com/sun/star/sheet/XFunctionDescriptions.idl b/offapi/com/sun/star/sheet/XFunctionDescriptions.idl index 83ded0096d08..ae3668f78b23 100644 --- a/offapi/com/sun/star/sheet/XFunctionDescriptions.idl +++ b/offapi/com/sun/star/sheet/XFunctionDescriptions.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module sheet { <p>The container access methods return a sequence of <type scope="com::sun::star::beans">PropertyValue</type> structs. The properties contained in the sequence are collected in the service - <type>FunctionDescription</type>.</p> + FunctionDescription.</p> @see com::sun::star::sheet::FunctionDescriptions */ @@ -45,11 +45,11 @@ published interface XFunctionDescriptions: com::sun::star::container::XIndexAcce @param nId is the identifier of the function description (the same that - is used in the service <type>RecentFunctions</type>.</p> + is used in the service RecentFunctions.</p> @returns the sequence of property values (described in - <type>FunctionDescription</type>). + FunctionDescription). */ sequence< com::sun::star::beans::PropertyValue > getById( [in] long nId ) raises( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/sheet/XNamedRange.idl b/offapi/com/sun/star/sheet/XNamedRange.idl index f70c25eafbd7..fe0feb75856a 100644 --- a/offapi/com/sun/star/sheet/XNamedRange.idl +++ b/offapi/com/sun/star/sheet/XNamedRange.idl @@ -67,7 +67,7 @@ published interface XNamedRange: com::sun::star::container::XNamed /** returns the type of the named range. <p>This is a combination of flags as defined in - <type>NamedRangeFlag</type>.</p> + NamedRangeFlag.</p> */ long getType(); @@ -76,7 +76,7 @@ published interface XNamedRange: com::sun::star::container::XNamed @param nType a combination of flags that specify the type of a named range, - as defined in <type>NamedRangeFlag</type>. + as defined in NamedRangeFlag. */ void setType( [in] long nType ); diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl b/offapi/com/sun/star/sheet/XNamedRanges.idl index e9009241012d..e393be77c2e4 100644 --- a/offapi/com/sun/star/sheet/XNamedRanges.idl +++ b/offapi/com/sun/star/sheet/XNamedRanges.idl @@ -54,7 +54,7 @@ published interface XNamedRanges: com::sun::star::container::XNameAccess @param nType a combination of flags that specify the type of a named range, - as defined in <type>NamedRangeFlag</type>. + as defined in NamedRangeFlag. <p>This parameter will be zero for any common named range.</p> */ diff --git a/offapi/com/sun/star/sheet/XRangeSelection.idl b/offapi/com/sun/star/sheet/XRangeSelection.idl index 2d8c9021c9a7..8aa5ccc29ba6 100644 --- a/offapi/com/sun/star/sheet/XRangeSelection.idl +++ b/offapi/com/sun/star/sheet/XRangeSelection.idl @@ -38,7 +38,7 @@ published interface XRangeSelection: com::sun::star::uno::XInterface /** starts the range selection. @param aArguments - the <type>RangeSelectionArguments</type> that specify how the + the RangeSelectionArguments that specify how the range selection is done. */ void startRangeSelection( diff --git a/offapi/com/sun/star/sheet/XSheetCellRange.idl b/offapi/com/sun/star/sheet/XSheetCellRange.idl index 51a8096e4e4f..c76a15aafc46 100644 --- a/offapi/com/sun/star/sheet/XSheetCellRange.idl +++ b/offapi/com/sun/star/sheet/XSheetCellRange.idl @@ -39,7 +39,7 @@ published interface XSheetCellRange: com::sun::star::table::XCellRange /** returns the spreadsheet interface which contains the cell range. @returns - a <type>Spreadsheet</type> object. + a Spreadsheet object. @see com::sun::star::sheet::SheetCellRange @see com::sun::star::sheet::SheetCellRanges diff --git a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl index 7c4e114c6fc5..7d3734742b27 100644 --- a/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl +++ b/offapi/com/sun/star/sheet/XSheetConditionalEntries.idl @@ -40,7 +40,7 @@ published interface XSheetConditionalEntries: com::sun::star::container::XIndexA <p>Supported properties are:</p> <dl> - <dt><type>ConditionOperator</type> Operator</dt> + <dt>ConditionOperator Operator</dt> <dd>contains the operation to perform for this condition.</dd> <dt><atom>string</atom> Formula1</dt> diff --git a/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl b/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl index 441fff0815ce..50460035dd19 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterDescriptor2.idl @@ -29,9 +29,9 @@ module com { module sun { module star { module sheet { /** provides access to a collection of filter conditions (filter fields). - <p>This interface uses the <type>TableFilterField2</type> struct, - whereas the <type>XSheetFilterDescriptor</type> interface uses the - <type>TableFilterField</type> struct.</p> + <p>This interface uses the TableFilterField2 struct, + whereas the XSheetFilterDescriptor interface uses the + TableFilterField struct.</p> @see SheetFilterDescriptor @since OOo 3.2 diff --git a/offapi/com/sun/star/sheet/XSheetFilterDescriptor3.idl b/offapi/com/sun/star/sheet/XSheetFilterDescriptor3.idl index 10a303491f4f..2ceadcbd3c3e 100644 --- a/offapi/com/sun/star/sheet/XSheetFilterDescriptor3.idl +++ b/offapi/com/sun/star/sheet/XSheetFilterDescriptor3.idl @@ -17,9 +17,9 @@ module com { module sun { module star { module sheet { /** provides access to a collection of filter conditions (filter fields). - <p>This interface uses the <type>TableFilterField3</type> struct. - whereas the <type>XSheetFilterDescriptor2</type> interface uses the - <type>TableFilterField2</type> struct.</p> + <p>This interface uses the TableFilterField3 struct. + whereas the XSheetFilterDescriptor2 interface uses the + TableFilterField2 struct.</p> @see SheetFilterDescriptor2 diff --git a/offapi/com/sun/star/sheet/XSheetLinkable.idl b/offapi/com/sun/star/sheet/XSheetLinkable.idl index 80bae9e15a63..caec9d440596 100644 --- a/offapi/com/sun/star/sheet/XSheetLinkable.idl +++ b/offapi/com/sun/star/sheet/XSheetLinkable.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module sheet { <p>To insert a sheet link, the sheet used as linked sheet has to exist already. The method <member>XSheetLinkable::link</member> creates a - <type>SheetLink</type> object in the document's <type>SheetLinks</type> + SheetLink object in the document's SheetLinks collection and links the sheet to the specified external sheet.</p> @see com::sun::star::sheet::SheetLinks @@ -71,7 +71,7 @@ published interface XSheetLinkable: com::sun::star::uno::XInterface /** sets the target URL of the link. - <p>A <type>SheetLink</type> object with the same file name must + <p>A SheetLink object with the same file name must exist already or the link will not work.</p> */ void setLinkUrl( [in] string aLinkUrl ); @@ -84,7 +84,7 @@ published interface XSheetLinkable: com::sun::star::uno::XInterface /** sets the name of the linked sheet in the source document. - <p>This method sets the sheet name in the <type>SheetLink</type> + <p>This method sets the sheet name in the SheetLink object, it does not modify the sheet name in the source document.</p> */ void setLinkSheetName( [in] string aLinkSheetName ); @@ -92,7 +92,7 @@ published interface XSheetLinkable: com::sun::star::uno::XInterface /** links the sheet to another sheet in another document. - <p>A <type>SheetLink</type> object is created if it does not exist, + <p>A SheetLink object is created if it does not exist, and the link mode, the URL of the linked document and the linked sheet name are set.</p> */ diff --git a/offapi/com/sun/star/sheet/XSheetOperation.idl b/offapi/com/sun/star/sheet/XSheetOperation.idl index 4808b2cee0c8..7ec2e1a6d28b 100644 --- a/offapi/com/sun/star/sheet/XSheetOperation.idl +++ b/offapi/com/sun/star/sheet/XSheetOperation.idl @@ -53,7 +53,7 @@ published interface XSheetOperation: com::sun::star::uno::XInterface /** clears the specified contents of the current cell range(s). @param nContentFlags - a combination of <type>CellFlags</type> flags selecting the + a combination of CellFlags flags selecting the contents to be deleted. */ void clearContents( [in] long nContentFlags ); diff --git a/offapi/com/sun/star/sheet/XSpreadsheetView.idl b/offapi/com/sun/star/sheet/XSpreadsheetView.idl index 8d4c891d7c53..bc5aa062aee0 100644 --- a/offapi/com/sun/star/sheet/XSpreadsheetView.idl +++ b/offapi/com/sun/star/sheet/XSpreadsheetView.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module sheet { -/** is the main interface of a <type>SpreadsheetView</type>. It +/** is the main interface of a SpreadsheetView. It manages the active sheet within this view. */ published interface XSpreadsheetView: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl b/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl index d63676a2ae41..e21ca11b043f 100644 --- a/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl +++ b/offapi/com/sun/star/sheet/XUniqueCellFormatRangesSupplier.idl @@ -44,7 +44,7 @@ published interface XUniqueCellFormatRangesSupplier: com::sun::star::uno::XInter <p>All equal-formatted ranges are consolidated into one collection. These collections are the members contained in a - <type>UniqueCellFormatRanges</type> collection.</p> + UniqueCellFormatRanges collection.</p> @returns the collection of equal-formatted cell range collections. diff --git a/offapi/com/sun/star/sheet/XViewFreezable.idl b/offapi/com/sun/star/sheet/XViewFreezable.idl index c80b7f55193b..a63d47dcfd1b 100644 --- a/offapi/com/sun/star/sheet/XViewFreezable.idl +++ b/offapi/com/sun/star/sheet/XViewFreezable.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sheet { -/** enables a <type>SpreadsheetView</type> to freeze +/** enables a SpreadsheetView to freeze columns and rows of the view. */ published interface XViewFreezable: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/sheet/XViewSplitable.idl b/offapi/com/sun/star/sheet/XViewSplitable.idl index 157b7dadb436..33a778edc54a 100644 --- a/offapi/com/sun/star/sheet/XViewSplitable.idl +++ b/offapi/com/sun/star/sheet/XViewSplitable.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module sheet { -/** enables a <type>SpreadsheetView</type> to split the view. +/** enables a SpreadsheetView to split the view. @deprecated */ diff --git a/offapi/com/sun/star/smarttags/SmartTagAction.idl b/offapi/com/sun/star/smarttags/SmartTagAction.idl index b4151fdc66db..3e494dd091f6 100644 --- a/offapi/com/sun/star/smarttags/SmartTagAction.idl +++ b/offapi/com/sun/star/smarttags/SmartTagAction.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module smarttags { <p>An implementation of this service defines one or more actions that can be performed for a smart tag which has been recognized - by a <type>SmartTagRecognizer</type> service.</p> + by a SmartTagRecognizer service.</p> @since OOo 2.3 */ diff --git a/offapi/com/sun/star/smarttags/SmartTagRecognizer.idl b/offapi/com/sun/star/smarttags/SmartTagRecognizer.idl index c9df9f4dc646..95b1d1b39ce0 100644 --- a/offapi/com/sun/star/smarttags/SmartTagRecognizer.idl +++ b/offapi/com/sun/star/smarttags/SmartTagRecognizer.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module smarttags { <p>Implementations of this service are used to scan the document text for smart tags. Smart tags are pieces of text that can be associated with specific actions which are defined by - implementations of the <type>SmartTagAction</type> service.</p> + implementations of the SmartTagAction service.</p> @since OOo 2.3 */ diff --git a/offapi/com/sun/star/style/ParagraphProperties.idl b/offapi/com/sun/star/style/ParagraphProperties.idl index 1a374362f1f5..a44a6ca24c30 100644 --- a/offapi/com/sun/star/style/ParagraphProperties.idl +++ b/offapi/com/sun/star/style/ParagraphProperties.idl @@ -238,7 +238,7 @@ published service ParagraphProperties <p>The name must be one of the names which are available via - <type>XStyleFamiliesSupplier</type>.</p> + XStyleFamiliesSupplier.</p> */ [optional, property] string NumberingStyleName; diff --git a/offapi/com/sun/star/style/StyleFamilies.idl b/offapi/com/sun/star/style/StyleFamilies.idl index 70dd9013a851..70b012e64a41 100644 --- a/offapi/com/sun/star/style/StyleFamilies.idl +++ b/offapi/com/sun/star/style/StyleFamilies.idl @@ -76,14 +76,14 @@ published service StyleFamilies /** This mandatory interface makes it possible to get access to the style families by their names. - <p>The elements within this collection are <type>StyleFamily</type> instances. + <p>The elements within this collection are StyleFamily instances. */ interface com::sun::star::container::XNameAccess; /** This optional interface makes it possible to get access to the style families by index. - <p>The elements within this collection are <type>StyleFamily</type> instances. + <p>The elements within this collection are StyleFamily instances. */ [optional] interface com::sun::star::container::XIndexAccess; diff --git a/offapi/com/sun/star/style/StyleFamily.idl b/offapi/com/sun/star/style/StyleFamily.idl index 1da948070437..d48e263ad9c4 100644 --- a/offapi/com/sun/star/style/StyleFamily.idl +++ b/offapi/com/sun/star/style/StyleFamily.idl @@ -36,7 +36,7 @@ published service StyleFamily the style sheets within this family by name. <p>The elements in this container support the service - <type>Style</type> and are accessed via an <type>XStyle</type>. + Style and are accessed via an XStyle. */ interface com::sun::star::container::XNameAccess; @@ -44,14 +44,14 @@ published service StyleFamily remove the style sheets within this family by name. <p>The elements in this container support the service - <type>Style</type> and are accessed via an <type>XStyle</type>. + Style and are accessed via an XStyle. */ [optional] interface com::sun::star::container::XNameContainer; /** This optional interface makes it possible to access the style sheets within this family by index. <p>The elements in this container support the service - <type>Style</type> and are accessed via an <type>XStyle</type>. + Style and are accessed via an XStyle. */ [optional] interface com::sun::star::container::XIndexAccess; diff --git a/offapi/com/sun/star/style/XStyleSupplier.idl b/offapi/com/sun/star/style/XStyleSupplier.idl index 1e9e171ae183..0b9706da30c0 100644 --- a/offapi/com/sun/star/style/XStyleSupplier.idl +++ b/offapi/com/sun/star/style/XStyleSupplier.idl @@ -39,14 +39,14 @@ interface XStyleSupplier : ::com::sun::star::uno::XInterface @return the style. If no style was set, the returned object may be empty (null). Otherwise, the returned object must support the service - <type>PropertyTemplate</type>. + PropertyTemplate. */ ::com::sun::star::style::XStyle getStyle(); /** @param xStyle If you want to remove an existing style, you can set an empty (null) object. Otherwise, the object given must support the service - <type>PropertyTemplate</type>. + PropertyTemplate. */ void setStyle( [in] ::com::sun::star::style::XStyle xStyle ) raises( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/system/SimpleMailClientFlags.idl b/offapi/com/sun/star/system/SimpleMailClientFlags.idl index da8b7c1dc28d..c95abb1989cc 100644 --- a/offapi/com/sun/star/system/SimpleMailClientFlags.idl +++ b/offapi/com/sun/star/system/SimpleMailClientFlags.idl @@ -37,7 +37,7 @@ published constants SimpleMailClientFlags /** Does not show the current configured system mail client, but sends the mail without any further user interaction. If this flag is specified, a recipient address must have been - specified for the given <type>XSimpleMailMessage</type> + specified for the given XSimpleMailMessage object given to the method <member scope="com::sun::star::system">XSimpleMailClient::sendSimpleMailMessage()</member>. */ diff --git a/offapi/com/sun/star/system/SystemShellExecuteException.idl b/offapi/com/sun/star/system/SystemShellExecuteException.idl index 253fe6fa5676..5395da154f44 100644 --- a/offapi/com/sun/star/system/SystemShellExecuteException.idl +++ b/offapi/com/sun/star/system/SystemShellExecuteException.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module system { -/** May be thrown in cases of errors executing a command using the <type>SystemShellExecute</type> service. +/** May be thrown in cases of errors executing a command using the SystemShellExecute service. <member scope="com::sun::star::uno">Exception::Message</member> may contain a system error message, but it is not mandatory. The member PosixError specifies a POSIX conforming error code or -1 for diff --git a/offapi/com/sun/star/system/SystemShellExecuteFlags.idl b/offapi/com/sun/star/system/SystemShellExecuteFlags.idl index 27859666abd6..9a2923677ca5 100644 --- a/offapi/com/sun/star/system/SystemShellExecuteFlags.idl +++ b/offapi/com/sun/star/system/SystemShellExecuteFlags.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module system { -/** Different settings for the <type>SystemShellExecute</type> service. +/** Different settings for the SystemShellExecute service. */ published constants SystemShellExecuteFlags diff --git a/offapi/com/sun/star/system/XSimpleMailClient.idl b/offapi/com/sun/star/system/XSimpleMailClient.idl index f332e54f97c7..4fdf47401c6b 100644 --- a/offapi/com/sun/star/system/XSimpleMailClient.idl +++ b/offapi/com/sun/star/system/XSimpleMailClient.idl @@ -35,14 +35,14 @@ module com { module sun { module star { module system { published interface XSimpleMailClient: com::sun::star::uno::XInterface { /** Create a simple mail message object that implements the interface - <type>XSimpleMailMessage</type>. + XSimpleMailMessage. @returns - An object that implements the <type>XSimpleMailMessage</type> interface. + An object that implements the XSimpleMailMessage interface. */ XSimpleMailMessage createSimpleMailMessage( ); /** Sends a given simple mail message object that implements the interface - <type>XSimpleMailMessage</type>. + XSimpleMailMessage. @param xSimpleMailMessage Specifies a configured mail object to be sent. diff --git a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl index eadbe45ba2a1..04f87d347666 100644 --- a/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl +++ b/offapi/com/sun/star/system/XSimpleMailClientSupplier.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module system { published interface XSimpleMailClientSupplier: com::sun::star::uno::XInterface { /** Allows a client to query for an object that implements - <type>XSimpleMailClient</type>. + XSimpleMailClient. @returns An interface to a simple mail client if there is one available on the system or an empty reference else. diff --git a/offapi/com/sun/star/table/CellProperties.idl b/offapi/com/sun/star/table/CellProperties.idl index 7d622a14985f..f9634b6a4aab 100644 --- a/offapi/com/sun/star/table/CellProperties.idl +++ b/offapi/com/sun/star/table/CellProperties.idl @@ -217,7 +217,7 @@ published service CellProperties /** contains a description of the top border line of each cell. - Preferred over <type>BorderLine</type> <member>TopBorder</member>. + Preferred over BorderLine <member>TopBorder</member>. @since LibreOffice 3.6 */ @@ -225,7 +225,7 @@ published service CellProperties /** contains a description of the bottom border line of each cell. - Preferred over <type>BorderLine</type> <member>BottomBorder</member>. + Preferred over BorderLine <member>BottomBorder</member>. @since LibreOffice 3.6 */ @@ -233,7 +233,7 @@ published service CellProperties /** contains a description of the left border line of each cell. - Preferred over <type>BorderLine</type> <member>LeftBorder</member>. + Preferred over BorderLine <member>LeftBorder</member>. @since LibreOffice 3.6 */ @@ -241,7 +241,7 @@ published service CellProperties /** contains a description of the right border line of each cell. - Preferred over <type>BorderLine</type> <member>RightBorder</member>. + Preferred over BorderLine <member>RightBorder</member>. @since LibreOffice 3.6 */ @@ -249,7 +249,7 @@ published service CellProperties /** contains a description of the top left to bottom right diagonal line of each cell. - Preferred over <type>BorderLine</type> <member>DiagonalTLBR</member>. + Preferred over BorderLine <member>DiagonalTLBR</member>. @since LibreOffice 3.6 */ @@ -257,7 +257,7 @@ published service CellProperties /** contains a description of the bottom left to top right diagonal line of each cell. - Preferred over <type>BorderLine</type> <member>DiagonalBLTR</member>. + Preferred over BorderLine <member>DiagonalBLTR</member>. @since LibreOffice 3.6 */ diff --git a/offapi/com/sun/star/table/ListPositionCellBinding.idl b/offapi/com/sun/star/table/ListPositionCellBinding.idl index f60dbce7562d..e3a786654f6e 100644 --- a/offapi/com/sun/star/table/ListPositionCellBinding.idl +++ b/offapi/com/sun/star/table/ListPositionCellBinding.idl @@ -35,7 +35,7 @@ service ListPositionCellBinding /** provides the basic functionality for exchanging values with a table cell. <p>Additionally to the types supported by the super service, the - <type>ListPositionCellBinding</type> allows exchanging integer values.</p> + ListPositionCellBinding allows exchanging integer values.</p> @see com::sun::star::form::binding::XValueBinding::getSupportedTypes */ diff --git a/offapi/com/sun/star/table/ShadowLocation.idl b/offapi/com/sun/star/table/ShadowLocation.idl index 3672699e68b1..1a810af94f67 100644 --- a/offapi/com/sun/star/table/ShadowLocation.idl +++ b/offapi/com/sun/star/table/ShadowLocation.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module table { -/** specifies the location of the shadow in a <type>ShadowFormat</type>. +/** specifies the location of the shadow in a ShadowFormat. */ published enum ShadowLocation { diff --git a/offapi/com/sun/star/table/TableBorder2.idl b/offapi/com/sun/star/table/TableBorder2.idl index 5789b4e87737..554f5f7f9cb0 100644 --- a/offapi/com/sun/star/table/TableBorder2.idl +++ b/offapi/com/sun/star/table/TableBorder2.idl @@ -20,8 +20,8 @@ module com { module sun { module star { module table { range. TableBorder2 is nearly identical to TableBorder, except that it has - members of <type>BorderLine2</type> instead of - <type>BorderLine</type>. + members of BorderLine2 instead of + BorderLine. <p>In a queried structure, the flags in <member>TableBorder2::Is...LineValid</member> indicate that not all diff --git a/offapi/com/sun/star/task/AsyncJob.idl b/offapi/com/sun/star/task/AsyncJob.idl index 4530e3d746fc..f11e9532a829 100644 --- a/offapi/com/sun/star/task/AsyncJob.idl +++ b/offapi/com/sun/star/task/AsyncJob.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module task { -/** represent an asynchronous job, which can be executed by the global <type>JobExecutor</type> +/** represent an asynchronous job, which can be executed by the global JobExecutor instance. @see Job diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl index 3243dc238638..9df88fab0f3b 100644 --- a/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module task { /** this request specifies the mode in which the password for Microsoft Office file format encryption should be asked <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used to interact for a document password. Continuations for using with the mentioned service are Abort and Approve. </P> diff --git a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl index 4ae26bb16bc1..64fca4e971f4 100644 --- a/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl +++ b/offapi/com/sun/star/task/DocumentMSPasswordRequest2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module task { /** this request specifies if a password for opening or modifying of an encrypted Microsoft Office document is requested. <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used to interact for a document password. Continuations for using with the mentioned service are Abort and Approve. </P> diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest.idl b/offapi/com/sun/star/task/DocumentPasswordRequest.idl index 68a896ec02b7..762dd4a9cfbb 100644 --- a/offapi/com/sun/star/task/DocumentPasswordRequest.idl +++ b/offapi/com/sun/star/task/DocumentPasswordRequest.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module task { /** this request specifies the mode in which the password should be asked <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used to interact for a document password. Continuations for using with the mentioned service are Abort and Approve. </P> diff --git a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl index e195bb7629a4..9fcc19a81627 100644 --- a/offapi/com/sun/star/task/DocumentPasswordRequest2.idl +++ b/offapi/com/sun/star/task/DocumentPasswordRequest2.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module task { /** this request specifies if a password for opening or modifying a document is requested. <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used to interact for a document password. Continuations for using with the mentioned service are Abort and Approve. </P> diff --git a/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl b/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl index e2876b0a6161..6ca61a3bc1d2 100644 --- a/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl +++ b/offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl @@ -30,8 +30,8 @@ module com { module sun { module star { module task { an ODF document was encountered which conforms to an ODF version unknown to the current OpenOffice.org version. - <p>An interaction request of this type usually comes with an <type>XInteractionApprove</type>, - and <type>XInteractionDisapprove</type>, and <type>XInteractionAskLater</type> continuation.</p> + <p>An interaction request of this type usually comes with an XInteractionApprove, + and XInteractionDisapprove, and XInteractionAskLater continuation.</p> */ exception FutureDocumentVersionProductUpdateRequest : ClassifiedInteractionRequest { diff --git a/offapi/com/sun/star/task/InteractionRequestStringResolver.idl b/offapi/com/sun/star/task/InteractionRequestStringResolver.idl index 6dc2f678454d..29a5c8a13468 100644 --- a/offapi/com/sun/star/task/InteractionRequestStringResolver.idl +++ b/offapi/com/sun/star/task/InteractionRequestStringResolver.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module com { module sun { module star { module task { /* An interaction request string resolver that obtains human readable strings - from an <type>XInteractionRequest</type>. + from an XInteractionRequest. */ /* published */ service InteractionRequestStringResolver : XInteractionRequestStringResolver; diff --git a/offapi/com/sun/star/task/Job.idl b/offapi/com/sun/star/task/Job.idl index 7f7887603ed9..69a5305b53f2 100644 --- a/offapi/com/sun/star/task/Job.idl +++ b/offapi/com/sun/star/task/Job.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module task { -/** represent a synchronous job, which can be executed by the global <type>JobExecutor</type> +/** represent a synchronous job, which can be executed by the global JobExecutor instance. @see AsyncJob diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl index 7bdb86195fa3..41737f3fd04a 100644 --- a/offapi/com/sun/star/task/JobExecutor.idl +++ b/offapi/com/sun/star/task/JobExecutor.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module task { own configuration and there lifetime. Such events are simple strings which meaning doesn't matter for any real service implementation of this specification. But triggered events must be available inside the - configuration and some <type>Job</type>s or <type>AsyncJob</type>s must be registered for that. + configuration and some Jobs or AsyncJobs must be registered for that. </p> @see Job diff --git a/offapi/com/sun/star/task/MasterPasswordRequest.idl b/offapi/com/sun/star/task/MasterPasswordRequest.idl index 853e5c4cae2f..fcc88d08b30d 100644 --- a/offapi/com/sun/star/task/MasterPasswordRequest.idl +++ b/offapi/com/sun/star/task/MasterPasswordRequest.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module task { /** this request specifies the mode in which the password should be asked <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used to interact for a master password. Continuations for using with the mentioned service are Abort and Approve. </P> diff --git a/offapi/com/sun/star/task/PasswordContainer.idl b/offapi/com/sun/star/task/PasswordContainer.idl index b66802482e33..530b912e2f3d 100644 --- a/offapi/com/sun/star/task/PasswordContainer.idl +++ b/offapi/com/sun/star/task/PasswordContainer.idl @@ -34,8 +34,8 @@ module com { module sun { module star { module task { The persistent way is only possible if configuration allows to use storage. It stores passwords encrypted with a super password. An interaction is used to ask a user for a super password. - To allow such an interaction, an object that implements <type>XInteractionHandler</type> - interface should be provided. For this purpose <type>InteractionHandler</type> + To allow such an interaction, an object that implements XInteractionHandler + interface should be provided. For this purpose InteractionHandler service can be used. </p> @@ -43,7 +43,7 @@ module com { module sun { module star { module task { In case no interaction handler is provided all passwords are stored for the session period. In case an interaction handler is provided, but the super password interaction does not return super password ( for any reason ), - <type>NoMasterException</type> exception is thrown to let user use + NoMasterException exception is thrown to let user use non-persistent way explicitly. </p> */ diff --git a/offapi/com/sun/star/task/PasswordRequest.idl b/offapi/com/sun/star/task/PasswordRequest.idl index 565343137dfe..855e1210a872 100644 --- a/offapi/com/sun/star/task/PasswordRequest.idl +++ b/offapi/com/sun/star/task/PasswordRequest.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module task { /** this request specifies the mode in which the password should be asked <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used to interact for a password. Continuations for using with the mentioned service are Abort and Approve. </P> diff --git a/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl b/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl index 6d716cdb08b2..840f26912c18 100644 --- a/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl +++ b/offapi/com/sun/star/task/UnsupportedOverwriteRequest.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module task { /** this request is used in case a content can't keep files from overwriting <P> - It is supported by <type>InteractionHandler</type> service, and can + It is supported by InteractionHandler service, and can be used in case a content can not keep files from overwriting and user specifies to do so. Continuations for using with the mentioned service are Abort and Approve. diff --git a/offapi/com/sun/star/task/UserRecord.idl b/offapi/com/sun/star/task/UserRecord.idl index f5493069579e..f04a4176d673 100644 --- a/offapi/com/sun/star/task/UserRecord.idl +++ b/offapi/com/sun/star/task/UserRecord.idl @@ -22,7 +22,7 @@ module com { module sun { module star { module task { -/* Specifies user/password entries for <type>UrlRecord</type>. +/* Specifies user/password entries for UrlRecord. */ published struct UserRecord { diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl index 231a097184c2..5f00ce4e9dd8 100644 --- a/offapi/com/sun/star/task/XAsyncJob.idl +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module task { /** specifies a job which must be executed asynchronously <p> - Instead of <type>XJob</type> the implementation of this interface + Instead of XJob the implementation of this interface must be aware, that execution can be made real asynchronous (e.g. by using threads). Because the environment wish to have creation and using of threads under control, it's not allowed for a real job implementation to use such mechanism @@ -50,7 +50,7 @@ published interface XAsyncJob : com::sun::star::uno::XInterface @param Arguments are arguments for executing the job. Their semantics is completely implementation dependent. Usually, a concrete implementation of a job specifies in its service descriptions which parameters are allowed - (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> + (or expected). This values are persistent by the configuration of the JobExecutor which use this asynchronous job. It's possible to write it back by called listener function <member>XJobListener::jobFinished()</member>. diff --git a/offapi/com/sun/star/task/XInteractionPassword2.idl b/offapi/com/sun/star/task/XInteractionPassword2.idl index c7d98e77549a..7160184ab2fc 100644 --- a/offapi/com/sun/star/task/XInteractionPassword2.idl +++ b/offapi/com/sun/star/task/XInteractionPassword2.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module task { /** A continuation to get a password from interaction helper, extends - <type>XInteractionPassword</type> with possibility to provide password + XInteractionPassword with possibility to provide password to modify. @since OOo 3.3 diff --git a/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl b/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl index 8f66153cdc3f..4a1be4a60ea3 100644 --- a/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl +++ b/offapi/com/sun/star/task/XInteractionRequestStringResolver.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module task { -/** Obtains human readable strings from an <type>XInteractionRequest</type>. +/** Obtains human readable strings from an XInteractionRequest. */ /* published */ interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface @@ -41,7 +41,7 @@ interface XInteractionRequestStringResolver : com::sun::star::uno::XInterface <p>An informational interaction request contains not more than one interaction continuation (user has no choice; request is just informational). The supplies continuation must either be a - <type>XInteractionAbort</type> or <type>XInteractionApprove</type> + XInteractionAbort or XInteractionApprove @param Request the interaction request for that the message shall be obtained. diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl index 28a61934108f..54b50b488ae6 100644 --- a/offapi/com/sun/star/task/XJob.idl +++ b/offapi/com/sun/star/task/XJob.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module task { /** specifies a job which is to be executed synchronously <p> - Instead of <type>XAsyncJob</type> the implementation of this interface + Instead of XAsyncJob the implementation of this interface will be executed synchronously everytime. That means: they can be sure that the current stack context will be blocked till this job finish it's work. </p> @@ -44,7 +44,7 @@ published interface XJob : com::sun::star::uno::XInterface @param Arguments are arguments for executing the job. Their semantics is completely implementation dependent. Usually, a concrete implementation of a job specifies in its service descriptions which parameters are allowed - (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> + (or expected). This values are persistent by the configuration of the JobExecutor which use this synchronous job. It's possible to write it back by use special protocol in return value. diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl index d7a8fe18770e..151b729c7f01 100644 --- a/offapi/com/sun/star/task/XJobListener.idl +++ b/offapi/com/sun/star/task/XJobListener.idl @@ -34,14 +34,14 @@ published interface XJobListener : com::sun::star::lang::XEventListener /** indicates that the job is done @param Job - identifies the asynchronous job so the <type>JobExecutor</type> + identifies the asynchronous job so the JobExecutor can differ between more then ones. @param Result should be the same like for the synchronous mode on <member>XJob::execute()</member>. It provides information about success or failure of job execution. It's possible too, to use special protocol (which depends from real implementation) between - <type>JobExecutor</type> and a real job. So it can be possible to: + JobExecutor and a real job. So it can be possible to: <ul> <li>deregister the job</li> diff --git a/offapi/com/sun/star/task/XMasterPasswordHandling.idl b/offapi/com/sun/star/task/XMasterPasswordHandling.idl index 8e2d2ec68603..9c79189f40c4 100644 --- a/offapi/com/sun/star/task/XMasterPasswordHandling.idl +++ b/offapi/com/sun/star/task/XMasterPasswordHandling.idl @@ -39,7 +39,7 @@ published interface XMasterPasswordHandling : com::sun::star::uno::XInterface <p> The call will use the standard interaction handler service - <type>InteractionHandler</type> if no handler is provided. + InteractionHandler if no handler is provided. </p> */ @@ -54,7 +54,7 @@ published interface XMasterPasswordHandling : com::sun::star::uno::XInterface <p> The call will use the standard interaction handler service - <type>InteractionHandler</type> if no handler is provided. + InteractionHandler if no handler is provided. </p> */ boolean changeMasterPassword( [in] XInteractionHandler xHandler ); diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl index 6c6b9b26aeed..a5e471de864a 100644 --- a/offapi/com/sun/star/task/XStatusIndicator.idl +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -28,7 +28,7 @@ longer actions to the user <p> - Such objects are provided by a <type>XStatusIndicatorFactory</type>. + Such objects are provided by a XStatusIndicatorFactory. </p> @see XStatusIndicatorFactory diff --git a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl index 39f507a25272..7d6e050d35c1 100644 --- a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl +++ b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module task { -/** use <type>XStatusIndicatorFactory</type> instead of this +/** use XStatusIndicatorFactory instead of this @deprecated */ diff --git a/offapi/com/sun/star/text/AccessiblePageView.idl b/offapi/com/sun/star/text/AccessiblePageView.idl index 688a67dd50c8..bf747158b669 100644 --- a/offapi/com/sun/star/text/AccessiblePageView.idl +++ b/offapi/com/sun/star/text/AccessiblePageView.idl @@ -85,7 +85,7 @@ service AccessiblePageView >AccessibleTextFrameView</type>: A child of this kind is returned for every text frame that is contained in the page. These objects - are children of the <type>AccessiblePageView</type> + are children of the AccessiblePageView regardless whether they are bound to the page, a paragraph, a frame, or a character. The only exception are text frames that are bound as @@ -95,7 +95,7 @@ service AccessiblePageView >AccessibleTextGraphicObject</type>: A child of this kind is returned for every graphic that is contained in the page. These objects are - children of the <type>AccessiblePageView</type> + children of the AccessiblePageView regardless whether they are bound to a page, paragraph, a frame or a character. The only exception are text frames that are bound as character. They are @@ -105,7 +105,7 @@ service AccessiblePageView A child of this kind is returned for every embedded object that is contained in the page. These objects are children of the - <type>AccessibleTextDocumentView</type> regardless + AccessibleTextDocumentView regardless whether they are bound to a page, a paragraph, a frame, or a character. They are children of the paragraph they are contained in. @@ -114,7 +114,7 @@ service AccessiblePageView A child of this kind (or one of its derived interfaces) is returned for every shape that is contained in the page. These objects are children of - the <type>AccessibleTextDocumentView</type> + the AccessibleTextDocumentView regardless whether they are bound to a page, a paragraph, a frame or a character. </ul> diff --git a/offapi/com/sun/star/text/AccessibleTextDocumentView.idl b/offapi/com/sun/star/text/AccessibleTextDocumentView.idl index 3415f9300213..b9c337f948aa 100644 --- a/offapi/com/sun/star/text/AccessibleTextDocumentView.idl +++ b/offapi/com/sun/star/text/AccessibleTextDocumentView.idl @@ -80,7 +80,7 @@ service AccessibleTextDocumentView kind is returned for every text frame that is at least partially visible. These objects are children of the - <type>AccessibleTextDocumentView</type> regardless + AccessibleTextDocumentView regardless whether they are bound to a page, a paragraph, a frame, or a character. The only exception are text frames that are bound as character. They are children @@ -89,7 +89,7 @@ service AccessibleTextDocumentView >AccessibleTextGraphicObject</type>: A child of this kind is returned for every graphic that is at least partially visible. These objects are - children of the <type>AccessibleTextDocumentView</type> + children of the AccessibleTextDocumentView regardless whether they are bound to a page, paragraph, a frame or a character. The only exception are text frames that are bound as character. They are @@ -99,7 +99,7 @@ service AccessibleTextDocumentView A child of this kind is returned for every embedded object that is at least partially visible. These objects are children of the - <type>AccessibleTextDocumentView</type> regardless + AccessibleTextDocumentView regardless whether they are bound to a page, a paragraph, a frame, or a character. They are children of the paragraph they are contained in. @@ -108,7 +108,7 @@ service AccessibleTextDocumentView derived interface) is returned for every shape that is at least partially visible. These objects are children of the - <type>AccessibleTextDocumentView</type> regardless + AccessibleTextDocumentView regardless whether they are bound to a page, a paragraph, a frame or a character. </ul> diff --git a/offapi/com/sun/star/text/AutoTextEntry.idl b/offapi/com/sun/star/text/AutoTextEntry.idl index dffe7885307b..eb72c0a72a25 100644 --- a/offapi/com/sun/star/text/AutoTextEntry.idl +++ b/offapi/com/sun/star/text/AutoTextEntry.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module text { /** provides access to a text block in a group of - an <type>AutoTextContainer</type>. + an AutoTextContainer. @see com::sun::star::text::AutoTextContainer @see com::sun::star::text::AutoTextGroup */ @@ -35,7 +35,7 @@ published service AutoTextEntry { interface com::sun::star::text::XAutoTextEntry; - /** provides access to the <type>Text</type> of this entry. + /** provides access to the Text of this entry. */ interface com::sun::star::text::XText; diff --git a/offapi/com/sun/star/text/BaseIndexMark.idl b/offapi/com/sun/star/text/BaseIndexMark.idl index 28830ed96e9c..5646d3e8b951 100644 --- a/offapi/com/sun/star/text/BaseIndexMark.idl +++ b/offapi/com/sun/star/text/BaseIndexMark.idl @@ -26,9 +26,9 @@ module com { module sun { module star { module text { -/** is a <type>TextRange</type> which is explicitly marked - as an index entry. This is the base service of index marks for <type>DocumentIndex</type>, - <type>ContentIndex</type>, and <type>UserIndex</type>. +/** is a TextRange which is explicitly marked + as an index entry. This is the base service of index marks for DocumentIndex, + ContentIndex, and UserIndex. */ published service BaseIndexMark { diff --git a/offapi/com/sun/star/text/Bookmark.idl b/offapi/com/sun/star/text/Bookmark.idl index 61d369cd827c..fc73ca6365be 100644 --- a/offapi/com/sun/star/text/Bookmark.idl +++ b/offapi/com/sun/star/text/Bookmark.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module text { -/** A bookmark is a <type>TextContent</type>, which is like a jump +/** A bookmark is a TextContent, which is like a jump target or a label. */ published service Bookmark diff --git a/offapi/com/sun/star/text/Bookmarks.idl b/offapi/com/sun/star/text/Bookmarks.idl index 90273b73fba9..b9bafdb30bbc 100644 --- a/offapi/com/sun/star/text/Bookmarks.idl +++ b/offapi/com/sun/star/text/Bookmarks.idl @@ -26,19 +26,19 @@ module com { module sun { module star { module text { -/** This service specifies a collection of <type>Bookmark</type>s. +/** This service specifies a collection of Bookmarks. */ published service Bookmarks { /** makes it possible to access the bookmarks by their names. - <p>All contents support the service <type>Bookmark</type>. + <p>All contents support the service Bookmark. */ interface com::sun::star::container::XNameAccess; /** makes it possible to access the bookmarks by their index. - <p>All contents support the service <type>Bookmark</type>. + <p>All contents support the service Bookmark. */ interface com::sun::star::container::XIndexAccess; diff --git a/offapi/com/sun/star/text/ChainedTextFrame.idl b/offapi/com/sun/star/text/ChainedTextFrame.idl index 942401598f37..1b8c8185bedb 100644 --- a/offapi/com/sun/star/text/ChainedTextFrame.idl +++ b/offapi/com/sun/star/text/ChainedTextFrame.idl @@ -28,8 +28,8 @@ module com { module sun { module star { module text { -/** extends a <type>TextFrame</type> which shares the same <type>Text</type> - with other <type>ChainedTextFrame</type> instances that will make the text +/** extends a TextFrame which shares the same Text + with other ChainedTextFrame instances that will make the text flow through the chained frames. The text flows in the next frame if there is no space left in the current frame. */ diff --git a/offapi/com/sun/star/text/ContentIndexMark.idl b/offapi/com/sun/star/text/ContentIndexMark.idl index a6e0e7343fde..3a05f286b565 100644 --- a/offapi/com/sun/star/text/ContentIndexMark.idl +++ b/offapi/com/sun/star/text/ContentIndexMark.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module text { -/** is a <type>TextRange</type> which is explicitly marked - as an index entry for a <type>ContentIndex</type>. +/** is a TextRange which is explicitly marked + as an index entry for a ContentIndex. */ published service ContentIndexMark { diff --git a/offapi/com/sun/star/text/DependentTextField.idl b/offapi/com/sun/star/text/DependentTextField.idl index 6d1f44deb29c..325cfaaf7201 100644 --- a/offapi/com/sun/star/text/DependentTextField.idl +++ b/offapi/com/sun/star/text/DependentTextField.idl @@ -27,15 +27,15 @@ module com { module sun { module star { module text { -/** is a <type>TextField</type> which is not specified by itself, - but dependent on a <type>TextFieldMaster</type>.@see TextFieldMaster +/** is a TextField which is not specified by itself, + but dependent on a TextFieldMaster.@see TextFieldMaster */ published service DependentTextField { service com::sun::star::text::TextField; /** This interface makes it possible to attach a - <type>TextFieldMaster</type> to this <type>TextField</type>. + TextFieldMaster to this TextField. */ interface com::sun::star::text::XDependentTextField; diff --git a/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl b/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl index a58c57f86434..50d68d8d6357 100644 --- a/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl +++ b/offapi/com/sun/star/text/DocumentIndexLevelFormat.idl @@ -100,7 +100,7 @@ </li> <li> <p>ChapterFormat</p> - <p>Valid in chapter info and entry number only. See <type>ChapterFormat</type>.</p> + <p>Valid in chapter info and entry number only. See ChapterFormat.</p> <p>Other information.</p> <ul> <li> diff --git a/offapi/com/sun/star/text/DocumentIndexMark.idl b/offapi/com/sun/star/text/DocumentIndexMark.idl index a50123fa5a51..a62c9f33d702 100644 --- a/offapi/com/sun/star/text/DocumentIndexMark.idl +++ b/offapi/com/sun/star/text/DocumentIndexMark.idl @@ -27,8 +27,8 @@ module com { module sun { module star { module text { -/** is a <type>TextRange</type> which is explicitly marked - as an index entry for a <type>DocumentIndex</type>. +/** is a TextRange which is explicitly marked + as an index entry for a DocumentIndex. */ published service DocumentIndexMark { diff --git a/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl b/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl index 2bd9d2099ef6..d8d89a0eab29 100644 --- a/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl +++ b/offapi/com/sun/star/text/DocumentIndexMarkAsian.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module text { -/** is a <type>TextRange</type> which is explicitly marked - as an index entry for a <type>DocumentIndex</type>. +/** is a TextRange which is explicitly marked + as an index entry for a DocumentIndex. For Asian languages the user can provide an additional string which is used for sorting. If the user does not provide these strings, they are not considered for sorting. diff --git a/offapi/com/sun/star/text/DocumentIndexes.idl b/offapi/com/sun/star/text/DocumentIndexes.idl index bf70ded51260..09c51eb7adb2 100644 --- a/offapi/com/sun/star/text/DocumentIndexes.idl +++ b/offapi/com/sun/star/text/DocumentIndexes.idl @@ -31,19 +31,19 @@ */ published service DocumentIndexes { - /** This interface makes it possible to access all <type>BaseIndex</type> + /** This interface makes it possible to access all BaseIndex instances within this context (e.g., a document) by its name. <p>The type of the interfaces returned by this collection is - always <type>XDocumentIndex</type>. + always XDocumentIndex. */ interface com::sun::star::container::XNameAccess; - /** This interface makes it possible to access all <type>BaseIndex</type> + /** This interface makes it possible to access all BaseIndex instances within this context (e.g., a document) by its index. <p>The type of the interfaces returned by this collection is - always <type>XDocumentIndex</type>. + always XDocumentIndex. */ interface com::sun::star::container::XIndexAccess; diff --git a/offapi/com/sun/star/text/Endnote.idl b/offapi/com/sun/star/text/Endnote.idl index 71da3aceda4f..7bb7f10ed24e 100644 --- a/offapi/com/sun/star/text/Endnote.idl +++ b/offapi/com/sun/star/text/Endnote.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module text { /** This service specifies a an endnote in a - <type>TextDocument</type>. + TextDocument. */ published service Endnote { diff --git a/offapi/com/sun/star/text/Footnote.idl b/offapi/com/sun/star/text/Footnote.idl index f1c75b94a4b8..79cef92b65fd 100644 --- a/offapi/com/sun/star/text/Footnote.idl +++ b/offapi/com/sun/star/text/Footnote.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module text { /** This service specifies a footnote or an endnote in a - <type>TextDocument</type>. + TextDocument. */ published service Footnote { diff --git a/offapi/com/sun/star/text/InContentMetadata.idl b/offapi/com/sun/star/text/InContentMetadata.idl index b6efcd167000..4d8c0c1b3c1d 100644 --- a/offapi/com/sun/star/text/InContentMetadata.idl +++ b/offapi/com/sun/star/text/InContentMetadata.idl @@ -30,25 +30,25 @@ module com { module sun { module star { module text { -/** is a <type>TextContent</type> that can be used to attach RDF metadata +/** is a TextContent that can be used to attach RDF metadata to a range of text. @since OOo 3.2 */ service InContentMetadata { - /** None of the properties of <type>TextContent</type> are + /** None of the properties of TextContent are supported. */ service com::sun::star::text::TextContent; - /** The <type>InContentMetadata</type> can have RDF metadata attached. */ + /** The InContentMetadata can have RDF metadata attached. */ interface com::sun::star::rdf::XMetadatable; - /** The <type>TextContent</type>s that are contained in the + /** The TextContents that are contained in the annotated range of text can be enumerated. */ interface com::sun::star::container::XEnumerationAccess; - /** The <type>TextContent</type> that is the parent of this text range. + /** The TextContent that is the parent of this text range. @since OOo 3.3 */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/text/InvalidTextContentException.idl b/offapi/com/sun/star/text/InvalidTextContentException.idl index 3619c7471f9a..c15e2b892017 100644 --- a/offapi/com/sun/star/text/InvalidTextContentException.idl +++ b/offapi/com/sun/star/text/InvalidTextContentException.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module text { -/** is thrown whenever a method gets a <type>TextContent</type> +/** is thrown whenever a method gets a TextContent as an actual argument when the text content cannot be used for that operation. */ diff --git a/offapi/com/sun/star/text/NumberingRules.idl b/offapi/com/sun/star/text/NumberingRules.idl index 4857dab9a7d8..7ff2ebb5c83a 100644 --- a/offapi/com/sun/star/text/NumberingRules.idl +++ b/offapi/com/sun/star/text/NumberingRules.idl @@ -28,7 +28,7 @@ /** provides access to the numbering rules. - <p> Numbering rules may be set at a <type>Paragraph</type> object. The numbering rules are + <p> Numbering rules may be set at a Paragraph object. The numbering rules are levels of property values. Each level contains equal properties. </p> diff --git a/offapi/com/sun/star/text/PagePrintSettings.idl b/offapi/com/sun/star/text/PagePrintSettings.idl index b44c0411a023..854d365cde98 100644 --- a/offapi/com/sun/star/text/PagePrintSettings.idl +++ b/offapi/com/sun/star/text/PagePrintSettings.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module text { -/** These properties describe the way the <type>XPagePrintable</type> interface +/** These properties describe the way the XPagePrintable interface prints the page on one printer page. */ published service PagePrintSettings diff --git a/offapi/com/sun/star/text/Paragraph.idl b/offapi/com/sun/star/text/Paragraph.idl index be370a46fcd6..2f84ec9fe9d0 100644 --- a/offapi/com/sun/star/text/Paragraph.idl +++ b/offapi/com/sun/star/text/Paragraph.idl @@ -80,7 +80,7 @@ published service Paragraph /** This interface enumerates the text portions of this paragraph. - <p>A text portion is defined as the largest possible <type>TextRange</type> + <p>A text portion is defined as the largest possible TextRange within a paragraph with the same property values and the same bound objects. <p>In general this interface is used for exporting into file diff --git a/offapi/com/sun/star/text/ParagraphEnumeration.idl b/offapi/com/sun/star/text/ParagraphEnumeration.idl index 371212e57339..afdc2f610dcd 100644 --- a/offapi/com/sun/star/text/ParagraphEnumeration.idl +++ b/offapi/com/sun/star/text/ParagraphEnumeration.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module text { -/** provides access to the paragraphs of an <type>XText</type> +/** provides access to the paragraphs of an XText interface. */ published service ParagraphEnumeration diff --git a/offapi/com/sun/star/text/Shape.idl b/offapi/com/sun/star/text/Shape.idl index c086e4801019..a398878ed9de 100644 --- a/offapi/com/sun/star/text/Shape.idl +++ b/offapi/com/sun/star/text/Shape.idl @@ -47,7 +47,7 @@ published service Shape */ [property] com::sun::star::text::XTextFrame AnchorFrame; /** specifies how the text content is attached to its surrounding - <type>Text</type>. + Text. */ [optional, property] com::sun::star::text::TextContentAnchorType AnchorType; /** determines the horizontal orientation of the object. diff --git a/offapi/com/sun/star/text/TableColumnSeparator.idl b/offapi/com/sun/star/text/TableColumnSeparator.idl index 6c8f695e4b46..e10e58bc96af 100644 --- a/offapi/com/sun/star/text/TableColumnSeparator.idl +++ b/offapi/com/sun/star/text/TableColumnSeparator.idl @@ -32,7 +32,7 @@ </p> <p>A text table or a text table row provides the separators in a - sequence of <type>TableColumnSeparator</type>s. If the table only + sequence of TableColumnSeparators. If the table only consists of one column, then this sequence is empty. </p> diff --git a/offapi/com/sun/star/text/Text.idl b/offapi/com/sun/star/text/Text.idl index e696d2d001cc..0c0a7e58c5b8 100644 --- a/offapi/com/sun/star/text/Text.idl +++ b/offapi/com/sun/star/text/Text.idl @@ -57,7 +57,7 @@ published service Text interface XText; - /** optional interface to compare positions of <type>TextRange</type> + /** optional interface to compare positions of TextRange instances within this text. */ [optional] interface XTextRangeCompare; diff --git a/offapi/com/sun/star/text/TextContent.idl b/offapi/com/sun/star/text/TextContent.idl index 361cb25b2a9e..3f97b2e6070e 100644 --- a/offapi/com/sun/star/text/TextContent.idl +++ b/offapi/com/sun/star/text/TextContent.idl @@ -28,13 +28,13 @@ module com { module sun { module star { module text { /** is an object which can be anchored in a text, like instances of - <type>TextFrame</type> or <type>TextField</type>. + TextFrame or TextField. - <p>If the concrete <type>TextContent</type> has a textual + <p>If the concrete TextContent has a textual representation which fades into the surrounding text, then - <type>XTextField</type> is used. + XTextField is used. - <p>If the concrete <type>TextContent</type> has a "floating" object, + <p>If the concrete TextContent has a "floating" object, like a graphic, <type scope="com::sun::star::drawing">XShape</type> is used. @@ -54,7 +54,7 @@ published service TextContent interface com::sun::star::text::XTextContent; /** specifies how the text content is attached to its surrounding - <type>Text</type>. + Text. */ [optional, property] com::sun::star::text::TextContentAnchorType AnchorType; diff --git a/offapi/com/sun/star/text/TextCursor.idl b/offapi/com/sun/star/text/TextCursor.idl index c9c12d23eb36..864b127674ac 100644 --- a/offapi/com/sun/star/text/TextCursor.idl +++ b/offapi/com/sun/star/text/TextCursor.idl @@ -34,8 +34,8 @@ module com { module sun { module star { module text { -/** A <type>TextCursor</type> is a <type>TextRange</type> which can be moved - within a <type>Text</type> object. +/** A TextCursor is a TextRange which can be moved + within a Text object. @see TextRange */ published service TextCursor diff --git a/offapi/com/sun/star/text/TextDocumentView.idl b/offapi/com/sun/star/text/TextDocumentView.idl index 1207766ae1b1..220dc9ead5cf 100644 --- a/offapi/com/sun/star/text/TextDocumentView.idl +++ b/offapi/com/sun/star/text/TextDocumentView.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module text { -/** specifies the view of a <type>TextDocument</type>. +/** specifies the view of a TextDocument. */ published service TextDocumentView { diff --git a/offapi/com/sun/star/text/TextEmbeddedObjects.idl b/offapi/com/sun/star/text/TextEmbeddedObjects.idl index b400f65d6315..a92093148852 100644 --- a/offapi/com/sun/star/text/TextEmbeddedObjects.idl +++ b/offapi/com/sun/star/text/TextEmbeddedObjects.idl @@ -31,7 +31,7 @@ */ published service TextEmbeddedObjects { - /** This interface makes it possible to access all <type>TextEmbeddedObject</type> + /** This interface makes it possible to access all TextEmbeddedObject instances within this context (e.g. a document) by its name. <p>The type of the interfaces returned by this collection is @@ -39,7 +39,7 @@ published service TextEmbeddedObjects */ interface com::sun::star::container::XNameAccess; - /** This interface makes it possible to access all <type>TextEmbeddedObject</type> + /** This interface makes it possible to access all TextEmbeddedObject instances within this context (e.g. a document) by its index. <p>The type of the interfaces returned by this collection is diff --git a/offapi/com/sun/star/text/TextField.idl b/offapi/com/sun/star/text/TextField.idl index 124241b4ea6c..38c58e9afb1e 100644 --- a/offapi/com/sun/star/text/TextField.idl +++ b/offapi/com/sun/star/text/TextField.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module text { -/** A <type>TextField</type> is a <type>TextContent</type> which fades its +/** A TextField is a TextContent which fades its textual representation into the text range to which it is anchored. */ published service TextField diff --git a/offapi/com/sun/star/text/TextFieldMaster.idl b/offapi/com/sun/star/text/TextFieldMaster.idl index f0a72ac5ef43..d256391fac40 100644 --- a/offapi/com/sun/star/text/TextFieldMaster.idl +++ b/offapi/com/sun/star/text/TextFieldMaster.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module text { -/** A <type>TextFieldMaster</type> specifies important data for its - <type>DependentTextField</type>s. +/** A TextFieldMaster specifies important data for its + DependentTextFields. */ published service TextFieldMaster { diff --git a/offapi/com/sun/star/text/TextFieldMasters.idl b/offapi/com/sun/star/text/TextFieldMasters.idl index 1ed037483ddd..b4491ca8522a 100644 --- a/offapi/com/sun/star/text/TextFieldMasters.idl +++ b/offapi/com/sun/star/text/TextFieldMasters.idl @@ -24,14 +24,14 @@ module com { module sun { module star { module text { -/** This is a collection of instances of <type>TextFieldMaster</type>, defined +/** This is a collection of instances of TextFieldMaster, defined in a context (e.g. in a document). */ published service TextFieldMasters { /** This interface makes it possible to access the instances of service - <type>TextFieldMaster</type> defined in this context (e.g. this + TextFieldMaster defined in this context (e.g. this document). @see TextFieldMaster diff --git a/offapi/com/sun/star/text/TextFields.idl b/offapi/com/sun/star/text/TextFields.idl index 835d58e4db85..d16106cdcbe5 100644 --- a/offapi/com/sun/star/text/TextFields.idl +++ b/offapi/com/sun/star/text/TextFields.idl @@ -25,14 +25,14 @@ module com { module sun { module star { module text { -/** This is a collection of <type>TextField</type> instances. +/** This is a collection of TextField instances. */ published service TextFields { /** This interface makes it possible to create an enumeration through all text fields in this container. - <p>All elements are of type <type>XTextField</type>.</p> + <p>All elements are of type XTextField.</p> */ interface com::sun::star::container::XEnumerationAccess; diff --git a/offapi/com/sun/star/text/TextFrame.idl b/offapi/com/sun/star/text/TextFrame.idl index d3d1c08d4070..0bb87dda729a 100644 --- a/offapi/com/sun/star/text/TextFrame.idl +++ b/offapi/com/sun/star/text/TextFrame.idl @@ -26,15 +26,15 @@ module com { module sun { module star { module text { -/** specifies a rectangular shape which contains a <type>Text</type> object - and is attached to a piece of surrounding <type>Text</type>. +/** specifies a rectangular shape which contains a Text object + and is attached to a piece of surrounding Text. @see Text @example StarBasic - <p>This example shows how to create a <type>TextFrame</type> and insert - it at the very beginning of <type>Text</type> component. The macro + <p>This example shows how to create a TextFrame and insert + it at the very beginning of Text component. The macro is ready to run, if it is a script within a text document. </p> <listing> diff --git a/offapi/com/sun/star/text/TextFrames.idl b/offapi/com/sun/star/text/TextFrames.idl index 40064f107f5a..cce2b872d431 100644 --- a/offapi/com/sun/star/text/TextFrames.idl +++ b/offapi/com/sun/star/text/TextFrames.idl @@ -27,20 +27,20 @@ module com { module sun { module star { module text { -/** This is the collection of all <type>TextFrame</type> instances within a +/** This is the collection of all TextFrame instances within a context (e.g. a document). */ published service TextFrames { - /** This interface makes it possible to access all <type>TextFrame</type> + /** This interface makes it possible to access all TextFrame instances within this context (e.g. a document) by its name. <p>The type of the interfaces returned by this collection is always "XTextFrame". */ interface com::sun::star::container::XNameAccess; - /** This interface makes it possible to access all <type>TextFrame</type> + /** This interface makes it possible to access all TextFrame instances within this context (e.g. a document) by its index. <p>The type of the interfaces returned by this collection is @@ -49,7 +49,7 @@ published service TextFrames interface com::sun::star::container::XIndexAccess; /** This optional interface makes it possible to register for events - which occur upon insertion and removal of <type>TextFrame</type> + which occur upon insertion and removal of TextFrame instances. */ [optional] interface com::sun::star::container::XContainer; diff --git a/offapi/com/sun/star/text/TextGraphicObject.idl b/offapi/com/sun/star/text/TextGraphicObject.idl index 56a746b98857..71ae0eec70b4 100644 --- a/offapi/com/sun/star/text/TextGraphicObject.idl +++ b/offapi/com/sun/star/text/TextGraphicObject.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module text { -/** specifies a graphic which can be embedded in <type>Text</type>. +/** specifies a graphic which can be embedded in Text. */ published service TextGraphicObject { diff --git a/offapi/com/sun/star/text/TextGraphicObjects.idl b/offapi/com/sun/star/text/TextGraphicObjects.idl index 1d7048f697dd..4a153c58db74 100644 --- a/offapi/com/sun/star/text/TextGraphicObjects.idl +++ b/offapi/com/sun/star/text/TextGraphicObjects.idl @@ -27,21 +27,21 @@ module com { module sun { module star { module text { -/** This is the collection of all <type>TextGraphicObject</type> instances within a +/** This is the collection of all TextGraphicObject instances within a context (e.g. a document). */ published service TextGraphicObjects { - /** This interface makes it possible to access all <type>TextGraphicObject</type> + /** This interface makes it possible to access all TextGraphicObject instances within this context (e.g. a document) by its name. <p>The type of the interfaces returned by this collection is always "XTextContent". */ interface com::sun::star::container::XNameAccess; - /** This interface makes it possible to access all <type>TextGraphicObject</type> + /** This interface makes it possible to access all TextGraphicObject instances within this context (e.g. a document) by its index. <p>The type of the interfaces returned by this collection is diff --git a/offapi/com/sun/star/text/TextLayoutCursor.idl b/offapi/com/sun/star/text/TextLayoutCursor.idl index 624336eec02f..7171b4db647d 100644 --- a/offapi/com/sun/star/text/TextLayoutCursor.idl +++ b/offapi/com/sun/star/text/TextLayoutCursor.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module text { -/** A <type>TextLayoutCursor</type> is a <type>TextRange</type> which can - travel within a layout of a <type>Text</type> object. +/** A TextLayoutCursor is a TextRange which can + travel within a layout of a Text object. */ published service TextLayoutCursor { diff --git a/offapi/com/sun/star/text/TextMarkupDescriptor.idl b/offapi/com/sun/star/text/TextMarkupDescriptor.idl index dcad92648377..17eea6e58173 100644 --- a/offapi/com/sun/star/text/TextMarkupDescriptor.idl +++ b/offapi/com/sun/star/text/TextMarkupDescriptor.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module text { struct TextMarkupDescriptor { - /// Type of text markup see <type>TextMarkupType</type> + /// Type of text markup see TextMarkupType long nType; /// A string used to identify the caller diff --git a/offapi/com/sun/star/text/TextRange.idl b/offapi/com/sun/star/text/TextRange.idl index 68717a965be6..6162bd043cfb 100644 --- a/offapi/com/sun/star/text/TextRange.idl +++ b/offapi/com/sun/star/text/TextRange.idl @@ -34,13 +34,13 @@ module com { module sun { module star { module text { -/** points to a sequence of characters within a <type>Text</type>. +/** points to a sequence of characters within a Text. <p>The service provides access to the string content and the properties - of this range of text and the <type>TextContent</type> instances which + of this range of text and the TextContent instances which are bound to this text range. </p> - <p>A <type>TextRange</type> is also used for a <i>text portion</i> which is + <p>A TextRange is also used for a <i>text portion</i> which is returned by the <type scope="com::sun::star::container">XEnumeration</type> for a single paragraph. Because this is the mechanism to use to export data, all formatting attributes and contents bound to this range have diff --git a/offapi/com/sun/star/text/TextRangeContentProperties.idl b/offapi/com/sun/star/text/TextRangeContentProperties.idl index 552f863a5136..a075a483a02c 100644 --- a/offapi/com/sun/star/text/TextRangeContentProperties.idl +++ b/offapi/com/sun/star/text/TextRangeContentProperties.idl @@ -75,7 +75,7 @@ service TextRangeContentProperties /** may contain a nested text content. - For example, may contain an <type>InContentMetadata</type> or a + For example, may contain an InContentMetadata or a <type scope="com::sun::star::text::textfield">MetadataField</type>. */ [optional, readonly, property] com::sun::star::text::XTextContent diff --git a/offapi/com/sun/star/text/TextRanges.idl b/offapi/com/sun/star/text/TextRanges.idl index f31b273ce51c..bbba659c4780 100644 --- a/offapi/com/sun/star/text/TextRanges.idl +++ b/offapi/com/sun/star/text/TextRanges.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module text { -/** provides a container for <type>XTextRange</type> objects. +/** provides a container for XTextRange objects. */ published service TextRanges { diff --git a/offapi/com/sun/star/text/TextSection.idl b/offapi/com/sun/star/text/TextSection.idl index 3eb125d4d169..58ec10233e40 100644 --- a/offapi/com/sun/star/text/TextSection.idl +++ b/offapi/com/sun/star/text/TextSection.idl @@ -33,13 +33,13 @@ module com { module sun { module star { module text { -/** A <type>TextSection</type> is a range of complete paragraphs within a text. +/** A TextSection is a range of complete paragraphs within a text. <p>The content of the section may be the content of a link into another document, a link from the same document, or the result of a DDE operation. - <p><type>TextSection</type> instances can be linked from and to other + <p>TextSection instances can be linked from and to other texts. */ diff --git a/offapi/com/sun/star/text/TextViewCursor.idl b/offapi/com/sun/star/text/TextViewCursor.idl index fd3cf61f52ce..37d62f11b6bd 100644 --- a/offapi/com/sun/star/text/TextViewCursor.idl +++ b/offapi/com/sun/star/text/TextViewCursor.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module text { -/** A <type>TextViewCursor</type> is a <type>TextRange</type> which can travel - within a view of a <type>Text</type> object. +/** A TextViewCursor is a TextRange which can travel + within a view of a Text object. @see TextDocumentView */ published service TextViewCursor diff --git a/offapi/com/sun/star/text/UserIndexMark.idl b/offapi/com/sun/star/text/UserIndexMark.idl index 1a52691a225e..f756fb48f37c 100644 --- a/offapi/com/sun/star/text/UserIndexMark.idl +++ b/offapi/com/sun/star/text/UserIndexMark.idl @@ -27,8 +27,8 @@ module com { module sun { module star { module text { -/** is a <type>TextRange</type> which is explicitly marked - as an index entry for a <type>UserIndex</type>. +/** is a TextRange which is explicitly marked + as an index entry for a UserIndex. */ published service UserIndexMark { diff --git a/offapi/com/sun/star/text/XAutoTextGroup.idl b/offapi/com/sun/star/text/XAutoTextGroup.idl index 943545c76221..87c4b05da059 100644 --- a/offapi/com/sun/star/text/XAutoTextGroup.idl +++ b/offapi/com/sun/star/text/XAutoTextGroup.idl @@ -61,7 +61,7 @@ published interface XAutoTextGroup: com::sun::star::container::XNameAccess com::sun::star::container::ElementExistException, com::sun::star::io::IOException ); - /** creates a new <type>AutoTextEntry</type> entry. + /** creates a new AutoTextEntry entry. */ com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName, [in] string aTitle, diff --git a/offapi/com/sun/star/text/XBookmarksSupplier.idl b/offapi/com/sun/star/text/XBookmarksSupplier.idl index 33ed71e5d83f..d3f66410cda5 100644 --- a/offapi/com/sun/star/text/XBookmarksSupplier.idl +++ b/offapi/com/sun/star/text/XBookmarksSupplier.idl @@ -32,8 +32,8 @@ published interface XBookmarksSupplier: com::sun::star::uno::XInterface { /** @returns - the collection of all <type>Bookmark</type> instances which are - within this context and which support the <type>Bookmarks</type> service. + the collection of all Bookmark instances which are + within this context and which support the Bookmarks service. */ com::sun::star::container::XNameAccess getBookmarks(); diff --git a/offapi/com/sun/star/text/XDependentTextField.idl b/offapi/com/sun/star/text/XDependentTextField.idl index 40e995f56239..77e49a9cf04a 100644 --- a/offapi/com/sun/star/text/XDependentTextField.idl +++ b/offapi/com/sun/star/text/XDependentTextField.idl @@ -30,15 +30,15 @@ module com { module sun { module star { module text { -/** makes it possible to attach this <type>TextField</type> to a - <type>TextFieldMaster</type>. +/** makes it possible to attach this TextField to a + TextFieldMaster. */ published interface XDependentTextField: com::sun::star::text::XTextField { /** method must be called to attach the - <type>TextFieldMaster</type> to this <type>TextField</type>. - <p>A <type>TextFieldMaster</type> can only be assigned once. + TextFieldMaster to this TextField. + <p>A TextFieldMaster can only be assigned once. </p> @example Create and insert a user field (with a @@ -69,7 +69,7 @@ published interface XDependentTextField: com::sun::star::text::XTextField /** @returns - the previously attached <type>TextFieldMaster</type> + the previously attached TextFieldMaster */ com::sun::star::beans::XPropertySet getTextFieldMaster(); diff --git a/offapi/com/sun/star/text/XDocumentIndexMark.idl b/offapi/com/sun/star/text/XDocumentIndexMark.idl index 172212599136..fc1b56f4d823 100644 --- a/offapi/com/sun/star/text/XDocumentIndexMark.idl +++ b/offapi/com/sun/star/text/XDocumentIndexMark.idl @@ -41,8 +41,8 @@ published interface XDocumentIndexMark: com::sun::star::text::XTextContent - <p>If empty, the string of the <type>TextRange</type> to which - the <type>TextContent</type> refers is used in the index.</p> + <p>If empty, the string of the TextRange to which + the TextContent refers is used in the index.</p> */ void setMarkEntry( [in] string aIndexEntry ); diff --git a/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl b/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl index 68ed1ee6ff9c..0918c6bb99e6 100644 --- a/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl +++ b/offapi/com/sun/star/text/XDocumentIndexesSupplier.idl @@ -31,7 +31,7 @@ - <p>In general this interface is supported by a <type>TextDocument</type>.</p> + <p>In general this interface is supported by a TextDocument.</p> */ published interface XDocumentIndexesSupplier: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl b/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl index 0f53cb350740..f6db5181cd36 100644 --- a/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl +++ b/offapi/com/sun/star/text/XEndnotesSettingsSupplier.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module text { -/** makes it possible to access the <type>FootnoteSettings</type> +/** makes it possible to access the FootnoteSettings within the context (e.g. document). */ published interface XEndnotesSettingsSupplier: com::sun::star::uno::XInterface { /** @returns - <type>EndnoteSettings</type> of the object. + EndnoteSettings of the object. */ com::sun::star::beans::XPropertySet getEndnotesSettings(); diff --git a/offapi/com/sun/star/text/XFlatParagraph.idl b/offapi/com/sun/star/text/XFlatParagraph.idl index 3c522dc9d893..a758cd964586 100644 --- a/offapi/com/sun/star/text/XFlatParagraph.idl +++ b/offapi/com/sun/star/text/XFlatParagraph.idl @@ -57,7 +57,7 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup text node as "processed" @param nType - type, see <type>TextMarkupType</type>. + type, see TextMarkupType. @param bVal <TRUE/> the respective text node has been processed @@ -69,7 +69,7 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup /** returns whether the respective text node has already been processed @param nType - type, see <type>TextMarkupType</type>. + type, see TextMarkupType. @returns <TRUE/> if the respective text node has been checked diff --git a/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl b/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl index f1294af4ae8b..38d9ad3c548e 100644 --- a/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl +++ b/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl @@ -43,7 +43,7 @@ interface XFlatParagraphIteratorProvider: com::sun::star::uno::XInterface /** get XFlatParagraphIterator @param nType - Type of text markup see <type>TextMarkupType</type>. + Type of text markup see TextMarkupType. @param bAutomatic Automatic or interactive checking. diff --git a/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl b/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl index 6a5d5ccf808f..fa2b650e1a75 100644 --- a/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl +++ b/offapi/com/sun/star/text/XFootnotesSettingsSupplier.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module text { -/** makes it possible to access the <type>FootnoteSettings</type> +/** makes it possible to access the FootnoteSettings with the context (e.g. document). */ published interface XFootnotesSettingsSupplier: com::sun::star::uno::XInterface { /** @returns - <type>FootnoteSettings</type> of the object. + FootnoteSettings of the object. */ com::sun::star::beans::XPropertySet getFootnotesSettings(); diff --git a/offapi/com/sun/star/text/XLineNumberingProperties.idl b/offapi/com/sun/star/text/XLineNumberingProperties.idl index 7d2c3595db88..f5cec957d1d8 100644 --- a/offapi/com/sun/star/text/XLineNumberingProperties.idl +++ b/offapi/com/sun/star/text/XLineNumberingProperties.idl @@ -32,7 +32,7 @@ published interface XLineNumberingProperties: com::sun::star::uno::XInterface { /** @return - the <type>LineNumberingProperties</type> of the object. + the LineNumberingProperties of the object. */ com::sun::star::beans::XPropertySet getLineNumberingProperties(); }; diff --git a/offapi/com/sun/star/text/XPagePrintable.idl b/offapi/com/sun/star/text/XPagePrintable.idl index c794c7a76853..49f3d8e210d0 100644 --- a/offapi/com/sun/star/text/XPagePrintable.idl +++ b/offapi/com/sun/star/text/XPagePrintable.idl @@ -56,7 +56,7 @@ published interface XPagePrintable: com::sun::star::uno::XInterface */ void setPagePrintSettings( [in] sequence<com::sun::star::beans::PropertyValue> aSettings ); - /** prints the pages according to the <type>PagePrintSettings</type>. + /** prints the pages according to the PagePrintSettings. @see com::sun::star::view::PrintOptions */ diff --git a/offapi/com/sun/star/text/XSimpleText.idl b/offapi/com/sun/star/text/XSimpleText.idl index 3e01cd08c678..a4411522ef21 100644 --- a/offapi/com/sun/star/text/XSimpleText.idl +++ b/offapi/com/sun/star/text/XSimpleText.idl @@ -42,7 +42,7 @@ published interface XSimpleText: com::sun::star::text::XTextRange { /** @returns - a new instance of a <type>TextCursor</type> service which can + a new instance of a TextCursor service which can be used to travel in the given text context. @see com::sun::star::text::TextCursor @@ -51,15 +51,15 @@ published interface XSimpleText: com::sun::star::text::XTextRange /** @returns - a new instance of a <type>TextCursor</type> which is located - at the specified <type>TextRange</type> to travel in the + a new instance of a TextCursor which is located + at the specified TextRange to travel in the given text context. <p>The initial position is set to <var>aTextPosition</var>. @param aTextPosition specifies the start position for the new - <type>TextCursor</type>. + TextCursor. @see com::sun::star::text::TextCursor */ @@ -80,7 +80,7 @@ published interface XSimpleText: com::sun::star::text::XTextRange @param xRange specifies the position of insertion. For example, <method>XSimpleText::createTextCursor</member> can be used to - get an <type>XTextRange</type> for this argument. + get an XTextRange for this argument. <p>If the parameter <member>bAbsorb</member> was <TRUE/> the text range will contain the new inserted string, otherwise diff --git a/offapi/com/sun/star/text/XText.idl b/offapi/com/sun/star/text/XText.idl index 0ac5cb7a5e4a..05b8a90063dd 100644 --- a/offapi/com/sun/star/text/XText.idl +++ b/offapi/com/sun/star/text/XText.idl @@ -34,8 +34,8 @@ module com { module sun { module star { module text { -/** extends a <type>XSimpleText</type> by the capability of inserting - <type>XTextContent</type>s. +/** extends a XSimpleText by the capability of inserting + XTextContents. */ published interface XText: com::sun::star::text::XSimpleText { diff --git a/offapi/com/sun/star/text/XTextAppendAndConvert.idl b/offapi/com/sun/star/text/XTextAppendAndConvert.idl index 85af374286b3..e4ae77854ea4 100644 --- a/offapi/com/sun/star/text/XTextAppendAndConvert.idl +++ b/offapi/com/sun/star/text/XTextAppendAndConvert.idl @@ -28,8 +28,8 @@ module com { module sun { module star { module text { -/** merges the functions of <type>XTextAppend</type>, - <type>XTextContentAppend</type> and <type>XTextConvert</type>. +/** merges the functions of XTextAppend, + XTextContentAppend and XTextConvert. */ interface XTextAppendAndConvert { diff --git a/offapi/com/sun/star/text/XTextCursor.idl b/offapi/com/sun/star/text/XTextCursor.idl index adbe1afc3b31..e30229e8d42c 100644 --- a/offapi/com/sun/star/text/XTextCursor.idl +++ b/offapi/com/sun/star/text/XTextCursor.idl @@ -100,7 +100,7 @@ published interface XTextCursor: com::sun::star::text::XTextRange void gotoEnd( [in] boolean bExpand ); - /** moves or expands the cursor to a specified <type>TextRange</type>. + /** moves or expands the cursor to a specified TextRange. */ void gotoRange( [in] com::sun::star::text::XTextRange xRange, [in] boolean bExpand ); diff --git a/offapi/com/sun/star/text/XTextDocument.idl b/offapi/com/sun/star/text/XTextDocument.idl index d6f9776591f2..2905a4a02fa2 100644 --- a/offapi/com/sun/star/text/XTextDocument.idl +++ b/offapi/com/sun/star/text/XTextDocument.idl @@ -34,10 +34,10 @@ published interface XTextDocument: com::sun::star::frame::XModel /** @returns the major <type scope="com::sun::star::text">Text</type> of the text document. - <p>This text does not contain texts in <type>TextFrame</type>s, - or cells of <type>TextTable</type>s etc. directly. These are + <p>This text does not contain texts in TextFrames, + or cells of TextTables etc. directly. These are accessible from the contents via <code>X...Supplier</code> - (e.g. <type>XTextTablesSupplier</type>). + (e.g. XTextTablesSupplier). */ com::sun::star::text::XText getText(); diff --git a/offapi/com/sun/star/text/XTextFieldsSupplier.idl b/offapi/com/sun/star/text/XTextFieldsSupplier.idl index b84ac523e438..e5edc36eaa67 100644 --- a/offapi/com/sun/star/text/XTextFieldsSupplier.idl +++ b/offapi/com/sun/star/text/XTextFieldsSupplier.idl @@ -34,13 +34,13 @@ published interface XTextFieldsSupplier: com::sun::star::uno::XInterface { /** @returns - the collection of <type>TextField</type> instances + the collection of TextField instances in this context (i.e. this document). */ com::sun::star::container::XEnumerationAccess getTextFields(); /** @returns - the collection of <type>TextFieldMaster</type> instances + the collection of TextFieldMaster instances which are defined in this context (i.e. this document). */ com::sun::star::container::XNameAccess getTextFieldMasters(); diff --git a/offapi/com/sun/star/text/XTextFrame.idl b/offapi/com/sun/star/text/XTextFrame.idl index 93629c56a8d2..94ed9e2ac84b 100644 --- a/offapi/com/sun/star/text/XTextFrame.idl +++ b/offapi/com/sun/star/text/XTextFrame.idl @@ -26,14 +26,14 @@ module com { module sun { module star { module text { -/** provides access to the <type>Text</type> of a <type>TextFrame</type>. +/** provides access to the Text of a TextFrame. @see TextFrame */ published interface XTextFrame: com::sun::star::text::XTextContent { /** @returns the text within this frame. The returned interface belongs - to an object which implements the service <type>Text</type>. + to an object which implements the service Text. */ com::sun::star::text::XText getText(); diff --git a/offapi/com/sun/star/text/XTextFramesSupplier.idl b/offapi/com/sun/star/text/XTextFramesSupplier.idl index e8d2ccc46a7d..b60ce9dc9a71 100644 --- a/offapi/com/sun/star/text/XTextFramesSupplier.idl +++ b/offapi/com/sun/star/text/XTextFramesSupplier.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module text { -/** makes it possible to access the <type>TextFrame</type> instances in this +/** makes it possible to access the TextFrame instances in this context (e.g. document). */ published interface XTextFramesSupplier: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/text/XTextMarkup.idl b/offapi/com/sun/star/text/XTextMarkup.idl index 9edf5c46c051..ee977897f1a3 100644 --- a/offapi/com/sun/star/text/XTextMarkup.idl +++ b/offapi/com/sun/star/text/XTextMarkup.idl @@ -48,7 +48,7 @@ interface XTextMarkup /** submits a new markup range. @param nType - Type of text markup see <type>TextMarkupType</type>. + Type of text markup see TextMarkupType. @param aIdentifier A string used to identify the caller. diff --git a/offapi/com/sun/star/text/XTextRangeCompare.idl b/offapi/com/sun/star/text/XTextRangeCompare.idl index d027dec2bd9d..b79c709a7120 100644 --- a/offapi/com/sun/star/text/XTextRangeCompare.idl +++ b/offapi/com/sun/star/text/XTextRangeCompare.idl @@ -29,12 +29,12 @@ published interface XText; published interface XTextRange; -/** compares the positions of two <type>TextRange</type>s within a - <type>Text</type>. +/** compares the positions of two TextRanges within a + Text. - <p>Only <type>TextRange</type> instances within the same <type>Text</type> + <p>Only TextRange instances within the same Text can be compared. </p> */ diff --git a/offapi/com/sun/star/text/XTextSection.idl b/offapi/com/sun/star/text/XTextSection.idl index ad054bf4df97..d249d8cc0ea1 100644 --- a/offapi/com/sun/star/text/XTextSection.idl +++ b/offapi/com/sun/star/text/XTextSection.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module text { -/** provide special data of a <type>TextSection</type>.@see TextSection +/** provide special data of a TextSection.@see TextSection */ published interface XTextSection: com::sun::star::text::XTextContent { diff --git a/offapi/com/sun/star/text/XTextTable.idl b/offapi/com/sun/star/text/XTextTable.idl index 64ed5c049566..4e40c31bcb0b 100644 --- a/offapi/com/sun/star/text/XTextTable.idl +++ b/offapi/com/sun/star/text/XTextTable.idl @@ -99,7 +99,7 @@ published interface XTextTable: com::sun::star::text::XTextContent /** creates a text table cursor and returns the - <type>XTextTableCursor</type> interface. + XTextTableCursor interface. <p>Initially the cursor is positioned in the cell with the specified name. </p> diff --git a/offapi/com/sun/star/text/textfield/MetadataField.idl b/offapi/com/sun/star/text/textfield/MetadataField.idl index b08e17a2b7e6..8ffe273c7a6e 100644 --- a/offapi/com/sun/star/text/textfield/MetadataField.idl +++ b/offapi/com/sun/star/text/textfield/MetadataField.idl @@ -43,19 +43,19 @@ service MetadataField <type scope="com::sun::star::text">TextContent</type> are supported. */ service com::sun::star::text::TextField; - /** The <type>MetadataField</type> can have RDF metadata attached. */ + /** The MetadataField can have RDF metadata attached. */ interface com::sun::star::rdf::XMetadatable; /** Allows for insertion of text content into, and creating cursors - that are bound within, the <type>MetadataField</type>. */ + that are bound within, the MetadataField. */ interface com::sun::star::text::XText; /** The <type scope="com::sun::star::text">TextContent</type>s that are - contained in the <type>MetadataField</type> can be enumerated. */ + contained in the MetadataField can be enumerated. */ interface com::sun::star::container::XEnumerationAccess; /** The <type scope="com::sun::star::text">TextContent</type> - that is the parent of this <type>MetadataField</type>. + that is the parent of this MetadataField. @since OOo 3.3 */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/ucb/AnyCompareFactory.idl b/offapi/com/sun/star/ucb/AnyCompareFactory.idl index ef850a53fbb5..c482af31241a 100644 --- a/offapi/com/sun/star/ucb/AnyCompareFactory.idl +++ b/offapi/com/sun/star/ucb/AnyCompareFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory to get <type>XAnyCompare</type> service implementations. +/** is a factory to get XAnyCompare service implementations. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/ucb/CachedContentResultSet.idl b/offapi/com/sun/star/ucb/CachedContentResultSet.idl index 86e85076efc8..9f3b2a6be9c2 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSet.idl @@ -24,10 +24,10 @@ module com { module sun { module star { module ucb { -/** is used on client side to access a <type>ContentResultSet</type> +/** is used on client side to access a ContentResultSet remote optimized. - <p>The <type>CachedContentResultSet</type> will not load every single + <p>The CachedContentResultSet will not load every single property or even row just in that moment you ask for it, but load the data for some rows beforehand. diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl index 2837aeabc2cf..ecfa073a8c79 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedContentResultSet</type> implementations. +/** is a factory for CachedContentResultSet implementations. */ published service CachedContentResultSetFactory : XCachedContentResultSetFactory; diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl b/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl index 66626f81f700..7cf72072e449 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetStub.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { -/** is used on provider side to access a <type>ContentResultSet</type> +/** is used on provider side to access a ContentResultSet remote optimized. */ @@ -42,7 +42,7 @@ published service CachedContentResultSetStub interface com::sun::star::ucb::XFetchProvider; /** Provides the possibility load information offered by a - <type>XContentAccess</type> for several rows of one result set at once. + XContentAccess for several rows of one result set at once. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl index 29b1a9f7e806..6d6ca92a9d96 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSetStubFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedContentResultSetStub</type> implementations. +/** is a factory for CachedContentResultSetStub implementations. */ published service CachedContentResultSetStubFactory : XCachedContentResultSetStubFactory; diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 5688103f07fa..3dde01a11d7b 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -26,33 +26,33 @@ module com { module sun { module star { module ucb { /** provides read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. - <p>For example, a <type>DynamicResultSet</type> is returned from the - open-command executed by an <type>XCommandProcessor</type> of the service - <type>Content</type>. + <p>For example, a DynamicResultSet is returned from the + open-command executed by an XCommandProcessor of the service + Content. */ published service CachedDynamicResultSet { /** Provides remote optimized read access to a static or a dynamically - changing <type>ContentResultSet</type>. + changing ContentResultSet. <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to the listener in the first notification in the - <type>WelcomeDynamicResultSetStruct</type> are implementations of the - <type>CachedContentResultSet</type> service. + WelcomeDynamicResultSetStruct are implementations of the + CachedContentResultSet service. <p>This interface is required. */ interface com::sun::star::ucb::XDynamicResultSet; - /** provides the initialization of the <type>CachedDynamicResultSet</type> + /** provides the initialization of the CachedDynamicResultSet with a source object. <p>The <var>Source</var> in <member>XSourceInitialization::setSource</member> has to be an - implementation of service <type>CachedDynamicResultSetStub</type> + implementation of service CachedDynamicResultSetStub <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl index 209a70d5daae..6a82cba0badb 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedDynamicResultSet</type> implementations. +/** is a factory for CachedDynamicResultSet implementations. */ published service CachedDynamicResultSetFactory : XCachedDynamicResultSetFactory; diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 56514c58b793..b7aaef24de28 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -26,34 +26,34 @@ module com { module sun { module star { module ucb { /** provides read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. - <p>For example, a <type>DynamicResultSet</type> is returned from the - open-command executed by an <type>XCommandProcessor</type> of the service - <type>Content</type>. + <p>For example, a DynamicResultSet is returned from the + open-command executed by an XCommandProcessor of the service + Content. */ published service CachedDynamicResultSetStub { - /** In Combination with a <type>CachedDynamicResultSet</type> this provides + /** In Combination with a CachedDynamicResultSet this provides remote optimized read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to the listener in the first notification in the - <type>WelcomeDynamicResultSetStruct</type> are implementations of - <type>CachedContentResultSetStub</type>. + WelcomeDynamicResultSetStruct are implementations of + CachedContentResultSetStub. <p>This interface is required. */ interface com::sun::star::ucb::XDynamicResultSet; - /** provides the initialization of the <type>CachedDynamicResultSetStub</type> + /** provides the initialization of the CachedDynamicResultSetStub with a source object. <p>The <var>Source</var> in <member>XSourceInitialization::setSource</member> has to be an - implementation of service <type>DynamicResultSet</type> + implementation of service DynamicResultSet <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl index 5d28643acb6e..c71b81adb5d6 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStubFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>CachedDynamicResultSetStub</type> implementations. +/** is a factory for CachedDynamicResultSetStub implementations. */ published service CachedDynamicResultSetStubFactory : XCachedDynamicResultSetStubFactory; diff --git a/offapi/com/sun/star/ucb/CmisContentProvider.idl b/offapi/com/sun/star/ucb/CmisContentProvider.idl index c370252ff173..131c926a1157 100644 --- a/offapi/com/sun/star/ucb/CmisContentProvider.idl +++ b/offapi/com/sun/star/ucb/CmisContentProvider.idl @@ -18,7 +18,7 @@ module com { module sun { module star { module ucb { -/** The Cmis Content Provider implements a <type>ContentProvider</type> +/** The Cmis Content Provider implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to directories and files on a diff --git a/offapi/com/sun/star/ucb/CommandEnvironment.idl b/offapi/com/sun/star/ucb/CommandEnvironment.idl index db5240ddc36f..bfaeba914132 100644 --- a/offapi/com/sun/star/ucb/CommandEnvironment.idl +++ b/offapi/com/sun/star/ucb/CommandEnvironment.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { - /* This service implements an <type>XCommandEnvironment</type> that can be + /* This service implements an XCommandEnvironment that can be initialized with any implementation of <type scope="com::sun::star::task">XInteractionHandler</type> and <type scope="com::sun::star::ucb">XProgressHandler</type>. The respective diff --git a/offapi/com/sun/star/ucb/CommandInfoChange.idl b/offapi/com/sun/star/ucb/CommandInfoChange.idl index b4627e613c7e..99a7bcc42522 100644 --- a/offapi/com/sun/star/ucb/CommandInfoChange.idl +++ b/offapi/com/sun/star/ucb/CommandInfoChange.idl @@ -23,18 +23,18 @@ module com { module sun { module star { module ucb { -/** specifies reasons for sending <type>CommandInfoChangeEvent</type>s. +/** specifies reasons for sending CommandInfoChangeEvents. @see CommandInfoChangeEvent @see XCommandInfo */ published constants CommandInfoChange { - /** A command was inserted into a <type>XCommandInfo</type>. + /** A command was inserted into a XCommandInfo. */ const long COMMAND_INSERTED = 0; - /** A command was removed from a <type>XCommandInfo</type>. + /** A command was removed from a XCommandInfo. */ const long COMMAND_REMOVED = 1; }; diff --git a/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl b/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl index 20bc39a3600d..97985c5aeb97 100644 --- a/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl +++ b/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module ucb { -/** This event gets delivered whenever a <type>XCommandInfo</type> is changed. +/** This event gets delivered whenever a XCommandInfo is changed. - <p>A <type>CommandInfoChangeEvent</type> object is sent to - <type>XCommandInfoChangeListener</type>s. + <p>A CommandInfoChangeEvent object is sent to + XCommandInfoChangeListeners. */ published struct CommandInfoChangeEvent: com::sun::star::lang::EventObject { @@ -44,7 +44,7 @@ published struct CommandInfoChangeEvent: com::sun::star::lang::EventObject /** contains the reason for the event. - <p>The value can be one of the <type>CommandInfoChange</type> constants. + <p>The value can be one of the CommandInfoChange constants. */ long Reason; }; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index d4dbbdb14195..0df2111aa56d 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -33,15 +33,15 @@ module com { module sun { module star { module ucb { -/** A <type>Content</type> is a service that provides access to data of a +/** A Content is a service that provides access to data of a content provided by an implementation of the service - <type>ContentProvider</type>. + ContentProvider. */ published service Content { /** provides access to the identity and the type of the content and - allows the registration of listeners for <type>ContentEvent</type>s. + allows the registration of listeners for ContentEvents. <p>This interface is required. */ @@ -68,7 +68,7 @@ published service Content /** enables the caller to let the content execute commands. <p>It is strongly recommended that any implementation supports the - improved <type>XCommandProcessor2</type> interface.</p> + improved XCommandProcessor2 interface.</p> <p>Typical commands are "open", "delete", "getPropertyValues" and "setPropertyValues". Each content must support a set of standard @@ -830,7 +830,7 @@ published service Content resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; @@ -846,7 +846,7 @@ published service Content properties from the content dynamically. <p>Note that the dynamic properties must be kept persistent. The - service <type>Store</type> (UCB persistence service) may be used to + service Store (UCB persistence service) may be used to implement this. <p><b>Important:</b> The implementation of @@ -923,7 +923,7 @@ published service Content <p>The object returned by the implementation of the method <member scope="com::sun::star::container">XChild::getParent()</member> - must implement the service <type>Content</type>. If the content is a + must implement the service Content. If the content is a root object, an empty interface may be returned. <p>This interface must be implemented by a content which is a (logical) diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index ddbc09e9d880..54e3ff075358 100644 --- a/offapi/com/sun/star/ucb/ContentEvent.idl +++ b/offapi/com/sun/star/ucb/ContentEvent.idl @@ -33,7 +33,7 @@ published struct ContentEvent: com::sun::star::lang::EventObject { /** The action. - <p>The value can be one of the <type>ContentAction</type> constants. + <p>The value can be one of the ContentAction constants. */ long Action; diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index 08b2d67c7ff2..e8b2d16a2650 100644 --- a/offapi/com/sun/star/ucb/ContentInfo.idl +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -47,9 +47,9 @@ published struct ContentInfo <p>It is highly recommended to fill these flags very accurately, as they are very important when transferring contents between different - <type>ContentProvider</type>s. + ContentProviders. - <p>The value can be one of the <type>ContentInfoAttribute</type> + <p>The value can be one of the ContentInfoAttribute constants. */ long Attributes; diff --git a/offapi/com/sun/star/ucb/ContentInfoAttribute.idl b/offapi/com/sun/star/ucb/ContentInfoAttribute.idl index 99c3faeccae1..5861c8c5c56b 100644 --- a/offapi/com/sun/star/ucb/ContentInfoAttribute.idl +++ b/offapi/com/sun/star/ucb/ContentInfoAttribute.idl @@ -31,7 +31,7 @@ published constants ContentInfoAttribute */ const short NONE = 0; - /** Supply an input stream with the <type>InsertCommandArgument</type>, + /** Supply an input stream with the InsertCommandArgument, when committing the new content by executing the command "insert" at it. */ const short INSERT_WITH_INPUTSTREAM = 1; diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl index 2db5e3ab6260..257cf6bad600 100644 --- a/offapi/com/sun/star/ucb/ContentProvider.idl +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** provides access to a set of <type>Content</type>s. +/** provides access to a set of Contents. */ published service ContentProvider { @@ -35,7 +35,7 @@ published service ContentProvider */ interface com::sun::star::ucb::XContentProvider; - /** creates special <type>XContentIdentifier</type> implementation + /** creates special XContentIdentifier implementation objects for the contents provided by this content provider. <p>This interface can be implemented in case the provider wants to @@ -44,13 +44,13 @@ published service ContentProvider */ [optional] interface com::sun::star::ucb::XContentIdentifierFactory; - /** allows a <type>ContentProvider</type> to adjust itself to special + /** allows a ContentProvider to adjust itself to special needs. <p>Whenever a ContentProvider that supports this interface is - registered at a <type>XContentProviderManager</type>, the method + registered at a XContentProviderManager, the method <member>XParameterizedContentProvider::registerInstance</member> - should first be called, using the returned <type>XContentProvider</type> + should first be called, using the returned XContentProvider to register at the XContentProviderManager. */ [optional] interface com::sun::star::ucb::XParameterizedContentProvider; diff --git a/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl b/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl index 7f5d6263eb4d..caf7263cfe9b 100644 --- a/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl +++ b/offapi/com/sun/star/ucb/ContentProviderProxyFactory.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>ContentProviderProxy</type> implementations. +/** is a factory for ContentProviderProxy implementations. */ published service ContentProviderProxyFactory : XContentProviderFactory; diff --git a/offapi/com/sun/star/ucb/ContentResultSet.idl b/offapi/com/sun/star/ucb/ContentResultSet.idl index cd174dbaa7d0..738faba28717 100644 --- a/offapi/com/sun/star/ucb/ContentResultSet.idl +++ b/offapi/com/sun/star/ucb/ContentResultSet.idl @@ -61,7 +61,7 @@ published service ContentResultSet This interface mainly provides a cursor for the result set. <p>Note that every method of this interface implementation additionally - may throw a <type>ResultSetException</type> ( which is derived from + may throw a ResultSetException ( which is derived from <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. @@ -73,7 +73,7 @@ published service ContentResultSet /** provides access to data of the content the cursor is pointing to. <p>Note that every method of this interface implementation additionally - may throw a <type>ResultSetException</type> ( which is derived from + may throw a ResultSetException ( which is derived from <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. @@ -86,7 +86,7 @@ published service ContentResultSet retrieving data from a server ). <p>Note that every method of this interface implementation additionally - may throw a <type>ResultSetException</type> ( which is derived from + may throw a ResultSetException ( which is derived from <type scope="com::sun::star::sdbc">SQLException</type> to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call. diff --git a/offapi/com/sun/star/ucb/ContentResultSetCapability.idl b/offapi/com/sun/star/ucb/ContentResultSetCapability.idl index 8b8ba4663a76..71b90cf67958 100644 --- a/offapi/com/sun/star/ucb/ContentResultSetCapability.idl +++ b/offapi/com/sun/star/ucb/ContentResultSetCapability.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module ucb { /** These values are used to specify the capabilities of an - <type>XDynamicResultSet</type>. + XDynamicResultSet. */ published constants ContentResultSetCapability { - /** indicates that a <type>ContentResultSet</type> is properly sorted, + /** indicates that a ContentResultSet is properly sorted, exactly following the rules given during the ContentResultSet was created. */ diff --git a/offapi/com/sun/star/ucb/ContentTransmitter.idl b/offapi/com/sun/star/ucb/ContentTransmitter.idl index 5fb455935197..c7725beaada4 100644 --- a/offapi/com/sun/star/ucb/ContentTransmitter.idl +++ b/offapi/com/sun/star/ucb/ContentTransmitter.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** A <type>ContentTransmitter</type> is a service that provides +/** A ContentTransmitter is a service that provides @deprecated */ diff --git a/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl b/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl index e6cb70c0550d..a58108e6405e 100644 --- a/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl +++ b/offapi/com/sun/star/ucb/DefaultHierarchyDataSource.idl @@ -24,14 +24,14 @@ module com { module sun { module star { module ucb { -/** is a concrete implementation of service <type>HierarchyDataSource</type>, +/** is a concrete implementation of service HierarchyDataSource, which uses the service <type scope="com::sun::star::configuration">ConfigurationProvider</type> for reading and writing hierarchy data. */ published service DefaultHierarchyDataSource { - /** is a concrete implementation of service <type>HierarchyDataSource</type>, + /** is a concrete implementation of service HierarchyDataSource, which uses the service <type scope="com::sun::star::configuration">ConfigurationProvider</type> for reading and writing hierarchy data. diff --git a/offapi/com/sun/star/ucb/DynamicResultSet.idl b/offapi/com/sun/star/ucb/DynamicResultSet.idl index 5c7c5775e4aa..b62a6588c10a 100644 --- a/offapi/com/sun/star/ucb/DynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/DynamicResultSet.idl @@ -25,17 +25,17 @@ module com { module sun { module star { module ucb { /** provides read access to a static or dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. - <p>For example, a <type>DynamicResultSet</type> is returned from the - open-command executed by an <type>XCommandProcessor</type> of the service - <type>Content</type>. + <p>For example, a DynamicResultSet is returned from the + open-command executed by an XCommandProcessor of the service + Content. */ published service DynamicResultSet { /** Provides read access to a static or a dynamically changing - <type>ContentResultSet</type>. + ContentResultSet. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/ExpandContentProvider.idl b/offapi/com/sun/star/ucb/ExpandContentProvider.idl index 423c0d084b73..873203f8974b 100644 --- a/offapi/com/sun/star/ucb/ExpandContentProvider.idl +++ b/offapi/com/sun/star/ucb/ExpandContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The Expand Content Provider implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The Expand Content Provider implements a ContentProvider + for the UniversalContentBroker (UCB). <p> It provides access to content via macrofied URLs, e.g. diff --git a/offapi/com/sun/star/ucb/FTPContent.idl b/offapi/com/sun/star/ucb/FTPContent.idl index 7b4db0629e5e..5b7dd5328c00 100644 --- a/offapi/com/sun/star/ucb/FTPContent.idl +++ b/offapi/com/sun/star/ucb/FTPContent.idl @@ -43,17 +43,17 @@ module com { module sun { module star { module ucb { published service FTPContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>An object representing a directory in the file system is able to create a new object, which in turn can become the representation @@ -90,7 +90,7 @@ published service FTPContent interface com::sun::star::ucb::XContentCreator; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -156,27 +156,27 @@ published service FTPContent interface com::sun::star::ucb::XCommandProcessor; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/FTPContentProvider.idl b/offapi/com/sun/star/ucb/FTPContentProvider.idl index 3019125b6a9a..1e7229c4d73b 100644 --- a/offapi/com/sun/star/ucb/FTPContentProvider.idl +++ b/offapi/com/sun/star/ucb/FTPContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** The FTP Content Provider (FCP) implements a <type>ContentProvider</type> +/** The FTP Content Provider (FCP) implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to directories and files on a diff --git a/offapi/com/sun/star/ucb/FetchError.idl b/offapi/com/sun/star/ucb/FetchError.idl index 8b7c0ae6bfeb..0b9b95d9fd10 100644 --- a/offapi/com/sun/star/ucb/FetchError.idl +++ b/offapi/com/sun/star/ucb/FetchError.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { /** These values are used to specify whether and which error has occurred - while fetching data of some <type>ContentResultSet</type> rows. + while fetching data of some ContentResultSet rows. @see FetchResult */ @@ -35,7 +35,7 @@ published constants FetchError /** indicates that during fetching we went beyond the last or first row. - <p>Therefore the <type>FetchResult</type> does not contain the full + <p>Therefore the FetchResult does not contain the full count of demanded rows, but the maximum possible count must be contained. */ @@ -44,8 +44,8 @@ published constants FetchError /** indicates that during fetching we got an exception. <p>The row, that causes the exception, and all following ( "following" - in read order! ) rows are not contained in the <type>FetchResult</type>. - Therefore the <type>FetchResult</type> does not contain the full count + in read order! ) rows are not contained in the FetchResult. + Therefore the FetchResult does not contain the full count of demanded rows. But all properly read rows so far must be contained. */ const short EXCEPTION = 2; diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index db6a6fc70025..d42f1e7258e1 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -22,7 +22,7 @@ module com { module sun { module star { module ucb { -/** contains data of several rows of a <type>ContentResultSet</type>. +/** contains data of several rows of a ContentResultSet. <p>This struct is returned from <member>XFetchProvider::fetch</member>, for example. @@ -60,7 +60,7 @@ published struct FetchResult /** indicates whether and which error has occurred, while fetching. <p>The value may contain zero or more constants of the - <type>FetchError</type> constants group. + FetchError constants group. */ short FetchError; }; diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index e7c8916c97b8..5f578fdc4a77 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -44,17 +44,17 @@ module com { module sun { module star { module ucb { published service FileContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>An object representing a directory in the file system is able to create a new object, which in turn can become the representation @@ -91,7 +91,7 @@ published service FileContent interface com::sun::star::ucb::XContentCreator; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -175,39 +175,39 @@ published service FileContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/FileContentProvider.idl b/offapi/com/sun/star/ucb/FileContentProvider.idl index ba3a42288ecd..3362a6424746 100644 --- a/offapi/com/sun/star/ucb/FileContentProvider.idl +++ b/offapi/com/sun/star/ucb/FileContentProvider.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** The File Content Provider (FCP) implements a <type>ContentProvider</type> +/** The File Content Provider (FCP) implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to the local file system. @@ -48,7 +48,7 @@ published service FileContentProvider interface com::sun::star::ucb::XContentProvider; /** This interface is implemented according to the specification of - service <type>ContentProvider</type>. + service ContentProvider. */ interface com::sun::star::ucb::XContentIdentifierFactory; @@ -70,7 +70,7 @@ published service FileContentProvider </li> <li> long FileSystemNotation ( read-only, the value is one of the - <type>FileSystemNotation</type> constants ) + FileSystemNotation constants ) </li> </ul> diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index 4e68bcf05d35..e17d01e38201 100644 --- a/offapi/com/sun/star/ucb/FolderListEntry.idl +++ b/offapi/com/sun/star/ucb/FolderListEntry.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ucb { -/** Information about a single folder in a <type>FolderList</type>. +/** Information about a single folder in a FolderList. */ published struct FolderListEntry { diff --git a/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl b/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl index 1580e5a349df..e7b2125a4322 100644 --- a/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl +++ b/offapi/com/sun/star/ucb/GlobalTransferCommandArgument.idl @@ -54,7 +54,7 @@ published struct GlobalTransferCommandArgument <p>A title clash for instance occurs, if a file named "foo.txt" is to be transferred to a folder already containing another file named - "foo.txt". Refer to <type>NameClash</type> for possible values for + "foo.txt". Refer to NameClash for possible values for this field. */ long NameClash; diff --git a/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl b/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl index 9c421011c3db..0d7ae62cd55e 100644 --- a/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl +++ b/offapi/com/sun/star/ucb/GnomeVFSDocumentContent.idl @@ -36,12 +36,12 @@ module com { module sun { module star { module ucb { service GnomeVFSDocumentContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; @@ -50,27 +50,27 @@ service GnomeVFSDocumentContent [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl b/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl index 9ea41cfdf37b..040f4de3be23 100644 --- a/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl +++ b/offapi/com/sun/star/ucb/GnomeVFSFolderContent.idl @@ -42,12 +42,12 @@ module com { module sun { module star { module ucb { service GnomeVFSFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; @@ -56,27 +56,27 @@ service GnomeVFSFolderContent [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/ucb/HelpContent.idl b/offapi/com/sun/star/ucb/HelpContent.idl index ebe6c3137156..42f5422fc88b 100644 --- a/offapi/com/sun/star/ucb/HelpContent.idl +++ b/offapi/com/sun/star/ucb/HelpContent.idl @@ -41,17 +41,17 @@ module com { module sun { module star { module ucb { published service HelpContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -126,39 +126,39 @@ published service HelpContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/HelpContentProvider.idl b/offapi/com/sun/star/ucb/HelpContentProvider.idl index ae1190055526..059179ed895e 100644 --- a/offapi/com/sun/star/ucb/HelpContentProvider.idl +++ b/offapi/com/sun/star/ucb/HelpContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** The Help Content Provider (HCP) implements a <type>ContentProvider</type> +/** The Help Content Provider (HCP) implements a ContentProvider for the <Type>UniversalContentBroker</type> (UCB). <p>The served contents enable access to the help contents and to the diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl index 4e8f1a378bcd..5d9fa601a4f8 100644 --- a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** The Hierarchy Content Provider (HCP) implements a - <type>ContentProvider</type> for the <type>UniversalContentBroker</type> + ContentProvider for the UniversalContentBroker (UCB). <p>It provides access to a persistent, customizable hierarchy of contents @@ -42,17 +42,17 @@ published service HierarchyContentProvider <b>HCP Contents</b> <ol> <li> - A HCP Link (<type>HierarchyLinkContent</type>) is a content which + A HCP Link (HierarchyLinkContent) is a content which points to another (UCB) content. It is always contained in HCP Folder. A HCP Link has no children. </li> <li> - A HCP Folder (<type>HierarchyFolderContent</type>) is a container for + A HCP Folder (HierarchyFolderContent) is a container for other HCP Folders and HCP Links. </li> <li> There is at most one instance of a HCP Root Folder - ( <type>HierarchyRootFolderContent</type> ) at a time. + ( HierarchyRootFolderContent ) at a time. All other HCP contents are children of this folder. The HCP Root Folder can contain HCP Folders and HCP Links. It has the URL "vnd.sun.star.hier:/". diff --git a/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl b/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl index b7510ecbac00..dd12f39d266f 100644 --- a/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl +++ b/offapi/com/sun/star/ucb/HierarchyDataReadAccess.idl @@ -40,8 +40,8 @@ module com { module sun { module star { module ucb { for the node. This value must not be empty. <li>"TargetURL", which is of type <atom>string</atom></li> It may contain any URL, which will be treated as the target of a hierarchy link. - <li>"Children", which is of type <type>HierarchyDataReadAccess</type> or - of type <type>HierarchyDataReadWriteAccess</type></li>, depending on the + <li>"Children", which is of type HierarchyDataReadAccess or + of type HierarchyDataReadWriteAccess</li>, depending on the type of the node. This member provides access to the children of a node. </ul> */ @@ -56,9 +56,9 @@ published service HierarchyDataReadAccess </li> <li><code>getByName( "Children" )</code> will return an <atom>any</atom> containing an implementation of service - <type>HierarchyDataReadAccess</type>, if it was called on a read-only + HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service - <type>HierarchyDataReadWriteAccess</type> if it was called on a + HierarchyDataReadWriteAccess if it was called on a writable node. </li> </ul> @@ -99,9 +99,9 @@ published service HierarchyDataReadAccess <code>getByHierarchicalName( "Children/['subnode1']" )</code> will give access to the child node named "subnode1" of the node. It will return an <atom>any</atom> containing an implementation of service - <type>HierarchyDataReadAccess</type>, if it was called on a read-only + HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service - <type>HierarchyDataReadWriteAccess</type> if it was called on a + HierarchyDataReadWriteAccess if it was called on a writable node. </li> <li> @@ -115,9 +115,9 @@ published service HierarchyDataReadAccess will give direct access to the "Children" data member of the child node named "subnode3" of the node. It will return an <atom>any</atom> containing an implementation of service - <type>HierarchyDataReadAccess</type>, if it was called on a read-only + HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service - <type>HierarchyDataReadWriteAccess</type> if it was called on a + HierarchyDataReadWriteAccess if it was called on a writable node. </li> </ul> diff --git a/offapi/com/sun/star/ucb/HierarchyDataSource.idl b/offapi/com/sun/star/ucb/HierarchyDataSource.idl index 7cf38cf1d2ff..6609c93d015d 100644 --- a/offapi/com/sun/star/ucb/HierarchyDataSource.idl +++ b/offapi/com/sun/star/ucb/HierarchyDataSource.idl @@ -45,14 +45,14 @@ published service HierarchyDataSource supports at least the service specifier <code>"com.sun.star.ucb.HierarchyDataReadAccess"</code>, which will create a <b>read-only view</b> to the data. The object that is created - implements the service <type>HierarchyDataReadAccess</type>. + implements the service HierarchyDataReadAccess. <p><b>Optionally</b> the factory may support <b>writable views</b>. A writable view is requested by passing the service specifier <code>"com.sun.star.ucb.HierarchyDataReadWriteAccess"</code> to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments</member> The object that is created implements the service - <type>HierarchyDataReadWriteAccess</type>. + HierarchyDataReadWriteAccess. <p>The arguments passed to <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments</member> @@ -70,7 +70,7 @@ published service HierarchyDataSource element and all its descendants. A path consists of segments that are separated by a single slash ("/"). There is neither a leading nor a trailing slash allowed. The <b>root</b> of the hierarchy data always - has an empty path. Refer to <type>HierarchyDataReadAccess</type> for + has an empty path. Refer to HierarchyDataReadAccess for more information on hierarchical names. <p>Other arguments can be used to control the behavior of the view. diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index cba08b94b748..e10b15bd9b35 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -42,17 +42,17 @@ module com { module sun { module star { module ucb { published service HierarchyFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -104,44 +104,44 @@ published service HierarchyFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 4839af91da9d..6c29f90f669b 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -43,17 +43,17 @@ module com { module sun { module star { module ucb { published service HierarchyLinkContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -102,39 +102,39 @@ published service HierarchyLinkContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index f494ca0b77fc..5db0ee493b49 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -46,17 +46,17 @@ module com { module sun { module star { module ucb { published service HierarchyRootFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -102,44 +102,44 @@ published service HierarchyRootFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/IOErrorCode.idl b/offapi/com/sun/star/ucb/IOErrorCode.idl index 1db24793fc13..92a986f4996c 100644 --- a/offapi/com/sun/star/ucb/IOErrorCode.idl +++ b/offapi/com/sun/star/ucb/IOErrorCode.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { <P>See <type scope="com::sun::star::task">InteractionHandler</type> for a description of what kinds of arguments - <type>InteractiveAugmentedIOException</type> should use with each of these + InteractiveAugmentedIOException should use with each of these error codes.</P> */ published enum IOErrorCode diff --git a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl index ba39152cf026..3aba573c2494 100644 --- a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** An input/output error while processing a file. <p>This exception is deprecated. Use - <type>InteractiveAugmentedIOException</type> instead. + InteractiveAugmentedIOException instead. @deprecated */ diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index 9ab8a8da710d..e4930ea8303b 100644 --- a/offapi/com/sun/star/ucb/ListAction.idl +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { /** This struct contains information needed in the notifications of a - <type>XDynamicResultSet</type>. + XDynamicResultSet. @see ListEvent */ @@ -60,7 +60,7 @@ published struct ListAction <tr align=left> <td>WELCOME</td> <td>n/a</td> <td>n/a</td> - <td><type>WelcomeDynamicResultSetStruct</type> required</td></tr> + <td>WelcomeDynamicResultSetStruct required</td></tr> <tr align=left> <td>CLEARED</td> <td>n/a</td> @@ -89,7 +89,7 @@ published struct ListAction </table> <p>The value for this member can be one of the - <type>ListActionType</type> constants group. + ListActionType constants group. */ long ListActionType; diff --git a/offapi/com/sun/star/ucb/ListActionType.idl b/offapi/com/sun/star/ucb/ListActionType.idl index 7bc27c6a261d..e284cf848ef2 100644 --- a/offapi/com/sun/star/ucb/ListActionType.idl +++ b/offapi/com/sun/star/ucb/ListActionType.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module ucb { /** These values are used to specify the type of change happened to a list. - <p>A change happened is sent from an <type>XDynamicResultSet</type> - as <type>ListAction</type> to a <type>XDynamicResultSetListener</type>. + <p>A change happened is sent from an XDynamicResultSet + as ListAction to a XDynamicResultSetListener. <p>The values are contained in <member>ListAction::ListActionType</member>. */ @@ -39,7 +39,7 @@ published constants ListActionType to a new listener. <p>The member <member>ListAction::ActionInfo</member> is required to - contain a struct <type>WelcomeDynamicResultSetStruct</type>. + contain a struct WelcomeDynamicResultSetStruct. This struct contains two <type scope="com::sun::star::sdbc">XResultSet</type>s (old and new). During and after the notification only the new set is valid for access. @@ -134,7 +134,7 @@ published constants ListActionType The identity of a row has changed. - <p>This action is related to <type>ContentAction</type> == EXCHANGED. + <p>This action is related to ContentAction == EXCHANGED. <p>The members <member>ListAction::Count</member> and <member>ListAction::Position</member> contain the position and count of the diff --git a/offapi/com/sun/star/ucb/ListEvent.idl b/offapi/com/sun/star/ucb/ListEvent.idl index 4877ecc8b942..3f465515c09f 100644 --- a/offapi/com/sun/star/ucb/ListEvent.idl +++ b/offapi/com/sun/star/ucb/ListEvent.idl @@ -25,12 +25,12 @@ module com { module sun { module star { module ucb { -/** specifies the type of event fired by an <type>XDynamicResultSet</type> +/** specifies the type of event fired by an XDynamicResultSet */ published struct ListEvent: com::sun::star::lang::EventObject { - /** If you apply the given <type>ListAction</type>s one after the other + /** If you apply the given ListActions one after the other to the old version of an result set in given order, you will get the positions in the new version. */ diff --git a/offapi/com/sun/star/ucb/MissingInputStreamException.idl b/offapi/com/sun/star/ucb/MissingInputStreamException.idl index 11302a60dd27..a479109078eb 100644 --- a/offapi/com/sun/star/ucb/MissingInputStreamException.idl +++ b/offapi/com/sun/star/ucb/MissingInputStreamException.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ucb { <p>For example, the command "insert" may fail, if the implementation expects that an input stream is supplied with the given - <type>InsertCommandArgument</type>. + InsertCommandArgument. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/NameClash.idl b/offapi/com/sun/star/ucb/NameClash.idl index 9d3f21a27019..af9573a874c2 100644 --- a/offapi/com/sun/star/ucb/NameClash.idl +++ b/offapi/com/sun/star/ucb/NameClash.idl @@ -48,7 +48,7 @@ published constants NameClash */ const long KEEP = 3; - /** Means to use a <type>NameClashResolveRequest</type> in order to solve + /** Means to use a NameClashResolveRequest in order to solve the name clash. @see com::sun::star::task::XInteractionHandler diff --git a/offapi/com/sun/star/ucb/NameClashResolveRequest.idl b/offapi/com/sun/star/ucb/NameClashResolveRequest.idl index ad1069f9c15e..79e105fcdbc2 100644 --- a/offapi/com/sun/star/ucb/NameClashResolveRequest.idl +++ b/offapi/com/sun/star/ucb/NameClashResolveRequest.idl @@ -33,12 +33,12 @@ module com { module sun { module star { module ucb { <p>If this exception is passed to an <type scope="com::sun::star::task">XInteractionHandler</type> an - <type>XInteractionSupplyName</type> and an - <type>XInteractionReplaceExistingData</type> should be supplied with + XInteractionSupplyName and an + XInteractionReplaceExistingData should be supplied with the <type scope="com::sun::star::task">XInteractionRequest</type>. On - return the <type>XInteractionSupplyName</type>, if selected, will contain + return the XInteractionSupplyName, if selected, will contain a new name supposed to resolve the name clash. The - <type>XInteractionReplaceExistingData</type> will be selected if the + XInteractionReplaceExistingData will be selected if the clashing resource shall be overwritten. @version 1.0 diff --git a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl index 55b64e72ef16..d438578dffc2 100644 --- a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl +++ b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl @@ -22,11 +22,11 @@ module com { module sun { module star { module ucb { -/** contains information for sorting a <type>ContentResultSet</type>. +/** contains information for sorting a ContentResultSet. - <p> In contrast to the struct <type>SortingInfo</type> this struct is + <p> In contrast to the struct SortingInfo this struct is used to be on the safe side, that no one asks for sorting by a property - which is not contained in a <type>ContentResultSet</type>. + which is not contained in a ContentResultSet. */ published struct NumberedSortingInfo { diff --git a/offapi/com/sun/star/ucb/ODMAContent.idl b/offapi/com/sun/star/ucb/ODMAContent.idl index 9d36f2d542c5..60978610d527 100644 --- a/offapi/com/sun/star/ucb/ODMAContent.idl +++ b/offapi/com/sun/star/ucb/ODMAContent.idl @@ -45,17 +45,17 @@ module com { module sun { module star { module ucb { published service ODMAContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -122,39 +122,39 @@ published service ODMAContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/ODMAContentProvider.idl b/offapi/com/sun/star/ucb/ODMAContentProvider.idl index c78c8b794cc8..dcdf56e65be2 100644 --- a/offapi/com/sun/star/ucb/ODMAContentProvider.idl +++ b/offapi/com/sun/star/ucb/ODMAContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The ODMA Content Provider (OCP) implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The ODMA Content Provider (OCP) implements a ContentProvider + for the UniversalContentBroker (UCB). <p>It provides access to a document structure stored on a Document Management System (DMS).</p> diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index c2035ce73dea..6ec17644d033 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument.idl @@ -33,7 +33,7 @@ published struct OpenCommandArgument { /** A mode. - <p>The value can be one of the <type>OpenMode</type> constants. + <p>The value can be one of the OpenMode constants. */ long Mode; @@ -62,7 +62,7 @@ published struct OpenCommandArgument com::sun::star::uno::XInterface Sink; /** The properties, for that the values shall be provided by the - <type>DynamicResultSet</type> returned by the command). + DynamicResultSet returned by the command). */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl index 634149d86cda..1e90dad16905 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module ucb { published struct OpenCommandArgument2 : OpenCommandArgument { /** The sort criteria for the rows of the returned - <type>ContentResultSet</type>. + ContentResultSet. <p>The result set implementation may ignore this parameter, if it cannot sort the data by the given criteria in an efficient way (i.e. diff --git a/offapi/com/sun/star/ucb/OpenMode.idl b/offapi/com/sun/star/ucb/OpenMode.idl index 826860bf13b4..323cd914ff59 100644 --- a/offapi/com/sun/star/ucb/OpenMode.idl +++ b/offapi/com/sun/star/ucb/OpenMode.idl @@ -44,7 +44,7 @@ published constants OpenMode sharing. <p>Note: There must be a data sink supplied in the - <type>OpenCommandArgument</type> struct, if this value is set. This + OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data. */ @@ -53,7 +53,7 @@ published constants OpenMode /** open a document. Allow shared read and write access. <p>Note: There must be a data sink supplied in the - <type>OpenCommandArgument</type> struct, if this value is set. This + OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data. */ @@ -62,7 +62,7 @@ published constants OpenMode /** open a document. Deny shared write access. <p>Note: There must be a data sink supplied in the - <type>OpenCommandArgument</type> struct, if this value is set. This + OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data. */ diff --git a/offapi/com/sun/star/ucb/PackageContentProvider.idl b/offapi/com/sun/star/ucb/PackageContentProvider.idl index de69ab0cf5d0..ae51059ce8bf 100644 --- a/offapi/com/sun/star/ucb/PackageContentProvider.idl +++ b/offapi/com/sun/star/ucb/PackageContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The Package Content Provider (PCP) implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The Package Content Provider (PCP) implements a ContentProvider + for the UniversalContentBroker (UCB). <p>It provides access to packages ( zip / jar archive files ) containing folders and streams. @@ -41,12 +41,12 @@ published service PackageContentProvider <b>PCP Contents</b> <ol> <li> - A PCP Stream (<type>PackageStreamContent</type>) is a content which + A PCP Stream (PackageStreamContent) is a content which represents a file inside a package. It is always contained in a PCP Folder. A PCP Stream has no children. </li> <li> - A PCP Folder (<type>PackageFolderContent</type>) is a container for + A PCP Folder (PackageFolderContent) is a container for other PCP Folders and PCP Streams. </li> </ol> diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 7e4692b67211..514d45aaadd6 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -41,17 +41,17 @@ module com { module sun { module star { module ucb { published service PackageFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -117,44 +117,44 @@ published service PackageFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 32cb3acae01e..3d67c7f6bc74 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -42,17 +42,17 @@ module com { module sun { module star { module ucb { published service PackageStreamContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -117,39 +117,39 @@ published service PackageStreamContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl index 42c830ef5e84..17a4d16d653e 100644 --- a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl @@ -25,28 +25,28 @@ module com { module sun { module star { module ucb { -/** A <type>RemoteAccessContentProvider</type> is a - <type>ContentProvider</type> that provides access to contents available at +/** A RemoteAccessContentProvider is a + ContentProvider that provides access to contents available at other (remote) UCBs. */ published service RemoteAccessContentProvider { - /** A <type>RemoteAccessContentProvider</type> is a specialized - <type>ContentProvider</type>. + /** A RemoteAccessContentProvider is a specialized + ContentProvider. */ service com::sun::star::ucb::ContentProvider; - /** allows configuration of the <type>RemoteAccessContentProvider</type>, - to specify that certain <type>XContentIdentifier</type>s map to - <type>XContent</type>s from a certain remote UCB. The Arguments + /** allows configuration of the RemoteAccessContentProvider, + to specify that certain XContentIdentifiers map to + XContents from a certain remote UCB. The Arguments string in the <member>XParameterizedContentProvider::registerInstance</member> call must contain the UNO URL of the remote UCB. @descr - The <type>XContentProvider</type>s obtained through this interface - implement the service <type>ContentProvider</type> and, if - appropriate, also the interface <type>XFileIdentifierConverter</type>. + The XContentProviders obtained through this interface + implement the service ContentProvider and, if + appropriate, also the interface XFileIdentifierConverter. */ interface com::sun::star::ucb::XParameterizedContentProvider; }; diff --git a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl index a8a91639d421..bb09062a5f53 100644 --- a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl @@ -26,15 +26,15 @@ module com { module sun { module star { module ucb { published interface XContentProvider; published interface XParameterizedContentProvider; -/** A <type>ContentProvider</type> that wraps remote content providers that +/** A ContentProvider that wraps remote content providers that (potentially) have been distributed to a UCB. <p>Before trying to pass a request to a "real", underlying content provider (which will most likely be a remote content provider distributed to this UCB), this proxy first activates any remote content providers that have been distributed here, but are still inactive (see - <type>RemoteContentProviderAcceptor</type> and - <type>XRemoteContentProviderActivator</type> for more information). + RemoteContentProviderAcceptor and + XRemoteContentProviderActivator for more information). <p>The way this works might change, therefore this interface is marked as deprecated. @@ -44,17 +44,17 @@ module com { module sun { module star { module ucb { published service RemoteProxyContentProvider { /** activates any potentially inactive remote content providers before - passing on requests to the underlying <type>XContentProvider</type>. + passing on requests to the underlying XContentProvider. */ interface XContentProvider; /** activates any potentially inactive remote content providers before passing on requests to the underlying - <type>XContentIdentifierFactory</type>. + XContentIdentifierFactory. */ [optional] interface XContentIdentifierFactory; - /** allows this <type>ContentProvider</type> to adjust itself to special + /** allows this ContentProvider to adjust itself to special needs. */ [optional] interface XParameterizedContentProvider; diff --git a/offapi/com/sun/star/ucb/ResultSetException.idl b/offapi/com/sun/star/ucb/ResultSetException.idl index 0228ae36c533..ff9e1d3eb05e 100644 --- a/offapi/com/sun/star/ucb/ResultSetException.idl +++ b/offapi/com/sun/star/ucb/ResultSetException.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** This exception is thrown to propagate exceptions thrown by operations - on <type>ContentResultSet</type>s. + on ContentResultSets. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/Rule.idl b/offapi/com/sun/star/ucb/Rule.idl index 70d89676ea22..ddf20924af68 100644 --- a/offapi/com/sun/star/ucb/Rule.idl +++ b/offapi/com/sun/star/ucb/Rule.idl @@ -27,8 +27,8 @@ module com { module sun { module star { module ucb { /** describes a rule that can be applies to a number of objects. - <p>A rule consists of a sequence of <type>RuleTerm</type>s describing the - objects to which the rule should be applied, the <type>RuleAction</type> + <p>A rule consists of a sequence of RuleTerms describing the + objects to which the rule should be applied, the RuleAction which should be used on the matching objects, and a parameter. */ published struct Rule @@ -38,7 +38,7 @@ published struct Rule */ sequence<com::sun::star::ucb::RuleTerm> Terms; - /** Some <type>RuleAction</type>s require a parameter. + /** Some RuleActions require a parameter. <table border =1> <tr> @@ -63,7 +63,7 @@ published struct Rule /** the action to perform on the matching objects. - <p>The value can be one of the <type>RuleAction</type> constants. + <p>The value can be one of the RuleAction constants. */ short Action; diff --git a/offapi/com/sun/star/ucb/RuleSet.idl b/offapi/com/sun/star/ucb/RuleSet.idl index ca27a5e600fa..bf4a061f3fab 100644 --- a/offapi/com/sun/star/ucb/RuleSet.idl +++ b/offapi/com/sun/star/ucb/RuleSet.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module ucb { -/** describes a set of <type>Rule</type>s. +/** describes a set of Rules. <p>A RuleSet is applied to a folder. It consists of a sequence of rules. - Each rule consists of a sequence of <type>RuleTerm</type>s describing the - objects to which the rule should by applied and the <type>RuleAction</type> + Each rule consists of a sequence of RuleTerms describing the + objects to which the rule should by applied and the RuleAction which should be performed on the matching objects. */ published struct RuleSet diff --git a/offapi/com/sun/star/ucb/RuleTerm.idl b/offapi/com/sun/star/ucb/RuleTerm.idl index bef8263a9cc5..49b2a51dfabc 100644 --- a/offapi/com/sun/star/ucb/RuleTerm.idl +++ b/offapi/com/sun/star/ucb/RuleTerm.idl @@ -41,7 +41,7 @@ published struct RuleTerm /** the operator used to compare the property of the document with the given value (e.g. "contains" or "greater equal"). - <p>The value can be one of the <type>RuleOperator</type> constants. + <p>The value can be one of the RuleOperator constants. */ short Operator; diff --git a/offapi/com/sun/star/ucb/SearchCommandArgument.idl b/offapi/com/sun/star/ucb/SearchCommandArgument.idl index 1df91bfcb5f9..6c5d112e1b57 100644 --- a/offapi/com/sun/star/ucb/SearchCommandArgument.idl +++ b/offapi/com/sun/star/ucb/SearchCommandArgument.idl @@ -37,7 +37,7 @@ published struct SearchCommandArgument SearchInfo Info; /** the properties for which values shall be provided through the - <type>ContentResultSet</type> returned by the search command. + ContentResultSet returned by the search command. */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl index f6c2fe7adcc6..a5b0a14ac5a2 100644 --- a/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/SortedDynamicResultSetFactory.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** is a factory for <type>DynamicResultSet</type> implementations, which +/** is a factory for DynamicResultSet implementations, which will be sorted according to the given sorting options. */ published service SortedDynamicResultSetFactory diff --git a/offapi/com/sun/star/ucb/Store.idl b/offapi/com/sun/star/ucb/Store.idl index a6eb94876445..500d2999c2c6 100644 --- a/offapi/com/sun/star/ucb/Store.idl +++ b/offapi/com/sun/star/ucb/Store.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { -/** creates instances of the service <type>PropertySetRegistry</type>. +/** creates instances of the service PropertySetRegistry. */ published service Store : XPropertySetRegistryFactory; diff --git a/offapi/com/sun/star/ucb/TransferInfo.idl b/offapi/com/sun/star/ucb/TransferInfo.idl index ff7ab7e29b28..07c6af8faa96 100644 --- a/offapi/com/sun/star/ucb/TransferInfo.idl +++ b/offapi/com/sun/star/ucb/TransferInfo.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { <p>The transfer command is always called on the target folder. For a details description of the transfer command refer to the documentation - of service <type>Content</type>. + of service Content. */ published struct TransferInfo { @@ -56,7 +56,7 @@ published struct TransferInfo to be transferred to a folder already containing another file named "foo.txt". - <p>The value can be one of the <type>NameClash</type> constants. + <p>The value can be one of the NameClash constants. <p>Implementations that are not able to detect whether there is a clashing resource may ignore <member>NameClash::ERROR</member> and diff --git a/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl b/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl index 7fb990352209..012a3dd46fa8 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsContentProvider.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** The Transient Documents Content Provider (TDCP) implements a - <type>ContentProvider</type> for the <type>UniversalContentBroker</type> + ContentProvider for the UniversalContentBroker (UCB). <p>It provides access to the hierarchical structure of the documents that @@ -57,25 +57,25 @@ service TransientDocumentsContentProvider <b>TDCP Contents</b> <ol> <li> - A TDCP Stream (<type>TransientDocumentsStreamContent</type>) is a + A TDCP Stream (TransientDocumentsStreamContent) is a content which represents a data stream of an Office document. It is contained in a TDCP Folder or TDCP Document. A TDCP Stream has no children. </li> <li> - A TDCP Folder (<type>TransientDocumentsFolderContent</type>) is a + A TDCP Folder (TransientDocumentsFolderContent) is a container for other TDCP Folders and TDCP Streams. It may be contained in another TDCP Folder or in a TDCP Document. </li> <li> - A TDCP Document (<type>TransientDocumentsDocumentContent</type>) + A TDCP Document (TransientDocumentsDocumentContent) represents the root folder of a transient document. It is a container for other TDCP Folders and TDCP Streams. It is always a child of the TDCP Root. </li> <li> There is at most one instance of a TDCP Root - (<type>TransientDocumentsRootContent</type>) at a time. All other TDCP + (TransientDocumentsRootContent) at a time. All other TDCP contents are children of this folder. The TDCP Root Folder can contain only TDCP Documents. It has the fixed URL "vnd.sun.star.tdoc:/". </li> diff --git a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl index 078c56085490..b45283769b06 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsDocumentContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -106,44 +106,44 @@ service TransientDocumentsDocumentContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>To create a new child of a TDCP Document: diff --git a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl index 1b0c545ef722..dee571768248 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl @@ -47,17 +47,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -116,44 +116,44 @@ service TransientDocumentsFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p>To create a new child of a TDCP Folder: diff --git a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl index 284f885418a0..271c9410626c 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsRootContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -101,39 +101,39 @@ service TransientDocumentsRootContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl index 30d5a750def2..89b95d7fbb05 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { service TransientDocumentsStreamContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -107,39 +107,39 @@ service TransientDocumentsStreamContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; diff --git a/offapi/com/sun/star/ucb/UniversalContentBroker.idl b/offapi/com/sun/star/ucb/UniversalContentBroker.idl index 81cc2dfaebe7..39768d13a7bd 100644 --- a/offapi/com/sun/star/ucb/UniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/UniversalContentBroker.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** is a one-instance service that provides access to a set of - <type>Content</type>s via <type>ContentProvider</type>s. + Contents via ContentProviders. <p>Traditionally, this service implements <type scope="com::sun::star::lang">XInitialization</type> and needed to be diff --git a/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl b/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl index 96007a7095fa..8403afeaad30 100644 --- a/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedDataSinkException.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** This exception is used to indicate that the requested type of data sink is not supported. - <p>For example, each <type>OpenCommandArgument</type> supplied as argument + <p>For example, each OpenCommandArgument supplied as argument of the command "open" contains such a data sink. @version 1.0 diff --git a/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl b/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl index e667373a2d9e..e8154991dc39 100644 --- a/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedNameClashException.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ucb { it or if it is just not (yet) implemented. <p>Command "transfer": Used if the name clash directive specified in - parameter NameClash of the supplied <type>TransferInfo</type> is not + parameter NameClash of the supplied TransferInfo is not supported. For example, if the NameClash was set to NameClash::ERROR, to NameClash::RENAME or to NameClash::ASK, the implementation must be able determine whether there are existing data. This exception must also @@ -38,7 +38,7 @@ module com { module sun { module star { module ucb { unable to create a valid new name after a suitable number of tries. <p>Command "insert": Used if the parameter ReplaceExisting of the - supplied <type>InsertCommandArgument</type> was set to <false/> and the + supplied InsertCommandArgument was set to <false/> and the implementation is unable to determine whether there are existing data. The member NameClash of the exception must be set to NameClash::ERROR @@ -48,7 +48,7 @@ module com { module sun { module star { module ucb { */ published exception UnsupportedNameClashException : com::sun::star::uno::Exception { - /** contains the <type>NameClash</type> that is not supported. + /** contains the NameClash that is not supported. */ long NameClash; }; diff --git a/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl b/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl index 20aca8332f96..8aa2555083ca 100644 --- a/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl +++ b/offapi/com/sun/star/ucb/UnsupportedOpenModeException.idl @@ -25,10 +25,10 @@ module com { module sun { module star { module ucb { -/** This exception is used to indicate that the requested <type>OpenMode</type> +/** This exception is used to indicate that the requested OpenMode is not supported. - <p>For example, each <type>OpenCommandArgument</type> supplied as argument + <p>For example, each OpenCommandArgument supplied as argument of the command "open" contains such an open mode. @version 1.0 @@ -37,7 +37,7 @@ module com { module sun { module star { module ucb { */ published exception UnsupportedOpenModeException : com::sun::star::uno::Exception { - /** contains the <type>OpenMode</type> that is not supported. + /** contains the OpenMode that is not supported. */ short Mode; }; diff --git a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl index ceaa55a889af..6a27e7f1704a 100644 --- a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl +++ b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl @@ -24,8 +24,8 @@ module com { module sun { module star { module ucb { -/** The WebDAV Content Provider (DCP) implements a <type>ContentProvider</type> - for the <type>UniversalContentBroker</type> (UCB). +/** The WebDAV Content Provider (DCP) implements a ContentProvider + for the UniversalContentBroker (UCB). <p>It provides access to WebDAV and standard HTTP servers. The DCP communicates with the server using the WebDAV protocol which is an @@ -45,11 +45,11 @@ published service WebDAVContentProvider <b>DCP Contents</b> <ol> <li> - A DCP Folder (<type>WebDAVFolderContent</type>) is a container for + A DCP Folder (WebDAVFolderContent) is a container for other DCP Folders or Documents. </li> <li> - A DCP Document (<type>WebDAVDocumentContent</type>) is a container for + A DCP Document (WebDAVDocumentContent) is a container for Document data/content. The data/content may be anything, a WebDAV server, like an HTTP server, does not necessarily mandate what type of data/content may be contained within Documents. The type of data/content diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index 4078fd443a5b..827936999813 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -48,17 +48,17 @@ module com { module sun { module star { module ucb { published service WebDAVDocumentContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -86,7 +86,7 @@ published service WebDAVDocumentContent open </li> <li> - post ( Argument: <type>PostCommandArgument2</type> - does a HTTP POST ) + post ( Argument: PostCommandArgument2 - does a HTTP POST ) </li> </ul> @@ -122,39 +122,39 @@ published service WebDAVDocumentContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; }; diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index ca3e5324d9b2..02b2cd3d819d 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -41,17 +41,17 @@ module com { module sun { module star { module ucb { published service WebDAVFolderContent { /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::lang::XComponent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XContent; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> @@ -116,44 +116,44 @@ published service WebDAVFolderContent */ interface com::sun::star::ucb::XCommandProcessor; - /** is an enhanced version of <type>XCommandProcessor</type> that has an + /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to <member>XCommandProcessor2::releaseCommandIdentifier</member>. - <p>Where many existing <type>Content</type> implementations do not + <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertiesChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertyContainer; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::beans::XPropertySetInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::ucb::XCommandInfoChangeNotifier; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. */ interface com::sun::star::container::XChild; /** This interface is implemented according to the specification of - service <type>Content</type>. + service Content. <p> diff --git a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl index 668e3d0a349a..ce6b78af5a90 100644 --- a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl +++ b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { /** This struct is to be contained in the first notification of an - <type>XDynamicResultSet</type>. + XDynamicResultSet. @see XDynamicResultSet @see ListEvent diff --git a/offapi/com/sun/star/ucb/XAnyCompareFactory.idl b/offapi/com/sun/star/ucb/XAnyCompareFactory.idl index 500f311d2086..1fb0956b3680 100644 --- a/offapi/com/sun/star/ucb/XAnyCompareFactory.idl +++ b/offapi/com/sun/star/ucb/XAnyCompareFactory.idl @@ -26,12 +26,12 @@ module com { module sun { module star { module ucb { -/** creates an <type>XAnyCompare</type> instance. +/** creates an XAnyCompare instance. */ published interface XAnyCompareFactory: com::sun::star::uno::XInterface { - /** creates an <type>XAnyCompare</type> instance. + /** creates an XAnyCompare instance. @param PropertyName is the name of a property diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl index f24c9d642288..47833e402de4 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedContentResultSet</type>. +/** creates a CachedContentResultSet. */ published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface @@ -35,15 +35,15 @@ published interface XCachedContentResultSetFactory: com::sun::star::uno::XInterf <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource - must be an instance of service <type>CachedContentResultSetStub</type>. + must be an instance of service CachedContentResultSetStub. @param xMapping can be used for optimization of remote access via the interface - <type>XContentAccess</type> of the <type>CachedContentResultSet</type>. + XContentAccess of the CachedContentResultSet. This parameter can be <NULL/>. @returns - an instance of service <type>CachedContentResultSet</type>. + an instance of service CachedContentResultSet. */ com::sun::star::sdbc::XResultSet createCachedContentResultSet( [in] com::sun::star::sdbc::XResultSet xSource, diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl index d3795626afa8..f27e1c9b3a97 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedContentResultSetStub</type>. +/** creates a CachedContentResultSetStub. */ published interface XCachedContentResultSetStubFactory: com::sun::star::uno::XInterface @@ -34,10 +34,10 @@ published interface XCachedContentResultSetStubFactory: com::sun::star::uno::XIn <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource - must be an instance of service <type>ContentResultSet</type>. + must be an instance of service ContentResultSet. @returns - an instance of service <type>CachedContentResultSetStub</type>. + an instance of service CachedContentResultSetStub. */ com::sun::star::sdbc::XResultSet createCachedContentResultSetStub( [in] com::sun::star::sdbc::XResultSet xSource ); diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl index 59adad760ae7..f6205e30422d 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetFactory.idl @@ -26,34 +26,34 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedDynamicResultSet</type>. +/** creates a CachedDynamicResultSet. <p>Pay attention to instantiate this helper on client side where your want to read the data respectively where you have instantiated the listener to - the <type>XDynamicResultSet</type>. + the XDynamicResultSet. <p>The needed stub on server side can be created using - <type>XCachedDynamicResultSetStubFactory</type>. + XCachedDynamicResultSetStubFactory. */ published interface XCachedDynamicResultSetFactory: com::sun::star::uno::XInterface { - /** creates a remote optimizes <type>XDynamicResultSet</type>. + /** creates a remote optimizes XDynamicResultSet. @param SourceStub - must be an instance of service <type>CachedDynamicResultSetStub</type>. + must be an instance of service CachedDynamicResultSetStub. It can be <NULL/>. In this case you can use the interface - <type>XSourceInitialization</type> of the returned - <type>CachedDynamicResultSet</type> to set the stub later. + XSourceInitialization of the returned + CachedDynamicResultSet to set the stub later. @param ContentIdentifierMapping is not required, but can be set if it is necessary to change the identity of the contents accessible via the interface - <type>XContentAccess</type> of the <type>ContentResultSet</type> + XContentAccess of the ContentResultSet (e.g., if merging two sources of the same type). @returns - an instance of service <type>CachedDynamicResultSet</type>. + an instance of service CachedDynamicResultSet. */ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSet( [in] com::sun::star::ucb::XDynamicResultSet SourceStub diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 9ca861b7db9f..91ef8523811e 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -27,48 +27,48 @@ module com { module sun { module star { module ucb { -/** creates a <type>CachedDynamicResultSetStub</type> and connects a non-remote - optimized <type>DynamicResultSet</type> to a remote optimized - <type>CachedDynamicResultSet</type>. +/** creates a CachedDynamicResultSetStub and connects a non-remote + optimized DynamicResultSet to a remote optimized + CachedDynamicResultSet. <p>Pay attention to instantiate this helper on server side where your source - <type>DynamicResultSet</type> was instantiated. + DynamicResultSet was instantiated. <p>Method <member>XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub</member> can be used to create a stub on server side. - <p>If you have instantiated a <type>CachedDynamicResultSet</type> on client + <p>If you have instantiated a CachedDynamicResultSet on client side already, use method <member>connectToCache</member> to connect your given DynamicResultSet with this Cache. <p>The needed cache on server side you can create using - <type>XCachedDynamicResultSetFactory</type>. + XCachedDynamicResultSetFactory. */ published interface XCachedDynamicResultSetStubFactory: com::sun::star::uno::XInterface { - /** creates a remote optimizes <type>XDynamicResultSet</type>. + /** creates a remote optimizes XDynamicResultSet. @param Source - must be an instance of service <type>DynamicResultSet</type>. + must be an instance of service DynamicResultSet. @returns - an instance of service <type>CachedDynamicResultSetStub</type>. + an instance of service CachedDynamicResultSetStub. */ com::sun::star::ucb::XDynamicResultSet createCachedDynamicResultSetStub( [in] com::sun::star::ucb::XDynamicResultSet Source ); - /** If you have instantiated a <type>CachedDynamicResultSet</type> on + /** If you have instantiated a CachedDynamicResultSet on client side already, use this to connect your given Source on server side to the TargetCache. @param Source - is an instance of service <type>DynamicResultSet</type>. + is an instance of service DynamicResultSet. @param TargetCache - is an instance of service <type>CachedDynamicResultSet</type>. + is an instance of service CachedDynamicResultSet. @param SortingInfo can be an empty sequence. Otherwise, Source will be sorted according diff --git a/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl b/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl index 129065f6d092..10546e68e16a 100644 --- a/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl +++ b/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a listener for events related to changing <type>XCommandInfo</type>s. +/** a listener for events related to changing XCommandInfos. @version 1.0 @author Kai Sommerfeld @@ -34,7 +34,7 @@ module com { module sun { module star { module ucb { */ published interface XCommandInfoChangeListener : com::sun::star::lang::XEventListener { - /** gets called whenever changes of a <type>XCommandInfo</type> shall + /** gets called whenever changes of a XCommandInfo shall be propagated. @param evt diff --git a/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl b/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl index c1d0bb563567..80eb0fa78acc 100644 --- a/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a notifier for changes of <type>XCommandInfo</type>s. +/** a notifier for changes of XCommandInfos. @version 1.0 @author Kai Sommerfeld @@ -34,7 +34,7 @@ module com { module sun { module star { module ucb { */ published interface XCommandInfoChangeNotifier : com::sun::star::uno::XInterface { - /** registers a listener for <type>CommandInfoChangeEvent</type>s. + /** registers a listener for CommandInfoChangeEvents. @param Listener the listener to add. @@ -42,7 +42,7 @@ published interface XCommandInfoChangeNotifier : com::sun::star::uno::XInterface void addCommandInfoChangeListener( [in] XCommandInfoChangeListener Listener ); - /** removes a listener for <type>CommandInfoChangeEvent</type>s. + /** removes a listener for CommandInfoChangeEvents. @param Listener the listener to remove. diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index 89cee4005ac5..1edf2ca3cea4 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor.idl @@ -72,7 +72,7 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface /** executes a command. <p>Common command definitions can be found in the specification of the - service <type>Content</type>. + service Content. @param aCommand is the command to execute. @@ -83,7 +83,7 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface zero can be used, if the command never shall be aborted. Different threads MUST NOT share one command identifier (except <code>0</code>). This can easily achieved, if every thread that wants to use an - <type>XCommandProcessor</type>, obtains exactly one identifier + XCommandProcessor, obtains exactly one identifier using <member>XCommandProcessor::createCommandIdentifier</member>. This identifier can be used for every call to <member>XCommandProcessor::execute</member> done by that thread. diff --git a/offapi/com/sun/star/ucb/XContentAccess.idl b/offapi/com/sun/star/ucb/XContentAccess.idl index 8f25fb9e7e30..75abcd300016 100644 --- a/offapi/com/sun/star/ucb/XContentAccess.idl +++ b/offapi/com/sun/star/ucb/XContentAccess.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ucb { /** specifies methods for obtaining information on a content in different levels. - <p>For example, if there is a cursor which points to <type>XContent</type>s, + <p>For example, if there is a cursor which points to XContents, this interface could be used to give the user access to the content under the cursor. If the client only needs the identifier string of the content, there is no need to first create the content object, then to obtain the diff --git a/offapi/com/sun/star/ucb/XContentCreator.idl b/offapi/com/sun/star/ucb/XContentCreator.idl index 52b4e7fef471..69080f2e36ee 100644 --- a/offapi/com/sun/star/ucb/XContentCreator.idl +++ b/offapi/com/sun/star/ucb/XContentCreator.idl @@ -41,7 +41,7 @@ module com { module sun { module star { module ucb { @deprecated - <p>This interface is deprecated. Use <type>Content</type> property + <p>This interface is deprecated. Use Content property "CreatableContentsInfo" and command "createNewContent" instead. @version 1.0 diff --git a/offapi/com/sun/star/ucb/XContentEventListener.idl b/offapi/com/sun/star/ucb/XContentEventListener.idl index 7434fc549da7..02cf799c98f1 100644 --- a/offapi/com/sun/star/ucb/XContentEventListener.idl +++ b/offapi/com/sun/star/ucb/XContentEventListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a listener for events related to <type>XContent</type>s. +/** a listener for events related to XContents. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl index c332ee402292..b06a1b743b37 100644 --- a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl +++ b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl @@ -27,17 +27,17 @@ module com { module sun { module star { module ucb { published interface XContent; published interface XContentIdentifier; -/** A mapping from a (source) set of <type>XContentIdentifier</type>s to +/** A mapping from a (source) set of XContentIdentifiers to another (target) set of XContentIdentifiers. <p>For convenience and performance, mapping between the string representations of source/target XContentIdentifiers, as well as mapping - between <type>XContent</type>s identified by source/target + between XContents identified by source/target XContentIdentifiers is also supported. <p>This interface can be useful in cases where the identifiers (and associated contents) returned by the various methods of an - <type>XContentAccess</type> need to be mapped to some other space of + XContentAccess need to be mapped to some other space of identifiers (and associated contents). @see XContent @@ -47,7 +47,7 @@ module com { module sun { module star { module ucb { published interface XContentIdentifierMapping: com::sun::star::uno::XInterface { - /** Map the string representation of an <type>XContentIdentifier</type>. + /** Map the string representation of an XContentIdentifier. @param Source The string representation of an XContentIdentifier from the source set. @@ -59,7 +59,7 @@ published interface XContentIdentifierMapping: com::sun::star::uno::XInterface */ string mapContentIdentifierString([in] string Source); - /** Map an <type>XContentIdentifier</type>. + /** Map an XContentIdentifier. @param Source An XContentIdentifier from the source set. @@ -70,8 +70,8 @@ published interface XContentIdentifierMapping: com::sun::star::uno::XInterface */ XContentIdentifier mapContentIdentifier([in] XContentIdentifier Source); - /** Map the <type>XContent</type> identified by an - <type>XContentIdentifier</type>. + /** Map the XContent identified by an + XContentIdentifier. @param Source The XContent identified by an XContentIdentifier from the source set. diff --git a/offapi/com/sun/star/ucb/XContentProvider.idl b/offapi/com/sun/star/ucb/XContentProvider.idl index 1f6d8beb5570..96890184c715 100644 --- a/offapi/com/sun/star/ucb/XContentProvider.idl +++ b/offapi/com/sun/star/ucb/XContentProvider.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** a content provider which creates and manages <type>XContent</type>s. +/** a content provider which creates and manages XContents. @version 1.0 @author Kai Sommerfeld @@ -36,8 +36,8 @@ module com { module sun { module star { module ucb { */ published interface XContentProvider: com::sun::star::uno::XInterface { - /** creates a new <type>XContent</type> instance, if the given - <type>XContentIdentifier</type> matches a content provided by the + /** creates a new XContent instance, if the given + XContentIdentifier matches a content provided by the implementation of this interface. @param Identifier @@ -54,7 +54,7 @@ published interface XContentProvider: com::sun::star::uno::XInterface [in] com::sun::star::ucb::XContentIdentifier Identifier ) raises ( com::sun::star::ucb::IllegalIdentifierException ); - /** compares two <type>XContentIdentifier</type>s. + /** compares two XContentIdentifiers. @param Id1 first content identifier. diff --git a/offapi/com/sun/star/ucb/XContentProviderFactory.idl b/offapi/com/sun/star/ucb/XContentProviderFactory.idl index bc399bc6d442..4ffa14f99275 100644 --- a/offapi/com/sun/star/ucb/XContentProviderFactory.idl +++ b/offapi/com/sun/star/ucb/XContentProviderFactory.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** a factory for a <type>XContentProvider</type>. +/** a factory for a XContentProvider. @version 1.0 @author Kai Sommerfeld @@ -33,7 +33,7 @@ module com { module sun { module star { module ucb { */ published interface XContentProviderFactory : com::sun::star::uno::XInterface { - /** creates a <type>XContentProvider</type> implementation object. + /** creates a XContentProvider implementation object. @param Service the name of the UNO service to be used to create the implementation of diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 9061770691a2..abfa388c2cbf 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -45,7 +45,7 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface <p>This may be <NULL/>, in which case a later <member>XContentProvider::queryContent</member> with an - <type>XContentIdentifier</type> that matches the <var>Scheme</var> + XContentIdentifier that matches the <var>Scheme</var> will simply return <NULL/>. These "dummy" content providers are useful in combination with other content providers that are registered on a wildcard URL template: For example, imagine that you want to route all @@ -95,8 +95,8 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface match the same URLs as their <code><simple>:</code> counterparts, but they also describe how a (local) URL is mapped to another (remote) URL. This mapping is only relevant for methods of the - <type>RemoteAccessContentProvider</type>'s - <type>XParameterizedContentProvider</type> interface; in all other + RemoteAccessContentProvider's + XParameterizedContentProvider interface; in all other cases, <code><translation>:</code> regexps have the same semantics as their <code><simple>:</code> counterparts. diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index 0f835706042a..ad783c5b7d3b 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -29,33 +29,33 @@ module com { module sun { module star { module ucb { -/** Provides read access to a <type>ContentResultSet</type>. +/** Provides read access to a ContentResultSet. <p> - You can either get a simple static <type>ContentResultSet</type> or you can + You can either get a simple static ContentResultSet or you can listen to change-notifications and than swap from the old to a new - <type>ContentResultSet</type>. + ContentResultSet. </p> <p>The following describes the dynamic use:</p> <p> - <type>XDynamicResultSet</type> provides the possibility to get notifications - about changes on a <type>ContentResultSet</type> and have an + XDynamicResultSet provides the possibility to get notifications + about changes on a ContentResultSet and have an listener-controlled update from one version to the next version. Two - <type>ContentResultSet</type> implementations were given to the listener in + ContentResultSet implementations were given to the listener in the first notification as interface <type scope="com::sun::star::sdbc">XResultSet</type>. </p> <p> To get notifications the listener has to be of type - <type>XDynamicResultSetListener</type>. + XDynamicResultSetListener. </p> <p> After registration you will get notifications for events of type - <type>ListEvent</type>. + ListEvent. </p> <p> @@ -70,7 +70,7 @@ module com { module sun { module star { module ucb { </p> <ol> - <li> The listener is allowed to access both <type>ContentResultSet</type>s, + <li> The listener is allowed to access both ContentResultSets, they must be both valid.</li> <li> It is not allowed to start a second notify-call.</li> <li> All additional things we want to send as notification are to be @@ -84,10 +84,10 @@ module com { module sun { module star { module ucb { <ol> <li> The listener is allowed to access the new - <type>ContentResultSet</type>. The new one is first assigned in the + ContentResultSet. The new one is first assigned in the WELCOME-event and than the ResultSets are always swapped.</li> <li> The listener is not allowed to access the old - <type>ContentResultSet</type>.</li> + ContentResultSet.</li> </ol> */ @@ -97,13 +97,13 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @returns an <type scope="com::sun::star::sdbc">XResultSet</type> that is - implemented as <type>ContentResultSet</type>. Its content will never + implemented as ContentResultSet. Its content will never change. @trows ListenerAlreadySetException if someone already has registered as listener via <member>XDynamicResultSet::setListener</member> or if someone has - established a connection to a <type>CachedDynamicResultSet</type> + established a connection to a CachedDynamicResultSet via <member>XDynamicResultSet::connectToCache</member>. */ com::sun::star::sdbc::XResultSet getStaticResultSet() @@ -123,17 +123,17 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @throws ListenerAlreadySetException if this method is called more than once during the life of the implementation object or if this method is called if someone already - has fetched the <type>ContentResultSet</type> via + has fetched the ContentResultSet via <member>XDynamicResultSet::getStaticResultSet</member>. */ void setListener( [in] XDynamicResultSetListener Listener ) raises( com::sun::star::ucb::ListenerAlreadySetException ); - /** Connects this to a <type>CachedDynamicResultSet</type> for optimized + /** Connects this to a CachedDynamicResultSet for optimized remote data transport. - <p>This method creates a <type>CachedDynamicResultSetStub</type> + <p>This method creates a CachedDynamicResultSetStub and sets it as Source to the given cache. <p>After this method has returned you can and have to use the given @@ -141,11 +141,11 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @param Cache has to be an implementation of the service - <type>CachedDynamicResultSet</type>. In particular it has to support - the interface <type>XSourceInitialization</type>. + CachedDynamicResultSet. In particular it has to support + the interface XSourceInitialization. @throws ListenerAlreadySetException - if if someone already has fetched the <type>ContentResultSet</type> via + if if someone already has fetched the ContentResultSet via <member>XDynamicResultSet::getStaticResultSet</member>. @throws AlreadyInitializedException @@ -159,11 +159,11 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent , com::sun::star::ucb::ServiceNotFoundException ); /** Using this method you can get information, whether the offered - <type>ContentResultSet</type>s are sorted or filtered etc correctly as - demanded during the creation of the <type>XDynamicResultSet</type>. + ContentResultSets are sorted or filtered etc correctly as + demanded during the creation of the XDynamicResultSet. @returns - zero or more constants of the <type>ContentResultSetCapability</type> + zero or more constants of the ContentResultSetCapability constants group. */ short getCapabilities(); diff --git a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl index e06e107aa7bb..77f97f00dd4b 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** used to receive notifications from an <type>XDynamicResultSet</type>. +/** used to receive notifications from an XDynamicResultSet. */ published interface XDynamicResultSetListener: com::sun::star::lang::XEventListener @@ -35,7 +35,7 @@ published interface XDynamicResultSetListener: com::sun::star::lang::XEventListe <p>In the first notify-call the listener gets two(!) <type scope="com::sun::star::sdbc">XResultSet</type>s and has to hold them. The <type scope="com::sun::star::sdbc">XResultSet</type>s are - implementations of the service <type>ContentResultSet</type>. + implementations of the service ContentResultSet. <p>The notified new <type scope="com::sun::star::sdbc">XResultSet</type> will stay valid diff --git a/offapi/com/sun/star/ucb/XFetchProvider.idl b/offapi/com/sun/star/ucb/XFetchProvider.idl index d790b53917cb..64a24245b6dd 100644 --- a/offapi/com/sun/star/ucb/XFetchProvider.idl +++ b/offapi/com/sun/star/ucb/XFetchProvider.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** provides the possibility to get the contents of the columns of several - rows of a <type>ContentResultSet</type> with a single function call. + rows of a ContentResultSet with a single function call. */ published interface XFetchProvider: com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl index 59ace22f74de..cd39c388df44 100644 --- a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl +++ b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl @@ -26,8 +26,8 @@ module com { module sun { module star { module ucb { /** provides the possibility to load information offered by a - <type>XContentAccess</type> for several rows of a - <type>ContentResultSet</type> with a single function call. + XContentAccess for several rows of a + ContentResultSet with a single function call. */ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface { @@ -54,12 +54,12 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf , [in] long nRowCount , [in] boolean bDirection ); - /** returns the <type>XContentIdentifier</type>s of the columns of the + /** returns the XContentIdentifiers of the columns of the indicated rows @returns <member>FetchResult::Rows</member> contains a sequence of anys. Each - of these anys contains an <type>XContentIdentifier</type>. + of these anys contains an XContentIdentifier. @param nRowStartPosition the starting row of the result set @@ -81,7 +81,7 @@ published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterf @returns <member>FetchResult::Rows</member> contains a sequence of anys. Each - of these anys contains an <type>XContent</type>. + of these anys contains an XContent. @param nRowStartPosition the starting row of the result set diff --git a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl index 83f5cac68353..32946dabfa8e 100644 --- a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl +++ b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** This interface should be implemented by an internal - <type>XCommandEnvironment</type> that can not supply an + XCommandEnvironment that can not supply an <type scope="com::sun::star::task">XInteractionHandler</type>, but instead wants interaction requests to be handled by other internal error handling mechanism. diff --git a/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl b/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl index e160195101f8..e5e568d5eaba 100644 --- a/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl +++ b/offapi/com/sun/star/ucb/XInteractionReplaceExistingData.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { existing data. <p>For example, this continuation can be selected when handling a - <type>NameClashResolveRequest</type> in order to instruct the requester + NameClashResolveRequest in order to instruct the requester to overwrite the clashing data. @version 1.0 diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index 96c90829ca75..3ccc8b8bd828 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** An interaction continuation handing back some authentication data. <p> This continuation is typically used in conjunction with - <type>AuthenticationRequest</type>. </p> + AuthenticationRequest. </p> */ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionContinuation { diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl index 090343fb8dad..c775f37f065e 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication2.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** An interaction continuation handing back some authentication data. <p> This continuation is typically used in conjunction with - <type>AuthenticationRequest</type>. </p> + AuthenticationRequest. </p> @since OOo 3.2 */ diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyName.idl b/offapi/com/sun/star/ucb/XInteractionSupplyName.idl index a5d7f0fba933..97eef6d613bf 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyName.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyName.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { /** is an interaction continuation used to hand back a new name for something. <p>For example, this continuation can be selected when handling a - <type>NameClashResolveRequest</type> in order to supply a new name + NameClashResolveRequest in order to supply a new name for a clashing resource. @version 1.0 diff --git a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl index 45d5c9c85649..7c9f66e8170b 100644 --- a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl +++ b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl @@ -42,7 +42,7 @@ published interface XParameterizedContentProvider: com::sun::star::uno::XInterfa complex, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. @param Arguments Any supplementary arguments required by this - <type>XContentProvider</type>, represented as a single string. If the + XContentProvider, represented as a single string. If the input is malformed, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. @@ -53,12 +53,12 @@ published interface XParameterizedContentProvider: com::sun::star::uno::XInterfa already registered instance, the new registration is not performed, and null is returned. - @return Either this <type>XContentProvider</type>, or another, - specially adjusted version of this <type>XContentProvider</type> (this + @return Either this XContentProvider, or another, + specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if the given Template conflicts with an already registered instance and ReplaceExisting is false. Note that the returned - <type>XContentProvider</type> must still be registered at the content + XContentProvider must still be registered at the content provider manager! */ com::sun::star::ucb::XContentProvider @@ -73,16 +73,16 @@ published interface XParameterizedContentProvider: com::sun::star::uno::XInterfa complex, an IllegalArgumentException may be raised. @param Arguments Any supplementary arguments required by this - <type>XContentProvider</type>, represented as a single string. If the + XContentProvider, represented as a single string. If the input is malformed, an <type scope="com::sun::star::lang">IllegalArgumentException</type> may be raised. - @return Either this <type>XContentProvider</type>, or another, - specially adjusted version of this <type>XContentProvider</type> (this + @return Either this XContentProvider, or another, + specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if no instance is registered for the given Template. Note that the - returned <type>XContentProvider</type> must still be deregistered at + returned XContentProvider must still be deregistered at the content provider manager! */ com::sun::star::ucb::XContentProvider diff --git a/offapi/com/sun/star/ucb/XPersistentPropertySet.idl b/offapi/com/sun/star/ucb/XPersistentPropertySet.idl index 7e4fbf069484..95a1bb099961 100644 --- a/offapi/com/sun/star/ucb/XPersistentPropertySet.idl +++ b/offapi/com/sun/star/ucb/XPersistentPropertySet.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { published interface XPropertySetRegistry; /** A persistent property set, which can be saved in and restored from a - <type>XPropertySetRegistry</type>. + XPropertySetRegistry. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl b/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl index c8b728d56fff..4d3d0fce83d3 100644 --- a/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl +++ b/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { -/** Creates an <type>XPropertyMatcher</type>, given a set of search criteria. +/** Creates an XPropertyMatcher, given a set of search criteria. */ published interface XPropertyMatcherFactory : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/ucb/XRecycler.idl b/offapi/com/sun/star/ucb/XRecycler.idl index 52552214daba..c201153dc98c 100644 --- a/offapi/com/sun/star/ucb/XRecycler.idl +++ b/offapi/com/sun/star/ucb/XRecycler.idl @@ -26,14 +26,14 @@ module com { module sun { module star { module ucb { -/** Allows an <type>XContent</type> to delete itself into the trash can. +/** Allows an XContent to delete itself into the trash can. <p>This is an additional interface the XContent representing the trash can (URL: "vnd.sun.staroffice.trashcan:///") should support. */ published interface XRecycler : com::sun::star::uno::XInterface { - /** Notify the trash can that an <type>XContent</type> is deleting itself + /** Notify the trash can that an XContent is deleting itself into it. @param Properties diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 52dcc97b38c0..2b4f77621fb7 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -42,7 +42,7 @@ published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterf remote content provider. @param Factory A factory through which the remote content provider's - <type>UniversalContentBroker</type> service can be instantiated. + UniversalContentBroker service can be instantiated. @param Templates A sequence of URL templates the remote content provider is willing to handle. @@ -56,7 +56,7 @@ published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterf To enable connection control, it is recommended that this argument also implements the interface - <type>XRemoteContentProviderConnectionControl</type>. + XRemoteContentProviderConnectionControl. @return true if the remote content provider has successfully been added. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl index ffed3ad35d24..a8b96f053f7a 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { published interface XContentProviderManager; /** This interface should be implemented together with - <type>XRemoteContentProviderAcceptor</type> and allows for a lazy + XRemoteContentProviderAcceptor and allows for a lazy implementation of <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. @@ -48,7 +48,7 @@ published interface XRemoteContentProviderActivator: com::sun::star::uno::XInter to be implemented in a lazy fashion (remember the remote content providers, but do not register them right away), which can increase performance in certain situations. But it is not required that an - implementation of <type>XRemoteContentProviderAcceptor</type> uses this + implementation of XRemoteContentProviderAcceptor uses this lazy strategy (and thus also implements this interface). @return diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index 79e90ea33458..16ef09f2c0a6 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { module com { module sun { module star { module ucb { -/** Notify about changes to a <type>XRemoteContentProviderSupplier</type>. +/** Notify about changes to a XRemoteContentProviderSupplier. @version 1.0 @author Stephan Bergmann diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl index ea0066693c83..eff305662462 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** Distribute a content broker to various - <type>XRemoteContentProviderAcceptor</type>s. + XRemoteContentProviderAcceptors. @version 1.0 @author Stephan Bergmann @@ -44,10 +44,10 @@ published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInt which is responsible for raising any of the advertised exceptions. </p> @param Url A Uno Url to address the - <type>XRemoteContentProviderAcceptor</type>. + XRemoteContentProviderAcceptor. @param Identifier An identifier handed to the - <type>XRemoteContentProviderAcceptor</type>. + XRemoteContentProviderAcceptor. @returns success indicator. Especially, if there's already a connection to the given Url, the call will fail, no matter whether @@ -63,7 +63,7 @@ published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInt content provider acceptor. @param Url A Uno Url to address the - <type>XRemoteContentProviderAcceptor</type>. + XRemoteContentProviderAcceptor. @returns success indicator. */ diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl index ee37340d80f2..9df980515a6d 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderDoneListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { published interface XRemoteContentProviderAcceptor; /** A notification mechanism that a - <type>XRemoteContentProviderAcceptor</type> no longer needs a remote + XRemoteContentProviderAcceptor no longer needs a remote content provider. @version 1.0 @@ -36,7 +36,7 @@ module com { module sun { module star { module ucb { published interface XRemoteContentProviderDoneListener: com::sun::star::uno::XInterface { /** A notification that all remote content providers added to the given - <type>XRemoteContentProviderAcceptor</type> should be removed, + XRemoteContentProviderAcceptor should be removed, because the acceptor no longer needs them. @param Acceptor diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl index 16870ef11d6b..378bad360aa5 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderSupplier.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module ucb { published interface XRemoteContentProviderSupplier: com::sun::star::uno::XInterface { /** Get a factory through which a remote content provider's - <type>UniversalContentBroker</type> service can be instantiated. + UniversalContentBroker service can be instantiated. @param Identifier An arbitrary identifier uniquely identifying a remote content provider. diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index 39aeb2711abc..d343f7f70416 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -190,7 +190,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface An XOutputStream, if the file can be opened for writing @throws - <type>UnsupportedDataSinkException</type>, if the file cannot be + UnsupportedDataSinkException, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources <member>XSimpleFileAccess2::writeFile</member> may be used. @@ -207,7 +207,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface An XStream, if the file can be opened for reading and writing @throws - <type>UnsupportedDataSinkException</type>, if the file cannot be + UnsupportedDataSinkException, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources <member>XSimpleFileAccess2::writeFile</member> may be used. diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl index fa025b721f13..71de89dd2963 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** This is an extension to the interface <type>XSimpleFileAccess</type>. +/** This is an extension to the interface XSimpleFileAccess. */ published interface XSimpleFileAccess2 : com::sun::star::ucb::XSimpleFileAccess { diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl index cd3cc7b6b3ef..99c27688a4b1 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess3.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module ucb { -/** This is an extension to the interface <type>XSimpleFileAccess2</type>. +/** This is an extension to the interface XSimpleFileAccess2. @since OOo 1.1.2 */ diff --git a/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl index 8cef589e9365..7ec634e896ce 100644 --- a/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl @@ -27,13 +27,13 @@ module com { module sun { module star { module ucb { -/** Provides a method to create an <type>XDynamicResultSet</type> which +/** Provides a method to create an XDynamicResultSet which will be sorted according to the given sorting options. */ published interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface { - /** creates a sorted <type>XDynamicResultSet</type> depending on internal + /** creates a sorted XDynamicResultSet depending on internal data, an (unsorted) XDynamicResultSet and the sorting info. @returns diff --git a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl index 29d364692134..20a38f589097 100644 --- a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl @@ -66,7 +66,7 @@ published interface XUniversalContentBroker */ interface com::sun::star::ucb::XContentProviderManager; - /** creates <type>XContentIdentifier</type> implementation objects for + /** creates XContentIdentifier implementation objects for all kind of contents provided by the UCB. <p>This interface is required. @@ -75,7 +75,7 @@ published interface XUniversalContentBroker /** Enables the caller to execute commands at the broker. - Is an enhanced version of <type>XCommandProcessor</type> that has an + Is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via <member>XCommandProcessor::createCommandIdentifier</member> to avoid resource leaks. For a detailed description of the problem refer to @@ -100,7 +100,7 @@ published interface XUniversalContentBroker // This command obtains an interface which allows to query // information on commands supported by the Content Broker. - <type>XCommandInfo</type> + XCommandInfo getCommandInfo void @@ -109,12 +109,12 @@ published interface XUniversalContentBroker // The implementation must be able to handle Contents provided // by any Content Provider. This is different from the command // "transfer" that can be supported by a Content. That command - // typically can only handle <type>Content</type>s provided by one - // <type>ContentProvider</type>. + // typically can only handle Contents provided by one + // ContentProvider. void globalTransfer - <type>GlobalTransferCommandArgument</type> + GlobalTransferCommandArgument </pre> */ diff --git a/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl b/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl index 25ed63146a04..2547aab74216 100644 --- a/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl +++ b/offapi/com/sun/star/ucb/XWebDAVCommandEnvironment.idl @@ -29,8 +29,8 @@ module com { module sun { module star { module ucb { commands. <p>Supply an implementation of this interface together with an - <type>XCommandEnvironment</type> implementation, when executing a command - using <type>XCommandProcessor</type>. + XCommandEnvironment implementation, when executing a command + using XCommandProcessor. */ interface XWebDAVCommandEnvironment : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/ui/ActionTriggerContainer.idl b/offapi/com/sun/star/ui/ActionTriggerContainer.idl index c4c97468d23c..6bb0f7df4840 100644 --- a/offapi/com/sun/star/ui/ActionTriggerContainer.idl +++ b/offapi/com/sun/star/ui/ActionTriggerContainer.idl @@ -33,16 +33,16 @@ module com { module sun { module star { module ui { You could have a menu or a toolbox working with the same container describing their entries.</p> - <p>Possible elements of the <type>ActionTriggerContainer</type> are + <p>Possible elements of the ActionTriggerContainer are <ul> - <li><type>ActionTrigger</type> - + <li>ActionTrigger - represents a simply clickable menu entry</li> - <li><type>ActionTriggerSeparator</type> - + <li>ActionTriggerSeparator - represents a separator between two entries<br/> This entry type is of interest for components rendering a an - <type>ActionTriggerContainer</type> + ActionTriggerContainer </li> - <li><type>ActionTriggerContainer</type> - + <li>ActionTriggerContainer - represents a sub container</li> </ul> </p> @@ -60,9 +60,9 @@ published service ActionTriggerContainer /** creates elements to be inserted into the container. <p>Usually, the <method>XMultiServiceFactory::getSupportedServiceNames</method> - gives you a <type>ActionTrigger</type> and - optionally <type>ActionTriggerContainer</type> and - <type>ActionTriggerSeparator</type> + gives you a ActionTrigger and + optionally ActionTriggerContainer and + ActionTriggerSeparator .</p> */ diff --git a/offapi/com/sun/star/ui/ActionTriggerSeparator.idl b/offapi/com/sun/star/ui/ActionTriggerSeparator.idl index 6f296472e1af..2d4c2f7ced97 100644 --- a/offapi/com/sun/star/ui/ActionTriggerSeparator.idl +++ b/offapi/com/sun/star/ui/ActionTriggerSeparator.idl @@ -23,12 +23,12 @@ module com { module sun { module star { module ui { /** describes a separator entry. Such entries are of interest - for components rendering an <type>ActionTriggerContainer</type>. + for components rendering an ActionTriggerContainer. */ published service ActionTriggerSeparator { /** determines the type of the separator using constants from - <type>ActionTriggerSeparatorType</type>. + ActionTriggerSeparatorType. */ [optional, property] short SeparatorType; }; diff --git a/offapi/com/sun/star/ui/ContextMenuInterceptorAction.idl b/offapi/com/sun/star/ui/ContextMenuInterceptorAction.idl index 17151e48bd6a..82fcbe82b25c 100644 --- a/offapi/com/sun/star/ui/ContextMenuInterceptorAction.idl +++ b/offapi/com/sun/star/ui/ContextMenuInterceptorAction.idl @@ -22,25 +22,25 @@ module com { module sun { module star { module ui { -/** determines the action that is requested from the <type>XContextMenuInterceptor</type>. +/** determines the action that is requested from the XContextMenuInterceptor. */ published enum ContextMenuInterceptorAction { - /** the <type>XContextMenuInterceptor</type> has ignored the call. The next registered - <type>XContextMenuInterceptor</type> should be notified. + /** the XContextMenuInterceptor has ignored the call. The next registered + XContextMenuInterceptor should be notified. */ IGNORED, /** the context menu must not be executed. The next registered - <type>XContextMenuInterceptor</type> should not be notified. + XContextMenuInterceptor should not be notified. */ CANCELLED, /** the menu has been modified and should be executed without notifying the next registered - <type>XContextMenuInterceptor</type>. + XContextMenuInterceptor. */ EXECUTE_MODIFIED, /** - the menu has been modified and the next registered <type>XContextMenuInterceptor</type> + the menu has been modified and the next registered XContextMenuInterceptor should be notified. */ CONTINUE_MODIFIED diff --git a/offapi/com/sun/star/ui/ItemDescriptor.idl b/offapi/com/sun/star/ui/ItemDescriptor.idl index d15c041bb019..a0c492adaf9e 100644 --- a/offapi/com/sun/star/ui/ItemDescriptor.idl +++ b/offapi/com/sun/star/ui/ItemDescriptor.idl @@ -43,7 +43,7 @@ module com { module sun { module star { module ui { service ItemDescriptor { /** specifies which type this item descriptor belongs to.<p>See constant definition - <type>ItemType</type>.</p> + ItemType.</p> */ [property] short Type; @@ -61,7 +61,7 @@ service ItemDescriptor /** different styles which influence the appearance of the item and its behavior. <p>This property is only valid if the item describes a toolbar or statusbar - item. See <type>ItemStyle</type> for more information about possible styles.</p> + item. See ItemStyle for more information about possible styles.</p> */ [optional, property] short Style; diff --git a/offapi/com/sun/star/ui/UIElementFactory.idl b/offapi/com/sun/star/ui/UIElementFactory.idl index e14156b61dfd..1ffcf6afe974 100644 --- a/offapi/com/sun/star/ui/UIElementFactory.idl +++ b/offapi/com/sun/star/ui/UIElementFactory.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module ui { It depends on the implementation which user interface element types can be created. It is also possible that a factory is only able to create one special user interface element. User interface element factories must be - registered at the single instance <type>UIElementFactoryManager</type> + registered at the single instance UIElementFactoryManager service to provide access to itself. </p> diff --git a/offapi/com/sun/star/ui/XContextMenuInterception.idl b/offapi/com/sun/star/ui/XContextMenuInterception.idl index 6123ee70bddd..8b5a1afef2c7 100644 --- a/offapi/com/sun/star/ui/XContextMenuInterception.idl +++ b/offapi/com/sun/star/ui/XContextMenuInterception.idl @@ -30,12 +30,12 @@ module com { module sun { module star { module ui { */ published interface XContextMenuInterception : ::com::sun::star::uno::XInterface { - /** registers an <type>XContextMenuInterceptor</type>, which will become + /** registers an XContextMenuInterceptor, which will become the first interceptor in the chain of registered interceptors. */ void registerContextMenuInterceptor( [in]XContextMenuInterceptor Interceptor); - /** removes an <type>XContextMenuInterceptor</type> which was previously registered + /** removes an XContextMenuInterceptor which was previously registered using <member>XContextMenuInterception::registerContextMenuInterceptor</member>. <p>The order of removals is arbitrary. It is not necessary to remove the last diff --git a/offapi/com/sun/star/ui/XImageManager.idl b/offapi/com/sun/star/ui/XImageManager.idl index 7487f6bcf367..34faf06daecf 100644 --- a/offapi/com/sun/star/ui/XImageManager.idl +++ b/offapi/com/sun/star/ui/XImageManager.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module ui { <p> An image manager controls a number of image sets which are specified - by a <type>ImageType</type>. + by a ImageType. </p> */ diff --git a/offapi/com/sun/star/ui/XUIConfiguration.idl b/offapi/com/sun/star/ui/XUIConfiguration.idl index d390bdedb095..5c96816280de 100644 --- a/offapi/com/sun/star/ui/XUIConfiguration.idl +++ b/offapi/com/sun/star/ui/XUIConfiguration.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ui { interface configuration manager. <p> - The <type>XUIConfiguration</type> interface is provided for user + The XUIConfiguration interface is provided for user interface configuration managers which need to broadcast changes within the container; that means the actions of adding, replacing and removing elements are broadcast to listeners. diff --git a/offapi/com/sun/star/ui/XUIConfigurationManager.idl b/offapi/com/sun/star/ui/XUIConfigurationManager.idl index 6d58c0eab9bd..1749eed89b42 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationManager.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationManager.idl @@ -88,7 +88,7 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface @return an empty user interface element settings data container, which - implements <type>UIElementSettings</type>. + implements UIElementSettings. */ ::com::sun::star::container::XIndexContainer createSettings(); @@ -121,7 +121,7 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface @return settings data of an existing user interface element, which - implements <type>UIElementSettings</type>. If the settings data + implements UIElementSettings. If the settings data cannot be found a <type scope="com::sun::star::container">NoSuchElementException</type> is thrown. If the <member>ResourceURL</member> is not valid or @@ -141,7 +141,7 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface @param aNewData the new settings data of an existing user interface element, which - implements <type>UIElementSettings</type>. + implements UIElementSettings. <p> If the settings data cannot be found a @@ -180,7 +180,7 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface @param aNewData the settings data of the new user interface element, which implements - <type>UIElementSettings</type>. + UIElementSettings. <p> If the settings data is already present a diff --git a/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl b/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl index fa819c13b210..9ffc59a093f6 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl @@ -38,7 +38,7 @@ interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface <p> It is up to the implementation if it defers the first loading process - until the first data request using <type>XUIConfigurationManager</type> + until the first data request using XUIConfigurationManager interface. </p> */ diff --git a/offapi/com/sun/star/ui/XUIElementFactory.idl b/offapi/com/sun/star/ui/XUIElementFactory.idl index f17f4363fb40..bef986896e1a 100644 --- a/offapi/com/sun/star/ui/XUIElementFactory.idl +++ b/offapi/com/sun/star/ui/XUIElementFactory.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module ui { <p> User interface element factories must be registered at a - <type>UIElementFactoryManager</type> service to provide access to itself. + UIElementFactoryManager service to provide access to itself. Currently the following user interface element types are defined: <ul> diff --git a/offapi/com/sun/star/ui/XUIElementSettings.idl b/offapi/com/sun/star/ui/XUIElementSettings.idl index 96bfed6ef5b4..1f7c6f24b67a 100644 --- a/offapi/com/sun/star/ui/XUIElementSettings.idl +++ b/offapi/com/sun/star/ui/XUIElementSettings.idl @@ -47,7 +47,7 @@ interface XUIElementSettings : com::sun::star::uno::XInterface */ void updateSettings(); - /** provides a <type>UIElementSettings</type> instance that provides access + /** provides a UIElementSettings instance that provides access to the structure of user interface element if the user interface element type supports it. diff --git a/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl b/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl index e77b5c0b8a06..5b25fabbef33 100644 --- a/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl +++ b/offapi/com/sun/star/ui/dialogs/DialogClosedEvent.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ui { module dialogs { <p>The broadcaster who sends such event, must send the dialog as the source.</p> - @see <type>com::sun::star::lang::EventObject</type> + @see com::sun::star::lang::EventObject */ struct DialogClosedEvent: com::sun::star::lang::EventObject { @@ -38,7 +38,7 @@ struct DialogClosedEvent: com::sun::star::lang::EventObject @param DialogResult Identifies the result of a dialog. - @see <type>ExecutableDialogResults</type> + @see ExecutableDialogResults */ short DialogResult; }; diff --git a/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl b/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl index 5554714330a4..5e39783c833e 100644 --- a/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl +++ b/offapi/com/sun/star/ui/dialogs/ExecutableDialogResults.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module ui { module dialogs { -/** These constants are used to specify a result of executing a <type>XExecutableDialog</type>. +/** These constants are used to specify a result of executing a XExecutableDialog. */ published constants ExecutableDialogResults diff --git a/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl b/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl index e15aeb04244a..dba798e7b8b6 100644 --- a/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl +++ b/offapi/com/sun/star/ui/dialogs/ListboxControlActions.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ui { module dialogs { /** These constants are deprecated and should not be used anymore. They're superseded - by <type>ControlActions</type>. + by ControlActions. @deprecated */ diff --git a/offapi/com/sun/star/ui/dialogs/WizardButton.idl b/offapi/com/sun/star/ui/dialogs/WizardButton.idl index 7c1d409ab557..65fd83463a7f 100644 --- a/offapi/com/sun/star/ui/dialogs/WizardButton.idl +++ b/offapi/com/sun/star/ui/dialogs/WizardButton.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ui { module dialogs { -/** denotes the buttons found in a <type>Wizard</type> +/** denotes the buttons found in a Wizard */ constants WizardButton { diff --git a/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl b/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl index c18c4701d522..1b91a045d9c3 100644 --- a/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl +++ b/offapi/com/sun/star/ui/dialogs/WizardTravelType.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ui { module dialogs { -/** denotes ways to leave a <type>Wizard</type>'s page +/** denotes ways to leave a Wizard's page */ constants WizardTravelType { diff --git a/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl b/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl index 399a158a8b84..75f3eb44cf34 100644 --- a/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl +++ b/offapi/com/sun/star/ui/dialogs/XDialogClosedListener.idl @@ -28,10 +28,10 @@ module com { module sun { module star { module ui { module dialogs { /** Used to notify listeners about dialog-closed events. <p>Registered listeners will be notified with a - <type>DialogClosedEvent</type> when a <type>XAsynchronousExecutableDialog</type> is closed.</p> + DialogClosedEvent when a XAsynchronousExecutableDialog is closed.</p> - @see <type>XAsynchronousExecutableDialog</type> - @see <type>DialogClosedEvent</type> + @see XAsynchronousExecutableDialog + @see DialogClosedEvent */ @@ -40,9 +40,9 @@ interface XDialogClosedListener: com::sun::star::lang::XEventListener /** A client receives this event if a dialog is closed. @param aEvent - of type <type>DialogClosedEvent</type> that describes the event + of type DialogClosedEvent that describes the event - @see <type>EndDialogEvent</type> + @see EndDialogEvent */ void dialogClosed( [in] DialogClosedEvent aEvent ); }; diff --git a/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl b/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl index 01ccb60bdae2..610a0859d149 100644 --- a/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl +++ b/offapi/com/sun/star/ui/dialogs/XExecutableDialog.idl @@ -44,7 +44,7 @@ published interface XExecutableDialog: com::sun::star::uno::XInterface /** Executes (shows) the dialog. @returns - A status code of type <type>ExecutableDialogResults</type>. + A status code of type ExecutableDialogResults. */ short execute(); }; diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl index bf46ef44aa77..ab27f579bc78 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -43,7 +43,7 @@ published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFile @param aControlAction Specifies an action to perform with the given value. - aControlAction has to be one of the values defined in <type>ControlActions</type>. + aControlAction has to be one of the values defined in ControlActions. Not all of the values are valid for all controls. To add a new filter to the FilePicker use the interface XFilterManager, but optionally an implementation may also support adding new filter using this @@ -66,7 +66,7 @@ void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue @param aControlAction Specifies which value to retrieve. - aControlAction has to be one of the values defined in <type>ControlActions</type>. + aControlAction has to be one of the values defined in ControlActions. Not all of the values are valid for all controls. @returns diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl index 851fd602098b..21d82c810379 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerListener.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ui { module dialogs { /** Interface to be implemented by a FilePicker listener. - <p> The <type>XFilePickerListener</type> interface must be implemented by + <p> The XFilePickerListener interface must be implemented by the clients of the FilePicker service which need to be informed about events while the FilePicker service is displayed.</p> */ @@ -40,7 +40,7 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener FilePicker service dialog changes. @param aEvent - of type <type>FilePickerEvent</type> that describes the event + of type FilePickerEvent that describes the event @see com::sun::star::ui::dialogs::FilePickerEvent */ @@ -51,7 +51,7 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener FilePicker dialog changes. @param aEvent - Of type <type>FilePickerEvent</type> that describes the event. + Of type FilePickerEvent that describes the event. @see com::sun::star::ui::dialogs::FilePickerEvent */ @@ -61,7 +61,7 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener pressed. @param aEvent - of type <type>FilePickerEvent</type> that describes the event + of type FilePickerEvent that describes the event @returns A help string which the FilePicker dialog should use to display @@ -78,7 +78,7 @@ published interface XFilePickerListener: com::sun::star::lang::XEventListener FilePicker service dialog changes. @param aEvent - of type <type>FilePickerEvent</type> that describes the event. + of type FilePickerEvent that describes the event. @see com::sun::star::ui::dialogs::FilePickerEvent */ diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl index 2a12e08f011e..9c20dc932dad 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerNotifier.idl @@ -34,8 +34,8 @@ published interface XFilePickerNotifier: com::sun::star::uno::XInterface /** Interface for clients to register as XFilePickerListener @param xListener - The <type>XFilePickerListener</type> interface of the listener that - wants to receive events of type <type>FilePickerEvent</type>. + The XFilePickerListener interface of the listener that + wants to receive events of type FilePickerEvent. <p>Invalid interfaces or NULL values will be ignored.</p> */ void addFilePickerListener( [in] XFilePickerListener xListener ); @@ -43,8 +43,8 @@ published interface XFilePickerNotifier: com::sun::star::uno::XInterface /** Interface for clients to unregister as XFilePickerListener. @param xListener - The <type>XFilePickerListener</type> interface of the listener that - wants to receive events of type <type>FilePickerEvent</type>. + The XFilePickerListener interface of the listener that + wants to receive events of type FilePickerEvent. <p>Invalid interfaces or NULL values will be ignored.</p> */ void removeFilePickerListener( [in] XFilePickerListener xListener ); diff --git a/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl b/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl index 969c3952df89..e157b03d0c8a 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilterGroupManager.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ui { module dialogs { /** Specifies an interface which allows manipulation of groups of filters - for the <type>FilePicker</type> service. + for the FilePicker service. */ published interface XFilterGroupManager : com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl index dadefcccac9c..6004702a8e1f 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizard.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module ui { module dialogs { interface XWizardPage; -/** is the main interface implemented by the <type>Wizard</type> services. +/** is the main interface implemented by the Wizard services. <p>A wizard is a dialog which guides the user through a number of tasks (usually input of data), which the user can accomplish either sequentially or out-of-order. For this, a wizard is comprised of a number of tab pages, @@ -54,7 +54,7 @@ interface XWizardPage; are not finally decided. In such a case, the roadmap will display future steps up to the point where the potential paths diverge, and then an item <quot><code>...</code></quot> indicating that the order of steps is undecided.</p> - <p>An <type>XWizardController</type> can declare a certain path as active path by calling the <member>activatePath</member> + <p>An XWizardController can declare a certain path as active path by calling the <member>activatePath</member> method. Usually, this is done depending on user input. For instance, your wizard could have radio buttons on the first page which effectively decide about which path to take in the wizard.</p> @@ -93,7 +93,7 @@ interface XWizard buttons are unlikely to ever being disabled.</p> @param WizardButton - denotes the button to enable or disable, as one of the <type>WizardButton</type> constants. Must not be + denotes the button to enable or disable, as one of the WizardButton constants. Must not be <member>WizardButton::NONE</member>. @param Enable specifies whether the button should be enabled (<TRUE/>) or disabled (<FALSE/>) diff --git a/offapi/com/sun/star/ui/dialogs/XWizardController.idl b/offapi/com/sun/star/ui/dialogs/XWizardController.idl index 75b33e5081ca..c25f8e6c8f12 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizardController.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizardController.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ui { module dialogs { -/** is the interface of a client-provided controller of a custom <type>Wizard</type>. +/** is the interface of a client-provided controller of a custom Wizard. */ interface XWizardController { diff --git a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl index 86730a18fc0a..32cdf6196242 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ui { module dialogs { -/** is a single page of a <type>Wizard</type> +/** is a single page of a Wizard */ interface XWizardPage : ::com::sun::star::lang::XComponent { @@ -50,7 +50,7 @@ interface XWizardPage : ::com::sun::star::lang::XComponent depends on the current state of the page.</p> @param Reason - is one of the <type>WizardTravelType</type> constants denoting the reason why the page should be + is one of the WizardTravelType constants denoting the reason why the page should be committed. */ boolean commitPage( [in] short Reason ); 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. diff --git a/offapi/com/sun/star/view/PrintJobEvent.idl b/offapi/com/sun/star/view/PrintJobEvent.idl index f4d012cbde84..20f5373180cb 100644 --- a/offapi/com/sun/star/view/PrintJobEvent.idl +++ b/offapi/com/sun/star/view/PrintJobEvent.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module view { -/** specifies the print progress of an <type>XPrintJob</type>. +/** specifies the print progress of an XPrintJob. <p><member scope="com::sun::star::lang">EventObject::Source</member> - contains the <type>XPrintJob</type> having changed its state</p>. + contains the XPrintJob having changed its state</p>. @since OOo 1.1.2 diff --git a/offapi/com/sun/star/view/PrintOptions.idl b/offapi/com/sun/star/view/PrintOptions.idl index 95702132c11a..b74a6a544472 100644 --- a/offapi/com/sun/star/view/PrintOptions.idl +++ b/offapi/com/sun/star/view/PrintOptions.idl @@ -57,7 +57,7 @@ published service PrintOptions */ [property] string Pages; - /** if set to TRUE, the corresponding <type>XPrintable</type>.print() request will + /** if set to TRUE, the corresponding XPrintable.print() request will be executed synchronous. <p>Default is the asynchronous print mode.</p> @@ -69,7 +69,7 @@ published service PrintOptions /** determines the duplex mode for the print job. - @see <type>DuplexMode</type> for more information about supported values + @see DuplexMode for more information about supported values */ [optional, property] short DuplexMode; }; diff --git a/offapi/com/sun/star/view/PrintableState.idl b/offapi/com/sun/star/view/PrintableState.idl index f428a5b3b6d7..b687d8174805 100644 --- a/offapi/com/sun/star/view/PrintableState.idl +++ b/offapi/com/sun/star/view/PrintableState.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module view { -/** specifies the print progress of an <type>XPrintable</type>. +/** specifies the print progress of an XPrintable. <p>Printing consists of two abstract phases: rendering the document for the printer and then sending it to the printer (spooling). - <type>PrintableState</type> describes which phase is currently + PrintableState describes which phase is currently progressing or has failed.</p> @see PrintableStateEvent diff --git a/offapi/com/sun/star/view/PrintableStateEvent.idl b/offapi/com/sun/star/view/PrintableStateEvent.idl index d95dcd9e4e34..1ca7d70b61e8 100644 --- a/offapi/com/sun/star/view/PrintableStateEvent.idl +++ b/offapi/com/sun/star/view/PrintableStateEvent.idl @@ -26,10 +26,10 @@ module com { module sun { module star { module view { -/** specifies the print progress of an <type>XPrintable</type>. +/** specifies the print progress of an XPrintable. <p><member scope="com::sun::star::lang">EventObject::Source</member> - contains the <type>XPrintable</type> having changed its state</p>. + contains the XPrintable having changed its state</p>. */ published struct PrintableStateEvent : com::sun::star::lang::EventObject diff --git a/offapi/com/sun/star/view/XMultiSelectionSupplier.idl b/offapi/com/sun/star/view/XMultiSelectionSupplier.idl index 6622eec1615d..e1d09bb695a9 100644 --- a/offapi/com/sun/star/view/XMultiSelectionSupplier.idl +++ b/offapi/com/sun/star/view/XMultiSelectionSupplier.idl @@ -40,7 +40,7 @@ interface XMultiSelectionSupplier: XSelectionSupplier { /** adds the object or the objects represented by <var>Selection</var> to the selection - of this <type>XMultiSelectionSupplier</type>. + of this XMultiSelectionSupplier. @param Selection either an Object that is selectable or a sequence of objects that are selectable. @@ -52,7 +52,7 @@ interface XMultiSelectionSupplier: XSelectionSupplier objects that are forbidden to be selected together with <var>Selection</var> @throws com::sun::star::lang::IllegalArgumentException - If <var>Selection</var> is not a selectable object for this <type>XMultiSelectionSupplier</type>. + If <var>Selection</var> is not a selectable object for this XMultiSelectionSupplier. <p>Adding an object to the selection that is already part of the selection should not raise this exception</p> */ boolean addSelection( [in] any Selection ) @@ -60,7 +60,7 @@ interface XMultiSelectionSupplier: XSelectionSupplier /** remove the object or objects represented by <var>Selection</var> from the - selection of this <type>XMultiSelectionSupplier</type>. + selection of this XMultiSelectionSupplier. @param Selection either an Object that is selectable or a sequence of objects that are selectable. @@ -72,32 +72,32 @@ interface XMultiSelectionSupplier: XSelectionSupplier objects that are forbidden to be selected together with <var>Selection</var>. @throws com::sun::star::lang::IllegalArgumentException - If <var>Selection</var> is not a selectable object for this <type>XMultiSelectionSupplier</type>. + If <var>Selection</var> is not a selectable object for this XMultiSelectionSupplier. <p>Removing an object from the selection that is not part of the selection should not raise this exception</p> */ void removeSelection( [in] any Selection ) raises( com::sun::star::lang::IllegalArgumentException ); - /** clears the selection of this <type>XMultiSelectionSupplier</type>. + /** clears the selection of this XMultiSelectionSupplier. */ void clearSelection(); - /** returns the number of selected objects of this <type>XMultiSelectionSupplier</type>. + /** returns the number of selected objects of this XMultiSelectionSupplier. */ long getSelectionCount(); /** @returns - a new object to enumerate the selection of this <type>XMultiSelectionSupplier</type>. + a new object to enumerate the selection of this XMultiSelectionSupplier. It returns NULL if there are no objects in the selection. */ com::sun::star::container::XEnumeration createSelectionEnumeration(); /** @returns - a new object to enumerate the selection of this <type>XMultiSelectionSupplier</type> + a new object to enumerate the selection of this XMultiSelectionSupplier in reverse order. If the order of the selected objects It returns NULL if there are no objects in the selection. */ diff --git a/offapi/com/sun/star/view/XPrintJob.idl b/offapi/com/sun/star/view/XPrintJob.idl index 337127a27ee7..d01bab00741d 100644 --- a/offapi/com/sun/star/view/XPrintJob.idl +++ b/offapi/com/sun/star/view/XPrintJob.idl @@ -29,8 +29,8 @@ module com { module sun { module star { module view { /** allows for getting information about a print job. - <p><type>XPrintJob</type> is implemented by print jobs that are created by - classes that implement <type>XPrintable</type>. It gives information about + <p>XPrintJob is implemented by print jobs that are created by + classes that implement XPrintable. It gives information about the context of the print job.</p> @see XPrintJobListener diff --git a/offapi/com/sun/star/view/XPrintJobBroadcaster.idl b/offapi/com/sun/star/view/XPrintJobBroadcaster.idl index b8c31e0085d6..dec3733f9409 100644 --- a/offapi/com/sun/star/view/XPrintJobBroadcaster.idl +++ b/offapi/com/sun/star/view/XPrintJobBroadcaster.idl @@ -27,8 +27,8 @@ module com { module sun { module star { module view { /** allows for getting information about a print job. - <p><type>XPrintJobBroadcaster</type> can be implemented by classes which - implement <type>XPrintable</type>. It allows a <type>XPrintJobListener</type> + <p>XPrintJobBroadcaster can be implemented by classes which + implement XPrintable. It allows a XPrintJobListener to be registered, thus a client object will learn about the print progress.</p> @see XPrintJobListener @@ -37,11 +37,11 @@ module com { module sun { module star { module view { */ published interface XPrintJobBroadcaster : com::sun::star::uno::XInterface { - /** adds an <type>XPrintJobListener</type> to be notified about print progress. + /** adds an XPrintJobListener to be notified about print progress. */ void addPrintJobListener( [in] XPrintJobListener xListener ); - /** removes an <type>XPrintJobListener</type>. + /** removes an XPrintJobListener. */ void removePrintJobListener( [in] XPrintJobListener xListener ); }; diff --git a/offapi/com/sun/star/view/XPrintJobListener.idl b/offapi/com/sun/star/view/XPrintJobListener.idl index 73a031b7bfe1..7c7adfccd80e 100644 --- a/offapi/com/sun/star/view/XPrintJobListener.idl +++ b/offapi/com/sun/star/view/XPrintJobListener.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module view { /** receives events about print job progress. - <p><type>XPrintJobListener</type> can be registered to <type>XPrintJobBroadcaster</type>. + <p>XPrintJobListener can be registered to XPrintJobBroadcaster. Then, the client object will be notified when a new print job starts or its state changes.</p> @see XPrintJobBroadcaster @@ -39,7 +39,7 @@ published interface XPrintJobListener : com::sun::star::lang::XEventListener { /** informs the user about the creation or the progress of a PrintJob @param Event - contains the <type>XPrintJob</type> having changed state and the new state. + contains the XPrintJob having changed state and the new state. */ void printJobEvent( [in] PrintJobEvent Event ); }; diff --git a/offapi/com/sun/star/view/XPrintableBroadcaster.idl b/offapi/com/sun/star/view/XPrintableBroadcaster.idl index bd634eff5e50..e2613f696327 100644 --- a/offapi/com/sun/star/view/XPrintableBroadcaster.idl +++ b/offapi/com/sun/star/view/XPrintableBroadcaster.idl @@ -27,19 +27,19 @@ module com { module sun { module star { module view { /** allows for getting information about a print job. - <p><type>XPrintableBroadcaster</type> can be implemented by classes which - implement <type>XPrintable</type>. It allows a <type>XPrintableListener</type> + <p>XPrintableBroadcaster can be implemented by classes which + implement XPrintable. It allows a XPrintableListener to be registered, thus a client object will learn about the print progress.</p> @see XPrintableListener */ published interface XPrintableBroadcaster : com::sun::star::uno::XInterface { - /** adds an <type>XPrintableListener</type> to be notified about print progress. + /** adds an XPrintableListener to be notified about print progress. */ void addPrintableListener( [in] XPrintableListener xListener ); - /** removes an <type>XPrintableListener</type>. + /** removes an XPrintableListener. */ void removePrintableListener( [in] XPrintableListener xListener ); }; diff --git a/offapi/com/sun/star/view/XPrintableListener.idl b/offapi/com/sun/star/view/XPrintableListener.idl index 3c03eb525ccf..89c1789144e7 100644 --- a/offapi/com/sun/star/view/XPrintableListener.idl +++ b/offapi/com/sun/star/view/XPrintableListener.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module view { /** receives events about print job progress. - <p><type>XPrintableListener</type> can be registered to <type>XPrintableBroadcaster</type>. + <p>XPrintableListener can be registered to XPrintableBroadcaster. Then, the client object will receive events about print progress. </p> @see XPrintableBroadcaster @@ -39,7 +39,7 @@ published interface XPrintableListener : com::sun::star::lang::XEventListener /** informs the user of the new state in print progress. @param Event - contains the <type>XPrintable</type> having changed state and the new state. + contains the XPrintable having changed state and the new state. */ void stateChanged( [in] PrintableStateEvent Event ); }; diff --git a/offapi/com/sun/star/view/XSelectionChangeListener.idl b/offapi/com/sun/star/view/XSelectionChangeListener.idl index d1da7e5c5c7c..f2860bbeb855 100644 --- a/offapi/com/sun/star/view/XSelectionChangeListener.idl +++ b/offapi/com/sun/star/view/XSelectionChangeListener.idl @@ -37,7 +37,7 @@ published interface XSelectionChangeListener: com::sun::star::lang::XEventListen /** is called when the selection changes. - <p>You can get the new selection via <type>XSelectionSupplier</type> from + <p>You can get the new selection via XSelectionSupplier from <member scope="com::sun::star::lang">EventObject::Source</member>. */ diff --git a/offapi/com/sun/star/view/XViewSettingsSupplier.idl b/offapi/com/sun/star/view/XViewSettingsSupplier.idl index 79f21e53497a..f00c382072db 100644 --- a/offapi/com/sun/star/view/XViewSettingsSupplier.idl +++ b/offapi/com/sun/star/view/XViewSettingsSupplier.idl @@ -34,7 +34,7 @@ published interface XViewSettingsSupplier: com::sun::star::uno::XInterface { /** @returns - an interface to the <type>ViewSettings</type>. + an interface to the ViewSettings. <p>Subclasses might be returned instead, offering more settings. </p> */ diff --git a/offapi/com/sun/star/xforms/Binding.idl b/offapi/com/sun/star/xforms/Binding.idl index 8f2df2cab0a7..cb053a262deb 100644 --- a/offapi/com/sun/star/xforms/Binding.idl +++ b/offapi/com/sun/star/xforms/Binding.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xforms { interface XSubmission; -/** represent a binding to one or more nodes in the DOM tree of an <type>XModel</type>. +/** represent a binding to one or more nodes in the DOM tree of an XModel. */ service Binding { diff --git a/offapi/com/sun/star/xforms/XSubmission.idl b/offapi/com/sun/star/xforms/XSubmission.idl index d51d2c2c40ea..31f007a7aee4 100644 --- a/offapi/com/sun/star/xforms/XSubmission.idl +++ b/offapi/com/sun/star/xforms/XSubmission.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module xforms { -/** specifies a submission object, associated with an <type>XModel</type> +/** specifies a submission object, associated with an XModel */ interface XSubmission { diff --git a/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl b/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl index da542eded283..27978f358454 100644 --- a/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl +++ b/offapi/com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xml { */ published service ParaUserDefinedAttributesSupplier { - /** This container holds the <type>AttributeData</type> elements + /** This container holds the AttributeData elements that represent uninterpreted XML attributes of a paragraph. <p>The idea behind this property is that a parser can stow @@ -41,7 +41,7 @@ published service ParaUserDefinedAttributesSupplier <p>The <type scope="com::sun::star::container">XNameContainer</type> - supports the service <type>AttributeContainer</type>.</p> + supports the service AttributeContainer.</p> */ [property] ::com::sun::star::container::XNameContainer ParaUserDefinedAttributes; diff --git a/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl b/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl index 8d595f79c9ab..2e4ed958b7f0 100644 --- a/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl +++ b/offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xml { */ published service TextUserDefinedAttributesSupplier { - /** This container holds the <type>AttributeData</type> elements + /** This container holds the AttributeData elements that represent uninterpreted XML attributes of a text. <p>The idea behind this property is that a parser can stow @@ -41,7 +41,7 @@ published service TextUserDefinedAttributesSupplier <p>The <type scope="com::sun::star::container">XNameContainer</type> - supports the service <type>AttributeContainer</type>.</p> + supports the service AttributeContainer.</p> */ [property] ::com::sun::star::container::XNameContainer TextUserDefinedAttributes; diff --git a/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl b/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl index 86319c05ec34..ae35cd4b9b8b 100644 --- a/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl +++ b/offapi/com/sun/star/xml/UserDefinedAttributesSupplier.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module xml { */ published service UserDefinedAttributesSupplier { - /** This container holds the <type>AttributeData</type> elements + /** This container holds the AttributeData elements that represent uninterpreted XML attributes. <p>The idea behind this property is that a parser can stow @@ -41,7 +41,7 @@ published service UserDefinedAttributesSupplier <p>The <type scope="com::sun::star::container">XNameContainer</type> - supports the service <type>AttributeContainer</type>.</p> + supports the service AttributeContainer.</p> */ [property] ::com::sun::star::container::XNameContainer UserDefinedAttributes; diff --git a/offapi/com/sun/star/xml/crypto/CipherID.idl b/offapi/com/sun/star/xml/crypto/CipherID.idl index d066ca15d019..9e34c09f6e84 100644 --- a/offapi/com/sun/star/xml/crypto/CipherID.idl +++ b/offapi/com/sun/star/xml/crypto/CipherID.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module xml { module crypto { /** The constant set contains identifiers of supported cipher-creation algorithms. - @see <type>XCipherContextSupplier</type> + @see XCipherContextSupplier @since OOo 3.4 */ constants CipherID diff --git a/offapi/com/sun/star/xml/crypto/DigestID.idl b/offapi/com/sun/star/xml/crypto/DigestID.idl index 83822d88148b..b913ef19ec3b 100644 --- a/offapi/com/sun/star/xml/crypto/DigestID.idl +++ b/offapi/com/sun/star/xml/crypto/DigestID.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module xml { module crypto { /** The constant set contains identifiers of supported digest-creation algorithms. - @see <type>XDigestContextSupplier</type> + @see XDigestContextSupplier @since OOo 3.4 */ constants DigestID diff --git a/offapi/com/sun/star/xml/crypto/XCipherContext.idl b/offapi/com/sun/star/xml/crypto/XCipherContext.idl index 873d3067adc0..bae91c7b139d 100644 --- a/offapi/com/sun/star/xml/crypto/XCipherContext.idl +++ b/offapi/com/sun/star/xml/crypto/XCipherContext.idl @@ -31,7 +31,7 @@ The algorithm as well as encryption data are specified on object creation. </p> - @see <type>XCipherContextSupplier</type> + @see XCipherContextSupplier @since OOo 3.4 */ interface XCipherContext : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl b/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl index 0a13cf87e60d..1fd2d5065c3d 100644 --- a/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl +++ b/offapi/com/sun/star/xml/crypto/XCipherContextSupplier.idl @@ -38,7 +38,7 @@ interface XCipherContextSupplier : com::sun::star::uno::XInterface @param nCipherID the internal ID specifying the algorithm, - should take value from <type>CipherID</type> + should take value from CipherID @param aKey the key that should be used for the encryption diff --git a/offapi/com/sun/star/xml/crypto/XDigestContext.idl b/offapi/com/sun/star/xml/crypto/XDigestContext.idl index aa869cbe02bb..06553a7da8e9 100644 --- a/offapi/com/sun/star/xml/crypto/XDigestContext.idl +++ b/offapi/com/sun/star/xml/crypto/XDigestContext.idl @@ -30,7 +30,7 @@ The algorithm to generate the digest is specified on object creation. </p> - @see <type>XDigestContextSupplier</type> + @see XDigestContextSupplier @since OOo 3.4 */ interface XDigestContext : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl b/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl index 30daeac41ea5..ead3e8ea95a4 100644 --- a/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl +++ b/offapi/com/sun/star/xml/crypto/XDigestContextSupplier.idl @@ -38,7 +38,7 @@ interface XDigestContextSupplier : com::sun::star::uno::XInterface @param nDigestID the internal ID specifying the algorithm, - should take value from <type>DigestID</type> + should take value from DigestID @param aParams optional parameters that could be used to initialize the digest, diff --git a/offapi/com/sun/star/xml/sax/XEntityResolver.idl b/offapi/com/sun/star/xml/sax/XEntityResolver.idl index d78c0fec7ced..ad479dc7cfc8 100644 --- a/offapi/com/sun/star/xml/sax/XEntityResolver.idl +++ b/offapi/com/sun/star/xml/sax/XEntityResolver.idl @@ -39,10 +39,10 @@ published interface XEntityResolver: com::sun::star::uno::XInterface { /** @returns - <type>InputSource</type> for the external entity. + InputSource for the external entity. <p>If <var>aInputStream</var> is a valid reference to an input stream, - the parser uses this <type>InputSource</type>. Otherwise the + the parser uses this InputSource. Otherwise the parser seeks for the entity using its default behavior. */ InputSource resolveEntity( [in] string sPublicId, [in] string sSystemId ); diff --git a/offapi/com/sun/star/xml/sax/XErrorHandler.idl b/offapi/com/sun/star/xml/sax/XErrorHandler.idl index da5a1e9ba495..db26a9e76276 100644 --- a/offapi/com/sun/star/xml/sax/XErrorHandler.idl +++ b/offapi/com/sun/star/xml/sax/XErrorHandler.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module xml { module sax { <p>This interface is a slight adaption of the Java interface <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed as an argument, so an <code>any</code> serves as the container. The type of the - exception is <type>SAXParseException</type> or an instance of a derived class.</p> + exception is SAXParseException or an instance of a derived class.</p> */ published interface XErrorHandler: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl index fe6f0e510277..2529f30b165e 100644 --- a/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl +++ b/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl @@ -57,7 +57,7 @@ published interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumen raises( com::sun::star::xml::sax::SAXException ); /** informs a writer that it is allowable to insert a line break and - indentation before the next <type>XDocumentHandler</type>-call. + indentation before the next XDocumentHandler-call. */ void allowLineBreak() raises( com::sun::star::xml::sax::SAXException ); diff --git a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl index 5821b35eecd7..1437ceaebae1 100644 --- a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl +++ b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl @@ -32,9 +32,9 @@ module com { module sun { module star { module xml { module sax { <br>Attributes are separated into known attributes and unknown attributes. <p>Known attributes have a local name that is known to the <type>XFastTokenHandler</token> - registered at the <type>XFastParser</type> which created the sax event containing + registered at the XFastParser which created the sax event containing this attributes. If an attribute also has a namespace, that must be registered - at the <type>XFastParser</type>, else this attribute is also unknown even if + at the XFastParser, else this attribute is also unknown even if the local name is known. */ interface XFastAttributeList: com::sun::star::uno::XInterface @@ -42,12 +42,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** checks if an attribute is available.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -59,12 +59,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** retrieves the token of an attributes value.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -81,12 +81,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /**retrieves the token of an attributes value.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -104,12 +104,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** retrieves the value of an attributes.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -126,12 +126,12 @@ interface XFastAttributeList: com::sun::star::uno::XInterface /** retrieves the value of an attributes.<br> @param Token - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the attribute name has a namespace that was registered with the - <type>XFastParser</type>, Token contains the integer token of the - attributes local name from the <type>XFastTokenHandler</type> and + XFastParser, Token contains the integer token of the + attributes local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. diff --git a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl index 147811c73161..a9996af32195 100644 --- a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module xml { module sax { /** receives notification of sax document events from a - <type>XFastParser</type>. + XFastParser. @see XFastDocumentHandler */ @@ -43,17 +43,17 @@ interface XFastContextHandler: com::sun::star::uno::XInterface /** receives notification of the beginning of an element . @param Element - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>.<br> + contains the integer token from the XFastTokenHandler + registered at the XFastParser.<br> If the element has a namespace that was registered with the - <type>XFastParser</type>, <param>Element</param> contains the integer - token of the elements local name from the <type>XFastTokenHandler</type> + XFastParser, <param>Element</param> contains the integer + token of the elements local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes from the element. */ @@ -68,7 +68,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface @param Name contains the elements local name. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes from the element. */ void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs ) @@ -92,17 +92,17 @@ interface XFastContextHandler: com::sun::star::uno::XInterface /** receives notification of the beginning of a known child element. @param Element - contains the integer token from the <type>XFastTokenHandler</type> - registered at the <type>XFastParser</type>. + contains the integer token from the XFastTokenHandler + registered at the XFastParser. <br>If the element has a namespace that was registered with the - <type>XFastParser</type>, <param>Element</param> contains the + XFastParser, <param>Element</param> contains the integer token of the elements local name from the - <type>XFastTokenHandler</type> and the integer token of the + XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes from the element. */ XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs ) @@ -116,7 +116,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface @param Name contains the elements local name. @param Attribs - Contains a <type>XFastAttrbitueList</type> to access the attributes + Contains a XFastAttrbitueList to access the attributes the element. */ XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs ) diff --git a/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl b/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl index 973fd3ac0890..61cb668c00c7 100644 --- a/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastDocumentHandler.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module xml { module sax { /** receives notification of sax document events from a - <type>XFastParser</type> + XFastParser */ interface XFastDocumentHandler: XFastContextHandler { diff --git a/offapi/com/sun/star/xml/sax/XFastParser.idl b/offapi/com/sun/star/xml/sax/XFastParser.idl index 2347144e3bcf..e91fa7bd7555 100644 --- a/offapi/com/sun/star/xml/sax/XFastParser.idl +++ b/offapi/com/sun/star/xml/sax/XFastParser.idl @@ -48,10 +48,10 @@ module com { module sun { module star { module xml { module sax { namespaces and allows to have individual contexts for each XML element. <p>Before parsing is possible you have to set your - <type>XFastDocumentHandler</type> using <member>setFastDocumentHandler</member>. + XFastDocumentHandler using <member>setFastDocumentHandler</member>. <p>Parsing starts with calling <member>parseStream</member>. If the parser - finds a valid XML file with the given <type>InputSource</type>, it calls + finds a valid XML file with the given InputSource, it calls <member>XFastDocumentHandler::startDocument</member> first. <p>This parser generates either "fast" events that use integer token @@ -61,13 +61,13 @@ module com { module sun { module star { module xml { module sax { <p>A namespace is unknown if the namespace URL was not registered with <member>registerNamespace</member>. - <p>An element is unknown if no <type>XFastTokenHandler</type> is set - or if the <type>XFastTokenHandler</type> does not return a valid + <p>An element is unknown if no XFastTokenHandler is set + or if the XFastTokenHandler does not return a valid identifier for the elements local name. An element is also unknown if the elements local name is known but it uses a namespace that is unknown. - <p>Setting a <type>XFastTokenHandler</type> with <member>setTokenHandler</member> - is optional, but without a <type>XFastTokenHandler</type> you will only + <p>Setting a XFastTokenHandler with <member>setTokenHandler</member> + is optional, but without a XFastTokenHandler you will only get unknown sax events. This can be useful if you are only interested in the namespace handling and/or the context feature. @@ -76,7 +76,7 @@ module com { module sun { module star { module xml { module sax { <member>XFastContextHandler::createFastChildContext</member> for known elements or <member>XFastContextHandler::createUnknownChildContext</member> for unknown elements. - <br>The parent context for the root element is the <type>XFastDocumentHandler</type> + <br>The parent context for the root element is the XFastDocumentHandler itself. <p>If the parent context returns an empty reference, no further events for @@ -90,12 +90,12 @@ module com { module sun { module star { module xml { module sax { <member>XFastContextHandler::endFastElement</member> for known elements or <member>XFastContextHandler::endUnknownElement</member> for unknown elements. - <p>It is valid to return one instance of <type>XFastContextHandler</type> more - than once. It is even possible to only use the <type>XFastDocumentHandler</type> + <p>It is valid to return one instance of XFastContextHandler more + than once. It is even possible to only use the XFastDocumentHandler by always returning a reference to itself for each create child context event. <p>After the last element is processed the parser generates an end document - event at the <type>XFastDocumentHandler</type> by calling + event at the XFastDocumentHandler by calling <member>XFastDocumentHandler::endDocument</member>. @see http://wiki.services.openoffice.org/wiki/FastParser diff --git a/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl index a3105c5c5ee5..bd58164b6f0e 100644 --- a/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastShapeContextHandler.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module xml { module sax { /** receives notification of sax document events from a - <type>XFastParser</type>. + XFastParser. @see XFastDocumentHandler */ diff --git a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl index 972bcdf43d9b..ea62913731d8 100644 --- a/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module xml { module sax { /** interface to translate XML strings to integer tokens. - <p>An instance of this interface can be registered at a <type>XFastParser</type>. + <p>An instance of this interface can be registered at a XFastParser. It should be able to translate all XML names (element local names, attribute local names and constant attribute values) to integer tokens. diff --git a/offapi/com/sun/star/xsd/DataTypeClass.idl b/offapi/com/sun/star/xsd/DataTypeClass.idl index 9d4ccc6167b3..1d5395614f7a 100644 --- a/offapi/com/sun/star/xsd/DataTypeClass.idl +++ b/offapi/com/sun/star/xsd/DataTypeClass.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module xsd { -/** These constants specify the class used of an <type>XDataType</type> +/** These constants specify the class used of an XDataType */ constants DataTypeClass { |