[gwt-contrib] [google-web-toolkit] r8395 committed - Fix javadoc issues...

Tue, 20 Jul 2010 11:19:38 -0700 

Revision: 8395
Author: [email protected]
Date: Tue Jul 20 08:04:29 2010
Log: Fix javadoc issues

Review at http://gwt-code-reviews.appspot.com/681801

Review by: [email protected]
http://code.google.com/p/google-web-toolkit/source/detail?r=8395

Modified:
 /trunk/user/src/com/google/gwt/app/place/AbstractRecordListActivity.java
 /trunk/user/src/com/google/gwt/app/place/ActivityManager.java
 /trunk/user/src/com/google/gwt/app/place/RecordListView.java
 /trunk/user/src/com/google/gwt/cell/client/package.html
 /trunk/user/src/com/google/gwt/i18n/shared/BidiFormatter.java
 /trunk/user/src/com/google/gwt/i18n/shared/HasDirectionEstimator.java
 /trunk/user/src/com/google/gwt/requestfactory/shared/Id.java
 /trunk/user/src/com/google/gwt/requestfactory/shared/Version.java
 /trunk/user/src/com/google/gwt/uibinder/client/UiField.java
 /trunk/user/src/com/google/gwt/uibinder/client/package-info.java
 /trunk/user/src/com/google/gwt/user/client/ui/AnimatedLayout.java
 /trunk/user/src/com/google/gwt/user/client/ui/CustomButton.java
 /trunk/user/src/com/google/gwt/user/client/ui/LayoutCommand.java
 /trunk/user/src/com/google/gwt/user/client/ui/LayoutPanel.java
 /trunk/user/src/com/google/gwt/user/client/ui/UIObject.java
 /trunk/user/src/com/google/gwt/user/client/ui/ValueBoxBase.java
/trunk/user/src/com/google/gwt/valuestore/client/DeltaValueStoreJsonImpl.java 
 /trunk/user/src/com/google/gwt/valuestore/client/ValueStoreJsonImpl.java
 /trunk/user/src/com/google/gwt/valuestore/shared/DeltaValueStore.java
 /trunk/user/src/com/google/gwt/valuestore/shared/ValueStore.java
 /trunk/user/src/com/google/gwt/view/client/AbstractListViewAdapter.java

=======================================
--- /trunk/user/src/com/google/gwt/app/place/AbstractRecordListActivity.java Fri Jul 16 07:47:49 2010 +++ /trunk/user/src/com/google/gwt/app/place/AbstractRecordListActivity.java Tue Jul 20 08:04:29 2010 
@@ -35,7 +35,7 @@
  * development, and is very likely to be deleted. Use it at your own risk.
  * </span>
  * </p>
- * Abstract activity for requesting and displaying a list of {...@record}.
+ * Abstract activity for requesting and displaying a list of {...@link Record}. 
  * <p>
  * Subclasses must:
  *
=======================================
--- /trunk/user/src/com/google/gwt/app/place/ActivityManager.java Fri Jul 16 07:47:49 2010 +++ /trunk/user/src/com/google/gwt/app/place/ActivityManager.java Tue Jul 20 08:04:29 2010 
@@ -62,8 +62,7 @@
   private boolean startingNext = false;

   /**
-   * Create an ActivityManager. Next call {...@link #setDisplay} and
-   * {...@link #activate}.
+   * Create an ActivityManager. Next call {...@link #setDisplay}.
    *
    * @param mapper finds the {...@link Activity} for a given {...@link Place}
    * @param eventBus source of {...@link PlaceChangeEvent} and
=======================================
--- /trunk/user/src/com/google/gwt/app/place/RecordListView.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/app/place/RecordListView.java Tue Jul 20 08:04:29 2010 
@@ -24,7 +24,7 @@
  * development, and is very likely to be deleted. Use it at your own risk.
  * </span>
  * </p>
- * A view of a list of {...@link Records}, which declares which properties it is + * A view of a list of {...@link Record}s, which declares which properties it is 
  * able to display.
  * <p>
* It is expected that such views will typically (eventually) be defined largely 
@@ -37,7 +37,7 @@
   /**
    * Implemented by the owner of a RecordTableView.
    *
-   * @param<R> the type of the records to display
+   * @param <R> the type of the records to display
    */
   interface Delegate<R extends Record> {
     void createClicked();
=======================================
--- /trunk/user/src/com/google/gwt/cell/client/package.html Mon Jun 7 12:20:31 2010 +++ /trunk/user/src/com/google/gwt/cell/client/package.html Tue Jul 20 08:04:29 2010 
@@ -4,23 +4,22 @@
{...@link com.google.gwt.user.cellview.client cellview} widgets. The available 
 cell types are:
 <ul>
-<li>{...@link com.google.gwt.cell.client.Cell Cell} - the main interface<li>
<li>{...@link com.google.gwt.cell.client.AbstractCell AbstractCell} - a convenience implementation for subclassing</li> <li>{...@link com.google.gwt.cell.client.ActionCell ActionCell} - a Button that responds to mouse clicks via a {...@link com.google.gwt.cell.client.ActionCell.Delegate Delegate} interface</li> <li>{...@link com.google.gwt.cell.client.ButtonCell ButtonCell} - a cell that displays a button with custom text</li> 
+<li>{...@link com.google.gwt.cell.client.Cell Cell} - the main interface<li>
<li>{...@link com.google.gwt.cell.client.CheckboxCell CheckboxCell} - a cell that display sa checkbox</li> <li>{...@link com.google.gwt.cell.client.ClickableTextCell ClickableTextCell} - HTML text that responds to mouse clicks</li> <li>{...@link com.google.gwt.cell.client.CompositeCell CompositeCell} - a cell that wraps other cells</li> -<li>{...@link com.google.gwt.cell.client.CurrencyCell CurrencyCell} - a cell that displays a currency value (NOTE: does not 
- currently perform any localization)</li>
<li>{...@link com.google.gwt.cell.client.DateCell DateCell} - a cell displays a date (NOTE: does not currently perform 
 any localization)</li>
<li>{...@link com.google.gwt.cell.client.DatePickerCell DatePickerCell} - a cell that displays a date and allows editing 
 using a {...@link com.google.gwt.user.datepicker.client.DatePicker DatePicker}
 widget</li>
-<li>{...@link com.google.gwt.cell.client.IconCellDecorator IconCellDecorator} - a cell that adds an icon to another cell</li> <li>{...@link com.google.gwt.cell.client.EditTextCell EditTextCell} - a cell that displays editable text</li> +<li>{...@link com.google.gwt.cell.client.IconCellDecorator IconCellDecorator} - a cell that adds an icon to another cell</li> +<li>{...@link com.google.gwt.cell.client.NumberCell CurrencyCell} - a cell that displays a formatted number</li> <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> 
=======================================
--- /trunk/user/src/com/google/gwt/i18n/shared/BidiFormatter.java Sun Apr 11 02:45:34 2010 +++ /trunk/user/src/com/google/gwt/i18n/shared/BidiFormatter.java Tue Jul 20 08:04:29 2010 
@@ -387,7 +387,7 @@
   }

   /**
- * Like {...@link #spanWrapWithKnownDir(Direction, String, boolean, boolean)}, + * Like {...@link #spanWrapWithKnownDir(HasDirection.Direction, String, boolean, boolean)}, 
    * but assumes {...@code isHtml} is false and {...@code dirReset} is true.
    *
    * @param dir {...@code str}'s direction
@@ -399,7 +399,7 @@
   }

   /**
- * Like {...@link #spanWrapWithKnownDir(Direction, String, boolean, boolean)}, + * Like {...@link #spanWrapWithKnownDir(HasDirection.Direction, String, boolean, boolean)}, 
    * but assumes {...@code dirReset} is true.
    *
    * @param dir {...@code str}'s direction
@@ -523,7 +523,7 @@
   }

   /**
- * Like {...@link #unicodeWrapWithKnownDir(Direction, String, boolean, boolean)}, + * Like {...@link #unicodeWrapWithKnownDir(HasDirection.Direction, String, boolean, boolean)}, 
    * but assumes {...@code isHtml} is false and {...@code dirReset} is true.
    *
    * @param dir {...@code str}'s direction
@@ -535,7 +535,7 @@
   }

   /**
- * Like {...@link #unicodeWrapWithKnownDir(Direction, String, boolean, boolean)}, + * Like {...@link #unicodeWrapWithKnownDir(HasDirection.Direction, String, boolean, boolean)}, 
    * but assumes {...@code dirReset} is true.
    *
    * @param dir {...@code str}'s direction
=======================================
--- /trunk/user/src/com/google/gwt/i18n/shared/HasDirectionEstimator.java Sun Apr 25 03:44:04 2010 +++ /trunk/user/src/com/google/gwt/i18n/shared/HasDirectionEstimator.java Tue Jul 20 08:04:29 2010 
@@ -28,15 +28,16 @@
   /**
    * Toggles on / off direction estimation.
    *
- * @param enabled Whether to enable direction estimation. If {...@true}, sets the 
-   *        DirectionEstimator object to a default {...@directionestimator}.
+ * @param enabled Whether to enable direction estimation. If {...@code true}, 
+   *          sets the {...@link DirectionEstimator} object to a default
+   *          {...@code DirectionEstimator}.
    */
   void setDirectionEstimator(boolean enabled);

   /**
-   * Sets the DirectionEstimator object.
+   * Sets the {...@link DirectionEstimator} object.
    *
- * @param directionEstimator The {...@code directionEstimator} to be set. {...@code + * @param directionEstimator The {code DirectionEstimator} to be set. {...@code 
    *        null} means turning off direction estimation.
    */
   void setDirectionEstimator(DirectionEstimator directionEstimator);
=======================================
--- /trunk/user/src/com/google/gwt/requestfactory/shared/Id.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/requestfactory/shared/Id.java Tue Jul 20 08:04:29 2010 
@@ -22,7 +22,7 @@
  * </span>
  * </p>
* Marks the id {...@link com.google.gwt.valuestore.shared.Property Property} of an 
- * {...@link com.google.gwt.valuestore.shared.ValuesKey ValuesKey}.
+ * entity.
  */
 public @interface Id {
   // TODO prove the servlet will use this info
=======================================
--- /trunk/user/src/com/google/gwt/requestfactory/shared/Version.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/requestfactory/shared/Version.java Tue Jul 20 08:04:29 2010 
@@ -22,7 +22,7 @@
  * </span>
  * </p>
* Marks the version {...@link com.google.gwt.valuestore.shared.Property Property} 
- * of an {...@link com.google.gwt.valuestore.shared.ValuesKey ValuesKey}.
+ * of an entity.
  */
 public @interface Version {
   // TODO prove the servlet will use this info
=======================================
--- /trunk/user/src/com/google/gwt/uibinder/client/UiField.java Wed Oct 28 09:10:53 2009 +++ /trunk/user/src/com/google/gwt/uibinder/client/UiField.java Tue Jul 20 08:04:29 2010 
@@ -23,8 +23,8 @@

 /**
  * Marks fields in a UiBinder client that must be filled by the binder's
- * {...@link UiBinder#bindUi} method. If provided is true the field creation is 
- * delegated to the client (owner).
+ * {...@link UiBinder#createAndBindUi} method. If provided is true the field
+ * creation is delegated to the client (owner).
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
=======================================
--- /trunk/user/src/com/google/gwt/uibinder/client/package-info.java Mon Jun 7 12:20:31 2010 +++ /trunk/user/src/com/google/gwt/uibinder/client/package-info.java Tue Jul 20 08:04:29 2010 
@@ -20,12 +20,12 @@
  * <p>
* This package contains the classes and interfaces that allow you to define 
  * user interfaces from ui.xml template files, managed by generated
- * implementations of the {...@link UiBinder} interface. UiBinder templates allow 
- * you to lay out your widgets and design new ones via HTML, CSS and Image
- * resources (the last two via generated {...@link com.google.gwt.resources.client - * ClientBundles}) with a minimum of coding. They also have extensive support 
- * for internationalization, by generating
- * {...@link com.google.gwt.i18n.client.Messages Messages}.
+ * implementations of the {...@link com.google.gwt.uibinder.client.UiBinder UiBinder} + * interface. UiBinder templates allow you to lay out your widgets and design 
+ * new ones via HTML, CSS and Image resources (the last two via generated
+ * {...@link com.google.gwt.resources.client.ClientBundle ClientBundles}) with a + * minimum of coding. They also have extensive support for internationalization, 
+ * by generating {...@link com.google.gwt.i18n.client.Messages Messages}.
  * </p>
  *
  * <p>
=======================================
--- /trunk/user/src/com/google/gwt/user/client/ui/AnimatedLayout.java Tue Nov 3 14:14:13 2009 +++ /trunk/user/src/com/google/gwt/user/client/ui/AnimatedLayout.java Tue Jul 20 08:04:29 2010 
@@ -58,7 +58,7 @@
    * </p>
    *
    * @see #animate(int)
-   * @see #animate(int, AnimationCallback)
+   * @see #animate(int, Layout.AnimationCallback)
    */
   void forceLayout();
 }
=======================================
--- /trunk/user/src/com/google/gwt/user/client/ui/CustomButton.java Tue Dec 1 15:35:53 2009 +++ /trunk/user/src/com/google/gwt/user/client/ui/CustomButton.java Tue Jul 20 08:04:29 2010 
@@ -25,7 +25,7 @@
 import com.google.gwt.user.client.Event;

 /**
- * Custom Button is a base button class with built in support for a set number + * CustomButton is a base button class with built in support for a set number 
  * of button faces.
  *
* Each face has its own style modifier. For example, the state for down and 
@@ -117,7 +117,7 @@
  *
  * Each face element can take an optional <code>image</code> attribute
  * and an html body. For example:<pre>
- * &lt;ui:image field='downButton'/> &lt;!-- define an {...@link ImageResource} --> + * &lt;ui:image field='downButton'/> &lt;!-- define an {...@link com.google.gwt.resources.client.ImageResource ImageResource} --> 
  *
  * &lt;g:PushButton ui:field='pushButton' enabled='true'>
  *   &lt;g:upFace>
=======================================
--- /trunk/user/src/com/google/gwt/user/client/ui/LayoutCommand.java Wed Jan 13 12:22:43 2010 +++ /trunk/user/src/com/google/gwt/user/client/ui/LayoutCommand.java Tue Jul 20 08:04:29 2010 
@@ -26,7 +26,7 @@
  * ever performed for a panel within a given user event.
  *
  * <p>
- * Note: This class assumes that {...@link Layout.Layer#getUserObject()} will
+ * Note: This class assumes that {...@link com.google.gwt.layout.client.Layout.Layer#getUserObject Layer.getUserObject()} will 
  * return the widget associated with a given layer.
  * </p>
  */
@@ -48,7 +48,7 @@

   /**
    * Cancels this command. A subsequent call to
-   * {...@link #schedule(int, AnimationCallback)} will re-enable it.
+   * {...@link #schedule(int, Layout.AnimationCallback)} will re-enable it.
    */
   public void cancel() {
     // There's no way to "unschedule" a command, so we use a canceled flag.
=======================================
--- /trunk/user/src/com/google/gwt/user/client/ui/LayoutPanel.java Wed Mar 3 07:46:03 2010 +++ /trunk/user/src/com/google/gwt/user/client/ui/LayoutPanel.java Tue Jul 20 08:04:29 2010 
@@ -123,8 +123,8 @@
    * <p>
    * By default, each child will fill the panel. To build more interesting
    * layouts, set child widgets' layout constraints using
- * {...@link #setWidgetLeftRight(Widget, double, Unit, double, Unit)} and related 
-   * methods.
+ * {...@link #setWidgetLeftRight(Widget, double, Style.Unit, double, Style.Unit)} 
+   * and related methods.
    * </p>
    *
    * @param widget the widget to be added
@@ -164,8 +164,8 @@
    * <p>
    * By default, each child will fill the panel. To build more interesting
    * layouts, set child widgets' layout constraints using
- * {...@link #setWidgetLeftRight(Widget, double, Unit, double, Unit)} and related 
-   * methods.
+ * {...@link #setWidgetLeftRight(Widget, double, Style.Unit, double, Style.Unit)} 
+   * and related methods.
    * </p>
    *
    * <p>
=======================================
--- /trunk/user/src/com/google/gwt/user/client/ui/UIObject.java Mon Jun 7 12:20:31 2010 +++ /trunk/user/src/com/google/gwt/user/client/ui/UIObject.java Tue Jul 20 08:04:29 2010 
@@ -108,7 +108,7 @@
  *
  * There is also special case handling for two common method signatures,
  * <code>(int, int)</code> and <code>(double, {...@link
- * com.google.gwt.dom.clientStyle.Unit Unit})</code>
+ * com.google.gwt.dom.client.Style.Unit Unit})</code>
  *
  * <pre>
  * &lt;g:Label pixelSize='100, 100'>Hello there&lt;/g:Label></pre>
@@ -425,7 +425,7 @@
    *
    * <p>
    * The code can also be simplified with
-   * {...@link setStyleDependentName(String, boolean}:
+   * {...@link #setStyleDependentName(String, boolean)}:
    * </p>
    *
    * <pre class="code">
=======================================
--- /trunk/user/src/com/google/gwt/user/client/ui/ValueBoxBase.java Fri Jul 2 04:56:18 2010 +++ /trunk/user/src/com/google/gwt/user/client/ui/ValueBoxBase.java Tue Jul 20 08:04:29 2010 
@@ -363,9 +363,10 @@
   /**
    * Sets the alignment of the text in the text box.
    *
- * @param align the text alignment (as specified by {...@link #ALIGN_CENTER}, 
-   *          {...@link #ALIGN_JUSTIFY}, {...@link #ALIGN_LEFT}, and
-   *          {...@link #ALIGN_RIGHT})
+   * @param align the text alignment (as specified by
+   *          {...@link TextBoxBase#ALIGN_CENTER},
+ * {...@link TextBoxBase#ALIGN_JUSTIFY}, {...@link TextBoxBase#ALIGN_LEFT}, 
+   *          and {...@link TextBoxBase#ALIGN_RIGHT})
    */
   public void setTextAlignment(TextAlignConstant align) {
DOM.setStyleAttribute(getElement(), "textAlign", align.getTextAlignString()); 
=======================================
--- /trunk/user/src/com/google/gwt/valuestore/client/DeltaValueStoreJsonImpl.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/valuestore/client/DeltaValueStoreJsonImpl.java Tue Jul 20 08:04:29 2010 
@@ -38,7 +38,7 @@
  * development, and is very likely to be deleted. Use it at your own risk.
  * </span>
  * </p>
- * {...@link DeltaValueStore} implementation based on {...@link ValuesImpl}.
+ * {...@link DeltaValueStore} implementation.
  */
 public class DeltaValueStoreJsonImpl implements DeltaValueStore {

=======================================
--- /trunk/user/src/com/google/gwt/valuestore/client/ValueStoreJsonImpl.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/valuestore/client/ValueStoreJsonImpl.java Tue Jul 20 08:04:29 2010 
@@ -31,7 +31,7 @@
  * development, and is very likely to be deleted. Use it at your own risk.
  * </span>
  * </p>
- * {...@link ValueStore} implementation based on {...@link ValuesImpl}.
+ * {...@link ValueStore} implementation.
  */
 public class ValueStoreJsonImpl implements ValueStore {
   // package protected fields for use by DeltaValueStoreJsonImpl
@@ -61,9 +61,6 @@
     }
   }

-  /**
-   * @return
-   */
   public DeltaValueStoreJsonImpl spawnDeltaView() {
     return new DeltaValueStoreJsonImpl(this, map);
   }
=======================================
--- /trunk/user/src/com/google/gwt/valuestore/shared/DeltaValueStore.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/valuestore/shared/DeltaValueStore.java Tue Jul 20 08:04:29 2010 
@@ -45,9 +45,7 @@
   <V> void set(Property<V> property, Record record, V value);

   /**
- * Returns true if all validations have passed. May notify subscribers that - * implement {...@link com.google.gwt.user.client.ui.HasErrors HasErrors} of new 
-   * validation errors.
+   * Returns true if all validations have passed.
    */
   boolean validate();
 }
=======================================
--- /trunk/user/src/com/google/gwt/valuestore/shared/ValueStore.java Thu Jun 24 14:48:00 2010 +++ /trunk/user/src/com/google/gwt/valuestore/shared/ValueStore.java Tue Jul 20 08:04:29 2010 
@@ -21,14 +21,11 @@
  * development, and is very likely to be deleted. Use it at your own risk.
  * </span>
  * </p>
- * A store of records with properties. Each record has a {...@link ValuesKey}
- * associated with it to indicate its type.
+ * A store of records with properties.
  */
 public interface ValueStore {
   /**
- * Most validations are per field or per id and set via annotation. Note that 
-   * validations are only actually enforced by in {...@link DeltaValueStore}
-   * instances spawned by {...@link #forEditContext(Object)}
+   * Most validations are per field or per id and set via annotation.
    */
void addValidation(/* what's a validation. JSR 303? Learn from Pectin? */); 

=======================================
--- /trunk/user/src/com/google/gwt/view/client/AbstractListViewAdapter.java Tue Jun 22 05:03:01 2010 +++ /trunk/user/src/com/google/gwt/view/client/AbstractListViewAdapter.java Tue Jul 20 08:04:29 2010 
@@ -50,7 +50,7 @@
* Adds a view to this adapter. The current range of interest of the view will 
    * be populated with data.
    *
-   * @param view a {...@link ListView}.
+   * @param view a {...@link ListView}.
    */
   public void addView(ListView<T> view) {
     if (views.contains(view)) {

--
http://groups.google.com/group/Google-Web-Toolkit-Contributors

Reply via email to