Skip to content

Commit

Permalink
Fixed generated doc links. (googleads#233)
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnbuso committed May 16, 2016
1 parent 764cc46 commit 6a44b3d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ module.exports = function(grunt) {
src: ['src/videojs.ima.js'],
dest: 'docs/api',
options: {
baseURL: 'https://github.com/googleads/videojs-ima/blob/master'
baseURL: 'https://github.com/googleads/videojs-ima/blob/master/'
}
}
}
Expand Down
32 changes: 16 additions & 16 deletions docs/api/player.ima.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
##### PARAMETERS:
* __listener__ `function` The listener to be called when content and ads complete.

_defined in_: [src/videojs.ima.js#L806](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L806)
_defined in_: [src/videojs.ima.js#L806](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L806)

---

Expand All @@ -49,7 +49,7 @@ _defined in_: [src/videojs.ima.js#L806](https://github.com/googleads/videojs-ima
##### PARAMETERS:
* __listener__ `function` The listener to be called when content completes.

_defined in_: [src/videojs.ima.js#L797](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L797)
_defined in_: [src/videojs.ima.js#L797](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L797)

---

Expand All @@ -62,7 +62,7 @@ _defined in_: [src/videojs.ima.js#L797](https://github.com/googleads/videojs-ima
* __event__ `google.ima.AdEvent.Type` The AdEvent.Type for which to listen.
* __callback__ `function` The method to call when the event is fired.

_defined in_: [src/videojs.ima.js#L699](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L699)
_defined in_: [src/videojs.ima.js#L699](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L699)

---

Expand All @@ -72,44 +72,44 @@ _defined in_: [src/videojs.ima.js#L699](https://github.com/googleads/videojs-ima
##### RETURNS:
* `google.ima.AdsManager` The AdsManager being used by the plugin.

_defined in_: [src/videojs.ima.js#L709](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L709)
_defined in_: [src/videojs.ima.js#L709](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L709)

---

### initializeAdDisplayContainer()
> Initializes the AdDisplayContainer. On mobile, this must be done as a
> result of user action.
_defined in_: [src/videojs.ima.js#L135](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L135)
_defined in_: [src/videojs.ima.js#L135](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L135)

---

### pauseAd()
> Pauses the ad.
_defined in_: [src/videojs.ima.js#L821](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L821)
_defined in_: [src/videojs.ima.js#L821](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L821)

---

### playAdBreak()
> Called by publishers in manual ad break playback mode to start an ad
> break.
_defined in_: [src/videojs.ima.js#L306](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L306)
_defined in_: [src/videojs.ima.js#L306](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L306)

---

### requestAds()
> Creates the AdsRequest and request ads through the AdsLoader.
_defined in_: [src/videojs.ima.js#L143](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L143)
_defined in_: [src/videojs.ima.js#L143](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L143)

---

### resumeAd()
> Resumes the ad.
_defined in_: [src/videojs.ima.js#L832](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L832)
_defined in_: [src/videojs.ima.js#L832](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L832)

---

Expand All @@ -119,7 +119,7 @@ _defined in_: [src/videojs.ima.js#L832](https://github.com/googleads/videojs-ima
##### PARAMETERS:
* __listener__ `function` The listener to be called to trigger manual ad break playback.

_defined in_: [src/videojs.ima.js#L814](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L814)
_defined in_: [src/videojs.ima.js#L814](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L814)

---

Expand All @@ -134,7 +134,7 @@ _defined in_: [src/videojs.ima.js#L814](https://github.com/googleads/videojs-ima
* __adTag__ `?string` The ad tag to be requested when the content loads.
* __playOnLoad__ `?boolean` True to play the content once it has loaded,

_defined in_: [src/videojs.ima.js#L725](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L725)
_defined in_: [src/videojs.ima.js#L725](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L725)

---

Expand All @@ -148,7 +148,7 @@ _defined in_: [src/videojs.ima.js#L725](https://github.com/googleads/videojs-ima
* __adTag__ `?string` The ad tag to be requested when the content loads.
* __playOnLoad__ `?boolean` True to play the content once it has loaded,

_defined in_: [src/videojs.ima.js#L743](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L743)
_defined in_: [src/videojs.ima.js#L743](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L743)

---

Expand All @@ -162,7 +162,7 @@ _defined in_: [src/videojs.ima.js#L743](https://github.com/googleads/videojs-ima
* __adsResponse__ `?string` The ads response to be requested when the
* __playOnLoad__ `?boolean` True to play the content once it has loaded,

_defined in_: [src/videojs.ima.js#L760](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L760)
_defined in_: [src/videojs.ima.js#L760](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L760)

---

Expand All @@ -172,7 +172,7 @@ _defined in_: [src/videojs.ima.js#L760](https://github.com/googleads/videojs-ima
##### PARAMETERS:
* __showCountdownIn__ `boolean` Show or hide the countdown timer.

_defined in_: [src/videojs.ima.js#L907](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L907)
_defined in_: [src/videojs.ima.js#L907](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L907)

---

Expand All @@ -181,7 +181,7 @@ _defined in_: [src/videojs.ima.js#L907](https://github.com/googleads/videojs-ima
> Start ad playback, or content video playback in the absence of a
> pre-roll.
_defined in_: [src/videojs.ima.js#L233](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L233)
_defined in_: [src/videojs.ima.js#L233](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L233)

---

Expand All @@ -194,7 +194,7 @@ _defined in_: [src/videojs.ima.js#L233](https://github.com/googleads/videojs-ima
> you should call this method in the last line of that callback. For more
> info, see this method's usage in our advanced and playlist examples.
_defined in_: [src/videojs.ima.js#L248](https://github.com/googleads/videojs-ima/blob/mastersrc/videojs.ima.js#L248)
_defined in_: [src/videojs.ima.js#L248](https://github.com/googleads/videojs-ima/blob/master/src/videojs.ima.js#L248)

---

0 comments on commit 6a44b3d

Please sign in to comment.