From 2d86be6aac39eb699c1d165cfb04cfae0842838b Mon Sep 17 00:00:00 2001 From: Antonio Laguna Date: Sun, 19 Mar 2017 23:09:33 +0100 Subject: [PATCH] Minor doc changes --- src/js/plugins/autoslide.js | 1 + src/js/plugins/click-nav.js | 4 ++-- src/js/plugins/grid.js | 4 ++-- src/js/plugins/hash.js | 2 +- src/js/plugins/keyboard.js | 4 ++-- src/js/plugins/navigation.js | 3 +-- src/js/plugins/scroll.js | 2 +- src/js/plugins/touch.js | 5 +++-- src/js/plugins/video.js | 7 ++++--- 9 files changed, 17 insertions(+), 15 deletions(-) diff --git a/src/js/plugins/autoslide.js b/src/js/plugins/autoslide.js index e3e282f..b87816a 100644 --- a/src/js/plugins/autoslide.js +++ b/src/js/plugins/autoslide.js @@ -6,6 +6,7 @@ import DOM from '../utils/dom'; export default class AutoSlide { /** * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { /** diff --git a/src/js/plugins/click-nav.js b/src/js/plugins/click-nav.js index 4b5acb9..331a1e5 100644 --- a/src/js/plugins/click-nav.js +++ b/src/js/plugins/click-nav.js @@ -8,12 +8,12 @@ const CLICKABLE_ELS = [ ]; /** - * Click to Nav plugin. + * ClickNav plugin that allows to click on the page to get to the next slide. */ export default class ClickNav { /** - * ClickNav plugin that allows to click on the page to get to the next slide. * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { /** diff --git a/src/js/plugins/grid.js b/src/js/plugins/grid.js index 828f925..e3130c6 100644 --- a/src/js/plugins/grid.js +++ b/src/js/plugins/grid.js @@ -5,12 +5,12 @@ const GRID_IMAGE = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYAg' + 'AA9bBR3ExhAJB1iooBQBGwgVEs/QtuAAAAABJRU5ErkJggg=='; /** - * Grid plugin. + * Grid plugin that shows a grid on top of the WebSlides for easy prototyping. */ export default class Grid { /** - * Grid plugin that shows a grid on top of the WebSlides for easy prototyping. * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { /** diff --git a/src/js/plugins/hash.js b/src/js/plugins/hash.js index a237c44..045cd78 100644 --- a/src/js/plugins/hash.js +++ b/src/js/plugins/hash.js @@ -7,8 +7,8 @@ const slideRegex = /#slide=(\d+)/; */ export default class Hash { /** - * Listens to the slide change event and the hash change events. * @param {WebSlides} wsInstance + * @constructor */ constructor(wsInstance) { this.ws_ = wsInstance; diff --git a/src/js/plugins/keyboard.js b/src/js/plugins/keyboard.js index 9c65a38..1d38a6a 100644 --- a/src/js/plugins/keyboard.js +++ b/src/js/plugins/keyboard.js @@ -2,12 +2,12 @@ import Keys from '../utils/keys'; import DOM from '../utils/dom'; /** - * Keyboard plugin. + * Keyboard interaction plugin. */ export default class Keyboard { /** - * Keyboard interaction plugin. * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { /** diff --git a/src/js/plugins/navigation.js b/src/js/plugins/navigation.js index e60da06..264f37c 100644 --- a/src/js/plugins/navigation.js +++ b/src/js/plugins/navigation.js @@ -23,9 +23,8 @@ const LABELS = { */ export default class Navigation { /** - * The Navigation constructor. It'll create all the nodes needed for the - * navigation such as the arrows and the counter. * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { const arrowLabels = wsInstance.isVertical ? diff --git a/src/js/plugins/scroll.js b/src/js/plugins/scroll.js index a1a3784..b909683 100644 --- a/src/js/plugins/scroll.js +++ b/src/js/plugins/scroll.js @@ -6,8 +6,8 @@ import MobileDetector from '../utils/mobile-detector'; */ export default class Scroll { /** - * Scroll handler for the WebSlides. * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { /** diff --git a/src/js/plugins/touch.js b/src/js/plugins/touch.js index 2af3e33..2b60e4c 100644 --- a/src/js/plugins/touch.js +++ b/src/js/plugins/touch.js @@ -19,6 +19,7 @@ const EVENTS = { export default class Touch { /** * @param {WebSlides} wsInstance The WebSlides instance + * @constructor */ constructor(wsInstance) { /** @@ -28,14 +29,14 @@ export default class Touch { this.ws_ = wsInstance; /** - * Start position for the X coord. + * Start position for the X coordinate. * @type {number} * @private */ this.startX_ = 0; /** - * Start position for the Y coord. + * Start position for the Y coordinate. * @type {number} * @private */ diff --git a/src/js/plugins/video.js b/src/js/plugins/video.js index 9fd67c6..1640ede 100644 --- a/src/js/plugins/video.js +++ b/src/js/plugins/video.js @@ -2,12 +2,13 @@ import DOM from '../utils/dom'; import Slide from '../modules/slide'; /** - * Video plugin. + * Video plugin. Video plugin that allows to autoplay videos once the slide gets + * active. */ export default class Video { /** - * Grid plugin that shows a grid on top of the WebSlides for easy prototyping. - * @param {WebSlides} wsInstance The WebSlides instance + * @param {WebSlides} wsInstance The WebSlides instance. + * @constructor */ constructor(wsInstance) { /**