1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-23 02:04:34 +02:00
video.js/docs/legacy-docs/api/fullscreen-toggle.json
Gary Katsevman 4dd000c809
docs: deploy docs using netlify (#4774)
This adds in the legacy docs into the repo and enables automatic deployment via netlify. The netlify-docs.js script will error out the build on netlify on master if we're not on a tagged commit so that it won't redeploy the docs unless there's a new release. If we're not on master or on master with a tagged commit, it will process with the deploy.
Also, this removes the API docs from being published with npm, fixes #4609.
2017-12-04 17:42:07 -05:00

96 lines
2.7 KiB
JSON

[
{
"comment": "/**\n * Toggle fullscreen video\n * @param {Player|Object} player\n * @param {Object=} options\n * @extends Button\n * @class FullScreenToggle\n */",
"meta": {
"range": [
0,
141
],
"filename": "fullscreen-toggle.js",
"lineno": 1,
"path": "/Users/mboles/git/BCL-LearningSamples/jsdoc-tests2",
"code": {}
},
"description": "<p>Toggle fullscreen video</p>",
"params": [
{
"type": {
"names": [
"Player",
"Object"
]
},
"name": "player"
},
{
"type": {
"names": [
"Object"
]
},
"optional": true,
"name": "options"
}
],
"augments": [
"Button"
],
"kind": "class",
"name": "FullScreenToggle",
"longname": "FullScreenToggle",
"scope": "global"
},
{
"comment": "/**\n * Allows sub components to stack CSS class names\n * @return {String}\n * @method buildCSSClass\n */",
"meta": {
"range": [
143,
249
],
"filename": "fullscreen-toggle.js",
"lineno": 9,
"path": "/Users/mboles/git/BCL-LearningSamples/jsdoc-tests2",
"code": {}
},
"description": "<p>Allows sub components to stack CSS class names</p>",
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"kind": "function",
"name": "buildCSSClass",
"longname": "buildCSSClass",
"scope": "global"
},
{
"comment": "/**\n * Handles the click\n * @method handleClick\n */",
"meta": {
"range": [
251,
305
],
"filename": "fullscreen-toggle.js",
"lineno": 15,
"path": "/Users/mboles/git/BCL-LearningSamples/jsdoc-tests2",
"code": {}
},
"description": "<p>Handles the click</p>",
"kind": "function",
"name": "handleClick",
"longname": "handleClick",
"scope": "global"
},
{
"kind": "package",
"longname": "package:undefined",
"files": [
"/Users/mboles/git/BCL-LearningSamples/jsdoc-tests2/fullscreen-toggle.js"
]
}
]