view patches/openjdk/6917485-docs-corba.patch @ 1738:3ac8e6470d4f

Backport upstream patches to fix warnings in documentation generation. 2010-07-21 Andrew John Hughes <ahughes@redhat.com> Backport documentation patches to avoid documentation errors. * .hgignore: Remove broken openjdk regexp matching. * Makefile.am: Add new patches. * patches/openjdk/4891262-docs-accessibility.patch, * patches/openjdk/6737212-docs-sql.patch, * patches/openjdk/6875861-docs-properties.patch, * patches/openjdk/6909563-docs-rmi.patch, * patches/openjdk/6917485-docs-corba.patch, * patches/openjdk/6921068-docs-specdefault.patch: Fix warnings in producing documentation.
author Andrew John Hughes <ahughes@redhat.com>
date Wed, 21 Jul 2010 17:39:05 +0100
parents
children
line wrap: on
line source

# HG changeset patch
# User andrew
# Date 1263603844 0
# Node ID 05436b84e93a16d660aca42b9b5cd0d724ab9121
# Parent  aa446c0200fdf2c2167dc0476f5ad02570f5257e
6917485: Corba doc warnings
Summary: Fix warnings generated by javadoc
Reviewed-by: darcy

diff -r aa446c0200fd -r 05436b84e93a src/share/classes/com/sun/tools/corba/se/idl/constExpr/Expression.java
--- openjdk.orig/corba/src/share/classes/com/sun/tools/corba/se/idl/constExpr/Expression.java	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/com/sun/tools/corba/se/idl/constExpr/Expression.java	Sat Jan 16 01:04:04 2010 +0000
@@ -123,7 +123,7 @@
 
   /**
    * Coerces a number to the target type of this expression.
-   * @parm  number  The number to coerce.
+   * @param  obj  The number to coerce.
    * @return  the value of number coerced to the (target) type of
    *  this expression.
    **/
@@ -142,7 +142,7 @@
   /**
    * Coerces an integral value (BigInteger) to its corresponding unsigned
    * representation, if the target type of this expression is unsigned.
-   * @parm b The BigInteger to be coerced.
+   * @param b The BigInteger to be coerced.
    * @return the value of an integral type coerced to its corresponding
    *  unsigned integral type, if the target type of this expression is
    *  unsigned.
@@ -170,7 +170,7 @@
   /**
    * Coerces an integral value (BigInteger) to its corresponding signed
    * representation, if the target type of this expression is signed.
-   * @parm  b  The BigInteger to be coerced.
+   * @param  b  The BigInteger to be coerced.
    * @return  the value of an integral type coerced to its corresponding
    *  signed integral type, if the target type of this expression is
    *  signed.
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/javax/rmi/PortableRemoteObject.java
--- openjdk.orig/corba/src/share/classes/javax/rmi/PortableRemoteObject.java	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/javax/rmi/PortableRemoteObject.java	Sat Jan 16 01:04:04 2010 +0000
@@ -161,7 +161,7 @@
      * happens implicitly when the object is sent or received as an argument
      * on a remote method call, but in some circumstances it is useful to
      * perform this action by making an explicit call.  See the
-     * {@link Stub#connect} method for more information.
+     * {@link javax.rmi.CORBA.Stub#connect} method for more information.
      * @param target the object to connect.
      * @param source a previously connected object.
      * @throws RemoteException if <code>source</code> is not connected
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/org/omg/CORBA/SetOverrideType.java
--- openjdk.orig/corba/src/share/classes/org/omg/CORBA/SetOverrideType.java	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/org/omg/CORBA/SetOverrideType.java	Sat Jan 16 01:04:04 2010 +0000
@@ -31,7 +31,7 @@
  * indicate whether policies should replace the
  * existing policies of an <code>Object</code> or be added to them.
  * <P>
- * The method {@link omg.org.CORBA.Object._set_policy_override} takes
+ * The method {@link org.omg.CORBA.Object#_set_policy_override} takes
  * either <code>SetOverrideType.SET_OVERRIDE</code> or
  * <code>SetOverrideType.ADD_OVERRIDE</code> as its second argument.
  * The method <code>_set_policy_override</code>
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/org/omg/CORBA/TCKind.java
--- openjdk.orig/corba/src/share/classes/org/omg/CORBA/TCKind.java	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/org/omg/CORBA/TCKind.java	Sat Jan 16 01:04:04 2010 +0000
@@ -545,8 +545,6 @@
     * @param  _value the <code>int</code> to convert.  It must be one of
     *         the <code>int</code> constants in the class
     *         <code>TCKind</code>.
-    * @return  a new <code>TCKind</code> instance whose <code>value</code>
-    * field matches the given <code>int</code>
     */
     @Deprecated
     protected TCKind(int _value){
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/org/omg/CORBA/UnknownUserException.java
--- openjdk.orig/corba/src/share/classes/org/omg/CORBA/UnknownUserException.java	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/org/omg/CORBA/UnknownUserException.java	Sat Jan 16 01:04:04 2010 +0000
@@ -56,7 +56,7 @@
      * Constructs an <code>UnknownUserException</code> object that contains the given
      * <code>Any</code> object.
      *
-     * @ param a an <code>Any</code> object that contains a user exception returned
+     * @param a an <code>Any</code> object that contains a user exception returned
      *         by the server
      */
     public UnknownUserException(Any a) {
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/org/omg/CORBA/portable/ServantObject.java
--- openjdk.orig/corba/src/share/classes/org/omg/CORBA/portable/ServantObject.java	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/org/omg/CORBA/portable/ServantObject.java	Sat Jan 16 01:04:04 2010 +0000
@@ -43,7 +43,6 @@
     /** The real servant. The local stub may cast this field to the expected type, and then
      * invoke the operation directly. Note, the object may or may not be the actual servant
      * instance.
-     * @return The real servant
      */
     public java.lang.Object servant;
 }
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/org/omg/CosNaming/nameservice.idl
--- openjdk.orig/corba/src/share/classes/org/omg/CosNaming/nameservice.idl	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/org/omg/CosNaming/nameservice.idl	Sat Jan 16 01:04:04 2010 +0000
@@ -256,7 +256,7 @@
  * 
  * @param  n Name of the object <p>
  * 
- * @parm obj The Object to rebind with the given name <p>
+ * @param obj The Object to rebind with the given name <p>
  * 
  * @exception org.omg.CosNaming.NamingContextPackage.NotFound Indicates the name does not identify a binding.<p>
  * 
diff -r aa446c0200fd -r 05436b84e93a src/share/classes/org/omg/PortableInterceptor/Interceptors.idl
--- openjdk.orig/corba/src/share/classes/org/omg/PortableInterceptor/Interceptors.idl	Sun Oct 11 11:59:07 2009 +0200
+++ openjdk/corba/src/share/classes/org/omg/PortableInterceptor/Interceptors.idl	Sat Jan 16 01:04:04 2010 +0000
@@ -1730,7 +1730,7 @@
      * <p>
      * Any number of components may exist with the same component ID. 
      * 
-     * @param a_component The IOP.TaggedComponent to add.
+     * @param tagged_component The IOP.TaggedComponent to add.
      */
     void add_ior_component 
       (in IOP::TaggedComponent tagged_component);
@@ -1744,7 +1744,7 @@
      * <p>
      * Any number of components may exist with the same component ID. 
      * 
-     * @param a_component The <code>IOP.TaggedComponent</code> to add. 
+     * @param tagged_component The <code>IOP.TaggedComponent</code> to add. 
      * @param profile_id The profile id of the profile to 
      *     which this component will be added.
      * @exception BAD_PARAM thrown, with a standard minor code of 29, if the