From 6ad1e5c97b2e7a1527d52638dc4672c52bcd391d Mon Sep 17 00:00:00 2001
From: Gary Katsevman <git@gkatsev.com>
Date: Thu, 2 Feb 2017 11:07:34 -0500
Subject: [PATCH] docs: fixup global jsdoc members (#4015)

---
 src/js/control-bar/play-toggle.js        | 1 -
 src/js/extend.js                         | 5 ++++-
 src/js/player.js                         | 4 ++--
 src/js/tech/tech.js                      | 3 ++-
 src/js/tracks/audio-track.js             | 2 ++
 src/js/tracks/html-track-element-list.js | 2 ++
 src/js/tracks/html-track-element.js      | 6 ++++++
 src/js/tracks/text-track-cue-list.js     | 6 ++++--
 src/js/tracks/text-track-display.js      | 2 ++
 src/js/tracks/text-track.js              | 8 ++++++++
 src/js/tracks/track-list.js              | 2 ++
 src/js/tracks/track-types.js             | 2 +-
 src/js/tracks/track.js                   | 8 ++++++++
 src/js/tracks/video-track.js             | 2 ++
 src/js/utils/computed-style.js           | 3 +++
 15 files changed, 48 insertions(+), 8 deletions(-)

diff --git a/src/js/control-bar/play-toggle.js b/src/js/control-bar/play-toggle.js
index 28dc86887..51c2af1e4 100644
--- a/src/js/control-bar/play-toggle.js
+++ b/src/js/control-bar/play-toggle.js
@@ -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');
diff --git a/src/js/extend.js b/src/js/extend.js
index df8a5a1af..783b2749a 100644
--- a/src/js/extend.js
+++ b/src/js/extend.js
@@ -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
  *
diff --git a/src/js/player.js b/src/js/player.js
index 1da0876ea..7f37aacea 100644
--- a/src/js/player.js
+++ b/src/js/player.js
@@ -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.
  *
diff --git a/src/js/tech/tech.js b/src/js/tech/tech.js
index 455bedc72..1db971a41 100644
--- a/src/js/tech/tech.js
+++ b/src/js/tech/tech.js
@@ -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();
diff --git a/src/js/tracks/audio-track.js b/src/js/tracks/audio-track.js
index 1334e01f1..ec760ae8a 100644
--- a/src/js/tracks/audio-track.js
+++ b/src/js/tracks/audio-track.js
@@ -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
      */
diff --git a/src/js/tracks/html-track-element-list.js b/src/js/tracks/html-track-element-list.js
index 5f1832099..ceb6ba19c 100644
--- a/src/js/tracks/html-track-element-list.js
+++ b/src/js/tracks/html-track-element-list.js
@@ -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() {
diff --git a/src/js/tracks/html-track-element.js b/src/js/tracks/html-track-element.js
index f61d15a98..a736fd414 100644
--- a/src/js/tracks/html-track-element.js
+++ b/src/js/tracks/html-track-element.js
@@ -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() {
diff --git a/src/js/tracks/text-track-cue-list.js b/src/js/tracks/text-track-cue-list.js
index dcd0a24b3..ec751a56b 100644
--- a/src/js/tracks/text-track-cue-list.js
+++ b/src/js/tracks/text-track-cue-list.js
@@ -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) {
diff --git a/src/js/tracks/text-track-display.js b/src/js/tracks/text-track-display.js
index d69514638..0097dd67a 100644
--- a/src/js/tracks/text-track-display.js
+++ b/src/js/tracks/text-track-display.js
@@ -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 {
diff --git a/src/js/tracks/text-track.js b/src/js/tracks/text-track.js
index 90f041560..6eb8fd01a 100644
--- a/src/js/tracks/text-track.js
+++ b/src/js/tracks/text-track.js
@@ -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() {
diff --git a/src/js/tracks/track-list.js b/src/js/tracks/track-list.js
index 44f7fa55e..aed95ef91 100644
--- a/src/js/tracks/track-list.js
+++ b/src/js/tracks/track-list.js
@@ -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() {
diff --git a/src/js/tracks/track-types.js b/src/js/tracks/track-types.js
index 3f3f3511a..6cc9e0002 100644
--- a/src/js/tracks/track-types.js
+++ b/src/js/tracks/track-types.js
@@ -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.
  */
diff --git a/src/js/tracks/track.js b/src/js/tracks/track.js
index 2e9930238..1b39a237d 100644
--- a/src/js/tracks/track.js
+++ b/src/js/tracks/track.js
@@ -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
      */
diff --git a/src/js/tracks/video-track.js b/src/js/tracks/video-track.js
index 46ba12ace..6fb3644d8 100644
--- a/src/js/tracks/video-track.js
+++ b/src/js/tracks/video-track.js
@@ -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
      */
diff --git a/src/js/utils/computed-style.js b/src/js/utils/computed-style.js
index e2d6a4463..c063e9d08 100644
--- a/src/js/utils/computed-style.js
+++ b/src/js/utils/computed-style.js
@@ -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) {