Update the jsdoc comments to modern syntax - Part 3 #3708
Conversation
brandonocasey
changed the title
| * @param {Function=} ready Ready callback function | ||
| * @class Player | ||
| * After an instance has been created it can be accessed globally again | ||
| * by calling `videojs('example_video_1');` |
There was a problem hiding this comment.
I wonder if we ought to mention that you can do videojs.players.example_video_1 too?
There was a problem hiding this comment.
sure I will add that in
| * @param {Object} [options] | ||
| * Object of option names and values. | ||
| * | ||
| * @param {Component~ReadyCallback} [ready] |
There was a problem hiding this comment.
What is this Component~ReadyCallback type?
There was a problem hiding this comment.
Its a custom typedef that is defined in the part 1 PR.
| @@ -356,9 +483,10 @@ class Player extends Component { | |||
| } | |||
|
|
|||
| /** | |||
| * Create the component's DOM element | |||
| * Create the `Player`s DOM element. | |||
There was a problem hiding this comment.
There are a few places where there is a missing apostrophe below as well.
| /** | ||
| * @event Player#loadstart | ||
| * @type {EventTarget~Event} | ||
| */ |
There was a problem hiding this comment.
This is documented above - does it need to be documented again?
There was a problem hiding this comment.
Same is true of firstplay in a few places.
There was a problem hiding this comment.
I will see if there is any way to have something like a "main definition" that these events can point to. I think it is still important to be able to see where events are used in the code from the docs.
misteroneill
added
confirmed
and removed
needs: LGTM
Description