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

*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
üst b352a8bf
......@@ -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;
......
......@@ -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()
......
......@@ -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
......
......@@ -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.
......
......@@ -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.
......
......@@ -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>
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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>
......
......@@ -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>
......
......@@ -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
*/
......
......@@ -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 >
......
......@@ -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>
......
......@@ -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;
......
......@@ -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
......
......@@ -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();
......
......@@ -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 );
......
......@@ -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,
......
......@@ -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
......
......@@ -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();
......
......@@ -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
{
......
......@@ -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>
......
......@@ -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;
};
......
......@@ -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>
......
......@@ -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;
......
......@@ -31,7 +31,7 @@ module chart2
{
/** parameters that may be passed to
<member>XChartTypeTemplate::createDiagramByDataSource</member>.
XChartTypeTemplate::createDiagramByDataSource().
*/
service StandardDiagramCreationParameters
{
......
......@@ -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();
};
......
......@@ -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,
......
......@@ -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
......
......@@ -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>
*/
......