Update the jsdoc comments to modern syntax - Part 6 #3771
Merged
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
brandonocasey
added
documentation
needs: LGTM
brandonocasey
changed the title
misteroneill
requested changes
Nov 14, 2016
| */ | ||
| createEl() { | ||
| return super.createEl('div', { | ||
| className: 'vjs-mouse-display' | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * handle the mouse move event on the `MouseTimeDisplay`. |
There was a problem hiding this comment.
"handle" should probably be capitalized.
| @@ -46,7 +52,15 @@ class PlayProgressBar extends Component { | |||
| }); | |||
| } | |||
|
|
|||
| updateDataAttr() { | |||
| /** | |||
| * Updatet the data-current-time attribute on the `PlayProgressBar`. | |||
| * | ||
| * @method updateARIAAttributes | ||
| * @listens Player#timupdate |
| * The key/value store of player options. | ||
| * | ||
| * @param {Component~ReadyCallback} [ready] | ||
| * The functino to call when this component is ready. |
| * The key/value store of player options. | ||
| * | ||
| * @param {Component~ReadyCallback} [ready] | ||
| * The functino to call when this component is ready. |
| * The key/value store of player options. | ||
| * | ||
| * @param {Component~ReadyCallback} [ready] | ||
| * The functino to call when this component is ready. |
| * Update remaining time display. | ||
| * | ||
| * @param {EventTarget~Event} [event] | ||
| * The `timeupdate` or `durationchange` event taht caused this to run. |
| * @param {EventTarget~Event|string} event | ||
| * A string (the type) or an event object with a type attribute | ||
| * | ||
| * @param {Object} [hash] data |
There was a problem hiding this comment.
Looks like "data" should be on the next line. And capitalized.
brandonocasey
added
confirmed
and removed
needs: LGTM
|
@misteroneill Changes made |
misteroneill
approved these changes
Nov 15, 2016
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.
Description
jsdoc part 6
Requirements Checklist