documentation/test/fixture/html/nested.output.files
2016-05-05 10:00:57 -04:00

1018 lines
21 KiB
Plaintext

<!doctype html>
<html>
<head>
<meta charset='utf-8' />
<title> | Documentation</title>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' type='text/css' rel='stylesheet' />
<link href='assets/style.css' type='text/css' rel='stylesheet' />
<link href='assets/github.css' type='text/css' rel='stylesheet' />
</head>
<body class='documentation'>
<div class='max-width-4 mx-auto'>
<div class='clearfix md-mxn2'>
<div class='fixed xs-hide fix-3 overflow-auto max-height-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'></h3>
<div class='mb1'><code></code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#Klass'
class=" toggle-sibling">
Klass
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'>Static members</li>
<li><a
href='#Klass.isClass'
class='regular pre-open'>
.isClass
</a></li>
<li><a
href='#Klass.isWeird'
class='regular pre-open'>
.isWeird
</a></li>
<li><a
href='#Klass.isBuffer'
class='regular pre-open'>
.isBuffer
</a></li>
<li><a
href='#Klass.isArrayOfBuffers'
class='regular pre-open'>
.isArrayOfBuffers
</a></li>
<li><a
href='#Klass.MAGIC_NUMBER'
class='regular pre-open'>
.MAGIC_NUMBER
</a></li>
<li><a
href='#Klass.event:event'
class='regular pre-open'>
.event
</a></li>
</ul>
<ul class='list-reset py1-ul pl1'>
<li class='h5'>Instance members</li>
<li><a
href='#Klass#getFoo'
class='regular pre-open'>
#getFoo
</a></li>
<li><a
href='#Klass#withOptions'
class='regular pre-open'>
#withOptions
</a></li>
</ul>
</div>
</li>
<li><a
href='#bar'
class="">
bar
</a>
</li>
<li><a
href='#bar'
class="">
bar
</a>
</li>
<li><a
href='#bar'
class="">
bar
</a>
</li>
<li><a
href='#Foo'
class=" toggle-sibling">
Foo
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'>Instance members</li>
<li><a
href='#Foo#bar'
class='regular pre-open'>
#bar
</a></li>
</ul>
</div>
</li>
</ul>
</div>
</div>
</div>
<div class='fix-margin-3'>
<div class='px2'>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h3 id='Klass' class='mt0'>
Klass
</h3>
<p>Creates a new Klass</p>
<div class='pre p1 fill-light'>new Klass(foo: )</div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>foo</code> <em>()</em>:
</li>
</ol>
<h4>Static members</h4>
<div class="clearfix">
<div class="sm-col sm-col-7 h5">Method</div>
<div class="sm-col sm-col-5 h5">Description</div>
<div id='Klass.isClass'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>isClass(other: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, also: Any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">Decide whether an object is a Klass instance
This is a
[klasssic]
<a href="#Klass">Klass</a>
This is a
[link to something that does not exist]
<a href="#DoesNot">DoesNot</a>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass.isClass' class='mt0'>
isClass
</h3>
<p>Decide whether an object is a Klass instance
This is a [klasssic]<a href="##Klass">Klass</a>
This is a [link to something that does not exist]<a href="##DoesNot">DoesNot</a></p>
<div class='pre p1 fill-light'>isClass(other: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, also: Any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>other</code> <em>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</em>:
</li>
<li><code>also</code> <em>(Any)</em>:
</li>
</ol>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>:
whether the other thing is a Klass
</div>
</div>
<div id='Klass.isWeird'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>isWeird(other: Weird): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">A function that triggers the case where the autolinker doesn&#x27;t find
the referenced class type
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass.isWeird' class='mt0'>
isWeird
</h3>
<p>A function that triggers the case where the autolinker doesn&#x27;t find
the referenced class type</p>
<div class='pre p1 fill-light'>isWeird(other: Weird): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>other</code> <em>(Weird)</em>:
</li>
</ol>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>:
whether the other thing is a Klass
</div>
</div>
<div id='Klass.isBuffer'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>isBuffer(buf: (<a href="https://nodejs.org/api/buffer.html">Buffer</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>), size: [<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>]): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">This method takes a Buffer object that will be linked to nodejs.org
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass.isBuffer' class='mt0'>
isBuffer
</h3>
<p>This method takes a Buffer object that will be linked to nodejs.org</p>
<div class='pre p1 fill-light'>isBuffer(buf: (<a href="https://nodejs.org/api/buffer.html">Buffer</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>), size: [<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>]): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>buf</code> <em>((<a href="https://nodejs.org/api/buffer.html">Buffer</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>))</em>:
</li>
<li><code>size</code> <em>([<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>]
(default <code>0</code>)
)</em>: size
</li>
</ol>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>:
whether the other thing is a Klass
</div>
</div>
<div id='Klass.isArrayOfBuffers'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>isArrayOfBuffers(buffers: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://nodejs.org/api/buffer.html">Buffer</a>&gt;): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">This method takes an array of buffers and counts them
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass.isArrayOfBuffers' class='mt0'>
isArrayOfBuffers
</h3>
<p>This method takes an array of buffers and counts them</p>
<div class='pre p1 fill-light'>isArrayOfBuffers(buffers: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://nodejs.org/api/buffer.html">Buffer</a>&gt;): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>buffers</code> <em>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://nodejs.org/api/buffer.html">Buffer</a>&gt;)</em>: some buffers
</li>
</ol>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>:
how many
<h4>Examples</h4>
<pre class='p1 overflow-auto fill-light'><span class="hljs-keyword">var</span> k = <span class="hljs-keyword">new</span> Klass();
k.isArrayOfBuffers();</pre>
</div>
</div>
<div id='Klass.MAGIC_NUMBER'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>MAGIC_NUMBER</span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">A magic number that identifies this Klass.
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass.MAGIC_NUMBER' class='mt0'>
MAGIC_NUMBER
</h3>
<p>A magic number that identifies this Klass.</p>
<div class='pre p1 fill-light'>MAGIC_NUMBER</div>
</div>
</div>
<div id='Klass.event:event'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>event</span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">Klass event
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass.event:event' class='mt0'>
event
</h3>
<p>Klass event</p>
<div class='pre p1 fill-light'>event</div>
</div>
</div>
</div>
<h4>Instance members</h4>
<div class="clearfix">
<div class="sm-col sm-col-7 h5">Method</div>
<div class="sm-col sm-col-5 h5">Description</div>
<div id='Klass#getFoo'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>getFoo: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">Get this Klass&#x27;s foo
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass#getFoo' class='mt0'>
getFoo
</h3>
<p>Get this Klass&#x27;s foo</p>
<div class='pre p1 fill-light'>getFoo: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></div>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>:
foo
<h4>Examples</h4>
<p><p>this shows you how to getFoo</p>
</p>
<pre class='p1 overflow-auto fill-light'>foo.getFoo();</pre>
</div>
</div>
<div id='Klass#withOptions'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>withOptions(options: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, otherOptions: ?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">A function with an options parameter
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Klass#withOptions' class='mt0'>
withOptions
</h3>
<p>A function with an options parameter</p>
<div class='pre p1 fill-light'>withOptions(options: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, otherOptions: ?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>options</code> <em>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</em>:
<ul>
<li><code>options.foo</code> <em>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</em>
</li>
<li><code>options.bar</code> <em>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</em>
</li>
</ul>
</li>
<li><code>otherOptions</code> <em>(?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</em>:
</li>
</ol>
</div>
</div>
</div>
</div>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h3 id='bar' class='mt0'>
bar
</h3>
<p>Get an instance of <a href="#Klass">Klass</a>. Will make
a <a href="#Klass">klass instance multiword</a>,
like a <a href="#Klass">klass</a></p>
<div class='pre p1 fill-light'>bar: <a href="#Klass">Klass</a></div>
<h4>Returns</h4>
<a href="#Klass">Klass</a>:
that class
</div>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h3 id='bar' class='mt0'>
bar
</h3>
<p>Rest property function</p>
<div class='pre p1 fill-light'>bar(toys: ...<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<h4>Parameters</h4>
<ol class='my1'>
<li><code>toys</code> <em>(...<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>)</em>:
</li>
</ol>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a>:
nothing
</div>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h3 id='bar' class='mt0'>
bar
</h3>
<p>Get an instance of <a href="#Klass">Klass</a>. Will make
a <a href="#Klass">klass instance multiword</a>,
like a <a href="#Klass">klass</a>. This needs a <a href="#number">number</a> input.</p>
<div class='pre p1 fill-light'>bar: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a>:
nothing
</div>
<div class='keyline-top-not py2'><section class='py2 clearfix'>
<h3 id='Foo' class='mt0'>
Foo
</h3>
<p>This is Foo</p>
<div class='pre p1 fill-light'>new Foo</div>
<h4>Instance members</h4>
<div class="clearfix">
<div class="sm-col sm-col-7 h5">Method</div>
<div class="sm-col sm-col-5 h5">Description</div>
<div id='Foo#bar'>
<div class="clearfix toggle-sibling">
<div class="py1 keyline-top sm-col sm-col-7">
<a class='h6 toggle-step-sibling icon'>▸</a> <span class='pre'>bar</span>
</div>
<div class="py1 keyline-top sm-col sm-col-5 h5 truncate">This is bar
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='py2 clearfix'>
<h3 id='Foo#bar' class='mt0'>
bar
</h3>
<p>This is bar</p>
<div class='pre p1 fill-light'>bar</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src='assets/anchor.js'></script>
<script src='assets/site.js'></script>
</body>
</html>