mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Silence javadoc 8 errors

Browse Source 
Change-Id: Ib0b2286669d797708b30bf0fffdbe14c14d1e30d
This commit is contained in:
Stephan Bergmann 2014-01-31 11:00:17 +01:00
parent 2df08acc4c
commit 3a05aabe41
9 changed files with 55 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
javaunohelper/com/sun/star/comp/helper/Bootstrap.java
View File

@ -136,9 +136,10 @@ public class Bootstrap {
/**
* Bootstraps a servicemanager with the jurt base components registered.
* <p>
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code>.
*
* @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
<code>cppuhelper/defaultBootstrap_InitialComponentContext()</code>.
*/
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
<code>cppuhelper/defaultBootstrap_InitialComponentContext()</code>.
@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<String,String> bootstrap_parameters )

2
javaunohelper/com/sun/star/comp/helper/ComponentContextEntry.java
View File

@ -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 (=&gt; service name) object for this.
</p>
*/
public class ComponentContextEntry

34
javaunohelper/com/sun/star/comp/helper/SharedLibraryLoader.java
View File

@ -29,10 +29,10 @@ import com.sun.star.registry.XRegistryKey;
*
* The <code>SharedLibraryLoader</code> class provides the functionality of the <code>com.sun.star.loader.SharedLibrary</code>
* service.
* <p>
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code>.
*
* @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.
* <p>
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code> and
* <code>com.sun.star.registry.RegistryKey</code>.
*
* @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.
* <p>
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code> and
* <code>com.sun.star.registry.RegistryKey</code>.
*
* @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.
* <p>
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code> and
* <code>com.sun.star.registry.RegistryKey</code>.
*
* @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.
* <p>
*
* See also UNOIDL <code>com.sun.star.lang.ServiceManager</code> and
* <code>com.sun.star.registry.RegistryKey</code>.
*
* @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,

15
javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
View File

@ -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.<br /> 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.<br />
* 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.<br />
* 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 <em>setVal</em> 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.<br />
* intended then use an Any variable rather then an Object.
*
* If a member is an Object or Any and the argument <em>setVal</em> 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 <em>newVal</em>
* returns the XInterface.<br />
* returns the XInterface.
*
* If a member is an UNO interface, then <em>setVal</em> is queried for this interface and the result is returned.
* If <em>setVal</em> is null then <em>newVal</em> will be null too after return.
* <p>

2
javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java
View File

@ -186,7 +186,7 @@ public final class PropertySetMixin {
@param newValue the property value corresponding to the new
attribute value. This is only used as
<code>com.sun.star.beans.PropertyChangeEvent.NewValue</code>, which is
rather useless, anyway (see &ldquo;Using the Observer Pattern&rdquo: in
rather useless, anyway (see &ldquo;Using the Observer Pattern&rdquo; in
<a href="http://tools.openoffice.org/CodingGuidelines.sxw">
<cite>OpenOffice.org Coding Guidelines</cite></a>), <em>unless</em> the
attribute that is going to be set is constrained. If the attribute

2
ridljar/com/sun/star/uno/IEnvironment.java
View File

@ -58,7 +58,7 @@ public interface IEnvironment {
* given bridge <var>B2</var>.</li>
* <li>A proxy object, created as a remote object is mapped into this
* environment via a given bridge.</li>
* </ul></p>
* </ul>
*
* <p>The object actually registered may differ from the specified
* <code>object</code> that is passed as an argument. This enables an

4
ridljar/com/sun/star/uno/IMethodDescription.java
View File

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

22
ridljar/com/sun/star/uno/ITypeDescription.java
View File

@ -98,8 +98,8 @@ public interface ITypeDescription {
/**
* Gets the (UNO) type name.
*
* <p>The following table lists how UNO types map to type names:</p>
* <table>
* <caption>Mapping from UNO types to type names</caption>
* <thead>
* <tr><th>UNO type</th><th>type name</th></tr>
* </thead>
@ -114,15 +114,15 @@ public interface ITypeDescription {
* </tr>
* <tr><td>LONG</td><td><code>"long"</code></td></tr>
* <tr><td>UNSIGNED LONG</td><td><code>"unsigned long"</code></td></tr>
* <tr><td>HYPER</td><td></td><code>"hyper"</code></tr>
* <tr><td>HYPER</td><td><code>"hyper"</code></td></tr>
* <tr>
* <td>UNSIGNED HYPER</td><td></td><code>"unsigned hyper"</code>
* <td>UNSIGNED HYPER</td><td><code>"unsigned hyper"</code></td>
* </tr>
* <tr><td>FLOAT</td><td></td><code>"float"</code></tr>
* <tr><td>DOUBLE</td><td></td><code>"double"</code></tr>
* <tr><td>STRING</td><td></td><code>"string"</code></tr>
* <tr><td>TYPE</td><td></td><code>"type"</code></tr>
* <tr><td>ANY</td><td></td><code>"any"</code></tr>
* <tr><td>FLOAT</td><td><code>"float"</code></td></tr>
* <tr><td>DOUBLE</td><td><code>"double"</code></td></tr>
* <tr><td>STRING</td><td><code>"string"</code></td></tr>
* <tr><td>TYPE</td><td><code>"type"</code></td></tr>
* <tr><td>ANY</td><td><code>"any"</code></td></tr>
* <tr>
* <td>sequence type of base type <var>T</var></td>
* <td><code>"[]"</code> followed by type name for <var>T</var></td>
@ -136,14 +136,14 @@ public interface ITypeDescription {
* <td><var>N</var> (see below)</td>
* </tr>
* <tr>
* <td>exception type named <var>N</var>
* </td><td><var>N</var> (see below)</td>
* <td>exception type named <var>N</var></td>
* <td><var>N</var> (see below)</td>
* </tr>
* <tr>
* <td>interface type named <var>N</var></td>
* <td><var>N</var> (see below)</td>
* </tr>
* <tbody>
* </tbody>
* </table>
* <p>For a UNO type named <var>N</var>, consisting of a sequence of module
* names <var>M<sub>1</sub></var>, ..., <var>M<sub>n</sub></var> followed by

4
ridljar/com/sun/star/uno/Type.java
View File

@ -199,9 +199,9 @@ public class Type {
*
* <p>In certain cases, one Java class corresponds to two UNO types (e.g.,
* the Java class <code>short[].class</code> corresponds to both a sequence
* of <codde>SHORT</code> and a sequence of <code>UNSIGNED SHORT</code> in
* of <code>SHORT</code> and a sequence of <code>UNSIGNED SHORT</code> in
* UNO). In such ambiguous cases, the parameter <code>alternative</code>
* controls which UNO type is chosen:</p>
* controls which UNO type is chosen:
* <ul>
* <li>If the Java type is (an array type with element type)
* <code>short</code> or <code>java.lang.Short</code>: If