Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@tomkowz
tomkowz committed Jul 15, 2015
1 parent ef6e843 commit 50c4b94
Show file tree
Hide file tree
Showing 74 changed files with 378 additions and 1,260 deletions.
9 changes: 3 additions & 6 deletions docs/framework/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,6 @@
<li class="nav-group-task">
<a href="Enums/StringsFileType.html">StringsFileType</a>
</li>
<li class="nav-group-task">
<a href="Enums/ValueType.html">ValueType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -208,7 +205,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parses inequality expression patterns. e.g. <code>ie:%d=5</code>.</p>
<p>Parses inequality expression patterns. e.g. <code>ie:x=5</code>.</p>

<a href="Classes/InequalityExpressionParser.html" class="slightly-smaller">See more</a>
</div>
Expand Down Expand Up @@ -240,7 +237,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parses inequality extended expressions. <code>iex:5&lt;%d&lt;10</code>.</p>
<p>Parses inequality extended expressions. <code>iex:5&lt;x&lt;10</code>.</p>

<a href="Classes/InequalityExtendedExpressionParser.html" class="slightly-smaller">See more</a>
</div>
Expand Down Expand Up @@ -521,7 +518,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="https://github.com/tomkowz/Swifternalization" target="_blank" rel="external">Tomasz Szulc</a>. All rights reserved. (Last updated: 2015-06-30)</p>
<p>&copy; 2015 <a class="link" href="https://github.com/tomkowz/Swifternalization" target="_blank" rel="external">Tomasz Szulc</a>. All rights reserved. (Last updated: 2015-07-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.2.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
5 changes: 1 addition & 4 deletions docs/framework/Classes/Expression.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@
<li class="nav-group-task">
<a href="../Enums/StringsFileType.html">StringsFileType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ValueType.html">ValueType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -555,7 +552,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="https://github.com/tomkowz/Swifternalization" target="_blank" rel="external">Tomasz Szulc</a>. All rights reserved. (Last updated: 2015-06-30)</p>
<p>&copy; 2015 <a class="link" href="https://github.com/tomkowz/Swifternalization" target="_blank" rel="external">Tomasz Szulc</a>. All rights reserved. (Last updated: 2015-07-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.2.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
126 changes: 13 additions & 113 deletions docs/framework/Classes/InequalityExpressionParser.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@
<li class="nav-group-task">
<a href="../Enums/StringsFileType.html">StringsFileType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ValueType.html">ValueType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -154,7 +151,7 @@
<section>
<section class="section">
<h1>InequalityExpressionParser</h1>
<p>Parses inequality expression patterns. e.g. <code>ie:%d=5</code>.</p>
<p>Parses inequality expression patterns. e.g. <code>ie:x=5</code>.</p>

</section>
<section class="section task-group-section">
Expand Down Expand Up @@ -266,38 +263,6 @@ <h4>Return Value</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC17Swifternalization26InequalityExpressionParserP33_9D005160C999803FBF7E317E0936910D9valueTypeFS0_FT_GSqOS_9ValueType_"></a>
<a name="//apple_ref/swift/Method/valueType()" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParserP33_9D005160C999803FBF7E317E0936910D9valueTypeFS0_FT_GSqOS_9ValueType_">valueType()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Get <code>ValueType</code>. Finds only <q>%d</q> - Int is only one supported for now.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">valueType</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">ValueType</span><span class="p">?</span></code></pre>

</div>
</div>
<div>
<h4>Return Value</h4>
<p><code>ValueType</code> or nil if value cannot be found.</p>

</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -333,9 +298,9 @@ <h4>Return Value</h4>
<li class="item">
<div>
<code>
<a name="/s:FC17Swifternalization26InequalityExpressionParserP33_9D005160C999803FBF7E317E0936910D5valueFS0_FT_GSqSi_"></a>
<a name="/s:FC17Swifternalization26InequalityExpressionParserP33_9D005160C999803FBF7E317E0936910D5valueFS0_FT_GSqSd_"></a>
<a name="//apple_ref/swift/Method/value()" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParserP33_9D005160C999803FBF7E317E0936910D5valueFS0_FT_GSqSi_">value()</a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParserP33_9D005160C999803FBF7E317E0936910D5valueFS0_FT_GSqSd_">value()</a>
</code>
</div>
<div class="height-container">
Expand All @@ -350,7 +315,7 @@ <h4>Return Value</h4>
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
<pre class="highlight"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Double</span><span class="p">?</span></code></pre>

</div>
</div>
Expand All @@ -376,9 +341,9 @@ <h3 class="section-name">Helpers</h3>
<li class="item">
<div>
<code>
<a name="/s:FC17Swifternalization26InequalityExpressionParser8getValueFS0_FTSS14failureMessageSS_GSqSi_"></a>
<a name="//apple_ref/swift/Method/getValue(_:failureMessage:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParser8getValueFS0_FTSS14failureMessageSS_GSqSi_">getValue(_:failureMessage:)</a>
<a name="/s:FC17Swifternalization26InequalityExpressionParser8getValueFS0_FTSS14failureMessageSS17capturingGroupIdxGSqSi__GSqSd_"></a>
<a name="//apple_ref/swift/Method/getValue(_:failureMessage:capturingGroupIdx:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParser8getValueFS0_FTSS14failureMessageSS17capturingGroupIdxGSqSi__GSqSd_">getValue(_:failureMessage:capturingGroupIdx:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -393,7 +358,7 @@ <h3 class="section-name">Helpers</h3>
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">getValue</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">failureMessage</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">getValue</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">failureMessage</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">capturingGroupIdx</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Double</span><span class="p">?</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -441,9 +406,9 @@ <h4>Return Value</h4>
<li class="item">
<div>
<code>
<a name="/s:FC17Swifternalization26InequalityExpressionParser7getSignFS0_FTSS14failureMessageSS_GSqOS_14InequalitySign_"></a>
<a name="//apple_ref/swift/Method/getSign(_:failureMessage:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParser7getSignFS0_FTSS14failureMessageSS_GSqOS_14InequalitySign_">getSign(_:failureMessage:)</a>
<a name="/s:FC17Swifternalization26InequalityExpressionParser7getSignFS0_FTSS14failureMessageSS17capturingGroupIdxGSqSi__GSqOS_14InequalitySign_"></a>
<a name="//apple_ref/swift/Method/getSign(_:failureMessage:capturingGroupIdx:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParser7getSignFS0_FTSS14failureMessageSS17capturingGroupIdxGSqSi__GSqOS_14InequalitySign_">getSign(_:failureMessage:capturingGroupIdx:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -458,7 +423,7 @@ <h4>Return Value</h4>
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">getSign</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">failureMessage</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">InequalitySign</span><span class="p">?</span></code></pre>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">getSign</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">failureMessage</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">capturingGroupIdx</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">InequalitySign</span><span class="p">?</span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -503,77 +468,12 @@ <h4>Return Value</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC17Swifternalization26InequalityExpressionParser12getValueTypeFS0_FTSS14failureMessageSS_GSqOS_9ValueType_"></a>
<a name="//apple_ref/swift/Method/getValueType(_:failureMessage:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC17Swifternalization26InequalityExpressionParser12getValueTypeFS0_FTSS14failureMessageSS_GSqOS_9ValueType_">getValueType(_:failureMessage:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Get value type with regex and prints failure message if not found.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">getValueType</span><span class="p">(</span><span class="nv">regex</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">failureMessage</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">ValueType</span><span class="p">?</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>regex</em>
</code>
</td>
<td>
<div>
<p>A regular expression.</p>

</div>
</td>
</tr>
<tr>
<td>
<code>
<em>failureMessage</em>
</code>
</td>
<td>
<div>
<p>A message that is printed out in console on failure.</p>

</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A value type or nil if value cannot be found.</p>

</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="https://github.com/tomkowz/Swifternalization" target="_blank" rel="external">Tomasz Szulc</a>. All rights reserved. (Last updated: 2015-06-30)</p>
<p>&copy; 2015 <a class="link" href="https://github.com/tomkowz/Swifternalization" target="_blank" rel="external">Tomasz Szulc</a>. All rights reserved. (Last updated: 2015-07-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.2.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 50c4b94

Please sign in to comment.