changeset 606:1c5112a19a06

8130247: fix some new tidy warnings from jaxws and CORBA Summary: minor docs cleanup Reviewed-by: darcy
author avstepan
date Thu, 02 Jul 2015 18:04:32 +0400
parents 61caeb7061bb
children 1d87054e2d2f
files src/java.activation/share/classes/com/sun/activation/registries/MailcapTokenizer.java src/java.xml.bind/share/classes/javax/xml/bind/JAXBContext.java src/java.xml.bind/share/classes/javax/xml/bind/annotation/package.html
diffstat 3 files changed, 82 insertions(+), 91 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.activation/share/classes/com/sun/activation/registries/MailcapTokenizer.java	Sun Jun 28 16:38:48 2015 -0700
+++ b/src/java.activation/share/classes/com/sun/activation/registries/MailcapTokenizer.java	Thu Jul 02 18:04:32 2015 +0400
@@ -42,7 +42,7 @@
     /**
      *  Constructor
      *
-     *  @parameter  inputString the string to tokenize
+     *  @param  inputString the string to tokenize
      */
     public MailcapTokenizer(String inputString) {
         data = inputString;
@@ -73,7 +73,7 @@
     /**
      *  Retrieve current token.
      *
-     *  @returns    The current token value
+     *  @return    The current token value
      */
     public int getCurrentToken() {
         return currentToken;
@@ -115,7 +115,7 @@
     /*
      *  Retrieve current token value.
      *
-     *  @returns    A String containing the current token value
+     *  @return    A String containing the current token value
      */
     public String getCurrentTokenValue() {
         return currentTokenValue;
@@ -123,7 +123,7 @@
     /*
      *  Process the next token.
      *
-     *  @returns    the next token
+     *  @return    the next token
      */
     public int nextToken() {
         if (dataIndex < dataLength) {
--- a/src/java.xml.bind/share/classes/javax/xml/bind/JAXBContext.java	Sun Jun 28 16:38:48 2015 -0700
+++ b/src/java.xml.bind/share/classes/javax/xml/bind/JAXBContext.java	Thu Jul 02 18:04:32 2015 +0400
@@ -34,8 +34,7 @@
 import java.io.InputStream;
 
 /**
- * <p>
- * The <tt>JAXBContext</tt> class provides the client's entry point to the
+ * The {@code JAXBContext} class provides the client's entry point to the
  * JAXB API. It provides an abstraction for managing the XML/Java binding
  * information necessary to implement the JAXB binding framework operations:
  * unmarshal, marshal and validate.
@@ -62,16 +61,16 @@
  * <p><i>
  * The following JAXB 1.0 requirement is only required for schema to
  * java interface/implementation binding. It does not apply to JAXB annotated
- * classes. JAXB Providers must generate a <tt>jaxb.properties</tt> file in
+ * classes. JAXB Providers must generate a {@code jaxb.properties} file in
  * each package containing schema derived classes.  The property file must
- * contain a property named <tt>javax.xml.bind.context.factory</tt> whose
- * value is the name of the class that implements the <tt>createContext</tt>
+ * contain a property named {@code javax.xml.bind.context.factory} whose
+ * value is the name of the class that implements the {@code createContext}
  * APIs.</i>
  *
  * <p><i>
  * The class supplied by the provider does not have to be assignable to
- * <tt>javax.xml.bind.JAXBContext</tt>, it simply has to provide a class that
- * implements the <tt>createContext</tt> APIs.</i>
+ * {@code javax.xml.bind.JAXBContext}, it simply has to provide a class that
+ * implements the {@code createContext} APIs.</i>
  *
  * <p><i>
  * In addition, the provider must call the
@@ -91,13 +90,13 @@
  * Additionally, the unmarshal method allows for an unrecognized root element that
  * has  an xsi:type attribute's value that references a type definition declared in
  * the schema  to be unmarshalled as the root of an instance document.
- * The <tt>JAXBContext</tt> object
+ * The {@code JAXBContext} object
  * allows the merging of global elements and type definitions across a set of schemas (listed
- * in the <tt>contextPath</tt>). Since each schema in the schema set can belong
+ * in the {@code contextPath}). Since each schema in the schema set can belong
  * to distinct namespaces, the unification of schemas to an unmarshalling
  * context should be namespace independent.  This means that a client
  * application is able to unmarshal XML documents that are instances of
- * any of the schemas listed in the <tt>contextPath</tt>.  For example:
+ * any of the schemas listed in the {@code contextPath}.  For example:
  *
  * <pre>
  *      JAXBContext jc = JAXBContext.newInstance( "com.acme.foo:com.acme.bar" );
@@ -114,12 +113,12 @@
  * For schema-derived interface/implementation classes and for the
  * creation of elements that are not bound to a JAXB-annotated
  * class, an application needs to have access and knowledge about each of
- * the schema derived <tt> ObjectFactory</tt> classes that exist in each of
- * java packages contained in the <tt>contextPath</tt>.  For each schema
+ * the schema derived {@code ObjectFactory} classes that exist in each of
+ * java packages contained in the {@code contextPath}.  For each schema
  * derived java class, there is a static factory method that produces objects
  * of that type.  For example,
- * assume that after compiling a schema, you have a package <tt>com.acme.foo</tt>
- * that contains a schema derived interface named <tt>PurchaseOrder</tt>.  In
+ * assume that after compiling a schema, you have a package {@code com.acme.foo}
+ * that contains a schema derived interface named {@code PurchaseOrder}.  In
  * order to create objects of that type, the client application would use the
  * factory method like this:
  *
@@ -133,25 +132,25 @@
  * it can use the mutator methods to set content on it.
  *
  * <p>
- * For more information on the generated <tt>ObjectFactory</tt> classes, see
+ * For more information on the generated {@code ObjectFactory} classes, see
  * Section 4.2 <i>Java Package</i> of the specification.
  *
  * <p>
  * <i>The provider must generate a class in each
  * package that contains all of the necessary object factory methods for that
  * package named ObjectFactory as well as the static
- * <tt>newInstance( javaContentInterface )</tt> method</i>
+ * {@code newInstance( javaContentInterface )} method</i>
  *
  * <h3>Marshalling</h3>
  * <p>
  * The {@link Marshaller} class provides the client application the ability
  * to convert a Java content tree back into XML data.  There is no difference
  * between marshalling a content tree that is created manually using the factory
- * methods and marshalling a content tree that is the result an <tt>unmarshal
- * </tt> operation.  Clients can marshal a java content tree back to XML data
- * to a <tt>java.io.OutputStream</tt> or a <tt>java.io.Writer</tt>.  The
+ * methods and marshalling a content tree that is the result an {@code unmarshal}
+ * operation.  Clients can marshal a java content tree back to XML data
+ * to a {@code java.io.OutputStream} or a {@code java.io.Writer}.  The
  * marshalling process can alternatively produce SAX2 event streams to a
- * registered <tt>ContentHandler</tt> or produce a DOM Node object.
+ * registered {@code ContentHandler} or produce a DOM Node object.
  * Client applications have control over the output encoding as well as
  * whether or not to marshal the XML data as a complete document or
  * as a fragment.
@@ -178,7 +177,7 @@
  * Validation has been changed significantly since JAXB 1.0.  The {@link Validator}
  * class has been deprecated and made optional.  This means that you are advised
  * not to use this class and, in fact, it may not even be available depending on
- * your JAXB provider.  JAXB 1.0 client applications that rely on <tt>Validator</tt>
+ * your JAXB provider.  JAXB 1.0 client applications that rely on {@code Validator}
  * will still work properly when deployed with the JAXB 1.0 runtime system.
  *
  * In JAXB 2.0, the {@link Unmarshaller} has included convenince methods that expose
@@ -192,8 +191,8 @@
  * The following JAXB 1.0 restriction only applies to binding schema to
  * interfaces/implementation classes.
  * Since this binding does not require a common runtime system, a JAXB
- * client application must not attempt to mix runtime objects (<tt>JAXBContext,
- * Marshaller</tt>, etc. ) from different providers.  This does not
+ * client application must not attempt to mix runtime objects ({@code JAXBContext,
+ * Marshaller}, etc. ) from different providers.  This does not
  * mean that the client application isn't portable, it simply means that a
  * client has to use a runtime system provided by the same provider that was
  * used to compile the schema.
@@ -201,14 +200,14 @@
  *
  * <h3>Discovery of JAXB implementation</h3>
  * <p>
- * When one of the <tt>newInstance</tt> methods is called, a JAXB implementation is discovered
+ * When one of the {@code newInstance} methods is called, a JAXB implementation is discovered
  * by the following steps.
  *
  * <ol>
  *
  * <li>
  * For each package/class explicitly passed in to the {@link #newInstance} method, in the order they are specified,
- * <tt>jaxb.properties</tt> file is looked up in its package, by using the associated classloader &mdash;
+ * {@code jaxb.properties} file is looked up in its package, by using the associated classloader &mdash;
  * this is {@link Class#getClassLoader() the owner class loader} for a {@link Class} argument, and for a package
  * the specified {@link ClassLoader}.
  *
@@ -269,8 +268,6 @@
  * {@link javax.xml.bind.JAXBContextFactory#createContext(Class[], java.util.Map)} is invoked
  * to create a {@link JAXBContext}.
  *
- * <p/>
- *
  * @apiNote
  * <p>Service discovery method using file /META-INF/services/javax.xml.bind.JAXBContext (described in step 4)
  * and leveraging provider's static methods is supported only to allow backwards compatibility, but it is strongly
@@ -294,7 +291,7 @@
 
     /**
      * The name of the property that contains the name of the class capable
-     * of creating new <tt>JAXBContext</tt> objects.
+     * of creating new {@code JAXBContext} objects.
      */
     public static final String JAXB_CONTEXT_FACTORY = "javax.xml.bind.JAXBContextFactory";
 
@@ -303,8 +300,7 @@
 
 
     /**
-     * <p>
-     * Create a new instance of a <tt>JAXBContext</tt> class.
+     * Create a new instance of a {@code JAXBContext} class.
      *
      * <p>
      * This is a convenience method to invoke the
@@ -312,7 +308,7 @@
      * the context class loader of the current thread.
      *
      * @throws JAXBException if an error was encountered while creating the
-     *                       <tt>JAXBContext</tt> such as
+     *                       {@code JAXBContext} such as
      * <ol>
      *   <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
      *   <li>an ambiguity among global elements contained in the contextPath</li>
@@ -328,8 +324,7 @@
     }
 
     /**
-     * <p>
-     * Create a new instance of a <tt>JAXBContext</tt> class.
+     * Create a new instance of a {@code JAXBContext} class.
      *
      * <p>
      * The client application must supply a context path which is a list of
@@ -340,7 +335,7 @@
      * ObjectFactory.class generated per package.
      * Alternatively than being listed in the context path, programmer
      * annotated JAXB mapped classes can be listed in a
-     * <tt>jaxb.index</tt> resource file, format described below.
+     * {@code jaxb.index} resource file, format described below.
      * Note that a java package can contain both schema-derived classes and
      * user annotated JAXB classes. Additionally, the java package may
      * contain JAXB package annotations  that must be processed. (see JLS,
@@ -349,7 +344,7 @@
      *
      * <p>
      * Every package listed on the contextPath must meet <b>one or both</b> of the
-     * following conditions otherwise a <tt>JAXBException</tt> will be thrown:
+     * following conditions otherwise a {@code JAXBException} will be thrown:
      * </p>
      * <ol>
      *   <li>it must contain ObjectFactory.class</li>
@@ -367,12 +362,12 @@
      * are reachable, as defined in {@link #newInstance(Class...)}, from the
      * listed classes are also registered with JAXBContext.
      * <p>
-     * Constraints on class name occuring in a <tt>jaxb.index</tt> file are:
+     * Constraints on class name occuring in a {@code jaxb.index} file are:
      * <ul>
      *   <li>Must not end with ".class".</li>
      *   <li>Class names are resolved relative to package containing
-     *       <tt>jaxb.index</tt> file. Only classes occuring directly in package
-     *       containing <tt>jaxb.index</tt> file are allowed.</li>
+     *       {@code jaxb.index} file. Only classes occuring directly in package
+     *       containing {@code jaxb.index} file are allowed.</li>
      *   <li>Fully qualified class names are not allowed.
      *       A qualified class name,relative to current package,
      *       is only allowed to specify a nested or inner class.</li>
@@ -381,21 +376,21 @@
      * <p>
      * To maintain compatibility with JAXB 1.0 schema to java
      * interface/implementation binding, enabled by schema customization
-     * <tt>{@literal <jaxb:globalBindings valueClass="false">}</tt>,
+     * {@code <jaxb:globalBindings valueClass="false">},
      * the JAXB provider will ensure that each package on the context path
-     * has a <tt>jaxb.properties</tt> file which contains a value for the
-     * <tt>javax.xml.bind.context.factory</tt> property and that all values
+     * has a {@code jaxb.properties} file which contains a value for the
+     * {@code javax.xml.bind.context.factory} property and that all values
      * resolve to the same provider.  This requirement does not apply to
      * JAXB annotated classes.
      *
      * <p>
      * If there are any global XML element name collisions across the various
-     * packages listed on the <tt>contextPath</tt>, a <tt>JAXBException</tt>
+     * packages listed on the {@code contextPath}, a {@code JAXBException}
      * will be thrown.
      *
      * <p>
      * Mixing generated interface/impl bindings from multiple JAXB Providers
-     * in the same context path may result in a <tt>JAXBException</tt>
+     * in the same context path may result in a {@code JAXBException}
      * being thrown.
      *
      * <p>
@@ -408,9 +403,9 @@
      *      This class loader will be used to locate the implementation
      *      classes.
      *
-     * @return a new instance of a <tt>JAXBContext</tt>
+     * @return a new instance of a {@code JAXBContext}
      * @throws JAXBException if an error was encountered while creating the
-     *                       <tt>JAXBContext</tt> such as
+     *                       {@code JAXBContext} such as
      * <ol>
      *   <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
      *   <li>an ambiguity among global elements contained in the contextPath</li>
@@ -424,8 +419,7 @@
     }
 
     /**
-     * <p>
-     * Create a new instance of a <tt>JAXBContext</tt> class.
+     * Create a new instance of a {@code JAXBContext} class.
      *
      * <p>
      * This is mostly the same as {@link JAXBContext#newInstance(String, ClassLoader)},
@@ -434,7 +428,7 @@
      *
      * <p>
      * The interpretation of properties is up to implementations. Implementations should
-     * throw <tt>JAXBException</tt> if it finds properties that it doesn't understand.
+     * throw {@code JAXBException} if it finds properties that it doesn't understand.
      *
      * @param contextPath list of java package names that contain schema derived classes
      * @param classLoader
@@ -443,9 +437,9 @@
      *      provider-specific properties. Can be null, which means the same thing as passing
      *      in an empty map.
      *
-     * @return a new instance of a <tt>JAXBContext</tt>
+     * @return a new instance of a {@code JAXBContext}
      * @throws JAXBException if an error was encountered while creating the
-     *                       <tt>JAXBContext</tt> such as
+     *                       {@code JAXBContext} such as
      * <ol>
      *   <li>failure to locate either ObjectFactory.class or jaxb.index in the packages</li>
      *   <li>an ambiguity among global elements contained in the contextPath</li>
@@ -472,8 +466,7 @@
 
 // TODO: resurrect this once we introduce external annotations
 //    /**
-//     * <p>
-//     * Create a new instance of a <tt>JAXBContext</tt> class.
+//     * Create a new instance of a {@code JAXBContext} class.
 //     *
 //     * <p>
 //     * The client application must supply a list of classes that the new
@@ -484,8 +477,8 @@
 //     * referenced statically from the specified classes.
 //     *
 //     * For example, in the following Java code, if you do
-//     * <tt>newInstance(Foo.class)</tt>, the newly created {@link JAXBContext}
-//     * will recognize both <tt>Foo</tt> and <tt>Bar</tt>, but not <tt>Zot</tt>:
+//     * {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
+//     * will recognize both {@code Foo} and {@code Bar}, but not {@code Zot}:
 //     * <pre>
 //     * class Foo {
 //     *      Bar b;
@@ -509,11 +502,11 @@
 //     *      spec-defined classes will be returned.
 //     *
 //     * @return
-//     *      A new instance of a <tt>JAXBContext</tt>.
+//     *      A new instance of a {@code JAXBContext}.
 //     *
 //     * @throws JAXBException
 //     *      if an error was encountered while creating the
-//     *      <tt>JAXBContext</tt>, such as (but not limited to):
+//     *      {@code JAXBContext}, such as (but not limited to):
 //     * <ol>
 //     *  <li>No JAXB implementation was discovered
 //     *  <li>Classes use JAXB annotations incorrectly
@@ -546,8 +539,7 @@
 //    }
 
     /**
-     * <p>
-     * Create a new instance of a <tt>JAXBContext</tt> class.
+     * Create a new instance of a {@code JAXBContext} class.
      *
      * <p>
      * The client application must supply a list of classes that the new
@@ -556,12 +548,12 @@
      * Not only the new context will recognize all the classes specified,
      * but it will also recognize any classes that are directly/indirectly
      * referenced statically from the specified classes. Subclasses of
-     * referenced classes nor <tt>@XmlTransient</tt> referenced classes
+     * referenced classes nor {@code @XmlTransient} referenced classes
      * are not registered with JAXBContext.
      *
      * For example, in the following Java code, if you do
-     * <tt>newInstance(Foo.class)</tt>, the newly created {@link JAXBContext}
-     * will recognize both <tt>Foo</tt> and <tt>Bar</tt>, but not <tt>Zot</tt> or <tt>FooBar</tt>:
+     * {@code newInstance(Foo.class)}, the newly created {@link JAXBContext}
+     * will recognize both {@code Foo} and {@code Bar}, but not {@code Zot} or {@code FooBar}:
      * <pre>
      * class Foo {
      *      &#64;XmlTransient FooBar c;
@@ -589,11 +581,11 @@
      *      spec-defined classes will be returned.
      *
      * @return
-     *      A new instance of a <tt>JAXBContext</tt>.
+     *      A new instance of a {@code JAXBContext}.
      *
      * @throws JAXBException
      *      if an error was encountered while creating the
-     *      <tt>JAXBContext</tt>, such as (but not limited to):
+     *      {@code JAXBContext}, such as (but not limited to):
      * <ol>
      *  <li>No JAXB implementation was discovered
      *  <li>Classes use JAXB annotations incorrectly
@@ -615,8 +607,7 @@
     }
 
     /**
-     * <p>
-     * Create a new instance of a <tt>JAXBContext</tt> class.
+     * Create a new instance of a {@code JAXBContext} class.
      *
      * <p>
      * An overloading of {@link JAXBContext#newInstance(Class...)}
@@ -624,7 +615,7 @@
      *
      * <p>
      * The interpretation of properties is up to implementations. Implementations should
-     * throw <tt>JAXBException</tt> if it finds properties that it doesn't understand.
+     * throw {@code JAXBException} if it finds properties that it doesn't understand.
      *
      * @param classesToBeBound
      *      list of java classes to be recognized by the new {@link JAXBContext}.
@@ -635,11 +626,11 @@
      *      in an empty map.
      *
      * @return
-     *      A new instance of a <tt>JAXBContext</tt>.
+     *      A new instance of a {@code JAXBContext}.
      *
      * @throws JAXBException
      *      if an error was encountered while creating the
-     *      <tt>JAXBContext</tt>, such as (but not limited to):
+     *      {@code JAXBContext}, such as (but not limited to):
      * <ol>
      *  <li>No JAXB implementation was discovered
      *  <li>Classes use JAXB annotations incorrectly
@@ -672,25 +663,25 @@
     }
 
     /**
-     * Create an <tt>Unmarshaller</tt> object that can be used to convert XML
+     * Create an {@code Unmarshaller} object that can be used to convert XML
      * data into a java content tree.
      *
-     * @return an <tt>Unmarshaller</tt> object
+     * @return an {@code Unmarshaller} object
      *
      * @throws JAXBException if an error was encountered while creating the
-     *                       <tt>Unmarshaller</tt> object
+     *                       {@code Unmarshaller} object
      */
     public abstract Unmarshaller createUnmarshaller() throws JAXBException;
 
 
     /**
-     * Create a <tt>Marshaller</tt> object that can be used to convert a
+     * Create a {@code Marshaller} object that can be used to convert a
      * java content tree into XML data.
      *
-     * @return a <tt>Marshaller</tt> object
+     * @return a {@code Marshaller} object
      *
      * @throws JAXBException if an error was encountered while creating the
-     *                       <tt>Marshaller</tt> object
+     *                       {@code Marshaller} object
      */
     public abstract Marshaller createMarshaller() throws JAXBException;
 
@@ -699,27 +690,27 @@
      * {@link Validator} has been made optional and deprecated in JAXB 2.0.  Please
      * refer to the javadoc for {@link Validator} for more detail.
      * <p>
-     * Create a <tt>Validator</tt> object that can be used to validate a
+     * Create a {@code Validator} object that can be used to validate a
      * java content tree against its source schema.
      *
-     * @return a <tt>Validator</tt> object
+     * @return a {@code Validator} object
      *
      * @throws JAXBException if an error was encountered while creating the
-     *                       <tt>Validator</tt> object
+     *                       {@code Validator} object
      * @deprecated since JAXB2.0
      */
     public abstract Validator createValidator() throws JAXBException;
 
     /**
-     * Creates a <tt>Binder</tt> object that can be used for
+     * Creates a {@code Binder} object that can be used for
      * associative/in-place unmarshalling/marshalling.
      *
      * @param domType select the DOM API to use by passing in its DOM Node class.
      *
-     * @return always a new valid <tt>Binder</tt> object.
+     * @return always a new valid {@code Binder} object.
      *
      * @throws UnsupportedOperationException
-     *      if DOM API corresponding to <tt>domType</tt> is not supported by
+     *      if DOM API corresponding to {@code domType} is not supported by
      *      the implementation.
      *
      * @since 1.6, JAXB 2.0
@@ -731,9 +722,9 @@
     }
 
     /**
-     * Creates a <tt>Binder</tt> for W3C DOM.
+     * Creates a {@code Binder} for W3C DOM.
      *
-     * @return always a new valid <tt>Binder</tt> object.
+     * @return always a new valid {@code Binder} object.
      *
      * @since 1.6, JAXB 2.0
      */
@@ -742,11 +733,11 @@
     }
 
     /**
-     * Creates a <tt>JAXBIntrospector</tt> object that can be used to
+     * Creates a {@code JAXBIntrospector} object that can be used to
      * introspect JAXB objects.
      *
      * @return
-     *      always return a non-null valid <tt>JAXBIntrospector</tt> object.
+     *      always return a non-null valid {@code JAXBIntrospector} object.
      *
      * @throws UnsupportedOperationException
      *      Calling this method on JAXB 1.0 implementations will throw
--- a/src/java.xml.bind/share/classes/javax/xml/bind/annotation/package.html	Sun Jun 28 16:38:48 2015 -0700
+++ b/src/java.xml.bind/share/classes/javax/xml/bind/annotation/package.html	Thu Jul 02 18:04:32 2015 +0400
@@ -239,7 +239,7 @@
           <ul>
             <li> For a property, a given annotation can be applied to
                  either read or write property but not both. </li>
-    
+
             <li> A property name must be different from any other
                  property name in any of the super classes of the
                  class being mapped. </li>
@@ -250,8 +250,8 @@
          <h3>Notations</h3>
          <b>Namespace prefixes</b> 
          <p>The following namespace prefixes are used in the XML Schema
-           fragments in this package.<p>
-    
+           fragments in this package.
+
         <table border="1" cellpadding="4" cellspacing="3">
           <tbody>
             <tr>