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

*api: convert <arg>

... which does not seem to do anything anyway.

sed -i "s,<arg>\([^<]\+\)</arg>,\1,g"

Change-Id: I90bcf81ea046bc88297ed8eadc560ad31d19830b
üst d11a7b5e
...@@ -152,7 +152,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface ...@@ -152,7 +152,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
@return @return
Returns the explicitly or implicitly (empty Returns the explicitly or implicitly (empty
<arg>aRequestedAttributes</arg> argument) requested attributes aRequestedAttributes argument) requested attributes
of the specified character. Each attribute is represented by a of the specified character. Each attribute is represented by a
::com::sun::star::beans::PropertyValue ::com::sun::star::beans::PropertyValue
object. The returned list of attribute descriptions contains object. The returned list of attribute descriptions contains
......
...@@ -116,7 +116,7 @@ published interface XMutableGridDataModel : XGridDataModel ...@@ -116,7 +116,7 @@ published interface XMutableGridDataModel : XGridDataModel
<p>The change in the data model will be notified to registered listeners via <p>The change in the data model will be notified to registered listeners via
XGridDataListener::dataChanged(). The GridDataEvent::FirstColumn and XGridDataListener::dataChanged(). The GridDataEvent::FirstColumn and
GridDataEvent::LastColumn will denote the smallest respectively largest column GridDataEvent::LastColumn will denote the smallest respectively largest column
index from <arg>ColumnIndexes</arg>.</p> index from ColumnIndexes.</p>
@param ColumnIndexes @param ColumnIndexes
contains the column indexes of the cells, which should be updated contains the column indexes of the cells, which should be updated
......
...@@ -79,7 +79,7 @@ interface XDocumentEventBroadcaster ...@@ -79,7 +79,7 @@ interface XDocumentEventBroadcaster
supplemental information related to the event. supplemental information related to the event.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>_EventName</arg> is empty, or if <arg>_EventName</arg> is not supported by the if _EventName is empty, or if _EventName is not supported by the
document implementation. document implementation.
@throws ::com::sun::star::lang::NoSupportException @throws ::com::sun::star::lang::NoSupportException
......
...@@ -51,7 +51,7 @@ published interface XGridColumnFactory: com::sun::star::uno::XInterface ...@@ -51,7 +51,7 @@ published interface XGridColumnFactory: com::sun::star::uno::XInterface
the new column object the new column object
@throws com::sun::star::lang::IllegalArgumentException @throws com::sun::star::lang::IllegalArgumentException
if <arg>aColumnType</arg> is not available. if aColumnType is not available.
*/ */
com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType ) com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType )
raises( com::sun::star::lang::IllegalArgumentException ); raises( com::sun::star::lang::IllegalArgumentException );
......
...@@ -64,8 +64,8 @@ service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObject ...@@ -64,8 +64,8 @@ service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObject
section. section.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative, if minHelpTextLines or maxHelpTextLines are negative,
or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>. or if minHelpTextLines is greater than maxHelpTextLines.
@see XObjectInspectorModel::HasHelpSection @see XObjectInspectorModel::HasHelpSection
@see XObjectInspectorModel::MinHelpTextLines @see XObjectInspectorModel::MinHelpTextLines
......
...@@ -128,7 +128,7 @@ interface XFilterController ...@@ -128,7 +128,7 @@ interface XFilterController
and smaller than #FilterComponents. and smaller than #FilterComponents.
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if <arg>_Component</arg> is out of the allowed range. if _Component is out of the allowed range.
@see ::com::sun::star::form::component::DataAwareControlModel::BoundField @see ::com::sun::star::form::component::DataAwareControlModel::BoundField
*/ */
...@@ -151,7 +151,7 @@ interface XFilterController ...@@ -151,7 +151,7 @@ interface XFilterController
#DisjunctiveTerms. #DisjunctiveTerms.
@throws ::com::sun::star::lang::IndexOutOfBoundsException @throws ::com::sun::star::lang::IndexOutOfBoundsException
if <arg>_Term</arg> is out of the allowed range. if _Term is out of the allowed range.
*/ */
void void
removeDisjunctiveTerm( [in] long _Term ) removeDisjunctiveTerm( [in] long _Term )
......
...@@ -78,7 +78,7 @@ service ObjectInspector : XObjectInspector ...@@ -78,7 +78,7 @@ service ObjectInspector : XObjectInspector
/** creates an instance of the ObjectInspector, using a given ObjectInspectorModel /** creates an instance of the ObjectInspector, using a given ObjectInspectorModel
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>Model</arg> is <NULL/>. if Model is <NULL/>.
@since OOo 2.2 @since OOo 2.2
*/ */
......
...@@ -76,11 +76,11 @@ service ObjectInspectorModel : XObjectInspectorModel ...@@ -76,11 +76,11 @@ service ObjectInspectorModel : XObjectInspectorModel
section. section.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>handlerFactories</arg> is empty. if handlerFactories is empty.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative, if minHelpTextLines or maxHelpTextLines are negative,
or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>. or if minHelpTextLines is greater than maxHelpTextLines.
@see XObjectInspectorModel::HandlerFactories @see XObjectInspectorModel::HandlerFactories
@see XObjectInspectorModel::HasHelpSection @see XObjectInspectorModel::HasHelpSection
......
...@@ -110,7 +110,7 @@ interface XObjectInspectorModel ...@@ -110,7 +110,7 @@ interface XObjectInspectorModel
@param PropertyName @param PropertyName
the property whose global order index should be retrieved the property whose global order index should be retrieved
@return @return
the global order index of <arg>PropertyName</arg>. the global order index of PropertyName.
*/ */
long getPropertyOrderIndex( [in] string PropertyName ); long getPropertyOrderIndex( [in] string PropertyName );
......
...@@ -71,7 +71,7 @@ interface XObjectInspectorUI ...@@ -71,7 +71,7 @@ interface XObjectInspectorUI
this does mean that this element's state is not affected by the call - it does this does mean that this element's state is not affected by the call - it does
<em>not</em> mean that it is disabled. <em>not</em> mean that it is disabled.
@param Enable @param Enable
<TRUE/> if the elements denoted by <arg>_nElements</arg> should be enabled, <FALSE/> if <TRUE/> if the elements denoted by _nElements should be enabled, <FALSE/> if
they should be disabled. they should be disabled.
*/ */
void enablePropertyUIElements( void enablePropertyUIElements(
...@@ -89,7 +89,7 @@ interface XObjectInspectorUI ...@@ -89,7 +89,7 @@ interface XObjectInspectorUI
<p>Note that the property whose UI should be rebuilt must not necessarily be (though usually <em>is</em>) <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 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 handler with the responsibility for PropertyName and call its
XPropertyHandler::describePropertyLine()</p> XPropertyHandler::describePropertyLine()</p>
@param PropertyName @param PropertyName
......
...@@ -55,7 +55,7 @@ interface XPropertyControlFactory ...@@ -55,7 +55,7 @@ interface XPropertyControlFactory
a control of the given type. a control of the given type.
@throws com::sun::star::lang::IllegalArgumentException @throws com::sun::star::lang::IllegalArgumentException
if the given <arg>ControlType</arg> is not a value PropertyControlType if the given ControlType is not a value PropertyControlType
*/ */
XPropertyControl createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly ) XPropertyControl createPropertyControl( [in] short ControlType, [in] boolean CreateReadOnly )
raises ( com::sun::star::lang::IllegalArgumentException ); raises ( com::sun::star::lang::IllegalArgumentException );
......
...@@ -112,7 +112,7 @@ interface XPropertyHandler ...@@ -112,7 +112,7 @@ interface XPropertyHandler
@throws com::sun::star::beans::UnknownPropertyException @throws com::sun::star::beans::UnknownPropertyException
if the given property is not supported by this handler if the given property is not supported by this handler
@throws com::sun::star::lang::NullPointerException @throws com::sun::star::lang::NullPointerException
if <arg>ControlFactory</arg> is <NULL/>. if ControlFactory is <NULL/>.
@see PropertyControlType @see PropertyControlType
@see LineDescriptor @see LineDescriptor
*/ */
...@@ -344,7 +344,7 @@ interface XPropertyHandler ...@@ -344,7 +344,7 @@ interface XPropertyHandler
@param out_Data @param out_Data
If the method returns InteractiveSelectionResult::ObtainedValue, If the method returns InteractiveSelectionResult::ObtainedValue,
then <arg>out_Data</arg> contains the value which has been interactively obtained then out_Data contains the value which has been interactively obtained
from the user, and which still needs to be set at the inspected component. from the user, and which still needs to be set at the inspected component.
@param InspectorUI @param InspectorUI
...@@ -359,7 +359,7 @@ interface XPropertyHandler ...@@ -359,7 +359,7 @@ interface XPropertyHandler
@throws com::sun::star::beans::UnknownPropertyException @throws com::sun::star::beans::UnknownPropertyException
if the given property is not supported by the property handler if the given property is not supported by the property handler
@throws com::sun::star::lang::NullPointerException @throws com::sun::star::lang::NullPointerException
if <arg>InspectorUI</arg> is <NULL/> if InspectorUI is <NULL/>
@see describePropertyLine @see describePropertyLine
@see addPropertyChangeListener @see addPropertyChangeListener
...@@ -396,9 +396,9 @@ interface XPropertyHandler ...@@ -396,9 +396,9 @@ interface XPropertyHandler
<br/> <br/>
In some cases it may be necessary to differentiate between both situations. For instance, In some cases it may be necessary to differentiate between both situations. For instance,
if you want to set the value of another property when an actuating property's value changed, if you want to set the value of another property when an actuating property's value changed,
you should definitely not do this when <arg>FirstTimeInit</arg> is <TRUE/>. you should definitely not do this when FirstTimeInit is <TRUE/>.
@throws com::sun::star::lang::NullPointerException @throws com::sun::star::lang::NullPointerException
if <arg>InspectorUI</arg> is <NULL/> if InspectorUI is <NULL/>
*/ */
void void
actuatingPropertyChanged( actuatingPropertyChanged(
......
...@@ -59,8 +59,8 @@ service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInsp ...@@ -59,8 +59,8 @@ service DefaultComponentInspectorModel : com::sun::star::inspection::XObjectInsp
section. section.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>minHelpTextLines</arg> or <arg>maxHelpTextLines</arg> are negative, if minHelpTextLines or maxHelpTextLines are negative,
or if <arg>minHelpTextLines</arg> is greater than <arg>maxHelpTextLines</arg>. or if minHelpTextLines is greater than maxHelpTextLines.
@see XObjectInspectorModel::HasHelpSection @see XObjectInspectorModel::HasHelpSection
@see XObjectInspectorModel::MinHelpTextLines @see XObjectInspectorModel::MinHelpTextLines
......
...@@ -84,7 +84,7 @@ service CopyTableWizard : XCopyTableWizard ...@@ -84,7 +84,7 @@ service CopyTableWizard : XCopyTableWizard
a table from one database to another. a table from one database to another.
<p>At creation time, an attempt will be made to obtain the connections described <p>At creation time, an attempt will be made to obtain the connections described
by <arg>Source</arg> resp. <arg>Dest</arg>. Failing to do so will result in an by Source resp. Dest. Failing to do so will result in an
exception.</p> exception.</p>
<p>If the connection has been newly created by the wizard (e.g. because the <p>If the connection has been newly created by the wizard (e.g. because the
......
...@@ -229,7 +229,7 @@ interface XDatabaseDocumentUI ...@@ -229,7 +229,7 @@ interface XDatabaseDocumentUI
or an com::sun::star::frame::XController if the component does is model-less. or an com::sun::star::frame::XController if the component does is model-less.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>ObjectType</arg> denotes an invalid object type if ObjectType denotes an invalid object type
@throws ::com::sun::star::container::NoSuchElementException @throws ::com::sun::star::container::NoSuchElementException
if an object with the given name and of the given type does not exist if an object with the given name and of the given type does not exist
...@@ -270,7 +270,7 @@ interface XDatabaseDocumentUI ...@@ -270,7 +270,7 @@ interface XDatabaseDocumentUI
constants. constants.
@param DocumentDefinition @param DocumentDefinition
Upon successful return, and if and only if <arg>ObjectType</arg> equals DatabaseObject::FORM Upon successful return, and if and only if ObjectType equals DatabaseObject::FORM
or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition
object which controls the sub component. object which controls the sub component.
*/ */
...@@ -294,11 +294,11 @@ interface XDatabaseDocumentUI ...@@ -294,11 +294,11 @@ interface XDatabaseDocumentUI
constants. constants.
@param DocumentDefinition @param DocumentDefinition
Upon successful return, and if and only if <arg>ObjectType</arg> equals DatabaseObject::FORM Upon successful return, and if and only if ObjectType equals DatabaseObject::FORM
or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition or DatabaseObject::REPORT, this will contain the com::sun::star::sdb::DocumentDefinition
object which controls the sub component.<br/> object which controls the sub component.<br/>
You can use this object to control various aspects of the sub component. For instance, you could decide You can use this object to control various aspects of the sub component. For instance, you could decide
to create the component hidden, by passing a <code>Hidden</code> flag (set to <TRUE/>) in <arg>Arguments</arg>, to create the component hidden, by passing a <code>Hidden</code> flag (set to <TRUE/>) in Arguments,
manipulate the component, and then finally show it by invoking the <code>show</code> command at the manipulate the component, and then finally show it by invoking the <code>show</code> command at the
definition object. definition object.
*/ */
......
...@@ -92,7 +92,7 @@ interface XTableUIProvider ...@@ -92,7 +92,7 @@ interface XTableUIProvider
interfaces, it's discarded. interfaces, it's discarded.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if the given <arg>TableName</arg> does not denote an existing table if the given TableName does not denote an existing table
@throws ::com::sun::star::lang::WrappedTargetException @throws ::com::sun::star::lang::WrappedTargetException
if an error occurs while creating the table editor component. if an error occurs while creating the table editor component.
......
...@@ -89,10 +89,10 @@ interface XConnectionTools ...@@ -89,10 +89,10 @@ interface XConnectionTools
@param command @param command
the object. This may be a table name, a query name, or an SQL statement, depending on the value the object. This may be a table name, a query name, or an SQL statement, depending on the value
of <arg>_nCommandType</arg> of _nCommandType
@param _rxCollectionOner @param _rxCollectionOner
If (and only if) <arg>CommandType</arg> is CommandType.COMMAND, the fields collection which is returned If (and only if) CommandType is CommandType.COMMAND, the fields collection which is returned
by this function here is a temporary object. It is kept alive by another object, which is to be by this function here is a temporary object. It is kept alive by another object, which is to be
created temporarily, too. To ensure that the fields you get are valid as long as you need them, created temporarily, too. To ensure that the fields you get are valid as long as you need them,
the owner which controls their life time is transfered to this parameter upon return.<br/> the owner which controls their life time is transfered to this parameter upon return.<br/>
...@@ -117,7 +117,7 @@ interface XConnectionTools ...@@ -117,7 +117,7 @@ interface XConnectionTools
@param command @param command
the object. This may be a table name, a query name, or an SQL statement, depending on the value the object. This may be a table name, a query name, or an SQL statement, depending on the value
of <arg>_nCommandType</arg> of _nCommandType
@return @return
the composer filled with command and command type. the composer filled with command and command type.
*/ */
......
...@@ -80,7 +80,7 @@ interface XObjectNames ...@@ -80,7 +80,7 @@ interface XObjectNames
base name will be used. base name will be used.
@throws com::sun::star::lang::IllegalArgumentException @throws com::sun::star::lang::IllegalArgumentException
if <arg>CommandType</arg> specifies an invalid command type. if CommandType specifies an invalid command type.
*/ */
string suggestName( [in] long CommandType, [in] string BaseName ) string suggestName( [in] long CommandType, [in] string BaseName )
raises ( com::sun::star::lang::IllegalArgumentException ); raises ( com::sun::star::lang::IllegalArgumentException );
...@@ -118,7 +118,7 @@ interface XObjectNames ...@@ -118,7 +118,7 @@ interface XObjectNames
to be used in the database. to be used in the database.
@throws com::sun::star::lang::IllegalArgumentException @throws com::sun::star::lang::IllegalArgumentException
if <arg>CommandType</arg> specifies an invalid command type. if CommandType specifies an invalid command type.
@see checkNameIsUsed @see checkNameIsUsed
*/ */
......
...@@ -80,7 +80,7 @@ interface XTableName ...@@ -80,7 +80,7 @@ interface XTableName
@see CompositionType @see CompositionType
@throws com::sun::star::IllegalArgumentException @throws com::sun::star::IllegalArgumentException
if the given <arg>Type</arg> does not denote a valid CompositionType if the given Type does not denote a valid CompositionType
*/ */
string getComposedName( [in] long Type, [in] boolean Quote ) string getComposedName( [in] long Type, [in] boolean Quote )
raises ( com::sun::star::lang::IllegalArgumentException ); raises ( com::sun::star::lang::IllegalArgumentException );
......
...@@ -42,7 +42,7 @@ published interface XFilterGroupManager : com::sun::star::uno::XInterface ...@@ -42,7 +42,7 @@ published interface XFilterGroupManager : com::sun::star::uno::XInterface
@param aFilters @param aFilters
The filters which form a group. Every filter consists of two strings, where the first one is a display name The filters which form a group. Every filter consists of two strings, where the first one is a display name
(as for <arg>sGroupTitle</arg>, it holds that these strings should be localized), and the second one the (as for sGroupTitle, it holds that these strings should be localized), and the second one the
semicolon separated list of wildcard expressions for the filter.<br/> semicolon separated list of wildcard expressions for the filter.<br/>
Usually, the expressions are simply extensions (e.g. "*.txt"), but this must no necessarily be the case. Usually, the expressions are simply extensions (e.g. "*.txt"), but this must no necessarily be the case.
......
...@@ -65,7 +65,7 @@ interface XModel ...@@ -65,7 +65,7 @@ interface XModel
/** submit form through given submission id /** submit form through given submission id
<p>This is a convenience method. Calling it is equivalent to calling <p>This is a convenience method. Calling it is equivalent to calling
<code>getSubmission()( <arg>id</arg> ).submit()</code>.</p> <code>getSubmission()( id ).submit()</code>.</p>
@param id @param id
the ID of the submission to execute the ID of the submission to execute
...@@ -85,7 +85,7 @@ interface XModel ...@@ -85,7 +85,7 @@ interface XModel
/** submit form through given submission id /** submit form through given submission id
<p>This is a convenience method. Calling it is equivalent to calling <p>This is a convenience method. Calling it is equivalent to calling
<code>getSubmission()( <arg>id</arg>, <arg>handler</arg> ).submit()</code>.</p> <code>getSubmission()( id, handler ).submit()</code>.</p>
@param id @param id
the ID of the submission to execute the ID of the submission to execute
......
...@@ -82,7 +82,7 @@ service EnumerableMap : XEnumerableMap ...@@ -82,7 +82,7 @@ service EnumerableMap : XEnumerableMap
denotes the type of the values in the to-be-created map denotes the type of the values in the to-be-created map
@throws ::com::sun::star::beans::IllegalTypeException @throws ::com::sun::star::beans::IllegalTypeException
if <arg>KeyType</arg> or <arg>ValueType</arg> are unsupported types. if KeyType or ValueType are unsupported types.
For values, all type classes except com::sun::star::uno::TypeClass::VOID For values, all type classes except com::sun::star::uno::TypeClass::VOID
and com::sun::star::uno::TypeClass::UNKNOWN are accepted. and com::sun::star::uno::TypeClass::UNKNOWN are accepted.
For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface
...@@ -104,7 +104,7 @@ service EnumerableMap : XEnumerableMap ...@@ -104,7 +104,7 @@ service EnumerableMap : XEnumerableMap
denote the values contained in the to-be-created map denote the values contained in the to-be-created map
@throws ::com::sun::star::beans::IllegalTypeException @throws ::com::sun::star::beans::IllegalTypeException
if <arg>KeyType</arg> or <arg>ValueType</arg> are unsupported types. if KeyType or ValueType are unsupported types.
For values, all type classes except com::sun::star::uno::TypeClass::VOID For values, all type classes except com::sun::star::uno::TypeClass::VOID
are accepted.<br/> are accepted.<br/>
For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface For keys, scalar types, strings, com::sun::star::uno::Type itself, and interface
......
...@@ -71,7 +71,7 @@ published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface { ...@@ -71,7 +71,7 @@ published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface {
specifies the non-escaped new name part of the URL. specifies the non-escaped new name part of the URL.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>name</arg> is empty if name is empty
@since OOo 3.0 @since OOo 3.0
*/ */
...@@ -116,7 +116,7 @@ published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface { ...@@ -116,7 +116,7 @@ published interface XVndSunStarScriptUrl: com::sun::star::uno::XInterface {
Otherwise, a parameter with the given key/value will be appended. Otherwise, a parameter with the given key/value will be appended.
@throws ::com::sun::star::lang::IllegalArgumentException @throws ::com::sun::star::lang::IllegalArgumentException
if <arg>key</arg> is empty if key is empty
@since OOo 3.0 @since OOo 3.0
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment