Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@SwiftStudies
SwiftStudies committed Feb 4, 2018
1 parent 2bb2f02 commit 759594b
Show file tree
Hide file tree
Showing 188 changed files with 2,946 additions and 1,708 deletions.
22 changes: 11 additions & 11 deletions Documentation/OysterKit/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,6 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/BackgroundTimer.html">BackgroundTimer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/GrammarError.html">GrammarError</a>
</li>
Expand All @@ -146,6 +143,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/ScannerRule.html">ScannerRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/TransientToken.html">TransientToken</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -163,9 +163,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Decodable.html">Decodable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Int.html">Int</a>
</li>
Expand All @@ -189,6 +186,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -244,6 +244,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/HomogenousTree.html">HomogenousTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/LabelledToken.html">LabelledToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ParsingDecoder.html">ParsingDecoder</a>
</li>
Expand All @@ -255,9 +258,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
</li>
Expand Down Expand Up @@ -887,7 +887,7 @@ <h4>Declaration</h4>
<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">class</span> <span class="kt">RecursiveRule</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Rule.html">Rule</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">RecursiveRule</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Rule.html">Rule</a></span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>

</div>
</div>
Expand All @@ -902,7 +902,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-01-31)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</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
41 changes: 22 additions & 19 deletions Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,6 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/BackgroundTimer.html">BackgroundTimer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/GrammarError.html">GrammarError</a>
</li>
Expand All @@ -147,6 +144,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/ScannerRule.html">ScannerRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Enums/TransientToken.html">TransientToken</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -164,9 +164,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Decodable.html">Decodable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions/Int.html">Int</a>
</li>
Expand All @@ -190,6 +187,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -245,6 +245,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/HomogenousTree.html">HomogenousTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/LabelledToken.html">LabelledToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ParsingDecoder.html">ParsingDecoder</a>
</li>
Expand All @@ -256,9 +259,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
</li>
Expand Down Expand Up @@ -765,17 +765,18 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:9OysterKit26IntermediateRepresentationP11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchJ0tF"></a>
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchL0tF"></a>
<a name="//apple_ref/swift/Method/didEvaluate(rule:matchResult:)" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit26IntermediateRepresentationP11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchJ0tF">didEvaluate(rule:matchResult:)</a>
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchL0tF">didEvaluate(rule:matchResult:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<p>Processes the results of evaluation</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
Expand All @@ -791,17 +792,18 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:9OysterKit26IntermediateRepresentationP8didBuildyyF"></a>
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC8didBuildyyF"></a>
<a name="//apple_ref/swift/Method/didBuild()" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit26IntermediateRepresentationP8didBuildyyF">didBuild()</a>
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC8didBuildyyF">didBuild()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<p>Does nothing</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
Expand All @@ -817,17 +819,18 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:9OysterKit26IntermediateRepresentationP10resetStateyyF"></a>
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC10resetStateyyF"></a>
<a name="//apple_ref/swift/Method/resetState()" class="dashAnchor"></a>
<a class="token" href="#/s:9OysterKit26IntermediateRepresentationP10resetStateyyF">resetState()</a>
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC10resetStateyyF">resetState()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

<p>Does nothing</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
Expand Down Expand Up @@ -1029,7 +1032,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-01-31)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</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
20 changes: 10 additions & 10 deletions Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor/ConstructionError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,6 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/BackgroundTimer.html">BackgroundTimer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/GrammarError.html">GrammarError</a>
</li>
Expand All @@ -147,6 +144,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/ScannerRule.html">ScannerRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/TransientToken.html">TransientToken</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -164,9 +164,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Decodable.html">Decodable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Int.html">Int</a>
</li>
Expand All @@ -190,6 +187,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -245,6 +245,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/HomogenousTree.html">HomogenousTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/LabelledToken.html">LabelledToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ParsingDecoder.html">ParsingDecoder</a>
</li>
Expand All @@ -256,9 +259,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
</li>
Expand Down Expand Up @@ -387,7 +387,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-01-31)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</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
20 changes: 10 additions & 10 deletions ...ation/OysterKit/Classes/AbstractSyntaxTreeConstructor/IntermediateRepresentationNode.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,6 @@
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/BackgroundTimer.html">BackgroundTimer</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/GrammarError.html">GrammarError</a>
</li>
Expand All @@ -147,6 +144,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/ScannerRule.html">ScannerRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Enums/TransientToken.html">TransientToken</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -164,9 +164,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Decodable.html">Decodable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Int.html">Int</a>
</li>
Expand All @@ -190,6 +187,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -245,6 +245,9 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/HomogenousTree.html">HomogenousTree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/LabelledToken.html">LabelledToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Structs/ParsingDecoder.html">ParsingDecoder</a>
</li>
Expand All @@ -256,9 +259,6 @@
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
</li>
Expand Down Expand Up @@ -468,7 +468,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-01-31)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</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
Loading

0 comments on commit 759594b

Please sign in to comment.