Update documentaiton for release.

tonystone · Sep 13, 2019 · db75fe3 · db75fe3
1 parent f0a4b8f
commit db75fe3
Show file tree

Hide file tree

Showing 85 changed files with 524 additions and 242 deletions.
diff --git a/docs/Classes/ConsoleWriter.html b/docs/Classes/ConsoleWriter.html
@@ -419,7 +419,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Classes/ConsoleWriter/Default.html b/docs/Classes/ConsoleWriter/Default.html
@@ -265,7 +265,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Classes/Environment.html b/docs/Classes/Environment.html
@@ -748,7 +748,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Classes/FileWriter.html b/docs/Classes/FileWriter.html
@@ -534,7 +534,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Classes/FileWriter/Default.html b/docs/Classes/FileWriter/Default.html
@@ -296,7 +296,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Classes/FileWriter/Strategy.html b/docs/Classes/FileWriter/Strategy.html
@@ -247,6 +247,14 @@ <h3 class="section-name">Strategies</h3>
  with this option, TraceLog will continue
  to append to the file name specified.</p>
 
+</div>
+<div class="aside aside-note">
+ <p class="aside-title">Note</p>
+ <p>On the iOS platform, this strategy will monitor protected data availability
+ and if you use the <code><a href="../../Enums/ConcurrencyMode.html#/s:8TraceLog15ConcurrencyModeO5async7optionsACShyAA05AsynccD6OptionOG_tFZ">ConcurrencyMode.async(options:)</a></code> mode with the
+ <code><a href="../../Enums/AsyncConcurrencyModeOption.html#/s:8TraceLog26AsyncConcurrencyModeOptionO6buffer13writeInterval8strategyAC8Dispatch0k4TimeI0O_AC14BufferStrategyOtFZ">AsyncConcurrencyModeOption.buffer(writeInterval:strategy:)</a></code> the FileWriter will
+ buffer when protected data is not available.</p>
+
 </div>
 <div class="aside aside-remark">
  <p class="aside-title">Remark</p>
@@ -425,7 +433,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Classes/FileWriter/Strategy/RotationOption.html b/docs/Classes/FileWriter/Strategy/RotationOption.html
@@ -281,7 +281,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Configuration.html b/docs/Configuration.html
@@ -520,7 +520,7 @@ <h4>Parameters</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/AsyncConcurrencyModeOption.html b/docs/Enums/AsyncConcurrencyModeOption.html
@@ -250,22 +250,25 @@ <h3 class="section-name">Available Options</h3>
  <div class="pointer"></div>
  <div class="abstract">
  <p>Back the async mode with a buffer for when the writer is not <code>available</code> to
- write to it&rsquo;s endpoint. Useful for situations where the endpoint may not
- be available at all times.</p>
+write to it&rsquo;s endpoint. Useful for situations where the endpoint may not
+be available at all times.</p>
 
 <p>Whenever the writer returns false for <code>available</code> TraceLog will buffer the
- log entries until the endpoint is <code>available</code>. It will check the writer for
- availability based on the <code>writeInterval</code> parameter. Once available, TraceLog
- will write each log entry in the buffer (in order) until the end of the
- buffer or the Writer becomes unavailable again.</p>
+log entries until the endpoint is <code>available</code>. It will check the writer for
+availability based on the <code>writeInterval</code> parameter. Once available, TraceLog
+will write each log entry in the buffer (in order) until the end of the
+buffer or the Writer becomes unavailable again.</p>
+<div class="aside aside-remark">
+ <p class="aside-title">Remark</p>
+ <p>Buffering is useful for many different use case including:</p>
 
-<p>Buffering is useful for many different use case including:</p>
+<p>In an iOS application when protected data is not available to your
+ app but you require visibility into the apps logging even during
+ these times.</p>
 
-<p>E.g. In an iOS application when protected data is not available to your
- app but you require visibility into the apps logging even during
-/ these times.</p>
-<pre class="highlight swift"><code> <span class="kt">A</span> <span class="n">network</span> <span class="n">writer</span> <span class="n">when</span> <span class="n">the</span> <span class="n">network</span> <span class="n">connection</span> <span class="k">is</span> <span class="n">unavailable</span> <span class="k">for</span> <span class="n">any</span> <span class="n">reason</span><span class="o">.</span>
-</code></pre>
+<p>A network writer when the network connection is unavailable for any reason.</p>
+
+</div>
 
  </div>
  <div class="declaration">
@@ -439,7 +442,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/AsyncConcurrencyModeOption/BufferStrategy.html b/docs/Enums/AsyncConcurrencyModeOption/BufferStrategy.html
@@ -367,7 +367,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/ConcurrencyMode.html b/docs/Enums/ConcurrencyMode.html
@@ -401,7 +401,7 @@ <h4>Parameters</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/FailureReason.html b/docs/Enums/FailureReason.html
@@ -312,7 +312,7 @@ <h4>Parameters</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/LogLevel.html b/docs/Enums/LogLevel.html
@@ -516,7 +516,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/OutputStreamFormatterError.html b/docs/Enums/OutputStreamFormatterError.html
@@ -254,7 +254,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Enums/WriterConcurrencyMode.html b/docs/Enums/WriterConcurrencyMode.html
@@ -375,7 +375,7 @@ <h4>Parameters</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Formatters.html b/docs/Formatters.html
@@ -495,7 +495,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Logging.html b/docs/Logging.html
@@ -558,7 +558,7 @@ <h4>Parameters</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Protocols/OutputStreamFormatter.html b/docs/Protocols/OutputStreamFormatter.html
@@ -340,7 +340,7 @@ <h4>Return Value</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Protocols/OutputStreamWriter.html b/docs/Protocols/OutputStreamWriter.html
@@ -278,7 +278,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>

diff --git a/docs/Protocols/RuntimeContext.html b/docs/Protocols/RuntimeContext.html
@@ -315,7 +315,7 @@ <h4>Declaration</h4>
  </div>
  <section class="footer">
  <p>© 2019 <a class="link" href="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/tonystone" target="_blank" rel="external">Tony Stone</a> under the <a class="link" href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank" rel="external">Apache License, Version 2.0</a>.</p>
- <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+ <p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  </section>
  </body>
 </div>