diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-05-01 00:26:55 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:08 +0200 |
| commit | 392706b5f743b2f989ba5a120bbb31c2296bf902 (patch) | |
| tree | 6d37555b819fb1c482106f29c0aede2a121ae819 /offapi | |
| parent | ed993aafc928717ead4fae6b6dac8845771d8661 (diff) | |
*api: fix loads of badly documented parameters
Change-Id: Ifcfdcc1aee5f45745ab17d83f69c2cf293b58196
Diffstat (limited to 'offapi')
76 files changed, 138 insertions, 164 deletions
diff --git a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl index 09cf4de411cd..181ab31ba540 100644 --- a/offapi/com/sun/star/accessibility/XAccessibleComponent.idl +++ b/offapi/com/sun/star/accessibility/XAccessibleComponent.idl @@ -85,7 +85,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface an opaque rectangle then both the points (0,0) and (with-1,height-1) would yield a `TRUE` value.</p> - @param point + @param Point Coordinates of the point to test. The origin of the coordinate system is the upper left corner of the object's bounding box as returned by the getBounds(). The scale of the @@ -96,7 +96,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface Returns `TRUE` if the point lies within or on the object's bounding box and `FALSE` otherwise. */ - boolean containsPoint ([in] ::com::sun::star::awt::Point aPoint); + boolean containsPoint ([in] ::com::sun::star::awt::Point Point); /** Returns the Accessible child that is rendered under the given point. @@ -105,7 +105,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface an opaque rectangle then both the points (0,0) and (with-1,height-1) would yield a `TRUE` value.</p> - @param aPoint + @param Point Coordinates of the test point for which to find the Accessible child. The origin of the coordinate system is the upper left corner of the object's bounding box as returned by the @@ -120,7 +120,7 @@ interface XAccessibleComponent : ::com::sun::star::uno::XInterface painted on top of the others. If no there is no child which is rendered at the test point an empty reference is returned. */ - XAccessible getAccessibleAtPoint ([in] ::com::sun::star::awt::Point aPoint); + XAccessible getAccessibleAtPoint ([in] ::com::sun::star::awt::Point Point); /** Returns the bounding box of this object. diff --git a/offapi/com/sun/star/awt/XDisplayConnection.idl b/offapi/com/sun/star/awt/XDisplayConnection.idl index ec86e821e051..0bb18ef66f47 100644 --- a/offapi/com/sun/star/awt/XDisplayConnection.idl +++ b/offapi/com/sun/star/awt/XDisplayConnection.idl @@ -74,7 +74,7 @@ published interface XDisplayConnection: com::sun::star::uno::XInterface @param errorHandler the handler to remove. */ - void removeErrorHandler( [in] XEventHandler errorhandler ); + void removeErrorHandler( [in] XEventHandler errorHandler ); /** returns a identifier. diff --git a/offapi/com/sun/star/awt/XMenuExtended.idl b/offapi/com/sun/star/awt/XMenuExtended.idl index 892a26bb9c84..f5d2703b026f 100644 --- a/offapi/com/sun/star/awt/XMenuExtended.idl +++ b/offapi/com/sun/star/awt/XMenuExtended.idl @@ -51,10 +51,10 @@ interface XMenuExtended: com::sun::star::uno::XInterface @param nItemId specifies the menu item ID for which the help command URL be set. - @param aCommand + @param HelpCommand specifies the help command for the menu item. */ - void setHelpCommand( [in] short nItemId, [in] string aHelp ); + void setHelpCommand( [in] short nItemId, [in] string HelpCommand ); /** retrieves the help command string for the menu item. diff --git a/offapi/com/sun/star/awt/XToolkitExperimental.idl b/offapi/com/sun/star/awt/XToolkitExperimental.idl index dfe5f7ebfd48..8cbd88df8e6c 100644 --- a/offapi/com/sun/star/awt/XToolkitExperimental.idl +++ b/offapi/com/sun/star/awt/XToolkitExperimental.idl @@ -23,7 +23,7 @@ interface XToolkitExperimental : XToolkit2 * * @returns the device * - * @param addressOfMemoryBufferForSharedArrayWrapper is the address of a + * @param AddressOfMemoryBufferForSharedArrayWrapper is the address of a * (C++) object the exact type of which is to be determined, but the point * is that it will then be rewrapped into a boost::shared_array of bytes to * be passed to the basebmp code. shared_array has its own style of diff --git a/offapi/com/sun/star/awt/XUnitConversion.idl b/offapi/com/sun/star/awt/XUnitConversion.idl index 0e2cefc158ad..5c834d243b81 100644 --- a/offapi/com/sun/star/awt/XUnitConversion.idl +++ b/offapi/com/sun/star/awt/XUnitConversion.idl @@ -57,13 +57,13 @@ interface XUnitConversion: com::sun::star::uno::XInterface @return Return a new Point in Pixel type format. */ - com::sun::star::awt::Point convertPointToPixel( [in] com::sun::star::awt::Point aPoint, [in] short SourceUnit ) + com::sun::star::awt::Point convertPointToPixel( [in] com::sun::star::awt::Point Point, [in] short SourceUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); /** converts the given Size, which is specified in pixels, into the given logical unit - @param aSize + @param Size A given Size in a well known type @param TargetUnit A type from com::sun::star::util::MeasureUnit in which the Size will convert to. @@ -71,20 +71,20 @@ interface XUnitConversion: com::sun::star::uno::XInterface @return Returns a new Size in the TargetUnit type format. */ - com::sun::star::awt::Size convertSizeToLogic( [in] com::sun::star::awt::Size aSize, [in] short TargetUnit ) + com::sun::star::awt::Size convertSizeToLogic( [in] com::sun::star::awt::Size Size, [in] short TargetUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); /** converts the given Size, which is specified in the given logical unit, into pixels @param Size A given Size in a well known type - @param TargetUnit + @param SourceUnit The type from com::sun::star::util::MeasureUnit of the Size. @return Returns a new Size in the TargetUnit type format. */ - com::sun::star::awt::Size convertSizeToPixel( [in] com::sun::star::awt::Size aSize, [in] short SourceUnit ) + com::sun::star::awt::Size convertSizeToPixel( [in] com::sun::star::awt::Size Size, [in] short SourceUnit ) raises ( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/awt/XWindow2.idl b/offapi/com/sun/star/awt/XWindow2.idl index 7285ee561e0a..dab677ea0345 100644 --- a/offapi/com/sun/star/awt/XWindow2.idl +++ b/offapi/com/sun/star/awt/XWindow2.idl @@ -45,7 +45,7 @@ published interface XWindow2: com::sun::star::awt::XWindow the inner width and height of the window. */ - void setOutputSize( [in] com::sun::star::awt::Size aSize ); + void setOutputSize( [in] com::sun::star::awt::Size Size ); /** returns the inner bounds of the window, also known as the client size. diff --git a/offapi/com/sun/star/awt/grid/XGridColumn.idl b/offapi/com/sun/star/awt/grid/XGridColumn.idl index 69150290deaf..2e3ca12ee715 100644 --- a/offapi/com/sun/star/awt/grid/XGridColumn.idl +++ b/offapi/com/sun/star/awt/grid/XGridColumn.idl @@ -124,14 +124,14 @@ published interface XGridColumn @param Listener the listener to add. */ - void addGridColumnListener( [in] XGridColumnListener listener); + void addGridColumnListener( [in] XGridColumnListener Listener); /** Removes a listener previously added with addColumnListener(). @param Listener the listener to remove. */ - void removeGridColumnListener( [in] XGridColumnListener listener); + void removeGridColumnListener( [in] XGridColumnListener Listener); }; diff --git a/offapi/com/sun/star/awt/grid/XGridDataModel.idl b/offapi/com/sun/star/awt/grid/XGridDataModel.idl index 23808f24ace1..d80233174044 100644 --- a/offapi/com/sun/star/awt/grid/XGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridDataModel.idl @@ -92,7 +92,7 @@ published interface XGridDataModel <p>This method is provided for performance and convenience reasons, it delivers the same result as subsequent calls to getCellData() would.</p> - @param Row + @param RowIndex the index of the row whose data should is to be retrieved. @throws ::com::sun::star::lang::IndexOutOfBoundsException of the given row index does not denote a valid row. diff --git a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl index 4d2a345598c9..a6e968c4fcf8 100644 --- a/offapi/com/sun/star/awt/tab/XTabPageContainer.idl +++ b/offapi/com/sun/star/awt/tab/XTabPageContainer.idl @@ -41,7 +41,7 @@ published interface XTabPageContainer /** Checks whether a tab page is activated. - @param + @param tabPageIndex the tab page to be checked. @returns `TRUE` if tab page is activated, else `FALSE`. diff --git a/offapi/com/sun/star/awt/tree/XTreeControl.idl b/offapi/com/sun/star/awt/tree/XTreeControl.idl index 9f2b4c7a1315..718df7f969c3 100644 --- a/offapi/com/sun/star/awt/tree/XTreeControl.idl +++ b/offapi/com/sun/star/awt/tree/XTreeControl.idl @@ -247,7 +247,7 @@ interface XTreeControl /** Adds a XTreeEditListener. - @param xListener + @param Listener a XTreeEditListener that will be notified before and after a tree node is edited. */ @@ -255,7 +255,7 @@ interface XTreeControl /** Removes a XTreeEditListener. - @param xListener + @param Listener the XTreeEditListener to remove */ void removeTreeEditListener( [in] XTreeEditListener Listener ); diff --git a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl index 52401abab621..c90574919a53 100644 --- a/offapi/com/sun/star/chart2/XChartTypeTemplate.idl +++ b/offapi/com/sun/star/chart2/XChartTypeTemplate.idl @@ -160,18 +160,6 @@ interface XChartTypeTemplate : ::com::sun::star::uno::XInterface */ XDataInterpreter getDataInterpreter(); - /** Applies default styles to the given XDataSeries. - - The default implementation assigns the system-wide chart-color defaults - as "Color" property to all series. - - @param nIndex - The index of the series. This is used to obtain a default style - (e.g. color) for the nth series. - */ -// void applyDefaultStyle( [in] XDataSeries xSeries, -// [in] long nSeriesIndex ); - /** Applies a chart-type specific style (e.g. symbols) to all series in the sequence aSeries. diff --git a/offapi/com/sun/star/chart2/XInternalDataProvider.idl b/offapi/com/sun/star/chart2/XInternalDataProvider.idl index e34b2b83a3bf..ed5c5186823f 100644 --- a/offapi/com/sun/star/chart2/XInternalDataProvider.idl +++ b/offapi/com/sun/star/chart2/XInternalDataProvider.idl @@ -40,7 +40,7 @@ interface XInternalDataProvider : com::sun::star::chart2::data::XDataProvider sequence< any > getDataByRangeRepresentation( [in] string aRange ); void setDataByRangeRepresentation( [in] string aRange, [in] sequence< any > aNewData ); - /** @param Note that -1 is allowed as the sequence is inserted + /** @note Note that -1 is allowed as the sequence is inserted after the given index. So to insert a sequence as the new first sequence (index 0), you would pass -1 here. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl index 2e65562a0aa1..dd9f15b78946 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.idl @@ -67,7 +67,7 @@ published interface XDragSourceContext: com::sun::star::uno::XInterface /** This method sets the current drag image. - @param dragImage + @param imageId The identifier the drag source returned when registering the image (0 = none). Invalid identifier will be ignored. */ diff --git a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl index 1d574c49406b..5229d18e77c1 100644 --- a/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl +++ b/offapi/com/sun/star/datatransfer/dnd/XDropTargetListener.idl @@ -55,7 +55,7 @@ published interface XDropTargetListener: com::sun::star::lang::XEventListener /** Called when a drag operation has encountered the drop target. - @param dtde + @param dtdee The DropTargetDragEvent. */ diff --git a/offapi/com/sun/star/deployment/XExtensionManager.idl b/offapi/com/sun/star/deployment/XExtensionManager.idl index 47d666a7869f..d6c92cec3012 100644 --- a/offapi/com/sun/star/deployment/XExtensionManager.idl +++ b/offapi/com/sun/star/deployment/XExtensionManager.idl @@ -190,7 +190,7 @@ interface XExtensionManager /** gets an installed extensions. - @param repositroy + @param repository the name of the repository @param identifier extension identifier @@ -254,7 +254,7 @@ interface XExtensionManager @param force set to true when called during soffice bootstrap after cleaning old extension cache - @param repositroy + @param repository the name of the repository @param xAbortChannel abort channel to asynchronously abort the adding process diff --git a/offapi/com/sun/star/deployment/XPackageManager.idl b/offapi/com/sun/star/deployment/XPackageManager.idl index 7f19a83bd46b..b19d16f14215 100644 --- a/offapi/com/sun/star/deployment/XPackageManager.idl +++ b/offapi/com/sun/star/deployment/XPackageManager.idl @@ -254,11 +254,11 @@ interface XPackageManager Added extensions will be added to the database and removed extensions will be removed from the database. - @param xAddedExtension - new extensions which may need to be registered. + @param xAbortChannel + abort channel to asynchronously abort the adding process + @param xCmdEnv + command environment for error and progress handling - @param - removed extensions which must be revoked @return If true - then at least one extension was removed or added. Otherwise nothing was changed. diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index 4b19165f66bf..3ab2a2c64256 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -76,10 +76,6 @@ interface XPackageRegistry media type of package, empty string if to be detected @param removed - @param unfulfilledPrerequisites - has a value other null if the extension could not be installed previously - because XPackage::checkPrerequisites() failed. - @param identifier the identifier of the extension diff --git a/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl b/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl index ce2d7ef56927..044bd98f348d 100644 --- a/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl +++ b/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl @@ -36,7 +36,7 @@ interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface { /** provides the access to a substorage with specified name - @param sStorageName + @param StorageName the name of requested substorage @param nMode @@ -46,7 +46,7 @@ interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface XStorage implementation that refers to specified substorage */ com::sun::star::embed::XStorage getDocumentSubStorage( - [in] string aStorageName, + [in] string StorageName, [in] long nMode ); /** provides the list of substorages diff --git a/offapi/com/sun/star/drawing/XShapeCombiner.idl b/offapi/com/sun/star/drawing/XShapeCombiner.idl index 6610210d998c..26cb7fe1cb17 100644 --- a/offapi/com/sun/star/drawing/XShapeCombiner.idl +++ b/offapi/com/sun/star/drawing/XShapeCombiner.idl @@ -55,14 +55,14 @@ published interface XShapeCombiner: com::sun::star::uno::XInterface /** splits Shapes. - @param xShapes + @param Group the Shape is converted to a PolyPolygonBezierShapes and then split into several PolyPolygonBezierShapes The Shapes in xShape will be removed from the GenericDrawPage and disposed. */ - void split( [in] com::sun::star::drawing::XShape xGroup ); + void split( [in] com::sun::star::drawing::XShape Group ); }; diff --git a/offapi/com/sun/star/drawing/framework/XConfiguration.idl b/offapi/com/sun/star/drawing/framework/XConfiguration.idl index 3217d59ecf03..a432359c1322 100644 --- a/offapi/com/sun/star/drawing/framework/XConfiguration.idl +++ b/offapi/com/sun/star/drawing/framework/XConfiguration.idl @@ -50,7 +50,7 @@ interface XConfiguration This anchor typically is either a pane or an empty XResourceId object. An empty reference is treated like an XResourceId object. - @param sURLPrefix + @param sTargetURLPrefix When a non-empty string is given then resource ids are returned only when their resource URL matches this prefix, i.e. when it begins with this prefix or is equal to it. Characters with @@ -116,7 +116,7 @@ interface XConfiguration When an empty resource id is given then an IllegalArgumentException is thrown. */ - void removeResource ([in] XResourceId xResource); + void removeResource ([in] XResourceId xResourceId); }; }; }; }; }; }; // ::com::sun::star::drawing::framework diff --git a/offapi/com/sun/star/drawing/framework/XResourceId.idl b/offapi/com/sun/star/drawing/framework/XResourceId.idl index 3e0c3c8172ce..216502cebf84 100644 --- a/offapi/com/sun/star/drawing/framework/XResourceId.idl +++ b/offapi/com/sun/star/drawing/framework/XResourceId.idl @@ -101,7 +101,7 @@ interface XResourceId <p>Note that not only the anchor of the given object is taken into account. The whole object, including the resource URL, is interpreted as anchor resource.</p> - @param xAnchor + @param xAnchorId The resource id of the anchor. @param eMode This mode specifies how the called resource has to be bound to @@ -112,7 +112,7 @@ interface XResourceId of the anchor of the called resource. */ boolean isBoundTo ( - [in] XResourceId xId, + [in] XResourceId xAnchorId, [in] AnchorBindingMode eMode); /** Return whether the anchor of the called resource id object @@ -120,7 +120,7 @@ interface XResourceId convenience variant of the isBoundTo() function that can also be seen as an optimization for the case that the anchor consists of exactly one URL. - @param xAnchor + @param AnchorURL The resource URL of the anchor. @param eMode This mode specifies how the called resource has to be bound to @@ -129,7 +129,7 @@ interface XResourceId information. */ boolean isBoundToURL ( - [in] string sAnchorURL, + [in] string AnchorURL, [in] AnchorBindingMode eMode); /** Return a copy of the called resource id. The caller becomes the diff --git a/offapi/com/sun/star/embed/InstanceLocker.idl b/offapi/com/sun/star/embed/InstanceLocker.idl index 7e2614cf9609..f46435ef9dd1 100644 --- a/offapi/com/sun/star/embed/InstanceLocker.idl +++ b/offapi/com/sun/star/embed/InstanceLocker.idl @@ -82,7 +82,7 @@ published service InstanceLocker : com::sun::star::lang::XComponent values in this case: "PreventClose", "PreventTermination" ). */ InstanceLockerCtor2( [in] com::sun::star::uno::XInterface xInstance, - [in] long aActions, + [in] long nActions, [in] XActionsApproval xApprove ) raises( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::frame::DoubleInitializationException, diff --git a/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl b/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl index 31e24aa8cfe0..b61c5cc62505 100644 --- a/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl +++ b/offapi/com/sun/star/embed/XHierarchicalStorageAccess.idl @@ -107,7 +107,7 @@ published interface XHierarchicalStorageAccess method will return an empty reference. </p> - @param sStreamPath + @param sStreamName the path to the substream that should be open @param nOpenMode diff --git a/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl b/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl index 99f043dc7693..35413a73173a 100644 --- a/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl +++ b/offapi/com/sun/star/embed/XHierarchicalStorageAccess2.idl @@ -43,7 +43,7 @@ interface XHierarchicalStorageAccess2 : XHierarchicalStorageAccess method will return an empty reference. </p> - @param sStreamPath + @param sStreamName the path to the substream that should be open @param nOpenMode diff --git a/offapi/com/sun/star/embed/XLinkFactory.idl b/offapi/com/sun/star/embed/XLinkFactory.idl index 72c2553ad2d8..b28137ced5ae 100644 --- a/offapi/com/sun/star/embed/XLinkFactory.idl +++ b/offapi/com/sun/star/embed/XLinkFactory.idl @@ -44,7 +44,7 @@ published interface XLinkFactory: com::sun::star::uno::XInterface @param aClassID the class id of the new object - @param aClassName + @param ClassName the class name of the new object @param xStorage @@ -73,7 +73,7 @@ published interface XLinkFactory: com::sun::star::uno::XInterface */ ::com::sun::star::uno::XInterface createInstanceLinkUserInit( [in] sequence< byte > aClassID, - [in] string sClassName, + [in] string ClassName, [in] ::com::sun::star::embed::XStorage xStorage, [in] string sEntryName, [in] sequence< ::com::sun::star::beans::PropertyValue > aArgs, diff --git a/offapi/com/sun/star/embed/XStorage.idl b/offapi/com/sun/star/embed/XStorage.idl index 22bf6a7a39b8..838b79d6d559 100644 --- a/offapi/com/sun/star/embed/XStorage.idl +++ b/offapi/com/sun/star/embed/XStorage.idl @@ -318,7 +318,7 @@ published interface XStorage transaction in the storage. </p> - @param xStorage + @param xTargetStorage the target storage that will be filled in with copy. @throws ::com::sun::star::embed::InvalidStorageException @@ -350,7 +350,7 @@ published interface XStorage @param sStorName the name of the storage that should be copied - @param xStorage + @param xTargetStorage the target storage that will be filled in with copy @throws ::com::sun::star::embed::InvalidStorageException diff --git a/offapi/com/sun/star/embed/XStorageRawAccess.idl b/offapi/com/sun/star/embed/XStorageRawAccess.idl index 3bc8ecaed23f..c9c27a844efe 100644 --- a/offapi/com/sun/star/embed/XStorageRawAccess.idl +++ b/offapi/com/sun/star/embed/XStorageRawAccess.idl @@ -100,9 +100,6 @@ published interface XStorageRawAccess @param sStreamName the name of the substream that should be open - @param xInputStream - a raw stream representing encrypted stream - @throws ::com::sun::star::embed::InvalidStorageException this storage is in invalid state for any reason @@ -150,7 +147,7 @@ published interface XStorageRawAccess @param sStreamName the name of the substream that should be open - @param xInputStream + @param xInStream a raw stream representing encrypted stream @throws ::com::sun::star::embed::InvalidStorageException diff --git a/offapi/com/sun/star/form/XSubmitListener.idl b/offapi/com/sun/star/form/XSubmitListener.idl index 40dae6c764d9..b22183ed3d57 100644 --- a/offapi/com/sun/star/form/XSubmitListener.idl +++ b/offapi/com/sun/star/form/XSubmitListener.idl @@ -44,13 +44,13 @@ published interface XSubmitListener: com::sun::star::lang::XEventListener /** is invoked when a component is about to submit it's data. - @param aEvent + @param Event the event happened @returns `TRUE` when submitting was approved, otherwise `FALSE`. */ - boolean approveSubmit( [in] com::sun::star::lang::EventObject rEvent ); + boolean approveSubmit( [in] com::sun::star::lang::EventObject Event ); }; diff --git a/offapi/com/sun/star/form/validation/XValidator.idl b/offapi/com/sun/star/form/validation/XValidator.idl index 83520fc2a3e1..bacca77031a0 100644 --- a/offapi/com/sun/star/form/validation/XValidator.idl +++ b/offapi/com/sun/star/form/validation/XValidator.idl @@ -44,7 +44,7 @@ interface XValidator : com::sun::star::uno::XInterface { /** determines whether the given value is valid - @param aValue + @param Value the value to check for validity @return `TRUE` if and only if the value is considered valid. @@ -53,7 +53,7 @@ interface XValidator : com::sun::star::uno::XInterface /** retrieves a justification for the invalidity of the given value - @param aValue + @param Value the value which has been recognized as being invalid @return a human-readable string, which explains why the given value is considered invalid. diff --git a/offapi/com/sun/star/frame/XBorderResizeListener.idl b/offapi/com/sun/star/frame/XBorderResizeListener.idl index 6980bb146459..5cc6e836f582 100644 --- a/offapi/com/sun/star/frame/XBorderResizeListener.idl +++ b/offapi/com/sun/star/frame/XBorderResizeListener.idl @@ -33,13 +33,14 @@ interface XBorderResizeListener: com::sun::star::lang::XEventListener /** notifies the listener that the controller's border widths have been changed. - @param aObject + @param Object reference to the object representing the controller @param NewSize the new widths of the controller's border */ - void borderWidthsChanged( [in] ::com::sun::star::uno::XInterface aObject, [in] BorderWidths aNewSize ); + void borderWidthsChanged( [in] ::com::sun::star::uno::XInterface Object, + [in] BorderWidths NewSize ); }; diff --git a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl index 6744d2ecbcd6..00e7177648f5 100644 --- a/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl +++ b/offapi/com/sun/star/frame/XDispatchProviderInterceptor.idl @@ -48,7 +48,7 @@ published interface XDispatchProviderInterceptor: XDispatchProvider XDispatchProvider::queryDispatch() can be forwarded under control of this dispatch provider. - @param xNewDispatchProvider + @param NewDispatchProvider the new slave of this interceptor @see XDispatchProviderInterceptor::getSlaveDispatchProvider() diff --git a/offapi/com/sun/star/frame/XDocumentTemplates.idl b/offapi/com/sun/star/frame/XDocumentTemplates.idl index 68085643004b..406418255ac2 100644 --- a/offapi/com/sun/star/frame/XDocumentTemplates.idl +++ b/offapi/com/sun/star/frame/XDocumentTemplates.idl @@ -119,9 +119,12 @@ published interface XDocumentTemplates: com::sun::star::uno::XInterface @param GroupName specifies the group which include the template - @param TemplateName + @param OldTemplateName specifies the template for renaming + @param NewTemplateName + specifies the new name for the template + @return `TRUE` if operation was successful <br> diff --git a/offapi/com/sun/star/frame/XSessionManagerClient.idl b/offapi/com/sun/star/frame/XSessionManagerClient.idl index c784f77346c7..247733f7d6de 100644 --- a/offapi/com/sun/star/frame/XSessionManagerClient.idl +++ b/offapi/com/sun/star/frame/XSessionManagerClient.idl @@ -72,7 +72,7 @@ module com { module sun { module star { module frame { /** saveDone signals that a listener has processed a save request - @param listener + @param xListener the listener having finished save request processing @see XSessionManagerListener diff --git a/offapi/com/sun/star/frame/XStatusbarController.idl b/offapi/com/sun/star/frame/XStatusbarController.idl index 079fd3191153..313dbe708a7b 100644 --- a/offapi/com/sun/star/frame/XStatusbarController.idl +++ b/offapi/com/sun/star/frame/XStatusbarController.idl @@ -178,7 +178,7 @@ interface XStatusbarController a reference to a com::sun::star::awt::XGraphics which has to be used to update the visual representation. - @param nCommand + @param OutputRectangle a com::sun::star::awt::Rectangle which determine the output rectangle for all drawing operations @@ -186,7 +186,7 @@ interface XStatusbarController reserved for future use. */ void paint( [in] ::com::sun::star::awt::XGraphics xGraphics, - [in] ::com::sun::star::awt::Rectangle rOutputRectangle, + [in] ::com::sun::star::awt::Rectangle OutputRectangle, [in] long nStyle ); /** is called by a status bar if the user clicked with mouse into the diff --git a/offapi/com/sun/star/frame/XToolbarController.idl b/offapi/com/sun/star/frame/XToolbarController.idl index ea6f8d5196e6..c8f7578ab59a 100644 --- a/offapi/com/sun/star/frame/XToolbarController.idl +++ b/offapi/com/sun/star/frame/XToolbarController.idl @@ -44,7 +44,7 @@ interface XToolbarController : com::sun::star::uno::XInterface { /** provides a function to execute the command which is bound to the toolbar controller. - @param + @param KeyModifier a combination of com::sun::star::awt::KeyModifier value that represent the current state of the modifier keys. diff --git a/offapi/com/sun/star/graphic/XGraphicRasterizer.idl b/offapi/com/sun/star/graphic/XGraphicRasterizer.idl index 19c0c491debc..593976c634c6 100644 --- a/offapi/com/sun/star/graphic/XGraphicRasterizer.idl +++ b/offapi/com/sun/star/graphic/XGraphicRasterizer.idl @@ -104,13 +104,13 @@ interface XGraphicRasterizer : ::com::sun::star::uno::XInterface values into account. The rotation is applied after scaling and shearing the original image. - @param ShearXAngle + @param ShearAngle_X The horizontal shear angle of the graphic to be rasterized. This parameter is used without taking other transformation values into account. The shearing is applied after scaling and before rotation of the image. - @param ShearYAngle + @param ShearAngle_Y The vertical shear angle of the graphic to be rasterized. This parameter is used without taking other transformation values into account. The shearing is applied after scaling @@ -119,10 +119,6 @@ interface XGraphicRasterizer : ::com::sun::star::uno::XInterface @param RasterizeProperties Additional properties for special needs (undefined by now) - @param Graphic - An interface to a graphic container into which the given data - should be rasterized. - @returns com::sun::star::graphic::XGraphic An interface to a graphic container that holds the rasterized pixel data diff --git a/offapi/com/sun/star/i18n/XTextConversion.idl b/offapi/com/sun/star/i18n/XTextConversion.idl index 0c48f84df33b..adfa7a3a5077 100644 --- a/offapi/com/sun/star/i18n/XTextConversion.idl +++ b/offapi/com/sun/star/i18n/XTextConversion.idl @@ -45,7 +45,7 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface The start position in aText for the conversion @param nLength The length of the portion in aText for the conversion - @param aLocal + @param Locale Locale the conversion is referring to. @param nTextConversionType One of TextConversionType values. @@ -62,7 +62,7 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface [in] string aText, [in] long nStartPos, [in] long nLength, - [in] ::com::sun::star::lang::Locale aLocale, + [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions ) raises( com::sun::star::lang::IllegalArgumentException, @@ -78,7 +78,7 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface The start position in aText for the conversion @param nLength The length of the portion in aText for the conversion - @param aLocal + @param Locale Locale the conversion is referring to. @param nTextConversionType One of TextConversionType values. @@ -95,7 +95,7 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface [in] string aText, [in] long nStartPos, [in] long nLength, - [in] ::com::sun::star::lang::Locale aLocale, + [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions ) raises( com::sun::star::lang::IllegalArgumentException, @@ -104,7 +104,7 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface /** Method to query if the conversion type should be interactive or non-interactive mode. - @param aLocal + @param Locale Locale the conversion is referring to. @param nTextConversionType One of TextConversionType values. @@ -119,7 +119,7 @@ published interface XTextConversion : ::com::sun::star::uno::XInterface or when the locale is not supported. */ boolean interactiveConversion( - [in] ::com::sun::star::lang::Locale aLocale, + [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions ) raises( com::sun::star::lang::IllegalArgumentException, diff --git a/offapi/com/sun/star/i18n/XTransliteration.idl b/offapi/com/sun/star/i18n/XTransliteration.idl index 8e50e6baa794..730ba787e153 100644 --- a/offapi/com/sun/star/i18n/XTransliteration.idl +++ b/offapi/com/sun/star/i18n/XTransliteration.idl @@ -168,11 +168,11 @@ published interface XTransliteration: com::sun::star::uno::XInterface object doesn't have TransliterationType IGNORE attribute. - @param aStr + @param aInStr The input string. @param nStartPos - Start position within aStr from where transliteration starts. + Start position within aInStr from where transliteration starts. @param nCount Number of code points to be transliterated. diff --git a/offapi/com/sun/star/linguistic2/XConversionDictionary.idl b/offapi/com/sun/star/linguistic2/XConversionDictionary.idl index 6951fdd2b6fd..a20a4a6130ec 100644 --- a/offapi/com/sun/star/linguistic2/XConversionDictionary.idl +++ b/offapi/com/sun/star/linguistic2/XConversionDictionary.idl @@ -75,7 +75,7 @@ published interface XConversionDictionary : com::sun::star::uno::XInterface /** specifies whether the dictionary should be used or not . - @param bAcvtivate + @param bActivate `TRUE` if the dictionary should be used, `FALSE` otherwise. */ @@ -110,7 +110,7 @@ published interface XConversionDictionary : com::sun::star::uno::XInterface @param nLength the length of the substring to be looked for. - @param eConversionDirection + @param eDirection specifies the direction of the conversion to look for. It is one of com::sun::star::linguistic2::ConversionDirection. diff --git a/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl b/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl index 541734c417db..9740178f8578 100644 --- a/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XConversionDictionaryList.idl @@ -124,7 +124,7 @@ published interface XConversionDictionaryList : com::sun::star::uno::XInterface can be used for. It is one of com::sun::star::linguistic2::ConversionDictionaryType. - @param eConversionDirection + @param eDirection specifies the direction of the conversion to look for. It is one of com::sun::star::linguistic2::ConversionDirection. diff --git a/offapi/com/sun/star/linguistic2/XDictionary.idl b/offapi/com/sun/star/linguistic2/XDictionary.idl index f70ed85cea5a..c184642c769d 100644 --- a/offapi/com/sun/star/linguistic2/XDictionary.idl +++ b/offapi/com/sun/star/linguistic2/XDictionary.idl @@ -59,7 +59,7 @@ published interface XDictionary : com::sun::star::container::XNamed /** specifies whether the dictionary should be used or not . - @param bAcvtivate + @param bActivate `TRUE` if the dictionary should be used, `FALSE` otherwise. */ diff --git a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl index dd68e618754f..02ff11cd3ac8 100644 --- a/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl +++ b/offapi/com/sun/star/linguistic2/XSearchableDictionaryList.idl @@ -51,7 +51,7 @@ published interface XSearchableDictionaryList : com::sun::star::linguistic2::XDi @param aLocale the language of the word to be looked for. - @param bSearchPosDic + @param bSearchPosDics `TRUE` if only positive dictionaries should be searched. `FALSE` if only negative dictionaries should be searched. diff --git a/offapi/com/sun/star/logging/XLogger.idl b/offapi/com/sun/star/logging/XLogger.idl index ea2912d8672d..5ee092287e05 100644 --- a/offapi/com/sun/star/logging/XLogger.idl +++ b/offapi/com/sun/star/logging/XLogger.idl @@ -124,7 +124,7 @@ interface XLogger @param Message the message to log */ - void logp( [in] long Level, [in] string SourceClassName, [in] string SourceMethodName, [in] string Message ); + void logp( [in] long Level, [in] string SourceClass, [in] string SourceMethod, [in] string Message ); }; diff --git a/offapi/com/sun/star/mozilla/XPluginInstance.idl b/offapi/com/sun/star/mozilla/XPluginInstance.idl index 2221ed6a5b49..82f94a52e768 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstance.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstance.idl @@ -67,7 +67,7 @@ published interface XPluginInstance: com::sun::star::uno::XInterface @param theURL [in]: the URL that denotes the stream @param filter [in]: a filter string to suggest a component that should handle the document @param stream [in]: the data stream - @param sessiondata [in]: the data specifying the current session + @param sessionData [in]: the data specifying the current session */ void newStream( @@ -84,7 +84,7 @@ published interface XPluginInstance: com::sun::star::uno::XInterface @param MIMEDesc [in]: the MIMEtype of the data stream @param theURL [in]: the URL to be opened @param filter [in]: a filter string to suggest a component that should handle the document - @param sessiondata [in]: the data specifying the current session + @param sessionData [in]: the data specifying the current session */ void newURL( [in] string MIMEDesc, [in] string theURL, [in] string filter, [in] any sessionData ); @@ -92,7 +92,7 @@ published interface XPluginInstance: com::sun::star::uno::XInterface /** Retrieves the URL of the HTTP Load balancing Slave. - @param aURL [out]: the full qualified host name of the LBS + @param aHost [out]: the full qualified host name of the LBS @param aPort [out]: the port number @param aPrefix [out]: the url prefix to the portal diff --git a/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl b/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl index 66e14e180180..1c87cf241c28 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstancePeer.idl @@ -47,7 +47,7 @@ published interface XPluginInstancePeer: com::sun::star::uno::XInterface @return <CODE>TRUE</CODE> on success */ - boolean setWindowSize( [in] long width, [in] long heigth ); + boolean setWindowSize( [in] long width, [in] long height ); /** Show status / hint message in browser's message area. diff --git a/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl b/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl index 10dbc777eab1..2aeb3e522a63 100644 --- a/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl +++ b/offapi/com/sun/star/mozilla/XPluginInstanceSyncPeer.idl @@ -34,7 +34,7 @@ published interface XPluginInstanceSyncPeer : com::sun::star::uno::XInterface /** Opens a new browser window with a plugin instance synchronously. @param aInstance [out]: new plugin instance in case of success - @param Any [out]: linkage to the window data + @param aLinkage [out]: linkage to the window data @param embedded [out]: selects embedded or full page plugin mode @@ -42,7 +42,7 @@ published interface XPluginInstanceSyncPeer : com::sun::star::uno::XInterface void openNewBrowserWindow( [out] XPluginInstance aInstance, [out] any aLinkage, - [out] boolean embeded); + [out] boolean embedded); }; diff --git a/offapi/com/sun/star/presentation/XSlideShow.idl b/offapi/com/sun/star/presentation/XSlideShow.idl index 41013ac2e02f..fe232b372d6e 100644 --- a/offapi/com/sun/star/presentation/XSlideShow.idl +++ b/offapi/com/sun/star/presentation/XSlideShow.idl @@ -116,13 +116,13 @@ interface XSlideShow : ::com::sun::star::uno::XInterface method does nothing (this especially means, that any currently active effects will remain running).<p> - @param xPage + @param xSlide The slide to display. @param xDrawPages For future use. - @param xAnimationNode + @param AnimationNode The animation node determine the animations to display. @param aProperties @@ -159,7 +159,7 @@ interface XSlideShow : ::com::sun::star::uno::XInterface void displaySlide( [in] ::com::sun::star::drawing::XDrawPage xSlide, [in] ::com::sun::star::drawing::XDrawPagesSupplier xDrawPages, - [in] ::com::sun::star::animations::XAnimationNode aAnimationNode, + [in] ::com::sun::star::animations::XAnimationNode AnimationNode, [in] sequence< ::com::sun::star::beans::PropertyValue > aProperties ); /** Change the pause state of the slide show.<p> diff --git a/offapi/com/sun/star/presentation/XTransitionFactory.idl b/offapi/com/sun/star/presentation/XTransitionFactory.idl index 1eef9672b0ce..71da161a7c5e 100644 --- a/offapi/com/sun/star/presentation/XTransitionFactory.idl +++ b/offapi/com/sun/star/presentation/XTransitionFactory.idl @@ -60,10 +60,6 @@ interface XTransitionFactory : ::com::sun::star::uno::XInterface @param enteringBitmap Bitmap of the slide that's going to enter the screen - - @param slideOffset - Offset in pixel from the top, left edge of the view, such that the - slide displays similar to normal slide show */ XTransition createTransition( [in] short transitionType, [in] short transitionSubType, diff --git a/offapi/com/sun/star/rendering/XCanvas.idl b/offapi/com/sun/star/rendering/XCanvas.idl index d01cd5a9863e..029da2224e56 100644 --- a/offapi/com/sun/star/rendering/XCanvas.idl +++ b/offapi/com/sun/star/rendering/XCanvas.idl @@ -399,7 +399,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The render state to be used when filling this polygon. - @param aTextures + @param xTextures A sequence of texture definitions, with which to fill the polygonal area. @@ -434,7 +434,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface @param aRenderState The render state to be used when filling this polygon. - @param aTextures + @param xTextures A sequence of texture definitions, with which to fill the polygonal area. @@ -507,7 +507,7 @@ interface XCanvas : ::com::sun::star::uno::XInterface or the "don't care" value restricts the list of returned fonts to contain only those that have the specified attribute. - @param xFontProperties + @param aFontProperties This interface can provide additional font properties to filter the list of available fonts against. diff --git a/offapi/com/sun/star/rendering/XColorSpace.idl b/offapi/com/sun/star/rendering/XColorSpace.idl index 3d8f3a050299..de47f2abf4c8 100644 --- a/offapi/com/sun/star/rendering/XColorSpace.idl +++ b/offapi/com/sun/star/rendering/XColorSpace.idl @@ -182,7 +182,7 @@ interface XColorSpace If this color space conveys alpha information, it is assumed be fully opaque for the given RGB color value. - @param deviceColor Sequence of sRGB color components. Is + @param rgbColor Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. diff --git a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl index b700faf1d14f..c15285ef1a1d 100644 --- a/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl +++ b/offapi/com/sun/star/rendering/XIntegerBitmapColorSpace.idl @@ -204,7 +204,7 @@ interface XIntegerBitmapColorSpace : XColorSpace are properly rounded and clipped, to be valid in the target color space.<p> - @param deviceColor Sequence of sRGB color components. Is + @param rgbColor Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. @@ -224,7 +224,7 @@ interface XIntegerBitmapColorSpace : XColorSpace properly rounded and clipped, to be valid in the target color space.<p> - @param deviceColor Sequence of sRGB color components. Is + @param rgbColor Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. @@ -245,7 +245,7 @@ interface XIntegerBitmapColorSpace : XColorSpace properly rounded and clipped, to be valid in the target color space.<p> - @param deviceColor Sequence of sRGB color components. Is + @param rgbColor Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. The individual RGB color values are assumed to be premultiplied by diff --git a/offapi/com/sun/star/report/XReportEngine.idl b/offapi/com/sun/star/report/XReportEngine.idl index 6372e441804b..99036b1c43c2 100644 --- a/offapi/com/sun/star/report/XReportEngine.idl +++ b/offapi/com/sun/star/report/XReportEngine.idl @@ -67,7 +67,7 @@ interface XReportEngine ::com::sun::star::uno::Exception ); /** creates a report document. - @param _frame + @param frame The frame must have a controller set. This controller will be set at the model. @throws com::sun::star::lang::DisposedException If the report engine is already disposed. diff --git a/offapi/com/sun/star/resource/XStringResourceManager.idl b/offapi/com/sun/star/resource/XStringResourceManager.idl index 3e53ef98bd1a..c602c7d7be19 100644 --- a/offapi/com/sun/star/resource/XStringResourceManager.idl +++ b/offapi/com/sun/star/resource/XStringResourceManager.idl @@ -56,7 +56,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol /** Sets the locale to be used - @param aLocale + @param Locale Specifies the current locale to be used. @param FindClosestMatch @@ -75,7 +75,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol */ void setCurrentLocale ( - [in] com::sun::star::lang::Locale locale, + [in] com::sun::star::lang::Locale Locale, [in] boolean FindClosestMatch ) raises( com::sun::star::lang::IllegalArgumentException ); @@ -83,7 +83,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol /** Sets the default locale to be used - @param aLocale + @param Locale Specifies the default locale to be used. If this locale is not available a com::sun::star::lang::IllegalArgumentException @@ -92,7 +92,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol @throws com::sun::star::lang::NoSupportException if the resource is read only, see isReadOnly() */ - void setDefaultLocale( [in] com::sun::star::lang::Locale locale ) + void setDefaultLocale( [in] com::sun::star::lang::Locale Locale ) raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NoSupportException ); diff --git a/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl b/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl index 77b94737f752..3bf4c8fbe472 100644 --- a/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl +++ b/offapi/com/sun/star/script/provider/XScriptProviderFactory.idl @@ -36,7 +36,7 @@ interface XScriptProviderFactory : ::com::sun::star::uno::XInterface { /** a factory method for the creation of XScriptProviders implementations. - @param sContext + @param Context is context for which the ScriptProvider is to be created for @returns @@ -45,7 +45,7 @@ interface XScriptProviderFactory : ::com::sun::star::uno::XInterface { @throws ::com::sun::star::lang::IllegalArgumentException if illegal or unknown context is passed */ - XScriptProvider createScriptProvider( [in] any context ) raises ( + XScriptProvider createScriptProvider( [in] any Context ) raises ( ::com::sun::star::lang::IllegalArgumentException ); }; diff --git a/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl b/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl index 33b0276efe1a..f77dffcb635e 100644 --- a/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl +++ b/offapi/com/sun/star/sdb/XRowSetApproveBroadcaster.idl @@ -34,13 +34,11 @@ published interface XRowSetApproveBroadcaster: com::sun::star::uno::XInterface /** adds the specified listener to receive the events "approveCursorMove", "approveRowChange", and "appproveRowSetChange". - @param com::sun::star::sdb::XRowSetApproveListener */ void addRowSetApproveListener( [in]XRowSetApproveListener listener ); /** removes the specified listener. - @param com::sun::star::sdb::XRowSetApproveListener */ void removeRowSetApproveListener( [in]XRowSetApproveListener listener ); diff --git a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl index 618bd17d3f49..e820eb805ed8 100644 --- a/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl +++ b/offapi/com/sun/star/sdb/XSQLErrorBroadcaster.idl @@ -35,13 +35,11 @@ published interface XSQLErrorBroadcaster: com::sun::star::uno::XInterface { /** adds the specified listener to receive the event "errorOccurred" - @param com::sun::star::sdb::XSQLErrorListener */ void addSQLErrorListener( [in]XSQLErrorListener Listener ); /** removes the specified listener. - @param com::sun::star::sdb::XSQLErrorListener */ void removeSQLErrorListener( [in]XSQLErrorListener Listener ); diff --git a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl index 3750698cfc6a..7a7f1d6ea3c0 100644 --- a/offapi/com/sun/star/sdb/tools/XConnectionTools.idl +++ b/offapi/com/sun/star/sdb/tools/XConnectionTools.idl @@ -91,7 +91,7 @@ interface XConnectionTools the object. This may be a table name, a query name, or an SQL statement, depending on the value of _nCommandType - @param _rxCollectionOner + @param keepFieldsAlive If (and only if) CommandType is CommandType.COMMAND, the fields collection which is returned by this function here is a temporary object. It is kept alive by another object, which is to be created temporarily, too. To ensure that the fields you get are valid as long as you need them, diff --git a/offapi/com/sun/star/sdbc/XConnection.idl b/offapi/com/sun/star/sdbc/XConnection.idl index 92ddb331fdf7..3548ac187d2e 100644 --- a/offapi/com/sun/star/sdbc/XConnection.idl +++ b/offapi/com/sun/star/sdbc/XConnection.idl @@ -296,7 +296,7 @@ published interface XConnection: com::sun::star::sdbc::XCloseable necessarily cause writes to be prohibited. </p> - @param readONly + @param readOnly `TRUE` enables read-only mode; `FALSE` disables read-only mode. @throws SQLException if a database access error occurs. diff --git a/offapi/com/sun/star/sheet/XDataPilotTables.idl b/offapi/com/sun/star/sheet/XDataPilotTables.idl index 20f804cf182a..75feee5e36b8 100644 --- a/offapi/com/sun/star/sheet/XDataPilotTables.idl +++ b/offapi/com/sun/star/sheet/XDataPilotTables.idl @@ -56,7 +56,7 @@ published interface XDataPilotTables: com::sun::star::container::XNameAccess @param aName the name of the data pilot table used in the collection. - @param aAoutputAddress + @param OutputAddress the top left cell of the location of the data pilot table in the spreadsheet document. @@ -67,7 +67,7 @@ published interface XDataPilotTables: com::sun::star::container::XNameAccess */ void insertNewByName( [in] string aName, - [in] com::sun::star::table::CellAddress aOutputAddress, + [in] com::sun::star::table::CellAddress OutputAddress, [in] com::sun::star::sheet::XDataPilotDescriptor xDescriptor ); diff --git a/offapi/com/sun/star/style/XStyleLoader.idl b/offapi/com/sun/star/style/XStyleLoader.idl index 5e6d8825c292..a695b79dde21 100644 --- a/offapi/com/sun/star/style/XStyleLoader.idl +++ b/offapi/com/sun/star/style/XStyleLoader.idl @@ -36,9 +36,9 @@ published interface XStyleLoader: com::sun::star::uno::XInterface If <var>OverwriteStyles</var> is `TRUE`, then all styles will be loaded. Otherwise, only styles which are not already defined in this document are loaded.</p> - @param string URL: + @param URL The directory and the filename from document with the styles - @param aOptions : + @param aOptions Specifies which of the Style families the method should load. The <code>sequence<PropertyValue></code> has the following, optional items: <ul> diff --git a/offapi/com/sun/star/table/XTable.idl b/offapi/com/sun/star/table/XTable.idl index 101634322935..5b7e9100cc83 100644 --- a/offapi/com/sun/star/table/XTable.idl +++ b/offapi/com/sun/star/table/XTable.idl @@ -73,7 +73,7 @@ interface XTable /** creates a cell cursor to travel in the given range context. - @param aRange + @param Range the cell range for the cursor. @throws com::sun::star::lang::IllegalArgumentException diff --git a/offapi/com/sun/star/task/XPasswordContainer.idl b/offapi/com/sun/star/task/XPasswordContainer.idl index 49cca216cc6c..93e2d3705d57 100644 --- a/offapi/com/sun/star/task/XPasswordContainer.idl +++ b/offapi/com/sun/star/task/XPasswordContainer.idl @@ -36,7 +36,7 @@ published interface XPasswordContainer : com::sun::star::uno::XInterface @param Url URL-pattern, that will be used later to retrieve passwords. - @param UseName The username. + @param UserName The username. @param Passwords The password-list. @@ -51,7 +51,7 @@ published interface XPasswordContainer : com::sun::star::uno::XInterface @param Url URL-pattern, that will be used later to retrieve passwords. - @param UseName The username. + @param UserName The username. @param Passwords The password-list. diff --git a/offapi/com/sun/star/text/XFlatParagraph.idl b/offapi/com/sun/star/text/XFlatParagraph.idl index acb0f256c506..2948e467518c 100644 --- a/offapi/com/sun/star/text/XFlatParagraph.idl +++ b/offapi/com/sun/star/text/XFlatParagraph.idl @@ -122,7 +122,7 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup @param nLen the length of the text. - @param nNewText + @param NewText new text. @param aAttributes @@ -131,7 +131,7 @@ interface XFlatParagraph: com::sun::star::text::XTextMarkup @throws IllegalArgumentException when any argument is wrong. */ - void changeText( [in] long nPos, [in] long nLen, [in] string aNewText, + void changeText( [in] long nPos, [in] long nLen, [in] string NewText, [in] sequence<::com::sun::star::beans::PropertyValue> aAttributes ) raises( com::sun::star::lang::IllegalArgumentException ); diff --git a/offapi/com/sun/star/ucb/XCommandInfo.idl b/offapi/com/sun/star/ucb/XCommandInfo.idl index 9b727cf393cc..8aaa13dd5fe5 100644 --- a/offapi/com/sun/star/ucb/XCommandInfo.idl +++ b/offapi/com/sun/star/ucb/XCommandInfo.idl @@ -86,7 +86,7 @@ published interface XCommandInfo: com::sun::star::uno::XInterface `TRUE` if a command with the specified handle is supported; otherwise `FALSE` is returned. - @param Name + @param Handle specifies the handle of the requested command. */ boolean hasCommandByHandle( [in] long Handle ); diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index e06ef8085e42..961ee7b40e4c 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -47,7 +47,7 @@ published interface XRemoteContentProviderChangeNotifier: /** Remove a listener. - @param Listener. + @param Listener Some listener previously added via XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener(). */ diff --git a/offapi/com/sun/star/ui/XImageManager.idl b/offapi/com/sun/star/ui/XImageManager.idl index 47d45aac1128..cad89a16f01f 100644 --- a/offapi/com/sun/star/ui/XImageManager.idl +++ b/offapi/com/sun/star/ui/XImageManager.idl @@ -67,13 +67,13 @@ interface XImageManager @param nImageType specifies the image type for this operation. - @param ResourceURL + @param CommandURL a command URL that should be checked for an associated image. @return `TRUE` if an image is associated, otherwise `FALSE`. */ - boolean hasImage( [in] short nImageType, [in] string aCommandURL ) raises ( com::sun::star::lang::IllegalArgumentException ); + boolean hasImage( [in] short nImageType, [in] string CommandURL ) raises ( com::sun::star::lang::IllegalArgumentException ); /** retrieves the associated images of command URLs. @@ -122,7 +122,7 @@ interface XImageManager @param nImageType specifies the image type for this association operation. - @param aCommandURLSequence + @param CommandURLs a sequence of command URLs for which the images should be removed. <p> @@ -133,7 +133,7 @@ interface XImageManager is thrown. </p> */ - void removeImages( [in] short nImageType, [in] sequence< string > aResourceURLSequence ) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IllegalAccessException ); + void removeImages( [in] short nImageType, [in] sequence< string > CommandURLs ) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IllegalAccessException ); /** inserts new image/command associations to a image manager. diff --git a/offapi/com/sun/star/ui/XUIConfigurationManager.idl b/offapi/com/sun/star/ui/XUIConfigurationManager.idl index a0b5ca6ea12b..b963dc4e222d 100644 --- a/offapi/com/sun/star/ui/XUIConfigurationManager.idl +++ b/offapi/com/sun/star/ui/XUIConfigurationManager.idl @@ -174,7 +174,7 @@ interface XUIConfigurationManager : ::com::sun::star::uno::XInterface /** inserts the settings of a new user interface element. - @param ResourceURL + @param NewResourceURL a resource URL which identifies the new user interface element. @param aNewData diff --git a/offapi/com/sun/star/ui/XUIElementFactoryRegistration.idl b/offapi/com/sun/star/ui/XUIElementFactoryRegistration.idl index 250bab9d9b71..7d184485c5b6 100644 --- a/offapi/com/sun/star/ui/XUIElementFactoryRegistration.idl +++ b/offapi/com/sun/star/ui/XUIElementFactoryRegistration.idl @@ -89,7 +89,7 @@ interface XUIElementFactoryRegistration : com::sun::star::uno::XInterface following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - @param ModuleName + @param ModuleIdentifier an optional module identifier. This value can remain empty, if a generic factory is requested. The module identifier can be retrieved from the com::sun::star::frame::ModuleManager service. */ @@ -137,7 +137,7 @@ interface XUIElementFactoryRegistration : com::sun::star::uno::XInterface interface element type class. This value can remain empty if no special factory for a single user interface element should be deregistered. - @param aModuleName + @param ModuleIdentifier an optional module name that can be used to deregister a factory only for a single module. This value can remain empty if not a module based factory should be deregistered. The module identifier can be retrieved from the com::sun::star::frame::ModuleManager service. @@ -148,7 +148,7 @@ interface XUIElementFactoryRegistration : com::sun::star::uno::XInterface </b> </p> */ - void deregisterFactory( [in] string aType, [in] string aName, [in] string aModuleIdentifier ) raises (com::sun::star::container::NoSuchElementException); + void deregisterFactory( [in] string aType, [in] string aName, [in] string ModuleIdentifier ) raises (com::sun::star::container::NoSuchElementException); }; }; }; }; }; diff --git a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl index c2baf8dd823b..e50db024c366 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePickerControlAccess.idl @@ -57,7 +57,7 @@ published interface XFilePickerControlAccess: com::sun::star::ui::dialogs::XFile @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds @see com::sun::star::ui::dialogs::ControlActions */ -void setValue( [in] short aControlId, [in] short aControlAction, [in] any aValue ); +void setValue( [in] short ControlId, [in] short aControlAction, [in] any aValue ); /** Get the value of an additional element within a FilePicker @@ -124,7 +124,7 @@ string getLabel( [in] short aControlId ); @see com::sun::star::ui::dialogs::CommonFilePickerElementIds @see com::sun::star::ui::dialogs::ExtendedFilePickerElementIds */ -void enableControl( [in] short aControlId, [in] boolean bEnable ); +void enableControl( [in] short ControlId, [in] boolean bEnable ); }; diff --git a/offapi/com/sun/star/util/NumberFormatsSupplier.idl b/offapi/com/sun/star/util/NumberFormatsSupplier.idl index 683d2a3a6746..d58fec9fde28 100644 --- a/offapi/com/sun/star/util/NumberFormatsSupplier.idl +++ b/offapi/com/sun/star/util/NumberFormatsSupplier.idl @@ -40,9 +40,9 @@ published service NumberFormatsSupplier : XNumberFormatsSupplier /** Create using specific locale. - @param aLocale the locale of the number formats supplier + @param Locale the locale of the number formats supplier */ - createWithLocale([in] com::sun::star::lang::Locale locale); + createWithLocale([in] com::sun::star::lang::Locale Locale); /** Create using default locale. diff --git a/offapi/com/sun/star/util/XNumberFormats.idl b/offapi/com/sun/star/util/XNumberFormats.idl index 88d3bd7b60af..5df638a57f3f 100644 --- a/offapi/com/sun/star/util/XNumberFormats.idl +++ b/offapi/com/sun/star/util/XNumberFormats.idl @@ -50,7 +50,7 @@ published interface XNumberFormats: com::sun::star::uno::XInterface the type of number formats to return. Must be one of the NumberFormat constants. - @param nLanguage + @param nLocale the language of number formats to return. @param bCreate diff --git a/offapi/com/sun/star/xml/crypto/XUriBinding.idl b/offapi/com/sun/star/xml/crypto/XUriBinding.idl index d62c595b0562..f0e42176601b 100644 --- a/offapi/com/sun/star/xml/crypto/XUriBinding.idl +++ b/offapi/com/sun/star/xml/crypto/XUriBinding.idl @@ -42,16 +42,17 @@ interface XUriBinding : com::sun::star::uno::XInterface * Sets the XInputStream interface for a uri. * * @param uri the uri to bind - * @param aStream the XInputStream to be binded + * @param InputStream the XInputStream to be bound */ - void setUriBinding([in] string uri, [in] com::sun::star::io::XInputStream aInputStream) + void setUriBinding([in] string uri, + [in] com::sun::star::io::XInputStream InputStream) raises( com::sun::star::uno::Exception ); /** * Gets the XInputStream interface for a uri. * * @param uri the uri whose binding is to get - * @return the XInputStream binded with the uri + * @return the XInputStream bound with the uri */ com::sun::star::io::XInputStream getUriBinding([in] string uri) raises( com::sun::star::uno::Exception ); diff --git a/offapi/com/sun/star/xml/input/XRoot.idl b/offapi/com/sun/star/xml/input/XRoot.idl index d9be774d15bb..8efb1a140a19 100644 --- a/offapi/com/sun/star/xml/input/XRoot.idl +++ b/offapi/com/sun/star/xml/input/XRoot.idl @@ -76,7 +76,7 @@ interface XRoot : com::sun::star::uno::XInterface namespace uid of element @param localName local name of element - @param xAattributes + @param xAttributes attributes of element */ XElement startRootElement( diff --git a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl index 8bcd45062347..509bcf823061 100644 --- a/offapi/com/sun/star/xml/sax/XFastAttributeList.idl +++ b/offapi/com/sun/star/xml/sax/XFastAttributeList.idl @@ -96,7 +96,7 @@ interface XFastAttributeList: com::sun::star::uno::XInterface @returns If the attribute is available it returns the integer token of the value from the attribute or FastToken::Invalid. - If not the value of <param>Default</param> is returned. + If not the value of <code>Default</code> is returned. */ long getOptionalValueToken( [in] long Token, [in] long Default ); diff --git a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl index a9996af32195..3acc13525499 100644 --- a/offapi/com/sun/star/xml/sax/XFastContextHandler.idl +++ b/offapi/com/sun/star/xml/sax/XFastContextHandler.idl @@ -47,7 +47,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface registered at the XFastParser.<br> If the element has a namespace that was registered with the - XFastParser, <param>Element</param> contains the integer + XFastParser, <code>Element</code> contains the integer token of the elements local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. @@ -96,7 +96,7 @@ interface XFastContextHandler: com::sun::star::uno::XInterface registered at the XFastParser. <br>If the element has a namespace that was registered with the - XFastParser, <param>Element</param> contains the + XFastParser, <code>Element</code> contains the integer token of the elements local name from the XFastTokenHandler and the integer token of the namespace combined with an arithmetic <b>or</b> operation. diff --git a/offapi/com/sun/star/xml/xpath/XXPathAPI.idl b/offapi/com/sun/star/xml/xpath/XXPathAPI.idl index 12f7c75f3f53..e400abff1487 100644 --- a/offapi/com/sun/star/xml/xpath/XXPathAPI.idl +++ b/offapi/com/sun/star/xml/xpath/XXPathAPI.idl @@ -134,7 +134,7 @@ interface XXPathAPI : com::sun::star::uno::XInterface */ com::sun::star::xml::dom::XNodeList selectNodeListNS( [in] com::sun::star::xml::dom::XNode contextNode, - [in] string str, + [in] string expr, [in] com::sun::star::xml::dom::XNode namespaceNode) raises( com::sun::star::xml::xpath::XPathException ); @@ -176,7 +176,7 @@ interface XXPathAPI : com::sun::star::uno::XInterface */ com::sun::star::xml::dom::XNode selectSingleNodeNS( [in] com::sun::star::xml::dom::XNode contextNode, - [in] string str, + [in] string expr, [in] com::sun::star::xml::dom::XNode namespaceNode) raises( com::sun::star::xml::xpath::XPathException ); |