Author: rwhitcomb
Date: Mon Aug 10 20:30:43 2015
New Revision: 1695162
URL: http://svn.apache.org/r1695162
Log:
PIVOT-976: Some Javadoc fixes (according to Java 8). Some of the files that
have only
a few warnings (although the tool stops listing at 100 warnings, so there are
still an
unknown number to be found).
Modified:
pivot/trunk/core/src/org/apache/pivot/collections/List.java
pivot/trunk/core/src/org/apache/pivot/collections/Map.java
pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Skin.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java
pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
Modified: pivot/trunk/core/src/org/apache/pivot/collections/List.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/List.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/List.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/List.java Mon Aug 10
20:30:43 2015
@@ -150,6 +150,7 @@ public interface List<T> extends Sequenc
/**
* Returns the list listener list.
+ * @return The list of listeners for this list.
*/
public ListenerList<ListListener<T>> getListListeners();
}
Modified: pivot/trunk/core/src/org/apache/pivot/collections/Map.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/Map.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/Map.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/Map.java Mon Aug 10
20:30:43 2015
@@ -93,6 +93,7 @@ public interface Map<K, V> extends Dicti
/**
* Returns the number of entries in the map.
+ * @return Current number of map entries.
*/
public int getCount();
@@ -104,6 +105,7 @@ public interface Map<K, V> extends Dicti
/**
* Returns the map listener collection.
+ * @return Current list of listeners on this map.
*/
public ListenerList<MapListener<K, V>> getMapListeners();
}
Modified: pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java (original)
+++ pivot/trunk/core/src/org/apache/pivot/collections/Sequence.java Mon Aug 10
20:30:43 2015
@@ -528,6 +528,7 @@ public interface Sequence<T> {
* Retrieves the item at the given index.
*
* @param index The index of the item to retrieve.
+ * @return The item at this index in the sequence.
*/
public T get(int index);
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/ConstrainedVisual.java Mon Aug 10
20:30:43 2015
@@ -23,8 +23,8 @@ public interface ConstrainedVisual exten
/**
* Sets the visual's render size.
*
- * @param width
- * @param height
+ * @param width The visual's new width.
+ * @param height The visual's new height.
*/
public void setSize(int width, int height);
@@ -34,6 +34,7 @@ public interface ConstrainedVisual exten
*
* @param height The height by which to constrain the preferred width, or
* <tt>-1</tt> for no constraint.
+ * @return The preferred width given the height constraint.
*/
public int getPreferredWidth(int height);
@@ -43,19 +44,21 @@ public interface ConstrainedVisual exten
*
* @param width The width by which to constrain the preferred height, or
* <tt>-1</tt> for no constraint.
+ * @return The preferred height given the width constraint.
*/
public int getPreferredHeight(int width);
/**
* Returns the visual's unconstrained preferred size.
+ * @return The unconstrained preferred size for this component.
*/
public Dimensions getPreferredSize();
/**
* Returns the baseline for a given width and height.
*
- * @param width
- * @param height
+ * @param width Constrained width to compute the baseline for.
+ * @param height Constrained height to compute the baseline for.
* @return The baseline relative to the origin of this visual, or
<tt>-1</tt>
* if this visual does not have a baseline.
*/
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Skin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Skin.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Skin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Skin.java Mon Aug 10 20:30:43 2015
@@ -52,6 +52,7 @@ public interface Skin extends Constraine
/**
* Returns the component with which a skin is associated.
+ * @return This skin's associated component.
*/
public Component getComponent();
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/Visual.java Mon Aug 10 20:30:43
2015
@@ -25,11 +25,13 @@ import java.awt.Graphics2D;
public interface Visual {
/**
* Returns the visual's width.
+ * @return Current width of this visual.
*/
public int getWidth();
/**
* Returns the visual's height.
+ * @return Current height of this visual.
*/
public int getHeight();
Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java
URL:
http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java?rev=1695162&r1=1695161&r2=1695162&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/ComponentSkin.java Mon Aug 10
20:30:43 2015
@@ -387,6 +387,7 @@ public abstract class ComponentSkin impl
* @param value Either a JSON dictionary {@link Theme#deriveFont describing
* a font relative to the current theme}, or one of the
* {@link Font#decode(String) standard Java font specifications}.
+ * @return The font corresponding to the specification.
*/
public static Font decodeFont(String value) {
Font font;
