Update the jsdoc comments to modern syntax - Part 2 #3698
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
gkatsev
requested changes
Oct 21, 2016
| * @type {Object|undefined} | ||
| * @private | ||
| * uses the map approach from [Screenful.js]{@link https://github.com/sindresorhus/screenfull.js}. | ||
| * The Spec for this is located [here]{@link https://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html} |
There was a problem hiding this comment.
Use this url instead: https://fullscreen.spec.whatwg.org
There was a problem hiding this comment.
just for the spec link? right?
| @@ -9,15 +9,21 @@ import * as Fn from '../utils/fn.js'; | |||
| import toTitleCase from '../utils/to-title-case.js'; | |||
|
|
|||
| /** | |||
| * A button class with a popup menu | |||
| * A Button class for any {@link Menu} | |||
There was a problem hiding this comment.
I think it would be good to keep the word "popup" in there
| * a constructor for a menu item | ||
| * | ||
| * @param {Player} player | ||
| * the player that this component should ataach to |
| * The constructor for Menu | ||
| * | ||
| * @param {Player} player | ||
| * the player that this component should ataach to |
| @@ -199,15 +219,23 @@ class ModalDialog extends Component { | |||
| } | |||
|
|
|||
| /** | |||
| * Closes the modal. | |||
| * Closes the modal, does nothing if the ModalDialog is | |||
| 8 not open | |||
|
@gkatsev ready for re-review |
gkatsev
requested changes
Oct 26, 2016
| * constructor for a MenuButton | ||
| * | ||
| * @param {Player} player | ||
| * the player that this component should ataach to |
| * but is not a native HTML button. | ||
| * | ||
| * @param {Player} player | ||
| * the player that this component should ataach to |
| * @fires Component#resize | ||
| * | ||
| * @param {string} widthOrHeight | ||
| 8 'width' or 'height' |
| 8 'width' or 'height' | ||
| * | ||
| * @param {number|string} [num] | ||
| 8 New dimension |
|
@gkatsev made all the requested changes, ran through hemingway, and made this PR not depend on the other. Ready for a last review! |
gkatsev
approved these changes
Nov 2, 2016
| @@ -100,4 +119,95 @@ for (let errNum = 0; errNum < MediaError.errorTypes.length; errNum++) { | |||
| MediaError.prototype[MediaError.errorTypes[errNum]] = errNum; | |||
| } | |||
|
|
|||
| // jsdocs for instance/static members added above | |||
There was a problem hiding this comment.
Can we note that this is why it will look like the following is doubled? i.e., we have both MediaError#MEDIA_ERROR_CUSTOM (instance) and MediaError.MEDIA_ERROR_CUSTOM (static).
brandonocasey
added
confirmed
and removed
needs: LGTM
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
@returnand description where missing from functions@paramand description where missing@classand@method@eventsand@firesFiles Changed (all others are from the previous PR)
- src/js/poster-image.js
Requirements Checklist