json-api-schema
Version:
JSON Api Schema is a JSON dialect that can describe any Web Based API that uses JSON to exchange data.
193 lines (192 loc) • 5.43 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>JSON API Schema Documentation</title>
<link rel='stylesheet' href='../assets/codo.css' type='text/css'>
<script src='../assets/codo.js'></script>
<script src='../assets/search_data.js'></script>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../README.md.html' title='JSON API Schema'>JSON API Schema</a>
»
<a href='../class_index.html' title='Index'>Index</a>
»
<span class='title'>Resource</span>
<nav>
<ul>
<li class='noframes'>
(<a class='noframes' href='#'>no frames</a>)
</li>
</ul>
</nav>
<div id='search'>
<a id='class_list_link' href='../class_list.html'>Classes</a>
<a id='file_list_link' href='../file_list.html'>Files</a>
<a id='method_list_link' href='../method_list.html'>Methods</a>
<a id='extra_list_link' href='../extra_list.html'>Extras</a>
</div>
</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>Ctrl-T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
In frame mode you can toggle the list naviation frame on the left side:
</p>
<ul>
<li>
<span>Ctrl-L</span>
Toggle list view
</li>
</ul>
<p>
You can focus a list in frame mode or toggle a tab in frameless mode:
</p>
<ul>
<li>
<span>Ctrl-C</span>
Class list
</li>
<li>
<span>Ctrl-I</span>
Mixin list
</li>
<li>
<span>Ctrl-F</span>
File list
</li>
<li>
<span>Ctrl-M</span>
Method list
</li>
<li>
<span>Ctrl-E</span>
Extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>Ctrl-S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
<p>
In frameless mode you can close the list tab:
</p>
<ul>
<li>
<span>Esc</span>
Close list tab
</li>
</ul>
</div>
</div>
<div id='content'>
<h1>
Class:
Resource
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/model/resource.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../classes/Scope.html'>Scope</a>
</td>
</tr>
</table>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#constructor-instance'>
- (void) <strong>constructor</strong>(options)
</a>
</span>
<span class='constructor note title'>Constructor</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
</h2>
<h3 class='inherited'>
Methods inherited from
<a href='../classes/Scope.html'>Scope</a>
</h3>
<p class='inherited'>
<a href='../classes/Scope.html#constructor-instance'>#constructor</a>
</p>
<h3 class='inherited'>
Methods inherited from
<a href='../classes/Entity.html'>Entity</a>
</h3>
<p class='inherited'>
<a href='../classes/Entity.html#extend-class'>.extend</a>,
<a href='../classes/Entity.html#include-class'>.include</a>,
<a href='../classes/Entity.html#accessors-class'>.accessors</a>,
<a href='../classes/Entity.html#children-class'>.children</a>,
<a href='../classes/Entity.html#entity-class'>.entity</a>,
<a href='../classes/Entity.html#constructor-instance'>#constructor</a>,
<a href='../classes/Entity.html#getEntityType-instance'>#getEntityType</a>,
<a href='../classes/Entity.html#isInstanceOfEntity-instance'>#isInstanceOfEntity</a>,
<a href='../classes/Entity.html#getParent-instance'>#getParent</a>,
<a href='../classes/Entity.html#setParent-instance'>#setParent</a>,
<a href='../classes/Entity.html#isRoot-instance'>#isRoot</a>,
<a href='../classes/Entity.html#getAncestors-instance'>#getAncestors</a>,
<a href='../classes/Entity.html#getChildrenIterator-instance'>#getChildrenIterator</a>,
<a href='../classes/Entity.html#isLeaf-instance'>#isLeaf</a>
</p>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-instance'>
- (void) <strong>constructor</strong>(options)
</p>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
Generated on
Fri Sep 20 2013 14:12:12 GMT+0200 (CEST)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
v1.7.2
(Node.js v0.10.15).
✲
Press Ctrl-h to see the keyboard shortcuts
✲
<a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
✲
<a href='https://mksoft.ch'>mksoft.ch</a>
</div>
</body>
</html>