Minor javadoc fixes

svn changeset:12514/svn branch:6.3

diff --git a/src/com/vaadin/data/Container.java b/src/com/vaadin/data/Container.java
index 6dbcfe779fc4b31520dc85fd8a791474fb5fee42..874b683eb499480ef47691a68751298a6d0d9817 100644 (file)
--- 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.
      * </p>
      * <p>
-     * 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.
      * </p>
      * <p>
      * How filtering is performed when a {@link Hierarchical} container
@@ -584,11 +583,11 @@ public interface Container extends Serializable {
      * documented in the implementing class.
      * </p>
      * <p>
-     * 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.
      * </p>
      * 
      * @since 5.0

diff --git a/src/com/vaadin/event/DataBoundTransferable.java b/src/com/vaadin/event/DataBoundTransferable.java
index edef4c44275fe6a27aafb92fb8c18aceccf07379..8fb3143e7addcc8da7c98e6d91c18de80deba823 100644 (file)
--- 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 c9a28b53436f6827626b77922642bb38e3ca5d50..c0176207ed39f88875ea81564523c25ab48d098d 100644 (file)
--- 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.
  * <p>
  * 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 31c6754f6faeeb19bcd69c6dc7fc486ccd427a15..fcb9670f6ff4170e00d6f38f89f6ab3fe9459720 100644 (file)
--- 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 f83edf84d141d15c463402d098d56c3c9cf8783f..bd2e41c63c417504c72148e78f8344252ffb2f1d 100644 (file)
--- 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 a2b631de5666a0a7a8af9a308a11a23a306517dc..6370ddad01592dffb4f04a6be248ca1cb949b37f 100644 (file)
--- 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.
      * <p>
-     * 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