Skip to content

Commit 0771cc7

Browse files
agcolomagcolom
committed
api docs: code indentation and formatting (event.* entries)
1 parent 65f4b06 commit 0771cc7

19 files changed

+184
-120
lines changed

‎entries/event.currentTarget.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@
1313
</longdesc>
1414
<example>
1515
<desc>Alert that currentTarget matches the `this` keyword.</desc>
16-
<code><![CDATA[$("p").click(function(event) {
16+
<code><![CDATA[
17+
$( "p" ).click(function( event ) {
1718
alert( event.currentTarget === this ); // true
18-
}); ]]></code>
19+
});
20+
]]></code>
1921
</example>
2022
<category slug="events/event-object"/>
2123
<category slug="version/1.3"/>

‎entries/event.data.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818
<div id="log"></div>
1919
]]></html>
2020
<code><![CDATA[
21-
var logDiv = $("#log");
21+
var logDiv = $( "#log" );
2222
23-
/* Note: This code is for demonstration purposes only. */
23+
// Note: This code is for demonstration purposes only.
2424
for (var i = 0; i < 5; i++) {
25-
$("button").eq(i).on("click", {value: i}, function(event) {
25+
$( "button" ).eq( i ).on( "click", {value: i}, function( event ) {
2626
var msgs = [
27-
"button = " + $(this).index(),
27+
"button = " + $( this ).index(),
2828
"event.data.value = " + event.data.value,
2929
"i = " + i
3030
];

‎entries/event.delegateTarget.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@
1111
</longdesc>
1212
<example>
1313
<desc>When a button in any box class is clicked, change the box's background color to red.</desc>
14-
<code><![CDATA[$(".box").on("click", "button", function(event) {
15-
$(event.delegateTarget).css("background-color", "red");
16-
}); ]]></code>
14+
<code><![CDATA[
15+
$( ".box" ).on( "click", "button", function( event ) {
16+
$( event.delegateTarget ).css( "background-color", "red" );
17+
});
18+
]]></code>
1719
</example>
1820
<category slug="events/event-object"/>
1921
<category slug="events"/>

‎entries/event.isDefaultPrevented.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88
<longdesc> </longdesc>
99
<example>
1010
<desc>Checks whether event.preventDefault() was called.</desc>
11-
<code><![CDATA[$("a").click(function(event){
11+
<code><![CDATA[
12+
$( "a" ).click(function( event ) {
1213
alert( event.isDefaultPrevented() ); // false
1314
event.preventDefault();
1415
alert( event.isDefaultPrevented() ); // true
15-
}); ]]></code>
16+
});
17+
]]></code>
1618
</example>
1719
<category slug="events/event-object"/>
1820
<category slug="version/1.3"/>

‎entries/event.isImmediatePropagationStopped.xml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,25 @@
1111
<example>
1212
<desc>Checks whether event.stopImmediatePropagation() was called.</desc>
1313
<code><![CDATA[
14-
15-
function immediatePropStopped(e) {
14+
function immediatePropStopped( e ) {
1615
var msg = "";
1716
if ( e.isImmediatePropagationStopped() ) {
1817
msg = "called"
1918
} else {
2019
msg = "not called";
2120
}
22-
$("#stop-log").append( "<div>" + msg + "</div>" );
21+
$( "#stop-log" ).append( "<div>" + msg + "</div>" );
2322
}
2423
25-
$("button").click(function(event) {
26-
immediatePropStopped(event);
24+
$( "button" ).click(function( event ) {
25+
immediatePropStopped( event );
2726
event.stopImmediatePropagation();
28-
immediatePropStopped(event);
27+
immediatePropStopped( event );
2928
});
3029
]]></code>
3130
<html><![CDATA[
32-
<button>click me</button>
33-
<div id="stop-log"></div>
31+
<button>click me</button>
32+
<div id="stop-log"></div>
3433
]]></html>
3534
</example>
3635
<category slug="events/event-object"/>

‎entries/event.isPropagationStopped.xml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,25 @@
1111
<example>
1212
<desc>Checks whether event.stopPropagation() was called</desc>
1313
<code><![CDATA[
14-
15-
function propStopped(e) {
14+
function propStopped( e ) {
1615
var msg = "";
1716
if ( e.isPropagationStopped() ) {
1817
msg = "called"
1918
} else {
2019
msg = "not called";
2120
}
22-
$("#stop-log").append( "<div>" + msg + "</div>" );
21+
$( "#stop-log" ).append( "<div>" + msg + "</div>" );
2322
}
2423
25-
$("button").click(function(event) {
26-
propStopped(event);
24+
$( "button" ).click(function(event) {
25+
propStopped( event );
2726
event.stopPropagation();
28-
propStopped(event);
27+
propStopped( event );
2928
});
3029
]]></code>
3130
<html><![CDATA[
32-
<button>click me</button>
33-
<div id="stop-log"></div>
31+
<button>click me</button>
32+
<div id="stop-log"></div>
3433
]]></html>
3534
</example>
3635
<category slug="events/event-object"/>

‎entries/event.metaKey.xml

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,28 @@
44
<signature>
55
<added>1.0.4</added>
66
</signature>
7-
<desc>Indicates whether the META key was pressed when the event fired.</desc>
8-
<longdesc>
7+
<desc>Indicates whether the META key was pressed when the event fired.</desc>
8+
<longdesc>
99
<p>Returns a boolean value (<code>true</code> or <code>false</code>) that indicates whether or not the <kbd>META</kbd> key was pressed at the time the event fired.
1010
This key might map to an alternative key name on some platforms.</p>
11-
</longdesc>
11+
</longdesc>
1212
<example>
1313
<desc>Determine whether the META key was pressed when the event fired.</desc>
14-
<css>body {background-color: #eef; }
15-
div { padding: 20px; }</css>
16-
<html><![CDATA[
14+
<css><![CDATA[
15+
body {
16+
background-color: #eef;
17+
}
18+
div {
19+
padding: 20px;
20+
}
21+
]]></css>
22+
<html><![CDATA[
1723
<button value="Test" name="Test" id="checkMetaKey">Click me!</button>
18-
<div id="display"></div>]]></html>
19-
<code><![CDATA[
20-
$('#checkMetaKey').click(function(e){
21-
$('#display').text(e.metaKey);
24+
<div id="display"></div>
25+
]]></html>
26+
<code><![CDATA[
27+
$( "#checkMetaKey" ).click(function( e ) {
28+
$( "#display" ).text( e.metaKey );
2229
});
2330
]]></code>
2431
</example>

‎entries/event.namespace.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
<example>
1212
<desc>Determine the event namespace used.</desc>
1313
<code><![CDATA[
14-
$("p").on("test.something", function(event) {
14+
$( "p" ).on( "test.something", function( event ) {
1515
alert( event.namespace );
1616
});
17-
$("button").click(function(event) {
18-
$("p").trigger("test.something");
17+
$( "button" ).click(function( event ) {
18+
$( "p" ).trigger( "test.something" );
1919
});
2020
]]></code>
2121
<html><![CDATA[
@@ -25,4 +25,4 @@ $("button").click(function(event) {
2525
</example>
2626
<category slug="events/event-object"/>
2727
<category slug="version/1.4.3"/>
28-
</entry>
28+
</entry>

‎entries/event.pageX.xml

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,24 @@
77
<desc>The mouse position relative to the left edge of the document. </desc>
88
<longdesc> </longdesc>
99
<example>
10-
<desc>Show the mouse position relative to the left and top edges of the document (within the iframe).</desc>
11-
<css>body {background-color: #eef; }
12-
div { padding: 20px; }</css>
13-
<html><![CDATA[<div id="log"></div>]]></html>
14-
<code><![CDATA[$(document).on('mousemove',function(e){
15-
$("#log").text("e.pageX: " + e.pageX + ", e.pageY: " + e.pageY);
16-
}); ]]></code>
10+
<desc>Show the mouse position relative to the left and top edges of the document (within this iframe).</desc>
11+
<css><![CDATA[
12+
body {
13+
background-color: #eef;
14+
}
15+
div {
16+
padding: 20px;
17+
}
18+
]]></css>
19+
<html><![CDATA[
20+
<div id="log"></div>
21+
]]></html>
22+
<code><![CDATA[
23+
$( document ).on( "mousemove", function( e ) {
24+
$( "#log" ).text( "e.pageX: " + e.pageX + ", e.pageY: " + e.pageY );
25+
});
26+
]]></code>
1727
</example>
1828
<category slug="events/event-object"/>
1929
<category slug="version/1.0.4"/>
20-
</entry>
30+
</entry>

‎entries/event.pageY.xml

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,23 @@
88
<longdesc> </longdesc>
99
<example>
1010
<desc>Show the mouse position relative to the left and top edges of the document (within this iframe).</desc>
11-
<css>body {background-color: #eef; }
12-
div { padding: 20px; }
13-
</css>
14-
<html><![CDATA[<div id="log"></div>]]></html>
11+
<css><![CDATA[
12+
body {
13+
background-color: #eef;
14+
}
15+
div {
16+
padding: 20px;
17+
}
18+
]]></css>
19+
<html><![CDATA[
20+
<div id="log"></div>
21+
]]></html>
1522
<code><![CDATA[
16-
$(document).on('mousemove',function(e){
17-
$("#log").text("e.pageX: " + e.pageX + ", e.pageY: " + e.pageY);
23+
$( document ).on( "mousemove", function( e ) {
24+
$( "#log" ).text( "e.pageX: " + e.pageX + ", e.pageY: " + e.pageY );
1825
});
19-
]]></code>
26+
]]></code>
2027
</example>
2128
<category slug="events/event-object"/>
2229
<category slug="version/1.0.4"/>
23-
</entry>
30+
</entry>

‎entries/event.preventDefault.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
</signature>
77
<desc> If this method is called, the default action of the event will not be triggered. </desc>
88
<longdesc>
9-
<p>For example, clicked anchors will not take the browser to a new URL. We can use <code>event.isDefaultPrevented()</code> to determine if this method has been called by an event handler that was triggered by this event.</p>
9+
<p>For example, clicked anchors will not take the browser to a new URL. We can use <a href="/event.isDefaultPrevented"><code>event.isDefaultPrevented()</code></a> to determine if this method has been called by an event handler that was triggered by this event.</p>
1010
</longdesc>
1111
<example>
1212
<desc>Cancel the default action (navigation) of the click.</desc>
1313
<code><![CDATA[
14-
$("a").click(function(event) {
14+
$( "a" ).click(function( event ) {
1515
event.preventDefault();
16-
$('<div/>')
17-
.append('default ' + event.type + ' prevented')
18-
.appendTo('#log');
16+
$( "<div/>" )
17+
.append( "default " + event.type + " prevented" )
18+
.appendTo( "#log" );
1919
});
2020
]]></code>
2121
<html><![CDATA[
@@ -25,4 +25,4 @@ $("a").click(function(event) {
2525
</example>
2626
<category slug="events/event-object"/>
2727
<category slug="version/1.0"/>
28-
</entry>
28+
</entry>

‎entries/event.relatedTarget.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@
1010
</longdesc>
1111
<example>
1212
<desc>On mouseout of anchors, alert the element type being entered.</desc>
13-
<code><![CDATA[$("a").mouseout(function(event) {
14-
alert(event.relatedTarget.nodeName); // "DIV"
15-
}); ]]></code>
13+
<code><![CDATA[
14+
$( "a" ).mouseout(function( event ) {
15+
alert( event.relatedTarget.nodeName ); // "DIV"
16+
});
17+
]]></code>
1618
</example>
1719
<category slug="events/event-object"/>
1820
<category slug="version/1.1.4"/>
19-
</entry>
21+
</entry>

‎entries/event.result.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
<example>
1212
<desc>Display previous handler's return value</desc>
1313
<code><![CDATA[
14-
$("button").click(function(event) {
14+
$( "button" ).click(function( event ) {
1515
return "hey";
1616
});
17-
$("button").click(function(event) {
18-
$("p").html( event.result );
17+
$( "button" ).click(function( event ) {
18+
$( "p" ).html( event.result );
1919
});
2020
]]></code>
2121
<html><![CDATA[

‎entries/event.stopImmediatePropagation.xml

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,42 @@
66
</signature>
77
<desc> Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree.</desc>
88
<longdesc>
9-
<p>In addition to keeping any additional handlers on an element from being executed, this method also stops the bubbling by implicitly calling <code>event.stopPropagation()</code>. To simply prevent the event from bubbling to ancestor elements but allow other event handlers to execute on the same element, we can use <code><a href="http://api.jquery.com/event.stopPropagation">event.stopPropagation()</a></code> instead.</p>
10-
<p>Use <code><a href="http://api.jquery.com/event.isImmediatePropagationStopped">event.isImmediatePropagationStopped()</a></code> to know whether this method was ever called (on that event object).</p>
9+
<p>In addition to keeping any additional handlers on an element from being executed, this method also stops the bubbling by implicitly calling <code>event.stopPropagation()</code>. To simply prevent the event from bubbling to ancestor elements but allow other event handlers to execute on the same element, we can use <code><a href="/event.stopPropagation">event.stopPropagation()</a></code> instead.</p>
10+
<p>Use <code><a href="/event.isImmediatePropagationStopped">event.isImmediatePropagationStopped()</a></code> to know whether this method was ever called (on that event object).</p>
1111
</longdesc>
1212
<note id="propagation-for-live-or-delegate" type="additional"/>
1313
<example>
1414
<desc>Prevents other event handlers from being called.</desc>
1515
<css><![CDATA[
16-
p { height: 30px; width: 150px; background-color: #ccf; }
17-
div {height: 30px; width: 150px; background-color: #cfc; }
16+
p {
17+
height: 30px;
18+
width: 150px;
19+
background-color: #ccf;
20+
}
21+
div {
22+
height: 30px;
23+
width: 150px;
24+
background-color: #cfc;
25+
}
1826
]]></css>
1927
<code><![CDATA[
20-
$("p").click(function(event){
28+
$( "p" ).click(function( event ) {
2129
event.stopImmediatePropagation();
2230
});
23-
$("p").click(function(event){
31+
$( "p" ).click(function( event ) {
2432
// This function won't be executed
25-
$(this).css("background-color", "#f00");
33+
$( this ).css( "background-color", "#f00" );
2634
});
27-
$("div").click(function(event) {
35+
$( "div" ).click(function( event ) {
2836
// This function will be executed
29-
$(this).css("background-color", "#f00");
30-
});]]></code>
31-
<html><![CDATA[<p>paragraph</p>
32-
<div>division</div>]]></html>
37+
$( this ).css( "background-color", "#f00" );
38+
});
39+
]]></code>
40+
<html><![CDATA[
41+
<p>paragraph</p>
42+
<div>division</div>
43+
]]></html>
3344
</example>
3445
<category slug="events/event-object"/>
3546
<category slug="version/1.3"/>
36-
</entry>
47+
</entry>

‎entries/event.stopPropagation.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@
1313
<note id="propagation-for-live-or-delegate" type="additional"/>
1414
<example>
1515
<desc>Kill the bubbling on the click event.</desc>
16-
<code><![CDATA[$("p").click(function(event){
16+
<code><![CDATA[
17+
$( "p" ).click(function( event ) {
1718
event.stopPropagation();
1819
// do something
19-
}); ]]></code>
20+
});
21+
]]></code>
2022
</example>
2123
<category slug="events/event-object"/>
2224
<category slug="version/1.0"/>
23-
</entry>
25+
</entry>

0 commit comments

Comments
 (0)