Add missing Javadoc for Cell packages Review at http://gwt-code-reviews.appspot.com/1005801 Review by: jlabanca@google.com git-svn-id: https://google-web-toolkit.googlecode.com/svn/trunk@9075 8db76d5a-ed1c-0410-87a9-c151d255dfc7

diff --git a/user/src/com/google/gwt/cell/client/AbstractEditableCell.java b/user/src/com/google/gwt/cell/client/AbstractEditableCell.java
index 2bac676..a99eb8f 100644
--- a/user/src/com/google/gwt/cell/client/AbstractEditableCell.java
+++ b/user/src/com/google/gwt/cell/client/AbstractEditableCell.java

@@ -76,6 +76,7 @@
    *
    * @param key the key identifying the row object
    * @return the view data, or null if none has been set
+   * @see #setViewData(Object, Object)V
    */
   public V getViewData(Object key) {
     return (key == null) ? null : viewDataMap.get(key);
@@ -90,6 +91,7 @@
    * @param parent the parent Element
    * @param value the value associated with the cell
    * @param key the unique key associated with the row object
+   * @return true if the cell is in edit mode
    */
   @Override
   public abstract boolean isEditing(Element parent, C value, Object key);
@@ -100,6 +102,7 @@
    *
    * @param key the key of the view data
    * @param viewData the view data to associate
+   * @see #getViewData(Object)
    */
   public void setViewData(Object key, V viewData) {
     if (key == null) {

diff --git a/user/src/com/google/gwt/cell/client/AbstractSafeHtmlCell.java b/user/src/com/google/gwt/cell/client/AbstractSafeHtmlCell.java
index 0e2bbfd..4d7bc32 100644
--- a/user/src/com/google/gwt/cell/client/AbstractSafeHtmlCell.java
+++ b/user/src/com/google/gwt/cell/client/AbstractSafeHtmlCell.java

@@ -65,6 +65,8 @@
 
   /**
    * Return the {@link SafeHtmlRenderer} used by this cell.
+   *
+   * @return a {@link SafeHtmlRenderer} instance
    */
   public SafeHtmlRenderer<C> getRenderer() {
     return renderer;

diff --git a/user/src/com/google/gwt/cell/client/ActionCell.java b/user/src/com/google/gwt/cell/client/ActionCell.java
index 8e06066..0003118 100644
--- a/user/src/com/google/gwt/cell/client/ActionCell.java
+++ b/user/src/com/google/gwt/cell/client/ActionCell.java

@@ -37,6 +37,8 @@
   public static interface Delegate<T> {
     /**
      * Perform the desired action on the given object.
+     *
+     * @param object the object to be acted upon
      */
     void execute(T object);
   }

diff --git a/user/src/com/google/gwt/cell/client/ButtonCell.java b/user/src/com/google/gwt/cell/client/ButtonCell.java
index e819440..d8caa83 100644
--- a/user/src/com/google/gwt/cell/client/ButtonCell.java
+++ b/user/src/com/google/gwt/cell/client/ButtonCell.java

@@ -36,6 +36,8 @@
 
   /**
    * Construct a new ButtonCell that will use a given {@link SafeHtmlRenderer}.
+   * 
+   * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
    */
   public ButtonCell(SafeHtmlRenderer<String> renderer) {
     super(renderer, "click", "keydown");

diff --git a/user/src/com/google/gwt/cell/client/Cell.java b/user/src/com/google/gwt/cell/client/Cell.java
index 85bb507..217217f 100644
--- a/user/src/com/google/gwt/cell/client/Cell.java
+++ b/user/src/com/google/gwt/cell/client/Cell.java

@@ -41,12 +41,10 @@
   boolean dependsOnSelection();
 
   /**
-   * <p>
    * Get the set of events that this cell consumes. The container that uses this
    * cell should only pass these events to
-   * {@link #onBrowserEvent(Element, Object, Object, NativeEvent, ValueUpdater)}
-   * .
-   * </p>
+   * {@link #onBrowserEvent(Element, Object, Object, NativeEvent, ValueUpdater)}.
+   *
    * <p>
    * The returned value should not be modified, and may be an unmodifiable set.
    * Changes to the return value may not be reflected in the cell.
@@ -73,6 +71,7 @@
    * @param parent the parent Element
    * @param value the value associated with the cell
    * @param key the unique key associated with the row object
+   * @return true if the cell is in edit mode
    */
   boolean isEditing(Element parent, C value, Object key);
 
@@ -109,6 +108,10 @@
    * Reset focus on the Cell. This method is called if the cell has focus when
    * it is refreshed.
    *
+   * @param parent the parent Element
+   * @param value the value associated with the cell
+   * @param key the unique key associated with the row object
+   *
    * @return true if focus is taken, false if not
    */
   boolean resetFocus(Element parent, C value, Object key);

diff --git a/user/src/com/google/gwt/cell/client/ClickableTextCell.java b/user/src/com/google/gwt/cell/client/ClickableTextCell.java
index 2c57c59..16fbe38 100644
--- a/user/src/com/google/gwt/cell/client/ClickableTextCell.java
+++ b/user/src/com/google/gwt/cell/client/ClickableTextCell.java

@@ -39,6 +39,8 @@
   /**
    * Construct a new ClickableTextCell that will use a given
    * {@link SafeHtmlRenderer}.
+   * 
+   * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
    */
   public ClickableTextCell(SafeHtmlRenderer<String> renderer) {
     super(renderer, "click", "keydown");

diff --git a/user/src/com/google/gwt/cell/client/DatePickerCell.java b/user/src/com/google/gwt/cell/client/DatePickerCell.java
index 236fb03..49df900 100644
--- a/user/src/com/google/gwt/cell/client/DatePickerCell.java
+++ b/user/src/com/google/gwt/cell/client/DatePickerCell.java

@@ -79,6 +79,8 @@
   /**
    * Constructs a new DatePickerCell that uses the given date/time format and a
    * {@link SimpleSafeHtmlRenderer}.
+   *
+   * @param format a {@link DateTimeFormat} instance
    */
   public DatePickerCell(DateTimeFormat format) {
     this(format, SimpleSafeHtmlRenderer.getInstance());
@@ -88,6 +90,8 @@
    * Constructs a new DatePickerCell that uses the date/time format given by
    * {@link DateTimeFormat#getFullDateFormat} and the given
    * {@link SafeHtmlRenderer}.
+   * 
+   * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
    */
   public DatePickerCell(SafeHtmlRenderer<String> renderer) {
     this(DateTimeFormat.getFormat(PredefinedFormat.DATE_FULL), renderer);
@@ -96,6 +100,9 @@
   /**
    * Constructs a new DatePickerCell that uses the given date/time format and
    * {@link SafeHtmlRenderer}.
+   *
+   * @param format a {@link DateTimeFormat} instance
+   * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
    */
   public DatePickerCell(DateTimeFormat format, SafeHtmlRenderer<String> renderer) {
     super("click", "keydown");

diff --git a/user/src/com/google/gwt/cell/client/EditTextCell.java b/user/src/com/google/gwt/cell/client/EditTextCell.java
index 07d5ef8..004967b 100644
--- a/user/src/com/google/gwt/cell/client/EditTextCell.java
+++ b/user/src/com/google/gwt/cell/client/EditTextCell.java

@@ -145,8 +145,9 @@
   }
 
   /**
-   * Construct a new EditTextCell that will use a given {@link SafeHtmlRenderer}
-   * .
+   * Construct a new EditTextCell that will use a given {@link SafeHtmlRenderer}.
+   * 
+   * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
    */
   public EditTextCell(SafeHtmlRenderer<String> renderer) {
     super("click", "keyup", "keydown", "blur");

diff --git a/user/src/com/google/gwt/cell/client/ImageLoadingCell.java b/user/src/com/google/gwt/cell/client/ImageLoadingCell.java
index 10c1a24..67a3e23 100644
--- a/user/src/com/google/gwt/cell/client/ImageLoadingCell.java
+++ b/user/src/com/google/gwt/cell/client/ImageLoadingCell.java

@@ -108,15 +108,30 @@
       }
     }
 
+    /**
+     * Returns the renderer for a broken image.
+     *
+     * @return a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
+     */
     public SafeHtmlRenderer<String> getErrorRenderer() {
       // Show the broken image on error.
       return getImageRenderer();
     }
 
+    /**
+     * Returns the renderer for an image.
+     *
+     * @return a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
+     */
     public SafeHtmlRenderer<String> getImageRenderer() {
       return IMAGE_RENDERER;
     }
 
+    /**
+     * Returns the renderer for a loading image.
+     *
+     * @return a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
+     */
     public SafeHtmlRenderer<String> getLoadingRenderer() {
       return LOADING_RENDERER;
     }
@@ -150,7 +165,8 @@
   /**
    * Construct an {@link ImageResourceCell} using the specified
    * {@link SafeHtmlRenderer SafeHtmlRenderers}.
-   *
+   * 
+   * @param renderers an instance of {@link ImageLoadingCell.Renderers Renderers}
    */
   public ImageLoadingCell(Renderers renderers) {
     super("load", "error");

diff --git a/user/src/com/google/gwt/cell/client/TextCell.java b/user/src/com/google/gwt/cell/client/TextCell.java
index 0a6fbeb..48db9eb 100644
--- a/user/src/com/google/gwt/cell/client/TextCell.java
+++ b/user/src/com/google/gwt/cell/client/TextCell.java

@@ -36,6 +36,8 @@
   /**
    * Constructs a TextCell that uses the provided {@link SafeHtmlRenderer} to
    * render its text.
+   * 
+   * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
    */
   public TextCell(SafeHtmlRenderer<String> renderer) {
     super(renderer);

diff --git a/user/src/com/google/gwt/cell/client/TextInputCell.java b/user/src/com/google/gwt/cell/client/TextInputCell.java
index ca932e5..be1f7d5 100644
--- a/user/src/com/google/gwt/cell/client/TextInputCell.java
+++ b/user/src/com/google/gwt/cell/client/TextInputCell.java

@@ -52,6 +52,8 @@
 
     /**
      * Construct a ViewData instance containing a given value.
+     *
+     * @param value a String value
      */
     public ViewData(String value) {
       this.lastValue = value;
@@ -74,6 +76,9 @@
 
     /**
      * Return the current value of the input element.
+     * 
+     * @return the current value String
+     * @see #setCurrentValue(String)
      */
     public String getCurrentValue() {
       return curValue;
@@ -81,6 +86,9 @@
 
     /**
      * Return the last value sent to the {@link ValueUpdater}.
+     * 
+     * @return the last value String
+     * @see #setLastValue(String)
      */
     public String getLastValue() {
       return lastValue;
@@ -98,6 +106,7 @@
      * Set the current value.
      * 
      * @param curValue the current value
+     * @see #getCurrentValue()
      */
     protected void setCurrentValue(String curValue) {
       this.curValue = curValue;
@@ -107,6 +116,7 @@
      * Set the last value.
      * 
      * @param lastValue the last value
+     * @see #getLastValue()
      */
     protected void setLastValue(String lastValue) {
       this.lastValue = lastValue;

diff --git a/user/src/com/google/gwt/cell/client/package.html b/user/src/com/google/gwt/cell/client/package.html
index 2ad25ad..9e1d211 100644
--- a/user/src/com/google/gwt/cell/client/package.html
+++ b/user/src/com/google/gwt/cell/client/package.html

@@ -23,7 +23,7 @@
 <li>{@link com.google.gwt.cell.client.SelectionCell SelectionCell} - a cell that displays a drop-down list</li>
 <li>{@link com.google.gwt.cell.client.TextCell TextCell} - a cell that displays HTML text</li>
 <li>{@link com.google.gwt.cell.client.TextInputCell TextInputCell} - a cell that provides text input</li>
-<ul>
+</ul>
 </p>
 
 <p>In addition to cells, this package provides the following interfaces:
@@ -33,5 +33,7 @@
 <li>{@link com.google.gwt.cell.client.FieldUpdater FieldUpdater}</li>
 </ul>
 </p>
+
+@since GWT 2.1
 </body>
 </html>