Интерфейс плагина

01
/**
02 * Interface onDrawCallback
03 * @param {Context} context     HTML5 Canvas 2d Context
04 */
05 var DrawCallback = function (context) {};
06
07 /**
08 * jQuery.favicon interface
09 * @param {String} iconURL
10 * @param {String} alternativeURL
11 (опциональный) URL, который будет использоваться для старых браузеров, которые не поддерживают элемент HTML5 Canvas
12 * @param {DrawCallback} onDrawCallback
13 (опциональный) Функция обратного вызова, которая нарисует что-то на иконке
14 *
15 * function (iconURL)
16 * function (iconURL, onDraw)
17 * function (iconURL, alternateURL, onDraw)
18 */
19 jQuery.favicon = function (iconURL, alternativeURL, onDrawCallback) {};
20
21 /**
22 * jQuery.favicon.animate – Начинает анимацию
23 *
24 * @param {String}      animationURL
25 Изображение, которое содержит кадры
26 * @param {String}      alternateURL
27 Изображение, которое будет вставлено, если динамика не сработает
28 * @param {Object}      options         опциональный
29 *
30 * function (animationURL, alternateURL)
31 * function (animationURL, alternateURL, {
32 *   interval: 1000, // интервал, по умолчанию 1000ms
33 *   onDraw: function (context) {}, // вызывается на каждом кадре
34 *   onStop: function () {}, // вызывается, при остановки анимации
35 *   frames: [1,3,5] // отображать кадры в особом порядке
36 * })
37 */
38 jQuery.favicon.animate = function (animationURL, alternateURL, options) {};
39
40 /**
41 * jQuery.favicon.unanimate – остановить текующую анимацию
42 */
43 jQuery.favicon.unanimate = function () {};