Skip to content

Commit

Permalink
Documentation update [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
@SwiftDevOps
SwiftDevOps committed Jun 11, 2018
1 parent 7e991d0 commit 6e6e2ca
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/Classes.html
View file
Expand Up @@ -125,7 +125,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/Log.html
View file
Expand Up @@ -807,7 +807,7 @@ <h4>Return Value</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums.html
View file
Expand Up @@ -127,7 +127,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Enums/LoggerMessageType.html
View file
Expand Up @@ -350,7 +350,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Protocols.html
View file
Expand Up @@ -126,7 +126,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Protocols/Logger.html
View file
Expand Up @@ -253,7 +253,7 @@ <h4>Return Value</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/Classes.html
View file
Expand Up @@ -125,7 +125,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/Classes/Log.html
View file
Expand Up @@ -807,7 +807,7 @@ <h4>Return Value</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/Enums.html
View file
Expand Up @@ -127,7 +127,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/Enums/LoggerMessageType.html
View file
Expand Up @@ -350,7 +350,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/Protocols.html
View file
Expand Up @@ -126,7 +126,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/Protocols/Logger.html
View file
Expand Up @@ -253,7 +253,7 @@ <h4>Return Value</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
22 changes: 5 additions & 17 deletions docs/docsets/LoggerAPI.docset/Contents/Resources/Documents/index.html
View file
Expand Up @@ -106,10 +106,7 @@ <h1 id='loggerapi' class='heading'>LoggerAPI</h1>

<p><a href="https://github.com/IBM-Swift/Kitura">Kitura</a> uses this API throughout its implementation when logging.</p>
<h2 id='usage' class='heading'>Usage</h2>

<ol>
<li><strong>Add dependencies</strong></li>
</ol>
<h4 id='add-dependencies' class='heading'>Add dependencies</h4>

<p>Add the <code>LoggerAPI</code> package to the dependencies within your application’s <code>Package.swift</code> file. Substitute <code>&quot;x.x.x&quot;</code> with the latest <code>LoggerAPI</code> <a href="https://github.com/IBM-Swift/LoggerAPI/releases">release</a>:</p>
<pre class="highlight swift"><code><span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/IBM-Swift/LoggerAPI.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"x.x.x"</span><span class="p">)</span>
Expand All @@ -118,25 +115,16 @@ <h2 id='usage' class='heading'>Usage</h2>
<p>Add <code>LoggerAPI</code> to your target&rsquo;s dependencies:</p>
<pre class="highlight swift"><code><span class="o">.</span><span class="nf">target</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"example"</span><span class="p">,</span> <span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span><span class="s">"LoggerAPI"</span><span class="p">]),</span>
</code></pre>

<ol>
<li><strong>Import package</strong></li>
</ol>
<h4 id='import-package' class='heading'>Import package</h4>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">LoggerAPI</span>
</code></pre>

<ol>
<li><strong>Log messages</strong></li>
</ol>
<h4 id='log-messages' class='heading'>Log messages</h4>

<p>Add log messages to your application:</p>
<pre class="highlight swift"><code><span class="kt">Log</span><span class="o">.</span><span class="nf">warning</span><span class="p">(</span><span class="s">"This is a warning."</span><span class="p">)</span>
<span class="kt">Log</span><span class="o">.</span><span class="nf">error</span><span class="p">(</span><span class="s">"This is an error."</span><span class="p">)</span>
</code></pre>

<ol>
<li><strong>Define a logger</strong></li>
</ol>
<h4 id='define-a-logger' class='heading'>Define a logger</h4>

<p>You need to define a <code>logger</code> in order to output these messages:</p>
<pre class="highlight swift"><code><span class="kt">Log</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="o">...</span>
Expand All @@ -161,7 +149,7 @@ <h2 id='license' class='heading'>License</h2>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
Binary file modified docs/docsets/LoggerAPI.tgz
View file
Binary file not shown.
22 changes: 5 additions & 17 deletions docs/index.html
View file
Expand Up @@ -106,10 +106,7 @@ <h1 id='loggerapi' class='heading'>LoggerAPI</h1>

<p><a href="https://github.com/IBM-Swift/Kitura">Kitura</a> uses this API throughout its implementation when logging.</p>
<h2 id='usage' class='heading'>Usage</h2>

<ol>
<li><strong>Add dependencies</strong></li>
</ol>
<h4 id='add-dependencies' class='heading'>Add dependencies</h4>

<p>Add the <code>LoggerAPI</code> package to the dependencies within your application’s <code>Package.swift</code> file. Substitute <code>&quot;x.x.x&quot;</code> with the latest <code>LoggerAPI</code> <a href="https://github.com/IBM-Swift/LoggerAPI/releases">release</a>:</p>
<pre class="highlight swift"><code><span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/IBM-Swift/LoggerAPI.git"</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="s">"x.x.x"</span><span class="p">)</span>
Expand All @@ -118,25 +115,16 @@ <h2 id='usage' class='heading'>Usage</h2>
<p>Add <code>LoggerAPI</code> to your target&rsquo;s dependencies:</p>
<pre class="highlight swift"><code><span class="o">.</span><span class="nf">target</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"example"</span><span class="p">,</span> <span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span><span class="s">"LoggerAPI"</span><span class="p">]),</span>
</code></pre>

<ol>
<li><strong>Import package</strong></li>
</ol>
<h4 id='import-package' class='heading'>Import package</h4>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">LoggerAPI</span>
</code></pre>

<ol>
<li><strong>Log messages</strong></li>
</ol>
<h4 id='log-messages' class='heading'>Log messages</h4>

<p>Add log messages to your application:</p>
<pre class="highlight swift"><code><span class="kt">Log</span><span class="o">.</span><span class="nf">warning</span><span class="p">(</span><span class="s">"This is a warning."</span><span class="p">)</span>
<span class="kt">Log</span><span class="o">.</span><span class="nf">error</span><span class="p">(</span><span class="s">"This is an error."</span><span class="p">)</span>
</code></pre>

<ol>
<li><strong>Define a logger</strong></li>
</ol>
<h4 id='define-a-logger' class='heading'>Define a logger</h4>

<p>You need to define a <code>logger</code> in order to output these messages:</p>
<pre class="highlight swift"><code><span class="kt">Log</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="o">...</span>
Expand All @@ -161,7 +149,7 @@ <h2 id='license' class='heading'>License</h2>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-04)</p>
<p>&copy; 2018 <a class="link" href="https://github.com/IBM-Swift/LoggerAPI" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down

0 comments on commit 6e6e2ca

Please sign in to comment.