From 0dac96b4deb952c4b8e1f611b8d9ee377e7a6733 Mon Sep 17 00:00:00 2001 From: miripiruni Date: Sun, 20 Jan 2013 03:24:58 +0400 Subject: [PATCH] JSDoc: All callbacks are optional --- shower.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/shower.js b/shower.js index 12984ff..c71888b 100755 --- a/shower.js +++ b/shower.js @@ -160,7 +160,7 @@ window.shower = (function(window, document, undefined) { /** * Show next slide. If slide is last returns false, otherwise return slide * 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} */ shower.next = function(callback) { @@ -192,7 +192,7 @@ window.shower = (function(window, document, undefined) { /** * Show previous slide. If slide is first returns false, otherwise return slide * 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} */ shower.previous = function(callback) { @@ -216,7 +216,7 @@ window.shower = (function(window, document, undefined) { /** * Show first slide. - * @param {Function} callback + * @param {Function} [callback] * @returns {Number} */ shower.first = function(callback) { @@ -229,7 +229,7 @@ window.shower = (function(window, document, undefined) { /** * Show last slide. - * @param {Function} callback + * @param {Function} [callback] * @returns {Number} */ shower.last = function(callback) { @@ -241,7 +241,7 @@ window.shower = (function(window, document, undefined) { /** * 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} */ shower.enterSlideMode = function(callback) { @@ -278,7 +278,7 @@ window.shower = (function(window, document, undefined) { /** * 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} */ shower.enterListMode = function(callback) { @@ -302,7 +302,7 @@ window.shower = (function(window, document, undefined) { /** * Toggle Mode: Slide and List - * @param {Function} callback + * @param {Function} [callback] */ shower.toggleMode = function(callback) { if (shower.isListMode()) { @@ -487,7 +487,7 @@ window.shower = (function(window, document, undefined) { /** * Go to slide number... * @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} */ shower.go = function(slideNumber, callback) {