mirror of
https://github.com/videojs/video.js.git
synced 2025-01-27 11:22:06 +02:00
docs: fixup global jsdoc members (#4015)
This commit is contained in:
parent
49496195ed
commit
6ad1e5c97b
@ -91,7 +91,6 @@ class PlayToggle extends Button {
|
||||
/**
|
||||
* Add the vjs-ended class to the element so it can change appearance
|
||||
*
|
||||
* @method handleEnded
|
||||
*/
|
||||
handleEnded(event) {
|
||||
this.removeClass('vjs-playing');
|
||||
|
@ -1,4 +1,4 @@
|
||||
/*
|
||||
/**
|
||||
* @file extend.js
|
||||
* @module extend
|
||||
*/
|
||||
@ -40,6 +40,9 @@ const _inherits = function(subClass, superClass) {
|
||||
* Function for subclassing using the same inheritance that
|
||||
* videojs uses internally
|
||||
*
|
||||
* @static
|
||||
* @const
|
||||
*
|
||||
* @param {Object} superClass
|
||||
* The class to inherit from
|
||||
*
|
||||
|
@ -3404,7 +3404,7 @@ TECH_EVENTS_RETRIGGER.forEach(function(event) {
|
||||
* This does not report whether or not the plugin has ever been initialized
|
||||
* on this player. For that, [usingPlugin]{@link Player#usingPlugin}.
|
||||
*
|
||||
* @method hasPlugin
|
||||
* @method Player#hasPlugin
|
||||
* @param {string} name
|
||||
* The name of a plugin.
|
||||
*
|
||||
@ -3418,7 +3418,7 @@ TECH_EVENTS_RETRIGGER.forEach(function(event) {
|
||||
* For basic plugins, this only reports whether the plugin has _ever_ been
|
||||
* initialized on this player.
|
||||
*
|
||||
* @method usingPlugin
|
||||
* @method Player#usingPlugin
|
||||
* @param {string} name
|
||||
* The name of a plugin.
|
||||
*
|
||||
|
@ -32,6 +32,8 @@ import * as TRACK_TYPES from '../tracks/track-types';
|
||||
/**
|
||||
* A function used by {@link Tech} to create a new {@link TextTrack}.
|
||||
*
|
||||
* @private
|
||||
*
|
||||
* @param {Tech} self
|
||||
* An instance of the Tech class.
|
||||
*
|
||||
@ -554,7 +556,6 @@ class Tech extends Component {
|
||||
/**
|
||||
* Emulate texttracks
|
||||
*
|
||||
* @method emulateTextTracks
|
||||
*/
|
||||
emulateTextTracks() {
|
||||
const tracks = this.textTracks();
|
||||
|
@ -51,9 +51,11 @@ class AudioTrack extends Track {
|
||||
}
|
||||
}
|
||||
/**
|
||||
* @memberof AudioTrack
|
||||
* @member {boolean} enabled
|
||||
* If this `AudioTrack` is enabled or not. When setting this will
|
||||
* fire {@link AudioTrack#enabledchange} if the state of enabled is changed.
|
||||
* @instance
|
||||
*
|
||||
* @fires VideoTrack#selectedchange
|
||||
*/
|
||||
|
@ -32,8 +32,10 @@ class HtmlTrackElementList {
|
||||
list.trackElements_ = [];
|
||||
|
||||
/**
|
||||
* @memberof HTMLTrackElementList
|
||||
* @member {number} length
|
||||
* The current number of `Track`s in the this Trackist.
|
||||
* @instance
|
||||
*/
|
||||
Object.defineProperty(list, 'length', {
|
||||
get() {
|
||||
|
@ -8,6 +8,7 @@ import EventTarget from '../event-target';
|
||||
import TextTrack from '../tracks/text-track';
|
||||
|
||||
/**
|
||||
* @memberof HTMLTrackElement
|
||||
* @typedef {HTMLTrackElement~ReadyState}
|
||||
* @enum {number}
|
||||
*/
|
||||
@ -83,8 +84,10 @@ class HTMLTrackElement extends EventTarget {
|
||||
trackElement.default = track.default;
|
||||
|
||||
/**
|
||||
* @memberof HTMLTrackElement
|
||||
* @member {HTMLTrackElement~ReadyState} readyState
|
||||
* The current ready state of the track element.
|
||||
* @instance
|
||||
*/
|
||||
Object.defineProperty(trackElement, 'readyState', {
|
||||
get() {
|
||||
@ -93,8 +96,11 @@ class HTMLTrackElement extends EventTarget {
|
||||
});
|
||||
|
||||
/**
|
||||
* @memberof HTMLTrackElement
|
||||
* @member {TextTrack} track
|
||||
* The underlying TextTrack object.
|
||||
* @instance
|
||||
*
|
||||
*/
|
||||
Object.defineProperty(trackElement, 'track', {
|
||||
get() {
|
||||
|
@ -5,7 +5,7 @@ import * as browser from '../utils/browser.js';
|
||||
import document from 'global/document';
|
||||
|
||||
/**
|
||||
* @typedef {Object} TextTrackCue
|
||||
* @typedef {Object} TextTrackCueList~TextTrackCue
|
||||
*
|
||||
* @property {string} id
|
||||
* The unique id for this text track cue
|
||||
@ -51,8 +51,10 @@ class TextTrackCueList {
|
||||
TextTrackCueList.prototype.setCues_.call(list, cues);
|
||||
|
||||
/**
|
||||
* @memberof TextTrackCueList
|
||||
* @member {number} length
|
||||
* The current number of `TextTrackCue`s in the TextTrackCueList.
|
||||
* @instance
|
||||
*/
|
||||
Object.defineProperty(list, 'length', {
|
||||
get() {
|
||||
@ -107,7 +109,7 @@ class TextTrackCueList {
|
||||
* @param {string} id
|
||||
* The id of the cue that should be searched for.
|
||||
*
|
||||
* @return {TextTrackCue|null}
|
||||
* @return {TextTrackCueList~TextTrackCue|null}
|
||||
* A single cue or null if none was found.
|
||||
*/
|
||||
getCueById(id) {
|
||||
|
@ -55,6 +55,8 @@ function constructColor(color, opacity) {
|
||||
*
|
||||
* @param {string} rule
|
||||
* The style rule that should be applied to the property.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
function tryUpdateStyle(el, style, rule) {
|
||||
try {
|
||||
|
@ -202,9 +202,11 @@ class TextTrack extends Track {
|
||||
}
|
||||
|
||||
/**
|
||||
* @memberof TextTrack
|
||||
* @member {boolean} default
|
||||
* If this track was set to be on or off by default. Cannot be changed after
|
||||
* creation.
|
||||
* @instance
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
@ -216,9 +218,11 @@ class TextTrack extends Track {
|
||||
});
|
||||
|
||||
/**
|
||||
* @memberof TextTrack
|
||||
* @member {string} mode
|
||||
* Set the mode of this TextTrack to a valid {@link TextTrack~Mode}. Will
|
||||
* not be set if setting to an invalid mode.
|
||||
* @instance
|
||||
*
|
||||
* @fires TextTrack#modechange
|
||||
*/
|
||||
@ -248,8 +252,10 @@ class TextTrack extends Track {
|
||||
});
|
||||
|
||||
/**
|
||||
* @memberof TextTrack
|
||||
* @member {TextTrackCueList} cues
|
||||
* The text track cue list for this TextTrack.
|
||||
* @instance
|
||||
*/
|
||||
Object.defineProperty(tt, 'cues', {
|
||||
get() {
|
||||
@ -263,8 +269,10 @@ class TextTrack extends Track {
|
||||
});
|
||||
|
||||
/**
|
||||
* @memberof TextTrack
|
||||
* @member {TextTrackCueList} activeCues
|
||||
* The list text track cues that are currently active for this TextTrack.
|
||||
* @instance
|
||||
*/
|
||||
Object.defineProperty(tt, 'activeCues', {
|
||||
get() {
|
||||
|
@ -40,8 +40,10 @@ class TrackList extends EventTarget {
|
||||
list.tracks_ = [];
|
||||
|
||||
/**
|
||||
* @memberof TrackList
|
||||
* @member {number} length
|
||||
* The current number of `Track`s in the this Trackist.
|
||||
* @instance
|
||||
*/
|
||||
Object.defineProperty(list, 'length', {
|
||||
get() {
|
||||
|
@ -10,7 +10,7 @@ import HTMLTrackElement from './html-track-element';
|
||||
|
||||
import mergeOptions from '../utils/merge-options';
|
||||
|
||||
/**
|
||||
/*
|
||||
* This file contains all track properties that are used in
|
||||
* player.js, tech.js, html5.js and possibly other techs in the future.
|
||||
*/
|
||||
|
@ -60,30 +60,38 @@ class Track extends EventTarget {
|
||||
};
|
||||
|
||||
/**
|
||||
* @memberof Track
|
||||
* @member {string} id
|
||||
* The id of this track. Cannot be changed after creation.
|
||||
* @instance
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
|
||||
/**
|
||||
* @memberof Track
|
||||
* @member {string} kind
|
||||
* The kind of track that this is. Cannot be changed after creation.
|
||||
* @instance
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
|
||||
/**
|
||||
* @memberof Track
|
||||
* @member {string} label
|
||||
* The label of this track. Cannot be changed after creation.
|
||||
* @instance
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
|
||||
/**
|
||||
* @memberof Track
|
||||
* @member {string} language
|
||||
* The two letter language code for this track. Cannot be changed after
|
||||
* creation.
|
||||
* @instance
|
||||
*
|
||||
* @readonly
|
||||
*/
|
||||
|
@ -51,9 +51,11 @@ class VideoTrack extends Track {
|
||||
}
|
||||
|
||||
/**
|
||||
* @memberof VideoTrack
|
||||
* @member {boolean} selected
|
||||
* If this `VideoTrack` is selected or not. When setting this will
|
||||
* fire {@link VideoTrack#selectedchange} if the state of selected changed.
|
||||
* @instance
|
||||
*
|
||||
* @fires VideoTrack#selectedchange
|
||||
*/
|
||||
|
@ -18,6 +18,9 @@ import window from 'global/window';
|
||||
* The property name you want
|
||||
*
|
||||
* @see https://bugzilla.mozilla.org/show_bug.cgi?id=548397
|
||||
*
|
||||
* @static
|
||||
* @const
|
||||
*/
|
||||
export default function computedStyle(el, prop) {
|
||||
if (!el || !prop) {
|
||||
|
Loading…
x
Reference in New Issue
Block a user