Skip to content

Commit 759594b

Browse files
SwiftStudiesSwiftStudies
committed
Updated documentation
1 parent 2bb2f02 commit 759594b

File tree

188 files changed

+2946
-1708
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+2946
-1708
lines changed

‎Documentation/OysterKit/Classes.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,6 @@
122122
<li class="nav-group-name">
123123
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
124124
<ul class="nav-group-tasks">
125-
<li class="nav-group-task">
126-
<a class="nav-group-task-link" href="Enums/BackgroundTimer.html">BackgroundTimer</a>
127-
</li>
128125
<li class="nav-group-task">
129126
<a class="nav-group-task-link" href="Enums/GrammarError.html">GrammarError</a>
130127
</li>
@@ -146,6 +143,9 @@
146143
<li class="nav-group-task">
147144
<a class="nav-group-task-link" href="Enums/ScannerRule.html">ScannerRule</a>
148145
</li>
146+
<li class="nav-group-task">
147+
<a class="nav-group-task-link" href="Enums/TransientToken.html">TransientToken</a>
148+
</li>
149149
</ul>
150150
</li>
151151
<li class="nav-group-name">
@@ -163,9 +163,6 @@
163163
<li class="nav-group-task">
164164
<a class="nav-group-task-link" href="Extensions/Decodable.html">Decodable</a>
165165
</li>
166-
<li class="nav-group-task">
167-
<a class="nav-group-task-link" href="Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
168-
</li>
169166
<li class="nav-group-task">
170167
<a class="nav-group-task-link" href="Extensions/Int.html">Int</a>
171168
</li>
@@ -189,6 +186,9 @@
189186
<li class="nav-group-task">
190187
<a class="nav-group-task-link" href="Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
191188
</li>
189+
<li class="nav-group-task">
190+
<a class="nav-group-task-link" href="Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
191+
</li>
192192
</ul>
193193
</li>
194194
<li class="nav-group-name">
@@ -244,6 +244,9 @@
244244
<li class="nav-group-task">
245245
<a class="nav-group-task-link" href="Structs/HomogenousTree.html">HomogenousTree</a>
246246
</li>
247+
<li class="nav-group-task">
248+
<a class="nav-group-task-link" href="Structs/LabelledToken.html">LabelledToken</a>
249+
</li>
247250
<li class="nav-group-task">
248251
<a class="nav-group-task-link" href="Structs/ParsingDecoder.html">ParsingDecoder</a>
249252
</li>
@@ -255,9 +258,6 @@
255258
<li class="nav-group-task">
256259
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
257260
</li>
258-
<li class="nav-group-task">
259-
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
260-
</li>
261261
<li class="nav-group-task">
262262
<a class="nav-group-task-link" href="Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
263263
</li>
@@ -887,7 +887,7 @@ <h4>Declaration</h4>
887887
<h4>Declaration</h4>
888888
<div class="language">
889889
<p class="aside-title">Swift</p>
890-
<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>
890+
<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>
891891

892892
</div>
893893
</div>
@@ -902,7 +902,7 @@ <h4>Declaration</h4>
902902
</article>
903903
</div>
904904
<section class="footer">
905-
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-01-31)</p>
905+
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</p>
906906
<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>
907907
</section>
908908
</body>

‎Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor.html

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,6 @@
123123
<li class="nav-group-name">
124124
<a class="nav-group-name-link" href="../Enums.html">Enumerations</a>
125125
<ul class="nav-group-tasks">
126-
<li class="nav-group-task">
127-
<a class="nav-group-task-link" href="../Enums/BackgroundTimer.html">BackgroundTimer</a>
128-
</li>
129126
<li class="nav-group-task">
130127
<a class="nav-group-task-link" href="../Enums/GrammarError.html">GrammarError</a>
131128
</li>
@@ -147,6 +144,9 @@
147144
<li class="nav-group-task">
148145
<a class="nav-group-task-link" href="../Enums/ScannerRule.html">ScannerRule</a>
149146
</li>
147+
<li class="nav-group-task">
148+
<a class="nav-group-task-link" href="../Enums/TransientToken.html">TransientToken</a>
149+
</li>
150150
</ul>
151151
</li>
152152
<li class="nav-group-name">
@@ -164,9 +164,6 @@
164164
<li class="nav-group-task">
165165
<a class="nav-group-task-link" href="../Extensions/Decodable.html">Decodable</a>
166166
</li>
167-
<li class="nav-group-task">
168-
<a class="nav-group-task-link" href="../Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
169-
</li>
170167
<li class="nav-group-task">
171168
<a class="nav-group-task-link" href="../Extensions/Int.html">Int</a>
172169
</li>
@@ -190,6 +187,9 @@
190187
<li class="nav-group-task">
191188
<a class="nav-group-task-link" href="../Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
192189
</li>
190+
<li class="nav-group-task">
191+
<a class="nav-group-task-link" href="../Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
192+
</li>
193193
</ul>
194194
</li>
195195
<li class="nav-group-name">
@@ -245,6 +245,9 @@
245245
<li class="nav-group-task">
246246
<a class="nav-group-task-link" href="../Structs/HomogenousTree.html">HomogenousTree</a>
247247
</li>
248+
<li class="nav-group-task">
249+
<a class="nav-group-task-link" href="../Structs/LabelledToken.html">LabelledToken</a>
250+
</li>
248251
<li class="nav-group-task">
249252
<a class="nav-group-task-link" href="../Structs/ParsingDecoder.html">ParsingDecoder</a>
250253
</li>
@@ -256,9 +259,6 @@
256259
<li class="nav-group-task">
257260
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
258261
</li>
259-
<li class="nav-group-task">
260-
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
261-
</li>
262262
<li class="nav-group-task">
263263
<a class="nav-group-task-link" href="../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
264264
</li>
@@ -765,17 +765,18 @@ <h4>Declaration</h4>
765765
<li class="item">
766766
<div>
767767
<code>
768-
<a name="/s:9OysterKit26IntermediateRepresentationP11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchJ0tF"></a>
768+
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchL0tF"></a>
769769
<a name="//apple_ref/swift/Method/didEvaluate(rule:matchResult:)" class="dashAnchor"></a>
770-
<a class="token" href="#/s:9OysterKit26IntermediateRepresentationP11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchJ0tF">didEvaluate(rule:matchResult:)</a>
770+
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC11didEvaluateyAA4Rule_p4rule_AA11MatchResultO05matchL0tF">didEvaluate(rule:matchResult:)</a>
771771
</code>
772772
</div>
773773
<div class="height-container">
774774
<div class="pointer-container"></div>
775775
<section class="section">
776776
<div class="pointer"></div>
777777
<div class="abstract">
778-
778+
<p>Processes the results of evaluation</p>
779+
779780
</div>
780781
<div class="declaration">
781782
<h4>Declaration</h4>
@@ -791,17 +792,18 @@ <h4>Declaration</h4>
791792
<li class="item">
792793
<div>
793794
<code>
794-
<a name="/s:9OysterKit26IntermediateRepresentationP8didBuildyyF"></a>
795+
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC8didBuildyyF"></a>
795796
<a name="//apple_ref/swift/Method/didBuild()" class="dashAnchor"></a>
796-
<a class="token" href="#/s:9OysterKit26IntermediateRepresentationP8didBuildyyF">didBuild()</a>
797+
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC8didBuildyyF">didBuild()</a>
797798
</code>
798799
</div>
799800
<div class="height-container">
800801
<div class="pointer-container"></div>
801802
<section class="section">
802803
<div class="pointer"></div>
803804
<div class="abstract">
804-
805+
<p>Does nothing</p>
806+
805807
</div>
806808
<div class="declaration">
807809
<h4>Declaration</h4>
@@ -817,17 +819,18 @@ <h4>Declaration</h4>
817819
<li class="item">
818820
<div>
819821
<code>
820-
<a name="/s:9OysterKit26IntermediateRepresentationP10resetStateyyF"></a>
822+
<a name="/s:9OysterKit29AbstractSyntaxTreeConstructorC10resetStateyyF"></a>
821823
<a name="//apple_ref/swift/Method/resetState()" class="dashAnchor"></a>
822-
<a class="token" href="#/s:9OysterKit26IntermediateRepresentationP10resetStateyyF">resetState()</a>
824+
<a class="token" href="#/s:9OysterKit29AbstractSyntaxTreeConstructorC10resetStateyyF">resetState()</a>
823825
</code>
824826
</div>
825827
<div class="height-container">
826828
<div class="pointer-container"></div>
827829
<section class="section">
828830
<div class="pointer"></div>
829831
<div class="abstract">
830-
832+
<p>Does nothing</p>
833+
831834
</div>
832835
<div class="declaration">
833836
<h4>Declaration</h4>
@@ -1029,7 +1032,7 @@ <h4>Declaration</h4>
10291032
</article>
10301033
</div>
10311034
<section class="footer">
1032-
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-01-31)</p>
1035+
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</p>
10331036
<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>
10341037
</section>
10351038
</body>

‎Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor/ConstructionError.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,6 @@
123123
<li class="nav-group-name">
124124
<a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
125125
<ul class="nav-group-tasks">
126-
<li class="nav-group-task">
127-
<a class="nav-group-task-link" href="../../Enums/BackgroundTimer.html">BackgroundTimer</a>
128-
</li>
129126
<li class="nav-group-task">
130127
<a class="nav-group-task-link" href="../../Enums/GrammarError.html">GrammarError</a>
131128
</li>
@@ -147,6 +144,9 @@
147144
<li class="nav-group-task">
148145
<a class="nav-group-task-link" href="../../Enums/ScannerRule.html">ScannerRule</a>
149146
</li>
147+
<li class="nav-group-task">
148+
<a class="nav-group-task-link" href="../../Enums/TransientToken.html">TransientToken</a>
149+
</li>
150150
</ul>
151151
</li>
152152
<li class="nav-group-name">
@@ -164,9 +164,6 @@
164164
<li class="nav-group-task">
165165
<a class="nav-group-task-link" href="../../Extensions/Decodable.html">Decodable</a>
166166
</li>
167-
<li class="nav-group-task">
168-
<a class="nav-group-task-link" href="../../Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
169-
</li>
170167
<li class="nav-group-task">
171168
<a class="nav-group-task-link" href="../../Extensions/Int.html">Int</a>
172169
</li>
@@ -190,6 +187,9 @@
190187
<li class="nav-group-task">
191188
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
192189
</li>
190+
<li class="nav-group-task">
191+
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
192+
</li>
193193
</ul>
194194
</li>
195195
<li class="nav-group-name">
@@ -245,6 +245,9 @@
245245
<li class="nav-group-task">
246246
<a class="nav-group-task-link" href="../../Structs/HomogenousTree.html">HomogenousTree</a>
247247
</li>
248+
<li class="nav-group-task">
249+
<a class="nav-group-task-link" href="../../Structs/LabelledToken.html">LabelledToken</a>
250+
</li>
248251
<li class="nav-group-task">
249252
<a class="nav-group-task-link" href="../../Structs/ParsingDecoder.html">ParsingDecoder</a>
250253
</li>
@@ -256,9 +259,6 @@
256259
<li class="nav-group-task">
257260
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
258261
</li>
259-
<li class="nav-group-task">
260-
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
261-
</li>
262262
<li class="nav-group-task">
263263
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
264264
</li>
@@ -387,7 +387,7 @@ <h4>Declaration</h4>
387387
</article>
388388
</div>
389389
<section class="footer">
390-
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-01-31)</p>
390+
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</p>
391391
<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>
392392
</section>
393393
</body>

‎Documentation/OysterKit/Classes/AbstractSyntaxTreeConstructor/IntermediateRepresentationNode.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,6 @@
123123
<li class="nav-group-name">
124124
<a class="nav-group-name-link" href="../../Enums.html">Enumerations</a>
125125
<ul class="nav-group-tasks">
126-
<li class="nav-group-task">
127-
<a class="nav-group-task-link" href="../../Enums/BackgroundTimer.html">BackgroundTimer</a>
128-
</li>
129126
<li class="nav-group-task">
130127
<a class="nav-group-task-link" href="../../Enums/GrammarError.html">GrammarError</a>
131128
</li>
@@ -147,6 +144,9 @@
147144
<li class="nav-group-task">
148145
<a class="nav-group-task-link" href="../../Enums/ScannerRule.html">ScannerRule</a>
149146
</li>
147+
<li class="nav-group-task">
148+
<a class="nav-group-task-link" href="../../Enums/TransientToken.html">TransientToken</a>
149+
</li>
150150
</ul>
151151
</li>
152152
<li class="nav-group-name">
@@ -164,9 +164,6 @@
164164
<li class="nav-group-task">
165165
<a class="nav-group-task-link" href="../../Extensions/Decodable.html">Decodable</a>
166166
</li>
167-
<li class="nav-group-task">
168-
<a class="nav-group-task-link" href="../../Extensions/DispatchTimeInterval.html">DispatchTimeInterval</a>
169-
</li>
170167
<li class="nav-group-task">
171168
<a class="nav-group-task-link" href="../../Extensions/Int.html">Int</a>
172169
</li>
@@ -190,6 +187,9 @@
190187
<li class="nav-group-task">
191188
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit2eeoiSbAA5Token_p_AaC_ptF">==(_:_:)</a>
192189
</li>
190+
<li class="nav-group-task">
191+
<a class="nav-group-task-link" href="../../Functions.html#/s:9OysterKit8areEqualSbs10DictionaryVyAA14RuleAnnotationOAA0fG5ValueOG3lhs_AI3rhstF">areEqual(lhs:rhs:)</a>
192+
</li>
193193
</ul>
194194
</li>
195195
<li class="nav-group-name">
@@ -245,6 +245,9 @@
245245
<li class="nav-group-task">
246246
<a class="nav-group-task-link" href="../../Structs/HomogenousTree.html">HomogenousTree</a>
247247
</li>
248+
<li class="nav-group-task">
249+
<a class="nav-group-task-link" href="../../Structs/LabelledToken.html">LabelledToken</a>
250+
</li>
248251
<li class="nav-group-task">
249252
<a class="nav-group-task-link" href="../../Structs/ParsingDecoder.html">ParsingDecoder</a>
250253
</li>
@@ -256,9 +259,6 @@
256259
<li class="nav-group-task">
257260
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit17CustomRuleClosurea">CustomRuleClosure</a>
258261
</li>
259-
<li class="nav-group-task">
260-
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit23DefaultHeterogeneousASTa">DefaultHeterogeneousAST</a>
261-
</li>
262262
<li class="nav-group-task">
263263
<a class="nav-group-task-link" href="../../Typealiases.html#/s:9OysterKit15RuleAnnotationsa">RuleAnnotations</a>
264264
</li>
@@ -468,7 +468,7 @@ <h4>Declaration</h4>
468468
</article>
469469
</div>
470470
<section class="footer">
471-
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-01-31)</p>
471+
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-04)</p>
472472
<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>
473473
</section>
474474
</body>

0 commit comments

Comments
 (0)