You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pivot.apache.org by rw...@apache.org on 2016/05/24 21:29:50 UTC

svn commit: r1745405 - in /pivot/trunk: wtk-terra/src/org/apache/pivot/wtk/skin/terra/ wtk/src/org/apache/pivot/wtk/ wtk/src/org/apache/pivot/wtk/skin/ wtk/src/org/apache/pivot/wtk/text/ wtk/src/org/apache/pivot/wtk/validation/

Author: rwhitcomb
Date: Tue May 24 21:29:50 2016
New Revision: 1745405

URL: http://svn.apache.org/viewvc?rev=1745405&view=rev
Log:
PIVOT-976: More Javadoc fixes for the warnings from Java 8.

This is the LAST!  All the remaining warnings have been removed.

NOTE: this does NOT mean that all the Javadoc is correct, complete, informative,
helpful, or otherwise as good as it could be.  All this means is that the
Javadoc processor no longer complains about it when you run "ant doc".


Modified:
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
    pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/DropTarget.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinSpanView.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinTextNodeView.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BlockListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java
    pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/Validator.java

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraFileBrowserSkin.java Tue May 24 21:29:50 2016
@@ -133,9 +133,9 @@ public class TerraFileBrowserSkin extend
         }
 
         /**
-         * Obtains the icon to display for a given file.
+         * @return The icon to display for a given file.
          *
-         * @param file
+         * @param file The current file.
          */
         public static Image getIcon(File file) {
             Image icon;
@@ -564,7 +564,9 @@ public class TerraFileBrowserSkin extend
     }
 
     /**
-     * File comparator.
+     * @return A new file comparator for the given column and direction.
+     * @param columnName The column name to sort on.
+     * @param sortDirection Ascending or Descending sort order.
      */
     public static FileComparator getFileComparator(String columnName, SortDirection sortDirection) {
         if (columnName.equals("name")) {

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTabPaneSkin.java Tue May 24 21:29:50 2016
@@ -1479,7 +1479,7 @@ public class TerraTabPaneSkin extends Ta
      * CommandModifier + {@link KeyCode#KEYPAD_1 KEYPAD_1} to
      * {@link KeyCode#KEYPAD_9 KEYPAD_9}<br>or CommandModifier +
      * {@link KeyCode#N1 1} to {@link KeyCode#N9 9} Select the (enabled) tab at
-     * index 0 to 8 respectively<p>
+     * index 0 to 8 respectively.
      *
      * @see Platform#getCommandModifier()
      */

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTableViewSkin.java Tue May 24 21:29:50 2016
@@ -1143,7 +1143,7 @@ public class TerraTableViewSkin extends
     }
 
     /**
-     * Is this {@link TableView} going into edit mode on a mouse down or
+     * @return Is this {@link TableView} going into edit mode on a mouse down or
      * on a mouse double click?
      */
     public boolean isEditOnMouseDown() {
@@ -1155,6 +1155,7 @@ public class TerraTableViewSkin extends
      * on a mouse double click (the default).
      * <p> Setting this to <tt>true</tt> can reduce the number of mouse clicks
      * necessary to rapidly edit a table view.
+     * @param editOnMouseDown The new setting.
      */
     public void setEditOnMouseDown(boolean editOnMouseDown) {
         this.editOnMouseDown = editOnMouseDown;

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTheme.java Tue May 24 21:29:50 2016
@@ -482,7 +482,8 @@ public final class TerraTheme extends Th
      * Gets the image that this theme uses to represent messages of the
      * specified type.
      *
-     * @param messageType
+     * @param messageType The desired message type.
+     * @return The icon image for this message type.
      */
     public Image getMessageIcon(MessageType messageType) {
         return messageIcons.get(messageType);
@@ -492,8 +493,8 @@ public final class TerraTheme extends Th
      * Sets the image that this theme uses to represent messages of the
      * specified type.
      *
-     * @param messageType
-     * @param messageIcon
+     * @param messageType The message type to change.
+     * @param messageIcon The new icon image for this type.
      */
     public void setMessageIcon(MessageType messageType, Image messageIcon) {
         if (messageType == null || messageIcon == null) {
@@ -507,7 +508,8 @@ public final class TerraTheme extends Th
      * Gets the small image that this theme uses to represent messages of the
      * specified type.
      *
-     * @param messageType
+     * @param messageType The message type to query.
+     * @return The small image.
      */
     public Image getSmallMessageIcon(MessageType messageType) {
         return smallMessageIcons.get(messageType);
@@ -517,8 +519,8 @@ public final class TerraTheme extends Th
      * Sets the small image that this theme uses to represent messages of the
      * specified type.
      *
-     * @param messageType
-     * @param smallMessageIcon
+     * @param messageType      The message type to change.
+     * @param smallMessageIcon The new small icon for this type.
      */
     public void setSmallMessageIcon(MessageType messageType, Image smallMessageIcon) {
         if (messageType == null || smallMessageIcon == null) {
@@ -531,7 +533,7 @@ public final class TerraTheme extends Th
     /**
      * Gets the theme's default background color.
      *
-     * @return the color if set, or White if the theme is not dark (default), or Black.
+     * @return The color if set, or White if the theme is not dark (default), or Black.
      */
     @Override
     public Color getDefaultBackgroundColor() {
@@ -541,7 +543,7 @@ public final class TerraTheme extends Th
     /**
      * Gets the theme's default foreground color.
      *
-     * @return the color if set, or Black if the theme is not dark (default), or White.
+     * @return The color if set, or Black if the theme is not dark (default), or White.
      */
     @Override
     public Color getDefaultForegroundColor() {
@@ -549,10 +551,11 @@ public final class TerraTheme extends Th
     }
 
     /**
-     * Returns a brighter version of the specified color. Specifically, it
+     * @return A brighter version of the specified color. Specifically, it
      * increases the brightness (in the HSB color model) by the
      * <tt>colorMultiplier</tt> factor and <tt>themeIsDark</tt> flag already
      * set.
+     * @param color The color to brighten.
      */
     public static Color brighten(Color color) {
         if (!themeIsDark) {
@@ -562,9 +565,10 @@ public final class TerraTheme extends Th
     }
 
     /**
-     * Returns a darker version of the specified color. Specifically, it
+     * @return A darker version of the specified color. Specifically, it
      * decreases the brightness (in the HSB color model) by the
      * <tt>colorMultiplier</tt> factor and <tt>themeDark</tt> flag already set.
+     * @param color The color to darken.
      */
     public static Color darken(Color color) {
         if (!themeIsDark) {

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraTreeViewSkin.java Tue May 24 21:29:50 2016
@@ -151,7 +151,7 @@ public class TerraTreeViewSkin extends C
         /**
          * This operation is not supported by this iterator.
          *
-         * @throws UnsupportedOperationException
+         * @throws UnsupportedOperationException always since this is unsupported.
          */
         @Override
         public void remove() {
@@ -1207,7 +1207,7 @@ public class TerraTreeViewSkin extends C
     }
 
     /**
-     * Gets the fixed node height of this skin.
+     * @return The fixed node height of this skin.
      */
     protected int getNodeHeight() {
         TreeView treeView = (TreeView) getComponent();
@@ -1225,8 +1225,9 @@ public class TerraTreeViewSkin extends C
     }
 
     /**
-     * Gets the metadata associated with the node found at the specified
+     * @return The metadata associated with the node found at the specified
      * y-coordinate, or <tt>null</tt> if there is no node at that location.
+     * @param y The current Y location.
      */
     protected final NodeInfo getNodeInfoAt(int y) {
         NodeInfo nodeInfo = null;
@@ -1242,9 +1243,10 @@ public class TerraTreeViewSkin extends C
     }
 
     /**
-     * Gets the metadata associated with the node at the specified path. The
+     * @return The metadata associated with the node at the specified path. The
      * path must be valid. The empty path is supported and represents the root
      * node info.
+     * @param path The path to query.
      */
     protected final NodeInfo getNodeInfoAt(Path path) {
         assert (path != null) : "Path is null";
@@ -1275,8 +1277,9 @@ public class TerraTreeViewSkin extends C
     }
 
     /**
-     * Gets the bounding box defined by the specified node, or <tt>null</tt> if
+     * @return The bounding box defined by the specified node, or <tt>null</tt> if
      * the node is not currently visible.
+     * @param nodeInfo The node information to search for.
      */
     protected final Bounds getNodeBounds(NodeInfo nodeInfo) {
         Bounds bounds = null;
@@ -1471,6 +1474,8 @@ public class TerraTreeViewSkin extends C
 
     /**
      * Repaints the region occupied by the specified node.
+     *
+     * @param nodeInfo The node to search for.
      */
     protected void repaintNode(NodeInfo nodeInfo) {
         Bounds bounds = getNodeBounds(nodeInfo);

Modified: pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java (original)
+++ pivot/trunk/wtk-terra/src/org/apache/pivot/wtk/skin/terra/TerraVFSBrowserSkin.java Tue May 24 21:29:50 2016
@@ -143,9 +143,9 @@ public class TerraVFSBrowserSkin extends
         }
 
         /**
-         * Obtains the icon to display for a given file.
+         * @return The icon to display for a given file.
          *
-         * @param file
+         * @param file The current file.
          */
         public Image getIcon(FileObject file) {
             Image icon;
@@ -661,7 +661,9 @@ public class TerraVFSBrowserSkin extends
     }
 
     /**
-     * FileObject comparator.
+     * @return A new {@link FileObject} comparator for the given column and sort order.
+     * @param columnName Name of the column to sort on.
+     * @param sortDirection The sort order.
      */
     public static FileComparator getFileComparator(String columnName, SortDirection sortDirection) {
         if (columnName.equals("name")) {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/DropTarget.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/DropTarget.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/DropTarget.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/DropTarget.java Tue May 24 21:29:50 2016
@@ -23,10 +23,10 @@ public interface DropTarget {
     /**
      * Called when the mouse first enters a drop target during a drag operation.
      *
-     * @param component
-     * @param dragContent
-     * @param supportedDropActions
-     * @param userDropAction
+     * @param component            The drop target component.
+     * @param dragContent          What is being dragged.
+     * @param supportedDropActions What drop actions should be considered.
+     * @param userDropAction       What drop action the user is requesting.
      * @return The drop action that would result if the user dropped the item at
      * this location, or <tt>null</tt> if the target cannot accept the drop.
      */
@@ -36,7 +36,7 @@ public interface DropTarget {
     /**
      * Called when the mouse leaves a drop target during a drag operation.
      *
-     * @param component
+     * @param component The drop target component.
      */
     public void dragExit(Component component);
 
@@ -44,12 +44,12 @@ public interface DropTarget {
      * Called when the mouse is moved while positioned over a drop target during
      * a drag operation.
      *
-     * @param component
-     * @param dragContent
-     * @param supportedDropActions
-     * @param x
-     * @param y
-     * @param userDropAction
+     * @param component            The drop target component.
+     * @param dragContent          What is being dragged.
+     * @param supportedDropActions The drop actions that are supported by the contents.
+     * @param x                    The current mouse X-location.
+     * @param y                    The current mouse Y-location.
+     * @param userDropAction       What drop action the user is requesting.
      * @return The drop action that would result if the user dropped the item at
      * this location, or <tt>null</tt> if the target cannot accept the drop.
      */
@@ -60,12 +60,12 @@ public interface DropTarget {
      * Called when the user drop action changes while the mouse is positioned
      * over a drop target during a drag operation.
      *
-     * @param component
-     * @param dragContent
-     * @param supportedDropActions
-     * @param x
-     * @param y
-     * @param userDropAction
+     * @param component            The drop target component.
+     * @param dragContent          What is being dragged.
+     * @param supportedDropActions The drop actions that are supported by the contents.
+     * @param x                    The current mouse X-location.
+     * @param y                    The current mouse Y-location.
+     * @param userDropAction       What drop action the user is requesting.
      * @return The drop action that would result if the user dropped the item at
      * this location, or <tt>null</tt> if the target cannot accept the drop.
      */
@@ -75,12 +75,12 @@ public interface DropTarget {
     /**
      * Called to drop the drag content.
      *
-     * @param component
-     * @param dragContent
-     * @param supportedDropActions
-     * @param x
-     * @param y
-     * @param userDropAction
+     * @param component            The drop target component.
+     * @param dragContent          What is being dragged.
+     * @param supportedDropActions The drop actions that are supported by the contents.
+     * @param x                    The current mouse X-location.
+     * @param y                    The current mouse Y-location.
+     * @param userDropAction       What drop action the user is requesting.
      * @return The drop action used to perform the drop, or <tt>null</tt> if the
      * target rejected the drop.
      */

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinSpanView.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinSpanView.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinSpanView.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinSpanView.java Tue May 24 21:29:50 2016
@@ -75,8 +75,10 @@ class TextPaneSkinSpanView extends TextP
     }
 
     /**
-     * Used by TextPaneSkinParagraphView when it breaks child nodes into
+     * Used by {@link TextPaneSkinParagraphView} when it breaks child nodes into
      * multiple views.
+     *
+     * @return The next text node view within the document.
      */
     public TextPaneSkinTextNodeView getNext() {
         if (getLength() == 0) {
@@ -125,4 +127,4 @@ class TextPaneSkinSpanView extends TextP
         }
     }
 
-}
\ No newline at end of file
+}

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinTextNodeView.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinTextNodeView.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinTextNodeView.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/skin/TextPaneSkinTextNodeView.java Tue May 24 21:29:50 2016
@@ -325,8 +325,10 @@ class TextPaneSkinTextNodeView extends T
     }
 
     /**
-     * Used by TextPaneSkinParagraphView when it breaks child nodes into
+     * Used by {@link TextPaneSkinParagraphView} when it breaks child nodes into
      * multiple views.
+     *
+     * @return The next node view in the document.
      */
     public TextPaneSkinNodeView getNext() {
         return next;
@@ -503,4 +505,4 @@ class TextPaneSkinTextNodeView extends T
         String text = textNode.getText();
         return "[" + text.substring(start, start + length) + "]";
     }
-}
\ No newline at end of file
+}

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BlockListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BlockListener.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BlockListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BlockListener.java Tue May 24 21:29:50 2016
@@ -34,8 +34,8 @@ public interface BlockListener {
     /**
      * Called when the horizontal alignment has changed.
      *
-     * @param block
-     * @param previousHorizontalAlignment
+     * @param block                       The text block in question.
+     * @param previousHorizontalAlignment The previous alignment value.
      */
     public void horizontalAlignmentChanged(Block block,
         HorizontalAlignment previousHorizontalAlignment);

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/BulletedListListener.java Tue May 24 21:29:50 2016
@@ -31,8 +31,8 @@ public interface BulletedListListener {
     /**
      * Called when the list style has changed.
      *
-     * @param bulletedList
-     * @param previousStyle
+     * @param bulletedList  The list whose style has changed.
+     * @param previousStyle The previous list style.
      */
     public void styleChanged(BulletedList bulletedList, BulletedList.Style previousStyle);
 }

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Element.java Tue May 24 21:29:50 2016
@@ -479,7 +479,7 @@ public abstract class Element extends No
     /**
      * Determines the index of the child node at a given offset.
      *
-     * @param offset
+     * @param offset The text offset to search for.
      * @return The index of the child node at the given offset.
      */
     public int getNodeAt(int offset) {
@@ -501,7 +501,7 @@ public abstract class Element extends No
     /**
      * Determines the path of the descendant node at a given offset.
      *
-     * @param offset
+     * @param offset The text offset to search for.
      * @return The path to the descendant node at the given offset.
      */
     public Sequence<Integer> getPathAt(int offset) {
@@ -525,7 +525,7 @@ public abstract class Element extends No
     /**
      * Determines the descendant node at a given offset.
      *
-     * @param offset
+     * @param offset The text offset to search for.
      * @return The descendant node at the given offset.
      */
     public Node getDescendantAt(int offset) {
@@ -618,7 +618,7 @@ public abstract class Element extends No
     }
 
     /**
-     * Gets the currently foreground color, or <tt>null</tt> if no color is
+     * @return The current foreground color, or <tt>null</tt> if no color is
      * foreground.
      */
     public Color getForegroundColor() {
@@ -629,7 +629,7 @@ public abstract class Element extends No
      * Sets the currently foreground color.
      *
      * @param foregroundColor The foreground color, or <tt>null</tt> to specify
-     * no selection
+     * no selection.
      */
     public void setForegroundColor(Color foregroundColor) {
         Color previousForegroundColor = this.foregroundColor;
@@ -641,9 +641,9 @@ public abstract class Element extends No
     }
 
     /**
-     * Sets the currently foreground color.
+     * Sets the current foreground color.
      *
-     * @param foregroundColor The foreground color
+     * @param foregroundColor The foreground color.
      */
     public void setForegroundColor(String foregroundColor) {
         if (foregroundColor == null) {
@@ -654,7 +654,7 @@ public abstract class Element extends No
     }
 
     /**
-     * Gets the currently background color, or <tt>null</tt> if no color is
+     * @return The current background color, or <tt>null</tt> if no color is
      * background.
      */
     public Color getBackgroundColor() {
@@ -662,10 +662,10 @@ public abstract class Element extends No
     }
 
     /**
-     * Sets the currently background color.
+     * Sets the current background color.
      *
      * @param backgroundColor The background color, or <tt>null</tt> to specify
-     * no selection
+     * no selection.
      */
     public void setBackgroundColor(Color backgroundColor) {
         Color previousBackgroundColor = this.backgroundColor;
@@ -677,9 +677,9 @@ public abstract class Element extends No
     }
 
     /**
-     * Sets the currently background color.
+     * Sets the current background color.
      *
-     * @param backgroundColor The background color
+     * @param backgroundColor The background color.
      */
     public void setBackgroundColor(String backgroundColor) {
         if (backgroundColor == null) {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/ElementListener.java Tue May 24 21:29:50 2016
@@ -66,55 +66,55 @@ public interface ElementListener {
     /**
      * Called when a node has been inserted into an element.
      *
-     * @param element
-     * @param index
+     * @param element The element that has changed.
+     * @param index   Where in the element's node sequence the new one was inserted.
      */
     public void nodeInserted(Element element, int index);
 
     /**
      * Called when nodes have been removed from an element.
      *
-     * @param element
-     * @param index
-     * @param nodes
+     * @param element The element that changed.
+     * @param index   The starting index of where nodes were removed.
+     * @param nodes   The actual sequence of removed nodes.
      */
     public void nodesRemoved(Element element, int index, Sequence<Node> nodes);
 
     /**
      * Called when the font has changed.
      *
-     * @param element
-     * @param previousFont
+     * @param element      The element that changed.
+     * @param previousFont What the font used to be.
      */
     public void fontChanged(Element element, java.awt.Font previousFont);
 
     /**
      * Called when the background color has changed.
      *
-     * @param element
-     * @param previousBackgroundColor
+     * @param element                 The element that changed.
+     * @param previousBackgroundColor What the background color was before the change.
      */
     public void backgroundColorChanged(Element element, Color previousBackgroundColor);
 
     /**
      * Called when the foreground color has changed.
      *
-     * @param element
-     * @param previousForegroundColor
+     * @param element                 The element whose color changed.
+     * @param previousForegroundColor The old foreground color.
      */
     public void foregroundColorChanged(Element element, Color previousForegroundColor);
 
     /**
      * Called when underline style has changed.
      *
-     * @param element
+     * @param element The element that changed.
      */
     public void underlineChanged(Element element);
 
     /**
      * Called when strikethrough style has changed.
      *
-     * @param element
+     * @param element The element that changed.
      */
     public void strikethroughChanged(Element element);
 }

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/Node.java Tue May 24 21:29:50 2016
@@ -117,6 +117,8 @@ public abstract class Node {
 
     /**
      * Set the offset of this node relative to its parent.
+     *
+     * @param offset The new offset for this node.
      */
     protected void setOffset(int offset) {
         int previousOffset = this.offset;
@@ -128,7 +130,7 @@ public abstract class Node {
     }
 
     /**
-     * Returns the node's offset within the document, which will be the
+     * @return The node's offset within the document, which will be the
      * offset of our parent (if any) added to our own offset.
      */
     public int getDocumentOffset() {
@@ -136,7 +138,7 @@ public abstract class Node {
     }
 
     /**
-     * Returns a {@link Span} that describes the content range of this node
+     * @return A {@link Span} that describes the content range of this node
      * relative to the whole document.
      */
     public Span getDocumentSpan() {
@@ -150,7 +152,7 @@ public abstract class Node {
      * Inserts a range into the node. Note that the contents of the range,
      * rather than the range itself, is added to the node.
      *
-     * @param range
+     * @param range The node containing the text to insert.
      * @param offsetArgument Offset relative to this node.
      */
     public abstract void insertRange(Node range, int offsetArgument);
@@ -159,7 +161,7 @@ public abstract class Node {
      * Removes a range from the node.
      *
      * @param offsetArgument Offset relative to this node.
-     * @param characterCount
+     * @param characterCount Count of characters to remove.
      * @return The removed range. This will be a copy of the node structure
      * relative to this node.
      */
@@ -169,8 +171,8 @@ public abstract class Node {
      * Replaces an existing range with a new range.
      *
      * @param offsetArgument Offset relative to this node.
-     * @param characterCount
-     * @param range
+     * @param characterCount Count of characters to replace.
+     * @param range The new range to insert.
      * @return The removed range. This will be a copy of the node structure
      * relative to this node.
      */
@@ -185,28 +187,29 @@ public abstract class Node {
      * Returns a range from the node.
      *
      * @param offsetArgument Offset relative to this node.
-     * @param characterCount
+     * @param characterCount Count of characters to get.
      * @return A node containing a copy of the node structure spanning the given
      * range, relative to this node.
      */
     public abstract Node getRange(int offsetArgument, int characterCount);
 
     /**
-     * Returns the character at the given offset.
+     * @return The character at the given offset.
      *
      * @param offsetArgument Offset relative to this node.
      */
     public abstract char getCharacterAt(int offsetArgument);
 
     /**
-     * Returns the number of characters in this node.
+     * @return The number of characters in this node.
      */
     public abstract int getCharacterCount();
 
     /**
      * Creates a copy of this node.
      *
-     * @param recursive
+     * @param recursive Whether to duplicate the children also.
+     * @return A copy of the current node.
      */
     public abstract Node duplicate(boolean recursive);
 
@@ -219,7 +222,7 @@ public abstract class Node {
      * Listeners for this node will just be given the offset relative to this node.
      *
      * @param offsetArgument Offset relative to this node.
-     * @param characterCount
+     * @param characterCount Count of characters inserted.
      */
     protected void rangeInserted(int offsetArgument, int characterCount) {
         if (parent != null) {
@@ -238,7 +241,7 @@ public abstract class Node {
      * Listeners for this node will just be given the offset relative to this node.
      *
      * @param offsetArgument Offset relative to this node.
-     * @param characterCount
+     * @param characterCount Count of characters removed.
      */
     protected void rangeRemoved(int offsetArgument, int characterCount) {
         if (parent != null) {
@@ -256,7 +259,7 @@ public abstract class Node {
      * Therefore the topmost node will be given the offset into the whole document.
      * Listeners for this node will just be given the offset relative to this node.
      *
-     * @param removed
+     * @param removed The actual sequence of nodes removed from here.
      * @param offsetArgument Offset relative to this node.
      */
     protected void nodesRemoved(Sequence<Node> removed, int offsetArgument) {
@@ -286,7 +289,7 @@ public abstract class Node {
     }
 
     /**
-     * Returns the node listener list.
+     * @return The node listener list.
      */
     public ListenerList<NodeListener> getNodeListeners() {
         return nodeListeners;

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NodeListener.java Tue May 24 21:29:50 2016
@@ -58,51 +58,51 @@ public interface NodeListener {
      * Called when a node's parent has changed, either as a result of being
      * added to or removed from an element.
      *
-     * @param node
-     * @param previousParent
+     * @param node           The node that moved.
+     * @param previousParent What the node's parent used to be.
      */
     public void parentChanged(Node node, Element previousParent);
 
     /**
-     * Called when a node's offset has changed within it's parent element.
+     * Called when a node's offset has changed within its parent element.
      *
-     * @param node
-     * @param previousOffset
+     * @param node           The node that has been updated.
+     * @param previousOffset The previous offset of this node.
      */
     public void offsetChanged(Node node, int previousOffset);
 
     /**
      * Called when a child node has been inserted into a node.
      *
-     * @param node
-     * @param offset
+     * @param node   The parent node that changed.
+     * @param offset The offset where the child node was inserted.
      */
     public void nodeInserted(Node node, int offset);
 
     /**
      * Called when child nodes have been removed from a node.
      *
-     * @param node
-     * @param removed
-     * @param offset
+     * @param node    The parent node.
+     * @param removed The sequence of child nodes that were removed.
+     * @param offset  The starting offset of the removed nodes.
      */
     public void nodesRemoved(Node node, Sequence<Node> removed, int offset);
 
     /**
      * Called when a text range has been inserted into a node.
      *
-     * @param node
-     * @param offset
-     * @param span
+     * @param node   The node where text was inserted.
+     * @param offset The starting offset of the insertion.
+     * @param span   Count of characters inserted.
      */
     public void rangeInserted(Node node, int offset, int span);
 
     /**
      * Called when a text range has been removed from a node.
      *
-     * @param node
-     * @param offset
-     * @param characterCount
+     * @param node           The node where text was removed.
+     * @param offset         Starting offset of the text removal.
+     * @param characterCount Count of characters removed.
      */
     public void rangeRemoved(Node node, int offset, int characterCount);
 }

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/NumberedListListener.java Tue May 24 21:29:50 2016
@@ -31,8 +31,8 @@ public interface NumberedListListener {
     /**
      * Called when the list style has changed.
      *
-     * @param numberedList
-     * @param previousStyle
+     * @param numberedList  The list whose style has changed.
+     * @param previousStyle The previous style for this list.
      */
     public void styleChanged(NumberedList numberedList, NumberedList.Style previousStyle);
 }

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNode.java Tue May 24 21:29:50 2016
@@ -26,7 +26,9 @@ public final class TextNode extends Node
     private static class TextNodeListenerList extends ListenerList<TextNodeListener> implements
         TextNodeListener {
         /**
-         * @param index Index into this node.
+         * @param textNode The text node that changed.
+         * @param index    Index into this node.
+         * @param count    Count of characters inserted here.
          */
         @Override
         public void charactersInserted(TextNode textNode, int index, int count) {
@@ -36,7 +38,9 @@ public final class TextNode extends Node
         }
 
         /**
-         * @param index Index into this node.
+         * @param textNode The text node that changed.
+         * @param index    Index into this node.
+         * @param count    Count of characters removed here.
          */
         @Override
         public void charactersRemoved(TextNode textNode, int index, int count) {
@@ -83,7 +87,8 @@ public final class TextNode extends Node
     }
 
     /**
-     * @param index Index into this node.
+     * @param text  The new text to insert into this node.
+     * @param index Starting index into this node for the insertion.
      */
     public void insertText(CharSequence text, int index) {
         if (text == null) {
@@ -104,6 +109,7 @@ public final class TextNode extends Node
 
     /**
      * @param index Index into this node.
+     * @param count Count of characters to remove.
      */
     public void removeText(int index, int count) {
         if (index < 0 || index + count > characters.length()) {

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/text/TextNodeListener.java Tue May 24 21:29:50 2016
@@ -23,18 +23,18 @@ public interface TextNodeListener {
     /**
      * Called when characters have been inserted into a text node.
      *
-     * @param textNode
-     * @param index
-     * @param count
+     * @param textNode The text node that changed.
+     * @param index    Starting index of the insertion.
+     * @param count    Count of characters inserted.
      */
     public void charactersInserted(TextNode textNode, int index, int count);
 
     /**
      * Called when characters have been removed from a text node.
      *
-     * @param textNode
-     * @param index
-     * @param count
+     * @param textNode The text node that changed.
+     * @param index    Starting index of the text removed.
+     * @param count    Count of characters removed.
      */
     public void charactersRemoved(TextNode textNode, int index, int count);
 }

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/DecimalValidator.java Tue May 24 21:29:50 2016
@@ -41,7 +41,13 @@ public class DecimalValidator extends Fo
         super(NumberFormat.getInstance(locale), locale);
     }
 
-    /** helper method that wraps the ParseException in a RuntimeException. */
+    /**
+     * Helper method that wraps the {@link ParseException} in a {@link RuntimeException}.
+     *
+     * @param text The text to parse.
+     * @return The number parsed from the text.
+     * @throws RuntimeException if there was a parsing error.
+     */
     protected final Number parseNumber(final String text) {
         String textToParse;
         try {
@@ -55,8 +61,12 @@ public class DecimalValidator extends Fo
     }
 
     /**
-     * helper method that returns the widest number real instance, and extract
+     * Helper method that returns the widest number real instance, and extract
      * later values depending on the precision needed.
+     *
+     * @param text The text to convert.
+     * @return The decimal equivalent of the text or {@code null} if the text
+     * cannot be converted.
      */
     protected final BigDecimal textToBigDecimal(final String text) {
         BigDecimal bd;
@@ -73,15 +83,20 @@ public class DecimalValidator extends Fo
         return bd;
     }
 
-    /** set the autoTrim mode, before parsing the text (default false) */
+    /**
+     * Set the autoTrim mode, before parsing the text (default false).
+     *
+     * @param autoTrim The new auto trim value ({@code true} to trim
+     * leading and trailing blanks before parsing text).
+     */
     public void setAutoTrim(boolean autoTrim) {
         this.autoTrim = autoTrim;
     }
 
     /**
-     * tell the autoTrim mode
+     * Tell the autoTrim mode.
      *
-     * @return true if autoTrim is enabled, otherwise false (default)
+     * @return {@code true} if autoTrim is enabled, otherwise {@code false} (default).
      */
     public boolean isAutoTrim() {
         return autoTrim;

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/RegexTextValidator.java Tue May 24 21:29:50 2016
@@ -44,7 +44,8 @@ public class RegexTextValidator implemen
     }
 
     /**
-     * @throws PatternSyntaxException If the expression's syntax is invalid
+     * @param regexPattern The new pattern for this validator.
+     * @throws PatternSyntaxException If the expression's syntax is invalid.
      */
     public void setPattern(String regexPattern) {
         this.p = Pattern.compile(regexPattern);

Modified: pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/Validator.java
URL: http://svn.apache.org/viewvc/pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/Validator.java?rev=1745405&r1=1745404&r2=1745405&view=diff
==============================================================================
--- pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/Validator.java (original)
+++ pivot/trunk/wtk/src/org/apache/pivot/wtk/validation/Validator.java Tue May 24 21:29:50 2016
@@ -23,7 +23,7 @@ public interface Validator {
     /**
      * Determines if a text value is valid based on the rules of the validator.
      *
-     * @param text
+     * @param text The text to test.
      * @return <tt>true</tt> if the value is valid; <tt>false</tt>, otherwise.
      */
     public boolean isValid(String text);