Skip to content

Commit

Permalink
Update jsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jleyba
jleyba committed Dec 22, 2013
1 parent 80224fb commit 24b5064
Show file tree
Hide file tree
Showing 315 changed files with 3,260 additions and 5,257 deletions.
2 changes: 1 addition & 1 deletion Rakefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,7 @@ namespace :docs do
# First, delete the old docs.
rm_rf "docs/api/javascript"

cmd = "java -jar third_party/java/dossier/dossier-0.1.1.jar"
cmd = "java -jar third_party/java/dossier/dossier-0.2.1.jar"
cmd << " --closure_library third_party/closure/goog"
cmd << " -o docs/api/javascript"
cmd << " -s javascript/atoms"
Expand Down
77 changes: 20 additions & 57 deletions docs/api/javascript/class_bot_Device.html
View file

Large diffs are not rendered by default.

16 changes: 2 additions & 14 deletions docs/api/javascript/class_bot_Device_EventEmitter.html
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,2 @@
<!DOCTYPE html><meta charset="UTF-8"><title>bot.Device.EventEmitter</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class bot.Device.EventEmitter</h1><a class="source" href="source_javascript_atoms_device.js.src.html#l916">code &raquo;</a></header><section><p> Fires events, a driver can replace it with a custom implementation

<h2>Constructor</h2><div class="wrap-details"><div class="public ctor"><div><span class="member"><a name="bot.Device.EventEmitter">bot.Device.EventEmitter</a> <span class="args">()</span></span></div></div></div></section><section><h2>Instance Methods</h2><div class="wrap-details"><div class="protected"><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l928">code &raquo;</a><span class="member"><a name="fireHtmlEvent">fireHtmlEvent</a> <span class="args">(target, type)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p> Fires an HTML event given the state of the device.

</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>HTML Event type.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details"><div class="protected"><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l942">code &raquo;</a><span class="member"><a name="fireKeyboardEvent">fireKeyboardEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p> Fires a keyboard event given the state of the device and the given arguments.

</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>Keyboard event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.KeyboardArgs">bot.events.KeyboardArgs</a></code><dd>Keyboard event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details"><div class="protected"><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l988">code &raquo;</a><span class="member"><a name="fireMSPointerEvent">fireMSPointerEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p> Fires an MSPointer event given the state of the device and the given
arguments.

</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>MSPointer event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.MSPointerArgs">bot.events.MSPointerArgs</a></code><dd>MSPointer event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details"><div class="protected"><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l957">code &raquo;</a><span class="member"><a name="fireMouseEvent">fireMouseEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p> Fires a mouse event given the state of the device and the given arguments.

</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>Mouse event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.MouseArgs">bot.events.MouseArgs</a></code><dd>Mouse event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details"><div class="protected"><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l972">code &raquo;</a><span class="member"><a name="fireTouchEvent">fireTouchEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p> Fires a mouse event given the state of the device and the given arguments.

</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>Touch event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.TouchArgs">bot.events.TouchArgs</a></code><dd>Touch event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div></section></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</i></div></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="types.js"></script><script src="dossier.js"></script>
<!DOCTYPE html><meta charset="UTF-8"><title>bot.Device.EventEmitter</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class bot.Device.EventEmitter</h1><a class="source" href="source_javascript_atoms_device.js.src.html#l916">code &raquo;</a></header><section><p>Fires events, a driver can replace it with a custom implementation<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member"><a name="bot.Device.EventEmitter">bot.Device.EventEmitter</a> <span class="args">()</span></span></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><div class="wrap-details protected"><div><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l928">code &raquo;</a><span class="member"><a name="fireHtmlEvent">fireHtmlEvent</a> <span class="args">(target, type)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Fires an HTML event given the state of the device.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>HTML Event type.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details protected"><div><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l942">code &raquo;</a><span class="member"><a name="fireKeyboardEvent">fireKeyboardEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Fires a keyboard event given the state of the device and the given arguments.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>Keyboard event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.KeyboardArgs">bot.events.KeyboardArgs</a></code><dd>Keyboard event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details protected"><div><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l988">code &raquo;</a><span class="member"><a name="fireMSPointerEvent">fireMSPointerEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Fires an MSPointer event given the state of the device and the given
arguments.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>MSPointer event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.MSPointerArgs">bot.events.MSPointerArgs</a></code><dd>MSPointer event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details protected"><div><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l957">code &raquo;</a><span class="member"><a name="fireMouseEvent">fireMouseEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Fires a mouse event given the state of the device and the given arguments.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>Mouse event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.MouseArgs">bot.events.MouseArgs</a></code><dd>Mouse event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div><div class="wrap-details protected"><div><details class="function"><summary><div><a class="source" href="source_javascript_atoms_device.js.src.html#l972">code &raquo;</a><span class="member"><a name="fireTouchEvent">fireTouchEvent</a> <span class="args">(target, type, args)</span> &rArr; <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Fires a mouse event given the state of the device and the given arguments.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>target: <code class="type">!<a href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-745549614">Element</a></code><dd>The element on which to fire the event.<dt>type: <code class="type"><a href="enum_bot_events_EventType.html">bot.events.EventType</a></code><dd>Touch event type.<dt>args: <code class="type"><a href="namespace_bot_events.html#bot.events.TouchArgs">bot.events.TouchArgs</a></code><dd>Touch event arguments.</dl><tr><th>Returns<tr><td><dl>Whether the event fired successfully; false if cancelled.</dl></table></div></details></div></div></section></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</i></div></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="types.js"></script><script src="dossier.js"></script>
Loading

0 comments on commit 24b5064

Please sign in to comment.