Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@daikini
daikini committed Oct 23, 2013
1 parent e96fd09 commit e75e250
Show file tree
Hide file tree
Showing 9 changed files with 109 additions and 39 deletions.
85 changes: 62 additions & 23 deletions Documentation/html/Classes/PKSyncManager.html
View file
Expand Up @@ -4,10 +4,9 @@
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
<title>PKSyncManager Class 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.1 (build 840)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand Down Expand Up @@ -46,6 +45,8 @@ <h1 class="hideInXcode">PKSyncManager Class Reference</h1>

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

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




Expand Down Expand Up @@ -118,6 +119,8 @@ <h1 class="hideInXcode">PKSyncManager Class Reference</h1>

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

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

</ul></li>


Expand Down Expand Up @@ -187,8 +190,8 @@ <h1 class="title title-header">PKSyncManager Class Reference</h1>
</tr>
</tbody></table></div>


<div class="section section-overview">
<a title="Overview" name="overview"></a>
Expand All @@ -213,28 +216,30 @@ <h3 class="subsubtitle task-title">Other Methods</h3>
<li>
<span class="tooltip">
<code><a href="#//api/name/managedObjectContext">&nbsp;&nbsp;managedObjectContext</a></code>
<span class="tooltip"><p>The Core Data managed object context to listen for changes from.</p></span>
</span>
<span class="task-item-suffix">property</span>

</li><li>
<span class="tooltip">
<code><a href="#//api/name/datastore">&nbsp;&nbsp;datastore</a></code>
<span class="tooltip"><p>The Dropbox Datastore to read and write to.</p></span>
</span>
<span class="task-item-suffix">property</span>

</li><li>
<span class="tooltip">
<code><a href="#//api/name/syncAttributeName">&nbsp;&nbsp;syncAttributeName</a></code>
<span class="tooltip"><p>The Core Data entity attribute name to use for keeping managed objects in sync.</p></span>
</span>
<span class="task-item-suffix">property</span>

</li><li>
<span class="tooltip">
<code><a href="#//api/name/syncBatchSize">&nbsp;&nbsp;syncBatchSize</a></code>
</span>
<span class="task-item-suffix">property</span>

</li><li>
<span class="tooltip">
<code><a href="#//api/name/syncID">+&nbsp;syncID</a></code>
<span class="tooltip"><p>Returns a random string suitable for using as a sync identifer.</p></span>
</span>


Expand All @@ -249,28 +254,24 @@ <h3 class="subsubtitle task-title">Creating and Configuring a Sync Manager</h3>
<li>
<span class="tooltip">
<code><a href="#//api/name/initWithManagedObjectContext:datastore:">&ndash;&nbsp;initWithManagedObjectContext:datastore:</a></code>
<span class="tooltip"><p>The designated initializer used to specify the Core Data managed object context and the Dropbox data store that should be synchronized.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/setTablesForEntityNamesWithDictionary:">&ndash;&nbsp;setTablesForEntityNamesWithDictionary:</a></code>
<span class="tooltip"><p>Map multiple Core Data entity names to their corresponding Dropbox data store table name. Replaces all other existing relationships that may have been previously set.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/setTable:forEntityName:">&ndash;&nbsp;setTable:forEntityName:</a></code>
<span class="tooltip"><p>Maps a single Core Data entity name to the corresponding Dropbox data store table name.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/removeTableForEntityName:">&ndash;&nbsp;removeTableForEntityName:</a></code>
<span class="tooltip"><p>Removes the Core Data &lt;&ndash;> Dropbox mapping for the given entity name.</p></span>
</span>


Expand All @@ -285,35 +286,30 @@ <h3 class="subsubtitle task-title">Accessing Entity Names and Tables</h3>
<li>
<span class="tooltip">
<code><a href="#//api/name/tablesByEntityName">&ndash;&nbsp;tablesByEntityName</a></code>
<span class="tooltip"><p>Returns a dictionary of tables mapped to their corresponding entity names.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/tableIDs">&ndash;&nbsp;tableIDs</a></code>
<span class="tooltip"><p>Returns an array of currently mapped Dropbox data store tableIDs.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/entityNames">&ndash;&nbsp;entityNames</a></code>
<span class="tooltip"><p>Returns an array of currently mapped Core Data entity names.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/tableForEntityName:">&ndash;&nbsp;tableForEntityName:</a></code>
<span class="tooltip"><p>Returns the tableID associated with a given entity name.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/entityNameForTable:">&ndash;&nbsp;entityNameForTable:</a></code>
<span class="tooltip"><p>Returns the entity name associated with a given tableID.</p></span>
</span>


Expand All @@ -328,21 +324,18 @@ <h3 class="subsubtitle task-title">Observing Changes</h3>
<li>
<span class="tooltip">
<code><a href="#//api/name/isObserving">&ndash;&nbsp;isObserving</a></code>
<span class="tooltip"><p>Returns whether or not the sync manager is currently observing changes.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/startObserving">&ndash;&nbsp;startObserving</a></code>
<span class="tooltip"><p>Starts observing changes to the Core Data managed object context and the Dropbox data store.</p></span>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/stopObserving">&ndash;&nbsp;stopObserving</a></code>
<span class="tooltip"><p>Stops observing changes from the Core Data managed object context and the Dropbox data store.</p></span>
</span>


Expand Down Expand Up @@ -469,6 +462,50 @@ <h4 class="method-subtitle">Discussion</h4>



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


</div>

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



<div class="method-subsection brief-description">
<p>The number of Core Data managed objects to sync with the DBDatastore at a time.</p>
</div>



<div class="method-subsection method-declaration"><code>@property (nonatomic) NSUInteger syncBatchSize</code></div>









<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The DBDatastore has a 2 MiB delta size limit so changes in the managed object context
must be batched to remain below this limit.</p>

<p>The default value is “20”. (2048 KiB max delta size / 100 KiB max record size)</p>
</div>







<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">PKSyncManager.h</code><br />
Expand Down Expand Up @@ -740,7 +777,7 @@ <h3 class="subsubtitle method-title">removeTableForEntityName:</h3>


<div class="method-subsection brief-description">
<p>Removes the Core Data &lt;&ndash;> Dropbox mapping for the given entity name.</p>
<p>Removes the Core Data &lt;-> Dropbox mapping for the given entity name.</p>
</div>


Expand Down Expand Up @@ -1090,6 +1127,8 @@ <h4 class="method-subtitle">Declared In</h4>
</div>




</div>
<div class="main-navigation navigation-bottom">
<ul>
Expand All @@ -1100,9 +1139,9 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2013 Overcommitted, LLC. All rights reserved. (Last updated: 2013-07-30)</span><br />
<p><span class="copyright">&copy; 2013 Overcommitted, LLC. All rights reserved. (Last updated: 2013-10-23)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

</div>
</div>
Expand Down
51 changes: 41 additions & 10 deletions Documentation/html/css/styles.css 100755 → 100644
View file
Expand Up @@ -89,9 +89,9 @@ th {

#contents, #overview_contents {
-webkit-overflow-scrolling: touch;
border-top: 1px solid #2B334F;
border-top: 1px solid #A9A9A9;
position: absolute;
top: 91px;
top: 90px;
left: 0;
right: 0;
bottom: 0;
Expand Down Expand Up @@ -169,6 +169,10 @@ th {
position: absolute;
}

#libraryTitle {
left: 0;
}

#top_header #library #developerHome {
color: #92979E;
right: 15px;
Expand All @@ -182,26 +186,26 @@ th {

#top_header #title {
background: url("../img/title_background.png") repeat-x 0 0 #8A98A9;
border-bottom: 1px solid #B6B6B6;
border-bottom: 1px solid #757575;
height: 25px;
overflow: hidden;
}

#top_header h1 {
font-size: 115%;
font-size: 105%;
font-weight: normal;
margin: 0;
padding: 3px 0 2px;
text-align: center;
text-shadow: 0 1px 0 #D5D5D5;
/*text-shadow: 0 1px 0 #D5D5D5;*/
white-space: nowrap;
}

#headerButtons {
background-color: #D8D8D8;
background-image: url("../img/button_bar_background.png");
border-bottom: 1px solid #EDEDED;
border-top: 1px solid #2B334F;
border-bottom: 0px solid #EDEDED;
border-top: 0px solid #a8a8a8;
font-size: 8pt;
height: 28px;
left: 0;
Expand All @@ -223,6 +227,7 @@ th {
}

#toc_button button {
background-color: #EBEEF1;
border-color: #ACACAC;
border-style: none solid none none;
border-width: 0 1px 0 0;
Expand Down Expand Up @@ -258,14 +263,14 @@ li#jumpto_button select {
}

#tocContainer {
background-color: #E4EBF7;
border-top: 1px solid #2B334F;
background-color: #EBEEF1;
border-top: 1px solid #ACACAC;
bottom: 0;
display: none;
left: 0;
overflow: hidden;
position: absolute;
top: 91px;
top: 90px;
width: 229px;
}

Expand Down Expand Up @@ -542,6 +547,32 @@ span.tooltip:hover span.tooltip {
color: #000;
}

.termdef {
margin-bottom: 10px;
margin-left: 0px;
margin-right: 0px;
margin-top: 0px;
}

.termdef dt {
margin: 0;
padding: 0;
}

.termdef dd {
margin-bottom: 6px;
margin-left: 16px;
margin-right: 0px;
margin-top: 1px;
}

.termdef dd p {
margin-bottom: 6px;
margin-left: 0px;
margin-right: 0px;
margin-top: -1px;
}

.argument-def {
margin-top: 0.3em;
margin-bottom: 0.3em;
Expand Down
6 changes: 3 additions & 3 deletions Documentation/html/hierarchy.html
View file
Expand Up @@ -5,7 +5,7 @@
<title>ParcelKit Hierarchy</title>
<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.1 (build 840)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand Down Expand Up @@ -57,9 +57,9 @@ <h2 class="index-title">Class Hierarchy</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2013 Overcommitted, LLC. All rights reserved. (Last updated: 2013-07-30)</span><br />
<p><span class="copyright">&copy; 2013 Overcommitted, LLC. All rights reserved. (Last updated: 2013-10-23)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>


</div>
Expand Down
Binary file modified Documentation/html/img/button_bar_background.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/html/img/disclosure.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/html/img/disclosure_open.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/html/img/library_background.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Documentation/html/img/title_background.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions Documentation/html/index.html
View file
Expand Up @@ -5,7 +5,7 @@
<title>ParcelKit Reference</title>
<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.1 (build 840)" />
<meta name="generator" content="appledoc 2.2 (build 961)" />
</head>
<body>
<header id="top_header">
Expand Down Expand Up @@ -53,9 +53,9 @@ <h2 class="index-title">Class References</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2013 Overcommitted, LLC. All rights reserved. (Last updated: 2013-07-30)</span><br />
<p><span class="copyright">&copy; 2013 Overcommitted, LLC. All rights reserved. (Last updated: 2013-10-23)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p>
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>


</div>
Expand Down

0 comments on commit e75e250

Please sign in to comment.