Fixing JavaDoc warnings in Cell Widgets.
Review at http://gwt-code-reviews.appspot.com/1143801
Review by: pdr@google.com
git-svn-id: https://google-web-toolkit.googlecode.com/svn/trunk@9284 8db76d5a-ed1c-0410-87a9-c151d255dfc7
diff --git a/user/src/com/google/gwt/user/cellview/client/AbstractHasData.java b/user/src/com/google/gwt/user/cellview/client/AbstractHasData.java
index 8d9992f..7275c1a 100644
--- a/user/src/com/google/gwt/user/cellview/client/AbstractHasData.java
+++ b/user/src/com/google/gwt/user/cellview/client/AbstractHasData.java
@@ -593,8 +593,8 @@
/**
* Set the {@link SelectionModel} that defines which items are selected and
- * the {@link CellPreviewEvent.Handler} that controls how user selection is
- * handled.
+ * the {@link com.google.gwt.view.client.CellPreviewEvent.Handler} that
+ * controls how user selection is handled.
*
* @param selectionModel the {@link SelectionModel} that defines selection
* @param selectionEventManager the handler that controls user selection
diff --git a/user/src/com/google/gwt/user/cellview/client/CellBasedWidgetImpl.java b/user/src/com/google/gwt/user/cellview/client/CellBasedWidgetImpl.java
index 2e179f8..9c14ce6 100644
--- a/user/src/com/google/gwt/user/cellview/client/CellBasedWidgetImpl.java
+++ b/user/src/com/google/gwt/user/cellview/client/CellBasedWidgetImpl.java
@@ -67,7 +67,7 @@
* widget should not steal focus from it.
*
* @param elem the element
- * @return
+ * @return true if the element is focusable, false if not
*/
public boolean isFocusable(Element elem) {
return focusableTypes.contains(elem.getTagName().toLowerCase())
diff --git a/user/src/com/google/gwt/view/client/CellPreviewEvent.java b/user/src/com/google/gwt/view/client/CellPreviewEvent.java
index 78e6db8..d2fcc06 100644
--- a/user/src/com/google/gwt/view/client/CellPreviewEvent.java
+++ b/user/src/com/google/gwt/view/client/CellPreviewEvent.java
@@ -22,15 +22,14 @@
/**
* Allows the previewing of events before they are fired to Cells.
*
- * @param <T> the data type of the {@link DataDisplay} source
+ * @param <T> the data type of the {@link HasData} source
*/
public class CellPreviewEvent<T> extends GwtEvent<CellPreviewEvent.Handler<T>> {
/**
* Handler for {@link CellPreviewEvent}.
*
- * @param <T> the data type of the {@link DataDisplay}
- * @param <C> the context of the event, usually the Widget source
+ * @param <T> the data type of the {@link HasData}
*/
public static interface Handler<T> extends EventHandler {
@@ -55,7 +54,7 @@
* @param <T> the old value type
* @param source the source of the handlers
* @param nativeEvent the event to preview
- * @param display the {@link DataDisplay} source of the event
+ * @param display the {@link HasData} source of the event
* @param index the index of the value where the event occurred
* @param value the value where the event occurred
* @param isCellEditing indicates whether or not the cell is being edited
@@ -76,7 +75,7 @@
* @param <T> the old value type
* @param source the source of the handlers
* @param nativeEvent the event to preview
- * @param display the {@link DataDisplay} source of the event
+ * @param display the {@link HasData} source of the event
* @param index the index of the value where the event occurred
* @param column the column index
* @param value the value where the event occurred
@@ -120,7 +119,7 @@
* Construct a new {@link CellPreviewEvent}.
*
* @param nativeEvent the event to preview
- * @param display the {@link DataDisplay} source of the event
+ * @param display the {@link HasData} source of the event
* @param index the index of the value where the event occurred
* @param value the value where the event occurred
* @param isCellEditing indicates whether or not the cell is being edited
@@ -157,7 +156,7 @@
}
/**
- * Get the {@link DataDisplay} source of the event.
+ * Get the {@link HasData} source of the event.
*/
public HasData<T> getDisplay() {
return display;
diff --git a/user/src/com/google/gwt/view/client/DefaultSelectionEventManager.java b/user/src/com/google/gwt/view/client/DefaultSelectionEventManager.java
index 5cc1601..22b40cc 100644
--- a/user/src/com/google/gwt/view/client/DefaultSelectionEventManager.java
+++ b/user/src/com/google/gwt/view/client/DefaultSelectionEventManager.java
@@ -44,7 +44,7 @@
*
* @param <T> the data type
*/
- public static class CheckboxEventTranslater<T> implements EventTranslator<T> {
+ public static class CheckboxEventTranslator<T> implements EventTranslator<T> {
/**
* The column index of the checkbox. Other columns are ignored.
@@ -52,20 +52,20 @@
private final int column;
/**
- * Construct a new {@link CheckboxEventTranslater} that will trigger
+ * Construct a new {@link CheckboxEventTranslator} that will trigger
* selection when any checkbox in any column is selected.
*/
- public CheckboxEventTranslater() {
+ public CheckboxEventTranslator() {
this(-1);
}
/**
- * Construct a new {@link CheckboxEventTranslater} that will trigger
+ * Construct a new {@link CheckboxEventTranslator} that will trigger
* selection when a checkbox in the specified column is selected.
*
* @param column the column index, or -1 for all columns
*/
- public CheckboxEventTranslater(int column) {
+ public CheckboxEventTranslator(int column) {
this.column = column;
}
@@ -140,7 +140,7 @@
* @return a {@link DefaultSelectionEventManager} instance
*/
public static <T> DefaultSelectionEventManager<T> createCheckboxManager() {
- return new DefaultSelectionEventManager<T>(new CheckboxEventTranslater<T>());
+ return new DefaultSelectionEventManager<T>(new CheckboxEventTranslator<T>());
}
/**
@@ -153,7 +153,7 @@
*/
public static <T> DefaultSelectionEventManager<T> createCheckboxManager(
int column) {
- return new DefaultSelectionEventManager<T>(new CheckboxEventTranslater<T>(
+ return new DefaultSelectionEventManager<T>(new CheckboxEventTranslator<T>(
column));
}
@@ -167,8 +167,8 @@
* @return a {@link DefaultSelectionEventManager} instance
*/
public static <T> DefaultSelectionEventManager<T> createCustomManager(
- EventTranslator<T> translater) {
- return new DefaultSelectionEventManager<T>(translater);
+ EventTranslator<T> translator) {
+ return new DefaultSelectionEventManager<T>(translator);
}
/**
