diff options
| -rw-r--r-- | java/src/Glacier2/src/main/java/Glacier2/SessionFactoryHelper.java | 4 | ||||
| -rw-r--r-- | java/src/Glacier2/src/main/java/Glacier2/SessionHelper.java | 4 | ||||
| -rw-r--r-- | java/src/Ice/src/main/java/IceSSL/Plugin.java | 2 | ||||
| -rw-r--r-- | java/src/Ice/src/main/java/IceSSL/PluginFactory.java | 2 | ||||
| -rw-r--r-- | slice/Ice/Communicator.ice | 6 | ||||
| -rw-r--r-- | slice/Ice/Instrumentation.ice | 52 | ||||
| -rw-r--r-- | slice/Ice/Metrics.ice | 2 | ||||
| -rw-r--r-- | slice/Ice/RemoteLogger.ice | 64 |
8 files changed, 68 insertions, 68 deletions
diff --git a/java/src/Glacier2/src/main/java/Glacier2/SessionFactoryHelper.java b/java/src/Glacier2/src/main/java/Glacier2/SessionFactoryHelper.java index 8653443befc..07a2fc260ed 100644 --- a/java/src/Glacier2/src/main/java/Glacier2/SessionFactoryHelper.java +++ b/java/src/Glacier2/src/main/java/Glacier2/SessionFactoryHelper.java @@ -13,7 +13,7 @@ package Glacier2; * A helper class for using Glacier2 with GUI applications. * * Applications should create a session factory for each Glacier2 router to which the application will - * connect. To connect with the Glacier2 router, call {@link SessionFactory#connect}. The callback object is + * connect. To connect with the Glacier2 router, call {@link SessionFactoryHelper#connect}. The callback object is * notified of the various life cycle events. Once the session is torn down for whatever reason, the application * can use the session factory to create another connection. */ @@ -167,7 +167,7 @@ public class SessionFactoryHelper * * Sets the protocol that will be used by the session factory to establish the connection. * - * @param protocol. + * @param protocol The communication protocol. */ synchronized public void setProtocol(String protocol) { diff --git a/java/src/Glacier2/src/main/java/Glacier2/SessionHelper.java b/java/src/Glacier2/src/main/java/Glacier2/SessionHelper.java index e84bbf565ca..0d222963366 100644 --- a/java/src/Glacier2/src/main/java/Glacier2/SessionHelper.java +++ b/java/src/Glacier2/src/main/java/Glacier2/SessionHelper.java @@ -34,7 +34,7 @@ public class SessionHelper /** * Destroys the Glacier2 session. * - * Once the session has been destroyed, {@link SessionCallback.disconnected} is called on + * Once the session has been destroyed, {@link SessionCallback#disconnected} is called on * the associated callback object. */ public void @@ -233,7 +233,7 @@ public class SessionHelper * Connects a Glacier2 session using user name and password credentials. * * Once the connection is established, {@link SessionCallback#connected} is called on the callback object; - * upon failure {@link SessionCallback.connectFailed} is called with the exception. + * upon failure {@link SessionCallback#connectFailed} is called with the exception. * * @param username The user name. * @param password The password. diff --git a/java/src/Ice/src/main/java/IceSSL/Plugin.java b/java/src/Ice/src/main/java/IceSSL/Plugin.java index 7301c37ed6a..9be0c0a332e 100644 --- a/java/src/Ice/src/main/java/IceSSL/Plugin.java +++ b/java/src/Ice/src/main/java/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 {@link PluginManager#initializePlugins}. + * invoke {@link Ice.PluginManager#initializePlugins}. * <p> * If an application supplies its own SSL context, the * plug-in skips its normal property-based configuration. diff --git a/java/src/Ice/src/main/java/IceSSL/PluginFactory.java b/java/src/Ice/src/main/java/IceSSL/PluginFactory.java index cb8063fe148..610415090ea 100644 --- a/java/src/Ice/src/main/java/IceSSL/PluginFactory.java +++ b/java/src/Ice/src/main/java/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. Alternatively, <code>create</code> can throw - * {@link PluginInitializationException} to provide more detailed information. + * {@link Ice.PluginInitializationException} to provide more detailed information. **/ @Override public Ice.Plugin diff --git a/slice/Ice/Communicator.ice b/slice/Ice/Communicator.ice index 6681587a1c6..4bb04372251 100644 --- a/slice/Ice/Communicator.ice +++ b/slice/Ice/Communicator.ice @@ -239,7 +239,7 @@ local interface Communicator * * Create a new object adapter with endpoints. This operation sets * the property <tt><em>name</em>.Endpoints</tt>, - * and then calls {@link createObjectAdapter}. It is provided as a + * and then calls {@link #createObjectAdapter}. It is provided as a * convenience function.</p> * * <p>Calling this operation with an empty name will result in a @@ -440,8 +440,8 @@ local interface Communicator * * <p class="Note"> You can also set a locator for an individual proxy * by calling the operation <tt>ice_locator</tt> on the proxy, or for an - * object adapter by calling the operation {@link setLocator} on the - * object adapter. + * object adapter by calling the operation {@link ObjectAdapter#setLocator} + * on the object adapter. * * @param loc The default locator to use for this communicator. * diff --git a/slice/Ice/Instrumentation.ice b/slice/Ice/Instrumentation.ice index b856f6d92ea..21386848f51 100644 --- a/slice/Ice/Instrumentation.ice +++ b/slice/Ice/Instrumentation.ice @@ -41,7 +41,7 @@ local interface Observer * * This method is called when the instrumented object is created * or when the observer is attached to an existing object. - * + * **/ void attach(); @@ -62,13 +62,13 @@ local interface Observer **/ void failed(string exceptionName); }; - + /** * * The thread state enumeration keeps track of the different possible * states of Ice threads. * - **/ + **/ local enum ThreadState { /** @@ -91,7 +91,7 @@ local enum ThreadState * * The thread is calling user code (servant implementation, AMI * callbacks). This state is only for threads from an Ice thread - * pool. + * pool. * **/ ThreadStateInUseForUser, @@ -110,7 +110,7 @@ local enum ThreadState * The thread observer interface to instrument Ice threads. This can * be threads from the Ice thread pool or utility threads used by the * Ice core. - * + * **/ local interface ThreadObserver extends Observer { @@ -122,7 +122,7 @@ local interface ThreadObserver extends Observer * * @param newState The new thread state. * - **/ + **/ void stateChanged(ThreadState oldState, ThreadState newState); }; @@ -130,14 +130,14 @@ local interface ThreadObserver extends Observer * * The state of an Ice connection. * - **/ + **/ local enum ConnectionState { /** * * The connection is being validated. * - **/ + **/ ConnectionStateValidating, /** @@ -146,7 +146,7 @@ local enum ConnectionState * **/ ConnectionStateHolding, - + /** * * The connection is active and can send and receive messages. @@ -175,7 +175,7 @@ local enum ConnectionState /** * * The connection observer interface to instrument Ice connections. - * + * **/ local interface ConnectionObserver extends Observer { @@ -184,7 +184,7 @@ local interface ConnectionObserver extends Observer * Notification of sent bytes over the connection. * * @param num The number of bytes sent. - * + * **/ void sentBytes(int num); @@ -193,7 +193,7 @@ local interface ConnectionObserver extends Observer * Notification of received bytes over the connection. * * @param num The number of bytes received. - * + * **/ void receivedBytes(int num); }; @@ -217,7 +217,7 @@ local interface DispatchObserver extends Observer * Reply notification. * * @param size The size of the reply. - * + * **/ void reply(int size); }; @@ -246,7 +246,7 @@ local interface ChildInvocationObserver extends Observer * The remote observer to instrument invocations that are sent over * the wire. * - **/ + **/ local interface RemoteObserver extends ChildInvocationObserver { }; @@ -256,7 +256,7 @@ local interface RemoteObserver extends ChildInvocationObserver * The collocated observer to instrument invocations that are * collocated. * - **/ + **/ local interface CollocatedObserver extends ChildInvocationObserver { }; @@ -344,7 +344,7 @@ local interface ObserverUpdater * for each connection {@link CommunicatorObserver#getConnectionObserver} * is called. The implementation of getConnectionObserver has the * possibility to return an updated observer if necessary. - * + * **/ void updateConnectionObservers(); @@ -357,7 +357,7 @@ local interface ObserverUpdater * each thread {@link CommunicatorObserver#getThreadObserver} is * called. The implementation of getThreadObserver has the * possibility to return an updated observer if necessary. - * + * **/ void updateThreadObservers(); }; @@ -394,7 +394,7 @@ local interface CommunicatorObserver * * This method should return an observer for the given endpoint * information. The Ice run-time calls this method to resolve an - * endpoint and obtain the list of connectors. + * endpoint and obtain the list of connectors. * * For IP endpoints, this typically involves doing a DNS lookup to * obtain the IP addresses associated with the DNS name. @@ -407,11 +407,11 @@ local interface CommunicatorObserver Observer getEndpointLookupObserver(Endpoint endpt); /** - * + * * This method should return a connection observer for the given * connection. The Ice run-time calls this method for each new * connection and for all the Ice communicator connections when - * {@link ObserverUpdater#updateConnections} is called. + * {@link ObserverUpdater#updateConnectionObservers} is called. * * @param c The connection information. * @@ -428,11 +428,11 @@ local interface CommunicatorObserver ConnectionObserver getConnectionObserver(ConnectionInfo c, Endpoint e, ConnectionState s, ConnectionObserver o); /** - * + * * This method should return a thread observer for the given * thread. The Ice run-time calls this method for each new thread * and for all the Ice communicator threads when - * {@link ObserverUpdater#updateThreads} is called. + * {@link ObserverUpdater#updateThreadObservers} is called. * * @param parent The parent of the thread. * @@ -449,7 +449,7 @@ local interface CommunicatorObserver ThreadObserver getThreadObserver(string parent, string id, ThreadState s, ThreadObserver o); /** - * + * * This method should return an invocation observer for the given * invocation. The Ice run-time calls this method for each new * invocation on a proxy. @@ -466,7 +466,7 @@ local interface CommunicatorObserver InvocationObserver getInvocationObserver(Object* prx, string operation, Context ctx); /** - * + * * This method should return a dispatch observer for the given * dispatch. The Ice run-time calls this method each time it * receives an incoming invocation to be dispatched for an Ice @@ -480,7 +480,7 @@ local interface CommunicatorObserver * @return The dispatch observer to instrument the dispatch. * **/ - DispatchObserver getDispatchObserver(Current c, int size); + DispatchObserver getDispatchObserver(Current c, int size); /** * @@ -496,6 +496,6 @@ local interface CommunicatorObserver }; }; - + }; diff --git a/slice/Ice/Metrics.ice b/slice/Ice/Metrics.ice index a849e246c32..5bac7e91854 100644 --- a/slice/Ice/Metrics.ice +++ b/slice/Ice/Metrics.ice @@ -269,7 +269,7 @@ class ThreadMetrics extends Metrics * * The number of threads which are currently performing other * activities. These are all other that are not counted with - * {@link inUseForUser} or {@link inUseForIO}, such as DNS + * {@link #inUseForUser} or {@link #inUseForIO}, such as DNS * lookups, garbage collection). * **/ diff --git a/slice/Ice/RemoteLogger.ice b/slice/Ice/RemoteLogger.ice index 894e3392798..1065bf40260 100644 --- a/slice/Ice/RemoteLogger.ice +++ b/slice/Ice/RemoteLogger.ice @@ -26,30 +26,30 @@ module Ice enum LogMessageType { /** - * + * * The {@link Logger} received a print message. - * + * **/ PrintMessage, /** - * + * * The {@link Logger} received a trace message. - * + * **/ TraceMessage, /** - * + * * The {@link Logger} received a warning message. - * + * **/ WarningMessage, /** - * + * * The {@link Logger} received an error message. - * + * **/ ErrorMessage }; @@ -71,32 +71,32 @@ sequence<LogMessageType> LogMessageTypeSeq; struct LogMessage { /** - * + * * The type of message sent to the {@link Logger}. - * + * **/ LogMessageType type; - + /** - * + * * The date and time when the {@link Logger} received this message, expressed * as the number of microseconds since the Unix Epoch (00:00:00 UTC on 1 January 1970) - * + * **/ long timestamp; /** - * - * For a message of type trace, the trace category of this log message; + * + * For a message of type trace, the trace category of this log message; * otherwise, the empty string. - * + * **/ string traceCategory; /** - * + * * The log message itself. - * + * **/ string message; }; @@ -123,24 +123,24 @@ interface RemoteLogger /** * * init is called by {@link LoggerAdmin#attachRemoteLogger} when a - * RemoteLogger proxy is attached. + * RemoteLogger proxy is attached. * * @param prefix The prefix of the associated local {@link Logger} - * + * * @param logMessages Old log messages generated before "now". * * @see LoggerAdmin#attachRemoteLogger * * **/ - void init(string prefix, LogMessageSeq logMessages); + void init(string prefix, LogMessageSeq logMessages); + - /** * * Log a {@link LogMessage}. Note that log may be called by {@link LoggerAdmin} * before {@link #init}. - * + * * @param message The message to log. * * @see Logger @@ -163,7 +163,7 @@ exception RemoteLoggerAlreadyAttachedException /** * - * The interface of the admin object that allows an Ice application the attach its + * The interface of the admin object that allows an Ice application the attach its * {@link RemoteLogger} to the {@link Logger} of this admin object's Ice communicator. * **/ @@ -171,8 +171,8 @@ interface LoggerAdmin { /** * - * attachRemoteLogger is called to attach a {@link RemoteLogger} object to - * the local {@link Logger}. + * attachRemoteLogger is called to attach a {@link RemoteLogger} object to + * the local {@link Logger}. * attachRemoteLogger calls init on the provided {@link RemoteLogger} proxy. * * @param prx A proxy to the remote logger. @@ -182,9 +182,9 @@ interface LoggerAdmin * * @param traceCategories The categories of traces that the remote logger wishes to receive. * This parameter is ignored if messageTypes is not empty and does not include trace. - * An empty list means no filtering (send all trace categories). + * An empty list means no filtering (send all trace categories). * - * @param messageMax The maximum number of log messages (of all types) to be provided + * @param messageMax The maximum number of log messages (of all types) to be provided * to {@link RemoteLogger#init}. A negative value requests all messages available. * * @throws RemoteLoggerAlreadyAttachedException Raised if this remote logger is already @@ -192,7 +192,7 @@ interface LoggerAdmin * **/ void attachRemoteLogger(RemoteLogger* prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories, - int messageMax) + int messageMax) throws RemoteLoggerAlreadyAttachedException; /** @@ -211,14 +211,14 @@ interface LoggerAdmin * * getLog retrieves log messages recently logged. * - * @param messageTypes The list of message types that the caller wishes to receive. + * @param messageTypes The list of message types that the caller wishes to receive. * An empty list means no filtering (send all message types). * * @param traceCategories The categories of traces that caller wish to receive. * This parameter is ignored if messageTypes is not empty and does not include trace. - * An empty list means no filtering (send all trace categories). + * An empty list means no filtering (send all trace categories). * - * @param messageMax The maximum number of log messages (of all types) to be returned. + * @param messageMax The maximum number of log messages (of all types) to be returned. * A negative value requests all messages available. * * @param prefix The prefix of the associated local {@link Logger}. |