diff --git a/package.json b/package.json index 70a910cbc..4662553eb 100644 --- a/package.json +++ b/package.json @@ -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}": [ diff --git a/src/ott/player-defaults.js b/src/ott/player-defaults.js index b8bb4f034..05bea3563 100644 --- a/src/ott/player-defaults.js +++ b/src/ott/player-defaults.js @@ -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 { diff --git a/src/ott/poster.js b/src/ott/poster.js index 48798f574..aec4ffd9a 100644 --- a/src/ott/poster.js +++ b/src/ott/poster.js @@ -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 { @@ -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 { @@ -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, playerWidth: number, playerHeight: number): string { diff --git a/src/setup.js b/src/setup.js index 91f77b30f..40b111078 100644 --- a/src/setup.js +++ b/src/setup.js @@ -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 {