From 9fe70c71e524accf5eac8352fc76bd358cb1c6c8 Mon Sep 17 00:00:00 2001 From: Artur Signell Date: Tue, 13 Apr 2010 12:18:15 +0000 Subject: [PATCH] Minor javadoc fixes svn changeset:12514/svn branch:6.3 --- src/com/vaadin/data/Container.java | 17 ++++++++--------- src/com/vaadin/event/DataBoundTransferable.java | 9 +++++---- src/com/vaadin/event/dd/DropHandler.java | 5 +++-- src/com/vaadin/event/dd/DropTarget.java | 5 ++--- src/com/vaadin/event/dd/TargetDetails.java | 4 ++-- .../dd/acceptcriteria/AcceptCriterion.java | 8 ++++---- 6 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/com/vaadin/data/Container.java b/src/com/vaadin/data/Container.java index 6dbcfe779f..874b683eb4 100644 --- a/src/com/vaadin/data/Container.java +++ b/src/com/vaadin/data/Container.java @@ -573,10 +573,9 @@ public interface Container extends Serializable { * visible in the container. *

*

- * When an {@link com.vaadin.data.Ordered} or - * {@link com.vaadin.data.Indexed} container is filtered, all operations of - * these interfaces should only use the filtered contents and the filtered - * indices to the container. + * When an {@link Ordered} or {@link Indexed} container is filtered, all + * operations of these interfaces should only use the filtered contents and + * the filtered indices to the container. *

*

* How filtering is performed when a {@link Hierarchical} container @@ -584,11 +583,11 @@ public interface Container extends Serializable { * documented in the implementing class. *

*

- * Adding items (if supported) to a filtered {@link com.vaadin.data.Ordered} - * or {@link com.vaadin.data.Indexed} container should insert them - * immediately after the indicated visible item. The unfiltered position of - * items added at index 0, at index {@link com.vaadin.data.Container#size()} - * or at an undefined position is up to the implementation. + * Adding items (if supported) to a filtered {@link Ordered} or + * {@link Indexed} container should insert them immediately after the + * indicated visible item. The unfiltered position of items added at index + * 0, at index {@link com.vaadin.data.Container#size()} or at an undefined + * position is up to the implementation. *

* * @since 5.0 diff --git a/src/com/vaadin/event/DataBoundTransferable.java b/src/com/vaadin/event/DataBoundTransferable.java index edef4c4427..8fb3143e7a 100644 --- a/src/com/vaadin/event/DataBoundTransferable.java +++ b/src/com/vaadin/event/DataBoundTransferable.java @@ -14,7 +14,8 @@ import com.vaadin.ui.Component; * (identified by its Id) and optionally also a property identifier (e.g. a * table column identifier when transferring a single table cell). * - * The component must implement the interface {@link Container.Viewer}. + * The component must implement the interface + * {@link com.vaadin.data.Container.Viewer}. * * In most cases, receivers of data transfers should depend on this class * instead of its concrete subclasses. @@ -47,13 +48,13 @@ public abstract class DataBoundTransferable extends TransferableImpl { /** * Returns the container data source from which the transfer occurs. * - * {@link Container.Viewer#getContainerDataSource()} is used to obtain the - * underlying container of the source component. + * {@link com.vaadin.data.Container.Viewer#getContainerDataSource()} is used + * to obtain the underlying container of the source component. * * @return Container */ public Container getSourceContainer() { - Component sourceComponent = getSourceComponent(); + Component sourceComponent = getSourceComponent(); if (sourceComponent instanceof Container.Viewer) { return ((Container.Viewer) sourceComponent) .getContainerDataSource(); diff --git a/src/com/vaadin/event/dd/DropHandler.java b/src/com/vaadin/event/dd/DropHandler.java index c9a28b5343..c0176207ed 100644 --- a/src/com/vaadin/event/dd/DropHandler.java +++ b/src/com/vaadin/event/dd/DropHandler.java @@ -14,8 +14,9 @@ import com.vaadin.event.dd.acceptcriteria.ServerSideCriterion; * DropHandlers contain the actual business logic for drag and drop operations. *

* The {@link #drop(DragAndDropEvent)} method is used to receive the transferred - * data and the #getAcceptCriterion()} method contains the (possibly client side - * verifiable) criterion whether the dragged data will be handled at all. + * data and the {@link #getAcceptCriterion()} method contains the (possibly + * client side verifiable) criterion whether the dragged data will be handled at + * all. * * @since 6.3 * diff --git a/src/com/vaadin/event/dd/DropTarget.java b/src/com/vaadin/event/dd/DropTarget.java index 31c6754f6f..fcb9670f6f 100644 --- a/src/com/vaadin/event/dd/DropTarget.java +++ b/src/com/vaadin/event/dd/DropTarget.java @@ -27,12 +27,11 @@ public interface DropTarget extends Component { * {@link DropHandler}. Implementation may for exmaple translate the drop * target details provided by the client side (drop target) to meaningful * server side values. If null is returned the terminal implementation will - * automatically create a {@link TargetDetails} with raw client side - * data. + * automatically create a {@link TargetDetails} with raw client side data. * * @see DragSource#getTransferable(Map) * - * @param rawVariables + * @param clientVariables * data passed from the DropTargets client side counterpart. * @return A DropTargetDetails object with the translated data or null to * use a default implementation. diff --git a/src/com/vaadin/event/dd/TargetDetails.java b/src/com/vaadin/event/dd/TargetDetails.java index f83edf84d1..bd2e41c63c 100644 --- a/src/com/vaadin/event/dd/TargetDetails.java +++ b/src/com/vaadin/event/dd/TargetDetails.java @@ -22,10 +22,10 @@ import com.vaadin.ui.Tree.TreeTargetDetails; public interface TargetDetails extends Serializable { /** - * Gets target data associated to given string key + * Gets target data associated with the given string key * * @param key - * @return + * @return The data associated with the key */ public Object getData(String key); diff --git a/src/com/vaadin/event/dd/acceptcriteria/AcceptCriterion.java b/src/com/vaadin/event/dd/acceptcriteria/AcceptCriterion.java index a2b631de56..6370ddad01 100644 --- a/src/com/vaadin/event/dd/acceptcriteria/AcceptCriterion.java +++ b/src/com/vaadin/event/dd/acceptcriteria/AcceptCriterion.java @@ -62,11 +62,11 @@ public interface AcceptCriterion extends Serializable { public void paintResponse(PaintTarget target) throws PaintException; /** - * Validates the data in event to be appropriate for - * {@link DropHandler#drop(com.vaadin.event.dd.DropEvent)} method. + * Validates the data in event to be appropriate for the + * {@link DropHandler#drop(DragAndDropEvent)} method. *

- * Note that even if your criterion is matched on client side, it is a very - * good manner to validate the data on server side too. + * Note that even if your criterion is validated on client side, you should + * always validate the data on server side too. * * @param dragEvent * @return -- 2.39.5