From ddba7d155d07b9018a9f5bf051b6faa1bdac022b Mon Sep 17 00:00:00 2001 From: Michael Stahl Date: Tue, 30 Apr 2013 14:12:14 +0200 Subject: *api: convert all unsupported html tags Only useful ones appear to be and which doxygen doesn't support but we only use those in 3 places so who cares. Change-Id: I374f7d208873a8436fe76e0f800ce18df5b188b3 --- offapi/com/sun/star/awt/CharSet.idl | 2 +- offapi/com/sun/star/awt/XContainerWindowProvider.idl | 3 ++- offapi/com/sun/star/awt/XDialogProvider2.idl | 3 ++- offapi/com/sun/star/awt/tree/XTreeNode.idl | 5 +++-- offapi/com/sun/star/chart2/Symbol.idl | 6 +----- .../com/sun/star/chart2/XRegressionCurveCalculator.idl | 16 ++++++++-------- offapi/com/sun/star/deployment/XPackageRegistry.idl | 2 +- .../com/sun/star/drawing/XSlidePreviewCacheListener.idl | 2 +- offapi/com/sun/star/form/DataAwareControlModel.idl | 4 ++-- offapi/com/sun/star/form/FormComponents.idl | 3 ++- offapi/com/sun/star/form/XForms.idl | 3 ++- offapi/com/sun/star/form/runtime/XFilterController.idl | 2 +- offapi/com/sun/star/form/runtime/XFormController.idl | 5 ++--- offapi/com/sun/star/frame/ProtocolHandler.idl | 3 ++- offapi/com/sun/star/presentation/Presentation.idl | 2 +- offapi/com/sun/star/presentation/XPresentation2.idl | 2 +- offapi/com/sun/star/rendering/XCanvas.idl | 16 ++++++++-------- offapi/com/sun/star/report/XFixedLine.idl | 2 +- offapi/com/sun/star/sdb/DataSourceBrowser.idl | 2 +- offapi/com/sun/star/sdb/ErrorCondition.idl | 4 ++-- offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl | 6 +----- .../com/sun/star/sdb/application/XDatabaseDocumentUI.idl | 4 ++-- offapi/com/sun/star/style/XStyleLoader.idl | 2 +- offapi/com/sun/star/ui/dialogs/XWizard.idl | 2 +- .../reflection/XTypeDescriptionEnumerationAccess.idl | 4 +--- 25 files changed, 50 insertions(+), 55 deletions(-) diff --git a/offapi/com/sun/star/awt/CharSet.idl b/offapi/com/sun/star/awt/CharSet.idl index 6037db1a30ad..dfd3030f252f 100644 --- a/offapi/com/sun/star/awt/CharSet.idl +++ b/offapi/com/sun/star/awt/CharSet.idl @@ -49,7 +49,7 @@ published constants CharSet const short ANSI = 1; - /** specifies the Apple Macintosh character set. + /** specifies the Apple Macintosh character set. */ const short MAC = 2; diff --git a/offapi/com/sun/star/awt/XContainerWindowProvider.idl b/offapi/com/sun/star/awt/XContainerWindowProvider.idl index 0208d78b976d..454b575e8a3d 100644 --- a/offapi/com/sun/star/awt/XContainerWindowProvider.idl +++ b/offapi/com/sun/star/awt/XContainerWindowProvider.idl @@ -73,7 +73,8 @@ interface XContainerWindowProvider : ::com::sun::star::uno::XInterface { based access will be used. The Introspection based access tries to call a method named according to the - HandlerMethodName specified by a vnd.sun.star.UNO: URL. + HandlerMethodName specified by a + vnd.sun.star.UNO:HandlerMethodName URL. First a method void HandlerMethodName( [in] com::sun::star::awt::XWindow xWindow, [in] any aEvent ) diff --git a/offapi/com/sun/star/awt/XDialogProvider2.idl b/offapi/com/sun/star/awt/XDialogProvider2.idl index 73c419a4e709..7365e1196816 100644 --- a/offapi/com/sun/star/awt/XDialogProvider2.idl +++ b/offapi/com/sun/star/awt/XDialogProvider2.idl @@ -66,7 +66,8 @@ interface XDialogProvider2 : ::com::sun::star::awt::XDialogProvider { based access will be used. The Introspection based access tries to call a method named according to the - HandlerMethodName specified by a vnd.sun.star.UNO: URL. + HandlerMethodName specified by a + vnd.sun.star.UNO:HandlerMethodName URL. First a method void HandlerMethodName( [in] com::sun::star::awt::XDialog xDialog, [in] any aEvent ) diff --git a/offapi/com/sun/star/awt/tree/XTreeNode.idl b/offapi/com/sun/star/awt/tree/XTreeNode.idl index 0ddfce321a2f..4e5a0b4a8c7b 100644 --- a/offapi/com/sun/star/awt/tree/XTreeNode.idl +++ b/offapi/com/sun/star/awt/tree/XTreeNode.idl @@ -48,9 +48,10 @@ interface XTreeNode /** Returns the parent node of this node. */ XTreeNode getParent(); - /** Returns the index of Node in this instances children. + /** Returns the index of Node in this instances children. @returns - The child index of Node , or -1 if Node is no child of this instance. + The child index of Node, + or -1 if Node is no child of this instance. */ long getIndex( [in] XTreeNode Node); diff --git a/offapi/com/sun/star/chart2/Symbol.idl b/offapi/com/sun/star/chart2/Symbol.idl index 3d9c19f3aeba..1149cb3a3a5f 100644 --- a/offapi/com/sun/star/chart2/Symbol.idl +++ b/offapi/com/sun/star/chart2/Symbol.idl @@ -51,11 +51,8 @@ struct Symbol

The default implementation for example currently uses 8 different standard symbols that are matched to the numbers 0 to 7. - - +
- - @@ -64,7 +61,6 @@ struct Symbol -
 value StandardSymbol  visible Symbol 
0square
1diamond
2down arrow
5left arrow
6bowtie
7sandglass

diff --git a/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl b/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl index 112df63e4494..f7c22ce57eaa 100644 --- a/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl +++ b/offapi/com/sun/star/chart2/XRegressionCurveCalculator.idl @@ -37,7 +37,7 @@ module chart2 interface XRegressionCurveCalculator : com::sun::star::uno::XInterface { /** recalculates the parameters of the internal regression curve according to - the x- and y-values given. + the x- and y-values given. @param aXValues All x-values that represent the measurement points on @@ -51,7 +51,7 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface [in] sequence< double > aYValues ); - /** calculates the value of the regression curve for x. + /** calculates the value of the regression curve for x. @param x The abscissa value for which the value of the regression @@ -59,11 +59,11 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface the domain of the regression function are valid. @return - If x is element of the domain of the regression + If x is element of the domain of the regression curve function, the result is its value. @throws com::sun::star::lang::IllegalArgumentException - If x is not part of the domain of the regression + If x is not part of the domain of the regression function. */ double getCurveValue( [in] double x ) @@ -102,11 +102,11 @@ interface XRegressionCurveCalculator : com::sun::star::uno::XInterface raises( com::sun::star::lang::IllegalArgumentException ); /** Returns the value of the correlation coefficient for the given - regression. This value is often denoted as r or - R. + regression. This value is often denoted as r or + R. -

The value of r is signed. Often - r2 is used instead of r to denote +

The value of r is signed. Often + r2 is used instead of r to denote a regression curve's accuracy.

@return diff --git a/offapi/com/sun/star/deployment/XPackageRegistry.idl b/offapi/com/sun/star/deployment/XPackageRegistry.idl index 075ac5ba2bc3..2840929d2f6f 100644 --- a/offapi/com/sun/star/deployment/XPackageRegistry.idl +++ b/offapi/com/sun/star/deployment/XPackageRegistry.idl @@ -51,7 +51,7 @@ interface XPackageRegistry creates an XPackage object on behalf of that extension and calls XPackage::revokePakage(). The parameter removed indicates this case. The returned object may not - rely on the file or folder to which refers url. Instead it + rely on the file or folder to which refers url. Instead it must use previously saved data to successfully carry out the revocation of this object (XPackage::revokePackage()). diff --git a/offapi/com/sun/star/drawing/XSlidePreviewCacheListener.idl b/offapi/com/sun/star/drawing/XSlidePreviewCacheListener.idl index fda0a7f00340..aaad37b3442e 100644 --- a/offapi/com/sun/star/drawing/XSlidePreviewCacheListener.idl +++ b/offapi/com/sun/star/drawing/XSlidePreviewCacheListener.idl @@ -32,7 +32,7 @@ module com { module sun { module star { module drawing { */ interface XSlidePreviewCacheListener { - /** Called by a XSlidePreviewCache object when a + /** Called by a XSlidePreviewCache object when a preview has been created for the slide with the given index. @param nSlideIndex The index of the slide for which a new preview has been created. diff --git a/offapi/com/sun/star/form/DataAwareControlModel.idl b/offapi/com/sun/star/form/DataAwareControlModel.idl index a268f572f590..684042ff75a7 100644 --- a/offapi/com/sun/star/form/DataAwareControlModel.idl +++ b/offapi/com/sun/star/form/DataAwareControlModel.idl @@ -148,8 +148,8 @@ published service DataAwareControlModel
  • com::sun::star::beans::XPropertySet
  • com::sun::star::container::XChild
    • - -
  • It has to be a part of the same document as the model who's property is to be modified. +
    • +
  • It has to be a part of the same document as the model who's property is to be modified.
  • Additionally, the support of a special service, indicating that the model is of the right type, is required. Which kind of service is in the request depends on the type of the control model.
    diff --git a/offapi/com/sun/star/form/FormComponents.idl b/offapi/com/sun/star/form/FormComponents.idl index 577cab2b5e55..cb1189957937 100644 --- a/offapi/com/sun/star/form/FormComponents.idl +++ b/offapi/com/sun/star/form/FormComponents.idl @@ -66,7 +66,8 @@ published service FormComponents you put into it with the scripting information obtained at the com::sun::star::script::XEventAttacherManager interface.

    -

    For instance, at any time you can obtain the events associated with the nth +

    For instance, at any time you can obtain the events associated with + the nth element in the form components by calling com::sun::star::script::XEventAttacherManager::getScriptEvents() with parameter n. In particular, this invariant is always met, even after you diff --git a/offapi/com/sun/star/form/XForms.idl b/offapi/com/sun/star/form/XForms.idl index 44f63a74f0c4..276127e1b71d 100644 --- a/offapi/com/sun/star/form/XForms.idl +++ b/offapi/com/sun/star/form/XForms.idl @@ -63,7 +63,8 @@ published interface XForms you put into it with the scripting information obtained at the com::sun::star::script::XEventAttacherManager interface.

    -

    For instance, at any time you can obtain the events associated with the nth +

    For instance, at any time you can obtain the events associated with + the nth element in the form components by calling com::sun::star::script::XEventAttacherManager::getScriptEvents() with parameter n. In particular, this invariant is always met, even after you diff --git a/offapi/com/sun/star/form/runtime/XFilterController.idl b/offapi/com/sun/star/form/runtime/XFilterController.idl index 90b044173eb4..f8554db5c8ba 100644 --- a/offapi/com/sun/star/form/runtime/XFilterController.idl +++ b/offapi/com/sun/star/form/runtime/XFilterController.idl @@ -35,7 +35,7 @@ interface XFilterControllerListener; which allows entering a search expression. This so-called predicate expression is basically a part of an SQL WHERE clause, but without the part denoting the database column. For instance, if you have a form control bound to a table column named Name, then entering the string - LIKE '%Smith%' effectively constitutes a SQL WHERE clause "Name" LIKE '%Smith%'.

    + LIKE '%Smith%' effectively constitutes a SQL WHERE clause "Name" LIKE '%Smith%'.

    In the actual document view, there are usually some relaxations to this. For instance, keywords such as LIKE might be localized, according to OpenOffice.org's UI locale. Also, for an equality criterion, diff --git a/offapi/com/sun/star/form/runtime/XFormController.idl b/offapi/com/sun/star/form/runtime/XFormController.idl index ccfd0a6c2ca5..35bdf22793dc 100644 --- a/offapi/com/sun/star/form/runtime/XFormController.idl +++ b/offapi/com/sun/star/form/runtime/XFormController.idl @@ -116,7 +116,7 @@ interface XFormControllerContext; For instance, the URL with the suffix moveToFirst is associated with moving the form to the first record, and it will be disabled in case the form is already positioned on the first record.

    - +
    @@ -232,8 +232,7 @@ interface XFormControllerContext; - -
    URL suffixremoveFilterOrder completely removes any filter and sorting order from the form, and reloads it.
    + @see ::com::sun::star::form::component:Form @see ::com::sun::star::form::binding::BindableControlModel diff --git a/offapi/com/sun/star/frame/ProtocolHandler.idl b/offapi/com/sun/star/frame/ProtocolHandler.idl index cc0b547e7da0..59dccd9f68aa 100644 --- a/offapi/com/sun/star/frame/ProtocolHandler.idl +++ b/offapi/com/sun/star/frame/ProtocolHandler.idl @@ -34,7 +34,8 @@

    - Supported URLs must match follow format: : + Supported URLs must match follow format: + protocol scheme:protocol specific part If a handler provides optional arguments ("?") or jump marks ("#") depends from his definition and implementation. The generic dispatch provider will use registered URL pattern to detect right handler. diff --git a/offapi/com/sun/star/presentation/Presentation.idl b/offapi/com/sun/star/presentation/Presentation.idl index fbff66501aac..6ba0c95bb9c7 100644 --- a/offapi/com/sun/star/presentation/Presentation.idl +++ b/offapi/com/sun/star/presentation/Presentation.idl @@ -106,7 +106,7 @@ published service Presentation /** is the duration of the black screen after the presentation has finished. -

    If this is set to 0, no black screen is shown.

    +

    If this is set to 0, no black screen is shown.

    */ [property] long Pause; diff --git a/offapi/com/sun/star/presentation/XPresentation2.idl b/offapi/com/sun/star/presentation/XPresentation2.idl index f6712362ff6c..fb7b552b1ae2 100644 --- a/offapi/com/sun/star/presentation/XPresentation2.idl +++ b/offapi/com/sun/star/presentation/XPresentation2.idl @@ -49,7 +49,7 @@ interface XPresentation2 /** start the slide show with the given arguments. - All arguments override the values from Presentation + All arguments override the values from Presentation. */ void startWithArguments( [in] sequence< ::com::sun::star::beans::PropertyValue > Arguments ); diff --git a/offapi/com/sun/star/rendering/XCanvas.idl b/offapi/com/sun/star/rendering/XCanvas.idl index 52b64324c012..eaec8d034c32 100644 --- a/offapi/com/sun/star/rendering/XCanvas.idl +++ b/offapi/com/sun/star/rendering/XCanvas.idl @@ -467,24 +467,24 @@ interface XCanvas : ::com::sun::star::uno::XInterface the following properties are recognized:
      - Kerning: a double between 0 and 1, where +
    • Kerning: a double between 0 and 1, where 0 completely disables kerning. Whether kerning is on or - off by default is font-dependent. + off by default is font-dependent.
      • - IsEmphasisMarks: a boolean, where `TRUE` +
    • IsEmphasisMarks: a boolean, where `TRUE` enables automatic placements of emphasis marks, e.g. for Hebrew. The default value, if this property is not - specified, is `FALSE`. + specified, is `FALSE`.
      • - ExpandedSpacing: a double value which is added +
    • ExpandedSpacing: a double value which is added between all cell distances for this font. The default value for this property is zero. Use negative values for condensed output, - and positive values for expanded output. + and positive values for expanded output.
      • - OptionalLayoutFeatures: a sequence of +
    • OptionalLayoutFeatures: a sequence of ::com::sun::star::beans::PropertyValue listing font-specific optional layout features, like glyph - variants. + variants.
    diff --git a/offapi/com/sun/star/report/XFixedLine.idl b/offapi/com/sun/star/report/XFixedLine.idl index 8f23335beff3..a6141d5a9ba6 100644 --- a/offapi/com/sun/star/report/XFixedLine.idl +++ b/offapi/com/sun/star/report/XFixedLine.idl @@ -36,7 +36,7 @@ interface XFixedLine 
             0: horizontal
-        1: vertical 
+        1: vertical (default)
    */ [attribute,bound] long Orientation diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl index bef25142202a..615fc0639f0b 100644 --- a/offapi/com/sun/star/sdb/DataSourceBrowser.idl +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -126,7 +126,7 @@ module com { module sun { module star { module sdb {

    The default for DataAccessDescriptor::Selection is to contain bookmarks, if not specified - otherwise by DataAccessDescriptor::BookmarkSelection. + otherwise by DataAccessDescriptor::BookmarkSelection.

    @see com::sun::star::sdb::ContentLoader diff --git a/offapi/com/sun/star/sdb/ErrorCondition.idl b/offapi/com/sun/star/sdb/ErrorCondition.idl index 1f9f9a223fe5..4618c7475d77 100644 --- a/offapi/com/sun/star/sdb/ErrorCondition.idl +++ b/offapi/com/sun/star/sdb/ErrorCondition.idl @@ -131,7 +131,7 @@ constants ErrorCondition not be accessed.

    For instance, this error code is used when you try to access the address book - in a Thunderbird profile named MyProfile, but there does not exist a profile + in a Thunderbird profile named MyProfile, but there does not exist a profile with this name.

    */ const long AB_ADDRESSBOOK_NOT_FOUND = 500; @@ -143,7 +143,7 @@ constants ErrorCondition

    Some database drivers are not able to SELECT from a table if the statement does not contain a WHERE clause. In this case, a statement - like SELECT * FROM "table" with fail with the error code + like SELECT * FROM "table" with fail with the error code DATA_CANNOT_SELECT_UNFILTERED.

    It is also legitimate for the driver to report this error condition as warning, and provide diff --git a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl index 4a50efd4f02e..f4b08e65a15f 100644 --- a/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl +++ b/offapi/com/sun/star/sdb/OfficeDatabaseDocument.idl @@ -90,13 +90,10 @@ service OfficeDatabaseDocument

    The following events are broadcasted by a database document - - - @@ -169,7 +166,7 @@ service OfficeDatabaseDocument - + @@ -196,7 +193,6 @@ service OfficeDatabaseDocument -
    Event Name broadcasted when broadcasted synchronously
    OnCreate the document has been newly created. This does not imply that the document has been loaded into a frame, it just means the initialization has been finished.no
    OnModifyChangedthe modified state of the document changed.the modified state of the document changed. no
    OnViewCreatedFrom with a view to the document, a view to a sub component (e.g. a table or a report) has been closed. no

    diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl index a8e200e617fd..1c86caa9de3c 100644 --- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl +++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl @@ -185,7 +185,7 @@ interface XDatabaseDocumentUI

    For the different object types, this means the following - +
    @@ -221,7 +221,7 @@ interface XDatabaseDocumentUI -
    ForEditing = `TRUE`The report is executed, and the results will be displayed.
    +

    @return diff --git a/offapi/com/sun/star/style/XStyleLoader.idl b/offapi/com/sun/star/style/XStyleLoader.idl index 52aab674df5b..5e6d8825c292 100644 --- a/offapi/com/sun/star/style/XStyleLoader.idl +++ b/offapi/com/sun/star/style/XStyleLoader.idl @@ -40,7 +40,7 @@ published interface XStyleLoader: com::sun::star::uno::XInterface The directory and the filename from document with the styles @param aOptions : Specifies which of the Style families the method should load. - The sequence has the following, optional items: + The sequence has the following, optional items:
    • boolean LoadCellStyles
    • boolean LoadTextStyles
      • diff --git a/offapi/com/sun/star/ui/dialogs/XWizard.idl b/offapi/com/sun/star/ui/dialogs/XWizard.idl index 453cc3b68087..7d228996aece 100644 --- a/offapi/com/sun/star/ui/dialogs/XWizard.idl +++ b/offapi/com/sun/star/ui/dialogs/XWizard.idl @@ -52,7 +52,7 @@ interface XWizardPage; paths are those whose first k steps are the same as in the current path. Obviously, there's at least one potential path in every situation: the current one. If there is more than one, then the future steps in the dialog 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 ... indicating that the order of steps is undecided.

      + paths diverge, and then an item ... indicating that the order of steps is undecided.

      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 diff --git a/udkapi/com/sun/star/reflection/XTypeDescriptionEnumerationAccess.idl b/udkapi/com/sun/star/reflection/XTypeDescriptionEnumerationAccess.idl index 641be7e99bd4..d82777004c41 100644 --- a/udkapi/com/sun/star/reflection/XTypeDescriptionEnumerationAccess.idl +++ b/udkapi/com/sun/star/reflection/XTypeDescriptionEnumerationAccess.idl @@ -88,8 +88,7 @@ published interface XTypeDescriptionEnumerationAccess : com::sun::star::uno::XIn XTypeDescription can be returned by the enumerator: - - + @@ -138,7 +137,6 @@ published interface XTypeDescriptionEnumerationAccess : com::sun::star::uno::XIn -
      IDLinterface
      IDLinterface
      enum XEnumTypeDescriptionconstants XConstantsTypeDescription
      @throws NoSuchTypeNameException -- cgit