jdk-sandbox: comparison jaxws/src/java.xml.bind/share/classes/javax/xml/bind/annotation/XmlType.java

equal deleted inserted replaced

-:f61a63b7d1e5
+:5a5710ee05a0
 /**
 * <p>
 * Maps a class or an enum type to a XML Schema type.
 *
 * <p><b>Usage</b></p>
-* <p> The <tt>@XmlType</tt> annnotation can be used with the following program
+* <p> The {@code @XmlType} annnotation can be used with the following program
 * elements:
 * <ul>
 *   <li> a top level class </li>
 *   <li> an enum type </li>
 * </ul>
 * values represented by properties and fields. A schema type is a
 * data container for values represented by schema components within a
 * schema type's content model (e.g. model groups, attributes etc).
 * <p> To be mapped, a class must either have a public no-arg
 * constructor or a static no-arg factory method. The static factory
-* method can be specified in <tt>factoryMethod()</tt> and
+* method can be specified in {@code factoryMethod()} and
-* <tt>factoryClass()</tt> annotation elements. The static factory
+* {@code factoryClass()} annotation elements. The static factory
 * method or the no-arg constructor is used during unmarshalling to
 * create an instance of this class. If both are present, the static
 * factory method overrides the no-arg constructor.
 * <p>
 * A class maps to either a XML Schema complex type or a XML Schema simple
 * type. The XML Schema type is derived based on the
 * mapping of JavaBean properties and fields contained within the
 * class. The schema type to which the class is mapped can either be
 * named or anonymous. A class can be mapped to an anonymous schema
-* type by annotating the class with <tt>&#64;XmlType(name="")</tt>.
+* type by annotating the class with {@code @XmlType(name="")}.
 * <p>
 * Either a global element, local element or a local attribute can be
 * associated with an anonymous type as follows:
 * <ul>
 *   <li><b>global element: </b> A global element of an anonymous
 *      a class annotated with @XmlType(name="") and is mapped to the
 *      attribute associated with the anonymous type. See Example 5 below. </li>
 * </ul>
 * <b> Mapping to XML Schema Complex Type </b>
 * <ul>
-*   <li>If class is annotated with <tt>@XmlType(name="") </tt>, it
+*   <li>If class is annotated with {@code @XmlType(name="") }, it
 *   is mapped to an anonymous type otherwise, the class name maps
-*   to a complex type name. The <tt>XmlName()</tt> annotation element
+*   to a complex type name. The {@code XmlName()} annotation element
 *   can be used to customize the name.</li>
 *
 *   <li> Properties and fields that are mapped to elements are mapped to a
 *   content model within a complex type. The annotation element
-*   <tt>propOrder()</tt> can be used to customize the content model to be
+*   {@code propOrder()} can be used to customize the content model to be
-*   <tt>xs:all</tt> or <tt>xs:sequence</tt>.  It is used for specifying
+*   {@code xs:all} or {@code xs:sequence}.  It is used for specifying
-*   the order of XML elements in <tt>xs:sequence</tt>. </li>
+*   the order of XML elements in {@code xs:sequence}. </li>
 *
 *   <li> Properties and fields can be mapped to attributes within the
 *        complex type.  </li>
 *
 *   <li> The targetnamespace of the XML Schema type can be customized
-*        using the annotation element <tt>namespace()</tt>. </li>
+*        using the annotation element {@code namespace()}. </li>
 * </ul>
 *
 * <p>
 * <b> Mapping class to XML Schema simple type </b>
 * <p>
 * A class can be mapped to a XML Schema simple type using the
-* <tt>@XmlValue</tt> annotation. For additional details and examples,
+* {@code @XmlValue} annotation. For additional details and examples,
 * see @{@link XmlValue} annotation type.
 * <p>
 * The following table shows the mapping of the class to a XML Schema
 * complex type or simple type. The notational symbols used in the table are:
 * <ul>
 *   <li> {@literal ->}    : represents a mapping </li>
 *   <li> [x]+  : one or more occurances of x </li>
-*   <li> [ <tt>@XmlValue</tt> property ]: JavaBean property annotated with
+*   <li> [ {@code @XmlValue} property ]: JavaBean property annotated with
-*         <tt>@XmlValue</tt></li>
+*         {@code @XmlValue}</li>
 *   <li> X     : don't care
 * </ul>
 * <blockquote>
 *   <table summary="" border="1" cellpadding="4" cellspacing="3">
 *     <tbody>
 *       </tr>
 *
 *       <tr valign="top">
 *         <td>Class</td>
 *         <td>X</td>
-*         <td>1 [<tt>@XmlValue</tt> property] {@literal &&} <br> [property]+ {@literal ->} attributes</td>
+*         <td>1 [{@code @XmlValue} property] {@literal &&} <br> [property]+ {@literal ->} attributes</td>
 *         <td>simplecontent</td>
 *         <td> </td>
 *       </tr>
 *
 *       <tr valign="top">
 *         <td>Class</td>
 *         <td>X</td>
-*         <td>1 [<tt>@XmlValue</tt> property] {@literal &&} <br> no properties {@literal ->} attribute</td>
+*         <td>1 [{@code @XmlValue} property] {@literal &&} <br> no properties {@literal ->} attribute</td>
 *         <td> </td>
 *         <td>simpletype</td>
 *       </tr>
 *     </tbody>
 *   </table>
 *
 * <h3> Mapping an enum type </h3>
 *
 * An enum type maps to a XML schema simple type with enumeration
 * facets. The following annotation elements are ignored since they
-* are not meaningful: <tt>propOrder()</tt> , <tt>factoryMethod()</tt> ,
+* are not meaningful: {@code propOrder()} , {@code factoryMethod()} ,
-* <tt>factoryClass()</tt> .
+* {@code factoryClass()} .
 *
 *  <h3> Usage with other annotations </h3>
 * <p> This annotation can be used with the following annotations:
 * {@link XmlRootElement}, {@link XmlAccessorOrder}, {@link XmlAccessorType},
 * {@link XmlEnum}. However, {@link
 *     JavaBean properties are listed is the order of XML Schema
 *     elements to which the JavaBean properties are mapped. </p>
 * <p> All of the JavaBean properties being mapped to XML Schema elements
 *     must be listed.
 * <p> A JavaBean property or field listed in propOrder must not
-*     be transient or annotated with <tt>@XmlTransient</tt>.
+*     be transient or annotated with {@code @XmlTransient}.
 * <p> The default ordering of JavaBean properties is determined
 *     by @{@link XmlAccessorOrder}.
 */
 String[] propOrder() default {""};
 /**
 * Class containing a no-arg factory method for creating an
 * instance of this class. The default is this class.
 *
-* <p>If <tt>factoryClass</tt> is DEFAULT.class and
+* <p>If {@code factoryClass} is DEFAULT.class and
-* <tt>factoryMethod</tt> is "", then there is no static factory
+* {@code factoryMethod} is "", then there is no static factory
 * method.
 *
-* <p>If <tt>factoryClass</tt> is DEFAULT.class and
+* <p>If {@code factoryClass} is DEFAULT.class and
-* <tt>factoryMethod</tt> is not "", then
+* {@code factoryMethod} is not "", then
-* <tt>factoryMethod</tt> is the name of a static factory method
+* {@code factoryMethod} is the name of a static factory method
 * in this class.
 *
-* <p>If <tt>factoryClass</tt> is not DEFAULT.class, then
+* <p>If {@code factoryClass} is not DEFAULT.class, then
-* <tt>factoryMethod</tt> must not be "" and must be the name of
+* {@code factoryMethod} must not be "" and must be the name of
-* a static factory method specified in <tt>factoryClass</tt>.
+* a static factory method specified in {@code factoryClass}.
 */
 Class factoryClass() default DEFAULT.class;
 /**
 * Used in {@link XmlType#factoryClass()} to
 */
 static final class DEFAULT {}
 /**
 * Name of a no-arg factory method in the class specified in
-* <tt>factoryClass</tt> factoryClass().
+* {@code factoryClass} factoryClass().
 *
 */
 String factoryMethod() default "";
 }

changeset 32795	5a5710ee05a0
parent 29839	6d5d546e953b
child 47210	1edad689f56c