update documentation for new entity

emaloney · Jan 9, 2017 · eeb70f5 · eeb70f5
1 parent 508aca3
commit eeb70f5
Show file tree

Hide file tree

Showing 7 changed files with 155 additions and 15 deletions.
diff --git a/Documentation/API/Enums/OSLogTypeTranslator.html b/Documentation/API/Enums/OSLogTypeTranslator.html
@@ -226,6 +226,69 @@ <h1>OSLogTypeTranslator</h1>
 
           </section>
           <section class="section task-group-section">
+            <div class="task-group">
+              <ul>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_"></a>
+                    <a name="//apple_ref/swift/Element/default" class="dashAnchor"></a>
+                    <a class="token" href="#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">default</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>The most direct translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&rsquo;s <code>severity</code> to the
+ corresponding <code>OSLogType</code> value.</p>
+
+<p>This value strikes a sensible balance between the higher-overhead logging
+ provided by <code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator6strictFMS0_S0_">.strict</a></code> and the more ephemeral logging of <code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7relaxedFMS0_S0_">.relaxed</a></code>.</p>
+
+<table><thead>
+<tr>
+<th>LogSeverity</th>
+<th>OSLogType</th>
+</tr>
+</thead><tbody>
+<tr>
+<td><code>.verbose</code></td>
+<td><code>.debug</code></td>
+</tr>
+<tr>
+<td><code>.debug</code></td>
+<td><code>.debug</code></td>
+</tr>
+<tr>
+<td><code>.info</code></td>
+<td><code>.info</code></td>
+</tr>
+<tr>
+<td><code>.warning</code></td>
+<td><code>.default</code></td>
+</tr>
+<tr>
+<td><code>.error</code></td>
+<td><code>.error</code></td>
+</tr>
+</tbody></table>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="k">case</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
             <div class="task-group">
               <ul>
                 <li class="item">
@@ -242,7 +305,11 @@ <h1>OSLogTypeTranslator</h1>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>A strict translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&rsquo;s <code>severity</code> to an
- <code>OSLogType</code> value. Warnings are treated as errors.</p>
+ <code>OSLogType</code> value. Warnings are treated as errors; errors are
+ treated as faults.</p>
+
+<p>This will result in additional logging overhead being recorded by OSLog,
+ and is not recommended unless you have a specific need for this.</p>
 
 <table><thead>
 <tr>
@@ -260,7 +327,7 @@ <h1>OSLogTypeTranslator</h1>
 </tr>
 <tr>
 <td><code>.info</code></td>
-<td><code>.default</code></td>
+<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">.default</a></code></td>
 </tr>
 <tr>
 <td><code>.warning</code></td>
@@ -302,7 +369,10 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>A relaxed translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&rsquo;s <code>severity</code> to an
- <code>OSLogType</code> value. Warnings are treated as informational log messages.</p>
+ <code>OSLogType</code> value. Nothing is treated as an error.</p>
+
+<p>This results in low-overhead logging, but log entries are more
+ ephemeral and may not contain as much OSLog metadata.</p>
 
 <table><thead>
 <tr>
@@ -320,15 +390,15 @@ <h4>Declaration</h4>
 </tr>
 <tr>
 <td><code>.info</code></td>
-<td><code>.default</code></td>
+<td><code>.info</code></td>
 </tr>
 <tr>
 <td><code>.warning</code></td>
-<td><code>.default</code></td>
+<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">.default</a></code></td>
 </tr>
 <tr>
 <td><code>.error</code></td>
-<td><code>.error</code></td>
+<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">.default</a></code></td>
 </tr>
 </tbody></table>
 

diff --git a/Documentation/API/Structs/OSLogRecorder.html b/Documentation/API/Structs/OSLogRecorder.html
@@ -389,7 +389,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="nf">init</span><span class="p">?(</span><span class="nv">formatters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/LogFormatter.html">LogFormatter</a></span><span class="p">],</span> <span class="nv">subsystem</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">""</span><span class="p">,</span> <span class="nv">logTypeTranslator</span><span class="p">:</span> <span class="kt"><a href="../Enums/OSLogTypeTranslator.html">OSLogTypeTranslator</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">strict</span><span class="p">,</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">formatters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/LogFormatter.html">LogFormatter</a></span><span class="p">],</span> <span class="nv">subsystem</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">""</span><span class="p">,</span> <span class="nv">logTypeTranslator</span><span class="p">:</span> <span class="kt"><a href="../Enums/OSLogTypeTranslator.html">OSLogTypeTranslator</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>

diff --git a/...ocsets/CleanroomLogger.docset/Contents/Resources/Documents/Enums/OSLogTypeTranslator.html b/...ocsets/CleanroomLogger.docset/Contents/Resources/Documents/Enums/OSLogTypeTranslator.html
@@ -226,6 +226,69 @@ <h1>OSLogTypeTranslator</h1>
 
           </section>
           <section class="section task-group-section">
+            <div class="task-group">
+              <ul>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_"></a>
+                    <a name="//apple_ref/swift/Element/default" class="dashAnchor"></a>
+                    <a class="token" href="#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">default</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>The most direct translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&rsquo;s <code>severity</code> to the
+ corresponding <code>OSLogType</code> value.</p>
+
+<p>This value strikes a sensible balance between the higher-overhead logging
+ provided by <code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator6strictFMS0_S0_">.strict</a></code> and the more ephemeral logging of <code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7relaxedFMS0_S0_">.relaxed</a></code>.</p>
+
+<table><thead>
+<tr>
+<th>LogSeverity</th>
+<th>OSLogType</th>
+</tr>
+</thead><tbody>
+<tr>
+<td><code>.verbose</code></td>
+<td><code>.debug</code></td>
+</tr>
+<tr>
+<td><code>.debug</code></td>
+<td><code>.debug</code></td>
+</tr>
+<tr>
+<td><code>.info</code></td>
+<td><code>.info</code></td>
+</tr>
+<tr>
+<td><code>.warning</code></td>
+<td><code>.default</code></td>
+</tr>
+<tr>
+<td><code>.error</code></td>
+<td><code>.error</code></td>
+</tr>
+</tbody></table>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight"><code><span class="k">case</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
             <div class="task-group">
               <ul>
                 <li class="item">
@@ -242,7 +305,11 @@ <h1>OSLogTypeTranslator</h1>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>A strict translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&rsquo;s <code>severity</code> to an
- <code>OSLogType</code> value. Warnings are treated as errors.</p>
+ <code>OSLogType</code> value. Warnings are treated as errors; errors are
+ treated as faults.</p>
+
+<p>This will result in additional logging overhead being recorded by OSLog,
+ and is not recommended unless you have a specific need for this.</p>
 
 <table><thead>
 <tr>
@@ -260,7 +327,7 @@ <h1>OSLogTypeTranslator</h1>
 </tr>
 <tr>
 <td><code>.info</code></td>
-<td><code>.default</code></td>
+<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">.default</a></code></td>
 </tr>
 <tr>
 <td><code>.warning</code></td>
@@ -302,7 +369,10 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>A relaxed translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&rsquo;s <code>severity</code> to an
- <code>OSLogType</code> value. Warnings are treated as informational log messages.</p>
+ <code>OSLogType</code> value. Nothing is treated as an error.</p>
+
+<p>This results in low-overhead logging, but log entries are more
+ ephemeral and may not contain as much OSLog metadata.</p>
 
 <table><thead>
 <tr>
@@ -320,15 +390,15 @@ <h4>Declaration</h4>
 </tr>
 <tr>
 <td><code>.info</code></td>
-<td><code>.default</code></td>
+<td><code>.info</code></td>
 </tr>
 <tr>
 <td><code>.warning</code></td>
-<td><code>.default</code></td>
+<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">.default</a></code></td>
 </tr>
 <tr>
 <td><code>.error</code></td>
-<td><code>.error</code></td>
+<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:FO15CleanroomLogger19OSLogTypeTranslator7defaultFMS0_S0_">.default</a></code></td>
 </tr>
 </tbody></table>
 

diff --git a/...PI/docsets/CleanroomLogger.docset/Contents/Resources/Documents/Structs/OSLogRecorder.html b/...PI/docsets/CleanroomLogger.docset/Contents/Resources/Documents/Structs/OSLogRecorder.html
@@ -389,7 +389,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="nf">init</span><span class="p">?(</span><span class="nv">formatters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/LogFormatter.html">LogFormatter</a></span><span class="p">],</span> <span class="nv">subsystem</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">""</span><span class="p">,</span> <span class="nv">logTypeTranslator</span><span class="p">:</span> <span class="kt"><a href="../Enums/OSLogTypeTranslator.html">OSLogTypeTranslator</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">strict</span><span class="p">,</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">formatters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/LogFormatter.html">LogFormatter</a></span><span class="p">],</span> <span class="nv">subsystem</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">""</span><span class="p">,</span> <span class="nv">logTypeTranslator</span><span class="p">:</span> <span class="kt"><a href="../Enums/OSLogTypeTranslator.html">OSLogTypeTranslator</a></span> <span class="o">=</span> <span class="o">.</span><span class="k">default</span><span class="p">,</span> <span class="nv">queue</span><span class="p">:</span> <span class="kt">DispatchQueue</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>

diff --git a/...ntation/API/docsets/CleanroomLogger.docset/Contents/Resources/Documents/undocumented.json b/...ntation/API/docsets/CleanroomLogger.docset/Contents/Resources/Documents/undocumented.json
@@ -2,5 +2,5 @@
   "warnings": [
 
   ],
-  "source_directory": "/Users/emaloney/Documents/Code/managed/CleanroomLogger"
+  "source_directory": "/Users/emaloney/Documents/Code/client/gilt-ios/Carthage/Checkouts/CleanroomLogger"
 }
diff --git a/Documentation/API/docsets/CleanroomLogger.docset/Contents/Resources/docSet.dsidx b/Documentation/API/docsets/CleanroomLogger.docset/Contents/Resources/docSet.dsidx
diff --git a/Documentation/API/docsets/CleanroomLogger.tgz b/Documentation/API/docsets/CleanroomLogger.tgz