Skip to content

Commit

Permalink
Bump version to 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@onevcat
onevcat committed Jan 13, 2017
1 parent c8e1431 commit 6154357
Show file tree
Hide file tree
Showing 41 changed files with 5,447 additions and 1,659 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Change Log

## [Unreleased]

## [1.0.0] - 2017-01-13
### Added
- Documentation and product ready release.

Expand Down
24 changes: 22 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Hedwig Docs</a> (5% documented)</p>
<p><a href="index.html">Hedwig Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/onevcat/Hedwig"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fonevcat%2Egithub%2Eio%2FHedwig%2Fdocsets%2FHedwig%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
</div>
Expand Down Expand Up @@ -85,6 +85,14 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Typealiases.html#/s:6Hedwig4Port">Port</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
Expand All @@ -110,10 +118,22 @@ <h1>Classes</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Represents an remote SMTP. Do not use this type directly. Use <code><a href="Structs/Hedwig.html">Hedwig</a></code> to
send mails instead.</p>

<a href="Classes/SMTP.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">class</span> <span class="kt">SMTP</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L47-L111">Show on GitHub</a>
</div>
</section>
</div>
</li>
Expand Down
78 changes: 72 additions & 6 deletions docs/Classes/SMTP.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="SMTP Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Hedwig Docs</a> (5% documented)</p>
<p><a href="../index.html">Hedwig Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/onevcat/Hedwig"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fonevcat%2Egithub%2Eio%2FHedwig%2Fdocsets%2FHedwig%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
</div>
Expand Down Expand Up @@ -86,13 +86,28 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Typealiases.html#/s:6Hedwig4Port">Port</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>SMTP</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SMTP</span></code></pre>

</div>
</div>
<p>Represents an remote SMTP. Do not use this type directly. Use <code><a href="../Structs/Hedwig.html">Hedwig</a></code> to
send mails instead.</p>

</section>
<section class="section task-group-section">
Expand All @@ -111,10 +126,21 @@ <h1>SMTP</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Represents SMTP validation methods.</p>

<a href="../Classes/SMTP/Validation.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">struct</span> <span class="kt">Validation</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L116-L149">Show on GitHub</a>
</div>
</section>
</div>
</li>
Expand All @@ -135,10 +161,21 @@ <h1>SMTP</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Error while SMTP connecting and communicating.</p>

<a href="../Classes/SMTP/SMTPError.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">SMTPError</span><span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L155-L208">Show on GitHub</a>
</div>
</section>
</div>
</li>
Expand All @@ -159,10 +196,21 @@ <h1>SMTP</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Secrity layer used when connencting an SMTP server.</p>

<a href="../Classes/SMTP/Secure.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">Secure</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L213-L230">Show on GitHub</a>
</div>
</section>
</div>
</li>
Expand All @@ -183,10 +231,28 @@ <h1>SMTP</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Auth method to an SMTP server.</p>

<ul>
<li>plain: Plain authorization.</li>
<li>cramMD5: CRAM-MD5 authorization.</li>
<li>login: Login authorization.</li>
<li>xOauth2: xOauth2 authorization.</li>
</ul>

<a href="../Classes/SMTP/AuthMethod.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">AuthMethod</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L248-L257">Show on GitHub</a>
</div>
</section>
</div>
</li>
Expand Down
77 changes: 71 additions & 6 deletions docs/Classes/SMTP/AuthMethod.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="AuthMethod Enum Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Hedwig Docs</a> (5% documented)</p>
<p><a href="../../index.html">Hedwig Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/onevcat/Hedwig"><img src="../../img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fonevcat%2Egithub%2Eio%2FHedwig%2Fdocsets%2FHedwig%2Exml"><img src="../../img/dash.png"/>Install in Dash</a></p>
</div>
Expand Down Expand Up @@ -86,13 +86,34 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Typealiases.html">Typealiases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Typealiases.html#/s:6Hedwig4Port">Port</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>AuthMethod</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AuthMethod</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
<p>Auth method to an SMTP server.</p>

<ul>
<li>plain: Plain authorization.</li>
<li>cramMD5: CRAM-MD5 authorization.</li>
<li>login: Login authorization.</li>
<li>xOauth2: xOauth2 authorization.</li>
</ul>

</section>
<section class="section task-group-section">
Expand All @@ -111,8 +132,19 @@ <h1>AuthMethod</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Plain authorization.</p>

</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="n">plain</span> <span class="o">=</span> <span class="s">"PLAIN"</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L250">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -134,8 +166,19 @@ <h1>AuthMethod</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>CRAM-MD5 authorization.</p>

</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="n">cramMD5</span> <span class="o">=</span> <span class="s">"CRAM-MD5"</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L252">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -157,8 +200,19 @@ <h1>AuthMethod</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Login authorization.</p>

</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="n">login</span> <span class="o">=</span> <span class="s">"LOGIN"</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L254">Show on GitHub</a>
</div>
</section>
</div>
Expand All @@ -180,9 +234,20 @@ <h1>AuthMethod</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>xOauth2 authorization.</p>

</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="n">xOauth2</span> <span class="o">=</span> <span class="s">"XOAUTH2"</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/onevcat/Hedwig/tree/1.0.0/Sources/SMTP.swift#L256">Show on GitHub</a>
</div>
</section>
</div>
</li>
Expand Down
Loading

0 comments on commit 6154357

Please sign in to comment.