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

514 lines
9.9 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'>Theme</span>
&raquo;
<span class='title'>Theme</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Theme.Theme
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>node_modules&#47;grunt-codo&#47;node_modules&#47;codo&#47;themes&#47;default&#47;lib&#47;theme.coffee</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='options-variable'>
options
=
</dt>
<dd>
<pre><code class='coffeescript'>[
{
name: &#39;private&#39;,
alias: &#39;p&#39;,
describe: &#39;Show privates&#39;,
boolean: true,
&quot;default&quot;: false
}, {
name: &#39;analytics&#39;,
alias: &#39;a&#39;,
describe: &#39;The Google analytics ID&#39;,
&quot;default&quot;: false
}, {
name: &#39;title&#39;,
alias: &#39;t&#39;,
describe: &#39;HTML Title&#39;,
&quot;default&quot;: &#39;CoffeeScript API Documentation&#39;
}
]</code></pre>
</dd>
</dl>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#compile-static'>
.
(void)
<b>compile</b><span>(environment)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#compile-dynamic'>
#
(void)
<b>compile</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#awareOf-dynamic'>
#
(void)
<b>awareOf</b><span>(needle)</span>
</a>
</span>
<span class='desc'>
HELPERS
</span>
</li>
<li>
<span class='signature'>
<a href='#reference-dynamic'>
#
(void)
<b>reference</b><span>(needle, prefix)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#anchorFor-dynamic'>
#
(void)
<b>anchorFor</b><span>(entity)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#pathFor-dynamic'>
#
(void)
<b>pathFor</b><span>(kind, entity, prefix = &#39;&#39;)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#activate-dynamic'>
#
(void)
<b>activate</b><span>(text, prefix, limit = false)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#generateBreadcrumbs-dynamic'>
#
(void)
<b>generateBreadcrumbs</b><span>(entries = [])</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#calculatePath-dynamic'>
#
(void)
<b>calculatePath</b><span>(filename)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#render-dynamic'>
#
(void)
<b>render</b><span>(source, destination, context = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#renderAlphabeticalIndex-dynamic'>
#
(void)
<b>renderAlphabeticalIndex</b><span>()</span>
</a>
</span>
<span class='desc'>
Generate the alphabetical index of all classes and mixins.
</span>
</li>
<li>
<span class='signature'>
<a href='#renderIndex-dynamic'>
#
(void)
<b>renderIndex</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#renderClasses-dynamic'>
#
(void)
<b>renderClasses</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#renderMixins-dynamic'>
#
(void)
<b>renderMixins</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#renderFiles-dynamic'>
#
(void)
<b>renderFiles</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#renderExtras-dynamic'>
#
(void)
<b>renderExtras</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#renderFuzzySearchData-dynamic'>
#
(void)
<b>renderFuzzySearchData</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='compile-static'>
.
(void)
<b>compile</b><span>(environment)</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)</span>
<br>
</p>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='compile-dynamic'>
#
(void)
<b>compile</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='awareOf-dynamic'>
#
(void)
<b>awareOf</b><span>(needle)</span>
<br>
</p>
<div class='docstring'>
<p>HELPERS</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='reference-dynamic'>
#
(void)
<b>reference</b><span>(needle, prefix)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='anchorFor-dynamic'>
#
(void)
<b>anchorFor</b><span>(entity)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='pathFor-dynamic'>
#
(void)
<b>pathFor</b><span>(kind, entity, prefix = &#39;&#39;)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='activate-dynamic'>
#
(void)
<b>activate</b><span>(text, prefix, limit = false)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='generateBreadcrumbs-dynamic'>
#
(void)
<b>generateBreadcrumbs</b><span>(entries = [])</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='calculatePath-dynamic'>
#
(void)
<b>calculatePath</b><span>(filename)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='render-dynamic'>
#
(void)
<b>render</b><span>(source, destination, context = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='renderAlphabeticalIndex-dynamic'>
#
(void)
<b>renderAlphabeticalIndex</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Generate the alphabetical index of all classes and mixins.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='renderIndex-dynamic'>
#
(void)
<b>renderIndex</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='renderClasses-dynamic'>
#
(void)
<b>renderClasses</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='renderMixins-dynamic'>
#
(void)
<b>renderMixins</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='renderFiles-dynamic'>
#
(void)
<b>renderFiles</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='renderExtras-dynamic'>
#
(void)
<b>renderExtras</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='renderFuzzySearchData-dynamic'>
#
(void)
<b>renderFuzzySearchData</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