[cp-patches] FYI: API doc fixes in org.omg.CORBA

[David Gilbert]

I've had these (minor) API doc fixes sitting on my hard drive for a while and 
figured I might as well commit them:

2005-09-14  David Gilbert  <address@hidden>

        * org/omg/CORBA/ORB.java: minor API doc fixes,
        * org/omg/CORBA/PERSIST_STORE.java: likewise,
        * org/omg/CORBA/PolicyError.java: likewise,
        * org/omg/CORBA/ValueBaseHolder.java: likewise,
        * org/omg/CORBA/VisibilityHelper.java: likewise.

Regards,

Dave Gilbert

Index: org/omg/CORBA/ORB.java
===================================================================
RCS file: /cvsroot/classpath/classpath/org/omg/CORBA/ORB.java,v
retrieving revision 1.15
diff -u -r1.15 ORB.java
--- org/omg/CORBA/ORB.java      2 Sep 2005 15:53:05 -0000       1.15
+++ org/omg/CORBA/ORB.java      14 Sep 2005 07:36:30 -0000
@@ -89,7 +89,7 @@
  * </td></tr>
  * <tr><td>org.omg.CORBA.ORBInitRef</td><td>Specifies the
  * initial reference, accessible by name with the method
- * address@hidden resolve_initial_references(String)}.
+ * address@hidden #resolve_initial_references(String)}.
  * </table>
  * The command line accepts the same properties as a keys. When specifying
  * in the command line, the prefix org.omg.CORBA can be omitted,
@@ -100,8 +100,8 @@
 public abstract class ORB
 {
   /**
-  * By default, address@hidden init(String[], Properties)} and
-  * address@hidden init(Applet, Properties} return
+  * By default, address@hidden #init(String[], Properties)} and
+  * address@hidden #iinit(Applet, Properties)} return
   * the built-in fully functional ORB is returned. If the
   * <code>props</code> contains the property org.omg.CORBA.ORBClass,
   * the value of this property is used as a class name to instantiate
@@ -172,7 +172,7 @@
 
   /**
    * Create an instance of the CORBA address@hidden Any} with the type, 
intialised
-   * to address@hidden TCKind#tc_null}
+   * to address@hidden TCKind#tk_null}
    */
   public abstract Any create_any();
 
@@ -394,7 +394,7 @@
    *
    * @return the named value.
    */
-  public abstract NamedValue create_named_value(String s, Any any, int flags);
+  public abstract NamedValue create_named_value(String name, Any any, int 
flags);
 
   /**
    * Send multiple prepared requests one way, do not caring about the answer.
@@ -466,7 +466,7 @@
    * However this method is oficially documented as not implemented at least
    * till v1.4 inclusive.
    *
-   * @param peration_definition the operation definition, must be
+   * @param operation_definition the operation definition, must be
    * CORBA <code>OperationDef</code>.
    *
    * @return never
@@ -482,7 +482,7 @@
    * <p>Creates the new policy of the specified type, having the given value.
    * This method looks for the policy factory that was previously registered
    * during ORB initialization by
-   * address@hidden org.omg.PortableInterceptor.ORBInitialiser}.
+   * address@hidden org.omg.PortableInterceptor#ORBInitialiser}.
    *
    * If the suitable factory is found, this factory creates the requested 
policy,
    * otherwise the PolicyError is thrown.
@@ -532,7 +532,7 @@
    *
    * The TypeCode object is initialized with the given id, name, and members.
    * @param id the Id of this type.
-   * @param the name of this type.
+   * @param name the name of this type.
    * @param members the member list.
    *
    * @return the typecode.
@@ -548,7 +548,7 @@
    * and members.
    *
    * @param id the Id of this type.
-   * @param the name of this type.
+   * @param name the name of this type.
    * @param discriminator the union discriminator.
    * @param members the member list.
    *
@@ -741,7 +741,7 @@
    * @return the default context of this ORB.
    *
    * @throws NO_IMPLEMENT for the Singleton ORB, returned by
-   * the parameterless address@hidden init()}.
+   * the parameterless address@hidden #init()}.
    */
   public Context get_default_context()
   {
@@ -751,7 +751,7 @@
   /**
    * Return thg typecode, representing the given primitive object type.
    *
-   * @param the kind of the primitive typecode.
+   * @param tcKind the kind of the primitive typecode.
    *
    * @return the typecode of the primitve typecode.
    */
@@ -817,7 +817,7 @@
    * By default the built-in fully functional ORB is returned. The ORB class
    * is found as described in the header of this class.
    *
-   * @param the parameters, passed to the applications
+   * @param args the parameters, passed to the applications
    * <code>main(String[] args)</code> method, may be <code>null</code>.
    * The parameter -org.omg.CORBA.ORBClass <class name>
    * if present, defines the used ORB implementation class. If this
@@ -856,7 +856,7 @@
    *
    * @return a list of services.
    *
-   * @see resolve_initial_references(String)
+   * @see #resolve_initial_references(String)
    */
   public abstract String[] list_initial_services();
 
@@ -919,9 +919,9 @@
    * (key) inside the server, the communication protocol version,
    * supported charsets and so on.
    *
-   * @param the CORBA object
+   * @param forObject the CORBA object
    * @return the object IOR representation.
-   * @see string_to_object(String)
+   * @see #string_to_object(String)
    */
   public abstract String object_to_string(Object forObject);
 
@@ -1016,7 +1016,7 @@
    * @throws DATA_CONVERSION if the string being parsed contains unsupported
    * prefix or protocol.
    * 
-   * @see object_to_string(org.omg.CORBA.Object)
+   * @see #object_to_string(org.omg.CORBA.Object)
    */
   public abstract Object string_to_object(String IOR);
 
@@ -1056,7 +1056,7 @@
    * application.
    *
    * @param props application specific properties that were passed
-   * as a second parameter in address@hidden init(String[], Properties)}).
+   * as a second parameter in address@hidden #init(String[], Properties)}).
    * Can be <code>null</code>.
    */
   protected abstract void set_parameters(String[] para, Properties props);
Index: org/omg/CORBA/PERSIST_STORE.java
===================================================================
RCS file: /cvsroot/classpath/classpath/org/omg/CORBA/PERSIST_STORE.java,v
retrieving revision 1.4
diff -u -r1.4 PERSIST_STORE.java
--- org/omg/CORBA/PERSIST_STORE.java    2 Jul 2005 20:32:57 -0000       1.4
+++ org/omg/CORBA/PERSIST_STORE.java    14 Sep 2005 07:36:30 -0000
@@ -57,7 +57,7 @@
   /**
    * Creates a PERSIST_STORE with the default minor code of 0,
    * completion state COMPLETED_NO and the given explaining message.
-   * @param reasom the explaining message.
+   * @param message the explaining message.
    */
   public PERSIST_STORE(String message)
   {
Index: org/omg/CORBA/PolicyError.java
===================================================================
RCS file: /cvsroot/classpath/classpath/org/omg/CORBA/PolicyError.java,v
retrieving revision 1.2
diff -u -r1.2 PolicyError.java
--- org/omg/CORBA/PolicyError.java      2 Jul 2005 20:32:57 -0000       1.2
+++ org/omg/CORBA/PolicyError.java      14 Sep 2005 07:36:30 -0000
@@ -75,7 +75,7 @@
 
   /**
    * Constructs the policy error with the given reason code.
-   * @param reason a reason code, one of
+   * @param a_reason a reason code, one of
    * address@hidden BAD_POLICY}, address@hidden BAD_POLICY_TYPE},
    * address@hidden BAD_POLICY_VALUE}, address@hidden UNSUPPORTED_POLICY},
    * address@hidden UNSUPPORTED_POLICY_VALUE}.
@@ -88,11 +88,11 @@
   /**
    * Constructs the policy error with the given reason code and the
    * detailed message.
-   * @param reason a reason code, one of
+   * @param a_details the detailed message.
+   * @param a_reason a reason code, one of
    * address@hidden BAD_POLICY}, address@hidden BAD_POLICY_TYPE},
    * address@hidden BAD_POLICY_VALUE}, address@hidden UNSUPPORTED_POLICY},
    * address@hidden UNSUPPORTED_POLICY_VALUE}.
-   * @param details the detailed message.
    */
   public PolicyError(String a_details, short a_reason)
   {
Index: org/omg/CORBA/ValueBaseHolder.java
===================================================================
RCS file: /cvsroot/classpath/classpath/org/omg/CORBA/ValueBaseHolder.java,v
retrieving revision 1.2
diff -u -r1.2 ValueBaseHolder.java
--- org/omg/CORBA/ValueBaseHolder.java  2 Jul 2005 20:32:58 -0000       1.2
+++ org/omg/CORBA/ValueBaseHolder.java  14 Sep 2005 07:36:31 -0000
@@ -79,7 +79,7 @@
 
   /**
    * Read fill in the value field by reading an instance from the
-   * given input stream. Uses address@hidden ValueBaseHelper.}
+   * given input stream. Uses address@hidden ValueBaseHelper}
    *
    * @param input a stream to read from.
    */
@@ -89,7 +89,7 @@
   }
 
   /**
-   * Get the typecode of the stored instance. Uses address@hidden 
ValueBaseHelper.}
+   * Get the typecode of the stored instance. Uses address@hidden 
ValueBaseHelper}
    */
   public TypeCode _type()
   {
@@ -97,10 +97,10 @@
   }
 
   /**
-   * Write the stored instance to the given input stream.
-   * Uses address@hidden ValueBaseHelper.}
+   * Write the stored instance to the given output stream.
+   * Uses address@hidden ValueBaseHelper}
    *
-   * @param input a stream to read from.
+   * @param output a stream to write to.
    */
   public void _write(OutputStream output)
   {
Index: org/omg/CORBA/VisibilityHelper.java
===================================================================
RCS file: /cvsroot/classpath/classpath/org/omg/CORBA/VisibilityHelper.java,v
retrieving revision 1.2
diff -u -r1.2 VisibilityHelper.java
--- org/omg/CORBA/VisibilityHelper.java 2 Jul 2005 20:32:58 -0000       1.2
+++ org/omg/CORBA/VisibilityHelper.java 14 Sep 2005 07:36:31 -0000
@@ -59,7 +59,7 @@
 
   /**
    * Insert the Visibility into the given Any.
-   * Uses address@hidden Any.insert_short}.
+   * Uses address@hidden Any#insert_short}.
    */
   public static void insert(Any any, short that)
   {
@@ -68,7 +68,7 @@
 
   /**
    * Extract the Visibility from the given Any.
-   * Uses address@hidden Any.extract_short}.
+   * Uses address@hidden Any#extract_short}.
    */
   public static short extract(Any any)
   {
@@ -103,7 +103,7 @@
   /**
    * Read the visibility value (as short) from the CDR intput stream.
    *
-   * Uses address@hidden InputStream.read_short()}.
+   * Uses address@hidden InputStream#read_short()}.
    *
    * @param istream a stream to read from.
    */
@@ -115,7 +115,7 @@
   /**
    * Write the visibility value (as short) to the CDR output stream.
    *
-   * USes address@hidden OutputStream.write_short(short)}.
+   * USes address@hidden OutputStream#write_short(short)}.
    *
    * @param ostream a stream to write into.
    * @param value a value to write.