JDK-6877122 : Many javadoc warnings from java.awt.Window, other awt classes
Type:Bug
Component:client-libs
Sub-Component:java.awt
Affected Version:7
Priority:P4
Status:Resolved
Resolution:Fixed
OS:generic
CPU:generic
Submitted:2009-08-28
Updated:2011-01-19
Resolved:2009-09-11
The Version table provides details related to the release that this issue/RFE will be addressed.
Unresolved : Release in which this issue/RFE will be addressed. Resolved: Release in which this issue/RFE has been resolved. Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.
New API elements added to java.awt.Window introduced many javadoc warnings. These and other javadoc warnings from AWT should be corrected.
Comments
EVALUATION
A fine idea.
28-08-2009
SUGGESTED FIX
# HG changeset patch
# User darcy
# Date 1251483071 25200
# Node ID 4a5f2147f953ace169f02b47ea245bb17ca293e2
# Parent 5342b0cdbf95575e9538f735ef66e5f135492700
6877122: Many javadoc warnings from java.awt.Window, other awt classes
Reviewed-by: anthony
--- a/src/share/classes/java/awt/Cursor.java Thu Aug 27 18:00:16 2009 -0700
+++ b/src/share/classes/java/awt/Cursor.java Fri Aug 28 11:11:11 2009 -0700
@@ -119,7 +119,7 @@ public class Cursor implements java.io.S
public static final int MOVE_CURSOR = 13;
/**
- * @deprecated As of JDK version 1.7, the {@link #getPredefinedCursor()}
+ * @deprecated As of JDK version 1.7, the {@link #getPredefinedCursor(int)}
* method should be used instead.
*/
@Deprecated
--- a/src/share/classes/java/awt/Window.java Thu Aug 27 18:00:16 2009 -0700
+++ b/src/share/classes/java/awt/Window.java Fri Aug 28 11:11:11 2009 -0700
@@ -3347,7 +3347,7 @@ public class Window extends Container im
*
* @return the opacity of the window
*
- * @see Window#setOpacity
+ * @see Window#setOpacity(float)
* @see GraphicsDevice.WindowTranslucency
*
* @since 1.7
@@ -3366,7 +3366,7 @@ public class Window extends Container im
* window. This is a platform-dependent behavior.
* <p>
* In order for this method to enable the translucency effect, the {@link
- * GraphicsDevice#isWindowTranslucencySupported()} method must indicate that
+ * GraphicsDevice#isWindowTranslucencySupported(GraphicsDevice.WindowTranslucency)} method must indicate that
* the {@link GraphicsDevice.WindowTranslucency#TRANSLUCENT TRANSLUCENT}
* translucency is supported.
* <p>
@@ -3375,8 +3375,8 @@ public class Window extends Container im
* IllegalComponentStateException} is thrown.
* <p>
* The translucency levels of individual pixels may also be effected by the
- * alpha component of their color (see {@link setBackground()}) and the
- * current shape of this window (see {@link setShape()}).
+ * alpha component of their color (see {@link Window#setBackground(Color)}) and the
+ * current shape of this window (see {@link #setShape(Shape)}).
*
* @param opacity the opacity level to set to the window
*
@@ -3389,10 +3389,10 @@ public class Window extends Container im
* translucency kind is not supported and the opacity is less than 1.0f
*
* @see Window#getOpacity
- * @see Window#setBackground()
- * @see Window#setShape()
+ * @see Window#setBackground(Color)
+ * @see Window#setShape(Shape)
* @see GraphicsDevice.WindowTranslucency
- * @see GraphicsDevice#isWindowTranslucencySupported()
+ * @see GraphicsDevice#isWindowTranslucencySupported(GraphicsDevice.WindowTranslucency)
*
* @since 1.7
*/
@@ -3434,7 +3434,7 @@ public class Window extends Container im
* @return the shape of the window or {@code null} if no
* shape is specified for the window
*
- * @see Window#setShape
+ * @see Window#setShape(Shape)
* @see GraphicsDevice.WindowTranslucency
*
* @since 1.7
@@ -3458,19 +3458,19 @@ public class Window extends Container im
* <ul>
* <li>The {@link GraphicsDevice.WindowTranslucency#PERPIXEL_TRANSPARENT
* PERPIXEL_TRANSPARENT} translucency kind must be supported by the
- * underlying system (see {@link })
+ * underlying system
* <i>and</i>
* <li>The window must not be in the full-screen mode (see
- * {@link GraphicsDevice#setFullScreenWindow()})
+ * {@link GraphicsDevice#setFullScreenWindow(Window)})
* </ul>
* If a certain condition is not met, either the {@code
* UnsupportedOperationException} or {@code IllegalComponentStateException}
* is thrown.
* <p>
* The tranlucency levels of individual pixels may also be effected by the
- * alpha component of their color (see {@link setBackground()}) and the
- * opacity value (see {@link setOpacity()}). See {@link
- * GraphicsDevice#WindowTranslucency} for more details.
+ * alpha component of their color (see {@link Window#setBackground(Color)}) and the
+ * opacity value (see {@link #setOpacity(float)}). See {@link
+ * GraphicsDevice.WindowTranslucency} for more details.
*
* @param shape the shape to set to the window
*
@@ -3481,10 +3481,10 @@ public class Window extends Container im
* PERPIXEL_TRANSPARENT} translucency is not supported
*
* @see Window#getShape()
- * @see Window#setBackgound()
- * @see Window#setOpacity()
+ * @see Window#setBackground(Color)
+ * @see Window#setOpacity(float)
* @see GraphicsDevice.WindowTranslucency
- * @see GraphicsDevice#isWindowTranslucencySupported()
+ * @see GraphicsDevice#isWindowTranslucencySupported(GraphicsDevice.WindowTranslucency)
*
* @since 1.7
*/
@@ -3520,7 +3520,7 @@ public class Window extends Container im
*
* @return this component's background color
*
- * @see Window#setBackground
+ * @see Window#setBackground(Color)
* @see Window#isOpaque
* @see GraphicsDevice.WindowTranslucency
*/
@@ -3544,7 +3544,7 @@ public class Window extends Container im
* PERPIXEL_TRANSLUCENT} translucency must be supported
* by the graphics device where this window is located <i>and</i>
* <li>The window must not be in the full-screen mode (see {@link
- * GraphicsDevice#setFullScreenWindow()})
+ * GraphicsDevice#setFullScreenWindow(Window)})
* </ul>
* If a certain condition is not met at the time of calling this method,
* the alpha component of the given background color will not effect the
@@ -3561,8 +3561,8 @@ public class Window extends Container im
* method is equal to zero.)
* <p>
* The actual level of translucency of a given pixel also depends on window
- * opacity (see {@link setOpacity()}), as well as the current shape of
- * this window (see {@link setShape()}).
+ * opacity (see {@link #setOpacity(float)}), as well as the current shape of
+ * this window (see {@link #setShape(Shape)}).
* <p>
* Note that painting a pixel with the alpha value of 0 may or may not
* disable the mouse event handling on this pixel. This is a
@@ -3585,10 +3585,10 @@ public class Window extends Container im
*
* @see Window#getBackground
* @see Window#isOpaque
- * @see Window#setOpacity()
- * @see Window#setShape()
+ * @see Window#setOpacity(float)
+ * @see Window#setShape(Shape)
* @see GraphicsDevice.WindowTranslucency
- * @see GraphicsDevice#isWindowTranslucencySupported()
+ * @see GraphicsDevice#isWindowTranslucencySupported(GraphicsDevice.WindowTranslucency)
* @see GraphicsConfiguration#isTranslucencyCapable()
*/
@Override
@@ -3635,7 +3635,7 @@ public class Window extends Container im
* @return {@code true} if the window is opaque, {@code false} otherwise
*
* @see Window#getBackground
- * @see Window#setBackground
+ * @see Window#setBackground(Color)
* @since 1.7
*/
@Override
--- a/src/share/classes/java/awt/dnd/DragSourceContext.java Thu Aug 27 18:00:16 2009 -0700
+++ b/src/share/classes/java/awt/dnd/DragSourceContext.java Fri Aug 28 11:11:11 2009 -0700
@@ -275,7 +275,7 @@ public class DragSourceContext
*
* @param c the initial {@code Cursor} for this drag operation,
* or {@code null} for the default cursor handling;
- * see {@linkplain #defaultCursor class
+ * see {@linkplain Cursor class
* level documentation} for more details
* on the cursor handling during drag and drop
*
28-08-2009
PUBLIC COMMENTS
See
http://hg.openjdk.java.net/jdk7/tl/jdk/rev/4a5f2147f953