Skip to content

Commit

Permalink
Fixes #27
Browse files Browse the repository at this point in the history 
Completes the extension with full API documenation and some refactoring to make the whole thing more coherent.
  • Loading branch information
@SwiftStudies
SwiftStudies committed Jul 17, 2018
1 parent 293a0a3 commit e383491
Show file tree
Hide file tree
Showing 181 changed files with 12,413 additions and 272 deletions.
55 changes: 53 additions & 2 deletions Documentation/OysterKit/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
OysterKit Docs
</a>
(94% documented)
(95% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -56,6 +56,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/AbstractSyntaxTreeConstructor/IntermediateRepresentationNode.html">– IntermediateRepresentationNode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/ClosureRule.html">ClosureRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/Lexer.html">Lexer</a>
</li>
Expand Down Expand Up @@ -168,6 +171,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AbstractSyntaxTree.html">AbstractSyntaxTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/BehaviouralRule.html">BehaviouralRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DecodeableAbstractSyntaxTree.html">DecodeableAbstractSyntaxTree</a>
</li>
Expand Down Expand Up @@ -200,6 +206,15 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Behaviour.html">Behaviour</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Behaviour/Kind.html">– Kind</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Cardinality.html">Cardinality</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/HomogenousTree.html">HomogenousTree</a>
</li>
Expand All @@ -223,6 +238,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit13StreamedTokena">StreamedToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit4Testa">Test</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -539,6 +557,39 @@ <h4>Declaration</h4>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9OysterKit11ClosureRuleC"></a>
<a name="//apple_ref/swift/Class/ClosureRule" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit11ClosureRuleC">ClosureRule</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An implementation of a <code><a href="Protocols/BehaviouralRule.html">BehaviouralRule</a></code> that allows the specification of a <code><a href="Typealiases.html#/s:9OysterKit4Testa">Test</a></code>
closure to provide the required check.</p>

<a href="Classes/ClosureRule.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 swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">ClosureRule</span> <span class="p">:</span> <span class="kt"><a href="Protocols/BehaviouralRule.html">BehaviouralRule</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
Expand Down Expand Up @@ -577,7 +628,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-07-14)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-07-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
103 changes: 101 additions & 2 deletions Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
OysterKit Docs
</a>
(94% documented)
(95% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -56,6 +56,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/AbstractSyntaxTreeConstructor/IntermediateRepresentationNode.html">– IntermediateRepresentationNode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ClosureRule.html">ClosureRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/Lexer.html">Lexer</a>
</li>
Expand Down Expand Up @@ -168,6 +171,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/AbstractSyntaxTree.html">AbstractSyntaxTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/BehaviouralRule.html">BehaviouralRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/DecodeableAbstractSyntaxTree.html">DecodeableAbstractSyntaxTree</a>
</li>
Expand Down Expand Up @@ -200,6 +206,15 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Behaviour.html">Behaviour</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Behaviour/Kind.html">– Kind</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Cardinality.html">Cardinality</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/HomogenousTree.html">HomogenousTree</a>
</li>
Expand All @@ -223,6 +238,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit13StreamedTokena">StreamedToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit4Testa">Test</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -360,6 +378,33 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC4withACSS_tcfc"></a>
<a name="//apple_ref/swift/Method/init(with:)" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC4withACSS_tcfc">init(with:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Used for testing, creates a new blank instance for manipulation</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">with</span> <span class="nv">source</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -748,6 +793,60 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC12willEvaluate5token2atAA11MatchResultOSgAA5Token_p_SS5IndexVtF"></a>
<a name="//apple_ref/swift/Method/willEvaluate(token:at:)" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC12willEvaluate5token2atAA11MatchResultOSgAA5Token_p_SS5IndexVtF">willEvaluate(token:at:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Prepare for evaluation</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">willEvaluate</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Token.html">Token</a></span><span class="p">,</span> <span class="n">at</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">String</span><span class="o">.</span><span class="kt">UnicodeScalarView</span><span class="o">.</span><span class="kt">Index</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Enums/MatchResult.html">MatchResult</a></span><span class="p">?</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC11didEvaluate5token11annotations11matchResultyAA5Token_p_SDyAA14RuleAnnotationOAA0nO5ValueOGAA05MatchL0OtF"></a>
<a name="//apple_ref/swift/Method/didEvaluate(token:annotations:matchResult:)" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC11didEvaluate5token11annotations11matchResultyAA5Token_p_SDyAA14RuleAnnotationOAA0nO5ValueOGAA05MatchL0OtF">didEvaluate(token:annotations:matchResult:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Process the results of evalution</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">didEvaluate</span><span class="p">(</span><span class="nv">token</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Token.html">Token</a></span><span class="p">,</span> <span class="nv">annotations</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a></span><span class="p">,</span> <span class="nv">matchResult</span><span class="p">:</span> <span class="kt"><a href="../Enums/MatchResult.html">MatchResult</a></span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -1018,7 +1117,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-07-14)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-07-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
22 changes: 20 additions & 2 deletions Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor/ConstructionError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<a class="header-link" href="../../index.html">
OysterKit Docs
</a>
(94% documented)
(95% documented)
</p>

<p class="header-col--secondary">
Expand Down Expand Up @@ -56,6 +56,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/AbstractSyntaxTreeConstructor/IntermediateRepresentationNode.html">– IntermediateRepresentationNode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/ClosureRule.html">ClosureRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Lexer.html">Lexer</a>
</li>
Expand Down Expand Up @@ -168,6 +171,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/AbstractSyntaxTree.html">AbstractSyntaxTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/BehaviouralRule.html">BehaviouralRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/DecodeableAbstractSyntaxTree.html">DecodeableAbstractSyntaxTree</a>
</li>
Expand Down Expand Up @@ -200,6 +206,15 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/Behaviour.html">Behaviour</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/Behaviour/Kind.html">– Kind</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/Cardinality.html">Cardinality</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/HomogenousTree.html">HomogenousTree</a>
</li>
Expand All @@ -223,6 +238,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit13StreamedTokena">StreamedToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit4Testa">Test</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -337,7 +355,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-07-14)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-07-17)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
Loading

0 comments on commit e383491

Please sign in to comment.