diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 22:32:23 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:00 +0200 |
| commit | 3122600a5e11309b86e33061defd710cf0872975 (patch) | |
| tree | 849f913b061611d306194e07c22071219dafd592 /offapi/com | |
| parent | b352a8bf0321c13919c9882484a1c4d4d65cfd33 (diff) | |
*api: convert <member>Foo::bar</member>
Doxygen would probably recognize these without () too but add them for
consistency.
sed -i "s,<member>\([^<]*::[a-z][^<:]\+[^)]\)</member>,\1(),g"
Change-Id: I2615b99265b75633459e35164e54d9da7fe76b85
Diffstat (limited to 'offapi/com')
142 files changed, 321 insertions, 321 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleEventId.idl b/offapi/com/sun/star/accessibility/AccessibleEventId.idl index 55baaf8dffc8..663f525a39fa 100644 --- a/offapi/com/sun/star/accessibility/AccessibleEventId.idl +++ b/offapi/com/sun/star/accessibility/AccessibleEventId.idl @@ -161,7 +161,7 @@ constants AccessibleEventId <member>AccessibleEventObject::NewValue</member> field contain the old and new value as a number. Its exact type is implementation dependent but has to be the same as is returned by the - <member>XAccessibleValue::getCurrentValue</member> function. + XAccessibleValue::getCurrentValue() function. */ const short VALUE_CHANGED = 11; diff --git a/offapi/com/sun/star/accessibility/IllegalAccessibleComponentStateException.idl b/offapi/com/sun/star/accessibility/IllegalAccessibleComponentStateException.idl index adb597f9d036..053ed162b859 100644 --- a/offapi/com/sun/star/accessibility/IllegalAccessibleComponentStateException.idl +++ b/offapi/com/sun/star/accessibility/IllegalAccessibleComponentStateException.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module accessibility { <p>This exception is thrown to indicate the an accessibility component has been queried for state information that it can not provide. Used by - <member>XAccessibleContext::getLocale</member>.</p> + XAccessibleContext::getLocale().</p> @see XAccessibleContext::getLocale() diff --git a/offapi/com/sun/star/accessibility/XAccessibleContext.idl b/offapi/com/sun/star/accessibility/XAccessibleContext.idl index 7738b7ed47c9..810f8077a20e 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleContext.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleContext.idl @@ -65,7 +65,7 @@ interface XAccessibleContext : ::com::sun::star::uno::XInterface @param i The index may have any value. If it is outside the range from 0 to n-1, with n being the number of children as returned by - <member>XAccessibleContext::getAccessibleChild</member> an empty + XAccessibleContext::getAccessibleChild() an empty reference is returned. @return If the object has an i-th child the returned value is a @@ -130,7 +130,7 @@ interface XAccessibleContext : ::com::sun::star::uno::XInterface /** Return the object's localized name. - <p>See <member>XAccessibleContext::getAccessibleRole</member>'s + <p>See XAccessibleContext::getAccessibleRole()'s documentation for the relation between an object's name and role. Names should be unique, at least between children of the same parent, although the uniqueness is neither enforced nor used inside diff --git a/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl b/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl index af74015ed0d8..f330ba0ec4d1 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleEditableText.idl @@ -43,12 +43,12 @@ interface XAccessibleEditableText <p>The specified text between and including the two given indices is copied into the system clipboard and is deleted afterwards from the text represented by this object. This is equivalent to calling - first <member>XAccessibleText::copyText</member> and then - <member>XAccessibleEditableText::deleteText</member> with the given + first XAccessibleText::copyText() and then + XAccessibleEditableText::deleteText() with the given start and end indices.</p> <p>The text indices are interpreted like those in the - <member>XAccessibleText::getTextRange</member> method. </p> + XAccessibleText::getTextRange() method. </p> @param nStartIndex Start index of the text to moved into the clipboard. @@ -72,7 +72,7 @@ interface XAccessibleEditableText <p>The text in the system clipboard is pasted into the text represented by this object at the given index. This method is - similar to the <member>XAccessibleEditableText::insertText</member> + similar to the XAccessibleEditableText::insertText() method. If the index is not valid then the system clipboard text is not inserted.</p> @@ -97,7 +97,7 @@ interface XAccessibleEditableText from the text represented by this object.</p> <p>The text indices are interpreted like those in the - <member>XAccessibleText::getTextRange</member> method. </p> + XAccessibleText::getTextRange() method. </p> @param nStartIndex Start index of the text to be deleted. @@ -144,13 +144,13 @@ interface XAccessibleEditableText <p>The text between the two given indices is replaced by the specified replacement string. This method is equivalent to calling first - <member>XAccessibleEditableText::deleteText</member> with the two + XAccessibleEditableText::deleteText() with the two indices and afterwards calling - <member>XAccessibleEditableText::insertText</member> with the + XAccessibleEditableText::insertText() with the replacement text and the start index.</p> <p>The text indices are interpreted like those in the - <member>XAccessibleText::getTextRange</member> method. </p> + XAccessibleText::getTextRange() method. </p> @param nStartIndex Start index of the text to be replaced. @@ -182,7 +182,7 @@ interface XAccessibleEditableText portion are replaced by the new list of attributes.</p> <p>The text indices are interpreted like those in the - <member>XAccessibleText::getTextRange</member> method. </p> + XAccessibleText::getTextRange() method. </p> @param nStartIndex Start index of the text whose attributes are modified. diff --git a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl index e6779ac33731..c4eff29044c8 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl @@ -32,17 +32,17 @@ module com { module sun { module star { module accessibility { of hyperlinks are contained in client side image maps. Linked objects and anchors are implementation dependent. This interface inherits the XAccessibleAction interface. Especially that interface's - <member>XAccessibleAction::getActionCount</member> method is needed to + XAccessibleAction::getActionCount() method is needed to obtain a maximum value for the indices passed to the - <member>XAccessibleHyperlink::getAccessibleActionAnchor</member> and - <member>XAccessibleHyperlink::getAccessibleActionObject</member> + XAccessibleHyperlink::getAccessibleActionAnchor() and + XAccessibleHyperlink::getAccessibleActionObject() methods.</p> <p>Furthermore, the object that implements this interface has to be connected implicitly or explicitly with an object that implements the the XAccessibleText interface. The - <member>XAccessibleHyperlink::getStartIndex</member> and - <member>XAccessibleHyperlink::getEndIndex</member> methods return + XAccessibleHyperlink::getStartIndex() and + XAccessibleHyperlink::getEndIndex() methods return indices with respect to the text exposed by that interface.</p> @since OOo 1.1.2 @@ -60,7 +60,7 @@ interface XAccessibleHyperlink : This index identifies the anchor when, as in the case of an image map, there is more than one link represented by this object. The valid maximal index can be determined by calling - the <member>XAccessibleAction::getActionCount</member> method. + the XAccessibleAction::getActionCount() method. @return If the index is not valid then an exception is thrown. @@ -79,7 +79,7 @@ interface XAccessibleHyperlink : This index identifies the action object when, as in the case of an image map, there is more than one link represented by this object. The valid maximal index can be determined by calling - the <member>XAccessibleAction::getActionCount</member> method. + the XAccessibleAction::getActionCount() method. @return If the index is not valid then an exception is thrown. diff --git a/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl b/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl index f05ef585ec0a..0e88a77071ab 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleHypertext.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module accessibility { <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 + XAccessibleHypertext::getLinkIndex() method of this interface and other character related methods of the XAccessibleHyperlink interface, it is necessary to also support the XAccessibleText interface.</p> diff --git a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl index fd539bc9a7b7..4b7aa2cc845d 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleMultiLineText.idl @@ -65,7 +65,7 @@ interface XAccessibleMultiLineText number.</p> <p>The number of lines can be obtained by calling - <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> + XAccessibleMultiLineText::getLineNumberAtIndex() with the index of the last character. In a loop, the last line has been reached when <member>TextSegment::SegmentEnd</member> of the returned value is equal to the index of the last @@ -89,15 +89,15 @@ interface XAccessibleMultiLineText /** Returns the text of the line in which the caret is located. <p>The substring returned will most of the time be identical to - calling <member>XAccessibleText::getTextAtIndex</member> with - the index returned by <member>XAccessibleText::getCaretPosition</member> + calling XAccessibleText::getTextAtIndex() with + the index returned by XAccessibleText::getCaretPosition() and type <const scope="AccessibleTextType">LINE</type> beside the following special case:</p> <p>Some text implementations place the caret at the end of the current line when the <b>End</b> key gets pressed. Since the index of this position is identical to the one of the first character of the following line, - <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> will + XAccessibleMultiLineText::getLineNumberAtIndex() will return the line following the current one in this case.</p> @return @@ -111,14 +111,14 @@ interface XAccessibleMultiLineText /** Returns the number of the line in which the caret is located. <p>The line number returned will most of the time be identical to - calling <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> - with the index returned by <member>XAccessibleText::getCaretPosition</member> + calling XAccessibleMultiLineText::getLineNumberAtIndex() + with the index returned by XAccessibleText::getCaretPosition() beside the following special case:</p> <p>Some text implementations place the caret at the end of the current line when the <b>End</b> key gets pressed. Since the index of this position is identical to the one of the first character of the following line, - <member>XAccessibleMultiLineText::getLineNumberAtIndex</member> will + XAccessibleMultiLineText::getLineNumberAtIndex() will return the line following the current one in this case.</p> @return diff --git a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl index c8ed13aee1bc..21258973585d 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleSelection.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleSelection.idl @@ -98,8 +98,8 @@ interface XAccessibleSelection : ::com::sun::star::uno::XInterface <p>This number specifies the valid interval of indices that can be used as arguments for the methods - <member>XAccessibleSelection::getSelectedChild</member> and - <member>XAccessibleSelection::deselectSelectedChild</member>.</p> + XAccessibleSelection::getSelectedChild() and + XAccessibleSelection::deselectSelectedChild().</p> @return Returns the number of selected children of this object or 0 if diff --git a/offapi/com/sun/star/accessibility/XAccessibleTable.idl b/offapi/com/sun/star/accessibility/XAccessibleTable.idl index ea60a3b8ac22..2e477fa33320 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTable.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTable.idl @@ -39,16 +39,16 @@ module com { module sun { module star { module accessibility { 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 - <member>XAccessibleTable::getAccessibleIndex</member>, - <member>XAccessibleTable::getAccessibleRow</member>, and - <member>XAccessibleTable::getAccessibleColumn</member>.</p> + XAccessibleTable::getAccessibleIndex(), + XAccessibleTable::getAccessibleRow(), and + XAccessibleTable::getAccessibleColumn().</p> <p>The range of valid coordinates for this interface are implementation dependent. However, that range includes at least the intervals from the from the first row or column with the index 0 up to the last (but not including) used row or column as returned by - <member>XAccessibleTable::getAccessibleRowCount</member> and - <member>XAccessibleTable::getAccessibleColumnCount</member>. In case of + XAccessibleTable::getAccessibleRowCount() and + XAccessibleTable::getAccessibleColumnCount(). In case of the Calc the current range of valid indices for retrieving data include the maximal table size--256 columns and 32000 rows--minus one.</p> @@ -251,9 +251,9 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface <p>This method has been renamed from the Java name <code>getAccessibleAt</code> to - <member>XAccessibleTable::getAccessibleCellAt</member> to avoid + XAccessibleTable::getAccessibleCellAt() to avoid ambiguities with the - <member>XAccessibleComponent::getAccessibleAt</member> method when + XAccessibleComponent::getAccessibleAt() method when accessed, for instance, from StarBasic.</p> @param nRow @@ -316,7 +316,7 @@ interface XAccessibleTable : ::com::sun::star::uno::XInterface specified cell. <p>This is the same index that would be returned by calling - <member>XAccessibleContext::getAccessibleIndexInParent</member> for + XAccessibleContext::getAccessibleIndexInParent() for that accessible object.</p> @param nRow diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl index 3a722de98a13..be5e2aaafe58 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl @@ -42,11 +42,11 @@ module com { module sun { module star { module accessibility { interface.</p> <p>The text length, i.e. the number of characters in the text, is - returned by <member>XAccessibleText::getCharacterCount</member>. + returned by XAccessibleText::getCharacterCount(). All methods that operate on particular characters (e.g. - <member>XAccessibleText::getCharacterAt</member>) use character + XAccessibleText::getCharacterAt()) use character indices from 0 to length-1. All methods that operate on character - positions (e.g. <member>XAccessibleText::getTextRange</member>) + positions (e.g. XAccessibleText::getTextRange()) use indices from 0 to length.</p> <p>Please note that accessible text does not necessarily support @@ -225,8 +225,8 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface coordinate system of the object, return the zero-based index of the character under that point. The same functionality could be achieved by using the bounding boxes for each character as returned - by <member>XAccessibleText::getCharacterBounds</member>. The method - <member>XAccessibleText::getIndexAtPoint</member>, however, can be + by XAccessibleText::getCharacterBounds(). The method + XAccessibleText::getIndexAtPoint(), however, can be implemented in a more efficient way.</p> @param aPoint @@ -278,7 +278,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface The old selection is replaced by the new selection.</p> <p>The selection encompasses the same string of text that - <member>XAccessibleText::getTextRange</member> would have + XAccessibleText::getTextRange() would have selected. See there for details.</p> <p>Setting the selection may or may not change the caret position. @@ -308,7 +308,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface /** Return the whole text. <p>Returns the complete text. This is equivalent to a call to - <member>XAccessibleText::getTextRange</member> with the arguments + XAccessibleText::getTextRange() with the arguments zero and <code>getCharacterCount()-1</code>.</p> @return @@ -385,7 +385,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface <p>Returns the substring of the specified text type that is located before the given character and does not include it. The result of this method should be same as a result for - <member>XAccessibleText::getTextAtIndex</member> with a + XAccessibleText::getTextAtIndex() with a suitably decreased index value.</p> <p>For example, if text type is <const @@ -424,7 +424,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface <p>Returns the substring of the specified text type that is located after the given character and does not include it. The result of this method should be same as a result for - <member>XAccessibleText::getTextAtIndex</member> with a + XAccessibleText::getTextAtIndex() with a suitably increased index value.</p> <p>For example, if text type is <const @@ -461,11 +461,11 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface <p>Copy the specified text into the clipboard. The text that is copied is the same text that would have been selected by the - <member>XAccessibleText::getTextRange</member> method. </p> + XAccessibleText::getTextRange() method. </p> <p>The other clipboard related methods - <member>XAccessibleEditableText::cutText</member> and - <member>XAccessibleEditableText::deleteText</member> can be found in + XAccessibleEditableText::cutText() and + XAccessibleEditableText::deleteText() can be found in the XAccessibleEditableText because of their destructive nature.</p> diff --git a/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl b/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl index af571d58c494..bf9fb3617f4f 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleTextMarkup.idl @@ -36,7 +36,7 @@ module com { module sun { module star { module accessibility { <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 + XAccessibleTextMarkup::getTextMarkupIndex() method of this interface and other character related methods of the XAccessibleTextMarkup interface, it is necessary to also support the XAccessibleText interface.</p> diff --git a/offapi/com/sun/star/awt/DeviceCapability.idl b/offapi/com/sun/star/awt/DeviceCapability.idl index 40b5639e61c0..8a6358d99fe3 100644 --- a/offapi/com/sun/star/awt/DeviceCapability.idl +++ b/offapi/com/sun/star/awt/DeviceCapability.idl @@ -36,9 +36,9 @@ published constants DeviceCapability const long RASTEROPERATIONS = 1; - /** supports the <member>XDevice::createBitmap</member>, - the <member>XDevice::createDevice</member> and the - <member>XGraphics::copy</member> methods. + /** supports the XDevice::createBitmap(), + the XDevice::createDevice() and the + XGraphics::copy() methods. @see XGraphics::setRasterOp */ diff --git a/offapi/com/sun/star/awt/ItemListEvent.idl b/offapi/com/sun/star/awt/ItemListEvent.idl index e372fe45a8d6..85e702396bba 100644 --- a/offapi/com/sun/star/awt/ItemListEvent.idl +++ b/offapi/com/sun/star/awt/ItemListEvent.idl @@ -42,7 +42,7 @@ struct ItemListEvent : ::com::sun::star::lang::EventObject /** the text of the item. <p>If the event being notified did not touch the text of an item, this member is empty. For instance, upon - invocation of <member>XItemList::setItemImage</member>, only <code>ItemImageURL</code> will be set, and + invocation of XItemList::setItemImage(), only <code>ItemImageURL</code> will be set, and <code>ItemText</code> will be empty.</p> */ ::com::sun::star::beans::Optional< string > @@ -51,7 +51,7 @@ struct ItemListEvent : ::com::sun::star::lang::EventObject /** the URL of the image of the item <p>If the event being notified did not touch the image of an item, this member is empty. For instance, upon - invocation of <member>XItemList::setItemText</member>, only <code>ItemText</code> will be set, and + invocation of XItemList::setItemText(), only <code>ItemText</code> will be set, and <code>ItemImageURL</code> will be empty.</p> */ ::com::sun::star::beans::Optional< string > diff --git a/offapi/com/sun/star/awt/SystemDependentXWindow.idl b/offapi/com/sun/star/awt/SystemDependentXWindow.idl index 23abdd89dd4b..e34bc18fa00a 100644 --- a/offapi/com/sun/star/awt/SystemDependentXWindow.idl +++ b/offapi/com/sun/star/awt/SystemDependentXWindow.idl @@ -27,7 +27,7 @@ /** specifies a system dependent XWindow. <p>This is the structure returned in the - <member>XSystemDependentWindowPeer::getWindowHandle</member> call, + XSystemDependentWindowPeer::getWindowHandle() call, if the system type is <const scope="com::sun::star::lang">SystemDependent::XWINDOW</const>.</p> diff --git a/offapi/com/sun/star/awt/UnoControlEditModel.idl b/offapi/com/sun/star/awt/UnoControlEditModel.idl index 5471e7ff2816..c6e93f70b18e 100644 --- a/offapi/com/sun/star/awt/UnoControlEditModel.idl +++ b/offapi/com/sun/star/awt/UnoControlEditModel.idl @@ -118,7 +118,7 @@ published service UnoControlEditModel /** specifies if hard line breaks will be returned in the - <member>XTextComponent::getText</member> method. + XTextComponent::getText() method. */ [property] boolean HardLineBreaks; diff --git a/offapi/com/sun/star/awt/XControl.idl b/offapi/com/sun/star/awt/XControl.idl index b4a85314bb8d..b83c130f32dd 100644 --- a/offapi/com/sun/star/awt/XControl.idl +++ b/offapi/com/sun/star/awt/XControl.idl @@ -41,7 +41,7 @@ <p>Implementations of this interface are abstract windows. The main reason to instantiate this implementation is to show the window on the screen. Before the window appears on the screen, the - <member>XControl::createPeer</member> method must be called.</p> + XControl::createPeer() method must be called.</p> <p>If the implementation of the control does not distinguish between model, view and controller, it must allow to set diff --git a/offapi/com/sun/star/awt/XDialog.idl b/offapi/com/sun/star/awt/XDialog.idl index 6b10a8ba2271..a20fdc053fde 100644 --- a/offapi/com/sun/star/awt/XDialog.idl +++ b/offapi/com/sun/star/awt/XDialog.idl @@ -47,7 +47,7 @@ published interface XDialog: com::sun::star::uno::XInterface short execute(); - /** hides the dialog and then causes <member>XDialog::execute</member> + /** hides the dialog and then causes XDialog::execute() to return. */ void endExecute(); diff --git a/offapi/com/sun/star/awt/XDialog2.idl b/offapi/com/sun/star/awt/XDialog2.idl index 9d9f83b91659..b39dfed5fa26 100644 --- a/offapi/com/sun/star/awt/XDialog2.idl +++ b/offapi/com/sun/star/awt/XDialog2.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module awt { */ published interface XDialog2: com::sun::star::awt::XDialog { - /** hides the dialog and then causes <member>XDialog::execute</member> + /** hides the dialog and then causes XDialog::execute() to return with the given result value. */ void endDialog ( [in] long Result ); diff --git a/offapi/com/sun/star/awt/XExtendedToolkit.idl b/offapi/com/sun/star/awt/XExtendedToolkit.idl index 39e0d521d8f8..70238d273963 100644 --- a/offapi/com/sun/star/awt/XExtendedToolkit.idl +++ b/offapi/com/sun/star/awt/XExtendedToolkit.idl @@ -40,8 +40,8 @@ module com { module sun { module star { module awt { <p>The first event broadcaster lets you keep track of the open top-level windows (frames). To get the set of currently open top-level window use - the <member>XExtendedToolkit::getTopWindowCount</member> and - <member>XExtendedToolkit::getTopWindow</member> methods.</p> + the XExtendedToolkit::getTopWindowCount() and + XExtendedToolkit::getTopWindow() methods.</p> <p>The second event broadcaster informs its listeners of key events. Its listeners can, unlike with most other broadcasters/listeners, diff --git a/offapi/com/sun/star/awt/XItemListListener.idl b/offapi/com/sun/star/awt/XItemListListener.idl index d72e655b13fa..06d82de99df6 100644 --- a/offapi/com/sun/star/awt/XItemListListener.idl +++ b/offapi/com/sun/star/awt/XItemListListener.idl @@ -50,7 +50,7 @@ interface XItemListListener : ::com::sun::star::lang::XEventListener [in] ItemListEvent Event ); /** is called when the list has been completely cleared, i.e. after an invocation of - <member>XItemList::removeAllItems</member> + XItemList::removeAllItems() */ void allItemsRemoved( [in] ::com::sun::star::lang::EventObject Event diff --git a/offapi/com/sun/star/awt/XView.idl b/offapi/com/sun/star/awt/XView.idl index c07db7137fc8..4a8e3d809c20 100644 --- a/offapi/com/sun/star/awt/XView.idl +++ b/offapi/com/sun/star/awt/XView.idl @@ -43,7 +43,7 @@ published interface XView: com::sun::star::uno::XInterface /** returns the output device which was set using the method - <member>XView::setGraphics</member>. + XView::setGraphics(). */ com::sun::star::awt::XGraphics getGraphics(); diff --git a/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl b/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl index c64449ff0f7a..520c2842b749 100644 --- a/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/SortableGridDataModel.idl @@ -49,7 +49,7 @@ interface XMutableGridDataModel; <p>Note that changing the data might result in the sort order being destroyed. If you want to ensure that the data represented by the model is still sorted after your modifications, you should call - <member>XSortableGridData::sortByColumn</member>, again.</p> + XSortableGridData::sortByColumn(), again.</p> */ service SortableGridDataModel : XSortableMutableGridDataModel { diff --git a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl index 74fd7b23c0bb..6cec955f2b2b 100644 --- a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl @@ -114,7 +114,7 @@ published interface XMutableGridDataModel : XGridDataModel /** updates the content of a given row. <p>The change in the data model will be notified to registered listeners via - <member>XGridDataListener::dataChanged</member>. The <member>GridDataEvent::FirstColumn</member> and + XGridDataListener::dataChanged(). The <member>GridDataEvent::FirstColumn</member> and <member>GridDataEvent::LastColumn</member> will denote the smallest respectively largest column index from <arg>ColumnIndexes</arg>.</p> diff --git a/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl b/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl index 522b4033c6cc..7f5477cf29af 100644 --- a/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XSortableMutableGridDataModel.idl @@ -38,7 +38,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 XGridDataListeners - via a call to its <member>XGridDataListener::dataChanged</member> method.</p> + via a call to its XGridDataListener::dataChanged() method.</p> */ interface XSortableGridData; }; diff --git a/offapi/com/sun/star/chart/XChartData.idl b/offapi/com/sun/star/chart/XChartData.idl index fa49818bf568..e6590a2cc8c4 100644 --- a/offapi/com/sun/star/chart/XChartData.idl +++ b/offapi/com/sun/star/chart/XChartData.idl @@ -76,7 +76,7 @@ published interface XChartData: com::sun::star::uno::XInterface <p>Always use this method to check, if a value is <em>not a number</em>. If you compare the value returned by - <member>XChartData::getNotANumber</member> to another double + XChartData::getNotANumber() to another double value using the = operator, you may not get the desired result!</p> diff --git a/offapi/com/sun/star/chart2/Axis.idl b/offapi/com/sun/star/chart2/Axis.idl index 5f36118a6193..b2fe0b7398ed 100644 --- a/offapi/com/sun/star/chart2/Axis.idl +++ b/offapi/com/sun/star/chart2/Axis.idl @@ -100,7 +100,7 @@ service Axis <p>To determine a source format, the axis can query the XDataSequences used by the data series attached - to it (see <member>XDataSequence::getNumberFormatKeyByIndex</member>). + to it (see XDataSequence::getNumberFormatKeyByIndex()). </p> */ [property, maybevoid] long NumberFormat; diff --git a/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl b/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl index 916885053e1a..2546aef50e8d 100644 --- a/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl +++ b/offapi/com/sun/star/chart2/StandardDiagramCreationParameters.idl @@ -31,7 +31,7 @@ module chart2 { /** parameters that may be passed to - <member>XChartTypeTemplate::createDiagramByDataSource</member>. + XChartTypeTemplate::createDiagramByDataSource(). */ service StandardDiagramCreationParameters { diff --git a/offapi/com/sun/star/chart2/XChartDocument.idl b/offapi/com/sun/star/chart2/XChartDocument.idl index dc231cf8b2ef..82a9ddff1a8d 100644 --- a/offapi/com/sun/star/chart2/XChartDocument.idl +++ b/offapi/com/sun/star/chart2/XChartDocument.idl @@ -93,7 +93,7 @@ interface XChartDocument : ::com::sun::star::frame::XModel /** Returns the currently set data provider. This may be an internal one, if createInternalDataProvider() has been called before, or an external one if - <member>XDataReceiver::attachDataProvider</member> has been + XDataReceiver::attachDataProvider() has been called. */ com::sun::star::chart2::data::XDataProvider getDataProvider(); @@ -120,7 +120,7 @@ interface XChartDocument : ::com::sun::star::frame::XModel want to access properties of the background area of a single diagram (the part where data points are actually plotted in), you have to get its wall. You can get the wall by calling - <member>XDiagram::getWall</member>.</p> + XDiagram::getWall().</p> */ com::sun::star::beans::XPropertySet getPageBackground(); }; diff --git a/offapi/com/sun/star/chart2/data/LabelOrigin.idl b/offapi/com/sun/star/chart2/data/LabelOrigin.idl index ae07c8a9a8ec..48c2a00d1601 100644 --- a/offapi/com/sun/star/chart2/data/LabelOrigin.idl +++ b/offapi/com/sun/star/chart2/data/LabelOrigin.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module chart2 { module data { /** is used to specify how the labels have to be created. - @see <member>XDataSequence::generateLabel</member>. + @see XDataSequence::generateLabel(). */ enum LabelOrigin { @@ -43,7 +43,7 @@ enum LabelOrigin <p>In case of a rectangular range, or a range that is composed of more than one contiguous sub-regions, the short side cannot be determined, thus - <member>XDataSequence::generateLabel</member> will return an + XDataSequence::generateLabel() will return an empty sequence.</p> */ SHORT_SIDE, diff --git a/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl b/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl index d2382256ae50..30cb67fa50c0 100644 --- a/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl +++ b/offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl @@ -41,7 +41,7 @@ service TabularDataProviderArguments <p>The range address string must be interpretable by the component that implements XDataProvider and gets this property as argument to - <member>XDataProvider::detectArguments</member>.</p> + XDataProvider::detectArguments().</p> <p>The representation string is of a form that may be used in the user interface. Example for OOo Calc: "$Sheet1.$A$1:$D$7", @@ -52,7 +52,7 @@ service TabularDataProviderArguments <member>DataRowSource</member>.</p> <p>When used as output of - <member>XDataProvider::detectArguments</member> this is the + XDataProvider::detectArguments() this is the range that spans the ranges of all given XDataSequences. If the result is ambiguous, i.e., a splitting of this range would not yield the same diff --git a/offapi/com/sun/star/configuration/backend/LayerFilter.idl b/offapi/com/sun/star/configuration/backend/LayerFilter.idl index 37fda20ec5bd..65a064a4128a 100644 --- a/offapi/com/sun/star/configuration/backend/LayerFilter.idl +++ b/offapi/com/sun/star/configuration/backend/LayerFilter.idl @@ -47,7 +47,7 @@ published service LayerFilter /** provides read access to the filtered contents. - <p> Method <member>XLayer::readData</member> will render a filtered version + <p> Method XLayer::readData() will render a filtered version of the data produced by the same method of the source object. </p> */ diff --git a/offapi/com/sun/star/configuration/backend/NodeAttribute.idl b/offapi/com/sun/star/configuration/backend/NodeAttribute.idl index ac1a24093824..44eea3eea305 100644 --- a/offapi/com/sun/star/configuration/backend/NodeAttribute.idl +++ b/offapi/com/sun/star/configuration/backend/NodeAttribute.idl @@ -59,10 +59,10 @@ published constants NodeAttribute /** indicates that contents shall be fused. - <p>Used in <member>XLayerHandler::addOrReplaceNode</member>, - <member>XLayerHandler::addOrReplaceNodeFromTemplate</member>, - <member>XUpdateHandler::addOrReplaceNode</member>, and - <member>XUpdateHandler::addOrReplaceNodeFromTemplate</member>.</p> + <p>Used in XLayerHandler::addOrReplaceNode(), + XLayerHandler::addOrReplaceNodeFromTemplate(), + XUpdateHandler::addOrReplaceNode(), and + XUpdateHandler::addOrReplaceNodeFromTemplate().</p> @since OOo 2.0.3 */ diff --git a/offapi/com/sun/star/deployment/ExtensionRemovedException.idl b/offapi/com/sun/star/deployment/ExtensionRemovedException.idl index 872c4562db22..33cc71476b63 100644 --- a/offapi/com/sun/star/deployment/ExtensionRemovedException.idl +++ b/offapi/com/sun/star/deployment/ExtensionRemovedException.idl @@ -28,7 +28,7 @@ interface XPackage; /** indicates that a function call with the given arguments is not supported - because the extension was removed. <member>XPackage::isRemoved</member> will + because the extension was removed. XPackage::isRemoved() will return true on that object. @since OOo 3.3 diff --git a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl index f619aed600e3..e7b8a6c3d4a8 100644 --- a/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl +++ b/offapi/com/sun/star/deployment/InvalidRemovedParameterException.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module deployment { interface XPackage; /** - indicates that <member>XPackageRegistry::bindPackage</member> was previously + indicates that XPackageRegistry::bindPackage() was previously called with a different value for the <code>removed</code> parameter and that the XPackage object created by that call still exist. @@ -35,14 +35,14 @@ interface XPackage; */ 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 + XPackageRegistry::bindPackage() to create the currently existing XPackage object. */ boolean PreviousValue; /** the XPackage that was already bound to the provided <code>url</code> parameter during - <member>XPackageRegistry::bindPackage</member>. + XPackageRegistry::bindPackage(). <p>Must not be <NULL/>.</p> */ diff --git a/offapi/com/sun/star/deployment/LicenseException.idl b/offapi/com/sun/star/deployment/LicenseException.idl index 04a8f49dff6e..94446240b091 100644 --- a/offapi/com/sun/star/deployment/LicenseException.idl +++ b/offapi/com/sun/star/deployment/LicenseException.idl @@ -34,7 +34,7 @@ exception LicenseException : com::sun::star::uno::Exception /** name of the extension. The display name of the extension. - See <member>XPackage::getDisplayName</member> + See XPackage::getDisplayName() */ string ExtensionName; /** contains the text of the license. diff --git a/offapi/com/sun/star/deployment/XExtensionManager.idl b/offapi/com/sun/star/deployment/XExtensionManager.idl index ffb4e756eba1..47d666a7869f 100644 --- a/offapi/com/sun/star/deployment/XExtensionManager.idl +++ b/offapi/com/sun/star/deployment/XExtensionManager.idl @@ -278,7 +278,7 @@ interface XExtensionManager Added extensions will be added to the database and removed extensions will be removed from the database. The active extensions are determined. That is, shared or bundled extensions - are not necessaryly registered (<member>XPackage::registerPackage</member>). + are not necessaryly registered (XPackage::registerPackage()). @return If true - then at least one extension was removed or added. Otherwise @@ -305,10 +305,10 @@ interface XExtensionManager are also not returned. Extensions returned by this functions are not returned by - <member>XExtensionManger::getDeployedExtension</member> - <member>XExtensionManger::getDeployedExtensions</member> - <member>XExtensionManger::getAllExtensions</member> - <member>XExtensionManger::getExtensionsWithSameIdentifier</member> + XExtensionManger::getDeployedExtension() + XExtensionManger::getDeployedExtensions() + XExtensionManger::getAllExtensions() + XExtensionManger::getExtensionsWithSameIdentifier() */ sequence<XPackage> getExtensionsWithUnacceptedLicenses( [in] string repository, diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index d2b7ba7af232..dac0e87d7f04 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -136,7 +136,7 @@ interface XPackage @param startup indicates that registration is adapted to the particular startup scenario. That is, it is set to <TRUE/>, when called - from <member>XExtensionManager::synchronize</member> + from XExtensionManager::synchronize() @param xAbortChannel abort channel to asynchronously abort the registration process, or <NULL/> @@ -160,7 +160,7 @@ interface XPackage @param startup indicates that registration is adapted to the particular startup scenario. That is, it is set to <TRUE/>, when called - from <member>XExtensionManager::synchronize</member> + from XExtensionManager::synchronize() @param xAbortChannel abort channel to asynchronously abort the registration process, or <NULL/> @@ -335,13 +335,13 @@ interface XPackage /** return a URL to a directory which contains the registration data. This data may be created when calling - <member>XPackage::registerPackage</member>. If this is the case is + XPackage::registerPackage(). If this is the case is indicated by <member scope="com::sun::star::beans">Optional::IsPresent</member> of the return value. If registration data are created during registration, but the package is currently not registered, for example after calling - <member>XPackage::revokePackage</member>, then <member + XPackage::revokePackage(), then <member scope="com::sun::star::beans">Optional::IsPresent</member> is <TRUE/> and the <member scope="com::sun::star::beans">Optional::Value</member> may be an empty string. @@ -352,7 +352,7 @@ interface XPackage /** indicates if this object represents a removed extension or extension item. This is the case when it was created by providing <TRUE/> for the <code>removed</code> parameter in the function - <member>XPackageRegistry::bindPackage</member>. + XPackageRegistry::bindPackage(). */ boolean isRemoved(); diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index 9a77f8be3158..365034cf0a4f 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -49,11 +49,11 @@ interface XPackageRegistry 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 XPackage object on behalf of that extension and - calls <member>XPackage::revokePakage</member>. The parameter + calls XPackage::revokePakage(). 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 must use previously saved data to successfully carry out the revocation - of this object (<member>XPackage::revokePackage</member>). + of this object (XPackage::revokePackage()). The implementation must ensure that there is only one instance of XPackage for the same <code>url</code> at any @@ -80,7 +80,7 @@ interface XPackageRegistry @param unfulfilledPrerequisites has a value other null if the extension could not be installed previously - because <member>XPackage::checkPrerequisites</member> failed. + because XPackage::checkPrerequisites() failed. @param identifier the identifier of the extension diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index b470de9ef989..b6c418cf2f36 100644 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -63,8 +63,8 @@ interface XUndoManagerListener; <a name="locking"></a> <h3>Locking</h3> - <p>An Undo manager can be locked and unlocked, using the <member>XLockable::lock</member> and - <member>XLockable::unlock</member> methods. When it is locked, then every attempt to add an undo action, or to + <p>An Undo manager can be locked and unlocked, using the XLockable::lock() and + XLockable::unlock() methods. When it is locked, then every attempt to add an undo action, or to enter or leave an Undo context, will be silently ignored.</p> */ interface XUndoManager @@ -136,11 +136,11 @@ interface XUndoManager <p>If no undo action has been added since the context has been opened, the context is not only left, but silently removed, and does not contribute to the undo stack at all. In this case, possible - listeners will be notified via <member>XUndoManagerListener::cancelledContext</member>.</p> + listeners will be notified via XUndoManagerListener::cancelledContext().</p> <p>Otherwise, the undo context will be closed, and added to the Undo stack; the redo stack will be cleared, - and listeners will be notified via <member>XUndoManagerListener::leftContext</member> resp. - <member>XUndoManagerListener::leftHiddenContext</member></p> + and listeners will be notified via XUndoManagerListener::leftContext() resp. + XUndoManagerListener::leftHiddenContext()</p> @throws ::com::sun::star::util::InvalidStateException if no undo context is currently open. @@ -174,7 +174,7 @@ interface XUndoManager /** reverts the most recent action on the document. <p>Effectively, invoking this method will - <ul><li>invoke <member>XUndoAction::undo</member> on the top-most action of the undo stack</li> + <ul><li>invoke XUndoAction::undo() on the top-most action of the undo stack</li> <li>move this undo action from the undo stack to the redo stack</li> </ul></p> @@ -185,7 +185,7 @@ interface XUndoManager if there currently is an open undo context @throws UndoFailedException - if the invocation of <member>XUndoAction::undo</member> raised this exception. In this case, the undo stack + if the invocation of XUndoAction::undo() raised this exception. In this case, the undo stack of the undo manager will have been cleared. @see redo @@ -199,7 +199,7 @@ interface XUndoManager /** replays the action on the document which has most recently been undone <p>Effectively, invoking this method will - <ul><li>invoke <member>XUndoAction::redo</member> on the top-most action of the redo stack</li> + <ul><li>invoke XUndoAction::redo() on the top-most action of the redo stack</li> <li>move this action from the redo stack to the undo stack</li> </ul></p> @@ -210,7 +210,7 @@ interface XUndoManager if there currently is an open undo context @throws UndoFailedException - if the invocation of <member>XUndoAction::redo</member> raised this exception. In this case, the redo stack + if the invocation of XUndoAction::redo() raised this exception. In this case, the redo stack of the undo manager will have been cleared. @see undo @@ -300,9 +300,9 @@ interface XUndoManager </ul></p> <p>Note that possible listeners will not get notifications for the single parts of the reset, i.e. there - will be no single <member>XUndoManagerListener::allActionsCleared</member>, - <member>XUndoManagerListener::leftContext</member>, etc., notifications. Instead, listeners will be - notified of the reset by calling their <member>XUndoManagerListener::resetAll</member> method.</p> + will be no single XUndoManagerListener::allActionsCleared(), + XUndoManagerListener::leftContext(), etc., notifications. Instead, listeners will be + notified of the reset by calling their XUndoManagerListener::resetAll() method.</p> */ void reset(); diff --git a/offapi/com/sun/star/form/DataAwareControlModel.idl b/offapi/com/sun/star/form/DataAwareControlModel.idl index 803d5f3b1f52..dc96cbff59d7 100644 --- a/offapi/com/sun/star/form/DataAwareControlModel.idl +++ b/offapi/com/sun/star/form/DataAwareControlModel.idl @@ -71,7 +71,7 @@ published service DataAwareControlModel (see XReset) is as follows:<br/> If (and only if) the control is valid bound to a column of it's com::sun::star::form::component::DataForm, 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 + XReset::reset() does not reset the model's value to it's default value, but uses the underlying column value.<br/> In all other cases, the model is reset to the default value as specified by the respective property.</p> diff --git a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl index f76ebb7e31f5..5ea712382ff9 100644 --- a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl +++ b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl @@ -37,7 +37,7 @@ published interface XApproveActionBroadcaster: com::sun::star::uno::XInterface { - /** adds the specified listener to receive the <member>XApproveActionListener::approveAction</member> + /** adds the specified listener to receive the XApproveActionListener::approveAction() event. @param aListener diff --git a/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl b/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl index 0d66ce031750..123bfb77d7d6 100644 --- a/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl +++ b/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl @@ -38,7 +38,7 @@ published interface XConfirmDeleteBroadcaster: com::sun::star::uno::XInterface /** remembers the specified listener to receive an event for confirming deletions - <p><member>XConfirmDeleteListener::confirmDelete</member> is called before a + <p>XConfirmDeleteListener::confirmDelete() is called before a deletion is performed. You may use the event to write your own confirmation messages.</p> @param aListener diff --git a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl index 549f99240952..83af94682c52 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster2.idl @@ -40,7 +40,7 @@ interface XDatabaseParameterBroadcaster2: XDatabaseParameterBroadcaster { /** registers an XDatabaseParameterListener - <p>This method behaves exactly as the <member>XDatabaseParameterBroadcaster::addParameterListener</member> + <p>This method behaves exactly as the XDatabaseParameterBroadcaster::addParameterListener() method inherited from the base interface.</p> */ void addDatabaseParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener ); @@ -48,7 +48,7 @@ interface XDatabaseParameterBroadcaster2: XDatabaseParameterBroadcaster /** revokes an XDatabaseParameterListener - <p>This method behaves exactly as the <member>XDatabaseParameterBroadcaster::removeParameterListener</member> + <p>This method behaves exactly as the XDatabaseParameterBroadcaster::removeParameterListener() method inherited from the base interface.</p> */ void removeDatabaseParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener ); diff --git a/offapi/com/sun/star/form/XFormsSupplier2.idl b/offapi/com/sun/star/form/XFormsSupplier2.idl index 2483ed81bdb9..b3e5a072150b 100644 --- a/offapi/com/sun/star/form/XFormsSupplier2.idl +++ b/offapi/com/sun/star/form/XFormsSupplier2.idl @@ -34,12 +34,12 @@ interface XFormsSupplier2: XFormsSupplier <p>If you need read access to the forms collection, then you might check the existence of forms using hasForms(), and if it returns - <FALSE/>, you can do as if <member>XFormsSupplier::getForms</member> would + <FALSE/>, you can do as if XFormsSupplier::getForms() would have returned an empty container.</p> <p>Semantically, hasForms() is equivalent to calling - <member>XElementAccess::hasElements</member> on the container returned by - <member>XFormsSupplier::getForms</member>. But when using the latter, the + XElementAccess::hasElements() on the container returned by + XFormsSupplier::getForms(). But when using the latter, the implementation is forced to create a empty container, which might be potentially expensive.</p> */ diff --git a/offapi/com/sun/star/form/XResetListener.idl b/offapi/com/sun/star/form/XResetListener.idl index ef7c6b4e326d..3bf1b0f1b5f1 100644 --- a/offapi/com/sun/star/form/XResetListener.idl +++ b/offapi/com/sun/star/form/XResetListener.idl @@ -34,9 +34,9 @@ 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> + <li>the component calls XReset::approveReset() on all its listeners</li> <li>if all listeners approve the reset operation, the data is reset</li> - <li>the component calls <member>XReset::resetted</member> on all its listeners</li> + <li>the component calls XReset::resetted() on all its listeners</li> </ul> </p> diff --git a/offapi/com/sun/star/form/XUpdateBroadcaster.idl b/offapi/com/sun/star/form/XUpdateBroadcaster.idl index d603948836dc..ddb83f21ccde 100644 --- a/offapi/com/sun/star/form/XUpdateBroadcaster.idl +++ b/offapi/com/sun/star/form/XUpdateBroadcaster.idl @@ -31,9 +31,9 @@ /** is the broadcaster interface for sending "approveUpdate" and "updated" events. <p>The component supporting this interface must do approval calls - (<member>XUpdateListener::approveUpdate</member>) immediately + (XUpdateListener::approveUpdate()) immediately before the data is updated, and notification calls - (<member>XUpdateListener::updated</member>) immediately afterwards.</p> + (XUpdateListener::updated()) immediately afterwards.</p> @see XUpdateListener */ diff --git a/offapi/com/sun/star/form/binding/BindableControlModel.idl b/offapi/com/sun/star/form/binding/BindableControlModel.idl index 8c6ca0bf6e03..e4b6809cadfb 100644 --- a/offapi/com/sun/star/form/binding/BindableControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableControlModel.idl @@ -36,7 +36,7 @@ service BindableControlModel <p>Via this service, bindable control models inherit the com::sun::star::util::XCloneable interface.<br/> If an bindable control model, at which a binding has been established (via - <member>XBindableValue::setValueBinding</member>), is being cloned, then the + XBindableValue::setValueBinding()), is being cloned, then the binding is also established at the clone. Effectively, this means that both control model instances share the same binding instance.</p> */ diff --git a/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl b/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl index 31a3da3710a3..f145990f06c1 100644 --- a/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl @@ -91,9 +91,9 @@ module com { module sun { module star { module form { module binding { </p> <p>When a BindableDataAwareControlModel is being bound to an external value, - using <member>XBindableValue::setValueBinding</member>, + using XBindableValue::setValueBinding(), 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>) + initially synchronized by setting the external value (XValueBinding::getValue()) at the control model.</p> */ diff --git a/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl b/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl index 37ebd2a74470..dc00f06c0eb5 100644 --- a/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl +++ b/offapi/com/sun/star/form/binding/BindableIntegerValueRange.idl @@ -36,7 +36,7 @@ service BindableIntegerValueRange { /** specifies that the control can be bound to external values - <p>Any binding used with the control model (see <member>XBindableValue::setValueBinding</member>) + <p>Any binding used with the control model (see XBindableValue::setValueBinding()) must support exchanging double values.</p> <p>When the (integer) value reflected by the control model is changed, it's converted diff --git a/offapi/com/sun/star/form/binding/ValueBinding.idl b/offapi/com/sun/star/form/binding/ValueBinding.idl index 34b3b565d672..558951c592cf 100644 --- a/offapi/com/sun/star/form/binding/ValueBinding.idl +++ b/offapi/com/sun/star/form/binding/ValueBinding.idl @@ -44,7 +44,7 @@ service ValueBinding <p>As long as this property is <TRUE/>, the value binding should throw a InvalidBindingStateException when its - <member>XValueBinding::setValue</member> method is invoked.</p> + XValueBinding::setValue() method is invoked.</p> */ [optional, property, bound, readonly] boolean ReadOnly; diff --git a/offapi/com/sun/star/form/binding/XListEntryListener.idl b/offapi/com/sun/star/form/binding/XListEntryListener.idl index 9bc623b872d1..f98cd0ab310f 100644 --- a/offapi/com/sun/star/form/binding/XListEntryListener.idl +++ b/offapi/com/sun/star/form/binding/XListEntryListener.idl @@ -62,7 +62,7 @@ interface XListEntryListener : com::sun::star::lang::XEventListener /** notifies the listener that all entries of the list have changed. <p>The listener should retrieve the complete new list by calling the - <member>XListEntrySource::getAllListEntries</member> method of the event source + XListEntrySource::getAllListEntries() method of the event source (which is denoted by <member scope="com::sun::star::lang">EventObject::Source</member>). */ void allEntriesChanged( [in] com::sun::star::lang::EventObject Source ); diff --git a/offapi/com/sun/star/form/component/DataForm.idl b/offapi/com/sun/star/form/component/DataForm.idl index db48537521b9..4c982347d443 100644 --- a/offapi/com/sun/star/form/component/DataForm.idl +++ b/offapi/com/sun/star/form/component/DataForm.idl @@ -77,7 +77,7 @@ published service DataForm functionality of this interface could be simulated by using setting some properties manually, <member scope="com::sun::star::sdbc">XRowSet::execute</member>, moving the row set cursor and so on.</p> - <p>One main difference between <member>XLoadable::load</member> and <member scope="com::sun::star::sdbc">XRowSet::execute</member> + <p>One main difference between XLoadable::load() and <member scope="com::sun::star::sdbc">XRowSet::execute</member> is that if you use the former, the row set is positioned on the first record, while in the latter case it is position <em>before</em> the it.</p> */ diff --git a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl index 185fb4f45da8..fb2bc5eae02d 100644 --- a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl @@ -50,10 +50,10 @@ service ValidatableBindableControlModel <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 XValidator interface), the binding is also - established as validator, as if it has been passed to <member>XValidatable::setValidator</member>.<br/> + established as validator, as if it has been passed to XValidatable::setValidator().<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 - com::sun::star::util::VetoException upon calling <member>XValidatable::setValidator</member>.</p> + com::sun::star::util::VetoException upon calling XValidatable::setValidator().</p> */ service com::sun::star::form::binding::BindableControlModel; }; diff --git a/offapi/com/sun/star/form/validation/ValidatableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableControlModel.idl index 330038662b6b..0d87f34e6303 100644 --- a/offapi/com/sun/star/form/validation/ValidatableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableControlModel.idl @@ -41,7 +41,7 @@ service ValidatableControlModel <p>Via this service, validatable control models inherit the com::sun::star::util::XCloneable interface.<br/> If an validatable control model, at which a validator has been set (via - <member>XValidatable::setValidator</member>), is being cloned, then the + XValidatable::setValidator()), is being cloned, then the validator is also set at the clone. Effectively, this means that both control model instances share the same validator instance.</p> */ @@ -54,17 +54,17 @@ service ValidatableControlModel 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> - and <member>XValidatableFormComponent::getCurrentValue</member>.</p> + (relative to the active validator), is provided by the methods XValidatableFormComponent::isValid() + and XValidatableFormComponent::getCurrentValue().</p> - <p>Note that the type of the value provided by <member>XValidatableFormComponent::getCurrentValue</member> + <p>Note that the type of the value provided by XValidatableFormComponent::getCurrentValue() is not specified here, but depends on the concrete control type.</p> */ interface XValidatableFormComponent; /** enables support for validators with dynamic validity constraints. - <p>As soon as a validator is set via <member>XValidatable::setValidator</member>, the validatable + <p>As soon as a validator is set via XValidatable::setValidator(), the validatable control model registers itself as listener. If the validity constraint of the validator changes, the ValidatableControlModel re-validates it's current valid, and broadcasts any resuling changes to all its XFormComponentValidityListener, if diff --git a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl index 90f5466a5435..e108d4731610 100644 --- a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl +++ b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl @@ -58,11 +58,11 @@ interface XValidatableFormComponent : XValidatable /** determines whether the current value of the component passed the validity test at the validator. - <p>Calling this is equal to calling <member>XValidator::isValid</member> with + <p>Calling this is equal to calling XValidator::isValid() with the current value (see getCurrentValue()) of the component, where - the validator is obtained via <member>XValidatable::getValidator</member>.</p> + the validator is obtained via XValidatable::getValidator().</p> - <p>If no validator has been set (<member>XValidatable::setValidator</member>), this method + <p>If no validator has been set (XValidatable::setValidator()), this method returns true.</p> */ boolean isValid(); @@ -76,7 +76,7 @@ interface XValidatableFormComponent : XValidatable calling this method is equivalent to retrieving the <member scope="com::sun::star::awt">UnoControlFormattedFieldModel::EffectiveValue</member>.</p> - <p>If no validator has been set (<member>XValidatable::setValidator</member>), the value returned + <p>If no validator has been set (XValidatable::setValidator()), the value returned here is defined by the service implementing this interface.</p> */ any getCurrentValue(); diff --git a/offapi/com/sun/star/frame/XController2.idl b/offapi/com/sun/star/frame/XController2.idl index 1bf0481ccbac..bd4eaba16482 100644 --- a/offapi/com/sun/star/frame/XController2.idl +++ b/offapi/com/sun/star/frame/XController2.idl @@ -46,14 +46,14 @@ interface XController2 : XController /** specifies the view name of the controller. <p>A view name is a logical name, which can be used to create views of the same - type. The name is meaningful only in conjunction with <member>XModel2::createViewController</member> + type. The name is meaningful only in conjunction with XModel2::createViewController() - if it's passed there, a view/controller pair of the same type will be created.</p> */ [readonly, attribute] string ViewControllerName; /** denotes the arguments used to create the instance. - <p>Usually, controllers are created via <member>XModel2::createViewController</member>, where the + <p>Usually, controllers are created via XModel2::createViewController(), where the caller can pass not only a controller name, but also arguments parameterizing the to-be-created instance. Those arguments used at creation time can subsequently be retrieved using the <code>CreationArguments</code> member.</p> diff --git a/offapi/com/sun/star/frame/XFrame.idl b/offapi/com/sun/star/frame/XFrame.idl index c0670ceb7f5f..4bdd0a94816a 100644 --- a/offapi/com/sun/star/frame/XFrame.idl +++ b/offapi/com/sun/star/frame/XFrame.idl @@ -315,7 +315,7 @@ published interface XFrame: com::sun::star::lang::XComponent According to a call to this interface, the frame calls <method>XFrameEventListener::frameAction</method> with <const>FrameAction::CONTEXT_CHANGED</const> to all listeners which - are registered using <member>XFrame::addFrameActionListener</member>. + are registered using XFrame::addFrameActionListener(). For external controllers this event can be used to requery dispatches. @see XFrameEventListener diff --git a/offapi/com/sun/star/frame/XLayoutManager.idl b/offapi/com/sun/star/frame/XLayoutManager.idl index 5dfe0baadb8f..b593aa9ca439 100644 --- a/offapi/com/sun/star/frame/XLayoutManager.idl +++ b/offapi/com/sun/star/frame/XLayoutManager.idl @@ -167,7 +167,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface <p> If a user interface element should forced to the visible state - <member>XLayoutManager::showElement</member> should be used. This function can be + XLayoutManager::showElement() should be used. This function can be used for context dependent elements which should respect a the current visibility state. </p> diff --git a/offapi/com/sun/star/frame/XModel2.idl b/offapi/com/sun/star/frame/XModel2.idl index daa52bc9fb29..0a0e15f1b738 100644 --- a/offapi/com/sun/star/frame/XModel2.idl +++ b/offapi/com/sun/star/frame/XModel2.idl @@ -102,9 +102,9 @@ interface XModel2 : com::sun::star::frame::XModel /** creates a new view instance classified by the specified name and arguments. <p>The newly created controller must not be connected with the document and the - frame. That is, you should neither call <member>XFrame::setComponent</member>, nor - <member>XController::attachFrame</member>, nor <member>XController::attachModel</member>, - nor <member>XModel::connectController</member>, not <member>XModel::setCurrentController</member>. + frame. That is, you should neither call XFrame::setComponent(), nor + XController::attachFrame(), nor XController::attachModel(), + nor XModel::connectController(), not XModel::setCurrentController(). All of this is the responsibility of the caller, which will do it in the proper order.</p> @param ViewName diff --git a/offapi/com/sun/star/frame/XSessionManagerListener.idl b/offapi/com/sun/star/frame/XSessionManagerListener.idl index de055e7fc5af..c644c9f68df0 100644 --- a/offapi/com/sun/star/frame/XSessionManagerListener.idl +++ b/offapi/com/sun/star/frame/XSessionManagerListener.idl @@ -65,7 +65,7 @@ module com { module sun { module star { module frame { If <FALSE/> the listener must not interact with the user. If <TRUE/> the listener can interact with the user now. After interaction the listener must call - <member>XSessionManagerClient::interactionDone</member> + XSessionManagerClient::interactionDone() on the session manager client service object. @see XSessionManagerClient diff --git a/offapi/com/sun/star/i18n/BreakType.idl b/offapi/com/sun/star/i18n/BreakType.idl index 55273c605eb3..44e5cb6d2754 100644 --- a/offapi/com/sun/star/i18n/BreakType.idl +++ b/offapi/com/sun/star/i18n/BreakType.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module i18n { /** Constants to specify the type of a line break, used with - <member>LineBreakResults::breakType</member>. + LineBreakResults::breakType(). */ published constants BreakType diff --git a/offapi/com/sun/star/i18n/Currency.idl b/offapi/com/sun/star/i18n/Currency.idl index 6ad2a851b239..015a24c038ed 100644 --- a/offapi/com/sun/star/i18n/Currency.idl +++ b/offapi/com/sun/star/i18n/Currency.idl @@ -55,7 +55,7 @@ published struct Currency boolean Default; /** If this currency is the one used in compatible number format codes with - <member>FormatElement::formatIndex</member> values in the range 12..17. + FormatElement::formatIndex() values in the range 12..17. Those format codes are used to generate some old style currency format codes for compatibility with StarOffice5 and StarOffice4. diff --git a/offapi/com/sun/star/i18n/NumberFormatIndex.idl b/offapi/com/sun/star/i18n/NumberFormatIndex.idl index 3f6df462a601..a7ec730c691f 100644 --- a/offapi/com/sun/star/i18n/NumberFormatIndex.idl +++ b/offapi/com/sun/star/i18n/NumberFormatIndex.idl @@ -44,7 +44,7 @@ module com { module sun { module star { module i18n { <code><FormatElement formatindex="0"></code> <br/> - (see also <member>FormatElement::formatIndex</member>). + (see also FormatElement::formatIndex()). The index values are also used to define the <code>enum NfIndexTableOffset</code> in file svtools/inc/zforlist.hxx </p> diff --git a/offapi/com/sun/star/i18n/XBreakIterator.idl b/offapi/com/sun/star/i18n/XBreakIterator.idl index 54802cca69f5..c46f2aef93a0 100644 --- a/offapi/com/sun/star/i18n/XBreakIterator.idl +++ b/offapi/com/sun/star/i18n/XBreakIterator.idl @@ -92,9 +92,9 @@ published interface XBreakIterator: com::sun::star::uno::XInterface if the first non-space character is an Asian character, then, since Asian word break needs language specific wordbreak dictionaries, the method will return -1 in - <member>Boundary::endPos</member> and the position after the + Boundary::endPos() and the position after the Asian character (i.e. the space character) in - <member>Boundary::startPos</member>. The caller then has to + Boundary::startPos(). The caller then has to call this method again with a correct <em>aLocale</em> referring to the Asian character, which is then the previous character of the space character where <em>nStartPos</em> diff --git a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl index 54bf61b0c8c7..3737e154855e 100644 --- a/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl +++ b/offapi/com/sun/star/inspection/PropertyCategoryDescriptor.idl @@ -32,7 +32,7 @@ struct PropertyCategoryDescriptor { /** contains the programmatic name of the category. - <p>This programmatic name is used internally: <member>XPropertyHandler::describePropertyLine</member> + <p>This programmatic name is used internally: XPropertyHandler::describePropertyLine() sets a programmatic category name at <member>LineDescriptor::Category</member>, and an object inspector uses this to find the proper PropertyCategoryDescriptor.</p> */ diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index d27e7a82b68d..89f2bf8e2b0f 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -66,7 +66,7 @@ interface XObjectInspectorModel /** describes the property categories used by the property handlers. <p>Properties can be sorted into different categories, described by the <member>LineDescriptor::Category</member> - attribute, which is filled in <member>XPropertyHandler::describePropertyLine</member> + attribute, which is filled in XPropertyHandler::describePropertyLine() method of your property handler.<br/> Those names provided by the handlers are programmatic names. All other information about categories is part of the PropertyCategoryDescriptor, and @@ -103,7 +103,7 @@ interface XObjectInspectorModel <p>If for two different properties the same order index is returned, the ObjectInspector will assume the order in which those properties were provided by the respective property handler - (<member>XPropertyHandler::getSupportedProperties</member>).<br/> + (XPropertyHandler::getSupportedProperties()).<br/> If two such properties originate from different handlers, they will be ordered according to the order of the handlers, as provided in the <member>HandlerFactories</member> attribute.</p> diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index dd3e549d3965..070d8b80edab 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -90,7 +90,7 @@ interface XObjectInspectorUI <p>Note that the property whose UI should be rebuilt must not necessarily be (though usually <em>is</em>) in the responsibility of the handler which calls this method. The object inspector will look up the handler with the responsibility for <arg>PropertyName</arg> and call its - <member>XPropertyHandler::describePropertyLine</member></p> + XPropertyHandler::describePropertyLine()</p> @param PropertyName the name of the property whose UI is to be completely rebuilt. diff --git a/offapi/com/sun/star/inspection/XStringRepresentation.idl b/offapi/com/sun/star/inspection/XStringRepresentation.idl index 8191978dc898..9a0cde4d794d 100644 --- a/offapi/com/sun/star/inspection/XStringRepresentation.idl +++ b/offapi/com/sun/star/inspection/XStringRepresentation.idl @@ -34,7 +34,7 @@ interface XStringRepresentation The to-be-converted property value. @return The converted string representation of the property value. - @see <member>XPropertyHandler::convertToControlValue</member> + @see XPropertyHandler::convertToControlValue() */ string convertToControlValue([in]any PropertyValue) raises( com::sun::star::uno::Exception ); @@ -43,7 +43,7 @@ interface XStringRepresentation The to-be-converted control value. @param ControlValueType The target type of the conversion. - @see <member>XPropertyHandler::convertToPropertyValue</member> + @see XPropertyHandler::convertToPropertyValue() */ any convertToPropertyValue( [in]string ControlValue, diff --git a/offapi/com/sun/star/logging/CsvLogFormatter.idl b/offapi/com/sun/star/logging/CsvLogFormatter.idl index 8a1266173197..5e20170c6b13 100644 --- a/offapi/com/sun/star/logging/CsvLogFormatter.idl +++ b/offapi/com/sun/star/logging/CsvLogFormatter.idl @@ -28,7 +28,7 @@ interface XCsvLogFormatter; /** specifies a service which formats log records for RFC4180-style CSV-Files - <p>Every log record, as passed to <member>XCsvLogFormatter::format</member>, + <p>Every log record, as passed to XCsvLogFormatter::format(), will be formatted into a single row for a CSV file. The sequence number, the thread ID, the time of the logged event, the source class/method name will get logged alongside the message, if this diff --git a/offapi/com/sun/star/logging/PlainTextFormatter.idl b/offapi/com/sun/star/logging/PlainTextFormatter.idl index 1e316aeefc1c..16868d25e673 100644 --- a/offapi/com/sun/star/logging/PlainTextFormatter.idl +++ b/offapi/com/sun/star/logging/PlainTextFormatter.idl @@ -28,7 +28,7 @@ interface XLogFormatter; /** specifies a service which formats log records as single line plain text - <p>Every log record, as passed to <member>XLogFormatter::format</member>, will + <p>Every log record, as passed to XLogFormatter::format(), will be formatted into a single text line, assembling the sequence number, the thread ID, the time of the logged event, the source class/method name (if applicable), and the log message.</p> diff --git a/offapi/com/sun/star/mozilla/XPluginInstance.idl b/offapi/com/sun/star/mozilla/XPluginInstance.idl index 40730a67fde3..2221ed6a5b49 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstance.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstance.idl @@ -39,7 +39,7 @@ published interface XPluginInstance: com::sun::star::uno::XInterface /** Stops plugin operation. This is called when the user goes to another web - page. The <member>XPluginInstance::destroy</member> method is directly called + page. The XPluginInstance::destroy() method is directly called afterwards. */ void stop(); diff --git a/offapi/com/sun/star/rdf/BlankNode.idl b/offapi/com/sun/star/rdf/BlankNode.idl index e1a10972d7cd..9ab41dd74b02 100644 --- a/offapi/com/sun/star/rdf/BlankNode.idl +++ b/offapi/com/sun/star/rdf/BlankNode.idl @@ -43,7 +43,7 @@ service BlankNode : XBlankNode another node that already exists in some repository. That may or may not be what you want. If you want to create a new blank node that is guaranteed to be unique, - use <member>XRepository::createBlankNode</member> instead. + use XRepository::createBlankNode() instead. <p> @param NodeID diff --git a/offapi/com/sun/star/rdf/FileFormat.idl b/offapi/com/sun/star/rdf/FileFormat.idl index f19a4c9d7227..7a4bd33d776b 100644 --- a/offapi/com/sun/star/rdf/FileFormat.idl +++ b/offapi/com/sun/star/rdf/FileFormat.idl @@ -28,8 +28,8 @@ module com { module sun { module star { module rdf { <p> These constants are mainly for use with - <member>XRepository::importGraph</member> - and <member>XRepository::exportGraph</member>. + XRepository::importGraph() + and XRepository::exportGraph(). </p> <p> diff --git a/offapi/com/sun/star/rdf/URIs.idl b/offapi/com/sun/star/rdf/URIs.idl index 7777e9624d00..6172fa87717a 100644 --- a/offapi/com/sun/star/rdf/URIs.idl +++ b/offapi/com/sun/star/rdf/URIs.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module rdf { /** Constants to specify some well-known URIs. <p> - These constants are for use with <member>URI::createKnown</member>. + These constants are for use with URI::createKnown(). </p> @since OOo 3.2 diff --git a/offapi/com/sun/star/rdf/XDocumentRepository.idl b/offapi/com/sun/star/rdf/XDocumentRepository.idl index c5c001faf60c..d9d260ec7d4e 100644 --- a/offapi/com/sun/star/rdf/XDocumentRepository.idl +++ b/offapi/com/sun/star/rdf/XDocumentRepository.idl @@ -77,7 +77,7 @@ interface XDocumentRepository : XRepository RDFa statements are handled specially because they are not logically part of any named graph in the repository. Also, they have rather unusual semantics; - just using <member>XNamedGraph::addStatement</member> would be + just using XNamedGraph::addStatement() would be ambiguous: if the object is a XMetadatable, do we insert the object itself (URI) or its literal content (RDFa)? @@ -176,7 +176,7 @@ interface XDocumentRepository : XRepository <p> This method exists because RDFa statements are not part of any named graph, and thus they cannot be enumerated with - <member>XNamedGraph::getStatements</member>. + XNamedGraph::getStatements(). </p> <p> diff --git a/offapi/com/sun/star/rdf/XNamedGraph.idl b/offapi/com/sun/star/rdf/XNamedGraph.idl index c6cfc06b81a2..899829215515 100644 --- a/offapi/com/sun/star/rdf/XNamedGraph.idl +++ b/offapi/com/sun/star/rdf/XNamedGraph.idl @@ -40,7 +40,7 @@ module com { module sun { module star { module rdf { <p> Note that instances may be destroyed via - <member>XRepository::destroyGraph</member>. + XRepository::destroyGraph(). If a graph is destroyed, subsequent calls to addStatement(), removeStatements() will fail with an com::sun::star::container::NoSuchElementException. diff --git a/offapi/com/sun/star/rendering/XAnimatedSprite.idl b/offapi/com/sun/star/rendering/XAnimatedSprite.idl index a0c16c94db7a..1688c4a68357 100644 --- a/offapi/com/sun/star/rendering/XAnimatedSprite.idl +++ b/offapi/com/sun/star/rendering/XAnimatedSprite.idl @@ -42,7 +42,7 @@ interface XAnimatedSprite : XSprite The speed of the animation is given in cycles per second (where a cycle is defined as one full animation run, i.e. the - full [0,1] range of the <member>XAnimation::render</member>'s + full [0,1] range of the XAnimation::render()'s t parameter, or a full sequence of sprite bitmaps drawn). Once an animation is running, the associated XSpriteCanvas handles screen updates @@ -56,7 +56,7 @@ interface XAnimatedSprite : XSprite @param nSpeed The speed of the animation in cycles per second (where a cycle is defined as one full animation run, i.e. the full [0,1] - range of the <member>XAnimation::render</member>'s t + range of the XAnimation::render()'s t parameter, or a full sequence of sprite bitmaps drawn). */ void startAnimation( [in] double nSpeed ); @@ -64,7 +64,7 @@ interface XAnimatedSprite : XSprite /** Stop the animation sequence.<p> - A subsequent <member>XAnimatedSprite::startAnimation</member> + A subsequent XAnimatedSprite::startAnimation() will commence the sequence at the point where it was stopped with here. Once an animation is stopped, the associated XSpriteCanvas does not update changed sprites @@ -152,7 +152,7 @@ interface XAnimatedSprite : XSprite @param bUpdateAnimation Whether this method should implicitly call - <member>XSpriteCanvas::updateAnimation</member> or not. + XSpriteCanvas::updateAnimation() or not. @throws com::sun::star::lang::IllegalArgumentException if one of the passed parameters does not lie in the specified, diff --git a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl index c6eb20704280..b0fef8efc4ba 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl @@ -141,7 +141,7 @@ interface XIntegerBitmapColorSpace : XColorSpace @return the corresponding sequence of sRGB colors. - @see <member>XIntegerBitmapColorSpace::convertIntegerToARGB</member> + @see XIntegerBitmapColorSpace::convertIntegerToARGB() @throws a com::sun::star::lang::IllegalArgumentException, diff --git a/offapi/com/sun/star/rendering/XSprite.idl b/offapi/com/sun/star/rendering/XSprite.idl index 5db147915ce7..9e58de209960 100644 --- a/offapi/com/sun/star/rendering/XSprite.idl +++ b/offapi/com/sun/star/rendering/XSprite.idl @@ -92,7 +92,7 @@ interface XSprite : ::com::sun::star::uno::XInterface components, be aware that sprite content moved beyond the sprite area (a box from (0,0) to (spriteWidth,spriteHeight)) might (but need not) be clipped. Use - <member>XSprite::move</member> to change the sprite location + XSprite::move() to change the sprite location on screen. The canvas implementations are free, if they have a cached representation of the sprite at hand, to transform only this cached representation (e.g. a bitmap), instead of diff --git a/offapi/com/sun/star/rendering/XTextLayout.idl b/offapi/com/sun/star/rendering/XTextLayout.idl index 1296acc7284d..212ae5a3b574 100644 --- a/offapi/com/sun/star/rendering/XTextLayout.idl +++ b/offapi/com/sun/star/rendering/XTextLayout.idl @@ -156,7 +156,7 @@ interface XTextLayout : ::com::sun::star::uno::XInterface /** Query the overall bounding box of the text.<p> This method is similar to - <member>XTextLayout::queryTextMeasures</member>, only that the + XTextLayout::queryTextMeasures(), only that the overall bounds are returned by this method.<p> @return the overall bounding box for the given layout, in font diff --git a/offapi/com/sun/star/resource/OfficeResourceLoader.idl b/offapi/com/sun/star/resource/OfficeResourceLoader.idl index cd95fde87784..abad49a85b18 100644 --- a/offapi/com/sun/star/resource/OfficeResourceLoader.idl +++ b/offapi/com/sun/star/resource/OfficeResourceLoader.idl @@ -34,7 +34,7 @@ module com { module sun { module star { module resource { types of resources within those files.</p> <p>Clients have to specify the resource file base name in the call to - <member>XResourceBundleLoader::loadBundle</member> resp. <member>XResourceBundleLoader::loadBundle_Default</member> + XResourceBundleLoader::loadBundle() resp. XResourceBundleLoader::loadBundle_Default() method. The loader will extent this base name so that the resulting name conforms to the OpenOffice.org resource file naming conventions, and look up the respective resource file, for the requested locale, in OpenOffice.org's installation.</p> @@ -42,7 +42,7 @@ module com { module sun { module star { module resource { <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 + <p>Resource keys, as passed to the XResourceBundle::getDirectElement() or <member scope="com::sun::star::container">XNameAccess::getByName</member>, have the following format: <code><resource_type>:<numeric_identifier></code>, where <code><resource_type> specifies the type of the requested resource (see below) and <code><numeric_identifier></code> is the numeric diff --git a/offapi/com/sun/star/script/XLibraryContainer3.idl b/offapi/com/sun/star/script/XLibraryContainer3.idl index 6d522cf3649b..55b38a2d020e 100644 --- a/offapi/com/sun/star/script/XLibraryContainer3.idl +++ b/offapi/com/sun/star/script/XLibraryContainer3.idl @@ -36,8 +36,8 @@ published interface XLibraryContainer3: com::sun::star::script::XLibraryContaine returns the location of the library link target. The returned URL is literally the same as the one provided in - <member>XLibraryContainer::createLibraryLink</member>. Otherwise the behavior - is the same as <member>XLibraryContainer2::getLibraryLinkURL</member> + XLibraryContainer::createLibraryLink(). Otherwise the behavior + is the same as XLibraryContainer2::getLibraryLinkURL() */ string getOriginalLibraryLinkURL( [in] string Name ) raises( com::sun::star::lang::IllegalArgumentException, diff --git a/offapi/com/sun/star/script/vba/VBAEventId.idl b/offapi/com/sun/star/script/vba/VBAEventId.idl index a62959fd5ad6..f01cf84ad14a 100644 --- a/offapi/com/sun/star/script/vba/VBAEventId.idl +++ b/offapi/com/sun/star/script/vba/VBAEventId.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module script { module vba { document code module will be executed.</p> <p>Each event expects some specific arguments to be passed to - <member>XVBAEventProcessor::processVbaEvent</member>.</p> + XVBAEventProcessor::processVbaEvent().</p> @see XVBAEventProcessor */ diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl index e266a44706ac..d1f3ec7172a1 100644 --- a/offapi/com/sun/star/sdb/RowSet.idl +++ b/offapi/com/sun/star/sdb/RowSet.idl @@ -67,8 +67,8 @@ published interface XParametersSupplier; <tr><td valign="top"><em>approving</em></td> <td valign="top">Before anything really happens, any veto listeners are called to approve the operation which is just being done. This may be either a - <member>XRowSetApproveListener::approveCursorMove</member> or - <member>XRowSetApproveListener::approveRowChange</member> call. + XRowSetApproveListener::approveCursorMove() or + XRowSetApproveListener::approveRowChange() call. @see XRowSetApproveListener </td> </tr> @@ -83,7 +83,7 @@ published interface XParametersSupplier; <td valign="top">When the operation is done, you get a notification about this. It may be a <member scope="com::sun::star::sdbc">XRowSetListener::cursorMoved</member> or a <member scope="com::sun::star::sdbc">XRowSetListener::rowChanged</member> call or a - <member>XRowsChangeListener::rowsChanged</member> call. + XRowsChangeListener::rowsChanged() call. </td> </tr> <tr><td valign="top"><em>row state</em></td> diff --git a/offapi/com/sun/star/sdb/XDatabaseRegistrationsListener.idl b/offapi/com/sun/star/sdb/XDatabaseRegistrationsListener.idl index 7e4b8afb94b5..e6078e17b98f 100644 --- a/offapi/com/sun/star/sdb/XDatabaseRegistrationsListener.idl +++ b/offapi/com/sun/star/sdb/XDatabaseRegistrationsListener.idl @@ -48,7 +48,7 @@ published interface XDatabaseRegistrationsListener : ::com::sun::star::lang::XEv <p>Note that this talks about registration data only. That is, if the actual file denoted by the database registration is moved, this is in no way monitored or reported. Only (successful) calls to - <member>XDatabaseRegistrations::changeDatabaseLocation</member> are reported here.</p> + XDatabaseRegistrations::changeDatabaseLocation() are reported here.</p> */ void changedDatabaseLocation( [in] DatabaseRegistrationEvent Event ); }; diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index 1674f4500531..5f021f5995c7 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -189,13 +189,13 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer <p>An elementary query or statement is a (single select) statement whose parts are not covered by the various set and get methods of the composer. That is, if the elementary statement contains a filter clause, a call to - <member>XSingleSelectQueryAnalyzer::getFilter</member> will not return you this + XSingleSelectQueryAnalyzer::getFilter() will not return you this filter. Instead, only filters which have been set using for instance setFilter() are covered by the get methods.</p> <p>The only methods which take all parts of the elementary statement into account are - <member>XSingleSelectQueryAnalyzer::getQuery</member> and - <member>XSingleSelectQueryAnalyzer::getQueryWithSubstitution</member>, which always returns + XSingleSelectQueryAnalyzer::getQuery() and + XSingleSelectQueryAnalyzer::getQueryWithSubstitution(), which always returns the complete composed query.</p> <p>As a result, you can use the composer to build cumulative filter expressions. That @@ -214,14 +214,14 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer <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 - <member>XSingleSelectQueryAnalyzer::setQuery</member>, and retrieve the filter - part via <member>XSingleSelectQueryAnalyzer::getFilter</member>.</p> + XSingleSelectQueryAnalyzer::setQuery(), and retrieve the filter + part via XSingleSelectQueryAnalyzer::getFilter().</p> <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>) + filter, and propagate the resulting query (XSingleSelectQueryAnalyzer::getQuery()) to an SingleSelectQueryAnalyzer instance via - <member>XSingleSelectQueryAnalyzer::setQuery</member>.</p> + XSingleSelectQueryAnalyzer::setQuery().</p> */ [attribute] string ElementaryQuery { diff --git a/offapi/com/sun/star/sdbc/RowSet.idl b/offapi/com/sun/star/sdbc/RowSet.idl index 0f31cdeb0159..309c1bda42c7 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 RowSet, use this interface's <member>XRowSet::execute</member> + <p>To refresh the content of a RowSet, use this interface's XRowSet::execute() method.</p> */ interface XRowSet; diff --git a/offapi/com/sun/star/sheet/FormulaMapGroup.idl b/offapi/com/sun/star/sheet/FormulaMapGroup.idl index c4f42ba540c8..e089bfa59571 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroup.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroup.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sheet { /** Constants of bit masks used with - <member>XFormurmulaOpCodeMapper::getAvailableMappings</member> to + XFormurmulaOpCodeMapper::getAvailableMappings() to 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 diff --git a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl index c96a888da131..f16a0a57fe0f 100644 --- a/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl +++ b/offapi/com/sun/star/sheet/FormulaMapGroupSpecialOffset.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module sheet { /** Constants designating the offsets within the sequence returned by - <member>XFormulaOpCodeMapper::getAvailableMappings</member> when + XFormulaOpCodeMapper::getAvailableMappings() when called for group <const>FormulaMapGroup::SPECIAL</const>. <p>The number of constants may grow in future versions!</p> diff --git a/offapi/com/sun/star/sheet/SheetLink.idl b/offapi/com/sun/star/sheet/SheetLink.idl index 084cccd92bcc..14b45c3da3c1 100644 --- a/offapi/com/sun/star/sheet/SheetLink.idl +++ b/offapi/com/sun/star/sheet/SheetLink.idl @@ -35,7 +35,7 @@ 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 SheetLink + XSheetLinkable::link() creates a SheetLink object in the document's SheetLinks collection and links the sheet to the specified external sheet.</p> */ diff --git a/offapi/com/sun/star/sheet/XCompatibilityNames.idl b/offapi/com/sun/star/sheet/XCompatibilityNames.idl index 374e42c33ee6..281e2145730b 100644 --- a/offapi/com/sun/star/sheet/XCompatibilityNames.idl +++ b/offapi/com/sun/star/sheet/XCompatibilityNames.idl @@ -40,7 +40,7 @@ published interface XCompatibilityNames: com::sun::star::uno::XInterface compatibility names is used to find the internal name of the function. The current locale may differ from the locale used in the imported file, so the method - <member>XAddIn::getProgrammaticFuntionName</member> cannot be used + XAddIn::getProgrammaticFuntionName() cannot be used here.</p> <p>The order inside the sequence of compatibility names is used to diff --git a/offapi/com/sun/star/sheet/XDataPilotTables.idl b/offapi/com/sun/star/sheet/XDataPilotTables.idl index b25a7282f41c..20f804cf182a 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTables.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTables.idl @@ -44,7 +44,7 @@ published interface XDataPilotTables: com::sun::star::container::XNameAccess /** creates a data pilot descriptor. <p>This descriptor can be used with - <member>XDataPilotTables::addTable</member>.</p> + XDataPilotTables::addTable().</p> @see com::sun::star::sheet::DataPilotDescriptor */ diff --git a/offapi/com/sun/star/sheet/XPrintAreas.idl b/offapi/com/sun/star/sheet/XPrintAreas.idl index 9f9102f727a9..26306ddc4704 100644 --- a/offapi/com/sun/star/sheet/XPrintAreas.idl +++ b/offapi/com/sun/star/sheet/XPrintAreas.idl @@ -68,7 +68,7 @@ published interface XPrintAreas: com::sun::star::uno::XInterface <p>Title columns can be automatically repeated on all subsequent print pages to the right, using - <member>XPrintAreas::setPrintTitleColumns</member>.</p> + XPrintAreas::setPrintTitleColumns().</p> @returns the range of columns that is specified as title columns range. @@ -82,7 +82,7 @@ published interface XPrintAreas: com::sun::star::uno::XInterface <p>Title columns can be automatically repeated on all subsequent print pages to the right, using - <member>XPrintAreas::setPrintTitleColumns</member>.</p> + XPrintAreas::setPrintTitleColumns().</p> @param aTitleColumns the title columns range. @@ -109,7 +109,7 @@ published interface XPrintAreas: com::sun::star::uno::XInterface <p>Title rows can be automatically repeated on all subsequent print pages to the bottom, using - <member>XPrintAreas::setPrintTitleRows</member>.</p> + XPrintAreas::setPrintTitleRows().</p> @returns the range of rows that is specified as title rows range. @@ -123,7 +123,7 @@ published interface XPrintAreas: com::sun::star::uno::XInterface <p>Title rows can be automatically repeated on all subsequent print pages to the bottom, using - <member>XPrintAreas::setPrintTitleRows</member>.</p> + XPrintAreas::setPrintTitleRows().</p> @param aTitleRows the title rows range. diff --git a/offapi/com/sun/star/sheet/XSheetLinkable.idl b/offapi/com/sun/star/sheet/XSheetLinkable.idl index caec9d440596..49f7e5310cf7 100644 --- a/offapi/com/sun/star/sheet/XSheetLinkable.idl +++ b/offapi/com/sun/star/sheet/XSheetLinkable.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module sheet { /** enables a sheet to refer to another sheet in a different document. <p>To insert a sheet link, the sheet used as linked sheet has to exist - already. The method <member>XSheetLinkable::link</member> creates a + already. The method XSheetLinkable::link() creates a SheetLink object in the document's SheetLinks collection and links the sheet to the specified external sheet.</p> diff --git a/offapi/com/sun/star/style/XStyleLoader.idl b/offapi/com/sun/star/style/XStyleLoader.idl index c9fa61d06b96..77d67ec4cc6c 100644 --- a/offapi/com/sun/star/style/XStyleLoader.idl +++ b/offapi/com/sun/star/style/XStyleLoader.idl @@ -56,7 +56,7 @@ published interface XStyleLoader: com::sun::star::uno::XInterface raises( com::sun::star::io::IOException ); /** @returns - a sequence of the supported properties as declared in <member>XStyleLoader::loadStylesFromURL</member> + a sequence of the supported properties as declared in XStyleLoader::loadStylesFromURL() with their current values. */ sequence<com::sun::star::beans::PropertyValue> getStyleLoaderOptions(); diff --git a/offapi/com/sun/star/text/TextTable.idl b/offapi/com/sun/star/text/TextTable.idl index 2d30d85ab306..e807efd28e95 100644 --- a/offapi/com/sun/star/text/TextTable.idl +++ b/offapi/com/sun/star/text/TextTable.idl @@ -45,12 +45,12 @@ <p>Note: The anchor of the actual implementation for text tables does not have a position in the text. Thus that anchor can not be - used for some operation like <member>XTextContent::attach</member> or - <member>XText::insertTextContent</member> + used for some operation like XTextContent::attach() or + XText::insertTextContent() or other function that require the object to have a position in the text.</p> <p>The reason why a text table still needs an anchor is that for example - tables should be insertable via <member>XText::insertTextContent</member> + tables should be insertable via XText::insertTextContent() and that interface uses a parameter of that type.</p> @example diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 5f5a57e5386a..fc045394fcff 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -51,7 +51,7 @@ published service CachedDynamicResultSet with a source object. <p>The <var>Source</var> in - <member>XSourceInitialization::setSource</member> has to be an + XSourceInitialization::setSource() has to be an implementation of service CachedDynamicResultSetStub <p>This interface is required. diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 80c7fcd06f82..49c0bae01a21 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -52,7 +52,7 @@ published service CachedDynamicResultSetStub with a source object. <p>The <var>Source</var> in - <member>XSourceInitialization::setSource</member> has to be an + XSourceInitialization::setSource() has to be an implementation of service DynamicResultSet <p>This interface is required. diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index aafe79867ac9..745fd68b8258 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -826,9 +826,9 @@ published service Content /** is an enhanced version of <type>XCommandProcessor</type> that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index e8b2d16a2650..f10c8527ba3d 100644 --- a/offapi/com/sun/star/ucb/ContentInfo.idl +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -36,7 +36,7 @@ published struct ContentInfo <p>This is an implementation specific string characterizing the kind of a content (e.g. "application/vnd.sun.star.hierarchy-link"). The value of this member should match the value returned by - <member>XContent::getContentType</member> of an appropriate content. + XContent::getContentType() of an appropriate content. */ string Type; @@ -56,7 +56,7 @@ published struct ContentInfo /** This field contains a list with the properties which must be set at a content that was just created using - <member>XContentCreator::createNewContent</member> before it can be + XContentCreator::createNewContent() before it can be committed (by executing the command "insert" at the new content). <p>If one of the properties is missing, the insert command will fail. diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl index 257cf6bad600..27328f3ef949 100644 --- a/offapi/com/sun/star/ucb/ContentProvider.idl +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -49,7 +49,7 @@ published service ContentProvider <p>Whenever a ContentProvider that supports this interface is registered at a XContentProviderManager, the method - <member>XParameterizedContentProvider::registerInstance</member> + XParameterizedContentProvider::registerInstance() should first be called, using the returned XContentProvider to register at the XContentProviderManager. */ diff --git a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl index 9eb21e5d6f02..8e5ff313a62c 100644 --- a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl +++ b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl @@ -25,7 +25,7 @@ module com { module sun { module star { module ucb { -/** is thrown by <member>XCommandProcessor::execute</member> to indicate that +/** is thrown by XCommandProcessor::execute() to indicate that the same command identifier was used for two threads. <p>Each thread must use it's own command identifier, which must be obtained diff --git a/offapi/com/sun/star/ucb/FTPContent.idl b/offapi/com/sun/star/ucb/FTPContent.idl index 70d5af32e4a6..166a1d1a6b25 100644 --- a/offapi/com/sun/star/ucb/FTPContent.idl +++ b/offapi/com/sun/star/ucb/FTPContent.idl @@ -65,7 +65,7 @@ published service FTPContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new directories is "application/vnd.sun.staroffice.ftp-folder". To create a new file use the type "application/vnd.sun.staroffice.ftp-file". diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index d42f1e7258e1..06a9181fbf1b 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -24,7 +24,7 @@ module com { module sun { module star { module ucb { /** contains data of several rows of a ContentResultSet. - <p>This struct is returned from <member>XFetchProvider::fetch</member>, + <p>This struct is returned from XFetchProvider::fetch(), for example. */ diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index 69e61a477dff..2e9809bdbe93 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -66,7 +66,7 @@ published service FileContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new directories is "application/vnd.sun.staroffice.fsys-folder". To create a new file use the type "application/vnd.sun.staroffice.fsys-file". @@ -177,9 +177,9 @@ published service FileContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/HelpContent.idl b/offapi/com/sun/star/ucb/HelpContent.idl index 42f5422fc88b..7047c61dded0 100644 --- a/offapi/com/sun/star/ucb/HelpContent.idl +++ b/offapi/com/sun/star/ucb/HelpContent.idl @@ -128,9 +128,9 @@ published service HelpContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index e10b15bd9b35..2f6c5b87bb47 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -106,9 +106,9 @@ published service HierarchyFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -151,7 +151,7 @@ published service HierarchyFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.hier-folder". To create a new link, use the type "application/vnd.sun.star.hier-link". </li> diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 6c29f90f669b..a72cf7c667d0 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -104,9 +104,9 @@ published service HierarchyLinkContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index 5db0ee493b49..e0483ebac3f5 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -104,9 +104,9 @@ published service HierarchyRootFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -149,7 +149,7 @@ published service HierarchyRootFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.hier-folder". To create a new link, use the type "application/vnd.sun.star.hier-link". </li> diff --git a/offapi/com/sun/star/ucb/ODMAContent.idl b/offapi/com/sun/star/ucb/ODMAContent.idl index 3ba646259497..5f1a11ea1717 100644 --- a/offapi/com/sun/star/ucb/ODMAContent.idl +++ b/offapi/com/sun/star/ucb/ODMAContent.idl @@ -124,9 +124,9 @@ published service ODMAContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 0a2f157f877e..c38350b07dcd 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -119,9 +119,9 @@ published service PackageFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -164,7 +164,7 @@ published service PackageFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.pkg-folder". To create a new PCP Stream, use the type "application/vnd.sun.star.pkg-stream". diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 3d67c7f6bc74..f3a1c39020e7 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -119,9 +119,9 @@ published service PackageStreamContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/PersistentPropertySet.idl b/offapi/com/sun/star/ucb/PersistentPropertySet.idl index d6e829b62e1e..212f87cb2218 100644 --- a/offapi/com/sun/star/ucb/PersistentPropertySet.idl +++ b/offapi/com/sun/star/ucb/PersistentPropertySet.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module ucb { /** This service contains the interfaces to implement by objects - returned by <member>XPropertySetRegistry::openPropertySet</member>. + returned by XPropertySetRegistry::openPropertySet(). */ published service PersistentPropertySet { diff --git a/offapi/com/sun/star/ucb/PropertySetRegistry.idl b/offapi/com/sun/star/ucb/PropertySetRegistry.idl index 15a5c868f688..54f21471d9ba 100644 --- a/offapi/com/sun/star/ucb/PropertySetRegistry.idl +++ b/offapi/com/sun/star/ucb/PropertySetRegistry.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module ucb { /** This service contains the interfaces to implement by objects - returned by <member>XPropertySetRegistryFactory::createRegistry</member>. + returned by XPropertySetRegistryFactory::createRegistry(). */ published service PropertySetRegistry { diff --git a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl index 17a4d16d653e..0a50ea3c016f 100644 --- a/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteAccessContentProvider.idl @@ -40,7 +40,7 @@ published service RemoteAccessContentProvider to specify that certain XContentIdentifiers map to XContents from a certain remote UCB. The Arguments string in the - <member>XParameterizedContentProvider::registerInstance</member> + XParameterizedContentProvider::registerInstance() call must contain the UNO URL of the remote UCB. @descr diff --git a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl index 4363c8504e32..7f9969019419 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsDocumentContent.idl @@ -108,9 +108,9 @@ service TransientDocumentsDocumentContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -150,7 +150,7 @@ service TransientDocumentsDocumentContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.tdoc-folder". To create a new stream, use the type string "application/vnd.sun.star.tdoc-stream". diff --git a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl index 61d9fe53b82b..f9dd69144b52 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl @@ -118,9 +118,9 @@ service TransientDocumentsFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -160,7 +160,7 @@ service TransientDocumentsFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.tdoc-folder". To create a new stream, use the type string "application/vnd.sun.star.tdoc-stream". diff --git a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl index 271c9410626c..a8de4dd6cdb8 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsRootContent.idl @@ -103,9 +103,9 @@ service TransientDocumentsRootContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl index 89b95d7fbb05..0382a61a4301 100644 --- a/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl +++ b/offapi/com/sun/star/ucb/TransientDocumentsStreamContent.idl @@ -109,9 +109,9 @@ service TransientDocumentsStreamContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index ef3b1eacf91f..495c47866392 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -38,7 +38,7 @@ module com { module sun { module star { module ucb { does not necessarily mandate what type of data/content may be contained within Documents. The type of data/content is defined by the MediaType property which is different from the content type returned from the - <member>XContent::getContentType</member> method. The MediaType property + XContent::getContentType() method. The MediaType property is mapped to the equivalent WebDAV property and the WebDAV server calculates the value. @@ -124,9 +124,9 @@ published service WebDAVDocumentContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index 0426737b3e4c..0c762a61a26d 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -118,9 +118,9 @@ published service WebDAVFolderContent /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>Where many existing Content implementations do not (yet), every new implementation should support this interface. @@ -163,7 +163,7 @@ published service WebDAVFolderContent <ol> <li> Let the parent folder create a new content by calling - <member>XContentCreator::createNewContent</member> on it. The content + XContentCreator::createNewContent() on it. The content type to use for new folders is "application/vnd.sun.star.webdav-collection". To create a new DCP Document, use the type "application/http-content". diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 236006e1d639..5696f6a2f434 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -35,7 +35,7 @@ module com { module sun { module star { module ucb { DynamicResultSet was instantiated. <p>Method - <member>XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub</member> + XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub() can be used to create a stub on server side. <p>If you have instantiated a CachedDynamicResultSet on client diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index 1edf2ca3cea4..dc4e718d5a33 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor.idl @@ -53,15 +53,15 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface only should get one identifier per thread and assign it to every command executed by that thread.</p> - <p>Also, after a call to <member>XCommandProcessor::abort</member>, an + <p>Also, after a call to XCommandProcessor::abort(), an identifier should not be used any longer (and instead be released by a - call to <member>XCommandProcessor2::releaseCommandIdentifier</member>), + call to XCommandProcessor2::releaseCommandIdentifier()), because it may well abort <em>all</em> further calls to - <member>XCommandProcessor::execute</member>.</p> + XCommandProcessor::execute().</p> <p>To avoid ever-increasing resource consumption, the identifier should be released via - <member>XCommandProcessor2::releaseCommandIdentifier</member> + XCommandProcessor2::releaseCommandIdentifier() when it is no longer used.</p> @returns @@ -79,14 +79,14 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface @param CommandId is a unique id for the command. This identifier was obtained by calling - <member>XCommandProcessor::createCommandIdentifier</member>. A value of + XCommandProcessor::createCommandIdentifier(). A value of 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 XCommandProcessor, obtains exactly one identifier - using <member>XCommandProcessor::createCommandIdentifier</member>. + using XCommandProcessor::createCommandIdentifier(). This identifier can be used for every call to - <member>XCommandProcessor::execute</member> done by that thread. + XCommandProcessor::execute() done by that thread. @param Environment is the execution environment. @@ -116,7 +116,7 @@ published interface XCommandProcessor : com::sun::star::uno::XInterface @param CommandId is a unique id for the command to abort. This must be the identifier - passed to <member>XCommandProcessor::execute</member> for the command + passed to XCommandProcessor::execute() for the command to abort. */ void abort( [in] long CommandId ); diff --git a/offapi/com/sun/star/ucb/XCommandProcessor2.idl b/offapi/com/sun/star/ucb/XCommandProcessor2.idl index a1c8585bd735..0ad842e92ff0 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor2.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor2.idl @@ -31,22 +31,22 @@ module com { module sun { module star { module ucb { published interface XCommandProcessor2: com::sun::star::ucb::XCommandProcessor { /** releases a command identifier obtained through - <member>XCommandProcessor::createCommandIdentifier</member> when it is + XCommandProcessor::createCommandIdentifier() when it is no longer used. <p>After this call the command identifier cannot be used any longer in - calls to <member>XCommandProcessor::execute</member> and - <member>XCommandProcessor::abort</member>. (But it can happen that a - call to <member>XCommandProcessor::createCommandIdentifier</member> + calls to XCommandProcessor::execute() and + XCommandProcessor::abort(). (But it can happen that a + call to XCommandProcessor::createCommandIdentifier() reuses this identifier.)</p> @param CommandId A command identifier obtained through - <member>XCommandProcessor::createCommandIdentifier</member>. If the + XCommandProcessor::createCommandIdentifier(). If the identifier is zero, the request is silently ignored; but if the identifier is invalid (not obtained via - <member>XCommandProcessor::createCommandIdentifier</member> or already - handed to <member>XCommandProcessor2::releaseCommandIdentifier</member> + XCommandProcessor::createCommandIdentifier() or already + handed to XCommandProcessor2::releaseCommandIdentifier() before), the behavior is undefined. */ void releaseCommandIdentifier([in] long CommandId); diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 7f30e131a66a..36627b5570d4 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -44,7 +44,7 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface the content provider to register. <p>This may be <NULL/>, in which case a later - <member>XContentProvider::queryContent</member> with an + XContentProvider::queryContent() with an 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 diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index 83091aa88b9c..6fd0d57a10d9 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -59,7 +59,7 @@ module com { module sun { module star { module ucb { </p> <p> - The calling of <member>XDynamicResultSetListener::notify</member> has + The calling of XDynamicResultSetListener::notify() has to happen in an own thread, because it could take a longer time and any actions ??? until the listener returns the call. So don't block the notify-causing action. @@ -102,9 +102,9 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @trows ListenerAlreadySetException if someone already has registered as listener via - <member>XDynamicResultSet::setListener</member> or if someone has + XDynamicResultSet::setListener() or if someone has established a connection to a CachedDynamicResultSet - via <member>XDynamicResultSet::connectToCache</member>. + via XDynamicResultSet::connectToCache(). */ com::sun::star::sdbc::XResultSet getStaticResultSet() raises( com::sun::star::ucb::ListenerAlreadySetException ); @@ -124,7 +124,7 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent 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 ContentResultSet via - <member>XDynamicResultSet::getStaticResultSet</member>. + XDynamicResultSet::getStaticResultSet(). */ void setListener( [in] XDynamicResultSetListener Listener ) @@ -146,7 +146,7 @@ published interface XDynamicResultSet: com::sun::star::lang::XComponent @throws ListenerAlreadySetException if if someone already has fetched the ContentResultSet via - <member>XDynamicResultSet::getStaticResultSet</member>. + XDynamicResultSet::getStaticResultSet(). @throws AlreadyInitializedException if <var>Cache</var> was already initialized with another source. diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index 3ccc8b8bd828..c5d719b1f048 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -42,7 +42,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetRealm</member> returned + XInteractionSupplyAuthentication::canSetRealm() returned <true/>.</p> */ void setRealm( [in] string Realm ); @@ -56,7 +56,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetUserName</member> + XInteractionSupplyAuthentication::canSetUserName() returned <true/>.</p> */ void setUserName( [in] string UserName ); @@ -70,7 +70,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetPassword</member> + XInteractionSupplyAuthentication::canSetPassword() returned <true/>.</p> */ void setPassword( [in] string Password ); @@ -92,12 +92,12 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::setPassword</member> + XInteractionSupplyAuthentication::setPassword() is also called.</p> @param Remember The mode to hand back, should be contained in the sequence returned by - <member>XInteractionSupplyAuthentication::getRememberPasswordModes</member>. + XInteractionSupplyAuthentication::getRememberPasswordModes(). */ void setRememberPassword( [in] com::sun::star::ucb::RememberAuthentication Remember ); @@ -110,7 +110,7 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::canSetAccount</member> + XInteractionSupplyAuthentication::canSetAccount() returned <true/>.</p> */ @@ -132,12 +132,12 @@ published interface XInteractionSupplyAuthentication: com::sun::star::task::XInt <p>This method should be called before <member scope="com::sun::star::task">XInteractionContinuation::select</member>, and should only be called if - <member>XInteractionSupplyAuthentication::setAccount</member> + XInteractionSupplyAuthentication::setAccount() is also called.</p> @param Remember The mode to hand back, should be contained in the sequence returned by - <member>XInteractionSupplyAuthentication::getRememberAccountModes</member>. + XInteractionSupplyAuthentication::getRememberAccountModes(). */ void setRememberAccount( [in] com::sun::star::ucb::RememberAuthentication Remember ); diff --git a/offapi/com/sun/star/ucb/XProgressHandler.idl b/offapi/com/sun/star/ucb/XProgressHandler.idl index 3bbc55d04b4a..170a8670c65e 100644 --- a/offapi/com/sun/star/ucb/XProgressHandler.idl +++ b/offapi/com/sun/star/ucb/XProgressHandler.idl @@ -35,12 +35,12 @@ published interface XProgressHandler: com::sun::star::uno::XInterface @param Status An object representing the new activity. There has to be an agreement between caller and callee of methods - <member>XProgressHandler::push</member> and - <member>XProgressHandler::update</member> as to which Status + XProgressHandler::push() and + XProgressHandler::update() as to which Status arguments are meaningful. For example, a <atom>string</atom> argument - to <member>XProgressHandler::push</member> should be used to transport + to XProgressHandler::push() should be used to transport some status text that describes the progress being made (possibly - followed by one or more <member>XProgressHandler::update</member>s with + followed by one or more XProgressHandler::update()s with <atom>string</atom> arguments, if the appropriate status text changes as progress is being made). */ @@ -50,7 +50,7 @@ published interface XProgressHandler: com::sun::star::uno::XInterface progress. @param Status An object representing the progress made. See the - documentation of <member>XProgressHandler::push</member> for more + documentation of XProgressHandler::push() for more information. */ void update([in] any Status); diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 2b4f77621fb7..436d1038fad7 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -51,7 +51,7 @@ published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterf can---through this callback---tell the calling side that the implementation no longer needs the remote content provider. (And the calling side should call - <member>XRemoteContentProviderAcceptor::removeRemoteContentProvider</member> + XRemoteContentProviderAcceptor::removeRemoteContentProvider() then.) To enable connection control, it is recommended that this argument diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl index a8b96f053f7a..b68c4bfeb5f5 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module ucb { /** This interface should be implemented together with XRemoteContentProviderAcceptor and allows for a lazy implementation of - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. + XRemoteContentProviderAcceptor::addRemoteContentProvider(). The way this works might change, therefore this interface is marked as deprecated. @@ -40,11 +40,11 @@ published interface XRemoteContentProviderActivator: com::sun::star::uno::XInter { /** Activate (i.e., register at the broker) the remote content providers that until now have only been remembered by - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>, + XRemoteContentProviderAcceptor::addRemoteContentProvider(), but not registered. <p>This allows for - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member> + XRemoteContentProviderAcceptor::addRemoteContentProvider() 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 diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index 16ef09f2c0a6..e06ef8085e42 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -49,7 +49,7 @@ published interface XRemoteContentProviderChangeNotifier: @param Listener. Some listener previously added via - <member>XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener</member>. + XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener(). */ void removeRemoteContentProviderChangeListener( diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl index e74fe21af5c4..daecd63f8cc7 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl @@ -33,7 +33,7 @@ module com { module sun { module star { module ucb { <p>This interface should be supported by the <var>DoneListener</var> parameter of - <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. + XRemoteContentProviderAcceptor::addRemoteContentProvider(). @version 1.0 @author Stephan Bergmann diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index d7a11dcb74db..974f4eee0591 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -193,7 +193,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface 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. + XSimpleFileAccess2::writeFile() may be used. */ com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); @@ -210,7 +210,7 @@ published interface XSimpleFileAccess: com::sun::star::uno::XInterface 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. + XSimpleFileAccess2::writeFile() may be used. */ com::sun::star::io::XStream openFileReadWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); diff --git a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl index 20a38f589097..4d971316243b 100644 --- a/offapi/com/sun/star/ucb/XUniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/XUniversalContentBroker.idl @@ -77,9 +77,9 @@ published interface XUniversalContentBroker Is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via - <member>XCommandProcessor::createCommandIdentifier</member> to avoid + XCommandProcessor::createCommandIdentifier() to avoid resource leaks. For a detailed description of the problem refer to - <member>XCommandProcessor2::releaseCommandIdentifier</member>. + XCommandProcessor2::releaseCommandIdentifier(). <p>This interface is required. diff --git a/offapi/com/sun/star/ui/ConfigurableUIElement.idl b/offapi/com/sun/star/ui/ConfigurableUIElement.idl index 34005ca25b8a..5d23dd400071 100644 --- a/offapi/com/sun/star/ui/ConfigurableUIElement.idl +++ b/offapi/com/sun/star/ui/ConfigurableUIElement.idl @@ -85,7 +85,7 @@ service ConfigurableUIElement <p> If the property <member>Persistent</member> is <TRUE/> changes on the structure of the user interface element are written back to configuration source. When this property is - changed, afterwards <member>XUIElementSettings::updateSettings</member> must be called so + changed, afterwards XUIElementSettings::updateSettings() must be called so the user interface element tries to retrieve its settings from the new user interface configuration manager. </p> diff --git a/offapi/com/sun/star/ui/XContextMenuInterception.idl b/offapi/com/sun/star/ui/XContextMenuInterception.idl index 8b5a1afef2c7..881cf2d01922 100644 --- a/offapi/com/sun/star/ui/XContextMenuInterception.idl +++ b/offapi/com/sun/star/ui/XContextMenuInterception.idl @@ -36,7 +36,7 @@ published interface XContextMenuInterception : ::com::sun::star::uno::XInterface void registerContextMenuInterceptor( [in]XContextMenuInterceptor Interceptor); /** removes an XContextMenuInterceptor which was previously registered - using <member>XContextMenuInterception::registerContextMenuInterceptor</member>. + using XContextMenuInterception::registerContextMenuInterceptor(). <p>The order of removals is arbitrary. It is not necessary to remove the last registered interceptor first.</p> diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl index 78a2b8671fb3..9ffec02bb7d4 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizard.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -62,7 +62,7 @@ interface XWizardPage; Disabled pages are skipped during sequential traveling, and not selectable in the roadmap.</p> <p>The state of the <em>Next</em> button in the dialog will be automatically maintained in most situations, - depending on the results of calls to the <member>XWizardController::canAdvance</member> and <member>XWizardPage::canAdvance</member> + depending on the results of calls to the XWizardController::canAdvance() and XWizardPage::canAdvance() methods. More sophisticated wizard logic, however, will need manual calls to the enableButton() method. Also, the <em>Finish</em> button needs to be maintained by the wizard's controller, too, as it cannot be decided generically in which situations it should be enabled or disabled.</p> @@ -145,7 +145,7 @@ interface XWizard /** updates the wizard elements which are related to traveling. - <p>For instance, the <em>Next</em> button is disabled if the current page's <member>XWizardPage::canAdvance</member> + <p>For instance, the <em>Next</em> button is disabled if the current page's XWizardPage::canAdvance() method returns <FALSE/>.</p> <p>You usually call this method from within a wizard page whose state changed in a way that it affects the @@ -185,7 +185,7 @@ interface XWizard However, if your current state is <code>2</code>, then you can not switch to the second path anymore.</p> @param PathIndex - the index of the path, as used in the <member>Wizard::createMultiplePathsWizard</member> constructor. + the index of the path, as used in the Wizard::createMultiplePathsWizard() constructor. @param Final <p>If <TRUE/>, the path will be completely activated, even if it is a conflicting path (i.e. there is another path which shares the first <code>k</code> states with the to-be-activated path.)</p> diff --git a/offapi/com/sun/star/util/AtomClassRequest.idl b/offapi/com/sun/star/util/AtomClassRequest.idl index 142d6ec60a93..bafae07ac4dd 100644 --- a/offapi/com/sun/star/util/AtomClassRequest.idl +++ b/offapi/com/sun/star/util/AtomClassRequest.idl @@ -35,11 +35,11 @@ module util published struct AtomClassRequest { /** the class of the atoms described in member - <member>AtomClassRequest::atoms</member>. + AtomClassRequest::atoms(). */ long atomClass; - /** the atoms requested from class <member>AtomClassRequest::atomClass</member>. + /** the atoms requested from class AtomClassRequest::atomClass(). */ sequence< long > atoms; }; diff --git a/offapi/com/sun/star/util/SearchFlags.idl b/offapi/com/sun/star/util/SearchFlags.idl index 9643331d7d87..c3d409a3d83d 100644 --- a/offapi/com/sun/star/util/SearchFlags.idl +++ b/offapi/com/sun/star/util/SearchFlags.idl @@ -32,7 +32,7 @@ published constants SearchFlags @deprecated The constant ALL_IGNORE_CASE is never supported - use <const scope="com::sun::star::i18n">TransliterationModules::IGNORE_CASE</const> with - <member>SearchOptions::transliterateFlags</member> + SearchOptions::transliterateFlags() instead. @see com::sun::star::i18n::TransliterationModules diff --git a/offapi/com/sun/star/util/XURLTransformer.idl b/offapi/com/sun/star/util/XURLTransformer.idl index 4465926bdb05..9be4f6306b57 100644 --- a/offapi/com/sun/star/util/XURLTransformer.idl +++ b/offapi/com/sun/star/util/XURLTransformer.idl @@ -87,7 +87,7 @@ published interface XURLTransformer: com::sun::star::uno::XInterface @param aURL the URL which contains alls necessary information in a structured form. The member <member>URL::Complete</member> contains the URL in string notation after - the operation finished successfully. Otherwise the content of <member>URL::complete</member> + the operation finished successfully. Otherwise the content of URL::complete() is not defined. @returns diff --git a/offapi/com/sun/star/xforms/XSubmission.idl b/offapi/com/sun/star/xforms/XSubmission.idl index 31f007a7aee4..ea070392bec6 100644 --- a/offapi/com/sun/star/xforms/XSubmission.idl +++ b/offapi/com/sun/star/xforms/XSubmission.idl @@ -45,7 +45,7 @@ interface XSubmission /** allows the submission to be associated with certain form controls <p>Calling the <member scope="com::sun::star::form::submission">XSubmission::submit</member> - yields exactly the same result as calling <member>XModel::submit</member> of the model which + yields exactly the same result as calling XModel::submit() of the model which the submission belongs to, passing the ID of the submission.</p> */ interface com::sun::star::form::submission::XSubmission; diff --git a/offapi/com/sun/star/xml/sax/XFastParser.idl b/offapi/com/sun/star/xml/sax/XFastParser.idl index f0742290ffff..5bdf4463d186 100644 --- a/offapi/com/sun/star/xml/sax/XFastParser.idl +++ b/offapi/com/sun/star/xml/sax/XFastParser.idl @@ -52,7 +52,7 @@ module com { module sun { module star { module xml { module sax { <p>Parsing starts with calling parseStream(). If the parser finds a valid XML file with the given InputSource, it calls - <member>XFastDocumentHandler::startDocument</member> first. + XFastDocumentHandler::startDocument() first. <p>This parser generates either "fast" events that use integer token values for namespaces, elements and attributes or "unknown" events for @@ -73,8 +73,8 @@ module com { module sun { module star { module xml { module sax { <p>For each element the parser sends a create child element event to the elements parent context by calling - <member>XFastContextHandler::createFastChildContext</member> for known - elements or <member>XFastContextHandler::createUnknownChildContext</member> + XFastContextHandler::createFastChildContext() for known + elements or XFastContextHandler::createUnknownChildContext() for unknown elements. <br>The parent context for the root element is the XFastDocumentHandler itself. @@ -83,12 +83,12 @@ module com { module sun { module star { module xml { module sax { the element and all of its children are created. <p>If a valid context is returned this context gets a start event by a call to - <member>XFastContextHandler::startFastElement</member> for known elements or - <member>XFastContextHandler::startUnknownElement</member> for unknown elements. + XFastContextHandler::startFastElement() for known elements or + XFastContextHandler::startUnknownElement() for unknown elements. <p>After processing all its child elements the context gets an end event by a call to - <member>XFastContextHandler::endFastElement</member> for known elements or - <member>XFastContextHandler::endUnknownElement</member> for unknown elements. + XFastContextHandler::endFastElement() for known elements or + XFastContextHandler::endUnknownElement() for unknown elements. <p>It is valid to return one instance of XFastContextHandler more than once. It is even possible to only use the XFastDocumentHandler @@ -96,7 +96,7 @@ module com { module sun { module star { module xml { module sax { <p>After the last element is processed the parser generates an end document event at the XFastDocumentHandler by calling - <member>XFastDocumentHandler::endDocument</member>. + XFastDocumentHandler::endDocument(). @see http://wiki.services.openoffice.org/wiki/FastParser */ |