Skip to content

Commit

Permalink
Updated docs with recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@heff
heff committed Nov 6, 2013
1 parent b6c902a commit 9662736
Show file tree
Hide file tree
Showing 46 changed files with 1,313 additions and 998 deletions.
53 changes: 30 additions & 23 deletions docs/api/vjs.BigPlayButton.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@ big play button is done via CSS and player states.
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
Expand Down Expand Up @@ -155,7 +155,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component

_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)

---

Expand Down Expand Up @@ -186,7 +186,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---

### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
Expand All @@ -213,21 +213,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js

### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger

##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting

_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)

---

### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
Expand All @@ -249,7 +254,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---

### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
Expand Down Expand Up @@ -379,10 +384,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values

##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged

_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)

Expand Down Expand Up @@ -477,18 +482,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger

##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting

_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)

---

Expand All @@ -497,7 +504,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)

---

53 changes: 30 additions & 23 deletions docs/api/vjs.Button.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ Base class for all buttons
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
Expand Down Expand Up @@ -154,7 +154,7 @@ _inherited from_: [src/js/component.js#L190](https://github.com/videojs/video.js
##### RETURNS:
* `vjs.Component` The component

_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)

---

Expand Down Expand Up @@ -185,7 +185,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---

### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
Expand All @@ -212,21 +212,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js

### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger

##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting

_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)

---

### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
Expand All @@ -248,7 +253,7 @@ _inherited from_: [src/js/component.js#L239](https://github.com/videojs/video.js
---

### init( player, options, ready )
> the constructor funciton for the class
> the constructor function for the class
##### PARAMETERS:
* __player__
Expand Down Expand Up @@ -378,10 +383,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values

##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged

_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)

Expand Down Expand Up @@ -476,18 +481,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger

##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting

_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)

---

Expand All @@ -496,7 +503,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)

---

51 changes: 29 additions & 22 deletions docs/api/vjs.CaptionsButton.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@ The button component for toggling and selecting captions
>
> Pass in options for child constructors and options for children of the child
>
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
> var myButton = myComponent.addChild('MyButton', {
> text: 'Press Me',
> children: {
> buttonChildExample: {
> buttonChildOption: true
> }
> }
> });
##### PARAMETERS:
* __child__ `String|vjs.Component` The class name or instance of a child to add
Expand Down Expand Up @@ -159,7 +159,7 @@ _inherited from_: [src/js/menu.js#L154](https://github.com/videojs/video.js/blob
##### RETURNS:
* `vjs.Component` The component

_inherited from_: [src/js/component.js#L730](https://github.com/videojs/video.js/blob/master/src/js/component.js#L730)
_inherited from_: [src/js/component.js#L737](https://github.com/videojs/video.js/blob/master/src/js/component.js#L737)

---

Expand Down Expand Up @@ -190,7 +190,7 @@ _inherited from_: [src/js/component.js#L201](https://github.com/videojs/video.js
---

### getChild( name )
> Returns a child component with the provided ID
> Returns a child component with the provided name
##### PARAMETERS:
* __name__
Expand All @@ -217,21 +217,26 @@ _inherited from_: [src/js/component.js#L294](https://github.com/videojs/video.js

### height( [num], [skipListeners] )
> Get or set the height of the component (CSS values)
>
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ New component height
* __skipListeners__ `Boolean` _(OPTIONAL)_ Skip the resize event trigger

##### RETURNS:
* `vjs.Component` The component if the height was set
* `Number|String` The height if it wasn't set
* `vjs.Component` This component, when setting the height
* `Number|String` The height, when getting

_inherited from_: [src/js/component.js#L719](https://github.com/videojs/video.js/blob/master/src/js/component.js#L719)
_inherited from_: [src/js/component.js#L726](https://github.com/videojs/video.js/blob/master/src/js/component.js#L726)

---

### hide()
> Hide the component element if hidden
> Hide the component element if currently showing
##### RETURNS:
* `vjs.Component`
Expand Down Expand Up @@ -382,10 +387,10 @@ _inherited from_: [src/js/component.js#L522](https://github.com/videojs/video.js
> }
##### PARAMETERS:
* __obj__ `Object` Object whose values will be overwritten
* __obj__ `Object` Object of new option values

##### RETURNS:
* `Object` NEW merged object. Does not return obj1.
* `Object` A NEW object of this.options_ and obj merged

_inherited from_: [src/js/component.js#L169](https://github.com/videojs/video.js/blob/master/src/js/component.js#L169)

Expand Down Expand Up @@ -480,18 +485,20 @@ _inherited from_: [src/js/component.js#L600](https://github.com/videojs/video.js
### width( [num], skipListeners )
> Set or get the width of the component (CSS values)
>
> Video tag width/height only work in pixels. No percents.
> But allowing limited percents use. e.g. width() will return number+%, not computed width
> Setting the video tag dimension values only works with values in pixels.
> Percent values will not work.
> Some percents can be used, but width()/height() will return the number + %,
> not the actual computed width/height.
##### PARAMETERS:
* __num__ `Number|String` _(OPTIONAL)_ Optional width number
* __skipListeners__ `Boolean` Skip the 'resize' event trigger

##### RETURNS:
* `vjs.Component` Returns 'this' if width was set
* `Number|String` Returns the width if nothing was set
* `vjs.Component` This component, when setting the width
* `Number|String` The width, when getting

_inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js/blob/master/src/js/component.js#L707)
_inherited from_: [src/js/component.js#L709](https://github.com/videojs/video.js/blob/master/src/js/component.js#L709)

---

Expand All @@ -500,7 +507,7 @@ _inherited from_: [src/js/component.js#L707](https://github.com/videojs/video.js
### resize `EVENT`
> Fired when the width and/or height of the component changes
_inherited from_: [src/js/component.js#L809](https://github.com/videojs/video.js/blob/master/src/js/component.js#L809)
_inherited from_: [src/js/component.js#L816](https://github.com/videojs/video.js/blob/master/src/js/component.js#L816)

---

Loading

0 comments on commit 9662736

Please sign in to comment.