Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan Ziv committed Nov 13, 2018
1 parent 6d5c46c commit b20c327
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 1 deletion.
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
"playkit-dev-ott:start": "playkit-dev start ott",
"playkit-dev:stop": "playkit-dev stop",
"playkit-rel": "playkit-rel start",
"precommit": "lint-staged"
"precommit": "lint-staged",
"docs:generate": "documentation build flow-typed/** src/** -f md -o docs/api.md",
"docs:serve": "documentation serve flow-typed/** src/** --watch"
},
"lint-staged": {
"*.{js,jsx}": [
Expand Down
1 change: 1 addition & 0 deletions src/ott/player-defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {Utils} from '@playkit-js/playkit-js';
/**
* Sets the default analytics plugin for the ott player.
* @param {KPOptionsObject} options - The player config.
* @private
* @returns {void}
*/
export function setDefaultAnalyticsPlugin(options: KPOptionsObject): void {
Expand Down
3 changes: 3 additions & 0 deletions src/ott/poster.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* @param {PKSourcesConfigObject} playerSources - player sources container
* @param {ProviderMediaConfigSourcesObject} mediaSources - media config sources container
* @param {Object} dimensions - player dimensions object
* @private
* @returns {void}
*/
function addKalturaPoster(playerSources: PKSourcesConfigObject, mediaSources: ProviderMediaConfigSourcesObject, dimensions: Object): void {
Expand All @@ -28,6 +29,7 @@ function addKalturaPoster(playerSources: PKSourcesConfigObject, mediaSources: Pr
* @param {string} poster - Player url.
* @param {number} playerWidth - Player width.
* @param {height} playerHeight - Player height.
* @private
* @return {string} - The new poster url including the player dimensions.
*/
function setPlayerDimensionsOnPoster(poster: string, playerWidth: number, playerHeight: number): string {
Expand All @@ -47,6 +49,7 @@ function setPlayerDimensionsOnPoster(poster: string, playerWidth: number, player
* @param {string} posters - Array of posters candidates.
* @param {number} playerWidth - Player width.
* @param {height} playerHeight - Player height.
* @private
* @return {string} - The poster url.
*/
function selectPosterByPlayerDimensions(posters: Array<Object>, playerWidth: number, playerHeight: number): string {
Expand Down
1 change: 1 addition & 0 deletions src/setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
/**
* Setup the Kaltura Player.
* @param {PartialKPOptionsObject|LegacyPartialKPOptionsObject} options - partial kaltura player options
* @private
* @returns {KalturaPlayer} - The Kaltura Player.
*/
function setup(options: PartialKPOptionsObject | LegacyPartialKPOptionsObject): KalturaPlayer {
Expand Down

0 comments on commit b20c327

Please sign in to comment.