8079342: some docs cleanup for CORBA - part 2
Summary: some fixes for CORBA docs
Reviewed-by: lancea
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/io/ValueHandlerImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/io/ValueHandlerImpl.java Wed May 06 15:10:46 2015 +0400
@@ -171,9 +171,9 @@
* @param out The stream to write the value to
* @param value The value to be written to the stream
**/
- public void writeValue(org.omg.CORBA.portable.OutputStream _out,
+ public void writeValue(org.omg.CORBA.portable.OutputStream out,
java.io.Serializable value) {
- writeValueWithVersion(_out, value, STREAM_FORMAT_VERSION_1);
+ writeValueWithVersion(out, value, STREAM_FORMAT_VERSION_1);
}
private void writeValueWithVersion(org.omg.CORBA.portable.OutputStream _out,
@@ -240,25 +240,25 @@
* Reads a value from the stream using java semantics.
* @param in The stream to read the value from
* @param clazz The type of the value to be read in
- * @param sender The sending context runtime
+ * @param rt The sending context runtime
**/
- public java.io.Serializable readValue(org.omg.CORBA.portable.InputStream _in,
+ public java.io.Serializable readValue(org.omg.CORBA.portable.InputStream in,
int offset,
java.lang.Class clazz,
String repositoryID,
- org.omg.SendingContext.RunTime _sender)
+ org.omg.SendingContext.RunTime rt)
{
// Must use narrow rather than a direct cast to a com.sun
// class. Fix for bug 4379539.
- CodeBase sender = CodeBaseHelper.narrow(_sender);
+ CodeBase sender = CodeBaseHelper.narrow(rt);
- org.omg.CORBA_2_3.portable.InputStream in =
- (org.omg.CORBA_2_3.portable.InputStream) _in;
+ org.omg.CORBA_2_3.portable.InputStream inStream =
+ (org.omg.CORBA_2_3.portable.InputStream) in;
if (!useHashtables) {
if (inputStreamBridge == null) {
inputStreamBridge = createInputStream();
- inputStreamBridge.setOrbStream(in);
+ inputStreamBridge.setOrbStream(inStream);
inputStreamBridge.setSender(sender); //d11638
// backward compatability 4365188
inputStreamBridge.setValueHandler(this);
@@ -269,7 +269,7 @@
try {
inputStreamBridge.increaseRecursionDepth();
- result = (java.io.Serializable) readValueInternal(inputStreamBridge, in, offset, clazz, repositoryID, sender);
+ result = (java.io.Serializable) readValueInternal(inputStreamBridge, inStream, offset, clazz, repositoryID, sender);
} finally {
@@ -287,16 +287,16 @@
if (inputStreamPairs == null)
inputStreamPairs = new Hashtable();
- jdkToOrbInputStreamBridge = (IIOPInputStream)inputStreamPairs.get(_in);
+ jdkToOrbInputStreamBridge = (IIOPInputStream)inputStreamPairs.get(in);
if (jdkToOrbInputStreamBridge == null) {
jdkToOrbInputStreamBridge = createInputStream();
- jdkToOrbInputStreamBridge.setOrbStream(in);
+ jdkToOrbInputStreamBridge.setOrbStream(inStream);
jdkToOrbInputStreamBridge.setSender(sender); //d11638
// backward compatability 4365188
jdkToOrbInputStreamBridge.setValueHandler(this);
- inputStreamPairs.put(_in, jdkToOrbInputStreamBridge);
+ inputStreamPairs.put(in, jdkToOrbInputStreamBridge);
}
java.io.Serializable result = null;
@@ -304,12 +304,12 @@
try {
jdkToOrbInputStreamBridge.increaseRecursionDepth();
- result = (java.io.Serializable) readValueInternal(jdkToOrbInputStreamBridge, in, offset, clazz, repositoryID, sender);
+ result = (java.io.Serializable) readValueInternal(jdkToOrbInputStreamBridge, inStream, offset, clazz, repositoryID, sender);
} finally {
if (jdkToOrbInputStreamBridge.decreaseRecursionDepth() == 0) {
- inputStreamPairs.remove(_in);
+ inputStreamPairs.remove(in);
}
}
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/ObjectKeyImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/ObjectKeyImpl.java Wed May 06 15:10:46 2015 +0400
@@ -37,9 +37,6 @@
import com.sun.corba.se.impl.encoding.EncapsOutputStream ;
-/**
- * @author
- */
public class ObjectKeyImpl implements ObjectKey
{
private ObjectKeyTemplate oktemp;
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/TaggedProfileTemplateFactoryFinderImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/ior/TaggedProfileTemplateFactoryFinderImpl.java Wed May 06 15:10:46 2015 +0400
@@ -35,9 +35,6 @@
import org.omg.CORBA.INTERNAL ;
-/**
- * @author
- */
public class TaggedProfileTemplateFactoryFinderImpl extends
IdentifiableFactoryFinderBase
{
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/javax/rmi/CORBA/Util.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/javax/rmi/CORBA/Util.java Wed May 06 15:10:46 2015 +0400
@@ -593,7 +593,7 @@
* @param className the name of the class.
* @param remoteCodebase a space-separated list of URLs at which
* the class might be found. May be null.
- * @param loadingContext a class whose ClassLoader may be used to
+ * @param loader a class whose ClassLoader may be used to
* load the class if all other methods fail.
* @return the <code>Class</code> object representing the loaded class.
* @exception ClassNotFoundException if class cannot be loaded.
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/BindingIteratorImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/BindingIteratorImpl.java Wed May 06 15:10:46 2015 +0400
@@ -114,7 +114,7 @@
* scope, It will be called from NamingContext.list() operation or
* this.next_n().
* @param how_many The number of requested bindings in the BindingList.
- * @param bl The BindingList as an out parameter.
+ * @param blh The BindingList as an out parameter.
* @return true if there were more bindings.
*/
public boolean list( int how_many, org.omg.CosNaming.BindingListHolder blh)
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/NamingContextImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/NamingContextImpl.java Wed May 06 15:10:46 2015 +0400
@@ -181,7 +181,7 @@
* exists. The NamingContext will participate in recursive resolving.
* @param n a sequence of NameComponents which is the name under which
* the object will be bound.
- * @param obj the NamingContect object reference to be bound.
+ * @param nc the NamingContext object reference to be bound.
* @exception org.omg.CosNaming.NamingContextPackage.NotFound A name with
* multiple components was supplied, but the first component could not be
* resolved.
@@ -278,7 +278,7 @@
* resolving.
* @param n a sequence of NameComponents which is the name under which
* the object will be bound.
- * @param obj the object reference to be bound.
+ * @param nc the object reference to be bound.
* @exception org.omg.CosNaming.NamingContextPackage.NotFound A name with
* multiple components was supplied, but the first component could not be
* resolved.
@@ -853,10 +853,9 @@
/**
* This operation creates a stringified name from the array of Name
* components.
- * @param n Name of the object <p>
+ * @param n Name of the object
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
- * Indicates the name does not identify a binding.<p>
- *
+ * Indicates the name does not identify a binding.
*/
public String to_string(org.omg.CosNaming.NameComponent[] n)
throws org.omg.CosNaming.NamingContextPackage.InvalidName
@@ -882,10 +881,9 @@
/**
* This operation converts a Stringified Name into an equivalent array
* of Name Components.
- * @param sn Stringified Name of the object <p>
+ * @param sn Stringified Name of the object
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
- * Indicates the name does not identify a binding.<p>
- *
+ * Indicates the name does not identify a binding.
*/
public org.omg.CosNaming.NameComponent[] to_name(String sn)
throws org.omg.CosNaming.NamingContextPackage.InvalidName
@@ -920,14 +918,13 @@
* This operation creates a URL based "iiopname://" format name
* from the Stringified Name of the object.
* @param addr internet based address of the host machine where
- * Name Service is running <p>
- * @param sn Stringified Name of the object <p>
+ * Name Service is running
+ * @param sn Stringified Name of the object
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
- * Indicates the name does not identify a binding.<p>
+ * Indicates the name does not identify a binding.
* @exception org.omg.CosNaming.NamingContextPackage.InvalidAddress
* Indicates the internet based address of the host machine is
- * incorrect <p>
- *
+ * incorrect
*/
public String to_url(String addr, String sn)
@@ -961,15 +958,15 @@
/**
* This operation resolves the Stringified name into the object
* reference.
- * @param sn Stringified Name of the object <p>
+ * @param sn Stringified Name of the object
* @exception org.omg.CosNaming.NamingContextPackage.NotFound
- * Indicates there is no object reference for the given name. <p>
+ * Indicates there is no object reference for the given name.
* @exception org.omg.CosNaming.NamingContextPackage.CannotProceed
- * Indicates that the given compound name is incorrect <p>
+ * Indicates that the given compound name is incorrect
* @exception org.omg.CosNaming.NamingContextExtPackage.InvalidName
- * Indicates the name does not identify a binding.<p>
+ * Indicates the name does not identify a binding.
* @exception org.omg.CosNaming.NamingContextPackage.AlreadyBound
- * Indicates the name is already bound.<p>
+ * Indicates the name is already bound.
*
*/
public org.omg.CORBA.Object resolve_str(String sn)
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/TransientBindingIterator.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/TransientBindingIterator.java Wed May 06 15:10:46 2015 +0400
@@ -63,7 +63,6 @@
* @param orb a org.omg.CORBA.ORB object.
* @param aTable A hashtable containing InternalBindingValues which is
* the content of the TransientNamingContext.
- * @param java.lang.Exception a Java exception.
* @exception Exception a Java exception thrown of the base class cannot
* initialize.
*/
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/TransientNameService.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/cosnaming/TransientNameService.java Wed May 06 15:10:46 2015 +0400
@@ -85,7 +85,7 @@
* NamingContext, whose object
* reference can be obtained by the initialNamingContext method.
* @param orb The ORB object
- * @param nameserviceName Stringified key used for INS Service registry
+ * @param serviceName Stringified key used for INS Service registry
* @exception org.omg.CORBA.INITIALIZE Thrown if
* the TransientNameService cannot initialize.
*/
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/pcosnaming/NamingContextImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/pcosnaming/NamingContextImpl.java Wed May 06 15:10:46 2015 +0400
@@ -116,8 +116,8 @@
* Runs the super constructor.
* @param orb an ORB object.
* @param objKey as String
- * @param TheNameService as NameService
- * @param TheServantManagerImpl as ServantManagerImpl
+ * @param theNameService as NameService
+ * @param theServantManagerImpl as ServantManagerImpl
* @exception java.lang.Exception a Java exception.
*/
@@ -223,7 +223,7 @@
* exists. The NamingContext will participate in recursive resolving.
* @param n a sequence of NameComponents which is the name under which
* the object will be bound.
- * @param obj the NamingContect object reference to be bound.
+ * @param nc the NamingContect object reference to be bound.
* @exception org.omg.CosNaming.NamingContextPackage.NotFound A name with multiple
* components was supplied, but the first component could not be
* resolved.
@@ -301,7 +301,7 @@
* unbound first. The NamingContext will participate in recursive resolving.
* @param n a sequence of NameComponents which is the name under which
* the object will be bound.
- * @param obj the object reference to be bound.
+ * @param nc the object reference to be bound.
* @exception org.omg.CosNaming.NamingContextPackage.NotFound A name with multiple
* components was supplied, but the first component could not be
* resolved.
@@ -907,7 +907,7 @@
* The doResolve( ) method calls Resolve( ) recursively to resolve n level
* Names.
* @param n a sequence of NameComponents which is the name to be resolved.
- * @param bt Type of binding (as object or as context).
+ * @param bth Type of binding (as object or as context).
* @return the object reference bound under the supplied name.
* @exception org.omg.CosNaming.NamingContextPackage.NotFound Neither a NamingContext
* or a Corba Object reference not found under this Name
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/pcosnaming/PersistentBindingIterator.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/naming/pcosnaming/PersistentBindingIterator.java Wed May 06 15:10:46 2015 +0400
@@ -64,7 +64,6 @@
* @param orb a org.omg.CORBA.ORB object.
* @param aTable A hashtable containing InternalBindingValues which is
* the content of the PersistentNamingContext.
- * @param java.lang.Exception a Java exception.
* @exception Exception a Java exception thrown of the base class cannot
* initialize.
*/
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/oa/toa/TOAImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/oa/toa/TOAImpl.java Wed May 06 15:10:46 2015 +0400
@@ -61,7 +61,7 @@
* Its characteristics include:
* <UL>
* <LI>There is only one OA instance of the TOA. Its OAId is { "TOA" }</LI>
-* <LI>There is not adapter manager. The TOA manager ID is fixed.<LI>
+* <LI>There is not adapter manager. The TOA manager ID is fixed.</LI>
* <LI>State is the same as ORB state (TBD)</LI>
* </UL>
* Other requirements:
@@ -118,7 +118,7 @@
* This will update thread Current, so that subsequent calls to
* returnServant and removeCurrent from the same thread are for the
* same request.
- * @param request is the request containing the rest of the request
+ * @param info is the request containing the rest of the request
*/
public void getInvocationServant( OAInvocationInfo info )
{
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/DenseIntMapImpl.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/DenseIntMapImpl.java Wed May 06 15:10:46 2015 +0400
@@ -42,8 +42,9 @@
throw new IllegalArgumentException( "Key must be >= 0." ) ;
}
- /** If key >= 0, return the value bound to key, or null if none.
- * Throws IllegalArgumentException if key <0.
+ /**
+ * If {@code key >= 0}, return the value bound to key, or null if none.
+ * Throws IllegalArgumentException if {@code key < 0}.
*/
public Object get( int key )
{
@@ -56,8 +57,9 @@
return result ;
}
- /** If key >= 0, bind value to the key.
- * Throws IllegalArgumentException if key <0.
+ /**
+ * If {@code key >= 0}, bind value to the key.
+ * Throws IllegalArgumentException if {@code key < 0}.
*/
public void set( int key, Object value )
{
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/concurrent/CondVar.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/concurrent/CondVar.java Wed May 06 15:10:46 2015 +0400
@@ -150,8 +150,7 @@
*
* </pre>
* @see Mutex
- * <p>[<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
-
+ * [<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
**/
public class CondVar {
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/concurrent/Sync.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/orbutil/concurrent/Sync.java Wed May 06 15:10:46 2015 +0400
@@ -181,11 +181,11 @@
* }
* }
* }
- *</pre>
+ * </pre>
* <p>
* Here is an even fancier version, that uses lock re-ordering
* upon conflict:
- * <pre>
+ * <pre>{@code
* class Cell {
* long value;
* Sync lock = ...;
@@ -214,8 +214,8 @@
* }
* catch (InterruptedException ex) { return; }
* }
- *}
- *</pre>
+ * }
+ * }</pre>
* <p>
* Interruptions are in general handled as early as possible.
* Normally, InterruptionExceptions are thrown
@@ -248,7 +248,7 @@
* it is normally best to just use acquire(), various forms
* of busy waits can be implemented. For a simple example
* (but one that would probably never be preferable to using acquire()):
- * <pre>
+ * <pre>{@code
* class X {
* Sync lock = ...
* void spinUntilAcquired() throws InterruptedException {
@@ -269,7 +269,7 @@
* }
* }
* }
- * </pre>
+ * }</pre>
* <p>
* In addition pure synchronization control, Syncs
* may be useful in any context requiring before/after methods.
@@ -277,7 +277,7 @@
* (perhaps as part of a LayeredSync) in order to obtain callbacks
* before and after each method invocation for a given class.
*
- * <p>[<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
+ * [<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
**/
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/impl/transport/CorbaConnectionCacheBase.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/impl/transport/CorbaConnectionCacheBase.java Wed May 06 15:10:46 2015 +0400
@@ -130,13 +130,13 @@
* This method must be synchronized since one WorkerThread could
* be reclaming connections inside the synchronized backingStore
* block and a second WorkerThread (or a SelectorThread) could have
- * already executed the if (numberOfConnections <= .... ). As a
+ * already executed the if (numberOfConnections {@literal <=} .... ). As a
* result the second thread would also attempt to reclaim connections.
*
* If connection reclamation becomes a performance issue, the connection
* reclamation could make its own task and consequently executed in
* a separate thread.
- * Currently, the accept & reclaim are done in the same thread, WorkerThread
+ * Currently, the accept {@literal &} reclaim are done in the same thread, WorkerThread
* by default. It could be changed such that the SelectorThread would do
* it for SocketChannels and WorkerThreads for Sockets by updating the
* ParserTable.
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/ior/package.html Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/ior/package.html Wed May 06 15:10:46 2015 +0400
@@ -41,8 +41,8 @@
<li>An IIOPProfile isA TaggedProfile.</li>
<li>An IIOPProfile is composed of an IIOPProfileTemplate and an object ID.</li>
<li>An IIOPProfileTemplate has an ObjectKeyTemplate, and contains TaggedComponents.</li>
-<li>A TaggedComponent has an ID, and can be written to an OuputStream.<li>
-<li>A TaggedComponentFactory reads a TaggedComponent from an InputStream.<li>
+<li>A TaggedComponent has an ID, and can be written to an OuputStream.</li>
+<li>A TaggedComponentFactory reads a TaggedComponent from an InputStream.</li>
</ul>
<p>
In all cases, containment is represented by having the appropriate interface (IOR and
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/legacy/connection/ORBSocketFactory.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/legacy/connection/ORBSocketFactory.java Wed May 06 15:10:46 2015 +0400
@@ -48,7 +48,7 @@
*
* property. <p>
*
- * Example: <p>
+ * Example:
* <pre>
* -Dcom.sun.CORBA.connection.ORBSocketFactoryClass=MySocketFactory
@@ -145,7 +145,7 @@
*
* property. <p>
*
- * Example usage:<p>
+ * Example usage:
*
* <pre>
* ... \
@@ -203,7 +203,7 @@
* Once you have the port you may add information to references
* created by the associated adapter by calling
*
- * <code>IORInfo::add_ior_component</code><p> <p>
+ * <code>IORInfo::add_ior_component</code><p>
*
*
* Note: if one is using a POA and the lifespan policy of that
@@ -247,7 +247,7 @@
*
* <code>ORBConstants.BAD_SERVER_ID_HANDLER_CLASS_PROPERTY</code> <p>
*
- * Example: <p>
+ * Example:
*
* <pre>
*
@@ -271,7 +271,7 @@
* <code>SOCKET_FACTORY_CLASS_PROPERTY</code> and
* <code>LISTEN_SOCKET_PROPERTY</code>
*
- * as used by other clients and servers in your distributed system. <p>
+ * as used by other clients and servers in your distributed system.
*
*/
public ServerSocket createServerSocket(String type, int port)
@@ -324,7 +324,7 @@
*
* The <code>SocketInfo</code> given to <code>getEndPointInfo</code>
* is either null or an object obtained
- * from <code>GetEndPointInfoAgainException</code> <p>
+ * from <code>GetEndPointInfoAgainException</code>
*
*/
public SocketInfo getEndPointInfo(org.omg.CORBA.ORB orb,
@@ -333,7 +333,7 @@
/**
- * DEPRECATED. DEPRECATED. DEPRECATED. DEPRECATED. <p
+ * DEPRECATED. DEPRECATED. DEPRECATED. DEPRECATED. <p>
*
* This method is used by a client side ORB. <p>
*
@@ -346,7 +346,7 @@
*
* If this method throws GetEndPointInfoAgainException then the
* ORB calls <code>getEndPointInfo</code> again, passing it the
- * <code>SocketInfo</code> object contained in the exception. <p>
+ * <code>SocketInfo</code> object contained in the exception.
*
*/
public Socket createSocket(SocketInfo socketInfo)
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredAttribute.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredAttribute.java Wed May 06 15:10:46 2015 +0400
@@ -42,7 +42,7 @@
/**
* Gets the Monitored Attribute Info for the attribute.
*
- * @param monitoredAttributeInfo for this Monitored Attribute.
+ * @return monitoredAttributeInfo for this Monitored Attribute.
*/
public MonitoredAttributeInfo getAttributeInfo();
/**
@@ -67,7 +67,7 @@
* getvalue is same as the one specified in MonitoredAttributeInfo for this
* attribute.
*
- * @param value is the current value for this MonitoredAttribute
+ * @return the current value for this MonitoredAttribute
*/
public Object getValue();
/**
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredObjectFactory.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/monitoring/MonitoredObjectFactory.java Wed May 06 15:10:46 2015 +0400
@@ -25,14 +25,9 @@
package com.sun.corba.se.spi.monitoring;
/**
- * <p>
- *
* @author Hemanth Puttaswamy
- * </p>
- * <p>
*
* MonitoredObject Factory to create Monitored Object.
- * </p>
*/
public interface MonitoredObjectFactory {
/**
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/oa/ObjectAdapter.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/oa/ObjectAdapter.java Wed May 06 15:10:46 2015 +0400
@@ -89,7 +89,7 @@
* <li>A local invocation, where the dispatch is handled in the client subcontract.</li>
* <li>A cached local invocation, where the servant is cached when the IOR is established
* for the client subcontract, and the dispatch is handled in the client subcontract
-* to the cached subcontract.<li>
+* to the cached subcontract.</li>
* </ol>
* <p>
* Each of these 3 cases is handled a bit differently. On each request, assume as known
@@ -113,9 +113,9 @@
* <li>pop info</li>
* </ol>
* </li>
-* REVISIT: Is this the required order for exit/pop? Cna they be nested instead?
+* <!-- REVISIT: Is this the required order for exit/pop? Cna they be nested instead?
* Note that getInvocationServant and returnServant may throw exceptions. In such cases,
-* returnServant, exit, and pop must be called in the correct order.
+* returnServant, exit, and pop must be called in the correct order. -->
* <li>The local pattern:
* <ol>
* <li>oa = oaf.find( oaid )</li>
@@ -128,10 +128,10 @@
* <li>oa.returnServant()</li>
* <li>oa.exit()</li>
* <li>pop info</li>
-* <ol>
+* </ol>
* </li>
-* This is the same as the remote case, except that setExecuteReturnServantInResponseConstructor
-* is not needed (or possible, since there is no server request).
+* <!-- This is the same as the remote case, except that setExecuteReturnServantInResponseConstructor
+* is not needed (or possible, since there is no server request). -->
* <li>The fast local pattern: When delegate is constructed,
* first extract ObjectKey from IOR in delegate,
* then get ObjectId, ObjectAdapterId, and ObjectAdapterFactory (oaf). Then:
@@ -143,14 +143,14 @@
* <li>pop info
* </ol>
* The info instance (which includes the Servant) is cached in the client subcontract.
-* <p>Then, on each invocation:</p>
+* <p>Then, on each invocation:
* <ol>
* <li>newinfo = copy of info (clone)</li>
* <li>info.setOperation( operation )</li>
* <li>push newinfo</li>
* <li>oa.enter()</li>
* <li>dispatch to servant</li>
-* <li>oa.returnServant()</li> // XXX This is probably wrong: remove it.
+* <li>oa.returnServant()</li> <!-- XXX This is probably wrong: remove it. -->
* <li>oa.exit()</li>
* <li>pop info</li>
* </ol>
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/orb/DataCollector.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/orb/DataCollector.java Wed May 06 15:10:46 2015 +0400
@@ -58,7 +58,7 @@
* mappings in the resulting properties. Also, -ORBInitialServices
* is handled specially in applet mode: they are converted from
* relative to absolute URLs.
- * @raises IllegalStateException if setPropertyNames has not
+ * @throws IllegalStateException if setPropertyNames has not
* been called.
*/
Properties getProperties() ;
--- a/corba/src/java.corba/share/classes/com/sun/corba/se/spi/orbutil/fsm/Guard.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/corba/se/spi/orbutil/fsm/Guard.java Wed May 06 15:10:46 2015 +0400
@@ -93,8 +93,8 @@
* input is retried when the thread runs again.
* </ul>
*
- * @param FSM fsm is the state machine causing this action.
- * @param Input in is the input that caused the transition.
+ * @param fsm is the state machine causing this action.
+ * @param in is the input that caused the transition.
*/
public Result evaluate( FSM fsm, Input in ) ;
}
--- a/corba/src/java.corba/share/classes/com/sun/org/omg/CORBA/portable/ValueHelper.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/org/omg/CORBA/portable/ValueHelper.java Wed May 06 15:10:46 2015 +0400
@@ -32,7 +32,7 @@
* An interface that is implemented by valuetype helper classes.
* This interface appeared in CORBA 2.3 drafts but was removed from
* the published CORBA 2.3 specification.
- * <P>
+ *
* @deprecated Deprecated by CORBA 2.3.
*/
@Deprecated
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/Arguments.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/Arguments.java Wed May 06 15:10:46 2015 +0400
@@ -68,9 +68,9 @@
* must check the arguments passed to it for validity and process the
* arguments appropriately. If it detects an invalid argument, it should
* throw an InvalidArgument exception. Arguments MUST be of the form
- * `/<arg> [<qualifiers>]' or `-<arg> [<qualifiers>]' where <qualifiers>
- * is optional (for example, -iC:\includes, `C:\includes' is the qualifier
- * for the argument `i').
+ * {@code '/<arg> [<qualifiers>]'} or {@code '-<arg> [<qualifiers>]'} where {@code <qualifiers>}
+ * is optional (for example, -iC:\includes, 'C:\includes' is the qualifier
+ * for the argument 'i').
* @param args The arguments which are unknown by the framework.
* @param properties Environment-style properties collected from the
* file idl.config.
@@ -289,7 +289,7 @@
public Hashtable definedSymbols = new Hashtable ();
/**
- * <f46082.46.01> True if new module entries are created for each
+ * (f46082.46.01) True if new module entries are created for each
* re-opened module.
**/
public boolean cppModule = false;
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/Compile.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/Compile.java Wed May 06 15:10:46 2015 +0400
@@ -52,7 +52,7 @@
* Compiler usage:
* <br><br>
*
- * java com.sun.tools.corba.se.idl.toJava.compile [options] <idl file>
+ * {@code java com.sun.tools.corba.se.idl.toJava.compile [options] <idl file>}
* <br><br>
*
* where <idl file> is the name of a file containing IDL definitions,
@@ -62,17 +62,17 @@
*
* Options:
* <dl>
- * <dt>-i <include path>
+ * <dt>{@code -i <include path>}
* <dd>By default, the current directory is scanned for included files.
* This option adds another directory. See also Note 1 below.
*
- * <dt>-d <symbol>
- * <dd>This is equivalent to the following line in an IDL file: #define <symbol>
+ * <dt>{@code -d <symbol>}
+ * <dd>This is equivalent to the following line in an IDL file: {@code #define <symbol>}
*
- * <dt>-emitAll
+ * <dt>{@code -emitAll}
* <dd>Emit all types, including those found in #included files.
*
- * <dt>-v
+ * <dt>{@code -v}
* <dd>Verbose mode.
* </dl>
*
@@ -81,9 +81,9 @@
* time. Instead, these can be placed into a config file called idl.config.
* This file must be in the CLASSPATH. The format of the includes line is:
*
- * <pre>
+ * <pre>{@code
* includes=<path1>;<path2>;...;<pathN>
- * </pre>
+ * }</pre>
*
* Note that the path separator character, here shown as a semicolon, is
* machine dependent. For instance, on Windows 95 this character is a
@@ -481,10 +481,10 @@
**/
public Arguments arguments = null;
/**
- * This hashtable contains <real name, alias> pairs. It is filled in by
+ * This hashtable contains {@code <real name, alias>} pairs. It is filled in by
* extenders in cases where they wish to override an IDL type name with
* some other name. For instance, when mapping to Java, there could be
- * an overrideNames entry of <"TRUE", "true">. NOTE: Do NOT change this
+ * an overrideNames entry of {@code <"TRUE", "true">}. NOTE: Do NOT change this
* variable to a new Hash table. Just add elements to it.
**/
protected Hashtable overrideNames = new Hashtable ();
@@ -495,8 +495,8 @@
**/
protected Hashtable symbolTable = new Hashtable ();
/**
- * This is a vector of strings of the form "IDLfile" or <IDLfile>. It is
- * a list of the files included in the given IDL file. It will be empty
+ * This is a vector of strings of the form {@code "IDLfile"} or {@code <IDLfile>}.
+ * It is a list of the files included in the given IDL file. It will be empty
* until the parse method executes. If errors are encountered, the state
* of this vector is undefined.
**/
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/DefaultSymtabFactory.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/DefaultSymtabFactory.java Wed May 06 15:10:46 2015 +0400
@@ -202,7 +202,7 @@
'char', 'octet', 'short', 'long', etc. The reason it is not limited
to these is that, as an extender, you may wish to override these names.
For instance, when generating Java code, octet translates to byte, so
- there is an entry in Compile.overrideNames: <"octet", "byte"> and a
+ there is an entry in Compile.overrideNames: {@code <"octet", "byte">} and a
PrimitiveEntry in the symbol table for "byte". */
public PrimitiveEntry primitiveEntry (String name)
{
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/IncludeEntry.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/IncludeEntry.java Wed May 06 15:10:46 2015 +0400
@@ -97,7 +97,7 @@
//d44810
/** Access the fully-qualified file specification of this include.
- @returns a string containing the path of the include file. */
+ @return a string containing the path of the include file. */
public String absFilename ()
{
return _absFilename;
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/UnionBranch.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/UnionBranch.java Wed May 06 15:10:46 2015 +0400
@@ -46,29 +46,21 @@
* of what it may contain:
* <dl>
* <dt>
- * <pre>
- * case 1: short x;
- * </pre>
- * <dd><short x, <1>, false>
+ * {@code case 1: short x;}
+ * <dd>{@code <short x, <1>, false>}
* <dt>
- * <pre>
- * case 0:
- * case 8:
- * case 2: long x;
- * </pre>
- * <dd><long x, <0, 8, 2>, false>
+ * {@code case 0:}<br>
+ * {@code case 8:}<br>
+ * {@code case 2: long x;}
+ * <dd>{@code <long x, <0, 8, 2>, false>}
* <dt>
- * <pre>
- * default: long x;
- * </pre>
- * <dd><long x, <>, true>
+ * {@code default: long x;}
+ * <dd>{@code <long x, <>, true>}
* <dt>
- * <pre>
- * case 0:
- * case 2:
- * default: char c;
- * </pre>
- * <dd><char c, <0, 2>, true>
+ * {@code case 0:}<br>
+ * {@code case 2:}<br>
+ * {@code default: char c;}
+ * <dd>{@code <char c, <0, 2>, true>}
* </dl>
**/
public class UnionBranch
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/Compile.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/Compile.java Wed May 06 15:10:46 2015 +0400
@@ -87,37 +87,37 @@
*
* Options:
* <dl>
- * <dt>-i <include path>
+ * <dt>{@code -i <include path>}
* <dd>By default, the current directory is scanned for included files.
* This option adds another directory. See also the note below.
*
- * <dt>-d <symbol>
+ * <dt>{@code -d <symbol>}
* <dd>This is equivalent to the following line in an IDL file:
- * #define <symbol>
+ * {@code #define <symbol>}
*
- * <dt>-f<side>
- * <dd>Defines what bindings to emit. <side> is one of client, server, all,
+ * <dt>{@code -f <side>}
+ * <dd>Defines what bindings to emit. {@code <side>} is one of client, server, all,
* serverTIE, allTIE. serverTIE and allTIE cause delegate model skeletons
* to be emitted. If this flag is not used, -fclient is assumed.
* allPOA has the same effect as all, except for generation POA type skeletons.
*
- * <dt>-keep
+ * <dt>{@code -keep}
* <dd>If a file to be generated already exists, do not overwrite it. By
* default it is overwritten.
*
- * <dt>-sep <string>
+ * <dt>{@code -sep <string>}
* <dd>Only valid with -m. Replace the file separator character with
- * <string> in the file names listed in the .u file.
+ * {@code <string>} in the file names listed in the .u file.
*
- * <dt>-emitAll
+ * <dt>{@code -emitAll}
* <dd>Emit all types, including those found in #included files.
*
- * <dt>-v
+ * <dt>{@code -v}
* <dd>Verbose mode.
*
- * <dt>-pkgPrefix <type> <package>
- * <dd>Whereever <type> is encountered, make sure it resides within
- * <package> in all generated files. <type> is a fully
+ * <dt>{@code -pkgPrefix <type> <package>}
+ * <dd>Whereever {@code <type>} is encountered, make sure it resides within
+ * {@code <package>} in all generated files. {@code <type>} is a fully
* qualified, java-style name.
* </dl>
*
@@ -127,9 +127,9 @@
* called idl.config. This file must be in the CLASSPATH. The format of
* the includes line is:
*
- * <pre>
+ * <pre>{@code
* includes=<path1>;<path2>;...;<pathN>
- * </pre>
+ * }</pre>
*
* Note that the path separator character, here shown as a semicolon,
* is machine dependent. For instance, on Windows 95 this character
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/Util.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/Util.java Wed May 06 15:10:46 2015 +0400
@@ -534,7 +534,7 @@
} // holderName
/**
- * <d61056>
+ * d61056
**/
public static String helperName (SymtabEntry entry, boolean qualifiedName)
{
@@ -1412,7 +1412,7 @@
// <d62023>
/**
* @return true if the current setting of corbaLevel is within delta of
- * the range min <= corbaLevel <= max
+ * the range {@code min <= corbaLevel <= max}
**/
public static boolean corbaLevel (float min, float max)
{
--- a/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/ValueBoxGen24.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/toJavaPortable/ValueBoxGen24.java Wed May 06 15:10:46 2015 +0400
@@ -121,7 +121,7 @@
} // helperRead
/**
- * <d62023>
+ * d62023
**/
public void helperWrite (SymtabEntry entry, PrintWriter stream)
{
--- a/corba/src/java.corba/share/classes/org/omg/CORBA/LocalObject.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/java.corba/share/classes/org/omg/CORBA/LocalObject.java Wed May 06 15:10:46 2015 +0400
@@ -28,7 +28,7 @@
/**
- * <P>Used as a base class for implementation of a local IDL interface in the
+ * Used as a base class for implementation of a local IDL interface in the
* Java language mapping. It is a class which implements all the operations
* in the <tt>org.omg.CORBA.Object</tt> interface.
* <P>Local interfaces are implemented by using CORBA::LocalObject
@@ -49,9 +49,10 @@
* <P><code>LocalObject</code> is to be used as the base class of locally
* constrained objects, such as those in the PortableServer module.
* The specification here is based on the CORBA Components
- * Volume I - orbos/99-07-01<P>
+ * Volume I - orbos/99-07-01
+ *
* @see <a href="package-summary.html#unimpl"><code>CORBA</code> package
- * comments for unimplemented features</a>
+ * comments for unimplemented features</a>
*/
public class LocalObject implements org.omg.CORBA.Object
@@ -64,7 +65,7 @@
public LocalObject() {}
/**
- * <P>Determines whether the two object references are equivalent,
+ * Determines whether the two object references are equivalent,
* so far as the ORB can easily determine. Two object references are equivalent
* if they are identical. Two distinct object references which in fact refer to
* the same object are also equivalent. However, ORBs are not required
--- a/corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/CompoundType.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/CompoundType.java Wed May 06 15:10:46 2015 +0400
@@ -145,15 +145,15 @@
/**
* Return true if this type implements
- * isIDLEntity() && isException().
+ * {@code isIDLEntity() && isException()}.
*/
public boolean isIDLEntityException () {
return isIDLEntity() && isException();
}
/**
- * Return true if isIDLEntity() && !isValueBase()
+ * Return true if {@code isIDLEntity() && !isValueBase()
* && !isAbstractBase() && !isCORBAObject()
- * && !isIDLEntityException().
+ * && !isIDLEntityException()}.
*/
public boolean isBoxed () {
return (isIDLEntity() && !isValueBase() &&
@@ -1984,7 +1984,7 @@
}
/**
- * Return true if this is NOT a constructor && is not
+ * Return true if this is NOT a constructor {@code &&} is not
* an attribute.
*/
public boolean isNormalMethod () {
--- a/corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/ContextStack.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/ContextStack.java Wed May 06 15:10:46 2015 +0400
@@ -95,7 +95,7 @@
}
/**
- * Return true if env.nerrors > 0.
+ * Return true if {@code env.nerrors > 0}.
*/
public boolean anyErrors () {
return env.nerrors > 0;
--- a/corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/IDLGenerator.java Tue May 05 15:17:13 2015 +0400
+++ b/corba/src/jdk.rmic/share/classes/sun/rmi/rmic/iiop/IDLGenerator.java Wed May 06 15:10:46 2015 +0400
@@ -91,8 +91,8 @@
/**
* Create and return a top-level type.
- * @param env The compiler environment.
* @param cdef The top-level class definition.
+ * @param stack The context stack.
* @return An RemoteType or null if is non-conforming.
*/
protected sun.rmi.rmic.iiop.CompoundType getTopType(ClassDefinition cdef,
@@ -169,7 +169,7 @@
* Examine and consume command line arguments.
* @param argv The command line arguments. Ignore null
* and unknown arguments. Set each consumed argument to null.
- * @param error Report any errors using the main.error() methods.
+ * @param main Report any errors using the main.error() methods.
* @return true if no errors, false otherwise.
*/
public boolean parseArgs(String argv[], Main main) {
@@ -195,11 +195,11 @@
else if ( argv[i].equalsIgnoreCase( "-init" ) ) {
factory = false;
argv[i] = null;
- }
+ }
else if ( argv[i].equalsIgnoreCase( "-factory" ) ) {
factory = true;
argv[i] = null;
- }
+ }
else if ( argv[i].equalsIgnoreCase( "-idlfile" ) ) {
argv[i] = null;
if ( ++i < argv.length && argv[i] != null && !argv[i].startsWith("-") ) {
@@ -210,7 +210,7 @@
argv[i] = null;
ifHash.put( idlFrom,idlTo );
continue nextArg;
- }
+ }
}
main.error("rmic.option.requires.argument", "-idlfile");
result = false;
@@ -403,7 +403,7 @@
* Write the output for the given OutputFileName into the output stream.
* (The IDL mapping for java.lang.Class is generated from
* javax.rmi.CORBA.ClassDesc in the tools workspace)
- * @param OutputType ot One of the items returned by getOutputTypesFor(...)
+ * @param ot One of the items returned by getOutputTypesFor(...)
* @param alreadyChecked A set of Types which have already been checked.
* Intended to be passed to Type.collectMatching(filter,alreadyChecked).
* @param p The output stream.
@@ -927,7 +927,7 @@
* Add reference for given type avoiding duplication.
* Sort into specials, arrays and regular references.
* Filter out types which are not required.
- * @param t Given Type
+ * @param ref Given Type
* @param refHash Hashtable for type references
* @param spcHash Hashtable for special type references
* @param arrHash Hashtable for array references
@@ -986,7 +986,7 @@
* Collect and filter thrown exceptions for a given pre-filtered method.
* Keep only 'checked' exception classes minus java.rmi.RemoteException
* and its subclasses
- * @param method The current method
+ * @param mth The current method
* @param excHash Hashtable containing non-duplicate thrown exceptions
*/
protected void getExceptions(
@@ -1077,7 +1077,7 @@
* order.
* Non-static, non-transient fields are mapped.
* If the type is a custom valuetype, only public fields are mapped.
- * @param ct The current CompoundType
+ * @param t The current CompoundType
* @return Vector containing the data fields
*/
protected Vector getData(
@@ -1163,7 +1163,7 @@
/**
* Write forward reference for boxed valuetype for single dimension of IDL
* sequence.
- * If the dimension is <1 and the element is a CompoundType, write a
+ * If the dimension is {@literal < 1} and the element is a CompoundType, write a
* forward declare for the element
* @param at ArrayType for forward declare
* @param dim The dimension to write
@@ -1276,7 +1276,7 @@
/**
* Write #includes
- * @param incHash Hashtable loaded with Types to include
+ * @param inhHash Hashtable loaded with Types to include
* @param p The output stream.
*/
protected void writeInheritedIncludes(