can generate jsdoc; private methods marked as such
[dygraphs.git] / jsdoc-toolkit / app / test / event.js
CommitLineData
629a09ae
DV
1/**
2 * @name Kitchen
3 * @constructor
4 * @fires Bakery#event:donutOrdered
5 */
6
7/**
8 * Fired when some cake is eaten.
9 * @name Kitchen#event:cakeEaten
10 * @function
11 * @param {Number} pieces The number of pieces eaten.
12 */
13
14/**
15 * Find out if cake was eaten.
16 * @name Kitchen#cakeEaten
17 * @function
18 * @param {Boolean} wasEaten
19 */
20
21/**
22 * @name getDesert
23 * @function
24 * @fires Kitchen#event:cakeEaten
25 */
26
27/**
28 * @name Bakery
29 * @constructor
30 * @extends Kitchen
31 */
32
33/**
34 * Fired when a donut order is made.
35 * @name Bakery#event:donutOrdered
36 * @event
37 * @param {Event} e The event object.
38 * @param {String} [e.topping] Optional sprinkles.
39 */
40
41/**
42 * @constructor
43 * @borrows Bakery#event:donutOrdered as this.event:cakeOrdered
44 */
45function CakeShop() {
46}
47
48/** @event */
49CakeShop.prototype.icingReady = function(isPink) {
50}
51
52/** @event */
53function amHungry(/**Boolean*/enoughToEatAHorse) {
54}