Skip to content

Commit

Permalink
[Docs] gen docs for 8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@jessesquires
jessesquires committed Nov 5, 2018
1 parent b8f4997 commit e52c324
Show file tree
Hide file tree
Showing 21 changed files with 592 additions and 1,124 deletions.
33 changes: 6 additions & 27 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
Expand Down Expand Up @@ -43,14 +44,6 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global Variables.html#/s:14JSQCoreDataKit19defaultStoreOptionss10DictionaryVys11AnyHashableVyXlGv">defaultStoreOptions</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
Expand All @@ -72,13 +65,10 @@
</ul>
</li>
<li class="nav-group-name">
<a href="Functions.html">Functions</a>
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Functions.html#/s:14JSQCoreDataKit19defaultDirectoryURL10Foundation0F0VyF">defaultDirectoryURL()</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:14JSQCoreDataKit11saveContextySo015NSManagedObjectE0C_Sb4waityAA10SaveResultOcSg10completiontF">saveContext(_:wait:completion:)</a>
<a href="Extensions/NSManagedObjectContext.html">NSManagedObjectContext</a>
</li>
</ul>
</li>
Expand All @@ -101,17 +91,6 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Typealiases.html#/s:14JSQCoreDataKit12ChildContexta">ChildContext</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/s:14JSQCoreDataKit22PersistentStoreOptionsa">PersistentStoreOptions</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
Expand Down Expand Up @@ -157,7 +136,7 @@ <h1>Classes</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CoreDataStack</span><span class="p">:</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">Equatable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CoreDataStack</span></code></pre>

</div>
</div>
Expand All @@ -169,8 +148,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://twitter.com/jesse_squires" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2017-12-31)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://twitter.com/jesse_squires" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2018-11-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
84 changes: 31 additions & 53 deletions docs/Classes/CoreDataStack.html
View file

Large diffs are not rendered by default.

75 changes: 27 additions & 48 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

</head>
<body>
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
Expand Down Expand Up @@ -43,14 +44,6 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global Variables.html#/s:14JSQCoreDataKit19defaultStoreOptionss10DictionaryVys11AnyHashableVyXlGv">defaultStoreOptions</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
Expand All @@ -72,13 +65,10 @@
</ul>
</li>
<li class="nav-group-name">
<a href="Functions.html">Functions</a>
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Functions.html#/s:14JSQCoreDataKit19defaultDirectoryURL10Foundation0F0VyF">defaultDirectoryURL()</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:14JSQCoreDataKit11saveContextySo015NSManagedObjectE0C_Sb4waityAA10SaveResultOcSg10completiontF">saveContext(_:wait:completion:)</a>
<a href="Extensions/NSManagedObjectContext.html">NSManagedObjectContext</a>
</li>
</ul>
</li>
Expand All @@ -101,17 +91,6 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Typealiases.html#/s:14JSQCoreDataKit12ChildContexta">ChildContext</a>
</li>
<li class="nav-group-task">
<a href="Typealiases.html#/s:14JSQCoreDataKit22PersistentStoreOptionsa">PersistentStoreOptions</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
Expand All @@ -127,25 +106,27 @@ <h1>Enumerations</h1>
<li class="item">
<div>
<code>
<a name="/s:14JSQCoreDataKit9StoreTypeO"></a>
<a name="//apple_ref/swift/Enum/StoreType" class="dashAnchor"></a>
<a class="token" href="#/s:14JSQCoreDataKit9StoreTypeO">StoreType</a>
<a name="/s:14JSQCoreDataKit18ModelFileExtensionO"></a>
<a name="//apple_ref/swift/Enum/ModelFileExtension" class="dashAnchor"></a>
<a class="token" href="#/s:14JSQCoreDataKit18ModelFileExtensionO">ModelFileExtension</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Describes a Core Data persistent store type.</p>
<p>Describes a Core Data model file exention type based on the
<a href="https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/CoreDataVersioning/Articles/vmModelFormat.html">Model File Format and Versions</a>
documentation.</p>

<a href="Enums/StoreType.html" class="slightly-smaller">See more</a>
<a href="Enums/ModelFileExtension.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StoreType</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ModelFileExtension</span> <span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -177,7 +158,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MigrationError</span><span class="p">:</span> <span class="kt">Error</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MigrationError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -209,7 +190,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SaveResult</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SaveResult</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>

</div>
</div>
Expand All @@ -223,27 +204,25 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:14JSQCoreDataKit18ModelFileExtensionO"></a>
<a name="//apple_ref/swift/Enum/ModelFileExtension" class="dashAnchor"></a>
<a class="token" href="#/s:14JSQCoreDataKit18ModelFileExtensionO">ModelFileExtension</a>
<a name="/s:14JSQCoreDataKit11StackResultO"></a>
<a name="//apple_ref/swift/Enum/StackResult" class="dashAnchor"></a>
<a class="token" href="#/s:14JSQCoreDataKit11StackResultO">StackResult</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Describes a Core Data model file exention type based on the
<a href="https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/CoreDataVersioning/Articles/vmModelFormat.html">Model File Format and Versions</a>
documentation.</p>
<p>A result object representing the result of creating a <code><a href="Classes/CoreDataStack.html">CoreDataStack</a></code> via a <code><a href="Structs/CoreDataStackFactory.html">CoreDataStackFactory</a></code>.</p>

<a href="Enums/ModelFileExtension.html" class="slightly-smaller">See more</a>
<a href="Enums/StackResult.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ModelFileExtension</span><span class="p">:</span> <span class="kt">String</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StackResult</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>

</div>
</div>
Expand All @@ -257,25 +236,25 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:14JSQCoreDataKit11StackResultO"></a>
<a name="//apple_ref/swift/Enum/StackResult" class="dashAnchor"></a>
<a class="token" href="#/s:14JSQCoreDataKit11StackResultO">StackResult</a>
<a name="/s:14JSQCoreDataKit9StoreTypeO"></a>
<a name="//apple_ref/swift/Enum/StoreType" class="dashAnchor"></a>
<a class="token" href="#/s:14JSQCoreDataKit9StoreTypeO">StoreType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A result object representing the result of creating a <code><a href="Classes/CoreDataStack.html">CoreDataStack</a></code> via a <code><a href="Structs/CoreDataStackFactory.html">CoreDataStackFactory</a></code>.</p>
<p>Describes a Core Data persistent store type.</p>

<a href="Enums/StackResult.html" class="slightly-smaller">See more</a>
<a href="Enums/StoreType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StackResult</span><span class="p">:</span> <span class="kt">Equatable</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StoreType</span> <span class="p">:</span> <span class="kt">Equatable</span></code></pre>

</div>
</div>
Expand All @@ -287,8 +266,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://twitter.com/jesse_squires" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2017-12-31)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://twitter.com/jesse_squires" target="_blank" rel="external">Jesse Squires</a>. All rights reserved. (Last updated: 2018-11-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit e52c324

Please sign in to comment.