8044276: Fix doclint warnings (missing javadoc tags) in javax.swing.plaf.synth
Reviewed-by: alexsch
Contributed-by: Rocky Sloan <rocky.sloan@oracle.com>
--- a/jdk/src/share/classes/javax/swing/plaf/synth/SynthButtonUI.java Thu Jun 26 15:58:06 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/synth/SynthButtonUI.java Thu Jun 26 15:59:57 2014 +0400
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2002, 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
@@ -513,6 +513,13 @@
/**
* Returns the Icon used in calculating the
* preferred/minimum/maximum size.
+ *
+ * @param b specifies the {@code AbstractButton}
+ * used when calculating the preferred/minimum/maximum
+ * size.
+ *
+ * @return the Icon used in calculating the
+ * preferred/minimum/maximum size.
*/
protected Icon getSizingIcon(AbstractButton b) {
Icon icon = getEnabledIcon(b, b.getIcon());
--- a/jdk/src/share/classes/javax/swing/plaf/synth/SynthGraphicsUtils.java Thu Jun 26 15:58:06 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/synth/SynthGraphicsUtils.java Thu Jun 26 15:59:57 2014 +0400
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2002, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2002, 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
@@ -137,6 +137,9 @@
* @param iconR Rectangle to place icon bounds in
* @param textR Rectangle to place text in
* @param iconTextGap gap between icon and text
+ *
+ * @return by reference, the location to
+ * place the icon and text.
*/
public String layoutText(SynthContext ss, FontMetrics fm,
String text, Icon icon, int hAlign,
@@ -166,6 +169,8 @@
* @param font Font to use
* @param metrics FontMetrics, may be ignored
* @param text Text to get size of.
+ *
+ * @return the size of the passed in string.
*/
public int computeStringWidth(SynthContext ss, Font font,
FontMetrics metrics, String text) {
@@ -187,6 +192,8 @@
* @param iconTextGap gap between icon and text
* @param mnemonicIndex Index into text to render the mnemonic at, -1
* indicates no mnemonic.
+ *
+ * @return the minimum size needed to properly render an icon and text.
*/
public Dimension getMinimumSize(SynthContext ss, Font font, String text,
Icon icon, int hAlign, int vAlign, int hTextPosition,
@@ -218,6 +225,8 @@
* @param iconTextGap gap between icon and text
* @param mnemonicIndex Index into text to render the mnemonic at, -1
* indicates no mnemonic.
+ *
+ * @return the maximum size needed to properly render an icon and text.
*/
public Dimension getMaximumSize(SynthContext ss, Font font, String text,
Icon icon, int hAlign, int vAlign, int hTextPosition,
@@ -263,6 +272,8 @@
* @param iconTextGap gap between icon and text
* @param mnemonicIndex Index into text to render the mnemonic at, -1
* indicates no mnemonic.
+ *
+ * @return the preferred size needed to properly render an icon and text.
*/
public Dimension getPreferredSize(SynthContext ss, Font font, String text,
Icon icon, int hAlign, int vAlign, int hTextPosition,
--- a/jdk/src/share/classes/javax/swing/plaf/synth/SynthSeparatorUI.java Thu Jun 26 15:58:06 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/plaf/synth/SynthSeparatorUI.java Thu Jun 26 15:59:57 2014 +0400
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2002, 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
@@ -78,6 +78,9 @@
/**
* Installs default setting. This method is called when a
* {@code LookAndFeel} is installed.
+ *
+ * @param c specifies the {@code JSeparator} for the installed
+ * {@code LookAndFeel}.
*/
public void installDefaults(JSeparator c) {
updateStyle(c);
@@ -109,6 +112,9 @@
/**
* Uninstalls default setting. This method is called when a
* {@code LookAndFeel} is uninstalled.
+ *
+ * @param c specifies the {@code JSeparator} for the (un)installed
+ * {@code LookAndFeel}.
*/
public void uninstallDefaults(JSeparator c) {
SynthContext context = getContext(c, ENABLED);
@@ -121,6 +127,9 @@
/**
* Installs listeners. This method is called when a
* {@code LookAndFeel} is installed.
+ *
+ * @param c specifies the {@code JSeparator} for the installed
+ * {@code LookAndFeel}.
*/
public void installListeners(JSeparator c) {
c.addPropertyChangeListener(this);
@@ -129,6 +138,9 @@
/**
* Uninstalls listeners. This method is called when a
* {@code LookAndFeel} is uninstalled.
+ *
+ * @param c specifies the {@code JSeparator} for the (un)installed
+ * {@code LookAndFeel}.
*/
public void uninstallListeners(JSeparator c) {
c.removePropertyChangeListener(this);