Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnfairh committed Sep 26, 2019
1 parent 3898214 commit 711bdee
Show file tree
Hide file tree
Showing 32 changed files with 219 additions and 193 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ All migrations happen as part of `NSPersistentContainer.loadPersistentStores`.

## Requirements

Swift 5, Xcode 10.2
Swift 5 or later, Xcode 10.2 or later.
* See the *swift31* branch for a Swift 31 version.
* See the *swift4* branch for a Swift 4 version.
* See the *swift41* branch for a Swift 4.1 version.
Expand Down
14 changes: 7 additions & 7 deletions docs/Classes/PersistentContainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Main APIs.html">Main APIs</a>
<a class="nav-group-name-link" href="../Main%20APIs.html">Main APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PersistentContainer.html">PersistentContainer</a>
Expand All @@ -79,7 +79,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Logging APIs.html">Logging APIs</a>
<a class="nav-group-name-link" href="../Logging%20APIs.html">Logging APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/LogMessage.html">LogMessage</a>
Expand All @@ -94,11 +94,11 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>PersistentContainer</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">@available(OSX 10.12, iOS 10.0, tvOS 10.0, watchOS 3.0, *)</span>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="kt">OSX</span> <span class="mf">10.12</span><span class="p">,</span> <span class="n">iOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">tvOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">watchOS</span> <span class="mf">3.0</span><span class="p">,</span> <span class="o">*</span><span class="p">)</span>
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">PersistentContainer</span> <span class="p">:</span> <span class="kt"><a href="https://developer.apple.com/documentation/coredata/nspersistentcontainer/">NSPersistentContainer</a></span><span class="p">,</span> <span class="kt">LogMessageEmitter</span></code></pre>

</div>
Expand Down Expand Up @@ -452,7 +452,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">loadPersistentStores</span><span class="p">(</span><span class="n">completionHandler</span> <span class="nv">block</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="https://developer.apple.com/documentation/coredata/nspersistentstoredescription/">NSPersistentStoreDescription</a></span><span class="p">,</span> <span class="kt"><a href="https://developer.apple.com/documentation/applemusicapi/error/">Error</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())</span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">override</span> <span class="kd">func</span> <span class="nf">loadPersistentStores</span><span class="p">(</span><span class="n">completionHandler</span> <span class="nv">block</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="https://developer.apple.com/documentation/coredata/nspersistentstoredescription/">NSPersistentStoreDescription</a></span><span class="p">,</span> <span class="kt"><a href="https://developer.apple.com/documentation/accelerate/quadrature/error/">Error</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())</span></code></pre>

</div>
</div>
Expand All @@ -469,7 +469,7 @@ <h4>Parameters</h4>
<td>
<div>
<p>Callback made on the main queue for each store when it has either been loaded successfully
or failed to load. The <code><a href="https://developer.apple.com/documentation/applemusicapi/error/">Error</a></code> here can be anything provided by
or failed to load. The <code><a href="https://developer.apple.com/documentation/accelerate/quadrature/error/">Error</a></code> here can be anything provided by
<code>NSPersistentContainer.loadPersistentStores</code> as well as anything from <code><a href="../Enums/MigrationError.html">MigrationError</a></code>
in this package.</p>
</div>
Expand All @@ -493,7 +493,7 @@ <h4>Parameters</h4>
</div>
<section class="footer">
<p>Distributed under the ISC license. Maintained by John Fairhurst.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/Enums/LogLevel.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Main APIs.html">Main APIs</a>
<a class="nav-group-name-link" href="../Main%20APIs.html">Main APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PersistentContainer.html">PersistentContainer</a>
Expand All @@ -79,7 +79,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Logging APIs.html">Logging APIs</a>
<a class="nav-group-name-link" href="../Logging%20APIs.html">Logging APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/LogMessage.html">LogMessage</a>
Expand All @@ -94,7 +94,7 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>LogLevel</h1>
<div class="declaration">
<div class="language">
Expand All @@ -103,7 +103,7 @@ <h1>LogLevel</h1>
</div>
</div>
<p>The category of message being logged, in descending order of importance.
Clients should normally be interested in recording <code><a href="https://developer.apple.com/documentation/applemusicapi/error/">error</a></code> and <code>warning</code> and
Clients should normally be interested in recording <code><a href="https://developer.apple.com/documentation/accelerate/quadrature/error/">error</a></code> and <code>warning</code> and
may also be interested in <code><a href="https://developer.apple.com/documentation/tvml/information_elements/info/">info</a></code>.</p>

</div>
Expand Down Expand Up @@ -135,7 +135,7 @@ <h1>LogLevel</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n"><a href="https://developer.apple.com/documentation/applemusicapi/error/">error</a></span></code></pre>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n"><a href="https://developer.apple.com/documentation/accelerate/quadrature/error/">error</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -252,7 +252,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Distributed under the ISC license. Maintained by John Fairhurst.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
18 changes: 8 additions & 10 deletions docs/Enums/MigrationError.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Main APIs.html">Main APIs</a>
<a class="nav-group-name-link" href="../Main%20APIs.html">Main APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PersistentContainer.html">PersistentContainer</a>
Expand All @@ -79,7 +79,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Logging APIs.html">Logging APIs</a>
<a class="nav-group-name-link" href="../Logging%20APIs.html">Logging APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/LogMessage.html">LogMessage</a>
Expand All @@ -94,12 +94,14 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>MigrationError</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">@available(OSX 10.12, iOS 10.0, tvOS 10.0, watchOS 3.0, *)</span>
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MigrationError</span> <span class="p">:</span> <span class="kt"><a href="https://developer.apple.com/documentation/applemusicapi/error/">Error</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="kt">OSX</span> <span class="mf">10.12</span><span class="p">,</span> <span class="n">iOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">tvOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">watchOS</span> <span class="mf">3.0</span><span class="p">,</span> <span class="o">*</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">MigrationError</span> <span class="p">:</span> <span class="kt"><a href="https://developer.apple.com/documentation/accelerate/quadrature/error/">Error</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="kt">OSX</span> <span class="mf">10.12</span><span class="p">,</span> <span class="n">iOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">tvOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">watchOS</span> <span class="mf">3.0</span><span class="p">,</span> <span class="o">*</span><span class="p">)</span>
<span class="kd">extension</span> <span class="kt">MigrationError</span><span class="p">:</span> <span class="kt"><a href="https://developer.apple.com/documentation/swift/customstringconvertible/">CustomStringConvertible</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -426,10 +428,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -469,7 +467,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Distributed under the ISC license. Maintained by John Fairhurst.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
16 changes: 7 additions & 9 deletions docs/Enums/ModelVersionOrder.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Main APIs.html">Main APIs</a>
<a class="nav-group-name-link" href="../Main%20APIs.html">Main APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/PersistentContainer.html">PersistentContainer</a>
Expand All @@ -79,7 +79,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Logging APIs.html">Logging APIs</a>
<a class="nav-group-name-link" href="../Logging%20APIs.html">Logging APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/LogMessage.html">LogMessage</a>
Expand All @@ -94,12 +94,14 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>ModelVersionOrder</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">@available(OSX 10.12, iOS 10.0, tvOS 10.0, watchOS 3.0, *)</span>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="kt">OSX</span> <span class="mf">10.12</span><span class="p">,</span> <span class="n">iOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">tvOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">watchOS</span> <span class="mf">3.0</span><span class="p">,</span> <span class="o">*</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ModelVersionOrder</span></code></pre>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="kt">OSX</span> <span class="mf">10.12</span><span class="p">,</span> <span class="n">iOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">tvOS</span> <span class="mf">10.0</span><span class="p">,</span> <span class="n">watchOS</span> <span class="mf">3.0</span><span class="p">,</span> <span class="o">*</span><span class="p">)</span>
<span class="kd">extension</span> <span class="kt">ModelVersionOrder</span><span class="p">:</span> <span class="kt"><a href="https://developer.apple.com/documentation/swift/customstringconvertible/">CustomStringConvertible</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -305,10 +307,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -348,7 +346,7 @@ <h4>Declaration</h4>
</div>
<section class="footer">
<p>Distributed under the ISC license. Maintained by John Fairhurst.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
12 changes: 4 additions & 8 deletions docs/Guides.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Main APIs.html">Main APIs</a>
<a class="nav-group-name-link" href="Main%20APIs.html">Main APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/PersistentContainer.html">PersistentContainer</a>
Expand All @@ -79,7 +79,7 @@
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Logging APIs.html">Logging APIs</a>
<a class="nav-group-name-link" href="Logging%20APIs.html">Logging APIs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/LogMessage.html">LogMessage</a>
Expand All @@ -94,7 +94,7 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>Guides</h1>

</div>
Expand All @@ -113,10 +113,6 @@ <h1>Guides</h1>
</code>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand All @@ -135,7 +131,7 @@ <h1>Guides</h1>
</div>
<section class="footer">
<p>Distributed under the ISC license. Maintained by John Fairhurst.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>-<a class="link" href="https://github.com/johnfairh/jazzy" target="_blank" rel="external">bebop</a>, originally a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
Expand Down
Loading

0 comments on commit 711bdee

Please sign in to comment.