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

163 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'>ColonAssignmentSpacing</span>
</div>
</div>
<div id='content'>
<h1>
Class:
ColonAssignmentSpacing
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>node_modules&#47;gulp-coffeelint&#47;node_modules&#47;coffeelint&#47;src&#47;rules&#47;colon_assignment_spacing.coffee</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='rule-variable'>
rule
=
</dt>
<dd>
<pre><code class='coffeescript'>{
name: &#39;colon_assignment_spacing&#39;,
level: &#39;ignore&#39;,
message: &#39;Colon assignment without proper spacing&#39;,
spacing: {
left: 0,
right: 0
},
description: &quot;&lt;p&gt;This rule checks to see that there is spacing before and\nafter the colon in a colon assignment (i.e., classes, objects).\nThe spacing amount is specified by\nspacing.left and spacing.right, respectively.\nA zero value means no spacing required.\n&lt;&#47;p&gt;\n&lt;pre&gt;&lt;code&gt;\n\n###\nGood\n###\nobject = {spacing : true}\nclass Dog\n canBark : true\n\n###\nBad\n###\nobject = {spacing: true}\nclass Cat\n canBark: false\n&lt;&#47;code&gt;&lt;&#47;pre&gt;&quot;
}</code></pre>
</dd>
<dt id='tokens-variable'>
tokens
=
</dt>
<dd>
<pre><code class='coffeescript'>[&#39;:&#39;]</code></pre>
</dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#lintToken-dynamic'>
#
(void)
<b>lintToken</b><span>(token, tokenApi)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='lintToken-dynamic'>
#
(void)
<b>lintToken</b><span>(token, tokenApi)</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>