Master

src/js/base-styles.js

@@ -1,6 +1,8 @@
 /**
-* This code injects the required base styles in the head of the document.
-*/
+ * @file base-styles.js
+ *
+ * This code injects the required base styles in the head of the document.
+ */
 import window from 'global/window';
 import document from 'global/document';
 

src/js/big-play-button.js

@@ -1,22 +1,41 @@
+/**
+ * @file big-play-button.js
+ */
 import Button from './button.js';
 import Component from './component.js';
 
-/* Big Play Button
-================================================================================ */
+/ * Big Play Button
+================================================================================  */
 /**
  * Initial play button. Shows before the video has played. The hiding of the
  * big play button is done via CSS and player states.
- * @param {Player|Object} player
- * @param {Object=} options
- * @class
- * @constructor
+ *
+ * @param {Object} player  Main Player
+ * @param {Object=} options Object of option names and values
+ * @extends Button
+ * @class BigPlayButton
  */
 class BigPlayButton extends Button {
 
+  constructor(player, options) {
+    super(player, options);
+  }
+
+  /**
+   * Allow sub components to stack CSS class names
+   *
+   * @return {String} The constructed class name
+   * @method buildCSSClass
+   */
   buildCSSClass() {
     return 'vjs-big-play-button';
   }
 
+  /**
+   * Handles click for play 
+   *
+   * @method handleClick
+   */
   handleClick() {
     this.player_.play();
   }

src/js/button.js

@@ -1,16 +1,20 @@
+/**
+ * @file button.js
+ */
 import Component from './component';
 import * as Dom from './utils/dom.js';
 import * as Events from './utils/events.js';
 import * as Fn from './utils/fn.js';
 import document from 'global/document';
 import assign from 'object.assign';
 
-/* Button - Base class for all buttons
-================================================================================ */
+/ * Button - Base class for all buttons
+================================================================================  */
 /**
  * Base class for all buttons
- * @param {Player|Object} player
- * @param {Object=} options
+ *
+ * @param {Object} player  Main Player
+ * @param {Object=} options Object of option names and values
  * @extends Component
  * @class Button
  */
@@ -27,6 +31,14 @@ class Button extends Component {
     this.on('blur', this.handleBlur);
   }
 
+  /**
+   * Create the component's DOM element
+   *
+   * @param {String=} type Element's node type. e.g. 'div'
+   * @param {Object=} props An object of element attributes that should be set on the element Tag name 
+   * @return {Element}
+   * @method createEl
+   */
   createEl(type='button', props={}) {
     // Add standard Aria and Tabindex info
     props = assign({
@@ -49,6 +61,13 @@ class Button extends Component {
     return el;
   }
 
+  /**
+   * Controls text - both request and localize 
+   *
+   * @param {String} text Text for button
+   * @return {String}
+   * @method controlText
+   */
   controlText(text) {
     if (!text) return this.controlText_ || 'Need Text';
 
@@ -58,19 +77,37 @@ class Button extends Component {
     return this;
   }
 
+  /**
+   * Allows sub components to stack CSS class names
+   *
+   * @return {String}
+   * @method buildCSSClass
+   */
   buildCSSClass() {
     return `vjs-control vjs-button ${super.buildCSSClass()}`;
   }
 
-  // Click - Override with specific functionality for button
+  /**
+   * Handle Click - Override with specific functionality for button
+   *
+   * @method handleClick
+   */
   handleClick() {}
 
-  // Focus - Add keyboard functionality to element
+  /**
+   * Handle Focus - Add keyboard functionality to element
+   *
+   * @method handleFocus
+   */
   handleFocus() {
     Events.on(document, 'keydown', Fn.bind(this, this.handleKeyPress));
   }
 
-  // KeyPress (document level) - Trigger click when keys are pressed
+  /**
+   * Handle KeyPress (document level) - Trigger click when keys are pressed
+   *
+   * @method handleKeyPress
+   */
   handleKeyPress(event) {
     // Check for space bar (32) or enter (13) keys
     if (event.which === 32 || event.which === 13) {
@@ -79,7 +116,11 @@ class Button extends Component {
     }
   }
 
-  // Blur - Remove keyboard triggers
+  /**
+   * Handle Blur - Remove keyboard triggers
+   *
+   * @method handleBlur
+   */
   handleBlur() {
     Events.off(document, 'keydown', Fn.bind(this, this.handleKeyPress));
   }