changeset 8553:e7d1bd32e491

8026021: more fix of javadoc errors and warnings reported by doclint, see the description Reviewed-by: anthony, serb
author cl
date Mon, 23 Jan 2017 21:08:33 +0000
parents 199373242e22
children e221fcbb190a
files src/share/classes/java/awt/GraphicsDevice.java src/share/classes/java/awt/GridBagLayout.java src/share/classes/java/awt/LinearGradientPaint.java src/share/classes/java/awt/RadialGradientPaint.java src/share/classes/java/awt/font/LineBreakMeasurer.java src/share/classes/java/awt/font/MultipleMaster.java src/share/classes/java/awt/font/NumericShaper.java src/share/classes/java/awt/font/OpenType.java src/share/classes/java/awt/geom/AffineTransform.java src/share/classes/java/awt/im/InputContext.java src/share/classes/javax/swing/Action.java src/share/classes/javax/swing/GroupLayout.java src/share/classes/javax/swing/text/JTextComponent.java src/share/classes/javax/swing/text/StyleConstants.java src/share/classes/javax/swing/text/html/HTMLDocument.java src/share/classes/javax/swing/tree/DefaultTreeCellRenderer.java
diffstat 16 files changed, 54 insertions(+), 50 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/java/awt/GraphicsDevice.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/GraphicsDevice.java	Mon Jan 23 21:08:33 2017 +0000
@@ -162,7 +162,7 @@
      * <code>GraphicsEnvironment</code>.  Although there is
      * no public method to set this <code>String</code>, a programmer can
      * use the <code>String</code> for debugging purposes.  Vendors of
-     * the Java<sup><font size=-2>TM</font></sup> Runtime Environment can
+     * the Java&trade; Runtime Environment can
      * format the return value of the <code>String</code>.  To determine
      * how to interpret the value of the <code>String</code>, contact the
      * vendor of your Java Runtime.  To find out who the vendor is, from
--- a/src/share/classes/java/awt/GridBagLayout.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/GridBagLayout.java	Mon Jan 23 21:08:33 2017 +0000
@@ -125,9 +125,9 @@
  * <center><table BORDER=0 WIDTH=800
  *        SUMMARY="absolute, relative and baseline values as described above">
  * <tr>
- * <th><P STYLE="TEXT-ALIGN:LEFT">Absolute Values</th>
- * <th><P STYLE="TEXT-ALIGN:LEFT">Orientation Relative Values</th>
- * <th><P STYLE="TEXT-ALIGN:LEFT">Baseline Relative Values</th>
+ * <th><P style="text-align:left">Absolute Values</th>
+ * <th><P style="text-align:left">Orientation Relative Values</th>
+ * <th><P style="text-align:left">Baseline Relative Values</th>
  * </tr>
  * <tr>
  * <td>
--- a/src/share/classes/java/awt/LinearGradientPaint.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/LinearGradientPaint.java	Mon Jan 23 21:08:33 2017 +0000
@@ -94,7 +94,8 @@
  * of the three cycle methods:
  * <p>
  * <center>
- * <img src = "doc-files/LinearGradientPaint.png" alt="LinearGradientPaint">
+ * <img src = "doc-files/LinearGradientPaint.png"
+ * alt="image showing the output of the example code">
  * </center>
  *
  * @see java.awt.Paint
--- a/src/share/classes/java/awt/RadialGradientPaint.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/RadialGradientPaint.java	Mon Jan 23 21:08:33 2017 +0000
@@ -80,14 +80,16 @@
  * from the focus point. The following figure shows that the distance AB
  * is equal to the distance BC, and the distance AD is equal to the distance DE.
  * <center>
- * <img src = "doc-files/RadialGradientPaint-3.png" alt="RadialGradientPaint-3">
+ * <img src = "doc-files/RadialGradientPaint-3.png" alt="image showing the
+ * distance AB=BC, and AD=DE">
  * </center>
  * If the gradient and graphics rendering transforms are uniformly scaled and
  * the user sets the focus so that it coincides with the center of the circle,
  * the gradient color proportions are equal for any line drawn from the center.
  * The following figure shows the distances AB, BC, AD, and DE. They are all equal.
  * <center>
- * <img src = "doc-files/RadialGradientPaint-4.png" alt="RadialGradientPaint-4">
+ * <img src = "doc-files/RadialGradientPaint-4.png" alt="image showing the
+ * distance of AB, BC, AD, and DE are all equal">
  * </center>
  * Note that some minor variations in distances may occur due to sampling at
  * the granularity of a pixel.
@@ -117,7 +119,8 @@
  * (centered) focus for each of the three cycle methods:
  * <p>
  * <center>
- * <img src = "doc-files/RadialGradientPaint-1.png" alt="RadialGradientPaint-1">
+ * <img src = "doc-files/RadialGradientPaint-1.png" alt="image showing the
+ * output of the sameple code">
  * </center>
  *
  * <p>
@@ -141,7 +144,8 @@
  * focus for each of the three cycle methods:
  * <p>
  * <center>
- * <img src = "doc-files/RadialGradientPaint-2.png" alt="RadialGradientPaint-2">
+ * <img src = "doc-files/RadialGradientPaint-2.png" alt="image showing the
+ * output of the sample code">
  * </center>
  *
  * @see java.awt.Paint
--- a/src/share/classes/java/awt/font/LineBreakMeasurer.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/font/LineBreakMeasurer.java	Mon Jan 23 21:08:33 2017 +0000
@@ -112,7 +112,7 @@
  * <strong>Examples</strong>:<p>
  * Rendering a paragraph in a component
  * <blockquote>
- * <pre>
+ * <pre>{@code
  * public void paint(Graphics graphics) {
  *
  *     Point2D pen = new Point2D(10, 20);
@@ -137,13 +137,13 @@
  *         pen.y += layout.getDescent() + layout.getLeading();
  *     }
  * }
- * </pre>
+ * }</pre>
  * </blockquote>
  * <p>
  * Rendering text with tabs.  For simplicity, the overall text
  * direction is assumed to be left-to-right
  * <blockquote>
- * <pre>
+ * <pre>{@code
  * public void paint(Graphics graphics) {
  *
  *     float leftMargin = 10, rightMargin = 310;
@@ -240,7 +240,7 @@
  *         verticalPos += maxDescent;
  *     }
  * }
- * </pre>
+ * }</pre>
  * </blockquote>
  * @see TextLayout
  */
--- a/src/share/classes/java/awt/font/MultipleMaster.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/font/MultipleMaster.java	Mon Jan 23 21:08:33 2017 +0000
@@ -41,7 +41,7 @@
   public  int getNumDesignAxes();
 
   /**
-   * Returns an array of design limits interleaved in the form [from->to]
+   * Returns an array of design limits interleaved in the form [from&rarr;to]
    * for each axis.  For example,
    * design limits for weight could be from 0.1 to 1.0. The values are
    * returned in the same order returned by
--- a/src/share/classes/java/awt/font/NumericShaper.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/font/NumericShaper.java	Mon Jan 23 21:08:33 2017 +0000
@@ -1194,7 +1194,7 @@
      * For example, to check if a shaper shapes to Arabic, you would use the
      * following:
      * <blockquote>
-     *   <code>if ((shaper.getRanges() & shaper.ARABIC) != 0) { ... </code>
+     *   <code>if ((shaper.getRanges() &amp; shaper.ARABIC) != 0) { ... </code>
      * </blockquote>
      *
      * <p>Note that this method supports only the bit mask-based
--- a/src/share/classes/java/awt/font/OpenType.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/font/OpenType.java	Mon Jan 23 21:08:33 2017 +0000
@@ -33,7 +33,7 @@
  * <p>
  * For more information on TrueType and OpenType fonts, see the
  * OpenType specification.
- * ( <a href=http://www.microsoft.com/typography/otspec/">http://www.microsoft.com/typography/otspec/l</a> ).
+ * ( <a href="http://www.microsoft.com/typography/otspec/">http://www.microsoft.com/typography/otspec/</a> ).
  */
 public interface OpenType {
 
--- a/src/share/classes/java/awt/geom/AffineTransform.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/geom/AffineTransform.java	Mon Jan 23 21:08:33 2017 +0000
@@ -47,7 +47,7 @@
  *      [ 1 ]   [   0    0    1   ] [ 1 ]   [         1         ]
  * </pre>
  * <p>
- * <a name="quadrantapproximation"></a><h4>Handling 90-Degree Rotations</h4>
+ * <h4><a name="quadrantapproximation">Handling 90-Degree Rotations</a></h4>
  * <p>
  * In some variations of the <code>rotate</code> methods in the
  * <code>AffineTransform</code> class, a double-precision argument
--- a/src/share/classes/java/awt/im/InputContext.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/java/awt/im/InputContext.java	Mon Jan 23 21:08:33 2017 +0000
@@ -98,7 +98,6 @@
      * an input method or keyboard layout has been successfully selected. The
      * following steps are taken until an input method has been selected:
      *
-     * <p>
      * <ul>
      * <li>
      * If the currently selected input method or keyboard layout supports the
--- a/src/share/classes/javax/swing/Action.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/javax/swing/Action.java	Mon Jan 23 21:08:33 2017 +0000
@@ -98,10 +98,10 @@
  *         summary="Supported Action properties"
  *         valign="top" >
  *  <tr valign="top"  align="left">
- *    <th bgcolor="#CCCCFF" align="left">Component Property
- *    <th bgcolor="#CCCCFF" align="left">Components
- *    <th bgcolor="#CCCCFF" align="left">Action Key
- *    <th bgcolor="#CCCCFF" align="left">Notes
+ *    <th style="background-color:#CCCCFF" align="left">Component Property
+ *    <th style="background-color:#CCCCFF" align="left">Components
+ *    <th style="background-color:#CCCCFF" align="left">Action Key
+ *    <th style="background-color:#CCCCFF" align="left">Notes
  *  <tr valign="top"  align="left">
  *      <td><b><code>enabled</code></b>
  *      <td>All
--- a/src/share/classes/javax/swing/GroupLayout.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/javax/swing/GroupLayout.java	Mon Jan 23 21:08:33 2017 +0000
@@ -79,7 +79,7 @@
  * The following diagram shows a sequential group along the horizontal
  * axis. The sequential group contains three components. A parallel group
  * was used along the vertical axis.
- * <p align="center">
+ * <p style="text-align:center">
  * <img src="doc-files/groupLayout.1.gif">
  * <p>
  * To reinforce that each axis is treated independently the diagram shows
@@ -101,7 +101,7 @@
  * parallel group along the horizontal axis and the sequential group along
  * the vertical axis.
  * <p>
- * <p align="center">
+ * <p style="text-align:center">
  * <img src="doc-files/groupLayout.2.gif">
  * <p>
  * As {@code c1} is the largest of the three components, the parallel
@@ -115,7 +115,7 @@
  * <p>
  * The following diagram shows a sequential group along both the horizontal
  * and vertical axis.
- * <p align="center">
+ * <p style="text-align:center">
  * <img src="doc-files/groupLayout.3.gif">
  * <p>
  * {@code GroupLayout} provides the ability to insert gaps between
@@ -172,7 +172,7 @@
  * </pre>
  * <p>
  * When run the following is produced.
- * <p align="center">
+ * <p style="text-align:center">
  * <img src="doc-files/groupLayout.example.png">
  * <p>
  * This layout consists of the following.
--- a/src/share/classes/javax/swing/text/JTextComponent.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/javax/swing/text/JTextComponent.java	Mon Jan 23 21:08:33 2017 +0000
@@ -160,9 +160,9 @@
  *
  * <table border=1 summary="Stages of keyboard and input method event handling">
  * <tr>
- * <th id="stage"><p align="left">Stage</p></th>
- * <th id="ke"><p align="left">KeyEvent</p></th>
- * <th id="ime"><p align="left">InputMethodEvent</p></th></tr>
+ * <th id="stage"><p style="text-align:left">Stage</p></th>
+ * <th id="ke"><p style="text-align:left">KeyEvent</p></th>
+ * <th id="ime"><p style="text-align:left">InputMethodEvent</p></th></tr>
  * <tr><td headers="stage">1.   </td>
  *     <td headers="ke">input methods </td>
  *     <td headers="ime">(generated here)</td></tr>
@@ -214,7 +214,7 @@
  * The text document model may be shared by other views which act as observers
  * of the model (e.g. a document may be shared by multiple components).
  *
- * <p align=center><img src="doc-files/editor.gif" alt="Diagram showing interaction between Controller, Document, events, and ViewFactory"
+ * <p style="text-align:center"><img src="doc-files/editor.gif" alt="Diagram showing interaction between Controller, Document, events, and ViewFactory"
  *                  HEIGHT=358 WIDTH=587></p>
  *
  * <p>
@@ -1399,8 +1399,8 @@
      * Fetches a portion of the text represented by the
      * component.  Returns an empty string if length is 0.
      *
-     * @param offs the offset >= 0
-     * @param len the length >= 0
+     * @param offs the offset &ge; 0
+     * @param len the length &ge; 0
      * @return the text
      * @exception BadLocationException if the offset or length are invalid
      */
@@ -1416,7 +1416,7 @@
      * be computed until the component has been sized).  The
      * component does not have to be visible or painted.
      *
-     * @param pos the position >= 0
+     * @param pos the position &ge; 0
      * @return the coordinates as a rectangle, with (r.x, r.y) as the location
      *   in the coordinate system, or null if the component does
      *   not yet have a positive size.
@@ -1437,7 +1437,7 @@
      * component does not have to be visible or painted.
      *
      * @param pt the location in the view to translate
-     * @return the offset >= 0 from the start of the document,
+     * @return the offset &ge; 0 from the start of the document,
      *   or -1 if the component does not yet have a positive
      *   size.
      * @see TextUI#viewToModel
@@ -1686,7 +1686,7 @@
      * text component.
      *
      * @return the position of the text insertion caret for the
-     *  text component >= 0
+     *  text component &ge; 0
      */
     @Transient
     public int getCaretPosition() {
@@ -1812,7 +1812,7 @@
      * Returns the selected text's start position.  Return 0 for an
      * empty document, or the value of dot if no selection.
      *
-     * @return the start position >= 0
+     * @return the start position &ge; 0
      */
     @Transient
     public int getSelectionStart() {
@@ -1830,7 +1830,7 @@
      * This is implemented to forward to the <code>Caret</code>
      * implementation which is where the actual selection is maintained.
      *
-     * @param selectionStart the start position of the text >= 0
+     * @param selectionStart the start position of the text &ge; 0
      * @beaninfo
      * description: starting location of the selection.
      */
@@ -1845,7 +1845,7 @@
      * Returns the selected text's end position.  Return 0 if the document
      * is empty, or the value of dot if there is no selection.
      *
-     * @return the end position >= 0
+     * @return the end position &ge; 0
      */
     @Transient
     public int getSelectionEnd() {
@@ -1863,7 +1863,7 @@
      * This is implemented to forward to the <code>Caret</code>
      * implementation which is where the actual selection is maintained.
      *
-     * @param selectionEnd the end position of the text >= 0
+     * @param selectionEnd the end position of the text &ge; 0
      * @beaninfo
      * description: ending location of the selection.
      */
@@ -2783,7 +2783,7 @@
          * if the JTextComponent is contained in a JScrollPane in which
          * case the resulting rectangle should be composed with the parent
          * coordinates.  A good algorithm to use is:
-         * <nf>
+         * <pre>
          * Accessible a:
          * AccessibleText at = a.getAccessibleText();
          * AccessibleComponent ac = a.getAccessibleComponent();
@@ -2791,14 +2791,14 @@
          * Point p = ac.getLocation();
          * r.x += p.x;
          * r.y += p.y;
-         * </nf>
+         * </pre>
          *
          * Note: the JTextComponent must have a valid size (e.g. have
          * been added to a parent container whose ancestor container
          * is a valid top-level window) for this method to be able
          * to return a meaningful (non-null) value.
          *
-         * @param i the index into the String >= 0
+         * @param i the index into the String &ge; 0
          * @return the screen coordinates of the character's bounding box
          */
         public Rectangle getCharacterBounds(int i) {
@@ -2842,7 +2842,7 @@
         /**
          * Returns the number of characters (valid indices)
          *
-         * @return the number of characters >= 0
+         * @return the number of characters &ge; 0
          */
         public int getCharCount() {
             return model.getLength();
@@ -2893,7 +2893,7 @@
          * Return 0 if the text is empty, or the caret position
          * if no selection.
          *
-         * @return the index into the text of the start of the selection >= 0
+         * @return the index into the text of the start of the selection &ge; 0
          */
         public int getSelectionStart() {
             return JTextComponent.this.getSelectionStart();
@@ -2906,7 +2906,7 @@
          * Return 0 if the text is empty, or the caret position
          * if no selection.
          *
-         * @return the index into teh text of the end of the selection >= 0
+         * @return the index into teh text of the end of the selection &ge; 0
          */
         public int getSelectionEnd() {
             return JTextComponent.this.getSelectionEnd();
--- a/src/share/classes/javax/swing/text/StyleConstants.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/javax/swing/text/StyleConstants.java	Mon Jan 23 21:08:33 2017 +0000
@@ -39,7 +39,7 @@
  * All sizes are specified in points (such as found in postscript), a
  * device independent measure.
  * </p>
- * <p align=center><img src="doc-files/paragraph.gif"
+ * <p style="text-align:center"><img src="doc-files/paragraph.gif"
  * alt="Diagram shows SpaceAbove, FirstLineIndent, LeftIndent, RightIndent,
  *      and SpaceBelow a paragraph."></p>
  * <p>
--- a/src/share/classes/javax/swing/text/html/HTMLDocument.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/javax/swing/text/html/HTMLDocument.java	Mon Jan 23 21:08:33 2017 +0000
@@ -261,8 +261,8 @@
  * not be compatible with future Swing releases. The current
  * serialization support is appropriate for short term storage or RMI
  * between applications running the same version of Swing.  As of 1.4,
- * support for long term storage of all JavaBeans<sup><font
- * size="-2">TM</font></sup> has been added to the
+ * support for long term storage of all JavaBeans&trade;
+ * has been added to the
  * <code>java.beans</code> package.  Please see {@link
  * java.beans.XMLEncoder}.</p>
  *
--- a/src/share/classes/javax/swing/tree/DefaultTreeCellRenderer.java	Wed Oct 02 11:28:07 2013 -0700
+++ b/src/share/classes/javax/swing/tree/DefaultTreeCellRenderer.java	Mon Jan 23 21:08:33 2017 +0000
@@ -63,8 +63,8 @@
  * <table border="1" cellpadding="1" cellspacing="0"
  *         valign="top" >
  *   <tr valign="top"  align="left">
- *     <th bgcolor="#CCCCFF" align="left">Property:
- *     <th bgcolor="#CCCCFF" align="left">Key:
+ *     <th style="background-color:#CCCCFF" align="left">Property:
+ *     <th style="background-color:#CCCCFF" align="left">Key:
  *   <tr><td>"leafIcon"<td>"Tree.leafIcon"
  *   <tr><td>"closedIcon"<td>"Tree.closedIcon"
  *   <tr><td>"openIcon"<td>"Tree.openIcon"