From a9f79f9a3c58a742b7e49a9474d4dcd60ff3de3a Mon Sep 17 00:00:00 2001 From: yan Date: Thu, 26 Sep 2013 16:10:36 +0400 Subject: [PATCH] 8025218: [javadoc] some errors in java/awt classes Reviewed-by: yan Contributed-by: Dmitry Zinkevich --- src/share/classes/java/awt/AWTKeyStroke.java | 10 +++++----- src/share/classes/java/awt/Component.java | 2 +- .../java/awt/DefaultKeyboardFocusManager.java | 2 +- src/share/classes/java/awt/Dialog.java | 2 +- src/share/classes/java/awt/Event.java | 2 +- src/share/classes/java/awt/Frame.java | 4 ++-- .../classes/java/awt/GridBagConstraints.java | 2 +- src/share/classes/java/awt/GridBagLayout.java | 16 +++++++++++----- src/share/classes/java/awt/GridLayout.java | 2 +- .../classes/java/awt/KeyboardFocusManager.java | 2 +- src/share/classes/java/awt/MenuBar.java | 2 +- src/share/classes/java/awt/ScrollPane.java | 2 +- .../classes/java/awt/ScrollPaneAdjustable.java | 6 +++--- src/share/classes/java/awt/SystemTray.java | 4 ++-- src/share/classes/java/awt/TextComponent.java | 14 +++++++------- src/share/classes/java/awt/TextField.java | 2 +- src/share/classes/java/awt/Window.java | 11 +++++------ .../java/awt/datatransfer/DataFlavor.java | 2 +- .../java/awt/event/MouseMotionListener.java | 4 ++-- 19 files changed, 48 insertions(+), 43 deletions(-) diff --git a/src/share/classes/java/awt/AWTKeyStroke.java b/src/share/classes/java/awt/AWTKeyStroke.java index e94194e0a..2cf7a3327 100644 --- a/src/share/classes/java/awt/AWTKeyStroke.java +++ b/src/share/classes/java/awt/AWTKeyStroke.java @@ -485,11 +485,11 @@ public class AWTKeyStroke implements Serializable { * If typed, pressed or released is not specified, pressed is assumed. Here * are some examples: * 
-     *     "INSERT" => getAWTKeyStroke(KeyEvent.VK_INSERT, 0);
-     *     "control DELETE" => getAWTKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
-     *     "alt shift X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
-     *     "alt shift released X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
-     *     "typed a" => getAWTKeyStroke('a');
+     *     "INSERT" => getAWTKeyStroke(KeyEvent.VK_INSERT, 0);
+     *     "control DELETE" => getAWTKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
+     *     "alt shift X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
+     *     "alt shift released X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
+     *     "typed a" => getAWTKeyStroke('a');
      *
* * @param s a String formatted as described above diff --git a/src/share/classes/java/awt/Component.java b/src/share/classes/java/awt/Component.java index 23a16f7db..64a753844 100644 --- a/src/share/classes/java/awt/Component.java +++ b/src/share/classes/java/awt/Component.java @@ -2026,7 +2026,7 @@ public abstract class Component implements ImageObserver, MenuContainer, * @return an instance of Point representing * the top-left corner of the component's bounds in the * coordinate space of the screen - * @throws IllegalComponentStateException if the + * @throws IllegalComponentStateException if the * component is not showing on the screen * @see #setLocation * @see #getLocation diff --git a/src/share/classes/java/awt/DefaultKeyboardFocusManager.java b/src/share/classes/java/awt/DefaultKeyboardFocusManager.java index 4685a88bb..4e07f16fa 100644 --- a/src/share/classes/java/awt/DefaultKeyboardFocusManager.java +++ b/src/share/classes/java/awt/DefaultKeyboardFocusManager.java @@ -1246,7 +1246,7 @@ public class DefaultKeyboardFocusManager extends KeyboardFocusManager { * any) should be cancelled. * * @param after the timestamp specified in the call to - * enqueueKeyEvents, or any value < 0 + * enqueueKeyEvents, or any value < 0 * @param untilFocused the Component specified in the call to * enqueueKeyEvents * @see #enqueueKeyEvents diff --git a/src/share/classes/java/awt/Dialog.java b/src/share/classes/java/awt/Dialog.java index d27041fd3..a2248f033 100644 --- a/src/share/classes/java/awt/Dialog.java +++ b/src/share/classes/java/awt/Dialog.java @@ -61,7 +61,7 @@ import java.security.AccessControlException; *

* The default layout for a dialog is BorderLayout. *

- * A dialog may have its native decorations (i.e. Frame & Titlebar) turned off + * A dialog may have its native decorations (i.e. Frame & Titlebar) turned off * with setUndecorated. This can only be done while the dialog * is not {@link Component#isDisplayable() displayable}. *

diff --git a/src/share/classes/java/awt/Event.java b/src/share/classes/java/awt/Event.java index fc119a037..2bc5c31b2 100644 --- a/src/share/classes/java/awt/Event.java +++ b/src/share/classes/java/awt/Event.java @@ -524,7 +524,7 @@ public class Event implements java.io.Serializable { * This field has been replaced by MouseEvent.getClickCount(). * * @serial - * @see java.awt.event.MouseEvent#getClickCount(). + * @see java.awt.event.MouseEvent#getClickCount() */ public int clickCount; diff --git a/src/share/classes/java/awt/Frame.java b/src/share/classes/java/awt/Frame.java index 2513ddb75..c7f5d4bcb 100644 --- a/src/share/classes/java/awt/Frame.java +++ b/src/share/classes/java/awt/Frame.java @@ -265,12 +265,12 @@ public class Frame extends Window implements MenuContainer { * *

Note that the correct test for frame being fully maximized is * 

-     *     (state & Frame.MAXIMIZED_BOTH) == Frame.MAXIMIZED_BOTH
+     *     (state & Frame.MAXIMIZED_BOTH) == Frame.MAXIMIZED_BOTH
      *
* *

To test is frame is maximized in some direction use * 

-     *     (state & Frame.MAXIMIZED_BOTH) != 0
+     *     (state & Frame.MAXIMIZED_BOTH) != 0
      *
* * @see #setExtendedState(int) diff --git a/src/share/classes/java/awt/GridBagConstraints.java b/src/share/classes/java/awt/GridBagConstraints.java index c524efd0c..3651b39be 100644 --- a/src/share/classes/java/awt/GridBagConstraints.java +++ b/src/share/classes/java/awt/GridBagConstraints.java @@ -30,7 +30,7 @@ package java.awt; * GridBagLayout class. * * @author Doug Stein - * @author Bill Spitzak (orignial NeWS & OLIT implementation) + * @author Bill Spitzak (orignial NeWS & OLIT implementation) * @see java.awt.GridBagLayout * @since JDK1.0 */ diff --git a/src/share/classes/java/awt/GridBagLayout.java b/src/share/classes/java/awt/GridBagLayout.java index 22cb656ba..fb306a8d3 100644 --- a/src/share/classes/java/awt/GridBagLayout.java +++ b/src/share/classes/java/awt/GridBagLayout.java @@ -120,9 +120,9 @@ import java.util.Arrays; * Orientation relative values are interpreted relative to the container's * ComponentOrientation property while absolute values * are not. Baseline relative values are calculated relative to the - * baseline. Valid values are: + * baseline. Valid values are: *

- *

* * @@ -131,6 +131,7 @@ import java.util.Arrays; * * * * * * - *

Absolute Values

+ *
    *
  • GridBagConstraints.NORTH
    • *
  • GridBagConstraints.SOUTH
    • *
  • GridBagConstraints.WEST
    • @@ -140,8 +141,10 @@ import java.util.Arrays; *
  • GridBagConstraints.SOUTHWEST
    • *
  • GridBagConstraints.SOUTHEAST
    • *
  • GridBagConstraints.CENTER (the default)
    • + *
* 		+ *
    *
  • GridBagConstraints.PAGE_START
    • *
  • GridBagConstraints.PAGE_END
    • *
  • GridBagConstraints.LINE_START
    • @@ -150,8 +153,10 @@ import java.util.Arrays; *
  • GridBagConstraints.FIRST_LINE_END
    • *
  • GridBagConstraints.LAST_LINE_START
    • *
  • GridBagConstraints.LAST_LINE_END
    • + *
* 		+ *
    *
  • GridBagConstraints.BASELINE
    • *
  • GridBagConstraints.BASELINE_LEADING
    • *
  • GridBagConstraints.BASELINE_TRAILING
    • @@ -161,9 +166,10 @@ import java.util.Arrays; *
  • GridBagConstraints.BELOW_BASELINE
    • *
  • GridBagConstraints.BELOW_BASELINE_LEADING
    • *
  • GridBagConstraints.BELOW_BASELINE_TRAILING
    • + *
*

+ * *

{@link GridBagConstraints#weightx}, * {@link GridBagConstraints#weighty} *
Used to determine how to distribute space, which is @@ -246,7 +252,7 @@ import java.util.Arrays; * left-to-right container and Figure 3 shows the layout for a horizontal, * right-to-left container. *

- *

+ *
* *
* The preceeding text describes this graphic (Figure 1). @@ -349,7 +355,7 @@ import java.util.Arrays; *
*

* @author Doug Stein - * @author Bill Spitzak (orignial NeWS & OLIT implementation) + * @author Bill Spitzak (orignial NeWS & OLIT implementation) * @see java.awt.GridBagConstraints * @see java.awt.GridBagLayoutInfo * @see java.awt.ComponentOrientation diff --git a/src/share/classes/java/awt/GridLayout.java b/src/share/classes/java/awt/GridLayout.java index 204995960..b08802e8e 100644 --- a/src/share/classes/java/awt/GridLayout.java +++ b/src/share/classes/java/awt/GridLayout.java @@ -55,7 +55,7 @@ package java.awt; * If the container's ComponentOrientation property is horizontal * and right-to-left, the example produces the output shown in Figure 2. *

- *

+ *
* *
Shows 6 buttons in rows of 2. Row 1 shows buttons 1 then 2. diff --git a/src/share/classes/java/awt/KeyboardFocusManager.java b/src/share/classes/java/awt/KeyboardFocusManager.java index 9bccdbbeb..72c3fdb49 100644 --- a/src/share/classes/java/awt/KeyboardFocusManager.java +++ b/src/share/classes/java/awt/KeyboardFocusManager.java @@ -2034,7 +2034,7 @@ public abstract class KeyboardFocusManager * oldest</b> timestamp (if any) should be cancelled. * * @param after the timestamp specified in the call to - * <code>enqueueKeyEvents</code>, or any value < 0 + * <code>enqueueKeyEvents</code>, or any value < 0 * @param untilFocused the Component specified in the call to * <code>enqueueKeyEvents</code> * @see #enqueueKeyEvents diff --git a/src/share/classes/java/awt/MenuBar.java b/src/share/classes/java/awt/MenuBar.java index bd0a7d890..feae49a4d 100644 --- a/src/share/classes/java/awt/MenuBar.java +++ b/src/share/classes/java/awt/MenuBar.java @@ -43,7 +43,7 @@ import javax.accessibility.*; * This is what a menu bar might look like: * <p> * <img src= *

diff --git a/src/share/classes/java/awt/ScrollPane.java b/src/share/classes/java/awt/ScrollPane.java index bb27de0ce..a2e2fc7ee 100644 --- a/src/share/classes/java/awt/ScrollPane.java +++ b/src/share/classes/java/awt/ScrollPane.java @@ -247,7 +247,7 @@ public class ScrollPane extends Container implements Accessible { * component is removed and the new one is added. * @param comp the component to be added * @param constraints not applicable - * @param index position of child component (must be <= 0) + * @param index position of child component (must be <= 0) */ protected final void addImpl(Component comp, Object constraints, int index) { synchronized (getTreeLock()) { diff --git a/src/share/classes/java/awt/ScrollPaneAdjustable.java b/src/share/classes/java/awt/ScrollPaneAdjustable.java index f9c08b39f..d51a84250 100644 --- a/src/share/classes/java/awt/ScrollPaneAdjustable.java +++ b/src/share/classes/java/awt/ScrollPaneAdjustable.java @@ -220,7 +220,7 @@ public class ScrollPaneAdjustable implements Adjustable, Serializable { * This method is public for this class to properly implement * Adjustable interface. * - * @throws AWTError Always throws an error when called. + * @throws AWTError Always throws an error when called. */ public void setMinimum(int min) { throw new AWTError(SCROLLPANE_ONLY); @@ -237,7 +237,7 @@ public class ScrollPaneAdjustable implements Adjustable, Serializable { * This method is public for this class to properly implement * Adjustable interface. * - * @throws AWTError Always throws an error when called. + * @throws AWTError Always throws an error when called. */ public void setMaximum(int max) { throw new AWTError(SCROLLPANE_ONLY); @@ -274,7 +274,7 @@ public class ScrollPaneAdjustable implements Adjustable, Serializable { * This method is public for this class to properly implement * Adjustable interface. * - * @throws AWTError Always throws an error when called. + * @throws AWTError Always throws an error when called. */ public void setVisibleAmount(int v) { throw new AWTError(SCROLLPANE_ONLY); diff --git a/src/share/classes/java/awt/SystemTray.java b/src/share/classes/java/awt/SystemTray.java index 444f85fa3..84e89265c 100644 --- a/src/share/classes/java/awt/SystemTray.java +++ b/src/share/classes/java/awt/SystemTray.java @@ -63,8 +63,8 @@ import sun.awt.AWTAccessor; * *

The following code snippet demonstrates how to access * and customize the system tray: - * * 

+ * 
  *     {@link TrayIcon} trayIcon = null;
  *     if (SystemTray.isSupported()) {
  *         // get the SystemTray instance
@@ -109,8 +109,8 @@ import sun.awt.AWTAccessor;
  *         trayIcon.{@link TrayIcon#setImage(java.awt.Image) setImage}(updatedImage);
  *     }
  *     // ...
- *
* + * * * @since 1.6 * @see TrayIcon diff --git a/src/share/classes/java/awt/TextComponent.java b/src/share/classes/java/awt/TextComponent.java index 483657fd4..2065db6a2 100644 --- a/src/share/classes/java/awt/TextComponent.java +++ b/src/share/classes/java/awt/TextComponent.java @@ -972,7 +972,7 @@ public class TextComponent extends Component implements Accessible { * coordinates. If the index is invalid a null rectangle * is returned. * - * @param i the index into the String >= 0 + * @param i the index into the String >= 0 * @return the screen coordinates of the character's bounding box */ public Rectangle getCharacterBounds(int i) { @@ -982,7 +982,7 @@ public class TextComponent extends Component implements Accessible { /** * Returns the number of characters (valid indicies) * - * @return the number of characters >= 0 + * @return the number of characters >= 0 */ public int getCharCount() { return TextComponent.this.getText().length(); @@ -1018,7 +1018,7 @@ public class TextComponent extends Component implements Accessible { * 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 >= 0 */ public int getSelectionStart() { return TextComponent.this.getSelectionStart(); @@ -1031,7 +1031,7 @@ public class TextComponent extends Component implements Accessible { * 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 >= 0 */ public int getSelectionEnd() { return TextComponent.this.getSelectionEnd(); @@ -1056,7 +1056,7 @@ public class TextComponent extends Component implements Accessible { * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, * null for an invalid index or part */ @@ -1122,7 +1122,7 @@ public class TextComponent extends Component implements Accessible { * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, null for an invalid * index or part */ @@ -1175,7 +1175,7 @@ public class TextComponent extends Component implements Accessible { * * @param part the AccessibleText.CHARACTER, AccessibleText.WORD, * or AccessibleText.SENTENCE to retrieve - * @param index an index within the text >= 0 + * @param index an index within the text >= 0 * @return the letter, word, or sentence, null for an invalid index * or part */ diff --git a/src/share/classes/java/awt/TextField.java b/src/share/classes/java/awt/TextField.java index 7c0e528f5..cbaf649f1 100644 --- a/src/share/classes/java/awt/TextField.java +++ b/src/share/classes/java/awt/TextField.java @@ -503,7 +503,7 @@ public class TextField extends TextComponent { * * @see #addActionListener * @see #removeActionListener - * @see java.awt.event#ActionListener + * @see java.awt.event.ActionListener * @since 1.4 */ public synchronized ActionListener[] getActionListeners() { diff --git a/src/share/classes/java/awt/Window.java b/src/share/classes/java/awt/Window.java index c10a3b277..747168374 100644 --- a/src/share/classes/java/awt/Window.java +++ b/src/share/classes/java/awt/Window.java @@ -1075,7 +1075,6 @@ public class Window extends Container implements Accessible { * Hide this Window, its subcomponents, and all of its owned children. * The Window and its subcomponents can be made visible again * with a call to {@code show}. - *

* @see #show * @see #dispose * @deprecated As of JDK version 1.5, replaced by @@ -3373,27 +3372,27 @@ public class Window extends Container implements Accessible { * this property of the Window. *

* For example, after the following code is executed: - * 


+     * 
      * setLocationByPlatform(true);
      * setVisible(true);
      * boolean flag = isLocationByPlatform();
-     *
+ * * The window will be shown at platform's default location and * {@code flag} will be {@code false}. *

* In the following sample: - * 


+     * 
      * setLocationByPlatform(true);
      * setLocation(10, 10);
      * boolean flag = isLocationByPlatform();
      * setVisible(true);
-     *
+ * * The window will be shown at (10, 10) and {@code flag} will be * {@code false}. * * @param locationByPlatform {@code true} if this Window should appear * at the default location, {@code false} if at the current location - * @throws {@code IllegalComponentStateException} if the window + * @throws IllegalComponentStateException if the window * is showing on screen and locationByPlatform is {@code true}. * @see #setLocation * @see #isShowing diff --git a/src/share/classes/java/awt/datatransfer/DataFlavor.java b/src/share/classes/java/awt/datatransfer/DataFlavor.java index acbc0fe65..7f1b388d3 100644 --- a/src/share/classes/java/awt/datatransfer/DataFlavor.java +++ b/src/share/classes/java/awt/datatransfer/DataFlavor.java @@ -454,7 +454,7 @@ public class DataFlavor implements Externalizable, Cloneable { /** * Constructs a DataFlavor from a mimeType string. - * The string can specify a "class=" + * The string can specify a "class=<fully specified Java class name>" * parameter to create a DataFlavor with the desired * representation class. If the string does not contain "class=" parameter, * java.io.InputStream is used as default. diff --git a/src/share/classes/java/awt/event/MouseMotionListener.java b/src/share/classes/java/awt/event/MouseMotionListener.java index e9cb4ef5a..4b8ff0899 100644 --- a/src/share/classes/java/awt/event/MouseMotionListener.java +++ b/src/share/classes/java/awt/event/MouseMotionListener.java @@ -60,9 +60,9 @@ public interface MouseMotionListener extends EventListener { * mouse button is released (regardless of whether the mouse position * is within the bounds of the component). *

- * Due to platform-dependent Drag&Drop implementations, + * Due to platform-dependent Drag&Drop implementations, * MOUSE_DRAGGED events may not be delivered during a native - * Drag&Drop operation. + * Drag&Drop operation. */ public void mouseDragged(MouseEvent e); -- GitLab