Javadoc added to com.vaadin.ui.Field interface (#13209)

Change-Id: Iad7381e59dfe7a6ea9cb4a633e2c411ebdd1a79d

diff --git a/server/src/com/vaadin/ui/Field.java b/server/src/com/vaadin/ui/Field.java
index e90c07b8a7640b37b409c27236a6119923806b6b..f191e1bdd7b3bbd97fef181bdf44e55abcac60f4 100644 (file)
--- a/server/src/com/vaadin/ui/Field.java
+++ b/server/src/com/vaadin/ui/Field.java
@@ -1,12 +1,12 @@
 /*
  * Copyright 2000-2014 Vaadin Ltd.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy of
  * the License at
- * 
+ *
  * http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
@@ -21,14 +21,23 @@ import com.vaadin.data.Property;
 import com.vaadin.ui.Component.Focusable;
 
 /**
- * TODO document
- * 
+ * Field interface is implemented by all classes (field components) that have a
+ * value that the user can change through the user interface.
+ *
+ * Field components are built upon the framework defined in the Field interface
+ * and the {@link com.vaadin.AbstractField} base class.
+ *
+ * The Field interface inherits the {@link com.vaadin.ui.Component}
+ * superinterface and also the {@link com.vaadin.ui.Property} interface to have
+ * a value for the field.
+ *
+ *
  * @author Vaadin Ltd.
- * 
+ *
  * @param T
  *            the type of values in the field, which might not be the same type
  *            as that of the data source if converters are used
- * 
+ *
  * @author IT Mill Ltd.
  */
 public interface Field<T> extends Component, BufferedValidatable, Property<T>,
@@ -37,9 +46,9 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
 
     /**
      * Is this field required.
-     * 
+     *
      * Required fields must filled by the user.
-     * 
+     *
      * @return <code>true</code> if the field is required,otherwise
      *         <code>false</code>.
      * @since 3.1
@@ -48,7 +57,7 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
 
     /**
      * Sets the field required. Required fields must filled by the user.
-     * 
+     *
      * @param required
      *            Is the field required.
      * @since 3.1
@@ -57,7 +66,7 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
 
     /**
      * Sets the error message to be displayed if a required field is empty.
-     * 
+     *
      * @param requiredMessage
      *            Error message.
      * @since 5.2.6
@@ -67,7 +76,7 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
     /**
      * Gets the error message that is to be displayed if a required field is
      * empty.
-     * 
+     *
      * @return Error message.
      * @since 5.2.6
      */
@@ -76,7 +85,7 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
     /**
      * An <code>Event</code> object specifying the Field whose value has been
      * changed.
-     * 
+     *
      * @author Vaadin Ltd.
      * @since 3.0
      */
@@ -86,7 +95,7 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
 
         /**
          * Constructs a new event object with the specified source field object.
-         * 
+         *
          * @param source
          *            the field that caused the event.
          */
@@ -96,7 +105,7 @@ public interface Field<T> extends Component, BufferedValidatable, Property<T>,
 
         /**
          * Gets the Property which triggered the event.
-         * 
+         *
          * @return the Source Property of the event.
          */
         @Override