diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 22:20:42 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:00 +0200 |
| commit | b352a8bf0321c13919c9882484a1c4d4d65cfd33 (patch) | |
| tree | 1f9d5c7f1d14def51714f0ac5ebe30ab0f5c9ed9 | |
| parent | 9f12a9da8d91364d4d0865021adbe62bfa09148c (diff) | |
*api: convert <member>method</member> to method()
Doxygen will only recognize a un-qualified method name as such if it is
followed by "()".
sed -i "s,<member>\([a-z][^<]\+[^)]\)</member>,\1(),g"
Change-Id: I69bc17849e76f3a3d91c6daf0f1be8168a83cfc5
72 files changed, 204 insertions, 204 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleRole.idl b/offapi/com/sun/star/accessibility/AccessibleRole.idl index 1b5b4e213d1a..aaa65634c7a5 100644 --- a/offapi/com/sun/star/accessibility/AccessibleRole.idl +++ b/offapi/com/sun/star/accessibility/AccessibleRole.idl @@ -29,7 +29,7 @@ module com { module sun { module star { module accessibility { the Java class javax.accessibility.AccessibleRole. The role of an object describes its generic function like "button", "menu", or "text". You can obtain an object's role by calling the - <member>getAccessibleRole</member> method of the + getAccessibleRole() method of the XAccessibleContext interface.</p> <p>We are using constants instead of a more typesafe enum. The reason diff --git a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl index db940a0b8fd6..bf31da06c7d1 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleRelationSet.idl @@ -33,9 +33,9 @@ module com { module sun { module star { module accessibility { between Accessible objects. Most of the convenience methods of the corresponding AccessibleRelationSet interface of the Java Accessibility API have been removed from this interface in order to - clean it up. These methods are <member>add</member>, - <member>addAll</member>, <member>clear</member>, and - <member>remove</member>. The other methods have been renamed to achieve + clean it up. These methods are add(), + addAll(), clear(), and + remove(). The other methods have been renamed to achieve a greater conformance with the other accessibility interfaces.</p> @since OOo 1.1.2 diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl index e11d0c12f00c..3a722de98a13 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleText.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl @@ -90,7 +90,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface The new index of the caret. This caret is actually placed to the left side of the character with that index. An index of 0 places the caret so that the next insertion goes before the - first character. An index of <member>getCharacterCount</member> + first character. An index of getCharacterCount() leads to insertion after the last character. @return diff --git a/offapi/com/sun/star/accessibility/XAccessibleValue.idl b/offapi/com/sun/star/accessibility/XAccessibleValue.idl index 22984f7370a7..ffe62951f48a 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleValue.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleValue.idl @@ -49,8 +49,8 @@ interface XAccessibleValue : ::com::sun::star::uno::XInterface <p>The argument is clipped to the valid interval whose upper and lower bounds are returned by the methods - <member>getMaximumAccessibleValue</member> and - <member>getMinimumAccessibleValue</member>, i.e. if it is lower than + getMaximumAccessibleValue() and + getMinimumAccessibleValue(), i.e. if it is lower than the minimum value the new value will be the minimum and if it is greater than the maximum then the new value will be the maximum.</p> @@ -68,7 +68,7 @@ interface XAccessibleValue : ::com::sun::star::uno::XInterface <p>The type of the returned value is implementation dependent. It does not have to be the same type as that returned by - <member>getCurrentAccessibleValue</member>.</p> + getCurrentAccessibleValue().</p> @return Returns the maximal value in an implementation dependent type. @@ -81,7 +81,7 @@ interface XAccessibleValue : ::com::sun::star::uno::XInterface <p>The type of the returned value is implementation dependent. It does not have to be the same type as that returned by - <member>getCurrentAccessibleValue</member>.</p> + getCurrentAccessibleValue().</p> @return Returns the minimal value in an implementation dependent type. diff --git a/offapi/com/sun/star/animations/AnimationFill.idl b/offapi/com/sun/star/animations/AnimationFill.idl index d466d2864114..7ef586d50dc8 100644 --- a/offapi/com/sun/star/animations/AnimationFill.idl +++ b/offapi/com/sun/star/animations/AnimationFill.idl @@ -23,7 +23,7 @@ module com { module sun { module star { module animations { -/** This constants are used for the members <member>fill</member> and <member>fillDefault</member> +/** This constants are used for the members fill() and fillDefault() of the an XTimeContainer. @see XTimeContainer diff --git a/offapi/com/sun/star/awt/XAnimatedImages.idl b/offapi/com/sun/star/awt/XAnimatedImages.idl index bba769c81d2e..deed8a442848 100644 --- a/offapi/com/sun/star/awt/XAnimatedImages.idl +++ b/offapi/com/sun/star/awt/XAnimatedImages.idl @@ -72,7 +72,7 @@ interface XAnimatedImages @param i_index the index of the set those image URLs are to be retrieved. Must be greater than or equal to <code>0</code>, - and smaller than the value returned by <member>getImageSetCount</member>. + and smaller than the value returned by getImageSetCount(). @throws ::com::sun::star::lang::IndexOutOfBoundsException if the <code>i_index</code> is not a valid index. @@ -91,7 +91,7 @@ interface XAnimatedImages @param i_index the index at which a new image set should be inserted. Must be greater than or equal to <code>0</code>, - and smaller than or equal to the value returned by <member>getImageSetCount</member>. + and smaller than or equal to the value returned by getImageSetCount(). @param i_imageURLs the URLs for the images for the given set. Will be resolved using a com::sun::star::graphic::GraphicProvider. @@ -113,7 +113,7 @@ interface XAnimatedImages @param i_index the index of the set those image URLs are to be replaced. Must be greater than or equal to <code>0</code>, - and smaller than the value returned by <member>getImageSetCount</member>. + and smaller than the value returned by getImageSetCount(). @param i_imageURLs the URLs for the images for the given set. Will be resolved using a com::sun::star::graphic::GraphicProvider. @@ -137,7 +137,7 @@ interface XAnimatedImages @param i_index the index of the set to remove. Must be greater than or equal to <code>0</code>, - and smaller than the value returned by <member>getImageSetCount</member>. + and smaller than the value returned by getImageSetCount(). @throws ::com::sun::star::lang::IndexOutOfBoundsException if the <code>i_index</code> is not a valid index. diff --git a/offapi/com/sun/star/awt/XDialogProvider2.idl b/offapi/com/sun/star/awt/XDialogProvider2.idl index 1fefe3bc8653..73c419a4e709 100644 --- a/offapi/com/sun/star/awt/XDialogProvider2.idl +++ b/offapi/com/sun/star/awt/XDialogProvider2.idl @@ -103,7 +103,7 @@ interface XDialogProvider2 : ::com::sun::star::awt::XDialogProvider { or a component supporting the XControl interface, so an <code>XWindowPeer</code> can be obtained from it. The given window will be used as parent window for the to-be-created dialog.</li> <li><em>EventHandler</em> - specifies a component handling events in the dialog. See - <member>createDialogWithHandler</member> for a detailed specification of dialog event handling.</li> + createDialogWithHandler() for a detailed specification of dialog event handling.</li> </ul> </p> */ diff --git a/offapi/com/sun/star/awt/XMouseListener.idl b/offapi/com/sun/star/awt/XMouseListener.idl index 9906c48f1daa..896a274eeaaa 100644 --- a/offapi/com/sun/star/awt/XMouseListener.idl +++ b/offapi/com/sun/star/awt/XMouseListener.idl @@ -39,7 +39,7 @@ published interface XMouseListener: com::sun::star::lang::XEventListener (also known as context menus) on objects, you might receive two events for a single mouse press: For example, if, on your operating system, pressing the right mouse button indicates the request for a context menu, - then you will receive one call to <member>mousePressed</member> indicating + then you will receive one call to mousePressed() indicating the mouse click, and another one indicating the context menu request. For the latter, the <member>MouseEvent::PopupTrigger</member> member of the event will be set to <TRUE/>.</p> diff --git a/offapi/com/sun/star/awt/grid/XGridColumnModel.idl b/offapi/com/sun/star/awt/grid/XGridColumnModel.idl index 16344dea1d4d..6ef4c5923253 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumnModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumnModel.idl @@ -61,7 +61,7 @@ published interface XGridColumnModel /** creates a new column for use with the column model. - <p>The newly created column is not yet inserted into the column container, you need to call <member>addColumn</member> + <p>The newly created column is not yet inserted into the column container, you need to call addColumn() after you initialized the column object.</p> */ XGridColumn @@ -69,7 +69,7 @@ published interface XGridColumnModel /** Adds a column to the model. - <p>You should use the <member>createColumn</member> member to create a new column. This gives + <p>You should use the createColumn() member to create a new column. This gives implementations of the <code>XGridColumnModel</code> interface the possibility to provide own column implementations which extend the basic GridColumn type.</p> diff --git a/offapi/com/sun/star/awt/grid/XGridDataModel.idl b/offapi/com/sun/star/awt/grid/XGridDataModel.idl index 94f6981f748e..3090db51838b 100644 --- a/offapi/com/sun/star/awt/grid/XGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridDataModel.idl @@ -90,7 +90,7 @@ published interface XGridDataModel /** retrieves the data for a complete row <p>This method is provided for performance and convenience reasons, it delivers the same result - as subsequent calls to <member>getCellData</member> would.</p> + as subsequent calls to getCellData() would.</p> @param Row the index of the row whose data should is to be retrieved. diff --git a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl index 0b650b5c51a6..74fd7b23c0bb 100644 --- a/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl @@ -151,7 +151,7 @@ published interface XMutableGridDataModel : XGridDataModel /** updates the tooltip for all cells of a given row - <p>Effectively this method is a shortcut for calling <member>updateCellToolTip</member> multiple + <p>Effectively this method is a shortcut for calling updateCellToolTip() multiple times in a row, for all cells of a given row.</p> @see XGridDataModel::getCellToolTip @@ -168,7 +168,7 @@ published interface XMutableGridDataModel : XGridDataModel void addGridDataListener( [in] XGridDataListener Listener ); - /** revokes a listener which was previously registered via <member>addGridDataListener</member> + /** revokes a listener which was previously registered via addGridDataListener() @param Listener specifies the listener to revoke. */ diff --git a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl index 7773ed2dc8d6..dad23fd98983 100644 --- a/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl +++ b/offapi/com/sun/star/awt/tree/XMutableTreeDataModel.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module awt { module tree { /** This is the editable version of the XTreeDataModel. - <p>Note that only XTreeNode created from the same instance with <member>createNode</member> + <p>Note that only XTreeNode created from the same instance with createNode() are valid nodes for this instance.</p> */ interface XMutableTreeDataModel : XTreeDataModel diff --git a/offapi/com/sun/star/awt/tree/XTreeNode.idl b/offapi/com/sun/star/awt/tree/XTreeNode.idl index 8cbb27a07de1..e2e178cb70f7 100644 --- a/offapi/com/sun/star/awt/tree/XTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XTreeNode.idl @@ -37,7 +37,7 @@ interface XTreeNode /** Returns the child tree node at <var>Index</var>. @throws ::com::sun::star::lang::IndexOutOfBoundsException - if <var>Index</var> is less than 0 or equal or greater then <member>getChildCount</member>. + if <var>Index</var> is less than 0 or equal or greater then getChildCount(). */ XTreeNode getChildAt( [in] long Index ) raises( com::sun::star::lang::IndexOutOfBoundsException ); @@ -56,7 +56,7 @@ interface XTreeNode /** Returns <TRUE/> if the children of this node are created on demand. <p>A TreeControl will handle a node that returns <TRUE/> always - like a node that has child nodes, even if <member>getChildCount</member> + like a node that has child nodes, even if getChildCount() returns 0.</p> @see TreeExpansionListener; diff --git a/offapi/com/sun/star/chart2/XChartDocument.idl b/offapi/com/sun/star/chart2/XChartDocument.idl index 9304bbf8695a..dc231cf8b2ef 100644 --- a/offapi/com/sun/star/chart2/XChartDocument.idl +++ b/offapi/com/sun/star/chart2/XChartDocument.idl @@ -82,7 +82,7 @@ interface XChartDocument : ::com::sun::star::frame::XModel is an internal one. <p>This is the case directly after - <member>createInternalDataProvider</member> has been called, + createInternalDataProvider() has been called, but this is not necessary. The chart can also create an internal data provider by other means, e.g. a call to <member scope="com::sun::star::frame">XModel::initNew</member>. @@ -91,7 +91,7 @@ interface XChartDocument : ::com::sun::star::frame::XModel boolean hasInternalDataProvider(); /** Returns the currently set data provider. This may be an - internal one, if <member>createInternalDataProvider</member> + internal one, if createInternalDataProvider() has been called before, or an external one if <member>XDataReceiver::attachDataProvider</member> has been called. diff --git a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl index 925412652595..9d0e36416466 100644 --- a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl +++ b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl @@ -71,7 +71,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface DataSeries and Categories and creates a new diagram based on these series. - <p>Note, that if <member>matchesTemplate</member> returns + <p>Note, that if matchesTemplate() returns <TRUE/> for the given XDiagram, the latter should not be changed.</p> @@ -90,7 +90,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface diagram is compatible with the data-format of this template.</p> - <p>Ideally a <member>matchesTemplate</member> call for the + <p>Ideally a matchesTemplate() call for the given diagram should return <TRUE/> before this method is called.</p> @@ -121,7 +121,7 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface <p>The template will parse the DataSeriesTree of the diagram to determine if the structure matches the one which would have been created by - <member>createDiagramByDataSource</member>.</p> + createDiagramByDataSource().</p> <p>For analysis all parts of the diagram may be used, e.g. also properties set at the data series (like symbols)./p> @@ -139,8 +139,8 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface @return <TRUE/> if the diagram given is structurally identical to a diagram that was created using - <member>createDiagramByDataSource</member> or - <member>changeDiagram</member>. If <FALSE/> is returned + createDiagramByDataSource() or + changeDiagram(). If <FALSE/> is returned the template stays unmodified even if <code>bAdaptProperties</code> is <TRUE/>. */ @@ -201,8 +201,8 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface /** Resets all styles that were changed from the default at any object in the chart and have not been later modified. - <p>In <member>createDiagramByDataSource</member> or - <member>changeDiagram</member> a template might e.g. change + <p>In createDiagramByDataSource() or + changeDiagram() a template might e.g. change the page background color or the line style of all data series. This method should reset all objects that still have the changed settings to the default.</p> diff --git a/offapi/com/sun/star/chart2/XDataInterpreter.idl b/offapi/com/sun/star/chart2/XDataInterpreter.idl index 1c8efd676c30..280b2696a020 100644 --- a/offapi/com/sun/star/chart2/XDataInterpreter.idl +++ b/offapi/com/sun/star/chart2/XDataInterpreter.idl @@ -65,7 +65,7 @@ interface XDataInterpreter : ::com::sun::star::uno::XInterface InterpretedData reinterpretDataSeries( [in] InterpretedData aInterpretedData ); /** parses the given data and states, if a - <member>reinterpretDataSeries</member> call can be done + reinterpretDataSeries() call can be done without data loss. @return @@ -76,10 +76,10 @@ interface XDataInterpreter : ::com::sun::star::uno::XInterface boolean isDataCompatible( [in] InterpretedData aInterpretedData ); /** Try to reverse the operation done in - <member>interpretDataSource</member>. + interpretDataSource(). <p>In case <code>aInterpretedData</code> is the result of - <member>interpretDataSource</member>( <code>xSource</code> ), + interpretDataSource()( <code>xSource</code> ), the result of this method should be <code>xSource</code>.</p> */ com::sun::star::chart2::data::XDataSource mergeInterpretedData( [in] InterpretedData aInterpretedData ); diff --git a/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl b/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl index c56bf5cba8bb..21f6573528ea 100644 --- a/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl +++ b/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl @@ -72,9 +72,9 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface /** calculate multiple points of a regression curve at once. Note that this method may optimize the output by returning less points, e.g. for a line you may get only two resulting points - instead of <member>nPointCount</member> points. This is only + instead of nPointCount() points. This is only allowed if the parameter - <member>bMaySkipPointsInCalculation</member> is set to + bMaySkipPointsInCalculation() is set to <TRUE/>. <p>It is important that a renderer takes the scalings into diff --git a/offapi/com/sun/star/chart2/XTransformation.idl b/offapi/com/sun/star/chart2/XTransformation.idl index 39d42c90b096..80b655660935 100644 --- a/offapi/com/sun/star/chart2/XTransformation.idl +++ b/offapi/com/sun/star/chart2/XTransformation.idl @@ -62,18 +62,18 @@ interface XTransformation : ::com::sun::star::uno::XInterface @throws ::com::sun::star::lang::IllegalArgumentException if the dimension of the input vector is not equal to the - dimension given in <member>getSourceDimension</member>. + dimension given in getSourceDimension(). */ sequence< double > transform( [in] sequence< double > aValues ) raises( ::com::sun::star::lang::IllegalArgumentException ); /** the dimension of the input coordinate sequence that is to be - transformed by the <member>transform</member> method. + transformed by the transform() method. */ long getSourceDimension(); /** the dimension of the output coordinate sequence that is the - result of the <member>transform</member> method. + result of the transform() method. */ long getTargetDimension(); }; diff --git a/offapi/com/sun/star/chart2/data/XDataProvider.idl b/offapi/com/sun/star/chart2/data/XDataProvider.idl index d06aebadae08..e82f5fbd08f3 100644 --- a/offapi/com/sun/star/chart2/data/XDataProvider.idl +++ b/offapi/com/sun/star/chart2/data/XDataProvider.idl @@ -80,7 +80,7 @@ interface XDataProvider : ::com::sun::star::uno::XInterface DataSource most probably was created. <p>if xDataSource is a data source that was created with - <member>createDataSource</member>, the arguments returned here + createDataSource(), the arguments returned here should be the same than the ones passed to the function. Of course, this cannot be guaranteed. However, if detection is ambiguous, the returned arguments should be empty. </p> @@ -96,7 +96,7 @@ interface XDataProvider : ::com::sun::star::uno::XInterface @return Arguments that when being passed to - <member>createDataSource</member> should in an ideal case + createDataSource() should in an ideal case return the same data source as <code>xDataSource</code>. */ sequence< com::sun::star::beans::PropertyValue > detectArguments( diff --git a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl index 8798935d726a..d24d6556a2c5 100644 --- a/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl +++ b/offapi/com/sun/star/configuration/backend/XSchemaHandler.idl @@ -53,7 +53,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that the current schema description is complete. - <p> Must match a previous call to <member>startSchema</member>. + <p> Must match a previous call to startSchema(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -96,7 +96,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a component description is started. <p> Subsequent calls describe the schema of the component - until a matching call to <member>endComponent</member> + until a matching call to endComponent() is encountered. </p> @@ -122,7 +122,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a component description is complete. - <p> Must match a previous call to <member>startComponent</member>. + <p> Must match a previous call to startComponent(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -144,7 +144,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a template description is started for a group. <p> Subsequent calls describe the members and properties of the template - until a matching call to <member>endTemplate</member> + until a matching call to endTemplate() is encountered. </p> @@ -186,7 +186,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a template description is started for a set. <p> Subsequent calls describe the members and properties of the template - until a matching call to <member>endTemplate</member> + until a matching call to endTemplate() is encountered. </p> @@ -232,8 +232,8 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a template description is complete. - <p> Must match a previous call to <member>startGroupTemplate</member> - or <member>startSetTemplate</member>. + <p> Must match a previous call to startGroupTemplate() + or startSetTemplate(). </p> @throws com::sun::star::configuration::backend::MalformedDataException @@ -255,7 +255,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a group description is started. <p> Subsequent calls describe the members and properties of the group - until a matching call to <member>endNode</member> + until a matching call to endNode() is encountered. </p> @@ -294,7 +294,7 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a set description is started. <p> Subsequent calls describe the item-types and properties of the set - until a matching call to <member>endNode</member> + until a matching call to endNode() is encountered. </p> @@ -338,8 +338,8 @@ published interface XSchemaHandler: ::com::sun::star::uno::XInterface /** receives notification that a node description is complete. - <p> Must match the last open call to <member>startGroup</member> - or <member>startSet</member>. + <p> Must match the last open call to startGroup() + or startSet(). </p> @throws com::sun::star::configuration::backend::MalformedDataException diff --git a/offapi/com/sun/star/deployment/XPackage.idl b/offapi/com/sun/star/deployment/XPackage.idl index cbfa58d748a0..d2b7ba7af232 100644 --- a/offapi/com/sun/star/deployment/XPackage.idl +++ b/offapi/com/sun/star/deployment/XPackage.idl @@ -186,7 +186,7 @@ interface XPackage /** Gets packages of the bundle. - If <member>isRemoved</member> returns <TRUE/> then getBundle may return an + If isRemoved() returns <TRUE/> then getBundle may return an empty sequence in case the object is not registered. @param xAbortChannel diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index cd7a9e520d7f..9a77f8be3158 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -57,7 +57,7 @@ interface XPackageRegistry The implementation must ensure that there is only one instance of XPackage for the same <code>url</code> at any - time. Therefore calling <member>bindPackage</member> again with the same + time. Therefore calling bindPackage() again with the same <code>url</code> but different <code>mediaType<code> (the exception is, if previously an empty string was provided to cause the determination of the media type) or <code>removed</code> parameters will cause an diff --git a/offapi/com/sun/star/document/XDocumentProperties.idl b/offapi/com/sun/star/document/XDocumentProperties.idl index 63ab8e0e81fb..a9a2f99c0f91 100644 --- a/offapi/com/sun/star/document/XDocumentProperties.idl +++ b/offapi/com/sun/star/document/XDocumentProperties.idl @@ -41,9 +41,9 @@ module com { module sun { module star { module document { Such properties may be set from the outside via the setter methods (e.g. when importing arbitrary document formats that support document properties), or imported from an ODF package via the methods - <member>loadFromStorage</member> and <member>loadFromMedium</member>. + loadFromStorage() and loadFromMedium(). The properties may also be stored via the methods - <member>storeToStorage</member> and <member>storeToMedium</member>. + storeToStorage() and storeToMedium(). </p> @since OOo 3.0 diff --git a/offapi/com/sun/star/document/XDocumentRecovery.idl b/offapi/com/sun/star/document/XDocumentRecovery.idl index 691138d50314..6b9954882064 100644 --- a/offapi/com/sun/star/document/XDocumentRecovery.idl +++ b/offapi/com/sun/star/document/XDocumentRecovery.idl @@ -33,13 +33,13 @@ module com { module sun { module star { module document { */ interface XDocumentRecovery { - /** determines whether the document has been modified since the last call to <member>storeToRecoveryFile</member>. + /** determines whether the document has been modified since the last call to storeToRecoveryFile(). <p>If <code>storeToRecoveryFile</code> has not been called before, this method returns whether the document has been modified since it has been loaded respectively created.</p> <p>When saving a session, either in case of a emergency (when OpenOffice.org crashed), or during a - periodic session save as configured by the user, <member>storeToRecoveryFile</member> is called for every + periodic session save as configured by the user, storeToRecoveryFile() is called for every document where <code>wasModifiedSinceLastSave</code> returns <TRUE/>.</p> <p>It's allowed to implement this method sloppy, by returning <TRUE/> in cases where it is not sure whether diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index 15b96bc89efb..b470de9ef989 100644 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -57,9 +57,9 @@ interface XUndoManagerListener; <h3>Hidden Undo actions</h3> <p>Hidden Undo actions are those which in no observable way contribute to the undo stack. That is, any method retrieving information about the stack will behave as if the undo action does not exist. Nonetheless, - calling <member>undo</member> respectively <member>redo</member> will include those actions.<br/> - Hidden Undo actions can be created by calling <member>enterHiddenUndoContext</member>, following by - <member>leaveUndoContext</member>.</p> + calling undo() respectively redo() will include those actions.<br/> + Hidden Undo actions can be created by calling enterHiddenUndoContext(), following by + leaveUndoContext().</p> <a name="locking"></a> <h3>Locking</h3> @@ -87,11 +87,11 @@ interface XUndoManager it will not be directly accessible at the Undo manager, not appear in any user interface, and cannot be separately undone or re-done.</p> - <p>Each call to <code>enterUndoContext</code> must be paired by a call to <member>leaveUndoContext</member>, + <p>Each call to <code>enterUndoContext</code> must be paired by a call to leaveUndoContext(), otherwise, the document's undo stack is left in an inconsistent state.</p> <p>Undo contexts can be nested, i.e. it is legitimate to call <code>enterUndoContext</code> and - <member>enterHiddenUndoContext</member> multiple times without calling <member>leaveUndoContext</member> inbetween.</p> + enterHiddenUndoContext() multiple times without calling leaveUndoContext() inbetween.</p> @see leaveUndoContext */ @@ -103,9 +103,9 @@ interface XUndoManager <p>A hidden undo action does not, in any visible way, contribute to the undo stack. This means that - <ul><li>Calling <member>undo</member> when the top-element is a hidden undo action will transparently + <ul><li>Calling undo() when the top-element is a hidden undo action will transparently undo this action, and also undo the new top element of the stack.</li> - <li>Calling <member>redo</member> when the top-element is a hidden action will transparently + <li>Calling redo() when the top-element is a hidden action will transparently redo this action, and also redo the new top element of the stack.</li> <li>In any user interface presenting the current Undo or Redo actions to the user, a hidden action will not be listed.</p> @@ -115,11 +115,11 @@ interface XUndoManager added to the stack will be treated as sub action. This means it will not be directly accessible at the undo manager, not appear in any user interface, and cannot be separately undone or re-done.</p> - <p>Each call to <code>enterHiddenUndoContext</code> must be paired by a call to <member>leaveUndoContext</member>, + <p>Each call to <code>enterHiddenUndoContext</code> must be paired by a call to leaveUndoContext(), otherwise, the document's undo stack is left in an inconsistent state.</p> - <p>Undo contexts can be nested, i.e. it is legitimate to call <member>enterUndoContext</member> and - <code>enterHiddenUndoContext</code> multiple times without calling <member>leaveUndoContext</member> inbetween.</p> + <p>Undo contexts can be nested, i.e. it is legitimate to call enterUndoContext() and + <code>enterHiddenUndoContext</code> multiple times without calling leaveUndoContext() inbetween.</p> @throws EmptyUndoStackException if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto @@ -131,8 +131,8 @@ interface XUndoManager void enterHiddenUndoContext() raises( EmptyUndoStackException ); - /** leaves the undo context previously opened via <member>enterUndoContext</member> respectively - <member>enterHiddenUndoContext</member>. + /** leaves the undo context previously opened via enterUndoContext() respectively + enterHiddenUndoContext(). <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 @@ -156,8 +156,8 @@ interface XUndoManager <p>The redo stack is cleared when a new action is pushed onto the undo stack.</p> <p>The Undo manager takes ownership of any actions pushed onto the undo stack. This means that if the - action is finally removed from the Undo manager's control (e.g. by calling <member>clear</member> resp. - <member>clearRedo</member>), it will be disposed, as long as it supports the <member scope="com::sun::star::lang">XComponent</member> + action is finally removed from the Undo manager's control (e.g. by calling clear() resp. + clearRedo()), it will be disposed, as long as it supports the <member scope="com::sun::star::lang">XComponent</member> interface.</p> <p>If the Undo manager is <a href="#locking">locked</a> at the moment the method is called, the call will be ignored, and the undo action @@ -220,7 +220,7 @@ interface XUndoManager ::com::sun::star::document::UndoContextNotClosedException, ::com::sun::star::document::UndoFailedException ); - /** determines whether <member>undo</member> can reasonably be expected to succeed. + /** determines whether undo() can reasonably be expected to succeed. @return <FALSE/> if and only if the undo stack is currently empty, or there is an open and not-yet-closed @@ -228,7 +228,7 @@ interface XUndoManager */ boolean isUndoPossible(); - /** determines whether <member>redo</member> can reasonably be expected to succeed. + /** determines whether redo() can reasonably be expected to succeed. @return <FALSE/> if and only if the redo stack is currently empty, or there is an open and not-yet-closed diff --git a/offapi/com/sun/star/drawing/Shape.idl b/offapi/com/sun/star/drawing/Shape.idl index 6345a85d1e36..91c296827e13 100644 --- a/offapi/com/sun/star/drawing/Shape.idl +++ b/offapi/com/sun/star/drawing/Shape.idl @@ -49,7 +49,7 @@ published service Shape /** This gives you the size and position of this Shape - and lets you change it. You can use <member>getShapeType</member> + and lets you change it. You can use getShapeType() to determine what kind of shape this is. */ interface com::sun::star::drawing::XShape; diff --git a/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl b/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl index f42ac74f80cc..a3d99fba5af8 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceFactoryManager.idl @@ -61,7 +61,7 @@ interface XResourceFactoryManager [in] string sResourceURL); /** Remove a resource factory for all resource types it has been registered for. Use - <member>removeResourceFactoryForURL</member> to remove a factory + removeResourceFactoryForURL() to remove a factory just for one resource type and to leave it registered for others. @param xResourceFactory The resource factory object to remove. diff --git a/offapi/com/sun/star/form/XBoundComponent.idl b/offapi/com/sun/star/form/XBoundComponent.idl index 4f3bd6dc8221..c1bc3249af5d 100644 --- a/offapi/com/sun/star/form/XBoundComponent.idl +++ b/offapi/com/sun/star/form/XBoundComponent.idl @@ -29,7 +29,7 @@ /** specifies a (form) component which is bound to a data source. <p>The interface provides the possibility of committing its respective - data to a data source it is bound to. A <member>commit</member> will be + data to a data source it is bound to. A commit() will be performed by the environment (usually, a FormController).<br/> For example, suppose you have a data-bound control that is connected to a database field. Each time the control loses its focus, the diff --git a/offapi/com/sun/star/form/XFormsSupplier2.idl b/offapi/com/sun/star/form/XFormsSupplier2.idl index 1d7efaf1e582..2483ed81bdb9 100644 --- a/offapi/com/sun/star/form/XFormsSupplier2.idl +++ b/offapi/com/sun/star/form/XFormsSupplier2.idl @@ -33,11 +33,11 @@ interface XFormsSupplier2: XFormsSupplier /** determines whether there are currently forms available at all <p>If you need read access to the forms collection, then you might check - the existence of forms using <member>hasForms</member>, and if it returns + the existence of forms using hasForms(), and if it returns <FALSE/>, you can do as if <member>XFormsSupplier::getForms</member> would have returned an empty container.</p> - <p>Semantically, <member>hasForms</member> is equivalent to calling + <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 implementation is forced to create a empty container, which might be potentially diff --git a/offapi/com/sun/star/form/binding/XValueBinding.idl b/offapi/com/sun/star/form/binding/XValueBinding.idl index 83e9689e3afa..e3c1276f1897 100644 --- a/offapi/com/sun/star/form/binding/XValueBinding.idl +++ b/offapi/com/sun/star/form/binding/XValueBinding.idl @@ -42,7 +42,7 @@ interface XValueBinding : com::sun::star::uno::XInterface /** determines whether a given type is supported by this binding for value exchange - <p>Calling this method is equal to calling <member>getSupportedValueTypes</member>, + <p>Calling this method is equal to calling getSupportedValueTypes(), and looking up the given type in the resulting type sequence.</p> @see getSupportedValueTypes diff --git a/offapi/com/sun/star/form/runtime/XFormOperations.idl b/offapi/com/sun/star/form/runtime/XFormOperations.idl index c01332788b88..ac14fb4ceac6 100644 --- a/offapi/com/sun/star/form/runtime/XFormOperations.idl +++ b/offapi/com/sun/star/form/runtime/XFormOperations.idl @@ -61,7 +61,7 @@ interface XFeatureInvalidation; com::sun::star::form::component::DataForm.</p> <p>If you agree that this is ugly to do and maintain, then <code>XFormOperations</code> - is for you. It provides a <member>execute</member> method, which will do all of the above + is for you. It provides a execute() method, which will do all of the above for you; plus some similar convenient wrappers for similar functionality.</p> @see FormFeature @@ -107,7 +107,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent /** determines whether a feature is currently enabled. - <p>Calling this is equivalent to calling <member>getState</member>, and evaluating the + <p>Calling this is equivalent to calling getState(), and evaluating the <member>FeatureState::Enabled</member> member.</p> @param Feature @@ -235,7 +235,7 @@ interface XFormOperations : ::com::sun::star::lang::XComponent whenever the state of any supported feature might have changed.</p> <p>For instance, imagine a form whose current row has just been moved to another - record, using the <member>execute</member> method. This means that potentially, the state + record, using the execute() method. This means that potentially, the state of all movement-related features might have changed.</p> <p>Note that the instance does not actually notify changes in the feature states, but only diff --git a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl index a1c332a86f85..90f5466a5435 100644 --- a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl +++ b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl @@ -59,7 +59,7 @@ interface XValidatableFormComponent : XValidatable at the validator. <p>Calling this is equal to calling <member>XValidator::isValid</member> with - the current value (see <member>getCurrentValue</member>) of the component, where + the current value (see getCurrentValue()) of the component, where the validator is obtained via <member>XValidatable::getValidator</member>.</p> <p>If no validator has been set (<member>XValidatable::setValidator</member>), this method diff --git a/offapi/com/sun/star/frame/XLayoutManager.idl b/offapi/com/sun/star/frame/XLayoutManager.idl index 28a8d835507b..5dfe0baadb8f 100644 --- a/offapi/com/sun/star/frame/XLayoutManager.idl +++ b/offapi/com/sun/star/frame/XLayoutManager.idl @@ -85,8 +85,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface <p> This call should be handled with care as all user interface elements will be destroyed and the layout manager is reseted to a state after a - <member>attachFrame</member> has been made. That means an attached frame - which has been set by <member>attachFrame</member> is not released. + attachFrame() has been made. That means an attached frame + which has been set by attachFrame() is not released. The layout manager itself calls reset after a component has been attached or reattached to a frame. </p> @@ -307,7 +307,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface <p> It is up to the layout manager to decide if the user interface element can be resized. The new size can be retrieved - by calling <member>getElementSize</member>. + by calling getElementSize(). </p> */ void setElementSize( [in] string ResourceURL, [in] com::sun::star::awt::Size Size ); @@ -324,7 +324,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface <p> It is up to the layout manager to decide if the user interface element can be moved. The new position can be retrieved - by calling <member>getElementPos</member>. + by calling getElementPos(). </p> */ void setElementPos( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos ); @@ -344,7 +344,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface <p> It is up to the layout manager to decide if the user interface element can be moved and resized. The new position and size can - be retrieved by calling <member>getElementPos</member> and <member>getElementSize</member>. + be retrieved by calling getElementPos() and getElementSize(). </p> */ void setElementPosSize( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size ); diff --git a/offapi/com/sun/star/frame/XModel2.idl b/offapi/com/sun/star/frame/XModel2.idl index f5f075c0b207..daa52bc9fb29 100644 --- a/offapi/com/sun/star/frame/XModel2.idl +++ b/offapi/com/sun/star/frame/XModel2.idl @@ -81,7 +81,7 @@ interface XModel2 : com::sun::star::frame::XModel /** creates the default view instance for this model. - <p>Effectively, this method is equivalent to calling <member>createView</member> with + <p>Effectively, this method is equivalent to calling createView() with the <code>ViewName</code> being <code>"Default"</code>.</p> @param Frame diff --git a/offapi/com/sun/star/frame/XSessionManagerListener.idl b/offapi/com/sun/star/frame/XSessionManagerListener.idl index 342e581e3ffd..de055e7fc5af 100644 --- a/offapi/com/sun/star/frame/XSessionManagerListener.idl +++ b/offapi/com/sun/star/frame/XSessionManagerListener.idl @@ -47,7 +47,7 @@ module com { module sun { module star { module frame { <TRUE/> if a shutdown in progress can be canceled by the listener, <FALSE/> else - <p>the listener may choose to ignore the <member>saveDone</member> + <p>the listener may choose to ignore the saveDone() event in case no real shutdown is in progress. He still has to call <member>XSessionManagerClient::saveDone()</member> diff --git a/offapi/com/sun/star/i18n/XCharacterClassification.idl b/offapi/com/sun/star/i18n/XCharacterClassification.idl index 97677a3aecbf..767e55155799 100644 --- a/offapi/com/sun/star/i18n/XCharacterClassification.idl +++ b/offapi/com/sun/star/i18n/XCharacterClassification.idl @@ -212,7 +212,7 @@ published interface XCharacterClassification : com::sun::star::uno::XInterface at position <em>nPos</em>. <p> Other parameters are the same as in - <member>parseAnyToken</member>. If the actual token does not + parseAnyToken(). If the actual token does not match the passed <em>nTokenType</em> a <member>ParseResult::TokenType</member> set to <b>0</b> (zero) is returned. </p> diff --git a/offapi/com/sun/star/inspection/XHyperlinkControl.idl b/offapi/com/sun/star/inspection/XHyperlinkControl.idl index 3e1114e1330e..4a50adf6a384 100644 --- a/offapi/com/sun/star/inspection/XHyperlinkControl.idl +++ b/offapi/com/sun/star/inspection/XHyperlinkControl.idl @@ -40,7 +40,7 @@ interface XHyperlinkControl : XPropertyControl */ void addActionListener( [in] com::sun::star::awt::XActionListener listener ); - /** removes a listener which was previously added via <member>addActionListener</member> + /** removes a listener which was previously added via addActionListener() @param listener the listener to revoke */ diff --git a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl index e5169c5c4635..d27e7a82b68d 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorModel.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorModel.idl @@ -70,7 +70,7 @@ interface XObjectInspectorModel 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 - <member>describeCategories</member> assembles information about all categories which + describeCategories() assembles information about all categories which all property handlers provided by the model use.</p> @return diff --git a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl index f696fdb2d93e..dd3e549d3965 100644 --- a/offapi/com/sun/star/inspection/XObjectInspectorUI.idl +++ b/offapi/com/sun/star/inspection/XObjectInspectorUI.idl @@ -58,8 +58,8 @@ interface XObjectInspectorUI /** enables or disables the single elements which can be part of the UI representation of a property <p>Note that the complete UI for the property must be enabled in order for these settings to - be evaluated. That is, <member>enablePropertyUIElements</member> does not have any effect if - somebody previously disabled the complete UI for this property with <member>enablePropertyUI</member>.</p> + be evaluated. That is, enablePropertyUIElements() does not have any effect if + somebody previously disabled the complete UI for this property with enablePropertyUI().</p> @param PropertyName the name of the property whose user interface elements are to be enabled or disabled diff --git a/offapi/com/sun/star/inspection/XPropertyHandler.idl b/offapi/com/sun/star/inspection/XPropertyHandler.idl index febaf2419e02..9207f2a694a3 100644 --- a/offapi/com/sun/star/inspection/XPropertyHandler.idl +++ b/offapi/com/sun/star/inspection/XPropertyHandler.idl @@ -125,13 +125,13 @@ interface XPropertyHandler /** converts a given control-compatible value to a property value - <p>In <member>describePropertyLine</member>, a property handler declared which type of control + <p>In describePropertyLine(), a property handler declared which type of control should be used to display the value of a certain property. To allow to use the same control type for different properties, and in particular, for properties of different type, conversions between controls values and property values are needed.</p> <p>This method converts a control value into a property value, which subsequently can be used - in conjunction with <member>setPropertyValue</member>.</p> + in conjunction with setPropertyValue().</p> @param PropertyName The name of the conversion's target property. @@ -156,19 +156,19 @@ interface XPropertyHandler /** converts a given property value to a control-compatible value - <p>In <member>describePropertyLine</member>, a property handler declared which type of control + <p>In describePropertyLine(), a property handler declared which type of control should be used to display the value of a certain property. To allow to use the same control type for different properties, and in particular, for properties of different type, conversions between controls values and property values are needed.</p> <p>This method converts a property value, which has previously been obtained using - <member>getPropertyValue</member>, into a control-compatible value, which can be used + getPropertyValue(), into a control-compatible value, which can be used with XPropertyControl's <member>XPropertyControl::Value</member> attribute.</p> <p>A usual application of this method are list boxes: There is a generic list box implementation, which is able to display a simple list of strings. Usually, every string represents one possible property value. To translate between those property values and the displayed strings, - <member>convertToControlValue</member> and <member>convertToPropertyValue</member> are used.</p> + convertToControlValue() and convertToPropertyValue() are used.</p> <p>The method is not invoked if the control's value type (<member>XPropertyControl::ValueType</member> equals the property's value type.</p> @@ -180,10 +180,10 @@ interface XPropertyHandler @param ControlValueType The target type of the conversion. This type is determined by the control which is used to display the property, which in turn is determined by the handler itself - in <member>describePropertyLine</member>.<br/> + in describePropertyLine().<br/> Speaking strictly, this is passed for convenience only, since every XPropertyHandler implementation should know exactly which type to expect, since it implicitly determined this type - in <member>describePropertyLine</member> by creating an appropriate XPropertyControl. + in describePropertyLine() by creating an appropriate XPropertyControl. @throws com::sun::star::beans::UnknownPropertyException if the given property is not supported by the property handler @@ -208,9 +208,9 @@ interface XPropertyHandler reflected in the object inspector.</p> <p>If a handler implementation supports property change listeners, it must be able to cope - with a call to <member>addPropertyChangeListener</member> even if currently no component is + with a call to addPropertyChangeListener() even if currently no component is being inspected. In this case, the listener must become active as soon as a new introspection - is set in the next <member>inspect</member> call.</p> + is set in the next inspect() call.</p> @param Listener the listener to notify about property changes @@ -243,7 +243,7 @@ interface XPropertyHandler /** returns the properties which are to be superseded by this handler - <p>Besides defining an own set of properties (see <member>getSupportedProperties</member>), + <p>Besides defining an own set of properties (see getSupportedProperties()), a property handler can also declare that foreign properties (which it is <em>not</em> responsible for) are superseded by its own properties.</p> @@ -269,7 +269,7 @@ interface XPropertyHandler <code>C</code>, so it cannot, by definition, supersede properties which are supported by <code>C</code>.</p> - <p>If <member>getSupportedProperties</member> returned an empty sequence, this method will + <p>If getSupportedProperties() returned an empty sequence, this method will not be called.</p> @see XObjectInspectorModel::HandlerFactories @@ -287,9 +287,9 @@ interface XPropertyHandler <p>Whenever the value of an actuating property changes, all handlers which expressed their interest in this particular actuating properties are called with their - <member>actuatingPropertyChanged</member> method.</p> + actuatingPropertyChanged() method.</p> - <p>If <member>getSupportedProperties</member> returned an empty sequence, this method will + <p>If getSupportedProperties() returned an empty sequence, this method will not be called</p> */ sequence< string > @@ -317,7 +317,7 @@ interface XPropertyHandler <p>Availability of this feature is indicated by the <member>LineDescriptor::HasPrimaryButton</member> and <member>LineDescriptor::HasSecondaryButton</member> members of a LineDescriptor, - which the XPropertyHandler fills in its <member>describePropertyLine</member> method.</p> + which the XPropertyHandler fills in its describePropertyLine() method.</p> <p>When this method is called, the property handler should raise the UI needed to enter the property value, and return the result of this (see InteractiveSelectionResult).</p> @@ -329,7 +329,7 @@ interface XPropertyHandler <p>If a handler sets the new property value directly, and returns <member>InteractiveSelectionResult::ObtainedValue</member>, this implies that the property cannot properly be handled in case the object inspector is inspecting an intersection of - multiple components, since in this case <member>onInteractivePropertySelection</member> + multiple components, since in this case onInteractivePropertySelection() will be called at one handler only, however the new property would have to be forwarded to all handlers.</p> @@ -350,7 +350,7 @@ interface XPropertyHandler @param InspectorUI provides access to the object inspector UI. Implementations should use this if the property selection requires non-modal user input. In those cases, - <member>onInteractivePropertySelection</member> should return <member>InteractiveSelectionResult::Pending</member>, + onInteractivePropertySelection() should return <member>InteractiveSelectionResult::Pending</member>, and the UI for (at least) the property whose input is still pending should be disabled. @return @@ -377,7 +377,7 @@ interface XPropertyHandler /** updates the UI of dependent properties when the value of a certain actuating property changed <p>This method is called whenever a property value changes, limited to those properties - whose changes the handler expressed interest in (see <member>getActuatingProperties</member>).</p> + whose changes the handler expressed interest in (see getActuatingProperties()).</p> @param ActuatingPropertyName the id of the actuating property. @@ -419,12 +419,12 @@ interface XPropertyHandler <p>The usual use case for this method are non-modal user interface components used for property value input. Such a component might have been opened during - <member>onInteractivePropertySelection</member>. If a property handler receives a - <member>suspend</member> call, it should forward the suspension request to the UI + onInteractivePropertySelection(). If a property handler receives a + suspend() call, it should forward the suspension request to the UI component, and veto suspension of the XObjectInspector as appropriate.</p> <p>If suspension is not to be vetoed, then all non-modal UI components opened - by the handler should have been closed when it returns from the <member>suspend</member> call.</p> + by the handler should have been closed when it returns from the suspend() call.</p> @param Suspend Whether the handler is to be suspended <TRUE/> or reactivated (<FALSE/>). The diff --git a/offapi/com/sun/star/mail/XMailService.idl b/offapi/com/sun/star/mail/XMailService.idl index 841130a0c9d3..efedf9f3c0ef 100644 --- a/offapi/com/sun/star/mail/XMailService.idl +++ b/offapi/com/sun/star/mail/XMailService.idl @@ -114,7 +114,7 @@ interface XMailService: ::com::sun::star::uno::XInterface { <li> <b>ConnectionType</b> of type 'string'. A list of supported connection types can be queried using - <member>getSupportedConnectionTypes</member>. + getSupportedConnectionTypes(). </li> <li> <b>Timeout</b> of type 'long' (Optional). diff --git a/offapi/com/sun/star/presentation/XSlideShowController.idl b/offapi/com/sun/star/presentation/XSlideShowController.idl index c0c557866a01..af34633bd08f 100644 --- a/offapi/com/sun/star/presentation/XSlideShowController.idl +++ b/offapi/com/sun/star/presentation/XSlideShowController.idl @@ -143,7 +143,7 @@ interface XSlideShowController /** pauses the slide show. All effects are paused. <p>The slide show continues on next user input or if - <member>resume</member> is called. + resume() is called. */ void pause(); @@ -155,8 +155,8 @@ interface XSlideShowController /** returns <TRUE/> if the slide show is currently paused. - @see <member>pause</member> - @see <member>resume</member> + @see pause() + @see resume() */ boolean isPaused(); diff --git a/offapi/com/sun/star/rdf/XNamedGraph.idl b/offapi/com/sun/star/rdf/XNamedGraph.idl index fc49063ec03d..c6cfc06b81a2 100644 --- a/offapi/com/sun/star/rdf/XNamedGraph.idl +++ b/offapi/com/sun/star/rdf/XNamedGraph.idl @@ -41,8 +41,8 @@ module com { module sun { module star { module rdf { <p> Note that instances may be destroyed via <member>XRepository::destroyGraph</member>. - If a graph is destroyed, subsequent calls to <member>addStatement</member>, - <member>removeStatements</member> will fail with an + If a graph is destroyed, subsequent calls to addStatement(), + removeStatements() will fail with an com::sun::star::container::NoSuchElementException. </p> diff --git a/offapi/com/sun/star/rendering/XColorSpace.idl b/offapi/com/sun/star/rendering/XColorSpace.idl index 6fe4d786cb02..af6e1033f8dd 100644 --- a/offapi/com/sun/star/rendering/XColorSpace.idl +++ b/offapi/com/sun/star/rendering/XColorSpace.idl @@ -128,7 +128,7 @@ interface XColorSpace com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. - @see <member>convertToARGB</member> + @see convertToARGB() */ sequence<RGBColor> convertToRGB( [in] sequence<ColorComponent> deviceColor ) raises (com::sun::star::lang::IllegalArgumentException); diff --git a/offapi/com/sun/star/resource/XStringResourceManager.idl b/offapi/com/sun/star/resource/XStringResourceManager.idl index f4fccf7c2c94..208dac558a5a 100644 --- a/offapi/com/sun/star/resource/XStringResourceManager.idl +++ b/offapi/com/sun/star/resource/XStringResourceManager.idl @@ -90,7 +90,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol is thrown. @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void setDefaultLocale( [in] com::sun::star::lang::Locale locale ) raises( com::sun::star::lang::IllegalArgumentException, @@ -110,7 +110,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol String to be associated with the Resource ID. @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void setString ( @@ -139,10 +139,10 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @param locale The locale the string should be set for. The locale has to match exactly with one of the locales provided by - <member>getLocales</member>. A closest match search is not supported. + getLocales(). A closest match search is not supported. @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void setStringForLocale ( @@ -166,7 +166,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void removeId( [in] string ResourceID ) raises( com::sun::star::resource::MissingResourceException, @@ -183,7 +183,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @param locale The locale the Resource ID should be removed for. The locale has to match exactly with one of the locales provided by - <member>getLocales</member>. A closest match search is not supported. + getLocales(). A closest match search is not supported. @throws com::sun::star::resource::MissingResourceException @@ -191,7 +191,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void removeIdForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale ) raises( com::sun::star::resource::MissingResourceException, @@ -217,7 +217,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void newLocale( [in] com::sun::star::lang::Locale locale ) raises( com::sun::star::container::ElementExistException, @@ -235,7 +235,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @throws com::sun::star::lang::NoSupportException - if the resource is read only, see <member>isReadOnly</member> + if the resource is read only, see isReadOnly() */ void removeLocale( [in] com::sun::star::lang::Locale locale ) raises( com::sun::star::lang::IllegalArgumentException, @@ -264,8 +264,8 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol beginning of a Resource ID incremented by 1. When calling this method more than once always the same number will be returned until this number is really used at the beginning of a new - Resource ID passed to <member>setString</member> or - <member>setStringForLocale</member>. + Resource ID passed to setString() or + setStringForLocale(). As the numeric id is guaranteed to be unique for the complete string table all locales are taken into account. So using this diff --git a/offapi/com/sun/star/resource/XStringResourcePersistence.idl b/offapi/com/sun/star/resource/XStringResourcePersistence.idl index d5af600f1e46..3e19e7dfc964 100644 --- a/offapi/com/sun/star/resource/XStringResourcePersistence.idl +++ b/offapi/com/sun/star/resource/XStringResourcePersistence.idl @@ -38,7 +38,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM { /** Stores all string table data respectively all data modified since - the last call to <member>store</member> to the location or storage + the last call to store() to the location or storage associated with the StringResourceManager. Each locale is stored in a single file following the format of Java properties files. @@ -55,7 +55,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM used to load data from and store data to, see StringResourceWithStorage. - If the string table isn't modified (see <member>isModified</member>) + If the string table isn't modified (see isModified()) this method does nothing. This method can throw all exceptions thrown by the methods of @@ -80,7 +80,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM @return <TRUE/> if the string table has changed since the last call to - <member>store</member> or, if supported + store() or, if supported <code>XStringResourceWithStorage::storeAsStorage</code>. <FALSE/> if the table hasn't changed. */ @@ -132,7 +132,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM @param Comment Comment stored first in each properties file, - for a detailed description see <member>setComment</member>. + for a detailed description see setComment(). This method can throw all exceptions thrown by the methods of com::sun::star::embed::XStorage @@ -169,7 +169,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM @param Comment Comment stored first in each properties file, - for a detailed description see <member>setComment</member>. + for a detailed description see setComment(). @param Handler a com::sun::star::task::XInteractionHandler. @@ -192,7 +192,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM by com::sun::star::datatransfer::XTransferable and related interfaces. - See <member>importBinary</member>). + See importBinary()). @return a sequence of byte representing the string resource. */ @@ -201,7 +201,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM /** Initializes the string resource with binary data. This method - expects the data format returned by <member>exportBinary</member>. + expects the data format returned by exportBinary(). All locales and strings previously added to the string resource will be deleted. So after calling this method the string resource @@ -211,11 +211,11 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM by com::sun::star::datatransfer::XTransferable and related interfaces. - See <member>importBinary</member>). + See importBinary()). @throws com::sun::star::lang::IllegalArgumentException if Data is empty or does not meet the binary format returned by - the current or earlier version of <member>exportBinary</member>). + the current or earlier version of exportBinary()). */ void importBinary( [in] sequence<byte> Data ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/resource/XStringResourceResolver.idl b/offapi/com/sun/star/resource/XStringResourceResolver.idl index 899d1f215dc0..e4967038702e 100644 --- a/offapi/com/sun/star/resource/XStringResourceResolver.idl +++ b/offapi/com/sun/star/resource/XStringResourceResolver.idl @@ -80,7 +80,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster @param locale The locale the string should be resolved for. The locale has to match exactly with one of the locales provided by - <member>getLocales</member>. A closest match search is not supported. + getLocales(). A closest match search is not supported. @return the localized string for the specified ID and Locale @@ -117,7 +117,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster @param locale The locale the entry should be checked for. The locale has to match exactly with one of the locales provided by - <member>getLocales</member>. A closest match search is not supported. + getLocales(). A closest match search is not supported. @return <TRUE/> if an entry exists, otherwise <FALSE/> */ @@ -142,7 +142,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster @param locale The locale the ResourceIDs should be returned for. The locale has to match exactly with one of the locales provided by - <member>getLocales</member>. A closest match search is not supported. + getLocales(). A closest match search is not supported. @return a sequence of all valid Resource IDs */ diff --git a/offapi/com/sun/star/resource/XStringResourceWithLocation.idl b/offapi/com/sun/star/resource/XStringResourceWithLocation.idl index bc2d60bc3977..a905cdbfd3ad 100644 --- a/offapi/com/sun/star/resource/XStringResourceWithLocation.idl +++ b/offapi/com/sun/star/resource/XStringResourceWithLocation.idl @@ -35,7 +35,7 @@ interface XStringResourceWithLocation: com::sun::star::resource::XStringResource { /** Stores all string table data to a location and associates this location - to this instance as if <member>setLocation</member> was called with this + to this instance as if setLocation() was called with this location. The modified state will be unmodified after the call. @param URL @@ -47,7 +47,7 @@ interface XStringResourceWithLocation: com::sun::star::resource::XStringResource /** Associates a location to the StringResourceWithStorage instance - which is used on subsequent calls of <member>store</member>. + which is used on subsequent calls of store(). @param URL the location to be associated to the StringResourceManager @@ -58,7 +58,7 @@ interface XStringResourceWithLocation: com::sun::star::resource::XStringResource force the implementation to reload data from the previous location before releasing it. The StringResourceManager will be modified after calling this method as the data isn't stored - to the new location yet. <member>storeAsURL</member> should + to the new location yet. storeAsURL() should be preferred as it directly stores the data to the new location and afterwards this location is in sync with the resource data. </p> diff --git a/offapi/com/sun/star/resource/XStringResourceWithStorage.idl b/offapi/com/sun/star/resource/XStringResourceWithStorage.idl index 205e17b9afba..41f1f2c31fd7 100644 --- a/offapi/com/sun/star/resource/XStringResourceWithStorage.idl +++ b/offapi/com/sun/star/resource/XStringResourceWithStorage.idl @@ -35,7 +35,7 @@ interface XStringResourceWithStorage: com::sun::star::resource::XStringResourceP { /** Stores all string table data to a storage and associates this storage - to this instance as if <member>setStorage</member> was called with + to this instance as if setStorage() was called with this storage. The modified state will be unmodified after the call. This method can throw all exceptions thrown by the methods of @@ -47,7 +47,7 @@ interface XStringResourceWithStorage: com::sun::star::resource::XStringResourceP /** Associates a storage to the StringResourceWithStorage instance - which is used on subsequent calls of <member>store</member>. + which is used on subsequent calls of store(). @param Storage the storage to be associated to the StringResourceManager @@ -58,7 +58,7 @@ interface XStringResourceWithStorage: com::sun::star::resource::XStringResourceP force the implementation to reload data from the previous storage before releasing it. The StringResourceManager will be modified after calling this method as the data isn't stored to the new - storage yet. <member>storeAsStorage</member> should be preferred + storage yet. storeAsStorage() should be preferred as it directly stores the data to the new storage and afterwards this storage is in sync with the resource data. </p> diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl index b54eb937183e..bc9f8470f568 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl @@ -175,7 +175,7 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface if the query represented cannot be completely substituted. A usual case for this is a recursion in the sub queries: Consider a query named <code>foo</code>, which is defined as <code>SELECT * FROM "bar"</code>. Now assume that <code>bar</code> is a query defined as <code>SELECT * FROM "foo"</code>. Passing either - of those statements to an analyzer, and calling <member>getQueryWithSubstitution</member>, would result + of those statements to an analyzer, and calling getQueryWithSubstitution(), would result in an exception being thrown, since it's impossible to substitute the sub queries with their constituting statements. diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl index e5de0382d433..1674f4500531 100644 --- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl +++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl @@ -190,7 +190,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer 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 - filter. Instead, only filters which have been set using for instance <member>setFilter</member> + 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 @@ -200,7 +200,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer <p>As a result, you can use the composer to build cumulative filter expressions. That is, you can set <member>ElementaryQuery</member> to a statement already containing - filters, and then use <member>setFilter</member> to append additional filters.</p> + filters, and then use setFilter() to append additional filters.</p> <p>The very same holds for sort orders, <code>HAVING</code> and <code>GROUP BY</code> clauses.</p> diff --git a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl index 03c07a7bec9f..3cadfb51d250 100644 --- a/offapi/com/sun/star/sdb/application/CopyTableWizard.idl +++ b/offapi/com/sun/star/sdb/application/CopyTableWizard.idl @@ -52,7 +52,7 @@ module com { module sun { module star { module sdb { module application { </ul></p> <p>When you do not specify an interaction handler by using the - <member>createWithInteractionHandler</member> constructor, the wizard will use the interaction + createWithInteractionHandler() constructor, the wizard will use the interaction handler associated with the copy target, i.e. the interaction handler specified when loading the document which the copy target refers to. If the copy target cannot be associated with a database document (e.g. because it is a mere <code>ConnectionResource</code>, or a connection @@ -63,7 +63,7 @@ module com { module sun { module star { module sdb { module application { the copy source and the copy target descriptors are used to create a Connection. For any interaction during this phase - including, for instance, necessary authentication -, the interaction handler of the respective data source is used, no matter what you specified - in <member>createWithInteractionHandler</member>. Only if there is no such interaction + in createWithInteractionHandler(). Only if there is no such interaction handler, the processing described above, to find another handler, is applied.</p> </dd> @@ -173,7 +173,7 @@ service CopyTableWizard : XCopyTableWizard /** creates an executable wizard dialog, which is to guide the user through copying a table from one database to another. - <p>The only difference to the <member>create</member> constructor is that + <p>The only difference to the create() constructor is that <code>createWithInteractionHandler</code> takes an additional argument, which can be used to intercept interactions (such as error messages) during the wizard run.</p> diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index 7c1495f8c6c3..d4a95a6e978f 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -247,7 +247,7 @@ interface XDatabaseDocumentUI /** loads the given sub component of the database document - <p>In opposite to <member>loadComponent</member>, this method allows you to specify + <p>In opposite to loadComponent(), this method allows you to specify additional arguments which are passed to the to-be-loaded component.</p> <p>The meaning of the arguments is defined at the service which is effectively @@ -282,7 +282,7 @@ interface XDatabaseDocumentUI /** creates a new sub component of the given type - <p>In opposite to <member>createComponent</member>, this method allows you to specify + <p>In opposite to createComponent(), this method allows you to specify additional arguments which are passed to the to-be-loaded component.</p> <p>The meaning of the arguments is defined at the service which is effectively diff --git a/offapi/com/sun/star/sdb/tools/XObjectNames.idl b/offapi/com/sun/star/sdb/tools/XObjectNames.idl index 34777ad324bc..dafa0eeb7057 100644 --- a/offapi/com/sun/star/sdb/tools/XObjectNames.idl +++ b/offapi/com/sun/star/sdb/tools/XObjectNames.idl @@ -141,8 +141,8 @@ interface XObjectNames /** checks whether a given name is allowed for a to-be-created table or query in the database. - <p>This method basically does the same checks as <member>isNameUsed</member> and - <member>isNameValid</member>. In case the given name is not allowed, it throws an + <p>This method basically does the same checks as isNameUsed() and + isNameValid(). In case the given name is not allowed, it throws an exception. This error can be presented to the user, to give it a common experience in all cases where he's required to enter an object name.</p> diff --git a/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl b/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl index e0ea4a15df28..5418267ab27f 100644 --- a/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl +++ b/offapi/com/sun/star/sdbc/XGeneratedResultSet.idl @@ -29,7 +29,7 @@ /** provides a result set which gives access to automatically generated values after a new row was inserted. - <p>The relative order of columns in the result set returned by <member>getGeneratedValues</member> must be the same + <p>The relative order of columns in the result set returned by getGeneratedValues() must be the same as the relative order of the same columns as returned when executing a "SELECT * FROM table". This ensures that clients of this interface can reliably fetch the column values.</p> diff --git a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl index b49a9d3c81b0..864e6a7d6c30 100644 --- a/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl +++ b/offapi/com/sun/star/sheet/XFormulaOpCodeMapper.idl @@ -45,7 +45,7 @@ interface XFormulaOpCodeMapper /** OpCode value used for unknown functions. <p>Used to identify which of the function names queried with - <member>getMappings</member> are unknown to the implementation.</p> + getMappings() are unknown to the implementation.</p> */ [attribute, readonly] long OpCodeUnknown; diff --git a/offapi/com/sun/star/text/XSimpleText.idl b/offapi/com/sun/star/text/XSimpleText.idl index a4411522ef21..ba3b5cd05417 100644 --- a/offapi/com/sun/star/text/XSimpleText.idl +++ b/offapi/com/sun/star/text/XSimpleText.idl @@ -82,7 +82,7 @@ published interface XSimpleText: com::sun::star::text::XTextRange <method>XSimpleText::createTextCursor</member> can be used to get an XTextRange for this argument. - <p>If the parameter <member>bAbsorb</member> was <TRUE/> + <p>If the parameter bAbsorb() was <TRUE/> the text range will contain the new inserted string, otherwise the range (and it's text) will remain unchanged. diff --git a/offapi/com/sun/star/text/XTextContent.idl b/offapi/com/sun/star/text/XTextContent.idl index 998ae0ed8e75..af92acea421b 100644 --- a/offapi/com/sun/star/text/XTextContent.idl +++ b/offapi/com/sun/star/text/XTextContent.idl @@ -61,7 +61,7 @@ published interface XTextContent: com::sun::star::lang::XComponent <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>attach</member> for example or + used for some operation like attach() for example or <member scope="com::sun::star::text">insertTextContent</member> or other function that require the object to have a position in the text.</p> diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 91ef8523811e..236006e1d639 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -39,7 +39,7 @@ module com { module sun { module star { module ucb { can be used to create a stub on server side. <p>If you have instantiated a CachedDynamicResultSet on client - side already, use method <member>connectToCache</member> to connect your + side already, use method connectToCache() to connect your given DynamicResultSet with this Cache. <p>The needed cache on server side you can create using diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index abfa388c2cbf..7f30e131a66a 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -125,7 +125,7 @@ published interface XContentProviderManager: com::sun::star::uno::XInterface @param Scheme the URL scheme for the provided contents. More generally, this may not only be a URL scheme, but a URL template (see - <member>registerContentProvider</member> for a discussion of URL + registerContentProvider() for a discussion of URL templates). */ void deregisterContentProvider( diff --git a/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl b/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl index 9ee2a61bd2bb..8e81daacdb6b 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationPersistence.idl @@ -45,17 +45,17 @@ interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface void reload() raises ( ::com::sun::star::uno::Exception ); /** stores the configuration data to the storage provided by - <member>setStorage</member> from the storage and initialize the + setStorage() from the storage and initialize the user interface configuration manager instance with the newly data. This call can throw an com::sun::star::io::IOException if - <member>store</member> cannot store its data into the internal + store() cannot store its data into the internal storage. */ void store() raises ( ::com::sun::star::uno::Exception ); /** stores the configuration data to the provided storage, ignoring - the previously set storage by <member>setStorage</member>. Can + the previously set storage by setStorage(). Can be used to make copy of the current user interface configuration data to another storage. This call will throw an com::sun::star::io::IOException if the provided @@ -71,7 +71,7 @@ interface XUIConfigurationPersistence : ::com::sun::star::uno::XInterface @return <TRUE/> if the configuration manager has changed since the - last <member>store</member> call. <FALSE/> if the configuration + last store() call. <FALSE/> if the configuration manager has not been changed. */ boolean isModified(); diff --git a/offapi/com/sun/star/ui/XUIConfigurationStorage.idl b/offapi/com/sun/star/ui/XUIConfigurationStorage.idl index 28a8c646251f..247687e4af4e 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationStorage.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationStorage.idl @@ -35,26 +35,26 @@ module com { module sun { module star { module ui { interface XUIConfigurationStorage : ::com::sun::star::uno::XInterface { /** connects a storage to the user interface configuration manager - which is used on subsequent calls of <member>load</member> and - <member>store</member>. + which is used on subsequent calls of load() and + store(). @param Storage all configuration data is loaded/stored from/into this storage. - If the storage is in read/write mode <member>load</member> - and <member>store</member> can be used otherwise only - <member>load</member> is possible. + If the storage is in read/write mode load() + and store() can be used otherwise only + load() is possible. <p> This call needs careful usage as data loss can occur. If the implementation has modified data and a new storage is set the implementation is not allowed to write back the data to the old - storage. This must be done explicitly with <member>store</member>. + storage. This must be done explicitly with store(). In general a user interface configuration manager instance is created and initialize by the document model or the module user interface configuration supplier. Normally there is no need to set a storage for a user interface configuration manager. If a copy of the configuration data to another storage should be made, - use <member>storeToStorage</member>. + use storeToStorage(). </p> */ void setStorage( [in] ::com::sun::star::embed::XStorage Storage ); diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl index 6004702a8e1f..78a2b8671fb3 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizard.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -54,16 +54,16 @@ interface XWizardPage; are not finally decided. In such a case, the roadmap will display future steps up to the point where the potential paths diverge, and then an item <quot><code>...</code></quot> indicating that the order of steps is undecided.</p> - <p>An XWizardController can declare a certain path as active path by calling the <member>activatePath</member> + <p>An XWizardController can declare a certain path as active path by calling the activatePath() method. Usually, this is done depending on user input. For instance, your wizard could have radio buttons on the first page which effectively decide about which path to take in the wizard.</p> - <p>Single steps in the wizard can be freely enabled and disabled, using the <member>enablePage</member> method. + <p>Single steps in the wizard can be freely enabled and disabled, using the enablePage() method. 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> - methods. More sophisticated wizard logic, however, will need manual calls to the <member>enableButton</member> method. + 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> diff --git a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl index 32cdf6196242..66d10d32c9e0 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizardPage.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizardPage.idl @@ -62,7 +62,7 @@ interface XWizardPage : ::com::sun::star::lang::XComponent or the provided input is not valid.</p> <p>If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity - than a disabled <code>Next</code> button in the wizard, then move your checks to the <member>commitPage</member> + than a disabled <code>Next</code> button in the wizard, then move your checks to the commitPage() method.</p> */ boolean canAdvance(); diff --git a/offapi/com/sun/star/util/XLockable.idl b/offapi/com/sun/star/util/XLockable.idl index 6553abbdabf3..ecd160569c2d 100644 --- a/offapi/com/sun/star/util/XLockable.idl +++ b/offapi/com/sun/star/util/XLockable.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module util { <p><code>lock</code> and <code>unlock</code> calls can be nested. However, they must be in pairs. As long as there has been one more call to <code>lock</code> than to <code>unlock</code>, the - component is considered locked, which is reflected by <member>isLocked</member> returning <TRUE/>.</p> + component is considered locked, which is reflected by isLocked() returning <TRUE/>.</p> */ interface XLockable { diff --git a/offapi/com/sun/star/util/XSortable.idl b/offapi/com/sun/star/util/XSortable.idl index 74ba6a5ac7e8..7093a0469b20 100644 --- a/offapi/com/sun/star/util/XSortable.idl +++ b/offapi/com/sun/star/util/XSortable.idl @@ -76,7 +76,7 @@ published interface XSortable: com::sun::star::uno::XInterface properties. <p>The specified properties are usually the same or a subset of - those obtained by calling <member>createSortDescriptor</member> + those obtained by calling createSortDescriptor() on the same type of object.<p> @see com::sun::star::util::SortDescriptor diff --git a/offapi/com/sun/star/xforms/XModel.idl b/offapi/com/sun/star/xforms/XModel.idl index 878c89043b97..1289b44b0eeb 100644 --- a/offapi/com/sun/star/xforms/XModel.idl +++ b/offapi/com/sun/star/xforms/XModel.idl @@ -65,7 +65,7 @@ interface XModel /** submit form through given submission id <p>This is a convenience method. Calling it is equivalent to calling - <code><member>getSubmission</member>( <arg>id</arg> ).submit()</code>.</p> + <code>getSubmission()( <arg>id</arg> ).submit()</code>.</p> @param id the ID of the submission to execute @@ -85,7 +85,7 @@ interface XModel /** submit form through given submission id <p>This is a convenience method. Calling it is equivalent to calling - <code><member>getSubmission</member>( <arg>id</arg>, <arg>handler</arg> ).submit()</code>.</p> + <code>getSubmission()( <arg>id</arg>, <arg>handler</arg> ).submit()</code>.</p> @param id the ID of the submission to execute @@ -151,7 +151,7 @@ interface XModel /** get a binding with a certain ID <p>This is a convenience method: the same result can also be obtained through - <member>getBindings</member></p> + getBindings()</p> */ com::sun::star::beans::XPropertySet getBinding( [in] string id ); @@ -181,7 +181,7 @@ interface XModel /** get a submission with a certain ID. <p>This is a convenience method: the same result can also be obtained through - <member>getSubmissions</member>.</p> + getSubmissions().</p> */ XSubmission getSubmission( [in] string id ); diff --git a/offapi/com/sun/star/xml/sax/XFastParser.idl b/offapi/com/sun/star/xml/sax/XFastParser.idl index e91fa7bd7555..f0742290ffff 100644 --- a/offapi/com/sun/star/xml/sax/XFastParser.idl +++ b/offapi/com/sun/star/xml/sax/XFastParser.idl @@ -48,9 +48,9 @@ module com { module sun { module star { module xml { module sax { namespaces and allows to have individual contexts for each XML element. <p>Before parsing is possible you have to set your - XFastDocumentHandler using <member>setFastDocumentHandler</member>. + XFastDocumentHandler using setFastDocumentHandler(). - <p>Parsing starts with calling <member>parseStream</member>. If the parser + <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. @@ -59,14 +59,14 @@ module com { module sun { module star { module xml { module sax { elements that are unknown. <p>A namespace is unknown if the namespace URL was not registered with - <member>registerNamespace</member>. + registerNamespace(). <p>An element is unknown if no XFastTokenHandler is set or if the XFastTokenHandler does not return a valid identifier for the elements local name. An element is also unknown if the elements local name is known but it uses a namespace that is unknown. - <p>Setting a XFastTokenHandler with <member>setTokenHandler</member> + <p>Setting a XFastTokenHandler with setTokenHandler() is optional, but without a XFastTokenHandler you will only get unknown sax events. This can be useful if you are only interested in the namespace handling and/or the context feature. diff --git a/udkapi/com/sun/star/container/EnumerableMap.idl b/udkapi/com/sun/star/container/EnumerableMap.idl index e1b7ce3eb8a7..cda2c85fa5c3 100644 --- a/udkapi/com/sun/star/container/EnumerableMap.idl +++ b/udkapi/com/sun/star/container/EnumerableMap.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module container { /** provides a default XEnumerableMap implementation - <p>For the keys put into the map using <member>XMap::put</member> or <member>createImmutable</member>, + <p>For the keys put into the map using <member>XMap::put</member> or createImmutable(), the following rules apply: <a name="keyrules"></a> <ul><li>A <VOID/> key is not allowed.</li> @@ -49,7 +49,7 @@ module com { module sun { module star { module container { <li>All other key types are rejected.</li> </ul></p> - <p>For the values put into the map using <member>XMap::put</member> or <member>createImmutable</member>, + <p>For the values put into the map using <member>XMap::put</member> or createImmutable(), the following rules apply: <a name="valuerules"></a> <ul><li>The <VOID/> value will be accepted to be put into the map.</p> diff --git a/udkapi/com/sun/star/io/XTextInputStream.idl b/udkapi/com/sun/star/io/XTextInputStream.idl index 622f15256429..dc1ea2606070 100644 --- a/udkapi/com/sun/star/io/XTextInputStream.idl +++ b/udkapi/com/sun/star/io/XTextInputStream.idl @@ -40,7 +40,7 @@ published interface XTextInputStream: com::sun::star::io::XInputStream EOF is found and returns it as string (without CR, LF). <p>The read characters are converted according to the - encoding defined by <member>setEncoding</member>. If + encoding defined by setEncoding(). If EOF is already reached before calling this method an empty string is returned.<p> @@ -57,7 +57,7 @@ published interface XTextInputStream: com::sun::star::io::XInputStream delimiter! So if no delimiter is defined or none of the delimiters is found, the stream will be read to EOF. The read characters are converted according to the encoding - defined by <member>setEncoding</member>. If EOF is already + defined by setEncoding(). If EOF is already reached before calling this method an empty string is returned.</p> @see setEncoding diff --git a/udkapi/com/sun/star/io/XTextOutputStream.idl b/udkapi/com/sun/star/io/XTextOutputStream.idl index 729e38ee6f64..dc0122cfde57 100644 --- a/udkapi/com/sun/star/io/XTextOutputStream.idl +++ b/udkapi/com/sun/star/io/XTextOutputStream.idl @@ -37,7 +37,7 @@ module com { module sun { module star { module io { published interface XTextOutputStream: com::sun::star::io::XOutputStream { /** writes a string to the stream using the encoding - defined by <member>setEncoding</member>. + defined by setEncoding(). <p>Line breaks or delimiters that may be neccessary to support <member>XTextInputStream::readLine</member> diff --git a/udkapi/com/sun/star/script/XEventAttacherManager.idl b/udkapi/com/sun/star/script/XEventAttacherManager.idl index 038bc02f3c07..d2e071f3607d 100644 --- a/udkapi/com/sun/star/script/XEventAttacherManager.idl +++ b/udkapi/com/sun/star/script/XEventAttacherManager.idl @@ -58,7 +58,7 @@ published interface XEventAttacherManager: com::sun::star::uno::XInterface in the sequence.</p> <p>If any object is attached under this index, then this - event is attached automatically (see <member>attach</member>)</p> + event is attached automatically (see attach())</p> <p>Exceptions of type com::sun::star::beans::IntrospectionException and @@ -80,7 +80,7 @@ published interface XEventAttacherManager: com::sun::star::uno::XInterface members of the ScriptEventDescriptor used to register events. If this event at this index has been attached to any object, it is detached automatically - (see <member>attach</member>).</p> + (see attach()).</p> <p>Exceptions of type com::sun::star::beans::IntrospectionException and @@ -100,7 +100,7 @@ published interface XEventAttacherManager: com::sun::star::uno::XInterface <p>If the events at this index have been attached to any object, they are detached automatically. - (see <member>attach</member>).</p> + (see attach()).</p> @see attach */ @@ -120,7 +120,7 @@ published interface XEventAttacherManager: com::sun::star::uno::XInterface <p>If any events are registered at this index, they will be revoked, too. So if the events at this index have been attached to any object they are detached automatically. - (see <member>attach</member>).</p> + (see attach()).</p> @see attach */ |