177 lines
3.7 KiB
HTML
177 lines
3.7 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>
|
|
»
|
|
<a href='../../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>Foo</span>
|
|
»
|
|
<span class='title'>Bar</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Mixin:
|
|
Foo.Bar
|
|
<span class='note title'>Abstract</span>
|
|
<span class='deprecated note title'>Deprecated</span>
|
|
<span class='note private'>Private</span>
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>node_modules/grunt-codo/node_modules/codo/spec/_templates/mixins/mixin_documentation.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<div class='deprecated note'>
|
|
<strong>Deprecated.</strong>
|
|
Use other module which is thread safe
|
|
</div>
|
|
<div class='abstract note'>
|
|
<strong>
|
|
This
|
|
mixin
|
|
is abstract.
|
|
</strong>
|
|
Each listener implementation must include
|
|
</div>
|
|
<div class='note todo'>
|
|
<strong>TODO:</strong>
|
|
Clean up socket handler
|
|
</div>
|
|
<div class='note todo'>
|
|
<strong>TODO:</strong>
|
|
Refactor property factory
|
|
</div>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
Please use this carefully
|
|
</div>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
For internal use only
|
|
</div>
|
|
<p>This is a test module with <code>inline.dot</code>. Beware.</p>
|
|
<div class='examples'>
|
|
<h3>Examples:</h3>
|
|
<h4>
|
|
Use it in this way
|
|
</h4>
|
|
<pre><code class='coffeescript'>class Rumba
|
|
@include Foo.Bar</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>Author:</h3>
|
|
<ul class='author'>
|
|
<li>
|
|
Netzpirat
|
|
</li>
|
|
<li>
|
|
Supermakaka
|
|
</li>
|
|
</ul>
|
|
<h3>Since:</h3>
|
|
<ul class='since'>
|
|
<li>
|
|
1.0.0
|
|
</li>
|
|
</ul>
|
|
<h3>Version:</h3>
|
|
<ul class='version'>
|
|
<li>
|
|
1.0.2
|
|
</li>
|
|
</ul>
|
|
</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
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<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> |