diff options
author | Michi Henning <michi@zeroc.com> | 2009-07-08 07:30:19 +1000 |
---|---|---|
committer | Michi Henning <michi@zeroc.com> | 2009-07-08 07:30:19 +1000 |
commit | e769f2c0cc39b4102436b4d57727a46f60ed8ef7 (patch) | |
tree | 1f698a40790dd74b3c4a77c85cd6244b03f60501 /java/src | |
parent | Add test/Ice/servantLocator missed files. (diff) | |
download | ice-e769f2c0cc39b4102436b4d57727a46f60ed8ef7.tar.bz2 ice-e769f2c0cc39b4102436b4d57727a46f60ed8ef7.tar.xz ice-e769f2c0cc39b4102436b4d57727a46f60ed8ef7.zip |
Bug 3502: More cleanup for new javadoc syntax.
Diffstat (limited to 'java/src')
23 files changed, 77 insertions, 78 deletions
diff --git a/java/src/Freeze/Map.java b/java/src/Freeze/Map.java index debe0c16f57..84872da5b78 100644 --- a/java/src/Freeze/Map.java +++ b/java/src/Freeze/Map.java @@ -26,7 +26,7 @@ public interface Map<K, V> extends NavigableMap<K, V> /** * Closes the database associated with this map, as well as all open iterators. * A map must be closed when it is no longer needed, either directly, or by - * closing the <code>Connection</code> associated with this map. + * closing the {@link Connection} associated with this map. **/ void close(); @@ -56,7 +56,7 @@ public interface Map<K, V> extends NavigableMap<K, V> /** * Closes this iterator, reclaiming associated resources. This - * method is an alias for <code>close</code>. + * method is an alias for {@link #close}. **/ void destroy(); } diff --git a/java/src/Ice/AMD_Object_ice_invoke.java b/java/src/Ice/AMD_Object_ice_invoke.java index 8a7d9733c99..63110e3443c 100644 --- a/java/src/Ice/AMD_Object_ice_invoke.java +++ b/java/src/Ice/AMD_Object_ice_invoke.java @@ -33,8 +33,8 @@ public interface AMD_Object_ice_invoke * with a run-time exception. * * @param ex The encoded Ice run-time exception. Note that, if <code>ex</code> - * is a user exception, the caller receives <code>UnknownUserException</code>. - * Use <code>ice_response</code> to raise user exceptions. + * is a user exception, the caller receives {@link UnknownUserException}. + * Use {@link #ice_response} to raise user exceptions. **/ void ice_exception(java.lang.Exception ex); diff --git a/java/src/Ice/AMI_Object_ice_flushBatchRequests.java b/java/src/Ice/AMI_Object_ice_flushBatchRequests.java index 36124db03b0..211f002b9d6 100644 --- a/java/src/Ice/AMI_Object_ice_flushBatchRequests.java +++ b/java/src/Ice/AMI_Object_ice_flushBatchRequests.java @@ -10,7 +10,7 @@ package Ice; /** - * Callback object for <code>ObjectPrx.ice_flushBatchRequests_async</code>. + * Callback object for {@link ObjectPrx#.ice_flushBatchRequests_async}. **/ public abstract class AMI_Object_ice_flushBatchRequests extends IceInternal.BatchOutgoingAsync { @@ -20,7 +20,7 @@ public abstract class AMI_Object_ice_flushBatchRequests extends IceInternal.Batc * * @param ex The run-time exception that was raised. * - * @see ObjectPrx.ice_flushBatchRequests_async + * @see ObjectPrx#ice_flushBatchRequests_async **/ public abstract void ice_exception(LocalException ex); diff --git a/java/src/Ice/AMI_Object_ice_invoke.java b/java/src/Ice/AMI_Object_ice_invoke.java index a7235328900..1ad20c38033 100644 --- a/java/src/Ice/AMI_Object_ice_invoke.java +++ b/java/src/Ice/AMI_Object_ice_invoke.java @@ -10,7 +10,7 @@ package Ice; /** - * Callback object for <code>Blobject</code> AMI invocations. + * Callback object for {@link Blobject} AMI invocations. * * @see Blobject **/ diff --git a/java/src/Ice/Application.java b/java/src/Ice/Application.java index 753e38400f9..342845bf84e 100644 --- a/java/src/Ice/Application.java +++ b/java/src/Ice/Application.java @@ -15,18 +15,18 @@ package Ice; * a logger, <Application> installs a per-process logger that logs to the standard * error output. * <p> - * Applications must create a derived class that implements the <code>run</code> method. + * Applications must create a derived class that implements the {@link #run} method. * <p> * A program can contain only one instance of this class. * - * @see run + * @see #run * @see Communicator * @see Logger **/ public abstract class Application { /** - * Initializes an instance that calls <code>Communicator.shutdown</code> if + * Initializes an instance that calls {@link Communicator#shutdown} if * a signal is received. **/ public @@ -52,7 +52,7 @@ public abstract class Application * The application must call <code>main</code> after it has * instantiated the derived class. <code>main</code> creates * a communicator, establishes the specified signal policy, and, - * once <code>run</code> returns, destroys the communicator. + * once {@link #run} returns, destroys the communicator. * <p> * The method prints an error message for any exception that propagates * out of <code>run</code> and ensures that the communicator is @@ -75,10 +75,10 @@ public abstract class Application * The application must call <code>main</code> after it has * instantiated the derived class. <code>main</code> creates * a communicator, establishes the specified signal policy, and, - * once <code>run</code> returns, destroys the communicator. + * once {@link run} returns, destroys the communicator. * <p> * The method prints an error message for any exception that propagates - * out of <code>run</code> and ensures that the communicator is + * out of <code>#run</code> and ensures that the communicator is * destroyed correctly even if <code>run</code> completes abnormally. * * @param appName The name of the application. This parameter is used to initialize @@ -98,7 +98,7 @@ public abstract class Application * The application must call <code>main</code> after it has * instantiated the derived class. <code>main</code> creates * a communicator, establishes the specified signal policy, and, - * once <code>run</code> returns, destroys the communicator. + * once {@link #run} returns, destroys the communicator. * <p> * The method prints an error message for any exception that propagates * out of <code>run</code> and ensures that the communicator is @@ -143,7 +143,7 @@ public abstract class Application * The application must call <code>main</code> after it has * instantiated the derived class. <code>main</code> creates * a communicator, establishes the specified signal policy, and, - * once <code>run</code> returns, destroys the communicator. + * once {@link #run} returns, destroys the communicator. * <p> * The method prints an error message for any exception that propagates * out of <code>run</code> and ensures that the communicator is @@ -209,10 +209,10 @@ public abstract class Application } /** - * Instructs <code>Application</code> to call <code>Communicator.destroy</code> on receipt of a signal. + * Instructs <code>Application</code> to call {@link Communicator#destroy} on receipt of a signal. * This is default signal handling policy established by the default constructor. * - * @see Communicator.destroy + * @see Communicator#destroy **/ public static void destroyOnInterrupt() @@ -247,9 +247,9 @@ public abstract class Application } /** - * Instructs <code>Application</code> to call <code>Communicator.shutdown</code> on receipt of a signal. + * Instructs <code>Application</code> to call {@link Communicator#shutdown} on receipt of a signal. * - * @see Communicator.shutdown + * @see Communicator#shutdown **/ public static void shutdownOnInterrupt() @@ -286,13 +286,13 @@ public abstract class Application /** * Installs a custom shutdown hook. The implementation of the shutdown * hook can do whatever cleanup is necessary to shut down the application. - * The hook is unregistered once <code>run</code> returns. + * The hook is unregistered once {@link #run} returns. * Note that the hook must obey the rules for shutdown hooks; specifically, * it must not call <code>exit</code>. * * @param newHook The thread to run on shutdown. * - * @see java.lang.Runtime.addShutdownHook + * @see java.lang.Runtime#addShutdownHook **/ public static void setInterruptHook(java.lang.Thread newHook) // Pun intended. @@ -316,8 +316,8 @@ public abstract class Application } /** - * Clears any shutdownn hooks, including any hook established with <code>destroyOnInterrupt</code> or - * <code>shutdownOnInterrupt</code>. + * Clears any shutdownn hooks, including any hook established with {@link #destroyOnInterrupt}code> or + * {@link #shutdownOnInterrupt}. **/ public static void defaultInterrupt() diff --git a/java/src/Ice/Blobject.java b/java/src/Ice/Blobject.java index 61f739baa4c..52cfec01bb2 100644 --- a/java/src/Ice/Blobject.java +++ b/java/src/Ice/Blobject.java @@ -11,8 +11,8 @@ package Ice; /** * Base class for dynamic dispatch servants. A server application - * derives a concrete servant class from <code>Blobject</code. that - * implements the <code>ice_invoke</code> method. + * derives a concrete servant class from <code>Blobject</code> that + * implements the {@link Blobject#ice_invoke} method. **/ public abstract class Blobject extends Ice.ObjectImpl { diff --git a/java/src/Ice/DispatchInterceptor.java b/java/src/Ice/DispatchInterceptor.java index 4901aef9ab2..d9da442e4ee 100644 --- a/java/src/Ice/DispatchInterceptor.java +++ b/java/src/Ice/DispatchInterceptor.java @@ -12,7 +12,7 @@ package Ice; /** * Base class that allows a server intercept incoming requests. * The application must derive a concrete class from <code>DispatchInterceptor</code> - * that implements the <code>dispatch</code> operation. An instance of this derived + * that implements the {@link DispatchInterceptor#dispatch} operation. An instance of this derived * class can be registered with an object adapter like any other servant. * <p> * A dispatch interceptor is useful particularly to automatically retry requests @@ -26,7 +26,7 @@ public abstract class DispatchInterceptor extends ObjectImpl * * @param request The details of the incoming request. * @return For synchronous dispatch, the return value must be whatever is - * returned <code>ice_dispatch</code>. For asynchronous dispatch, the return + * returned {@link #ice_dispatch}. For asynchronous dispatch, the return * value must be <code>DispatchAsync</code>. * * @see Request diff --git a/java/src/Ice/InitializationData.java b/java/src/Ice/InitializationData.java index 466174af2bc..18395f54dac 100644 --- a/java/src/Ice/InitializationData.java +++ b/java/src/Ice/InitializationData.java @@ -12,7 +12,7 @@ package Ice; /** * A class that encapsulates data to initialize a communicator. * - * @see Communicator.intialize + * @see Communicator#intialize * @see Properties * @see Logger * @see Stats diff --git a/java/src/Ice/InputStream.java b/java/src/Ice/InputStream.java index b3d6d13637f..2a4f897d15f 100644 --- a/java/src/Ice/InputStream.java +++ b/java/src/Ice/InputStream.java @@ -30,7 +30,7 @@ public interface InputStream * * @param If <code>true</code> (the default), slicing is enabled; if <code>false</code>, * slicing is disabled. If slicing is disabled and the stream encounters a Slice type ID - * during decoding for which no object factory is installed, it raises <code>NoObjectFactoryException</code>. + * during decoding for which no object factory is installed, it raises {@link NoObjectFactoryException}. **/ void sliceObjects(boolean slice); @@ -171,7 +171,7 @@ public interface InputStream * Extracts the index of a Slice class from the stream. * * @param cb The callback to notify the application when the extracted instance is available. - * The Ice run time extracts Slice classes stages. The Ice run time calls <code>ReadObjectCallback.invoke</code> + * The Ice run time extracts Slice classes stages. The Ice run time calls {@link ReadObjectCallback#invoke} * when the corresponding instance has been fully unmarshaled. * * @see ReadObjectCallback @@ -258,7 +258,7 @@ public interface InputStream /** * Indicates that unmarshaling is complete, except for any Slice objects. The application must call this method * only if the stream actually contains Slice objects. Calling <code>readPendingObjects</code> triggers the - * calls to <code>ReadObjectCallback.invoke</code> that inform the application that unmarshaling of a Slice + * calls to {@link ReadObjectCallback#invoke} that inform the application that unmarshaling of a Slice * object is complete. **/ void readPendingObjects(); diff --git a/java/src/Ice/LoggerPlugin.java b/java/src/Ice/LoggerPlugin.java index e9f3ddbc7d1..a123e30e4d0 100644 --- a/java/src/Ice/LoggerPlugin.java +++ b/java/src/Ice/LoggerPlugin.java @@ -12,7 +12,7 @@ package Ice; /** * Class to support custom loggers. Applications using a custom logger * instantiate a <code>LoggerPlugin</code> with a custom logger and - * return the instance from their <code>PluginFactory</code> implementation. + * return the instance from their {@link PluginFactory} implementation. * * @see PluginFactory * @see Plugin diff --git a/java/src/Ice/LongHolder.java b/java/src/Ice/LongHolder.java index 8488c4b1272..39219c93d99 100644 --- a/java/src/Ice/LongHolder.java +++ b/java/src/Ice/LongHolder.java @@ -32,7 +32,7 @@ public final class LongHolder } /** - * The <code>int</code> value stored by this holder. + * The <code>long</code> value stored by this holder. **/ public long value; } diff --git a/java/src/Ice/Object.java b/java/src/Ice/Object.java index 4c6fd03267a..7f2b79c3c1d 100644 --- a/java/src/Ice/Object.java +++ b/java/src/Ice/Object.java @@ -34,7 +34,7 @@ public interface Object * Tests whether this object supports a specific Slice interface. * * @param s The type ID of the Slice interface to test against. - * @param current The <code>Current</code> object for the invocation. + * @param current The {@link Current} object for the invocation. * @return <code>true</code> if this object has the interface * specified by <code>s</code> or derives from the interface * specified by <code>s</code>. @@ -49,7 +49,7 @@ public interface Object /** * Tests whether this object can be reached. * - * @param current The <code>Current</code> object for the invocation. + * @param current The {@link Current} object for the invocation. **/ void ice_ping(Current current); @@ -64,7 +64,7 @@ public interface Object /** * Returns the Slice type IDs of the interfaces supported by this object. * - * @param current The <code>Current</code> object for the invocation. + * @param current The {@link Current} object for the invocation. * @return The Slice type Ids of the interfaces supported by this object, in base-to-derived * order. The first element of the return array is always <code>::Ice::Object</code>. **/ @@ -80,7 +80,7 @@ public interface Object /** * Returns the Slice type ID of the most-derived interface supported by this object. * - * @param current The <code>Current</code> object for the invocation. + * @param current The {@link Current} object for the invocation. * @return The Slice type ID of the most-derived interface. **/ String ice_id(Current current); @@ -108,7 +108,7 @@ public interface Object * <dd><code>["freeze:read:never"]</code></dd> * </dl> * - * @see Freeze:TransactionalEvictor + * @see Freeze.TransactionalEvictor **/ int ice_operationAttributes(String operation); diff --git a/java/src/Ice/ObjectImpl.java b/java/src/Ice/ObjectImpl.java index b19c4d9a991..c3df1998d9f 100644 --- a/java/src/Ice/ObjectImpl.java +++ b/java/src/Ice/ObjectImpl.java @@ -161,7 +161,7 @@ public abstract class ObjectImpl implements Object, java.lang.Cloneable, java.io /** * Returns the Slice type ID of the most-derived interface supported by this object. * - * @return The return value is always <code>::Ice::Object</code.> + * @return The return value is always <code>::Ice::Object</code>. **/ public String ice_id() @@ -173,7 +173,7 @@ public abstract class ObjectImpl implements Object, java.lang.Cloneable, java.io * Returns the Slice type ID of the most-derived interface supported by this object. * * @param current The current object for the invocation. - * @return The return value is always <code>::Ice::Object</code.> + * @return The return value is always {@link IceObject}. **/ public String ice_id(Current current) @@ -194,7 +194,7 @@ public abstract class ObjectImpl implements Object, java.lang.Cloneable, java.io /** * Returns the Slice type ID of the most-derived interface supported by this object. * - * @return The return value is always <code>::Ice::Object</code>. + * @return The return value is always {@link IceObject}. **/ public static String ice_staticId() @@ -225,7 +225,7 @@ public abstract class ObjectImpl implements Object, java.lang.Cloneable, java.io * <dd><code>["freeze:read:never"]</code></dd> * </dl> * - * @see Freeze:TransactionalEvictor + * @see Freeze.TransactionalEvictor **/ public int ice_operationAttributes(String operation) { diff --git a/java/src/Ice/ObjectPrx.java b/java/src/Ice/ObjectPrx.java index 7d467544e14..0ec89ee0387 100644 --- a/java/src/Ice/ObjectPrx.java +++ b/java/src/Ice/ObjectPrx.java @@ -453,7 +453,7 @@ public interface ObjectPrx /** * Creates a new proxy that is identical to this proxy, except for compression. * - * @param co <code>true</code> enables compression for the new proxy; <code>false</code>disables compression. + * @param co <code>true</code> enables compression for the new proxy; <code>false</code> disables compression. * @return A new proxy with the specified compression setting. **/ ObjectPrx ice_compress(boolean co); @@ -477,10 +477,10 @@ public interface ObjectPrx ObjectPrx ice_connectionId(String connectionId); /** - * Returns the <code>Connection</code> for this proxy. If the proxy does not yet have an established connection, + * Returns the {@link Connection} for this proxy. If the proxy does not yet have an established connection, * it first attempts to create a connection. * - * @return The <code>Connection</code> for this proxy. + * @return The {@link Connection} for this proxy. * @throws CollocationOptimizationException If the proxy uses collocation optimization and denotes a * collocated object. * @@ -489,10 +489,10 @@ public interface ObjectPrx Connection ice_getConnection(); /** - * Returns the cached <code>Connection</code> for this proxy. If the proxy does not yet have an established + * Returns the cached {@link Connection} for this proxy. If the proxy does not yet have an established * connection, it does not attempt to create a connection. * - * @return The cached <code>Connection</code> for this proxy (<code>null</code> if the proxy does not have + * @return The cached {@link Connection} for this proxy (<code>null</code> if the proxy does not have * an established connection). * @throws CollocationOptimizationException If the proxy uses collocation optimization and denotes a * collocated object. diff --git a/java/src/Ice/ObjectPrxHelper.java b/java/src/Ice/ObjectPrxHelper.java index 22c553855a8..da4360fe5ff 100644 --- a/java/src/Ice/ObjectPrxHelper.java +++ b/java/src/Ice/ObjectPrxHelper.java @@ -12,11 +12,11 @@ package Ice; public class ObjectPrxHelper extends ObjectPrxHelperBase { /** - * Casts a proxy to <code>::Ice::ObjectPrx</code>. This call contacts + * Casts a proxy to {@link Ice.ObjectPrx}. This call contacts * the server and will throw an Ice run-time exception if the target * object does not exist or the server cannot be reached. * - * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>. + * @param b The proxy to cast to @{link Ice.ObjectPrx}. * @return <code>b</code>. **/ public static ObjectPrx @@ -26,11 +26,11 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase } /** - * Casts a proxy to <code>::Ice::ObjectPrx</code>. This call contacts + * Casts a proxy to {@link Ice.ObjectPrx}. This call contacts * the server and throws an Ice run-time exception if the target * object does not exist or the server cannot be reached. * - * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>. + * @param b The proxy to cast to {@link Ice.ObjectPrx}. * @param ctx The <code>Context</code> map for the invocation. * @return <code>b</code>. **/ @@ -46,7 +46,7 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase * the server and throws an Ice run-time exception if the target * object does not exist, the specified facet does not exist, or the server cannot be reached. * - * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>. + * @param b The proxy to cast to {@link Ice.ObjectPrx}. * @param f The facet for the new proxy. * @return The new proxy with the specified facet. **/ @@ -78,7 +78,7 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase * the server and throws an Ice run-time exception if the target * object does not exist, the specified facet does not exist, or the server cannot be reached. * - * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>. + * @param b The proxy to cast to {@link Ice.ObjectPrx}. * @param f The facet for the new proxy. * @param ctx The <code>Context</code> map for the invocation. * @return The new proxy with the specified facet. @@ -106,10 +106,10 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase } /** - * Casts a proxy to <code>::Ice::ObjectPrx</code>. This call does + * Casts a proxy to {@link Ice.ObjectPrx}. This call does * not contact the server and always succeeds. * - * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>. + * @param b The proxy to cast to {@link Ice.ObjectPrx}. * @return <code>b</code>. **/ public static ObjectPrx @@ -122,7 +122,7 @@ public class ObjectPrxHelper extends ObjectPrxHelperBase * Creates a new proxy that is identical to the passed proxy, except * for its facet. This call does not contact the server and always succeeds. * - * @param b The proxy to cast to <code>::Ice::ObjectPrx</code>. + * @param b The proxy to cast to {@link Ice.ObjectPrx}. * @param f The facet for the new proxy. * @return The new proxy with the specified facet. **/ diff --git a/java/src/Ice/ObjectPrxHelperBase.java b/java/src/Ice/ObjectPrxHelperBase.java index 653c2511b62..285f6d7e6a6 100644 --- a/java/src/Ice/ObjectPrxHelperBase.java +++ b/java/src/Ice/ObjectPrxHelperBase.java @@ -1032,10 +1032,10 @@ public class ObjectPrxHelperBase implements ObjectPrx, java.io.Serializable } /** - * Returns the <code>Connection</code> for this proxy. If the proxy does not yet have an established connection, + * Returns the {@link Connection} for this proxy. If the proxy does not yet have an established connection, * it first attempts to create a connection. * - * @return The <code>Connection</code> for this proxy. + * @return The {@link Connection} for this proxy. * @throws CollocationOptimizationException If the proxy uses collocation optimization and denotes a * collocated object. * @@ -1062,10 +1062,10 @@ public class ObjectPrxHelperBase implements ObjectPrx, java.io.Serializable } /** - * Returns the cached <code>Connection</code> for this proxy. If the proxy does not yet have an established + * Returns the cached {@link Connection} for this proxy. If the proxy does not yet have an established * connection, it does not attempt to create a connection. * - * @return The cached <code>Connection</code> for this proxy (<code>null</code> if the proxy does not have + * @return The cached {@link Connection} for this proxy (<code>null</code> if the proxy does not have * an established connection). * @throws CollocationOptimizationException If the proxy uses collocation optimization and denotes a * collocated object. diff --git a/java/src/Ice/OutputStream.java b/java/src/Ice/OutputStream.java index 72471d6d501..654cbcb0b64 100644 --- a/java/src/Ice/OutputStream.java +++ b/java/src/Ice/OutputStream.java @@ -165,7 +165,7 @@ public interface OutputStream * Writes a Slice class to the stream. * * @param v The class to write. This method writes the index of a Slice class; the state of the class is - * written once <code>writePendingObjects</code> is called. + * written once {@link #writePendingObjects} is called. **/ void writeObject(Ice.Object v); @@ -205,7 +205,7 @@ public interface OutputStream /** * Writes the state of Slice classes whose index was previously - * written with <code>writeObject</code> to the stream. + * written with {@link #writeObject} to the stream. **/ void writePendingObjects(); diff --git a/java/src/Ice/ReadObjectCallback.java b/java/src/Ice/ReadObjectCallback.java index 1e383c23b81..23248f1d2fc 100644 --- a/java/src/Ice/ReadObjectCallback.java +++ b/java/src/Ice/ReadObjectCallback.java @@ -13,7 +13,7 @@ package Ice; * Callback class to inform an application when a Slice class has been unmarshaled * from an input stream. * - * @see InputStream.readObject + * @see InputStream#readObject **/ public interface ReadObjectCallback { diff --git a/java/src/Ice/Request.java b/java/src/Ice/Request.java index a9e7a07080e..0f26dab1d2c 100644 --- a/java/src/Ice/Request.java +++ b/java/src/Ice/Request.java @@ -23,9 +23,9 @@ public interface Request boolean isCollocated(); /** - * Returns the <code>Current</code> object for this the request. + * Returns the {@link Current} object for this the request. * - * @return The <code>Current</code> object for this request. + * @return The {@link Current} object for this request. **/ Current getCurrent(); } diff --git a/java/src/Ice/SignalPolicy.java b/java/src/Ice/SignalPolicy.java index faba3d600b3..86f8bcd00ca 100644 --- a/java/src/Ice/SignalPolicy.java +++ b/java/src/Ice/SignalPolicy.java @@ -17,10 +17,9 @@ package Ice; public enum SignalPolicy { /** - * If a signal is received, Ice.Application reacts to the signal - * by calling <code>destroy</code> or <code>shutdown</code> on - * the communicator, or by calling a custom shutdown hook installed - * by the application. + * If a signal is received, {@link Ice.Application} reacts to the signal + * by calling {@link Communicator#destroy} or {@link Communicator#shutdown}, + * or by calling a custom shutdown hook installed by the application. **/ HandleSignals, diff --git a/java/src/IceSSL/Plugin.java b/java/src/IceSSL/Plugin.java index bb6c1cbf7f8..9515a8acbe3 100644 --- a/java/src/IceSSL/Plugin.java +++ b/java/src/IceSSL/Plugin.java @@ -19,7 +19,7 @@ public interface Plugin extends Ice.Plugin * plug-in is initialized. Therefore, the application must set * the property <code>Ice.InitPlugins</code> to zero, call * <code>setContext</code> to set the context, and finally - * invoke <code>initializePlugins</code> on the <code>PluginManager</code>. + * invoke {@link PluginManager#initializePlugins}. * <p> * If an application supplies its own SSL context, the * plug-in skips its normal property-based configuration. @@ -77,7 +77,7 @@ public interface Plugin extends Ice.Plugin /** * Supplies an input stream for the truststore. Calling this method * causes IceSSL to ignore the <code>IceSSL.Truststore</code> property. It is - * legal to supply the same input stream as the one for <code>setKeystoreStream</code>, + * legal to supply the same input stream as the one for {@link #setKeystoreStream}, * in which case IceSSL uses the certificates contained in the keystore. * * @param stream The input stream for the truststore. diff --git a/java/src/IceSSL/PluginFactory.java b/java/src/IceSSL/PluginFactory.java index 0e7fdf0c537..70ada47f651 100644 --- a/java/src/IceSSL/PluginFactory.java +++ b/java/src/IceSSL/PluginFactory.java @@ -23,7 +23,7 @@ public class PluginFactory implements Ice.PluginFactory * * @return The new plug-in. <code>null</code> can be returned to indicate * that a general error occurred. Alterntively, <code>create</code> can throw - * <code>PluginInitializationException</code> to provide more detailed information. + * {@link PluginInitializationException} to provide more detailed information. **/ public Ice.Plugin create(Ice.Communicator communicator, String name, String[] args) diff --git a/java/src/IceUtil/Cache.java b/java/src/IceUtil/Cache.java index 2fc00d10816..f983f394d80 100644 --- a/java/src/IceUtil/Cache.java +++ b/java/src/IceUtil/Cache.java @@ -36,9 +36,9 @@ public class Cache * * @return If the cache contains an entry for the key, the return value * is the object corresponding to the key; otherwise, the return value - * is null. <code>getIfPinned</code> does not call load. + * is null. <code>getIfPinned</code> does not call {@link Store#load}. * - * @see Store.load + * @see Store#load **/ public Object getIfPinned(Object key) @@ -97,7 +97,7 @@ public class Cache /** * Adds a key-value pair to the cache. - * This version of <code>pin</code> does not call <code>Store.load</code> to retrieve + * This version of <code>pin</code> does not call {@link Store#load} to retrieve * an entry from backing store if an entry for the given key is not yet in the cache. This * is useful to add a newly-created object to the cache. * @@ -128,13 +128,13 @@ public class Cache /** * Returns an object from the cache. * If no entry with the given key is in the cache, <code>pin</code> calls - * <code>load</code> to retrieve the corresponding value (if any) from the + * {@link Store#load} to retrieve the corresponding value (if any) from the * backing store. * * @param key The key for the entry to retrieve. * @return Returns the value for the corresponding key if the cache * contains an entry for the key. Otherwise, <code>pin(Object)</code> calls - * <code>Store.load</code> and the return value is whatever is returned by + * {@link Store#load} and the return value is whatever is returned by * <code>load</code>; if <code>load</code> throws an exception, that exception * is thrown by <code>pin(Object)</code>. **/ @@ -151,7 +151,7 @@ public class Cache * @return If the cache already contains an entry for the given key, * <code>putIfAbsent</code> returns the original value for that key. * If no entry is for the given key is in the cache, <code>putIfAbsent</code> - * calls <code>load</code> to retrieve the corresponding entry (if any) from + * calls {@link Store#load} to retrieve the corresponding entry (if any) from * the backings store and returns the value returned by <code>load</code>. * If the cache does not contain an entry for the given key and <code>load</code> * does not return a value for the key, <code>putIfAbsent</code> adds the new entry |