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 /testbench-api | |
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 'testbench-api')
16 files changed, 40 insertions, 40 deletions
diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractComponentElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractComponentElement.java index 7a4963d4ab..39859cf830 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractComponentElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractComponentElement.java @@ -24,7 +24,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; @ServerClass("com.vaadin.ui.AbstractComponent") public class AbstractComponentElement extends AbstractElement { /** - * Returns the caption of the Component element + * Returns the caption of the Component element. * * @since 8.0 * @return component caption diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractFieldElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractFieldElement.java index 566b73883b..d53f1ddc32 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractFieldElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractFieldElement.java @@ -24,7 +24,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; public class AbstractFieldElement extends AbstractComponentElement { /** - * Select contents of TextField Element + * Select contents of TextField Element. * * NOTE: When testing with firefox browser window should have focus in it * diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractTextFieldElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractTextFieldElement.java index 6435f4a096..f619593709 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractTextFieldElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/AbstractTextFieldElement.java @@ -24,7 +24,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; public class AbstractTextFieldElement extends AbstractFieldElement { /** - * Return value of the field element + * Return value of the field element. * * @return value of the field element */ @@ -33,7 +33,7 @@ public class AbstractTextFieldElement extends AbstractFieldElement { } /** - * Set value of the field element + * Set value of the field element. * * @param chars * new value of the field diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/CheckBoxElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/CheckBoxElement.java index 788d4a917d..1a2768161f 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/CheckBoxElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/CheckBoxElement.java @@ -26,7 +26,7 @@ public class CheckBoxElement extends AbstractFieldElement { /** * Return string representation of value of the checkbox Return either - * checked or unchecked + * checked or unchecked. */ public String getValue() { if (isChecked()) { diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/ComboBoxElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/ComboBoxElement.java index 2eaef4f015..211d94cac6 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/ComboBoxElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/ComboBoxElement.java @@ -118,14 +118,14 @@ public class ComboBoxElement extends AbstractSingleSelectElement { } /** - * Open the suggestion popup + * Open the suggestion popup. */ public void openPopup() { findElement(By.vaadin("#button")).click(); } /** - * Gets the text representation of all suggestions on the current page + * Gets the text representation of all suggestions on the current page. * * @return List of suggestion texts */ @@ -191,7 +191,7 @@ public class ComboBoxElement extends AbstractSingleSelectElement { } /** - * Returns the suggestion popup element + * Returns the suggestion popup element. */ public WebElement getSuggestionPopup() { ensurePopupOpen(); diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/GridElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/GridElement.java index 9530f07de3..7f57cc10a7 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/GridElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/GridElement.java @@ -29,7 +29,7 @@ import com.vaadin.testbench.elementsbase.AbstractElement; import com.vaadin.testbench.elementsbase.ServerClass; /** - * TestBench Element API for Grid + * TestBench Element API for Grid. * * @author Vaadin Ltd */ @@ -157,7 +157,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Scrolls Grid element so that wanted row is displayed + * Scrolls Grid element so that wanted row is displayed. * * @param index * Target row @@ -316,7 +316,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get header row count + * Get header row count. * * @return Header row count */ @@ -325,7 +325,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get footer row count + * Get footer row count. * * @return Footer row count */ @@ -334,7 +334,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get a header row by index + * Get a header row by index. * * @param rowIndex * Row index @@ -345,7 +345,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get a footer row by index + * Get a footer row by index. * * @param rowIndex * Row index @@ -356,7 +356,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get the vertical scroll element + * Get the vertical scroll element. * * @return The element representing the vertical scrollbar */ @@ -366,7 +366,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get the horizontal scroll element + * Get the horizontal scroll element. * * @return The element representing the horizontal scrollbar */ @@ -376,7 +376,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get the header element + * Get the header element. * * @return The thead element */ @@ -385,7 +385,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get the body element + * Get the body element. * * @return the tbody element */ @@ -394,7 +394,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get the footer element + * Get the footer element. * * @return the tfoot element */ @@ -403,7 +403,7 @@ public class GridElement extends AbstractComponentElement { } /** - * Get the element wrapping the table element + * Get the element wrapping the table element. * * @return The element that wraps the table element */ diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/ListSelectElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/ListSelectElement.java index f484854700..e4e12345fa 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/ListSelectElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/ListSelectElement.java @@ -102,7 +102,7 @@ public class ListSelectElement extends AbstractSelectElement { } /** - * Return value of the list select element + * Return value of the list select element. * * @return value of the list select element */ diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/NotificationElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/NotificationElement.java index 6ba2a0f339..584dd6de2b 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/NotificationElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/NotificationElement.java @@ -30,7 +30,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; @ServerClass("com.vaadin.ui.Notification") public class NotificationElement extends AbstractElement { /** - * Closes a notification + * Closes a notification. * * @throws TimeoutException * If a notification can not be closed and the timeout expires. @@ -45,7 +45,7 @@ public class NotificationElement extends AbstractElement { } /** - * Returns the caption of the Notification element + * Returns the caption of the Notification element. * * @since 8.0 * @return the caption of the Notification element @@ -57,7 +57,7 @@ public class NotificationElement extends AbstractElement { } /** - * Returns description of the Notification element + * Returns description of the Notification element. * * @return description of the Notification element */ @@ -68,7 +68,7 @@ public class NotificationElement extends AbstractElement { } /** - * Returns type of the Notification element + * Returns type of the Notification element. * * @return type of the Notification element */ diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/OptionGroupElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/OptionGroupElement.java index 8c5dcea181..b35de4fc83 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/OptionGroupElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/OptionGroupElement.java @@ -56,7 +56,7 @@ public class OptionGroupElement extends AbstractSelectElement { } /** - * Return value of the selected option in the option group + * Return value of the selected option in the option group. * * @return value of the selected option in the option group */ @@ -75,7 +75,7 @@ public class OptionGroupElement extends AbstractSelectElement { } /** - * Select option in the option group with the specified value + * Select option in the option group with the specified value. * * @param chars * value of the option in the option group which will be selected diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/PasswordFieldElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/PasswordFieldElement.java index ed0c8da0c5..d93f45f5a1 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/PasswordFieldElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/PasswordFieldElement.java @@ -20,7 +20,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; @ServerClass("com.vaadin.ui.PasswordField") public class PasswordFieldElement extends AbstractTextFieldElement { /** - * Return value of the password element + * Return value of the password element. * * @since 8.0 * @return value of the password element diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/ProgressBarElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/ProgressBarElement.java index f567dbf904..271983a8dd 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/ProgressBarElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/ProgressBarElement.java @@ -24,7 +24,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; public class ProgressBarElement extends AbstractFieldElement { /** - * Retrns the value of the progress bar + * Returns the value of the progress bar. * * @return */ diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/RadioButtonGroupElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/RadioButtonGroupElement.java index 4cff189ea7..30952c1e00 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/RadioButtonGroupElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/RadioButtonGroupElement.java @@ -55,7 +55,7 @@ public class RadioButtonGroupElement extends AbstractSingleSelectElement { } /** - * Return value of the selected option in the option group + * Return value of the selected option in the option group. * * @return value of the selected option in the option group */ @@ -74,7 +74,7 @@ public class RadioButtonGroupElement extends AbstractSingleSelectElement { } /** - * Select option in the option group with the specified value + * Select option in the option group with the specified value. * * @param chars * value of the option in the option group which will be selected diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/TableElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/TableElement.java index da167805e8..fb6c2c9003 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/TableElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/TableElement.java @@ -52,7 +52,7 @@ public class TableElement extends AbstractSelectElement { } /** - * Return table row element by zero-based index + * Return table row element by zero-based index. * * @return table row element by zero-based index */ @@ -78,7 +78,7 @@ public class TableElement extends AbstractSelectElement { } /** - * Function to get footer cell with given column index + * Function to get footer cell with given column index. * * @param column * 0 based column index @@ -130,7 +130,7 @@ public class TableElement extends AbstractSelectElement { } /** - * Fetches the context menu for the table + * Fetches the context menu for the table. * * @return {@link com.vaadin.testbench.elements.TableElement.ContextMenuElement} * @throws java.util.NoSuchElementException diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/TextAreaElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/TextAreaElement.java index db38820d91..0eda9ae680 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/TextAreaElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/TextAreaElement.java @@ -22,7 +22,7 @@ import com.vaadin.testbench.elementsbase.ServerClass; @ServerClass("com.vaadin.ui.TextArea") public class TextAreaElement extends AbstractTextFieldElement { /** - * Return value of the field element + * Return value of the field element. * * @since 8.0 * @return value of the field element diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/TreeGridElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/TreeGridElement.java index 3eb8b30b5e..52a49c3a4d 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/TreeGridElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/TreeGridElement.java @@ -24,7 +24,7 @@ import org.openqa.selenium.WebElement; import com.vaadin.testbench.By; /** - * TestBench Element API for TreeGrid + * TestBench Element API for TreeGrid. * * @author Vaadin Ltd */ diff --git a/testbench-api/src/main/java/com/vaadin/testbench/elements/WindowElement.java b/testbench-api/src/main/java/com/vaadin/testbench/elements/WindowElement.java index 39b5bfa830..2bcd9d42f0 100644 --- a/testbench-api/src/main/java/com/vaadin/testbench/elements/WindowElement.java +++ b/testbench-api/src/main/java/com/vaadin/testbench/elements/WindowElement.java @@ -35,14 +35,14 @@ public class WindowElement extends PanelElement { private static final String CLOSE_BOX_CLASS = "v-window-closebox"; /** - * Clicks the close button of the window + * Clicks the close button of the window. */ public void close() { getCloseButton().click(); } /** - * Clicks the restore button of the window + * Clicks the restore button of the window. */ public void restore() { if (isMaximized()) { @@ -54,14 +54,14 @@ public class WindowElement extends PanelElement { } /** - * Check if this window is currently maximized + * Check if this window is currently maximized. */ public boolean isMaximized() { return isElementPresent(By.className(RESTORE_BOX_CLASS)); } /** - * Clicks the maximize button of the window + * Clicks the maximize button of the window. */ public void maximize() { if (!isMaximized()) { |