From 3a05aabe4190fc948ebdc94a14a15872f977ba0c Mon Sep 17 00:00:00 2001 From: Stephan Bergmann Date: Fri, 31 Jan 2014 11:00:17 +0100 Subject: [PATCH] Silence javadoc 8 errors Change-Id: Ib0b2286669d797708b30bf0fffdbe14c14d1e30d --- .../com/sun/star/comp/helper/Bootstrap.java | 13 ++++--- .../comp/helper/ComponentContextEntry.java | 2 +- .../star/comp/helper/SharedLibraryLoader.java | 34 +++++++++++-------- .../sun/star/lib/uno/helper/PropertySet.java | 15 +++++--- .../star/lib/uno/helper/PropertySetMixin.java | 2 +- ridljar/com/sun/star/uno/IEnvironment.java | 2 +- .../com/sun/star/uno/IMethodDescription.java | 4 +-- .../com/sun/star/uno/ITypeDescription.java | 22 ++++++------ ridljar/com/sun/star/uno/Type.java | 4 +-- 9 files changed, 55 insertions(+), 43 deletions(-) diff --git a/javaunohelper/com/sun/star/comp/helper/Bootstrap.java b/javaunohelper/com/sun/star/comp/helper/Bootstrap.java index 85bc4837a99d..6c40f7c09f64 100644 --- a/javaunohelper/com/sun/star/comp/helper/Bootstrap.java +++ b/javaunohelper/com/sun/star/comp/helper/Bootstrap.java @@ -136,9 +136,10 @@ public class Bootstrap { /** * Bootstraps a servicemanager with the jurt base components registered. - *

+ * + * See also UNOIDL com.sun.star.lang.ServiceManager. + * * @return a freshly boostrapped service manager - * @see com.sun.star.lang.ServiceManager */ static public XMultiServiceFactory createSimpleServiceManager() throws Exception { @@ -149,7 +150,8 @@ public class Bootstrap { /** Bootstraps the initial component context from a native UNO installation. - @see "cppuhelper/defaultBootstrap_InitialComponentContext()" + See also + cppuhelper/defaultBootstrap_InitialComponentContext(). */ static public final XComponentContext defaultBootstrap_InitialComponentContext() throws Exception @@ -168,12 +170,13 @@ public class Bootstrap { } /** Bootstraps the initial component context from a native UNO installation. + See also + cppuhelper/defaultBootstrap_InitialComponentContext(). + @param ini_file ini_file (may be null: uno.rc besides cppuhelper lib) @param bootstrap_parameters bootstrap parameters (maybe null) - - @see "cppuhelper/defaultBootstrap_InitialComponentContext()" */ static public final XComponentContext defaultBootstrap_InitialComponentContext( String ini_file, java.util.Map bootstrap_parameters ) diff --git a/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java b/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java index ea1c57ec9ea1..bb3bd7a012e4 100644 --- a/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java +++ b/javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java @@ -24,7 +24,7 @@ package com.sun.star.comp.helper; The first one is commonly used for singleton objects of the component context, that are raised on first-time retrieval of the key. You have to pass a com.sun.star.lang.XSingleComponentFactory - or string (=> service name) object for this. + or string (=> service name) object for this.

*/ public class ComponentContextEntry diff --git a/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java b/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java index c7e3ded8f9af..32610a3ba955 100644 --- a/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java +++ b/javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java @@ -29,10 +29,10 @@ import com.sun.star.registry.XRegistryKey; * * The SharedLibraryLoader class provides the functionality of the com.sun.star.loader.SharedLibrary * service. - *

+ * + * See also UNOIDL com.sun.star.lang.ServiceManager. + * * @see com.sun.star.loader.SharedLibrary - * @see "com.sun.star.comp.servicemanager.ServiceManager" - * @see com.sun.star.lang.ServiceManager */ public class SharedLibraryLoader { /** @@ -77,13 +77,14 @@ public class SharedLibraryLoader { * The defaults are "shlibloader.uno" * for the library and "com.sun.star.comp.stoc.DLLComponentLoader" * for the component name. - *

+ * + * See also UNOIDL com.sun.star.lang.ServiceManager and + * com.sun.star.registry.RegistryKey. + * * @return the factory for the "com.sun.star.comp.stoc.DLLComponentLoader" component. * @param smgr the ServiceManager * @param regKey the root registry key * @see com.sun.star.loader.SharedLibrary - * @see com.sun.star.lang.ServiceManager - * @see com.sun.star.registry.RegistryKey */ public static XSingleServiceFactory getServiceFactory( XMultiServiceFactory smgr, @@ -98,15 +99,16 @@ public class SharedLibraryLoader { /** * Loads and returns a specific factory for a given library and implementation name. - *

+ * + * See also UNOIDL com.sun.star.lang.ServiceManager and + * com.sun.star.registry.RegistryKey. + * * @return the factory of the component * @param libName the name of the shared library * @param impName the implementation name of the component * @param smgr the ServiceManager * @param regKey the root registry key * @see com.sun.star.loader.SharedLibrary - * @see com.sun.star.lang.ServiceManager - * @see com.sun.star.registry.RegistryKey */ public static XSingleServiceFactory getServiceFactory( String libName, @@ -123,13 +125,14 @@ public class SharedLibraryLoader { /** * Registers the SharedLibraryLoader under a RegistryKey. - *

+ * + * See also UNOIDL com.sun.star.lang.ServiceManager and + * com.sun.star.registry.RegistryKey. + * * @return true if the registration was successful - otherwise false * @param smgr the ServiceManager * @param regKey the root key under that the component should be registered * @see com.sun.star.loader.SharedLibrary - * @see com.sun.star.lang.ServiceManager - * @see com.sun.star.registry.RegistryKey */ public static boolean writeRegistryServiceInfo( com.sun.star.lang.XMultiServiceFactory smgr, @@ -142,14 +145,15 @@ public class SharedLibraryLoader { /** * Registers the SharedLibraryLoader under a RegistryKey. - *

+ * + * See also UNOIDL com.sun.star.lang.ServiceManager and + * com.sun.star.registry.RegistryKey. + * * @return true if the registration was successful - otherwise false * @param libName name of the shared library * @param smgr the ServiceManager * @param regKey the root key under that the component should be registered * @see com.sun.star.loader.SharedLibrary - * @see com.sun.star.lang.ServiceManager - * @see com.sun.star.registry.RegistryKey */ public static boolean writeRegistryServiceInfo( String libName, diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java index 372354e1f58b..04c33b6aaf3f 100644 --- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java +++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java @@ -557,11 +557,14 @@ XMultiPropertySet * {@link #setFastPropertyValue XFastPropertySet.setFastPropertyValue} * and {@link #setPropertyValues XMultiPropertySet.setPropertyValues}. * If this method fails, that is, it returns false or throws an exception, then no listeners are notified and the - * property value, that was intended to be changed, remains untouched.
This method does not have to deal with property attributes, such as + * property value, that was intended to be changed, remains untouched. + * + * This method does not have to deal with property attributes, such as * PropertyAttribute.READONLY or PropertyAttribute.MAYBEVOID. The processing of these attributes occurs - * in the calling methods.
+ * in the calling methods. + * * Only if this method returns successfully further processing, such - * as listener notification and finally the modifiction of the property's value, will occur.
+ * as listener notification and finally the modifiction of the property's value, will occur. * * The actual modification of a property's value is done by {@link #setPropertyValueNoBroadcast setPropertyValueNoBroadcast} * which is called subsequent to convertPropertyValue. @@ -587,10 +590,12 @@ XMultiPropertySet * Then, no conversion is necessary, since they can hold all possible values. However, if * the member is an Object and setVal is an Any then the object contained in the any is assigned to * the member. The extra type information which exists as Type object in the Any will get lost. If this is not - * intended then use an Any variable rather then an Object.
+ * intended then use an Any variable rather then an Object. + * * If a member is an Object or Any and the argument setVal is an Object, other than String or array, * then it is presumed to be an UNO object and queried for XInterface. If successful, the out-param newVal - * returns the XInterface.
+ * returns the XInterface. + * * If a member is an UNO interface, then setVal is queried for this interface and the result is returned. * If setVal is null then newVal will be null too after return. *

diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java index dae489fd4c66..0f548fe10d93 100644 --- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java +++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java @@ -186,7 +186,7 @@ public final class PropertySetMixin { @param newValue the property value corresponding to the new attribute value. This is only used as com.sun.star.beans.PropertyChangeEvent.NewValue, which is - rather useless, anyway (see “Using the Observer Pattern&rdquo: in + rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines), unless the attribute that is going to be set is constrained. If the attribute diff --git a/ridljar/com/sun/star/uno/IEnvironment.java b/ridljar/com/sun/star/uno/IEnvironment.java index 34435ecff328..dc963414ef58 100644 --- a/ridljar/com/sun/star/uno/IEnvironment.java +++ b/ridljar/com/sun/star/uno/IEnvironment.java @@ -58,7 +58,7 @@ public interface IEnvironment { * given bridge B2. *

  • A proxy object, created as a remote object is mapped into this * environment via a given bridge.
    • - *

    + * * *

    The object actually registered may differ from the specified * object that is passed as an argument. This enables an diff --git a/ridljar/com/sun/star/uno/IMethodDescription.java b/ridljar/com/sun/star/uno/IMethodDescription.java index ffc9833e0500..cb2625a7327e 100644 --- a/ridljar/com/sun/star/uno/IMethodDescription.java +++ b/ridljar/com/sun/star/uno/IMethodDescription.java @@ -47,7 +47,7 @@ public interface IMethodDescription extends IMemberDescription { boolean isConst(); /** - * Gives any array of ITypeDescription> of + * Gives any array of ITypeDescription of * the [in] parameters. *

    * @return the in parameters @@ -55,7 +55,7 @@ public interface IMethodDescription extends IMemberDescription { ITypeDescription[] getInSignature(); /** - * Gives any array of ITypeDescription> of + * Gives any array of ITypeDescription of * the [out] parameters. *

    * @return the out parameters diff --git a/ridljar/com/sun/star/uno/ITypeDescription.java b/ridljar/com/sun/star/uno/ITypeDescription.java index 98f2d0824062..62a399b6a7a3 100644 --- a/ridljar/com/sun/star/uno/ITypeDescription.java +++ b/ridljar/com/sun/star/uno/ITypeDescription.java @@ -98,8 +98,8 @@ public interface ITypeDescription { /** * Gets the (UNO) type name. * - *

    The following table lists how UNO types map to type names:

    * + * * * * @@ -114,15 +114,15 @@ public interface ITypeDescription { * * * - * "hyper" + * * - * "unsigned hyper" + * * - * "float" - * "double" - * "string" - * "type" - * "any" + * + * + * + * + * * * * @@ -136,14 +136,14 @@ public interface ITypeDescription { * * * - * + * + * * * * * * - * + * *
    Mapping from UNO types to type names
    UNO typetype name
    LONG"long"
    UNSIGNED LONG"unsigned long"
    HYPER
    HYPER"hyper"
    UNSIGNED HYPERUNSIGNED HYPER"unsigned hyper"
    FLOAT
    DOUBLE
    STRING
    TYPE
    ANY
    FLOAT"float"
    DOUBLE"double"
    STRING"string"
    TYPE"type"
    ANY"any"
    sequence type of base type T"[]" followed by type name for TN (see below)
    exception type named N - * N (see below)exception type named NN (see below)
    interface type named NN (see below)
    *

    For a UNO type named N, consisting of a sequence of module * names M1, ..., Mn followed by diff --git a/ridljar/com/sun/star/uno/Type.java b/ridljar/com/sun/star/uno/Type.java index 74cb1eb591f6..c5f1b5c7bd71 100644 --- a/ridljar/com/sun/star/uno/Type.java +++ b/ridljar/com/sun/star/uno/Type.java @@ -199,9 +199,9 @@ public class Type { * *

    In certain cases, one Java class corresponds to two UNO types (e.g., * the Java class short[].class corresponds to both a sequence - * of SHORT and a sequence of UNSIGNED SHORT in + * of SHORT and a sequence of UNSIGNED SHORT in * UNO). In such ambiguous cases, the parameter alternative - * controls which UNO type is chosen:

    + * controls which UNO type is chosen: *