Update JSDoc class docs

master
Daniel Rudolf 6 years ago
parent fc941aab0c
commit 8df986b02e
No known key found for this signature in database
GPG Key ID: A061F02CD8DE4538
  1. 2
      css/style.css
  2. 2
      js/pico.js
  3. 21
      js/utils.js

@ -11,7 +11,7 @@
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link http://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license http://opensource.org/licenses/MIT The MIT License
* @version 2.0 * @version 2.1
*/ */
* { * {

@ -6,7 +6,7 @@
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link http://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license http://opensource.org/licenses/MIT The MIT License
* @version 2.0 * @version 2.1
*/ */
function main() function main()

@ -6,7 +6,7 @@
* @author Daniel Rudolf * @author Daniel Rudolf
* @link http://picocms.org * @link http://picocms.org
* @license http://opensource.org/licenses/MIT The MIT License * @license http://opensource.org/licenses/MIT The MIT License
* @version 2.0 * @version 2.1
*/ */
utils = {}; utils = {};
@ -14,7 +14,7 @@ utils = {};
/** /**
* Checks whether the client's browser is able to slide elements or not * Checks whether the client's browser is able to slide elements or not
* *
* @return boolean TRUE when the browser supports sliding, FALSE otherwise * @return {bool} TRUE when the browser supports sliding, FALSE otherwise
*/ */
utils.canSlide = function () utils.canSlide = function ()
{ {
@ -24,10 +24,10 @@ utils.canSlide = function ()
/** /**
* Slides a element up (i.e. hide a element by changing its height to 0px) * Slides a element up (i.e. hide a element by changing its height to 0px)
* *
* @param HTMLElement element the element to slide up * @param {HTMLElement} element the element to slide up
* @param function finishCallback function to call when the animation has * @param {function} finishCallback function to call when the animation has
* been finished (i.e. the element is hidden) * been finished (i.e. the element is hidden)
* @param function startCallback function to call when the animation starts * @param {function} startCallback function to call when the animation starts
*/ */
utils.slideUp = function (element, finishCallback, startCallback) utils.slideUp = function (element, finishCallback, startCallback)
{ {
@ -71,10 +71,10 @@ utils.slideUp = function (element, finishCallback, startCallback)
/** /**
* Slides a element down (i.e. show a hidden element) * Slides a element down (i.e. show a hidden element)
* *
* @param HTMLElement element the element to slide down * @param {HTMLElement} element the element to slide down
* @param function finishCallback function to call when the animation has * @param {function} finishCallback function to call when the animation has
* been finished (i.e. the element is visible) * been finished (i.e. the element is visible)
* @param function startCallback function to call when the animation starts * @param {function} startCallback function to call when the animation starts
*/ */
utils.slideDown = function (element, finishCallback, startCallback) utils.slideDown = function (element, finishCallback, startCallback)
{ {
@ -124,8 +124,9 @@ utils.slideDown = function (element, finishCallback, startCallback)
/** /**
* Checks whether a element is visible or not * Checks whether a element is visible or not
* *
* @param HTMLElement element the element to check * @param {HTMLElement} element the element to check
* @return boolean TRUE when the element is visible, FALSE otherwise *
* @return {bool} TRUE when the element is visible, FALSE otherwise
*/ */
utils.isElementVisible = function (element) utils.isElementVisible = function (element)
{ {

Loading…
Cancel
Save