Skip to content

M
my-cucumbers-ru-github-io
Commit 0dac96b4 authored by miripiruni's avatar miripiruni
Browse files
Options

JSDoc: All callbacks are optional

parent b87fc92c
Hide whitespace changes
Inline Side-by-side
Showing with 8 additions and 8 deletions
shower.js
View file @ 0dac96b4
...@@ -160,7 +160,7 @@ window.shower = (function(window, document, undefined) { ...@@ -160,7 +160,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Show next slide. If slide is last returns false, otherwise return slide * Show next slide. If slide is last returns false, otherwise return slide
* number which been shown. * number which been shown.
* @param {Function} callback runs only if shower.next() complete successfully * @param {Function} [callback] runs only if shower.next() complete successfully
* @returns {Number|Boolean} * @returns {Number|Boolean}
*/ */
shower.next = function(callback) { shower.next = function(callback) {
...@@ -192,7 +192,7 @@ window.shower = (function(window, document, undefined) { ...@@ -192,7 +192,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Show previous slide. If slide is first returns false, otherwise return slide * Show previous slide. If slide is first returns false, otherwise return slide
* number which been shown. * number which been shown.
* @param {Function} callback runs only if shower.previous() complete successfully * @param {Function} [callback] runs only if shower.previous() complete successfully
* @returns {Number|Boolean} * @returns {Number|Boolean}
*/ */
shower.previous = function(callback) { shower.previous = function(callback) {
...@@ -216,7 +216,7 @@ window.shower = (function(window, document, undefined) { ...@@ -216,7 +216,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Show first slide. * Show first slide.
* @param {Function} callback * @param {Function} [callback]
* @returns {Number} * @returns {Number}
*/ */
shower.first = function(callback) { shower.first = function(callback) {
...@@ -229,7 +229,7 @@ window.shower = (function(window, document, undefined) { ...@@ -229,7 +229,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Show last slide. * Show last slide.
* @param {Function} callback * @param {Function} [callback]
* @returns {Number} * @returns {Number}
*/ */
shower.last = function(callback) { shower.last = function(callback) {
...@@ -241,7 +241,7 @@ window.shower = (function(window, document, undefined) { ...@@ -241,7 +241,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Switch to slide view. * Switch to slide view.
* @param {Function} callback runs only if shower.enterSlideMode() complete successfully * @param {Function} [callback] runs only if shower.enterSlideMode() complete successfully
* @returns {Number|Boolean} * @returns {Number|Boolean}
*/ */
shower.enterSlideMode = function(callback) { shower.enterSlideMode = function(callback) {
...@@ -278,7 +278,7 @@ window.shower = (function(window, document, undefined) { ...@@ -278,7 +278,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Switch to list view. * Switch to list view.
* @param {Function} callback runs only if shower.enterListMode() complete successfully * @param {Function} [callback] runs only if shower.enterListMode() complete successfully
* @returns {Number} * @returns {Number}
*/ */
shower.enterListMode = function(callback) { shower.enterListMode = function(callback) {
...@@ -302,7 +302,7 @@ window.shower = (function(window, document, undefined) { ...@@ -302,7 +302,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Toggle Mode: Slide and List * Toggle Mode: Slide and List
* @param {Function} callback * @param {Function} [callback]
*/ */
shower.toggleMode = function(callback) { shower.toggleMode = function(callback) {
if (shower.isListMode()) { if (shower.isListMode()) {
...@@ -487,7 +487,7 @@ window.shower = (function(window, document, undefined) { ...@@ -487,7 +487,7 @@ window.shower = (function(window, document, undefined) {
/** /**
* Go to slide number... * Go to slide number...
* @param {Number} slideNumber slide number (sic!). Attention: starts from zero. * @param {Number} slideNumber slide number (sic!). Attention: starts from zero.
* @param {Function} callback runs only if you not in List mode * @param {Function} [callback] runs only if you not in List mode
* @returns {Number} * @returns {Number}
*/ */
shower.go = function(slideNumber, callback) { shower.go = function(slideNumber, callback) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment