yonote/yjs
24
0
Fork 0
Code Pull Requests 1 Releases Activity
yjs/doc/class/Entities/Class.html
Kevin Jahns 28b48de454 switched to Gulp
2014-08-12 19:18:56 +02:00

482 lines
9.3 KiB
HTML
Raw Blame History

<!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'>Entities</span>
&raquo;
<span class='title'>Class</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Entities.Class
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>node_modules&#47;grunt-codo&#47;node_modules&#47;codo&#47;lib&#47;entities&#47;class.coffee</td>
</tr>
</table>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#looksLike-static'>
.
(void)
<b>looksLike</b><span>(node)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#determineContainment-dynamic'>
#
(void)
<b>determineContainment</b><span>(node)</span>
</a>
</span>
<span class='desc'>
Determines if the class definition at given node is using @assignation and if in such case this class is nested into another one
</span>
</li>
<li>
<span class='signature'>
<a href='#fetchParent-dynamic'>
#
(void)
<b>fetchParent</b><span>(source)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#fetchName-dynamic'>
#
(void)
<b>fetchName</b><span>(source, selfish, container)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#linkify-dynamic'>
#
(void)
<b>linkify</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#linkifyAssign-dynamic'>
#
(void)
<b>linkifyAssign</b><span>(node)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#linkifyValue-dynamic'>
#
(void)
<b>linkifyValue</b><span>(node)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#linkifyCall-dynamic'>
#
(void)
<b>linkifyCall</b><span>(node)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#linkifyParent-dynamic'>
#
(void)
<b>linkifyParent</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#linkifyMixins-dynamic'>
#
(void)
<b>linkifyMixins</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#effectiveMethods-dynamic'>
#
(void)
<b>effectiveMethods</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#allMethods-dynamic'>
#
(void)
<b>allMethods</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#inherited-dynamic'>
#
(void)
<b>inherited</b><span>(getter)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#inheritedMethods-dynamic'>
#
(void)
<b>inheritedMethods</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#inheritedVariables-dynamic'>
#
(void)
<b>inheritedVariables</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#inheritedProperties-dynamic'>
#
(void)
<b>inheritedProperties</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#inspect-dynamic'>
#
(void)
<b>inspect</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='looksLike-static'>
.
(void)
<b>looksLike</b><span>(node)</span>
<br>
</p>
</div>
</div>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(environment, file, node)</span>
<br>
</p>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='determineContainment-dynamic'>
#
(void)
<b>determineContainment</b><span>(node)</span>
<br>
</p>
<div class='docstring'>
<p>Determines if the class definition at given node is using @assignation
and if in such case this class is nested into another one</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='fetchParent-dynamic'>
#
(void)
<b>fetchParent</b><span>(source)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='fetchName-dynamic'>
#
(void)
<b>fetchName</b><span>(source, selfish, container)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='linkify-dynamic'>
#
(void)
<b>linkify</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='linkifyAssign-dynamic'>
#
(void)
<b>linkifyAssign</b><span>(node)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='linkifyValue-dynamic'>
#
(void)
<b>linkifyValue</b><span>(node)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='linkifyCall-dynamic'>
#
(void)
<b>linkifyCall</b><span>(node)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='linkifyParent-dynamic'>
#
(void)
<b>linkifyParent</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='linkifyMixins-dynamic'>
#
(void)
<b>linkifyMixins</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='effectiveMethods-dynamic'>
#
(void)
<b>effectiveMethods</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='allMethods-dynamic'>
#
(void)
<b>allMethods</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='inherited-dynamic'>
#
(void)
<b>inherited</b><span>(getter)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='inheritedMethods-dynamic'>
#
(void)
<b>inheritedMethods</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='inheritedVariables-dynamic'>
#
(void)
<b>inheritedVariables</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='inheritedProperties-dynamic'>
#
(void)
<b>inheritedProperties</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='inspect-dynamic'>
#
(void)
<b>inspect</b><span>()</span>
<br>
</p>
</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>
View Git Blame Copy Permalink