From d448acd224f4eecd5574f3b51a53fc890ba77c78 Mon Sep 17 00:00:00 2001 From: rcrooks Date: Fri, 15 Jan 2016 15:33:15 -0500 Subject: [PATCH] @rcrooks fixed a couple of docs link and a jsdoc comment. closes #2987 --- CHANGELOG.md | 1 + docs/guides/options.md | 2 +- docs/guides/plugins.md | 2 +- docs/guides/setup.md | 2 +- src/js/tracks/html-track-element-list.js | 2 +- src/js/tracks/html-track-element.js | 4 ++++ 6 files changed, 9 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5109ad8f6..db195d722 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ CHANGELOG ## HEAD (Unreleased) * @gkasev updated vjs to correctly return already created player when given an element ([view](https://github.com/videojs/video.js/pull/3006)) * @mister-ben updated CDN urls in setup guide ([view](https://github.com/videojs/video.js/pull/2984)) +* @rcrooks fixed a couple of docs link and a jsdoc comment ([view](https://github.com/videojs/video.js/pull/2987)) -------------------- diff --git a/docs/guides/options.md b/docs/guides/options.md index e75ac14b2..0285dd9b5 100644 --- a/docs/guides/options.md +++ b/docs/guides/options.md @@ -134,5 +134,5 @@ notation. ``` -The [components guide](components.md) has an excellent breakdown of the structure of a player, you +The [components guide](./components.md) has an excellent breakdown of the structure of a player, you just need to remember to nest child components in a `children` array for each level. diff --git a/docs/guides/plugins.md b/docs/guides/plugins.md index 87ce9e0e0..bfe822228 100644 --- a/docs/guides/plugins.md +++ b/docs/guides/plugins.md @@ -17,7 +17,7 @@ You may have already done this step. Code up something interesting and then wrap }); }; -When it's activated, `this` will be the Video.js player your plugin is attached to. You can use anything you'd like in the [Video.js API](api.md) when you're writing a plugin: change the `src`, mess up the DOM, or listen for and emit your own events. +When it's activated, `this` will be the Video.js player your plugin is attached to. You can use anything you'd like in the [Video.js API](./api.md) when you're writing a plugin: change the `src`, mess up the DOM, or listen for and emit your own events. Step 2: Registering A Plugin ------------------------------- diff --git a/docs/guides/setup.md b/docs/guides/setup.md index 085dc4e9a..c9d8852d4 100644 --- a/docs/guides/setup.md +++ b/docs/guides/setup.md @@ -56,7 +56,7 @@ With Video.js you just use an HTML5 video tag to embed a video. Video.js will th > Note: The `data-setup` attribute described here should not be used if you use the alternative setup described in the next section. - 1. The 'data-setup' Attribute tells Video.js to automatically set up the video when the page is ready, and read any options (in JSON format) from the attribute (see [options](options.md)). There are other methods for initializing the player, but this is the easiest. + 1. The 'data-setup' Attribute tells Video.js to automatically set up the video when the page is ready, and read any options (in JSON format) from the attribute (see [options](./options.md)). There are other methods for initializing the player, but this is the easiest. 2. The 'id' Attribute: Should be used and unique for every video on the same page. diff --git a/src/js/tracks/html-track-element-list.js b/src/js/tracks/html-track-element-list.js index 5a66d27e9..9b38d0582 100644 --- a/src/js/tracks/html-track-element-list.js +++ b/src/js/tracks/html-track-element-list.js @@ -1,5 +1,5 @@ /** - * @file html-track-element.js + * @file html-track-element-list.js */ import * as browser from '../utils/browser.js'; diff --git a/src/js/tracks/html-track-element.js b/src/js/tracks/html-track-element.js index 2e6320e99..d799375ef 100644 --- a/src/js/tracks/html-track-element.js +++ b/src/js/tracks/html-track-element.js @@ -1,3 +1,7 @@ +/** + * @file html-track-element.js + */ + import * as browser from '../utils/browser.js'; import document from 'global/document'; import EventTarget from '../event-target';