8050924: Fix doclint missing tag warnings in javax.swing.plaf.basic parts 5b,6b of 7
authoryan
Tue, 29 Jul 2014 12:45:24 +0400
changeset 26012 36ecb579dbc8
parent 26011 0fa4f1bd2843
child 26013 83b99f14245f
8050924: Fix doclint missing tag warnings in javax.swing.plaf.basic parts 5b,6b of 7 Summary: Fix doclint missing tag warnings Reviewed-by: prr Contributed-by: prhinduja@gmail.com, anisha.nagarajan1@gmail.com
jdk/src/share/classes/javax/swing/plaf/basic/BasicInternalFrameUI.java
jdk/src/share/classes/javax/swing/plaf/basic/BasicScrollBarUI.java
jdk/src/share/classes/javax/swing/plaf/basic/BasicSliderUI.java
jdk/src/share/classes/javax/swing/plaf/basic/BasicTabbedPaneUI.java
--- a/jdk/src/share/classes/javax/swing/plaf/basic/BasicInternalFrameUI.java	Mon Jul 28 19:11:52 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/basic/BasicInternalFrameUI.java	Tue Jul 29 12:45:24 2014 +0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -351,10 +351,15 @@
 
 
     /**
-      * Installs necessary mouse handlers on <code>newPane</code>
-      * and adds it to the frame.
-      * Reverse process for the <code>currentPane</code>.
-      */
+     * Installs necessary mouse handlers on <code>newPane</code>
+     * and adds it to the frame.
+     * Reverse process for the <code>currentPane</code>.
+     *
+     * @param currentPane this {@code Jcomponent} is the current pane being
+     * viewed that has mouse handlers installed
+     * @param newPane this {@code Jcomponent} is the pane which will be added
+     * and have mouse handlers installed
+     */
     protected void replacePane(JComponent currentPane, JComponent newPane) {
         if(currentPane != null) {
             deinstallMouseHandlers(currentPane);
@@ -517,11 +522,12 @@
   }
 
 /// DesktopManager methods
-    /** Returns the proper DesktopManager. Calls getDesktopPane() to
-      * find the JDesktop component and returns the desktopManager from
-      * it. If this fails, it will return a default DesktopManager that
-      * should work in arbitrary parents.
-      */
+    /**
+     * Returns the proper DesktopManager. Calls getDesktopPane() to
+     * find the JDesktop component and returns the desktopManager from
+     * it. If this fails, it will return a default DesktopManager that
+     * should work in arbitrary parents.
+     */
     protected DesktopManager getDesktopManager() {
         if(frame.getDesktopPane() != null
            && frame.getDesktopPane().getDesktopManager() != null)
@@ -539,6 +545,8 @@
      * This method is called when the user wants to close the frame.
      * The <code>playCloseSound</code> Action is fired.
      * This action is delegated to the desktopManager.
+     *
+     * @param f the {@code JInternalFrame} being viewed
      */
     protected void closeFrame(JInternalFrame f) {
         // Internal Frame Auditory Cue Activation
@@ -551,6 +559,8 @@
      * This method is called when the user wants to maximize the frame.
      * The <code>playMaximizeSound</code> Action is fired.
      * This action is delegated to the desktopManager.
+     *
+     * @param f the {@code JInternalFrame} being viewed
      */
     protected void maximizeFrame(JInternalFrame f) {
         // Internal Frame Auditory Cue Activation
@@ -563,6 +573,8 @@
      * This method is called when the user wants to minimize the frame.
      * The <code>playRestoreDownSound</code> Action is fired.
      * This action is delegated to the desktopManager.
+     *
+     * @param f the {@code JInternalFrame} being viewed
      */
     protected void minimizeFrame(JInternalFrame f) {
         // Internal Frame Auditory Cue Activation
@@ -579,6 +591,8 @@
      * This method is called when the user wants to iconify the frame.
      * The <code>playMinimizeSound</code> Action is fired.
      * This action is delegated to the desktopManager.
+     *
+     * @param f the {@code JInternalFrame} being viewed
      */
     protected void iconifyFrame(JInternalFrame f) {
         // Internal Frame Auditory Cue Activation
@@ -591,6 +605,8 @@
      * This method is called when the user wants to deiconify the frame.
      * The <code>playRestoreUpSound</code> Action is fired.
      * This action is delegated to the desktopManager.
+     *
+     * @param f the {@code JInternalFrame} being viewed
      */
     protected void deiconifyFrame(JInternalFrame f) {
         // Internal Frame Auditory Cue Activation
@@ -603,15 +619,21 @@
         getDesktopManager().deiconifyFrame(f);
     }
 
-    /** This method is called when the frame becomes selected.
+    /**
+      * This method is called when the frame becomes selected.
       * This action is delegated to the desktopManager.
+      *
+      * @param f the {@code JInternalFrame} being viewed
       */
     protected void activateFrame(JInternalFrame f) {
         getDesktopManager().activateFrame(f);
     }
-    /** This method is called when the frame is no longer selected.
-      * This action is delegated to the desktopManager.
-      */
+    /**
+     * This method is called when the frame is no longer selected.
+     * This action is delegated to the desktopManager.
+     *
+     * @param f the {@code JInternalFrame} being viewed
+     */
     protected void deactivateFrame(JInternalFrame f) {
         getDesktopManager().deactivateFrame(f);
     }
@@ -769,7 +791,7 @@
                       resizeDir = SOUTH;
                     }
                 } else {
-                  /* the mouse press happened inside the frame, not in the
+                    /* the mouse press happened inside the frame, not in the
                      border */
                   discardRelease = true;
                   return;
--- a/jdk/src/share/classes/javax/swing/plaf/basic/BasicScrollBarUI.java	Mon Jul 28 19:11:52 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/basic/BasicScrollBarUI.java	Tue Jul 29 12:45:24 2014 +0400
@@ -93,8 +93,10 @@
 
     private final static int scrollSpeedThrottle = 60; // delay in milli seconds
 
-    /** True indicates a middle click will absolutely position the
-     * scrollbar. */
+    /**
+     * True indicates a middle click will absolutely position the
+     * scrollbar.
+     */
     private boolean supportsAbsolutePositioning;
 
     /**
@@ -877,6 +879,10 @@
      * Set the bounds of the thumb and force a repaint that includes
      * the old thumbBounds and the new one.
      *
+     * @param x set the x location of the thumb
+     * @param y set the y location of the thumb
+     * @param width set the width of the thumb
+     * @param height set the height of the thumb
      * @see #getThumbBounds
      */
     protected void setThumbBounds(int x, int y, int width, int height)
--- a/jdk/src/share/classes/javax/swing/plaf/basic/BasicSliderUI.java	Mon Jul 28 19:11:52 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/basic/BasicSliderUI.java	Tue Jul 29 12:45:24 2014 +0400
@@ -656,10 +656,15 @@
     }
 
     /**
-     * Gets the height of the tick area for horizontal sliders and the width of the
-     * tick area for vertical sliders.  BasicSliderUI uses the returned value to
-     * determine the tick area rectangle.  If you want to give your ticks some room,
-     * make this larger than you need and paint your ticks away from the sides in paintTicks().
+     * Gets the height of the tick area for horizontal sliders and the width of
+     * the tick area for vertical sliders. BasicSliderUI uses the returned value
+     * to determine the tick area rectangle. If you want to give your ticks some
+     * room, make this larger than you need and paint your ticks away from the
+     * sides in paintTicks().
+     *
+     * @return an integer representing the height of the tick area for
+     * horizontal sliders, and the width of the tick area for the vertical
+     * sliders
      */
     protected int getTickLength() {
         return 8;
@@ -867,7 +872,7 @@
      * Returns the smallest value that has an entry in the label table.
      *
      * @return smallest value that has an entry in the label table, or
-     *         null.
+     * null.
      * @since 1.6
      */
     protected Integer getLowestValue() {
@@ -894,7 +899,11 @@
 
 
     /**
-     * Returns the label that corresponds to the highest slider value in the label table.
+     * Returns the label that corresponds to the highest slider value in the
+     * label table.
+     *
+     * @return the label that corresponds to the highest slider value in the
+     * label table
      * @see JSlider#setLabelTable
      */
     protected Component getLowestValueLabel() {
@@ -906,7 +915,11 @@
     }
 
     /**
-     * Returns the label that corresponds to the lowest slider value in the label table.
+     * Returns the label that corresponds to the lowest slider value in the
+     * label table.
+     *
+     * @return the label that corresponds to the lowest slider value in the
+     * label table
      * @see JSlider#setLabelTable
      */
     protected Component getHighestValueLabel() {
@@ -1166,8 +1179,14 @@
     }
 
     /**
-     * Called for every label in the label table.  Used to draw the labels for horizontal sliders.
-     * The graphics have been translated to labelRect.y already.
+     * Called for every label in the label table. Used to draw the labels for
+     * horizontal sliders. The graphics have been translated to labelRect.y
+     * already.
+     *
+     * @param g the graphics context in which to paint
+     * @param value the value of the slider
+     * @param label the component label in the label table that needs to be
+     * painted
      * @see JSlider#setLabelTable
      */
     protected void paintHorizontalLabel( Graphics g, int value, Component label ) {
@@ -1179,8 +1198,14 @@
     }
 
     /**
-     * Called for every label in the label table.  Used to draw the labels for vertical sliders.
-     * The graphics have been translated to labelRect.x already.
+     * Called for every label in the label table. Used to draw the labels for
+     * vertical sliders. The graphics have been translated to labelRect.x
+     * already.
+     *
+     * @param g the graphics context in which to paint
+     * @param value the value of the slider
+     * @param label the component label in the label table that needs to be
+     * painted
      * @see JSlider#setLabelTable
      */
     protected void paintVerticalLabel( Graphics g, int value, Component label ) {
@@ -1342,9 +1367,12 @@
     }
 
     /**
-     * This function is called when a mousePressed was detected in the track, not
-     * in the thumb.  The default behavior is to scroll by block.  You can
-     *  override this method to stop it from scrolling or to add additional behavior.
+     * This function is called when a mousePressed was detected in the track,
+     * not in the thumb. The default behavior is to scroll by block. You can
+     * override this method to stop it from scrolling or to add additional
+     * behavior.
+     *
+     * @param dir the direction and number of blocks to scroll
      */
     protected void scrollDueToClickInTrack( int dir ) {
         scrollByBlock( dir );
@@ -1387,6 +1415,7 @@
      * @param value the slider value to get the location for
      * @param trackY y-origin of the track
      * @param trackHeight the height of the track
+     * @return the y location for the specified value of the slider
      * @since 1.6
      */
     protected int yPositionForValue(int value, int trackY, int trackHeight) {
@@ -1417,6 +1446,9 @@
      * track at the the bottom or the top, this method sets the value to either
      * the minimum or maximum value of the slider, depending on if the slider
      * is inverted or not.
+     *
+     * @param yPos the location of the slider along the y axis
+     * @return the value at the y position
      */
     public int valueForYPosition( int yPos ) {
         int value;
@@ -1449,6 +1481,9 @@
      * track at the left or the right, this method sets the value to either the
      * minimum or maximum value of the slider, depending on if the slider is
      * inverted or not.
+     *
+     * @param xPos the location of the slider along the x axis
+     * @return the value of the x position
      */
     public int valueForXPosition( int xPos ) {
         int value;
--- a/jdk/src/share/classes/javax/swing/plaf/basic/BasicTabbedPaneUI.java	Mon Jul 28 19:11:52 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/basic/BasicTabbedPaneUI.java	Tue Jul 29 12:45:24 2014 +0400
@@ -1174,6 +1174,16 @@
       * this function draws the border around each tab
       * note that this function does now draw the background of the tab.
       * that is done elsewhere
+      *
+      * @param g             the graphics context in which to paint
+      * @param tabPlacement  the placement (left, right, bottom, top) of the tab
+      * @param tabIndex      the index of the tab with respect to other tabs
+      * @param x             the x coordinate of tab
+      * @param y             the y coordinate of tab
+      * @param w             the width of the tab
+      * @param h             the height of the tab
+      * @param isSelected    a {@code boolean} which determines whether or not
+      * the tab is selected
       */
     protected void paintTabBorder(Graphics g, int tabPlacement,
                                   int tabIndex,