Skip to content

Commit

Permalink
Added v4.0 API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@stig
stig committed Nov 9, 2013
1 parent 9eb408f commit b8aa7ff
Show file tree
Hide file tree
Showing 44 changed files with 11,892 additions and 7 deletions.
319 changes: 319 additions & 0 deletions api/4.0/Categories/NSObject+SBProxyForJson.html
View file
@@ -0,0 +1,319 @@
<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>NSObject(SBProxyForJson) Category Reference</title>
<meta id="xcode-display" name="xcode-display" content="render"/>
<meta name="viewport" content="width=550" />
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
<meta name="generator" content="appledoc 2.0.5 (build 789)" />
</head>
<body>
<header id="top_header">
<div id="library" class="hideInXcode">
<h1><a id="libraryTitle" href="../index.html">SBJson </a></h1>
<a id="developerHome" href="../index.html">Stig Brautaset</a>
</div>

<div id="title" role="banner">
<h1 class="hideInXcode">NSObject(SBProxyForJson) Category Reference</h1>
</div>
<ul id="headerButtons" role="toolbar">
<li id="toc_button">
<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
</li>
<li id="jumpto_button" role="navigation">
<select id="jumpTo">
<option value="top">Jump To&#133;</option>

<option value="overview">Overview</option>




<option value="tasks">Tasks</option>









<option value="instance_methods">Instance Methods</option>

<option value="//api/name/proxyForJson">&nbsp;&nbsp;&nbsp;&nbsp;- proxyForJson</option>



</select>
</li>
</ul>
</header>
<nav id="tocContainer" class="isShowingTOC">
<ul id="toc" role="tree">

<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>




<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>

</ul></li>









<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/proxyForJson">proxyForJson</a></span></li>

</ul></li>


</ul>
</nav>
<article>
<div id="contents" class="isShowingTOC" role="main">
<a title="NSObject(SBProxyForJson) Category Reference" name="top"></a>
<div class="main-navigation navigation-top">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="header">
<div class="section-header">
<h1 class="title title-header">NSObject(SBProxyForJson) Category Reference</h1>
</div>
</div>
<div id="container">

<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<td class="specification-title">Declared in</td>
<td class="specification-value">SBJsonStreamWriter.h</td>
</tr>
</tbody></table></div>




<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>Enable JSON writing for non-native objects</p>
</div>





<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<h2 class="subtitle subtitle-tasks">Tasks</h2>





<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/proxyForJson">&ndash;&nbsp;proxyForJson</a></code>
<span class="tooltip"><p>Allows generation of JSON for otherwise unsupported classes.</p></span>
</span>


</li>
</ul>

</div>









<div class="section section-methods">
<a title="Instance Methods" name="instance_methods"></a>
<h2 class="subtitle subtitle-methods">Instance Methods</h2>

<div class="section-method">
<a name="//api/name/proxyForJson" title="proxyForJson"></a>
<h3 class="subsubtitle method-title">proxyForJson</h3>



<div class="method-subsection brief-description">
<p>Allows generation of JSON for otherwise unsupported classes.</p>
</div>



<div class="method-subsection method-declaration"><code>- (id)proxyForJson</code></div>









<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If you have a custom class that you want to create a JSON representation
for you can implement this method in your class. It should return a
representation of your object defined in terms of objects that can be
translated into JSON. For example, a Person object might implement it like this:</p>

<pre><code> - (id)proxyForJson {
return [NSDictionary dictionaryWithObjectsAndKeys:
name, @"name",
phone, @"phone",
email, @"email",
nil];
}
</code></pre>
</div>







<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">SBJsonStreamWriter.h</code><br />
</div>


</div>

</div>


</div>
<div class="main-navigation navigation-bottom">
<ul>
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
</ul>
</div>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2013 Stig Brautaset. All rights reserved. (Last updated: 2013-11-09)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>

</div>
</div>
</div>
</article>
<script type="text/javascript">
function jumpToChange()
{
window.location.hash = this.options[this.selectedIndex].value;
}

function toggleTOC()
{
var contents = document.getElementById('contents');
var tocContainer = document.getElementById('tocContainer');

if (this.getAttribute('class') == 'open')
{
this.setAttribute('class', '');
contents.setAttribute('class', '');
tocContainer.setAttribute('class', '');

window.name = "hideTOC";
}
else
{
this.setAttribute('class', 'open');
contents.setAttribute('class', 'isShowingTOC');
tocContainer.setAttribute('class', 'isShowingTOC');

window.name = "";
}
return false;
}

function toggleTOCEntryChildren(e)
{
e.stopPropagation();
var currentClass = this.getAttribute('class');
if (currentClass == 'children') {
this.setAttribute('class', 'children open');
}
else if (currentClass == 'children open') {
this.setAttribute('class', 'children');
}
return false;
}

function tocEntryClick(e)
{
e.stopPropagation();
return true;
}

function init()
{
var selectElement = document.getElementById('jumpTo');
selectElement.addEventListener('change', jumpToChange, false);

var tocButton = document.getElementById('table_of_contents');
tocButton.addEventListener('click', toggleTOC, false);

var taskTreeItem = document.getElementById('task_treeitem');
if (taskTreeItem.getElementsByTagName('li').length > 0)
{
taskTreeItem.setAttribute('class', 'children');
taskTreeItem.firstChild.setAttribute('class', 'disclosure');
}

var tocList = document.getElementById('toc');

var tocEntries = tocList.getElementsByTagName('li');
for (var i = 0; i < tocEntries.length; i++) {
tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
}

var tocLinks = tocList.getElementsByTagName('a');
for (var i = 0; i < tocLinks.length; i++) {
tocLinks[i].addEventListener('click', tocEntryClick, false);
}

if (window.name == "hideTOC") {
toggleTOC.call(tocButton);
}
}

window.onload = init;

// If showing in Xcode, hide the TOC and Header
if (navigator.userAgent.match(/xcode/i)) {
document.getElementById("contents").className = "hideInXcode"
document.getElementById("tocContainer").className = "hideInXcode"
document.getElementById("top_header").className = "hideInXcode"
}

</script>
</body>
</html>

0 comments on commit b8aa7ff

Please sign in to comment.