Selenium: Update javadocs to actual state in the "CodenvyEditor" class #9115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ohrimenko1988
added
status/code-review
SkorikSergey
approved these changes
Mar 16, 2018
dmytro-ndp
reviewed
Mar 16, 2018
| /** | ||
| * Waits until editor's tab with specified {@code nameOfFile} is closed. | ||
| * | ||
| * @param nameOfFile visible name of the editor's tab |
There was a problem hiding this comment.
did you mean title of tab?
dmytro-ndp
reviewed
Mar 16, 2018
| @@ -596,7 +624,9 @@ private void openGoToLineFormAndSetCursorToPosition(int positionLine, int positi | |||
| askForValueDialog.waitFormToClose(); | |||
| } | |||
|
|
|||
| /** launch code assistant with ctrl+space keys and wait container is open */ | |||
| /** | |||
| * Launches code assistant by "ctrl" + "space" keys combination and waits until container is open. | |||
There was a problem hiding this comment.
is opened? (passive voice)
dmytro-ndp
reviewed
Mar 16, 2018
| @@ -657,7 +687,7 @@ public void waitMarkerInPosition(MarkerLocator markerLocator, int position) { | |||
| expectedNumberOfActiveLine(position); | |||
| } | |||
|
|
|||
| /** Wait for no Git change markers in the opened editor. */ | |||
| /** Waits for no Git change markers in the opened editor. */ | |||
There was a problem hiding this comment.
"No Git Change" markers is clearer.
dmytro-ndp
reviewed
Mar 16, 2018
| @@ -670,7 +700,8 @@ public void waitNoGitChangeMarkers() { | |||
| } | |||
|
|
|||
| /** | |||
| * Wait for Git insertion marker in the opened editor. | |||
| * Waits for Git insertion marker between {@code startLine} and {@code endLine} including this two | |||
There was a problem hiding this comment.
it could be written simpler: between the specified fromLine, inclusive, and toLine, inclusive.
dmytro-ndp
reviewed
Mar 16, 2018
| public String getAllVisibleTextFromProposition() { | ||
| waitPropositionAssistContainer(); | ||
| return seleniumWebDriverHelper.waitVisibilityAndGetText(propositionContainer); | ||
| } | ||
|
|
||
| /** wait assist proposition container is open */ | ||
| /** Waits until assist proposition container is open. */ |
There was a problem hiding this comment.
is opened (Passive voice)
dmytro-ndp
reviewed
Mar 16, 2018
| */ | ||
| public void waitActiveTabFileName(String nameOfFile) { | ||
| seleniumWebDriverHelper.waitPresence(By.xpath(format(ACTIVE_TAB_FILE_NAME, nameOfFile))); | ||
| } | ||
|
|
||
| /** check that files have been closed. (Check disappears all text areas and tabs) */ | ||
| /** Checks that all files have been closed. (Checks disappears all text areas and tabs) */ |
There was a problem hiding this comment.
disappears > disappearance of
dmytro-ndp
reviewed
Mar 16, 2018
| @@ -1139,7 +1226,7 @@ public void selectLineAndDelete() { | |||
| typeTextIntoEditor(DELETE.toString()); | |||
| } | |||
|
|
|||
| /** Deletes current line with Ctrl+D */ | |||
| /** Deletes current editor's line with Ctrl+D. */ | |||
There was a problem hiding this comment.
with Ctrl+D > by Ctrl+D keys pressing
dmytro-ndp
reviewed
Mar 16, 2018
| * | ||
| * @param position position of the breakpoint | ||
| * @param position number of line in which breakpoint should be placed |
dmytro-ndp
reviewed
Mar 16, 2018
| } | ||
|
|
||
| /** | ||
| * select defined implementation in the 'Implementation' form | ||
| * Selects defined {@code itemName} in the 'Implementation' form |
dmytro-ndp
reviewed
Mar 16, 2018
| * Select tab by index of editor window after split | ||
| * Selects editor's tab by specified {@code index} and {@code tabName}. | ||
| * | ||
| * <p>Note! Is used for split editor. |
There was a problem hiding this comment.
Is used for split editor. is not clear, as for me.
dmytro-ndp
reviewed
Mar 16, 2018
| * | ||
| * @param selectedElement is the selected element into editor | ||
| * @param selectedElement visible text in the editor on which context click should be perform |
There was a problem hiding this comment.
be performed (Passive Voice)
dmytro-ndp
reviewed
Mar 16, 2018
| @@ -1854,18 +2006,18 @@ public void openContextMenuOnElementInEditor(String selectedElement) { | |||
| waitContextMenu(); | |||
| } | |||
|
|
|||
| /** wait context menu form is open */ | |||
| /** Waits until context menu form is open. */ | |||
dmytro-ndp
approved these changes
Mar 19, 2018
Ohrimenko1988
removed
the
status/code-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Update javadocs to actual state in the "CodenvyEditor" class.
What issues does this PR fix or reference?
Issue: #9085
Release Notes
Docs PR