diff options
author | Ahmed Ashour <asashour@yahoo.com> | 2017-10-02 09:09:37 +0200 |
---|---|---|
committer | Henri Sara <henri.sara@gmail.com> | 2017-10-02 10:09:37 +0300 |
commit | 763a5cbe8c13ff4a169aae9062c643ad1588cea0 (patch) | |
tree | cf41f4ac4c31925f5ca69d66a3fa6a47fbecfd4f /compatibility-shared/src | |
parent | adcf2e2e80c6a05ea5e43be15dc7a2576fd2bbb4 (diff) | |
download | vaadin-framework-763a5cbe8c13ff4a169aae9062c643ad1588cea0.tar.gz vaadin-framework-763a5cbe8c13ff4a169aae9062c643ad1588cea0.zip |
First sentence of javadoc should end with a period (#10114)
Also includes minor other javadoc and formatting fixes.
Diffstat (limited to 'compatibility-shared/src')
12 files changed, 57 insertions, 54 deletions
diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/datefield/Resolution.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/datefield/Resolution.java index 3d75c48006..69b80239c7 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/datefield/Resolution.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/datefield/Resolution.java @@ -15,20 +15,22 @@ */ package com.vaadin.v7.shared.ui.datefield; -import com.vaadin.shared.ui.datefield.DateResolution; -import com.vaadin.shared.ui.datefield.DateTimeResolution; - import java.util.ArrayList; import java.util.List; +import com.vaadin.shared.ui.datefield.DateResolution; +import com.vaadin.shared.ui.datefield.DateTimeResolution; + /** - * Resolutions for DateFields + * Resolutions for DateFields. * * @author Vaadin Ltd. * @since 7.0 * - * @deprecated As of 8.0, replaced by {@link DateResolution} and {@link DateTimeResolution}, - * used by new {@code com.vaadin.ui.DateField} and {@code com.vaadin.ui.DateTimeField} + * @deprecated As of 8.0, replaced by {@link DateResolution} and + * {@link DateTimeResolution}, used by new + * {@code com.vaadin.ui.DateField} and + * {@code com.vaadin.ui.DateTimeField} */ public enum Resolution { // Values from Calendar.SECOND etc. Set as ints to avoid Calendar dependency diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/ColumnGroupState.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/ColumnGroupState.java index f3751f449a..00ed95d9f5 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/ColumnGroupState.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/ColumnGroupState.java @@ -21,7 +21,7 @@ import java.util.ArrayList; import java.util.List; /** - * The column group data shared between the server and the client + * The column group data shared between the server and the client. * * @since 7.4 * @author Vaadin Ltd @@ -29,17 +29,17 @@ import java.util.List; public class ColumnGroupState implements Serializable { /** - * The columns that is included in the group + * The columns that is included in the group. */ public List<String> columns = new ArrayList<String>(); /** - * The header text of the group + * The header text of the group. */ public String header; /** - * The footer text of the group + * The footer text of the group. */ public String footer; } diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/DetailsConnectorChange.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/DetailsConnectorChange.java index 877a558563..22d57eb1a2 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/DetailsConnectorChange.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/DetailsConnectorChange.java @@ -49,7 +49,7 @@ public class DetailsConnectorChange implements Serializable { private Integer newIndex; private boolean shouldStillBeVisible; - /** Create a new connector index change */ + /** Create a new connector index change. */ public DetailsConnectorChange() { } @@ -143,7 +143,7 @@ public class DetailsConnectorChange implements Serializable { } /** - * Sets the old index + * Sets the old index. * * @param oldIndex * the old index. May be <code>null</code> if a new connector is @@ -154,7 +154,7 @@ public class DetailsConnectorChange implements Serializable { } /** - * Sets the new index + * Sets the new index. * * @param newIndex * the new index. May be <code>null</code> if a connector is diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridColumnState.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridColumnState.java index b1bf1844e6..07be704bd8 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridColumnState.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridColumnState.java @@ -21,7 +21,7 @@ import com.vaadin.shared.Connector; /** * Column state DTO for transferring column properties from the server to the - * client + * client. * * @since 7.4 * @author Vaadin Ltd @@ -30,7 +30,7 @@ public class GridColumnState implements Serializable { /** * Id used by grid connector to map server side column with client side - * column + * column. */ public String id; @@ -58,7 +58,7 @@ public class GridColumnState implements Serializable { public Connector editorConnector; /** - * Whether this column is sortable by the user + * Whether this column is sortable by the user. */ public boolean sortable = false; @@ -86,7 +86,7 @@ public class GridColumnState implements Serializable { /** The caption for the column hiding toggle. */ public String hidingToggleCaption; - /** Column header caption */ + /** Column header caption. */ public String headerCaption; /** Whether this column is resizable by the user. */ diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridConstants.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridConstants.java index dc9b2207e5..8d9b607f6c 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridConstants.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridConstants.java @@ -74,28 +74,28 @@ public final class GridConstants implements Serializable { public static final double DEFAULT_COLUMN_WIDTH_PX = -1; /** - * Event ID for item click events + * Event ID for item click events. */ public static final String ITEM_CLICK_EVENT_ID = "itemClick"; - /** The default save button caption in the editor */ + /** The default save button caption in the editor. */ public static final String DEFAULT_SAVE_CAPTION = "Save"; - /** The default cancel button caption in the editor */ + /** The default cancel button caption in the editor. */ public static final String DEFAULT_CANCEL_CAPTION = "Cancel"; /** - * Event ID constant for editor open event + * Event ID constant for editor open event. */ public static final String EDITOR_OPEN_EVENT_ID = "editorOpen"; /** - * Event ID constant for editor move event + * Event ID constant for editor move event. */ public static final String EDITOR_MOVE_EVENT_ID = "editorMove"; /** - * Event ID constant for editor close event + * Event ID constant for editor close event. */ public static final String EDITOR_CLOSE_EVENT_ID = "editorClose"; } diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridServerRpc.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridServerRpc.java index 7fcf461244..b50f37bae4 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridServerRpc.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridServerRpc.java @@ -23,7 +23,7 @@ import com.vaadin.shared.data.sort.SortDirection; import com.vaadin.v7.shared.ui.grid.GridConstants.Section; /** - * Client-to-server RPC interface for the Grid component + * Client-to-server RPC interface for the Grid component. * * @since 7.4 * @author Vaadin Ltd diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridState.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridState.java index c333ed0d55..cfefce4326 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridState.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridState.java @@ -24,7 +24,8 @@ import com.vaadin.shared.data.sort.SortDirection; import com.vaadin.shared.ui.TabIndexState; /** - * The shared state for the {@link com.vaadin.ui.components.grid.Grid} component + * The shared state for the {@link com.vaadin.ui.components.grid.Grid} + * component. * * @since 7.4 * @author Vaadin Ltd @@ -43,7 +44,7 @@ public class GridState extends TabIndexState { */ public enum SharedSelectionMode { /** - * Representation of a single selection mode + * Representation of a single selection mode. * * @see com.vaadin.ui.components.grid.Grid.SelectionMode#SINGLE * @see com.vaadin.client.ui.grid.Grid.SelectionMode#SINGLE @@ -51,7 +52,7 @@ public class GridState extends TabIndexState { SINGLE, /** - * Representation of a multiselection mode + * Representation of a multiselection mode. * * @see com.vaadin.ui.components.grid.Grid.SelectionMode#MULTI * @see com.vaadin.client.ui.grid.Grid.SelectionMode#MULTI @@ -59,7 +60,7 @@ public class GridState extends TabIndexState { MULTI, /** - * Representation of a no-selection mode + * Representation of a no-selection mode. * * @see com.vaadin.ui.components.grid.Grid.SelectionMode#NONE * @see com.vaadin.client.ui.grid.Grid.SelectionMode#NONE @@ -70,40 +71,40 @@ public class GridState extends TabIndexState { /** * The default value for height-by-rows for both GWT widgets * {@link com.vaadin.ui.components.grid Grid} and - * {@link com.vaadin.client.ui.grid.Escalator Escalator} + * {@link com.vaadin.client.ui.grid.Escalator Escalator}. */ public static final double DEFAULT_HEIGHT_BY_ROWS = 10.0d; /** - * The key in which a row's data can be found + * The key in which a row's data can be found. * * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String) */ public static final String JSONKEY_DATA = "d"; /** - * The key in which a row's own key can be found + * The key in which a row's own key can be found. * * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String) */ public static final String JSONKEY_ROWKEY = "k"; /** - * The key in which a row's generated style can be found + * The key in which a row's generated style can be found. * * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String) */ public static final String JSONKEY_ROWSTYLE = "rs"; /** - * The key in which a generated styles for a row's cells can be found + * The key in which a generated styles for a row's cells can be found. * * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String) */ public static final String JSONKEY_CELLSTYLES = "cs"; /** - * The key in which a row's description can be found + * The key in which a row's description can be found. * * @since 7.6 * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String) @@ -111,7 +112,7 @@ public class GridState extends TabIndexState { public static final String JSONKEY_ROWDESCRIPTION = "rd"; /** - * The key in which a cell's description can be found + * The key in which a cell's description can be found. * * @since 7.6 * @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String) @@ -162,7 +163,7 @@ public class GridState extends TabIndexState { public GridStaticSectionState footer = new GridStaticSectionState(); - /** The number of frozen columns */ + /** The number of frozen columns. */ public int frozenColumnCount = 0; /** The height of the Grid in terms of body rows. */ @@ -173,17 +174,17 @@ public class GridState extends TabIndexState { @DelegateToWidget public HeightMode heightMode = HeightMode.CSS; - /** Keys of the currently sorted columns */ + /** Keys of the currently sorted columns. */ public String[] sortColumns = new String[0]; - /** Directions for each sorted column */ + /** Directions for each sorted column. */ public SortDirection[] sortDirs = new SortDirection[0]; - /** The enabled state of the editor interface */ + /** The enabled state of the editor interface. */ public boolean editorEnabled = false; /** - * Buffered editor mode + * Buffered editor mode. * * @since 7.6 */ @@ -191,21 +192,21 @@ public class GridState extends TabIndexState { public boolean editorBuffered = true; /** - * Whether rows and/or cells have generated descriptions (tooltips) + * Whether rows and/or cells have generated descriptions (tooltips). * * @since 7.6 */ public boolean hasDescriptions; - /** The caption for the save button in the editor */ + /** The caption for the save button in the editor. */ @DelegateToWidget public String editorSaveCaption = GridConstants.DEFAULT_SAVE_CAPTION; - /** The caption for the cancel button in the editor */ + /** The caption for the cancel button in the editor. */ @DelegateToWidget public String editorCancelCaption = GridConstants.DEFAULT_CANCEL_CAPTION; - /** Whether the columns can be reordered */ + /** Whether the columns can be reordered. */ @DelegateToWidget public boolean columnReorderingAllowed; diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridStaticCellType.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridStaticCellType.java index 70da93f573..3cac591be1 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridStaticCellType.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/grid/GridStaticCellType.java @@ -23,17 +23,17 @@ package com.vaadin.v7.shared.ui.grid; */ public enum GridStaticCellType { /** - * Text content + * Text content. */ TEXT, /** - * HTML content + * HTML content. */ HTML, /** - * Widget content + * Widget content. */ WIDGET; } diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/progressindicator/ProgressBarState.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/progressindicator/ProgressBarState.java index a9a98e3395..b23600de02 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/progressindicator/ProgressBarState.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/progressindicator/ProgressBarState.java @@ -21,7 +21,7 @@ import com.vaadin.shared.communication.SharedState; import com.vaadin.v7.shared.AbstractFieldState; /** - * {@link SharedState} for {@link com.vaadin.ui.ProgressBar} + * {@link SharedState} for {@link com.vaadin.ui.ProgressBar}. * * @since 7.1 * @author Vaadin Ltd diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/table/TableServerRpc.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/table/TableServerRpc.java index 18ba4e69e9..5db25da871 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/table/TableServerRpc.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/table/TableServerRpc.java @@ -20,7 +20,7 @@ import com.vaadin.shared.communication.ServerRpc; import com.vaadin.v7.shared.ui.table.TableConstants.Section; /** - * Client-to-server RPC interface for the Table component + * Client-to-server RPC interface for the Table component. * * @since 7.6 * @author Vaadin Ltd @@ -28,7 +28,7 @@ import com.vaadin.v7.shared.ui.table.TableConstants.Section; public interface TableServerRpc extends ServerRpc { /** - * Informs the server that a context click happened inside of Table + * Informs the server that a context click happened inside of Table. */ public void contextClick(String rowKey, String colKey, Section section, MouseEventDetails details); diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/textfield/AbstractTextFieldState.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/textfield/AbstractTextFieldState.java index c74684d19a..f8b54a0b84 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/textfield/AbstractTextFieldState.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/textfield/AbstractTextFieldState.java @@ -42,7 +42,7 @@ public class AbstractTextFieldState extends AbstractFieldState { public String inputPrompt = null; /** - * The text in the field + * The text in the field. */ @NoLayout public String text = null; diff --git a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/tree/TreeServerRpc.java b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/tree/TreeServerRpc.java index 23587a43e8..5d391d3912 100644 --- a/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/tree/TreeServerRpc.java +++ b/compatibility-shared/src/main/java/com/vaadin/v7/shared/ui/tree/TreeServerRpc.java @@ -19,7 +19,7 @@ import com.vaadin.shared.MouseEventDetails; import com.vaadin.shared.communication.ServerRpc; /** - * Client-to-server RPC interface for the Tree component + * Client-to-server RPC interface for the Tree component. * * @since 7.6 * @author Vaadin Ltd @@ -27,8 +27,8 @@ import com.vaadin.shared.communication.ServerRpc; public interface TreeServerRpc extends ServerRpc { /** - * Informs the server that a context click happened inside of Tree + * Informs the server that a context click happened inside of Tree. */ public void contextClick(String rowKey, MouseEventDetails details); -}
\ No newline at end of file +} |