8025235: [javadoc] fix some errors in 2D
Reviewed-by: prr, yan
Contributed-by: Dmitry Ginzburg <dmitry.x.ginzburg@oracle.com>
--- a/jdk/src/share/classes/java/awt/Font.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/Font.java Wed Nov 20 12:23:55 2013 +0400
@@ -71,7 +71,7 @@
* and to render sequences of glyphs on <code>Graphics</code> and
* <code>Component</code> objects.
*
- * <h4>Characters and Glyphs</h4>
+ * <h3>Characters and Glyphs</h3>
*
* A <em>character</em> is a symbol that represents an item such as a letter,
* a digit, or punctuation in an abstract way. For example, <code>'g'</code>,
@@ -192,7 +192,7 @@
* not serializable. See {@link java.awt.im.InputMethodHighlight}.</li>
* </ul>
*
- * Clients who create custom subclasses of <code>Paint</code> and
+ * <p>Clients who create custom subclasses of <code>Paint</code> and
* <code>GraphicAttribute</code> can make them serializable and
* avoid this problem. Clients who use input method highlights can
* convert these to the platform-specific attributes for that
--- a/jdk/src/share/classes/java/awt/Graphics2D.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/Graphics2D.java Wed Nov 20 12:23:55 2013 +0400
@@ -78,7 +78,7 @@
* <p>
* When creating a <code>Graphics2D</code> object, the
* <code>GraphicsConfiguration</code>
- * specifies the <a name="#deftransform">default transform</a> for
+ * specifies the <a name="deftransform">default transform</a> for
* the target of the <code>Graphics2D</code> (a
* {@link Component} or {@link Image}). This default transform maps the
* user space coordinate system to screen and printer device coordinates
@@ -1103,7 +1103,7 @@
* method is intended only for restoring the original
* <code>Graphics2D</code> transform after rendering, as shown in this
* example:
- * <pre><blockquote>
+ * <pre>
* // Get the current transform
* AffineTransform saveAT = g2.getTransform();
* // Perform transformation
@@ -1112,7 +1112,7 @@
* g2d.draw(...);
* // Restore original transform
* g2d.setTransform(saveAT);
- * </blockquote></pre>
+ * </pre>
*
* @param Tx the <code>AffineTransform</code> that was retrieved
* from the <code>getTransform</code> method
--- a/jdk/src/share/classes/java/awt/GraphicsConfiguration.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/GraphicsConfiguration.java Wed Nov 20 12:23:55 2013 +0400
@@ -75,7 +75,7 @@
* bounds of the virtual device. The following code sample
* calculates the bounds of the virtual device.
*
- * <pre>
+ * <pre>{@code
* Rectangle virtualBounds = new Rectangle();
* GraphicsEnvironment ge = GraphicsEnvironment.
* getLocalGraphicsEnvironment();
@@ -89,7 +89,7 @@
* virtualBounds =
* virtualBounds.union(gc[i].getBounds());
* }
- * } </pre>
+ * } }</pre>
*
* @see Window
* @see Frame
--- a/jdk/src/share/classes/java/awt/GraphicsDevice.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/GraphicsDevice.java Wed Nov 20 12:23:55 2013 +0400
@@ -46,7 +46,7 @@
* following code sample demonstrates how to create a <code>JFrame</code>
* object for each <code>GraphicsConfiguration</code> on each screen
* device in the <code>GraphicsEnvironment</code>:
- * <pre>
+ * <pre>{@code
* GraphicsEnvironment ge = GraphicsEnvironment.
* getLocalGraphicsEnvironment();
* GraphicsDevice[] gs = ge.getScreenDevices();
@@ -66,7 +66,7 @@
* f.show();
* }
* }
- * </pre>
+ * }</pre>
* <p>
* For more information on full-screen exclusive mode API, see the
* <a href="http://docs.oracle.com/javase/tutorial/extra/fullscreen/index.html">
--- a/jdk/src/share/classes/java/awt/Image.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/Image.java Wed Nov 20 12:23:55 2013 +0400
@@ -124,7 +124,7 @@
* @param name a property name.
* @param observer an object waiting for this image to be loaded.
* @return the value of the named property.
- * @throws <code>NullPointerException</code> if the property name is null.
+ * @throws NullPointerException if the property name is null.
* @see java.awt.image.ImageObserver
* @see java.awt.Image#UndefinedProperty
*/
--- a/jdk/src/share/classes/java/awt/MediaTracker.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/MediaTracker.java Wed Nov 20 12:23:55 2013 +0400
@@ -66,7 +66,7 @@
* <p>
* Here is an example of using <code>MediaTracker</code>:
* <p>
- * <hr><blockquote><pre>
+ * <hr><blockquote><pre>{@code
* import java.applet.Applet;
* import java.awt.Color;
* import java.awt.Image;
@@ -160,7 +160,7 @@
* }
* }
* }
- * </pre></blockquote><hr>
+ * } </pre></blockquote><hr>
*
* @author Jim Graham
* @since JDK1.0
--- a/jdk/src/share/classes/java/awt/PageAttributes.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/PageAttributes.java Wed Nov 20 12:23:55 2013 +0400
@@ -187,55 +187,55 @@
};
/**
- * The MediaType instance for ISO/DIN & JIS 4A0, 1682 x 2378 mm.
+ * The MediaType instance for ISO/DIN and JIS 4A0, 1682 x 2378 mm.
*/
public static final MediaType ISO_4A0 = new MediaType(I_ISO_4A0);
/**
- * The MediaType instance for ISO/DIN & JIS 2A0, 1189 x 1682 mm.
+ * The MediaType instance for ISO/DIN and JIS 2A0, 1189 x 1682 mm.
*/
public static final MediaType ISO_2A0 = new MediaType(I_ISO_2A0);
/**
- * The MediaType instance for ISO/DIN & JIS A0, 841 x 1189 mm.
+ * The MediaType instance for ISO/DIN and JIS A0, 841 x 1189 mm.
*/
public static final MediaType ISO_A0 = new MediaType(I_ISO_A0);
/**
- * The MediaType instance for ISO/DIN & JIS A1, 594 x 841 mm.
+ * The MediaType instance for ISO/DIN and JIS A1, 594 x 841 mm.
*/
public static final MediaType ISO_A1 = new MediaType(I_ISO_A1);
/**
- * The MediaType instance for ISO/DIN & JIS A2, 420 x 594 mm.
+ * The MediaType instance for ISO/DIN and JIS A2, 420 x 594 mm.
*/
public static final MediaType ISO_A2 = new MediaType(I_ISO_A2);
/**
- * The MediaType instance for ISO/DIN & JIS A3, 297 x 420 mm.
+ * The MediaType instance for ISO/DIN and JIS A3, 297 x 420 mm.
*/
public static final MediaType ISO_A3 = new MediaType(I_ISO_A3);
/**
- * The MediaType instance for ISO/DIN & JIS A4, 210 x 297 mm.
+ * The MediaType instance for ISO/DIN and JIS A4, 210 x 297 mm.
*/
public static final MediaType ISO_A4 = new MediaType(I_ISO_A4);
/**
- * The MediaType instance for ISO/DIN & JIS A5, 148 x 210 mm.
+ * The MediaType instance for ISO/DIN and JIS A5, 148 x 210 mm.
*/
public static final MediaType ISO_A5 = new MediaType(I_ISO_A5);
/**
- * The MediaType instance for ISO/DIN & JIS A6, 105 x 148 mm.
+ * The MediaType instance for ISO/DIN and JIS A6, 105 x 148 mm.
*/
public static final MediaType ISO_A6 = new MediaType(I_ISO_A6);
/**
- * The MediaType instance for ISO/DIN & JIS A7, 74 x 105 mm.
+ * The MediaType instance for ISO/DIN and JIS A7, 74 x 105 mm.
*/
public static final MediaType ISO_A7 = new MediaType(I_ISO_A7);
/**
- * The MediaType instance for ISO/DIN & JIS A8, 52 x 74 mm.
+ * The MediaType instance for ISO/DIN and JIS A8, 52 x 74 mm.
*/
public static final MediaType ISO_A8 = new MediaType(I_ISO_A8);
/**
- * The MediaType instance for ISO/DIN & JIS A9, 37 x 52 mm.
+ * The MediaType instance for ISO/DIN and JIS A9, 37 x 52 mm.
*/
public static final MediaType ISO_A9 = new MediaType(I_ISO_A9);
/**
- * The MediaType instance for ISO/DIN & JIS A10, 26 x 37 mm.
+ * The MediaType instance for ISO/DIN and JIS A10, 26 x 37 mm.
*/
public static final MediaType ISO_A10 = new MediaType(I_ISO_A10);
/**
--- a/jdk/src/share/classes/java/awt/Rectangle.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/Rectangle.java Wed Nov 20 12:23:55 2013 +0400
@@ -76,19 +76,19 @@
* negative width and height or it should use the first point in the set
* to construct the {@code Rectangle}.
* For example:
- * <pre>
+ * <pre>{@code
* Rectangle bounds = new Rectangle(0, 0, -1, -1);
* for (int i = 0; i < points.length; i++) {
* bounds.add(points[i]);
* }
- * </pre>
+ * }</pre>
* or if we know that the points array contains at least one point:
- * <pre>
+ * <pre>{@code
* Rectangle bounds = new Rectangle(points[0]);
* for (int i = 1; i < points.length; i++) {
* bounds.add(points[i]);
* }
- * </pre>
+ * }</pre>
* <p>
* This class uses 32-bit integers to store its location and dimensions.
* Frequently operations may produce a result that exceeds the range of
--- a/jdk/src/share/classes/java/awt/RenderingHints.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/RenderingHints.java Wed Nov 20 12:23:55 2013 +0400
@@ -999,15 +999,15 @@
}
/**
- * Returns <code>true</code> if this <code>RenderingHints</code>
+ * Returns {@code true} if this {@code RenderingHints}
* contains a mapping for the specified key.
*
* @param key key whose presence in this
- * <code>RenderingHints</code> is to be tested.
- * @return <code>true</code> if this <code>RenderingHints</code>
+ * {@code RenderingHints} is to be tested.
+ * @return {@code true} if this {@code RenderingHints}
* contains a mapping for the specified key.
- * @exception <code>ClassCastException</code> if the key can not
- * be cast to <code>RenderingHints.Key</code>
+ * @exception ClassCastException if the key can not
+ * be cast to {@code RenderingHints.Key}
*/
public boolean containsKey(Object key) {
return hintmap.containsKey((Key) key);
@@ -1039,10 +1039,10 @@
* Returns the value to which the specified key is mapped.
* @param key a rendering hint key
* @return the value to which the key is mapped in this object or
- * <code>null</code> if the key is not mapped to any value in
+ * {@code null} if the key is not mapped to any value in
* this object.
- * @exception <code>ClassCastException</code> if the key can not
- * be cast to <code>RenderingHints.Key</code>
+ * @exception ClassCastException if the key can not
+ * be cast to {@code RenderingHints.Key}
* @see #put(Object, Object)
*/
public Object get(Object key) {
@@ -1050,20 +1050,20 @@
}
/**
- * Maps the specified <code>key</code> to the specified
- * <code>value</code> in this <code>RenderingHints</code> object.
- * Neither the key nor the value can be <code>null</code>.
- * The value can be retrieved by calling the <code>get</code> method
+ * Maps the specified {@code key} to the specified
+ * {@code value} in this {@code RenderingHints} object.
+ * Neither the key nor the value can be {@code null}.
+ * The value can be retrieved by calling the {@code get} method
* with a key that is equal to the original key.
* @param key the rendering hint key.
* @param value the rendering hint value.
* @return the previous value of the specified key in this object
- * or <code>null</code> if it did not have one.
- * @exception <code>NullPointerException</code> if the key is
- * <code>null</code>.
- * @exception <code>ClassCastException</code> if the key can not
- * be cast to <code>RenderingHints.Key</code>
- * @exception <code>IllegalArgumentException</code> if the
+ * or {@code null} if it did not have one.
+ * @exception NullPointerException if the key is
+ * {@code null}.
+ * @exception ClassCastException if the key can not
+ * be cast to {@code RenderingHints.Key}
+ * @exception IllegalArgumentException if the
* {@link Key#isCompatibleValue(java.lang.Object)
* Key.isCompatibleValue()}
* method of the specified key returns false for the
@@ -1102,13 +1102,13 @@
/**
* Removes the key and its corresponding value from this
- * <code>RenderingHints</code> object. This method does nothing if the
- * key is not in this <code>RenderingHints</code> object.
+ * {@code RenderingHints} object. This method does nothing if the
+ * key is not in this {@code RenderingHints} object.
* @param key the rendering hints key that needs to be removed
- * @exception <code>ClassCastException</code> if the key can not
- * be cast to <code>RenderingHints.Key</code>
+ * @exception ClassCastException if the key can not
+ * be cast to {@code RenderingHints.Key}
* @return the value to which the key had previously been mapped in this
- * <code>RenderingHints</code> object, or <code>null</code>
+ * {@code RenderingHints} object, or {@code null}
* if the key did not have a mapping.
*/
public Object remove(Object key) {
@@ -1116,18 +1116,18 @@
}
/**
- * Copies all of the mappings from the specified <code>Map</code>
- * to this <code>RenderingHints</code>. These mappings replace
- * any mappings that this <code>RenderingHints</code> had for any
- * of the keys currently in the specified <code>Map</code>.
- * @param m the specified <code>Map</code>
- * @exception <code>ClassCastException</code> class of a key or value
- * in the specified <code>Map</code> prevents it from being
- * stored in this <code>RenderingHints</code>.
- * @exception <code>IllegalArgumentException</code> some aspect
- * of a key or value in the specified <code>Map</code>
+ * Copies all of the mappings from the specified {@code Map}
+ * to this {@code RenderingHints}. These mappings replace
+ * any mappings that this {@code RenderingHints} had for any
+ * of the keys currently in the specified {@code Map}.
+ * @param m the specified {@code Map}
+ * @exception ClassCastException class of a key or value
+ * in the specified {@code Map} prevents it from being
+ * stored in this {@code RenderingHints}.
+ * @exception IllegalArgumentException some aspect
+ * of a key or value in the specified {@code Map}
* prevents it from being stored in
- * this <code>RenderingHints</code>.
+ * this {@code RenderingHints}.
*/
public void putAll(Map<?,?> m) {
// ## javac bug?
--- a/jdk/src/share/classes/java/awt/font/NumericShaper.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/font/NumericShaper.java Wed Nov 20 12:23:55 2013 +0400
@@ -1212,7 +1212,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() & shaper.ARABIC) != 0) { ... }
* </blockquote>
*
* <p>Note that this method supports only the bit mask-based
--- a/jdk/src/share/classes/java/awt/font/TextAttribute.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/font/TextAttribute.java Wed Nov 20 12:23:55 2013 +0400
@@ -66,7 +66,7 @@
* <LI>a description of the effect.
* </UL>
* <p>
- * <H4>Values</H4>
+ * <H3>Values</H3>
* <UL>
* <LI>The values of attributes must always be immutable.
* <LI>Where value limitations are given, any value outside of that
@@ -96,7 +96,6 @@
*
* <h4>Summary of attributes</h4>
* <p>
- * <font size="-1">
* <table style="float:center" border="0" cellspacing="0" cellpadding="2" width="%95"
* summary="Key, value type, principal constants, and default value
* behavior of all TextAttributes">
@@ -110,9 +109,9 @@
* <td valign="TOP">{@link #FAMILY}</td>
* <td valign="TOP">String</td>
* <td valign="TOP">See Font {@link java.awt.Font#DIALOG DIALOG},
-{@link java.awt.Font#DIALOG_INPUT DIALOG_INPUT},<br> {@link java.awt.Font#SERIF SERIF},
-{@link java.awt.Font#SANS_SERIF SANS_SERIF}, and {@link java.awt.Font#MONOSPACED MONOSPACED}.
-</td>
+ * {@link java.awt.Font#DIALOG_INPUT DIALOG_INPUT},<br> {@link java.awt.Font#SERIF SERIF},
+ * {@link java.awt.Font#SANS_SERIF SANS_SERIF}, and {@link java.awt.Font#MONOSPACED MONOSPACED}.
+ * </td>
* <td valign="TOP">"Default" (use platform default)</td>
* </tr>
* <tr style="background-color:#eeeeff">
@@ -248,7 +247,6 @@
* <td valign="TOP">0 (do not add tracking)</td>
* </tr>
* </table>
- * </font>
*
* @see java.awt.Font
* @see java.awt.font.TextLayout
--- a/jdk/src/share/classes/java/awt/geom/FlatteningPathIterator.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/geom/FlatteningPathIterator.java Wed Nov 20 12:23:55 2013 +0400
@@ -109,7 +109,7 @@
* control points and the flattened curve
* @param limit the maximum number of recursive subdivisions
* allowed for any curved segment
- * @exception <code>IllegalArgumentException</code> if
+ * @exception IllegalArgumentException if
* <code>flatness</code> or <code>limit</code>
* is less than zero
*/
@@ -336,7 +336,7 @@
* @param coords an array that holds the data returned from
* this method
* @return the path segment type of the current path segment.
- * @exception <code>NoSuchElementException</code> if there
+ * @exception NoSuchElementException if there
* are no more elements in the flattening path to be
* returned.
* @see PathIterator#SEG_MOVETO
@@ -371,7 +371,7 @@
* @param coords an array that holds the data returned from
* this method
* @return the path segment type of the current path segment.
- * @exception <code>NoSuchElementException</code> if there
+ * @exception NoSuchElementException if there
* are no more elements in the flattening path to be
* returned.
* @see PathIterator#SEG_MOVETO
--- a/jdk/src/share/classes/java/awt/geom/Path2D.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/geom/Path2D.java Wed Nov 20 12:23:55 2013 +0400
@@ -794,7 +794,7 @@
* ({@link #WIND_EVEN_ODD WIND_EVEN_ODD} or
* {@link #WIND_NON_ZERO WIND_NON_ZERO})
* <li>followed by
- * NP (or unlimited if NP < 0) sets of values consisting of
+ * {@code NP} (or unlimited if {@code NP < 0}) sets of values consisting of
* a single byte indicating a path segment type
* followed by one or more pairs of float or double
* values representing the coordinates of the path segment
@@ -1520,7 +1520,7 @@
* ({@link #WIND_EVEN_ODD WIND_EVEN_ODD} or
* {@link #WIND_NON_ZERO WIND_NON_ZERO})
* <li>followed by
- * NP (or unlimited if NP < 0) sets of values consisting of
+ * {@code NP} (or unlimited if {@code NP < 0}) sets of values consisting of
* a single byte indicating a path segment type
* followed by one or more pairs of float or double
* values representing the coordinates of the path segment
--- a/jdk/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/image/MultiPixelPackedSampleModel.java Wed Nov 20 12:23:55 2013 +0400
@@ -348,7 +348,7 @@
* data
* @return the specified band containing the sample of the specified
* pixel.
- * @exception ArrayIndexOutOfBoundException if the specified
+ * @exception ArrayIndexOutOfBoundsException if the specified
* coordinates are not in bounds.
* @see #setSample(int, int, int, int, DataBuffer)
*/
--- a/jdk/src/share/classes/java/awt/print/Book.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/print/Book.java Wed Nov 20 12:23:55 2013 +0400
@@ -129,7 +129,7 @@
* @param painter the <code>Printable</code> instance that
* renders the page
* @param page the size and orientation of the page
- * @throws <code>NullPointerException</code>
+ * @throws NullPointerException
* If the <code>painter</code> or <code>page</code>
* argument is <code>null</code>
*/
@@ -146,7 +146,7 @@
* @param page the size and orientation of the page
* @param numPages the number of pages to be added to the
* this <code>Book</code>.
- * @throws <code>NullPointerException</code>
+ * @throws NullPointerException
* If the <code>painter</code> or <code>page</code>
* argument is <code>null</code>
*/
--- a/jdk/src/share/classes/java/awt/print/PageFormat.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/print/PageFormat.java Wed Nov 20 12:23:55 2013 +0400
@@ -286,7 +286,7 @@
* <code>PageFormat</code>.
* @param paper the <code>Paper</code> object to which to set
* the <code>Paper</code> object for this <code>PageFormat</code>.
- * @exception <code>NullPointerException</code>
+ * @exception NullPointerException
* a null paper instance was passed as a parameter.
* @see #getPaper
*/
--- a/jdk/src/share/classes/java/awt/print/Printable.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/print/Printable.java Wed Nov 20 12:23:55 2013 +0400
@@ -76,7 +76,7 @@
* <li>With the exception of re-imaging an entire document for multiple
* collated copies, the increasing page index order means that when
* page N is requested if a client needs to calculate page break position,
- * it may safely discard any state related to pages < N, and make current
+ * it may safely discard any state related to pages < N, and make current
* that for page N. "State" usually is just the calculated position in the
* document that corresponds to the start of the page.
*
--- a/jdk/src/share/classes/java/awt/print/PrinterJob.java Tue Nov 19 10:36:02 2013 -0800
+++ b/jdk/src/share/classes/java/awt/print/PrinterJob.java Wed Nov 20 12:23:55 2013 +0400
@@ -113,7 +113,7 @@
* A convenience method which locates factories for stream print
* services which can image 2D graphics.
* Sample usage :
- * <pre>
+ * <pre>{@code
* FileOutputStream outstream;
* StreamPrintService psPrinter;
* String psMimeType = "application/postscript";
@@ -131,7 +131,7 @@
* e.printStackTrace();
* }
* }
- * </pre>
+ * }</pre>
* Services returned from this method may be installed on
* <code>PrinterJob</code> instances which support print services.
* Calling this method is equivalent to calling