aboutsummaryrefslogtreecommitdiffstats
path: root/build/docs/gen-events.pl
blob: 5e92df927dd1f9dba1b4a76389a8afcc71aaff1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
#!/usr/bin/perl

my @stuff = split(",", "blur,focus,load,resize,scroll,unload,click,dblclick," .
		"mousedown,mouseup,mousemove,mouseover,mouseout,change,reset,select," .
		"submit,keydown,keypress,keyup,error");

foreach (@stuff) {

print qq~
		/**
		 * Bind a function to the $_ event of each matched element.
		 *
		 * \@example \$("p").$_( function() { alert("Hello"); } );
		 * \@before <p>Hello</p>
		 * \@result <p on$_="alert('Hello');">Hello</p>
		 *
		 * \@name $_
		 * \@type jQuery
		 * \@param Function fn A function to bind to the $_ event on each of the matched elements.
		 * \@cat Events
		 */

		/**
		 * Trigger the $_ event of each matched element. This causes all of the functions
		 * that have been bound to thet $_ event to be executed.
		 *
		 * \@example \$("p").$_();
		 * \@before <p on$_="alert('Hello');">Hello</p>
		 * \@result alert('Hello');
		 *
		 * \@name $_
		 * \@type jQuery
		 * \@cat Events
		 */

		/**
		 * Bind a function to the $_ event of each matched element, which will only be executed once.
		 * Unlike a call to the normal .$_() method, calling .one$_() causes the bound function to be
		 * only executed the first time it is triggered, and never again (unless it is re-bound).
		 *
		 * \@example \$("p").one$_( function() { alert("Hello"); } );
		 * \@before <p on$_="alert('Hello');">Hello</p>
		 * \@result alert('Hello'); // Only executed for the first $_
		 *
		 * \@name one$_
		 * \@type jQuery
		 * \@param Function fn A function to bind to the $_ event on each of the matched elements.
		 * \@cat Events
		 */

		/**
		 * Removes a bound $_ event from each of the matched
		 * elements. You must pass the identical function that was used in the original 
		 * bind method.
		 *
		 * \@example \$("p").un$_( myFunction );
		 * \@before <p on$_="myFunction">Hello</p>
		 * \@result <p>Hello</p>
		 *
		 * \@name un$_
		 * \@type jQuery
		 * \@param Function fn A function to unbind from the $_ event on each of the matched elements.
		 * \@cat Events
		 */

		/**
		 * Removes all bound $_ events from each of the matched elements.
		 *
		 * \@example \$("p").un$_();
		 * \@before <p on$_="alert('Hello');">Hello</p>
		 * \@result <p>Hello</p>
		 *
		 * \@name un$_
		 * \@type jQuery
		 * \@cat Events
		 */
~;


}