yjs/doc/class/Example/Events.html
2014-08-12 19:18:56 +02:00

186 lines
3.8 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<script src='../../javascript/application.js'></script>
<script src='../../javascript/search.js'></script>
<link rel='stylesheet' href='../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../extra/README.md.html' title='Yatta'>
Yatta
</a>
&raquo;
<a href='../../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>Example</span>
&raquo;
<span class='title'>Events</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Example.Events
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>node_modules&#47;grunt-codo&#47;node_modules&#47;codo&#47;spec&#47;_templates&#47;methods&#47;method_events.coffee</td>
</tr>
</table>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#emit-dynamic'>
#
(void)
<b>emit</b><span>(args...)</span>
</a>
</span>
<span class='desc'>
This is a generic Events emit method.
</span>
</li>
</ul>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='emit-dynamic'>
#
(void)
<b>emit</b><span>(args...)</span>
<br>
</p>
<div class='docstring'>
<p>This is a generic Events emit method.</p><p>This should be more description for the method itself, and events
shouldn&#39;t have messed it up.</p>
</div>
<div class='tags'>
<div class='events'>
<h3>Events:</h3>
<div class='event'>
<p class='signature'>
theBasic.One
</p>
<div class='tags'>
</div>
</div>
<div class='event'>
<p class='signature'>
theWeirdOne
</p>
<div class='docstring'>
<p>Omg this event is so weird o_O</p>
</div>
<div class='tags'>
</div>
</div>
<div class='event'>
<p class='signature'>
theComplicatedOne
</p>
<div class='docstring'>
<p>This is the complicated event yo</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>the</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>incredible string </span>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id='footer'>
August 12, 14 06:33:02 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>