8077036: swing docs: fix some tidy warnings
Summary: minor fixes for docs
Reviewed-by: alexsch
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifBorders.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifBorders.java Wed Jun 03 18:39:26 2015 +0400
@@ -41,7 +41,7 @@
import java.awt.Rectangle;
/**
- * Factory object that can vend Icons appropriate for the basic L & F.
+ * Factory object that can vend Icons appropriate for the basic {@literal L & F}.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifButtonListener.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifButtonListener.java Wed Jun 03 18:39:26 2015 +0400
@@ -34,7 +34,6 @@
/**
* Button Listener
- * <p>
*
* @author Rich Schiavi
*/
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifCheckBoxMenuItemUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifCheckBoxMenuItemUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -37,7 +37,6 @@
/**
* MotifCheckboxMenuItem implementation
- * <p>
*
* @author Georges Saab
* @author Rich Schiavi
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifComboBoxUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifComboBoxUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -35,7 +35,8 @@
/**
* ComboBox motif look and feel
- * <p> * <strong>Warning:</strong>
+ * <p>
+ * <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
* future Swing releases. The current serialization support is appropriate
* for short term storage or RMI between applications running the same
@@ -261,9 +262,9 @@
}
/**
- * This inner class is marked "public" due to a compiler bug.
- * This class should be treated as a "protected" inner class.
- * Instantiate it only within subclasses of <FooUI>.
+ * This inner class is marked "public" due to a compiler bug.
+ * This class should be treated as a "protected" inner class.
+ * Instantiate it only within subclasses of {@code <FooUI>}.
*/
public class ComboBoxLayoutManager extends BasicComboBoxUI.ComboBoxLayoutManager {
public ComboBoxLayoutManager() {
@@ -344,7 +345,7 @@
}
/**
- * This class should be made "protected" in future releases.
+ * This class should be made "protected" in future releases.
*/
private class MotifPropertyChangeListener
extends BasicComboBoxUI.PropertyChangeHandler {
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifInternalFrameUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifInternalFrameUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -38,7 +38,7 @@
/**
- * A Motif L&F implementation of InternalFrame.
+ * A Motif {@literal L&F} implementation of InternalFrame.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifLabelUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifLabelUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -32,7 +32,7 @@
import javax.swing.plaf.ComponentUI;
/**
- * A Motif L&F implementation of LabelUI.
+ * A Motif {@literal L&F} implementation of LabelUI.
* This merely sets up new default values in MotifLookAndFeel.
* <p>
* <strong>Warning:</strong>
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifMenuBarUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifMenuBarUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -45,7 +45,7 @@
import javax.swing.plaf.basic.*;
/**
- * A Windows L&F implementation of MenuBarUI. This implementation
+ * A Windows {@literal L&F} implementation of MenuBarUI. This implementation
* is a "combined" view/controller.
* <p>
* <strong>Warning:</strong>
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifMenuItemUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifMenuItemUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -37,7 +37,6 @@
/**
* MotifMenuItem implementation
- * <p>
*
* @author Rich Schiavi
* @author Georges Saab
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifMenuUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifMenuUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -36,8 +36,7 @@
import javax.swing.plaf.basic.BasicMenuUI;
/**
- * A Motif L&F implementation of MenuUI.
- * <p>
+ * A Motif {@literal L&F} implementation of MenuUI.
*
* @author Georges Saab
* @author Rich Schiavi
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifPopupMenuSeparatorUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifPopupMenuSeparatorUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -34,8 +34,8 @@
import javax.swing.plaf.*;
/**
- * A Motif L&F implementation of PopupMenuSeparatorUI. This implementation
- * is a "combined" view/controller.
+ * A Motif {@literal L&F} implementation of PopupMenuSeparatorUI.
+ * This implementation is a "combined" view/controller.
*
* @author Jeff Shapiro
*/
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifPopupMenuUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifPopupMenuUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -47,7 +47,7 @@
/**
- * A Motif L&F implementation of PopupMenuUI.
+ * A Motif {@literal L&F} implementation of PopupMenuUI.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifScrollPaneUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifScrollPaneUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -34,7 +34,7 @@
import java.beans.PropertyChangeListener;
/**
- * A CDE/Motif L&F implementation of ScrollPaneUI.
+ * A CDE/Motif {@code L&F} implementation of ScrollPaneUI.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifSeparatorUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifSeparatorUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -35,8 +35,8 @@
import javax.swing.plaf.basic.BasicSeparatorUI;
/**
- * A Motif L&F implementation of SeparatorUI. This implementation
- * is a "combined" view/controller.
+ * A Motif {@literal L&F} implementation of SeparatorUI.
+ * This implementation is a "combined" view/controller.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifTabbedPaneUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/motif/MotifTabbedPaneUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -34,7 +34,7 @@
import java.io.Serializable;
/**
- * A Motif L&F implementation of TabbedPaneUI.
+ * A Motif {@literal L&F} implementation of TabbedPaneUI.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/DesktopProperty.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/DesktopProperty.java Wed Jun 03 18:39:26 2015 +0400
@@ -199,7 +199,7 @@
/**
* Requests that all components in the GUI hierarchy be updated
- * to reflect dynamic changes in this look&feel. This update occurs
+ * to reflect dynamic changes in this {@literal look&feel}. This update occurs
* by uninstalling and re-installing the UI objects. Requests are
* batched and collapsed into a single update pass because often
* many desktop properties will change at once.
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsBorders.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsBorders.java Wed Jun 03 18:39:26 2015 +0400
@@ -39,7 +39,7 @@
import static com.sun.java.swing.plaf.windows.XPStyle.Skin;
/**
- * Factory object that can vend Borders appropriate for the Windows 95 L & F.
+ * Factory object that can vend Borders appropriate for the Windows 95 {@literal L & F}.
* @author Rich Schiavi
*/
@@ -142,7 +142,7 @@
/**
* A border for the ToolBar. If the ToolBar is floatable then the handle grip is drawn
- * <p>
+ *
* @since 1.4
*/
@SuppressWarnings("serial") // Superclass is not serializable across versions
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsCheckBoxMenuItemUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsCheckBoxMenuItemUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -76,7 +76,7 @@
}
/**
* Method which renders the text of the current menu item.
- * <p>
+ *
* @param g Graphics context
* @param menuItem Current menu item to render
* @param textRect Bounding rectangle to render the text.
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsFileChooserUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsFileChooserUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -48,7 +48,7 @@
import javax.accessibility.*;
/**
- * Windows L&F implementation of a FileChooser.
+ * Windows {@literal L&F} implementation of a FileChooser.
*
* @author Jeff Dinkins
*/
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsGraphicsUtils.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsGraphicsUtils.java Wed Jun 03 18:39:26 2015 +0400
@@ -47,7 +47,7 @@
* Renders a text String in Windows without the mnemonic.
* This is here because the WindowsUI hierarchy doesn't match the Component hierarchy. All
* the overriden paintText methods of the ButtonUI delegates will call this static method.
- * <p>
+ *
* @param g Graphics context
* @param b Current button to render
* @param textRect Bounding rectangle to render the text.
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsIconFactory.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsIconFactory.java Wed Jun 03 18:39:26 2015 +0400
@@ -38,7 +38,7 @@
import sun.swing.MenuItemCheckIconFactory;
/**
- * Factory object that can vend Icons appropriate for the Windows L & F.
+ * Factory object that can vend Icons appropriate for the Windows {@literal L & F}.
* <p>
* <strong>Warning:</strong>
* Serialized objects of this class will not be compatible with
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsInternalFrameTitlePane.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsInternalFrameTitlePane.java Wed Jun 03 18:39:26 2015 +0400
@@ -503,7 +503,7 @@
private Icon[] icons;
/**
- * @params objects an array of Icon or UIDefaults.LazyValue
+ * @param objects an array of Icon or UIDefaults.LazyValue
* <p>
* The constructor is public so it can be called by UIDefaults.ProxyLazyValue.
*/
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsMenuItemUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsMenuItemUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -70,7 +70,7 @@
/**
* Method which renders the text of the current menu item.
- * <p>
+ *
* @param g Graphics context
* @param menuItem Current menu item to render
* @param textRect Bounding rectangle to render the text.
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsMenuUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsMenuUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -199,7 +199,7 @@
/**
* Method which renders the text of the current menu item.
- * <p>
+ *
* @param g Graphics context
* @param menuItem Current menu item to render
* @param textRect Bounding rectangle to render the text.
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsPopupMenuSeparatorUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsPopupMenuSeparatorUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -36,7 +36,7 @@
import com.sun.java.swing.plaf.windows.XPStyle.Skin;
/**
- * Windows L&F implementation of PopupMenuSeparatorUI.
+ * Windows {@literal L&F} implementation of PopupMenuSeparatorUI.
*
* @author Leif Samuelsson
* @author Igor Kushnirskiy
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsRadioButtonMenuItemUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsRadioButtonMenuItemUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -76,7 +76,7 @@
/**
* Method which renders the text of the current menu item.
- * <p>
+ *
* @param g Graphics context
* @param menuItem Current menu item to render
* @param textRect Bounding rectangle to render the text.
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsSeparatorUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsSeparatorUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -29,7 +29,5 @@
/**
* Windows Separator.
- * <p>
- *
*/
public class WindowsSeparatorUI extends BasicSeparatorUI { }
--- a/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsToolBarSeparatorUI.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/com/sun/java/swing/plaf/windows/WindowsToolBarSeparatorUI.java Wed Jun 03 18:39:26 2015 +0400
@@ -37,7 +37,6 @@
/**
* Draws Windows toolbar separators.
- * <p>
*
* @author Mark Davidson
*/
--- a/jdk/src/java.desktop/share/classes/javax/swing/Timer.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/javax/swing/Timer.java Wed Jun 03 18:39:26 2015 +0400
@@ -141,7 +141,7 @@
* has been added to the <code>java.beans</code> package.
* Please see {@link java.beans.XMLEncoder}.
*
- * @see java.util.Timer <code>java.util.Timer</code>
+ * @see java.util.Timer
*
*
* @author Dave Moore
--- a/jdk/src/java.desktop/share/classes/sun/swing/AccumulativeRunnable.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/sun/swing/AccumulativeRunnable.java Wed Jun 03 18:39:26 2015 +0400
@@ -49,10 +49,10 @@
* <p>
* Here is how one can do this using {@code AccumulativeRunnable}:
* <pre>
- * AccumulativeRunnable<String> doSetTextImpl =
- * new AccumulativeRunnable<String>() {
- * @Override
- * protected void run(List<String> args) {
+ * {@code AccumulativeRunnable<String> doSetTextImpl =
+ * new AccumulativeRunnable<String>()} {
+ * {@literal @Override}
+ * {@code protected void run(List<String> args)} {
* //set to the last string being passed
* setTextImpl(args.get(args.size() - 1));
* }
@@ -66,16 +66,16 @@
* <p>
* Say we want to implement addDirtyRegion(Rectangle rect)
* which sends this region to the
- * handleDirtyRegions(List<Rect> regiouns) on the EDT.
+ * {@code handleDirtyRegions(List<Rect> regiouns)} on the EDT.
* addDirtyRegions better be accumulated before handling on the EDT.
*
* <p>
* Here is how it can be implemented using AccumulativeRunnable:
* <pre>
- * AccumulativeRunnable<Rectangle> doHandleDirtyRegions =
- * new AccumulativeRunnable<Rectangle>() {
- * @Override
- * protected void run(List<Rectangle> args) {
+ * {@code AccumulativeRunnable<Rectangle> doHandleDirtyRegions =}
+ * {@code new AccumulativeRunnable<Rectangle>()} {
+ * {@literal @Override}
+ * {@code protected void run(List<Rectangle> args)} {
* handleDirtyRegions(args);
* }
* };
@@ -113,7 +113,7 @@
}
/**
- * appends arguments and sends this {@cod Runnable} for the
+ * appends arguments and sends this {@code Runnable} for the
* execution if needed.
* <p>
* This implementation uses {@see #submit} to send this
--- a/jdk/src/java.desktop/share/classes/sun/swing/PrintColorUIResource.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/sun/swing/PrintColorUIResource.java Wed Jun 03 18:39:26 2015 +0400
@@ -72,7 +72,7 @@
* manager. When access is disallowed, deserialization of any object
* with reference to a {@code PrintColorUIResource} fails.
* <p>
- * Since {@code PrintColorUIResource) is used only by Swing's look
+ * Since {@code PrintColorUIResource} is used only by Swing's look
* and feels, and we know that UI supplied colors are replaced after
* deserialization when the UI is re-installed, the only important
* aspect of the {@code PrintColorUIResource} that needs to be
--- a/jdk/src/java.desktop/share/classes/sun/swing/PrintingStatus.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/sun/swing/PrintingStatus.java Wed Jun 03 18:39:26 2015 +0400
@@ -40,7 +40,7 @@
/**
* The {@code PrintingStatus} provides a dialog that displays progress
* of the printing job and provides a way to abort it
- * <p/>
+ * <p>
* Methods of these class are thread safe, although most Swing methods
* are not. Please see
* <A HREF="http://docs.oracle.com/javase/tutorial/uiswing/concurrency/index.html">Concurrency
--- a/jdk/src/java.desktop/share/classes/sun/swing/SwingUtilities2.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/sun/swing/SwingUtilities2.java Wed Jun 03 18:39:26 2015 +0400
@@ -662,7 +662,8 @@
* Point is within the actual bounds of a list item (not just in the cell)
* and if the JList has the "List.isFileList" client property set.
* Otherwise, this method returns -1.
- * This is used to make WindowsL&F JFileChooser act like native dialogs.
+ * This is used to make Windows {@literal L&F} JFileChooser act
+ * like native dialogs.
*/
public static int loc2IndexFileList(JList<?> list, Point point) {
int index = list.locationToIndex(point);
@@ -703,7 +704,8 @@
* item at the given row of the table. (Column must be 0).
* Does not check the "Table.isFileList" property. That should be checked
* before calling this method.
- * This is used to make WindowsL&F JFileChooser act like native dialogs.
+ * This is used to make Windows {@literal L&F} JFileChooser act
+ * like native dialogs.
*/
public static boolean pointOutsidePrefSize(JTable table, int row, int column, Point p) {
if (table.convertColumnIndexToModel(column) != 0 || row == -1) {
--- a/jdk/src/java.desktop/share/classes/sun/swing/UIClientPropertyKey.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/sun/swing/UIClientPropertyKey.java Wed Jun 03 18:39:26 2015 +0400
@@ -27,7 +27,7 @@
/**
* This interface is used only for tagging keys for client properties
- * for {@code JComponent} set by UI which needs to be cleared on L&F
+ * for {@code JComponent} set by UI which needs to be cleared on {@literal L&F}
* change and serialization.
*
* All such keys are removed from client properties in {@code
--- a/jdk/src/java.desktop/share/classes/sun/swing/WindowsPlacesBar.java Wed Jun 03 15:21:35 2015 +0300
+++ b/jdk/src/java.desktop/share/classes/sun/swing/WindowsPlacesBar.java Wed Jun 03 18:39:26 2015 +0400
@@ -43,7 +43,6 @@
* <b>WARNING:</b> This class is an implementation detail and is only
* public so that it can be used by two packages. You should NOT consider
* this public API.
- * <p>
*
* @author Leif Samuelsson
*/