documentation/test/fixture/html/nested.output.files
2016-05-22 20:04:03 -04:00

1053 lines
22 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'>
<section class='py2 clearfix'>
<div class='clearfix'>
<h2 class='fl' id='Klass'>
Klass
</h2>
</div>
<p>Creates a new Klass</p>
<div class='pre p1 fill-light'>Klass(foo: )</div>
<p>
Extends
<a href="https://nodejs.org/api/stream.html#stream_class_stream_writable">Stream.Writable</a>
</p>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>foo</span> <code class='quiet'>()</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Static Members</div>
<div class="clearfix">
<div class='keyline-bottom' id='Klass.isClass'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>isClass</span>
<span class='quiet code space-right2'>(other, also)</span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<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>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>other</span> <code class='quiet'>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code>
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>also</span> <code class='quiet'>(Any)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>:
whether the other thing is a Klass
</section>
</div>
</div>
<div class='keyline-bottom' id='Klass.isWeird'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>isWeird</span>
<span class='quiet code space-right2'>(other)</span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<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>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>other</span> <code class='quiet'>(Weird)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>:
whether the other thing is a Klass
</section>
</div>
</div>
<div class='keyline-bottom' id='Klass.isBuffer'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>isBuffer</span>
<span class='quiet code space-right2'>(buf, [size])</span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<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>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>buf</span> <code class='quiet'>((<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>))</code>
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>size</span> <code class='quiet'>([<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>]
(default <code>0</code>)
)</code> size
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code>:
whether the other thing is a Klass
</section>
</div>
</div>
<div class='keyline-bottom' id='Klass.isArrayOfBuffers'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>isArrayOfBuffers</span>
<span class='quiet code space-right2'>(buffers)</span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<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>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>buffers</span> <code class='quiet'>(<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;)</code> some buffers
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code>:
how many
<div class='py1 quiet mt1 prose-big'>Example</div>
<pre class='p1 overflow-auto round fill-light'><span class="hljs-keyword">var</span> k = <span class="hljs-keyword">new</span> Klass();
k.isArrayOfBuffers();</pre>
</section>
</div>
</div>
<div class='keyline-bottom' id='Klass.MAGIC_NUMBER'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>MAGIC_NUMBER</span>
<span class='quiet code space-right2'></span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<p>A magic number that identifies this Klass.</p>
<div class='pre p1 fill-light'>MAGIC_NUMBER</div>
</section>
</div>
</div>
<div class='keyline-bottom' id='Klass.event:event'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>event</span>
<span class='quiet code space-right2'></span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<p>Klass event</p>
<div class='pre p1 fill-light'>event</div>
</section>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='keyline-bottom' id='Klass#getFoo'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>getFoo</span>
<span class='quiet code space-right2'>()</span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<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>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></code>:
foo
<div class='py1 quiet mt1 prose-big'>Example</div>
<p><p>this shows you how to getFoo</p>
</p>
<pre class='p1 overflow-auto round fill-light'>foo.getFoo();</pre>
</section>
</div>
</div>
<div class='keyline-bottom' id='Klass#withOptions'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>withOptions</span>
<span class='quiet code space-right2'>(options, otherOptions)</span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<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>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>options</span> <code class='quiet'>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code>
</div>
<table class='mt1 mb2 fixed-table h5'>
<colgroup>
<col width='30%' />
<col width='70%' />
</colgroup>
<thead>
<tr class='bold fill-light'>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody class='mt1'>
<tr>
<td class='break-word'><span class='code bold'>options.foo</span> <code class='quiet'><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code>
</td>
<td class='break-word'><span></span></td>
</tr>
<tr>
<td class='break-word'><span class='code bold'>options.bar</span> <code class='quiet'><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code>
</td>
<td class='break-word'><span></span></td>
</tr>
</tbody>
</table>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>otherOptions</span> <code class='quiet'>(?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</section>
<section class='py2 clearfix'>
<div class='clearfix'>
<h2 class='fl' id='bar'>
bar
</h2>
</div>
<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>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="#Klass">Klass</a></code>:
that class
</section>
<section class='py2 clearfix'>
<div class='clearfix'>
<h2 class='fl' id='bar'>
bar
</h2>
</div>
<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>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>toys</span> <code class='quiet'>(...<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>)</code>
</div>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
nothing
</section>
<section class='py2 clearfix'>
<div class='clearfix'>
<h2 class='fl' id='bar'>
bar
</h2>
</div>
<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>
<div class='py1 quiet mt1 prose-big'>Returns</div>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></code>:
nothing
</section>
<section class='py2 clearfix'>
<div class='clearfix'>
<h2 class='fl' id='Foo'>
Foo
</h2>
</div>
<p>This is Foo</p>
<div class='pre p1 fill-light'>Foo()</div>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='keyline-bottom' id='Foo#bar'>
<div class="clearfix small pointer toggle-sibling">
<div class="pad1y contain">
<a class='icon pin-right pad1y dark-link caret-right'></a>
<span class='code strong strong truncate'>bar</span>
<span class='quiet code space-right2'></span>
</div>
</div>
<div class="clearfix hidden toggle-target">
<section class='py2 clearfix'>
<p>This is bar</p>
<div class='pre p1 fill-light'>bar</div>
</section>
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</div>
<script src='assets/anchor.js'></script>
<script src='assets/site.js'></script>
</body>
</html>