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

310 lines
6.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'>Example</span>
&raquo;
<span class='title'>Methods</span>
&raquo;
<span class='title'>Virtual</span>
</div>
</div>
<div id='content'>
<h1>
Class:
Example.Methods.Virtual
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>node_modules&#47;grunt-codo&#47;node_modules&#47;codo&#47;spec&#47;_templates&#47;methods&#47;dynamic_methods.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>This class has virtual methods, which doesn&#39;t
exist in the source but appears in the documentation.</p><p>This line should be part of the class description, and the method declaration
shouldn&#39;t have messed it up.</p>
</div>
<div class='tags'>
</div>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#get-static'>
.
(Object)
<b>get</b><span>(key)</span>
</a>
</span>
<span class='desc'>
Gets a value
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#set-dynamic'>
#
(void)
<b>set</b><span>(key, value)</span>
</a>
</span>
<span class='desc'>
Sets a value
</span>
</li>
<li>
<span class='signature'>
<a href='#delete-dynamic'>
#
(void)
<b>delete</b><span>({key, passion}, foo = &#39;bar&#39;)</span>
</a>
</span>
<span class='desc'>
Deletes a key from the data.
</span>
</li>
</ul>
<h2>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='get-static'>
.
(Object)
<b>get</b><span>(key)</span>
<br>
</p>
<div class='docstring'>
<p>Gets a value</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>key</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>describe key param </span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>Object</tt>
)
&mdash;
<span class='desc'>describe value param </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='set-dynamic'>
#
(void)
<b>set</b><span>(key, value)</span>
<br>
</p>
<div class='docstring'>
<p>Sets a value</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>key</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>describe key param </span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
&mdash;
<span class='desc'>describe value param </span>
</li>
</ul>
<h3>
Options Hash:
(value):
</h3>
<ul class='options'>
<li>
<span class='name'>string</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
</li>
<li>
<span class='name'>number</span>
<span class='type'>
(
<tt>Integer</tt>
)
</span>
</li>
<li>
<span class='name'>whatever</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='delete-dynamic'>
#
(void)
<b>delete</b><span>({key, passion}, foo = &#39;bar&#39;)</span>
<br>
</p>
<div class='docstring'>
<p>Deletes a key from the data.</p><p>Another line</p>
<div class='examples'>
<h3>Examples:</h3>
<h4>
Delete a key.
</h4>
<pre><code class='coffeescript'>emv = new Example.Methods.Virtual
emv.set &#39;foo&#39;, &#39;bar&#39;
val = emv.get &#39;foo&#39;
# now, proclaim you&#39;re done with foo.
emv.delete &#39;foo&#39;</code></pre>
</div>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>key</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>describe key param </span>
</li>
</ul>
</div>
</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