summaryrefslogtreecommitdiffstats
path: root/shared
diff options
context:
space:
mode:
authorIlia Motornyi <elmot@vaadin.com>2016-12-22 14:13:23 +0200
committerHenri Sara <henri.sara@gmail.com>2016-12-22 14:13:23 +0200
commite54256fe0919aeedfa4663879be5963e9b857114 (patch)
tree58a81d76b11df83d31f36e33d367cfbaf1a27910 /shared
parent60097da19728f2675245a914f0bd98f4f01df896 (diff)
downloadvaadin-framework-e54256fe0919aeedfa4663879be5963e9b857114.tar.gz
vaadin-framework-e54256fe0919aeedfa4663879be5963e9b857114.zip
Partial javadocs fix for vaadin-shared (#8068)
Diffstat (limited to 'shared')
-rw-r--r--shared/src/main/java/com/vaadin/shared/data/DataProviderRpc.java2
-rw-r--r--shared/src/main/java/com/vaadin/shared/ui/ComponentStateUtil.java4
-rw-r--r--shared/src/main/java/com/vaadin/shared/ui/grid/GridState.java15
-rw-r--r--shared/src/main/java/com/vaadin/shared/ui/grid/HeightMode.java9
-rw-r--r--shared/src/main/java/com/vaadin/shared/ui/grid/editor/EditorServerRpc.java4
-rw-r--r--shared/src/main/java/com/vaadin/shared/ui/ui/DebugWindowServerRpc.java3
6 files changed, 17 insertions, 20 deletions
diff --git a/shared/src/main/java/com/vaadin/shared/data/DataProviderRpc.java b/shared/src/main/java/com/vaadin/shared/data/DataProviderRpc.java
index 701ba6acc9..4c7cff82b3 100644
--- a/shared/src/main/java/com/vaadin/shared/data/DataProviderRpc.java
+++ b/shared/src/main/java/com/vaadin/shared/data/DataProviderRpc.java
@@ -52,7 +52,7 @@ public interface DataProviderRpc extends ClientRpc {
* @param rowDataJson
* the updated row data
* @see com.vaadin.shared.ui.grid.GridState#JSONKEY_DATA
- * @see com.vaadin.ui.components.grid.Renderer#encode(Object)
+ * @see com.vaadin.ui.Renderer#encode(Object)
*/
@NoLayout
public void setRowData(int firstRowIndex, JsonArray rowDataJson);
diff --git a/shared/src/main/java/com/vaadin/shared/ui/ComponentStateUtil.java b/shared/src/main/java/com/vaadin/shared/ui/ComponentStateUtil.java
index bcc4b3f496..081abfa8aa 100644
--- a/shared/src/main/java/com/vaadin/shared/ui/ComponentStateUtil.java
+++ b/shared/src/main/java/com/vaadin/shared/ui/ComponentStateUtil.java
@@ -56,7 +56,9 @@ public final class ComponentStateUtil implements Serializable {
/**
* Removes an event listener id.
*
- * @param eventListenerId
+ * @param state
+ * shared state
+ * @param eventIdentifier
* The event identifier to remove
* @deprecated Use a {@link Registration} object returned by
* {@link #addRegisteredEventListener(SharedState, String)} to
diff --git a/shared/src/main/java/com/vaadin/shared/ui/grid/GridState.java b/shared/src/main/java/com/vaadin/shared/ui/grid/GridState.java
index 1074b181d8..62dee006f7 100644
--- a/shared/src/main/java/com/vaadin/shared/ui/grid/GridState.java
+++ b/shared/src/main/java/com/vaadin/shared/ui/grid/GridState.java
@@ -22,6 +22,7 @@ import java.util.List;
import com.vaadin.shared.annotations.DelegateToWidget;
import com.vaadin.shared.data.sort.SortDirection;
import com.vaadin.shared.ui.AbstractSingleSelectState;
+import elemental.json.JsonArray;
/**
* The shared state for the {@link com.vaadin.ui.Grid} component.
@@ -41,49 +42,49 @@ public class GridState extends AbstractSingleSelectState {
/**
* The key in which a row's data can be found.
*
- * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
+ * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, JsonArray)
*/
public static final String JSONKEY_DATA = "d";
/**
* The key in which a row's own key can be found.
*
- * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
+ * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, JsonArray)
*/
public static final String JSONKEY_ROWKEY = "k";
/**
* The key in which a row's generated style can be found.
*
- * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
+ * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, JsonArray)
*/
public static final String JSONKEY_ROWSTYLE = "rs";
/**
* The key in which a generated styles for a row's cells can be found.
*
- * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
+ * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, JsonArray)
*/
public static final String JSONKEY_CELLSTYLES = "cs";
/**
* The key in which a row's description can be found.
*
- * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
+ * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, JsonArray)
*/
public static final String JSONKEY_ROWDESCRIPTION = "rd";
/**
* The key in which a cell's description can be found.
*
- * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
+ * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, JsonArray)
*/
public static final String JSONKEY_CELLDESCRIPTION = "cd";
/**
* The key that tells whether details are visible for the row.
*
- * @see com.vaadin.ui.Grid#setDetailsGenerator(com.vaadin.ui.Grid.DetailsGenerator)
+ * @see com.vaadin.ui.Grid#setDetailsGenerator(com.vaadin.ui.components.grid.DetailsGenerator)
* @see com.vaadin.ui.Grid#setDetailsVisible(Object, boolean)
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int,
* elemental.json.JsonArray)
diff --git a/shared/src/main/java/com/vaadin/shared/ui/grid/HeightMode.java b/shared/src/main/java/com/vaadin/shared/ui/grid/HeightMode.java
index 8029012892..ca0f2c6761 100644
--- a/shared/src/main/java/com/vaadin/shared/ui/grid/HeightMode.java
+++ b/shared/src/main/java/com/vaadin/shared/ui/grid/HeightMode.java
@@ -17,15 +17,12 @@ package com.vaadin.shared.ui.grid;
/**
* The modes for height calculation that are supported by Grid (
- * {@link com.vaadin.client.ui.grid.Grid client} and
- * {@link com.vaadin.ui.components.grid.Grid server}) /
- * {@link com.vaadin.client.ui.grid.Escalator Escalator}.
+ * client ({@code com.vaadin.client.widgets.Grid}),
+ * server ({@code com.vaadin.ui.Grid server}), and
+ * Escalator ({@code com.vaadin.client.widgets.Escalator Escalator}).
*
* @since 7.4
* @author Vaadin Ltd
- * @see com.vaadin.client.ui.grid.Grid#setHeightMode(HeightMode)
- * @see com.vaadin.ui.components.grid.Grid#setHeightMode(HeightMode)
- * @see com.vaadin.client.ui.grid.Escalator#setHeightMode(HeightMode)
*/
public enum HeightMode {
/**
diff --git a/shared/src/main/java/com/vaadin/shared/ui/grid/editor/EditorServerRpc.java b/shared/src/main/java/com/vaadin/shared/ui/grid/editor/EditorServerRpc.java
index 3ddcfff758..8f338aa1a0 100644
--- a/shared/src/main/java/com/vaadin/shared/ui/grid/editor/EditorServerRpc.java
+++ b/shared/src/main/java/com/vaadin/shared/ui/grid/editor/EditorServerRpc.java
@@ -28,7 +28,7 @@ public interface EditorServerRpc extends ServerRpc {
/**
* Asks the server to open the editor and bind data to it. When a bind
* request is sent, it must be acknowledged with a
- * {@link EditorClientRpc#confirmBind() confirm call} before the client can
+ * {@link EditorClientRpc#confirmBind(boolean) confirm call} before the client can
* open the editor.
*
* @param key
@@ -39,7 +39,7 @@ public interface EditorServerRpc extends ServerRpc {
/**
* Asks the server to save unsaved changes in the editor to the bean. When a
* save request is sent, it must be acknowledged with a
- * {@link EditorClientRpc#confirmSave() confirm call}.
+ * {@link EditorClientRpc#confirmSave(boolean) confirm call}.
*/
void save();
diff --git a/shared/src/main/java/com/vaadin/shared/ui/ui/DebugWindowServerRpc.java b/shared/src/main/java/com/vaadin/shared/ui/ui/DebugWindowServerRpc.java
index e79ca049b4..3a3b04091c 100644
--- a/shared/src/main/java/com/vaadin/shared/ui/ui/DebugWindowServerRpc.java
+++ b/shared/src/main/java/com/vaadin/shared/ui/ui/DebugWindowServerRpc.java
@@ -14,9 +14,6 @@
* the License.
*/
-/**
- *
- */
package com.vaadin.shared.ui.ui;
import com.vaadin.shared.Connector;