1
0
mirror of https://github.com/webslides/WebSlides.git synced 2025-08-16 18:14:09 +02:00

Minor doc changes

This commit is contained in:
Antonio Laguna
2017-03-19 23:09:33 +01:00
parent 3d549d7b97
commit 2d86be6aac
9 changed files with 17 additions and 15 deletions

View File

@@ -6,6 +6,7 @@ import DOM from '../utils/dom';
export default class AutoSlide {
/**
* @param {WebSlides} wsInstance The WebSlides instance
* @constructor
*/
constructor(wsInstance) {
/**

View File

@@ -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) {
/**

View File

@@ -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) {
/**

View File

@@ -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;

View File

@@ -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) {
/**

View File

@@ -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 ?

View File

@@ -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) {
/**

View File

@@ -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
*/

View File

@@ -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) {
/**