Skip to content

Commit a20b474

Browse files
Updated doc
1 parent ec757c0 commit a20b474

24 files changed

+2354
-7
lines changed

docs/cat_interpreter/CATInterpreter-class.html

Lines changed: 173 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,111 @@ <h2>Properties</h2>
164164
id="instance-methods">
165165
<h2>Methods</h2>
166166
<dl class="callables">
167+
<dt id="copyCells" class="callable">
168+
<span class="name"><a href="../cat_interpreter/CATInterpreter/copyCells.html">copyCells</a></span><span class="signature">(<wbr><span class="parameter" id="copyCells-param-origin"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">origin</span>, </span><span class="parameter" id="copyCells-param-destination"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">destination</span></span>)
169+
<span class="returntype parameter">&#8594; void</span>
170+
</span>
171+
172+
173+
</dt>
174+
<dd>
175+
It takes a list of origin cells and a list of destination cells,
176+
the color of the origin cells is copied to the destination cells.
177+
Args:
178+
origin (List<string>): Origin cells from where to copy the colors
179+
destinations (List<string>): Destination cells</string></string>
180+
181+
182+
</dd>
183+
184+
<dt id="fillEmpty" class="callable">
185+
<span class="name"><a href="../cat_interpreter/CATInterpreter/fillEmpty.html">fillEmpty</a></span><span class="signature">(<wbr><span class="parameter" id="fillEmpty-param-colors"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">colors</span></span>)
186+
<span class="returntype parameter">&#8594; void</span>
187+
</span>
188+
189+
190+
</dt>
191+
<dd>
192+
If the first element of the list is a valid color, then call the <code>color</code>
193+
function of the <code>commandCaller</code> object with the <code>fillEmpty</code> command
194+
and the index of the color.
195+
196+
197+
</dd>
198+
199+
<dt id="go" class="callable">
200+
<span class="name"><a href="../cat_interpreter/CATInterpreter/go.html">go</a></span><span class="signature">(<wbr><span class="parameter" id="go-param-move"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">move</span>, </span><span class="parameter" id="go-param-repetitions"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/int-class.html">int</a></span> <span class="parameter-name">repetitions</span></span>)
201+
<span class="returntype parameter">&#8594; void</span>
202+
</span>
203+
204+
205+
</dt>
206+
<dd>
207+
208+
209+
210+
</dd>
211+
212+
<dt id="goCell" class="callable">
213+
<span class="name"><a href="../cat_interpreter/CATInterpreter/goCell.html">goCell</a></span><span class="signature">(<wbr><span class="parameter" id="goCell-param-cell"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">cell</span></span>)
214+
<span class="returntype parameter">&#8594; void</span>
215+
</span>
216+
217+
218+
</dt>
219+
<dd>
220+
221+
222+
223+
</dd>
224+
225+
<dt id="mirrorBoard" class="callable">
226+
<span class="name"><a href="../cat_interpreter/CATInterpreter/mirrorBoard.html">mirrorBoard</a></span><span class="signature">(<wbr><span class="parameter" id="mirrorBoard-param-direction"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">direction</span></span>)
227+
<span class="returntype parameter">&#8594; void</span>
228+
</span>
229+
230+
231+
</dt>
232+
<dd>
233+
It calls the mirrorHorizontal or mirrorVertical function in the Dart code,
234+
depending on the value of the direction parameter
235+
236+
237+
</dd>
238+
239+
<dt id="mirrorCells" class="callable">
240+
<span class="name"><a href="../cat_interpreter/CATInterpreter/mirrorCells.html">mirrorCells</a></span><span class="signature">(<wbr><span class="parameter" id="mirrorCells-param-cells"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">cells</span>, </span><span class="parameter" id="mirrorCells-param-direction"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">direction</span></span>)
241+
<span class="returntype parameter">&#8594; void</span>
242+
</span>
243+
244+
245+
</dt>
246+
<dd>
247+
It takes a list of cells and a direction,
248+
and then it moves to each cell and
249+
calls the appropriate mirror function
250+
251+
252+
</dd>
253+
254+
<dt id="mirrorCommands" class="callable">
255+
<span class="name"><a href="../cat_interpreter/CATInterpreter/mirrorCommands.html">mirrorCommands</a></span><span class="signature">(<wbr><span class="parameter" id="mirrorCommands-param-commands"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">commands</span>, </span><span class="parameter" id="mirrorCommands-param-direction"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">direction</span></span>)
256+
<span class="returntype parameter">&#8594; void</span>
257+
</span>
258+
259+
260+
</dt>
261+
<dd>
262+
It creates a new command caller,
263+
copies the board from the old command caller,
264+
parses the commands,
265+
mirrors the board,
266+
and then joins the crosses from the
267+
new board to the old board.
268+
269+
270+
</dd>
271+
167272
<dt id="noSuchMethod" class="callable inherited">
168273
<span class="name"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
169274
<span class="returntype parameter">&#8594; dynamic</span>
@@ -175,6 +280,62 @@ <h2>Methods</h2>
175280
Invoked when a nonexistent method or property is accessed.
176281
<div class="features"><span class="feature">inherited</span></div>
177282

283+
</dd>
284+
285+
<dt id="paintMultileCells" class="callable">
286+
<span class="name"><a href="../cat_interpreter/CATInterpreter/paintMultileCells.html">paintMultileCells</a></span><span class="signature">(<wbr><span class="parameter" id="paintMultileCells-param-colors"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">colors</span>, </span><span class="parameter" id="paintMultileCells-param-cellsPositions"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">cellsPositions</span></span>)
287+
<span class="returntype parameter">&#8594; void</span>
288+
</span>
289+
290+
291+
</dt>
292+
<dd>
293+
294+
295+
296+
</dd>
297+
298+
<dt id="paintPattern" class="callable">
299+
<span class="name"><a href="../cat_interpreter/CATInterpreter/paintPattern.html">paintPattern</a></span><span class="signature">(<wbr><span class="parameter" id="paintPattern-param-colors"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">colors</span>, </span><span class="parameter" id="paintPattern-param-repetitions"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">repetitions</span>, </span><span class="parameter" id="paintPattern-param-pattern"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">pattern</span></span>)
300+
<span class="returntype parameter">&#8594; void</span>
301+
</span>
302+
303+
304+
</dt>
305+
<dd>
306+
307+
308+
309+
</dd>
310+
311+
<dt id="paintSingleCell" class="callable">
312+
<span class="name"><a href="../cat_interpreter/CATInterpreter/paintSingleCell.html">paintSingleCell</a></span><span class="signature">(<wbr><span class="parameter" id="paintSingleCell-param-color"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">color</span></span>)
313+
<span class="returntype parameter">&#8594; void</span>
314+
</span>
315+
316+
317+
</dt>
318+
<dd>
319+
320+
321+
322+
</dd>
323+
324+
<dt id="repeatCommands" class="callable">
325+
<span class="name"><a href="../cat_interpreter/CATInterpreter/repeatCommands.html">repeatCommands</a></span><span class="signature">(<wbr><span class="parameter" id="repeatCommands-param-commands"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">commands</span>, </span><span class="parameter" id="repeatCommands-param-positions"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span>&gt;</span></span> <span class="parameter-name">positions</span></span>)
326+
<span class="returntype parameter">&#8594; void</span>
327+
</span>
328+
329+
330+
</dt>
331+
<dd>
332+
It takes a list of commands and a list of positions where to copy the
333+
commands.
334+
Args:
335+
commands (List<string>): The commands to execute
336+
positions (List<string>): The positions where tto repeat the commands</string></string>
337+
338+
178339
</dd>
179340

180341
<dt id="reset" class="callable">
@@ -207,7 +368,7 @@ <h2>Methods</h2>
207368

208369
<dt id="validateOnScheme" class="callable">
209370
<span class="name"><a href="../cat_interpreter/CATInterpreter/validateOnScheme.html">validateOnScheme</a></span><span class="signature">(<wbr><span class="parameter" id="validateOnScheme-param-code"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">code</span>, </span><span class="parameter" id="validateOnScheme-param-schemeIndex"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.0.0/dart-core/int-class.html">int</a></span> <span class="parameter-name">schemeIndex</span></span>)
210-
<span class="returntype parameter">&#8594; <a href="https://pub.dev/documentation/dartx/1.1.0/dartx_io/Pair-class.html">Pair</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../cat_interpreter/Results-class.html">Results</a></span>, <span class="type-parameter"><a href="../cat_interpreter/CatError.html">CatError</a></span>&gt;</span></span>
371+
<span class="returntype parameter">&#8594; <a href="https://pub.dev/documentation/dartx/1.2.0/dartx_io/Pair-class.html">Pair</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../cat_interpreter/Results-class.html">Results</a></span>, <span class="type-parameter"><a href="../cat_interpreter/CatError.html">CatError</a></span>&gt;</span></span>
211372
</span>
212373

213374

@@ -314,7 +475,18 @@ <h5>cat_interpreter library</h5>
314475
<li><a href="../cat_interpreter/CATInterpreter/shape.html">shape</a></li>
315476

316477
<li class="section-title"><a href="../cat_interpreter/CATInterpreter-class.html#instance-methods">Methods</a></li>
478+
<li><a href="../cat_interpreter/CATInterpreter/copyCells.html">copyCells</a></li>
479+
<li><a href="../cat_interpreter/CATInterpreter/fillEmpty.html">fillEmpty</a></li>
480+
<li><a href="../cat_interpreter/CATInterpreter/go.html">go</a></li>
481+
<li><a href="../cat_interpreter/CATInterpreter/goCell.html">goCell</a></li>
482+
<li><a href="../cat_interpreter/CATInterpreter/mirrorBoard.html">mirrorBoard</a></li>
483+
<li><a href="../cat_interpreter/CATInterpreter/mirrorCells.html">mirrorCells</a></li>
484+
<li><a href="../cat_interpreter/CATInterpreter/mirrorCommands.html">mirrorCommands</a></li>
317485
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
486+
<li><a href="../cat_interpreter/CATInterpreter/paintMultileCells.html">paintMultileCells</a></li>
487+
<li><a href="../cat_interpreter/CATInterpreter/paintPattern.html">paintPattern</a></li>
488+
<li><a href="../cat_interpreter/CATInterpreter/paintSingleCell.html">paintSingleCell</a></li>
489+
<li><a href="../cat_interpreter/CATInterpreter/repeatCommands.html">repeatCommands</a></li>
318490
<li><a href="../cat_interpreter/CATInterpreter/reset.html">reset</a></li>
319491
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/toString.html">toString</a></li>
320492
<li><a href="../cat_interpreter/CATInterpreter/validateOnScheme.html">validateOnScheme</a></li>

docs/cat_interpreter/CATInterpreter/CATInterpreter.fromSchemes.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,18 @@ <h5>CATInterpreter class</h5>
113113
<li><a href="../../cat_interpreter/CATInterpreter/shape.html">shape</a></li>
114114

115115
<li class="section-title"><a href="../../cat_interpreter/CATInterpreter-class.html#instance-methods">Methods</a></li>
116+
<li><a href="../../cat_interpreter/CATInterpreter/copyCells.html">copyCells</a></li>
117+
<li><a href="../../cat_interpreter/CATInterpreter/fillEmpty.html">fillEmpty</a></li>
118+
<li><a href="../../cat_interpreter/CATInterpreter/go.html">go</a></li>
119+
<li><a href="../../cat_interpreter/CATInterpreter/goCell.html">goCell</a></li>
120+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorBoard.html">mirrorBoard</a></li>
121+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorCells.html">mirrorCells</a></li>
122+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorCommands.html">mirrorCommands</a></li>
116123
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
124+
<li><a href="../../cat_interpreter/CATInterpreter/paintMultileCells.html">paintMultileCells</a></li>
125+
<li><a href="../../cat_interpreter/CATInterpreter/paintPattern.html">paintPattern</a></li>
126+
<li><a href="../../cat_interpreter/CATInterpreter/paintSingleCell.html">paintSingleCell</a></li>
127+
<li><a href="../../cat_interpreter/CATInterpreter/repeatCommands.html">repeatCommands</a></li>
117128
<li><a href="../../cat_interpreter/CATInterpreter/reset.html">reset</a></li>
118129
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/toString.html">toString</a></li>
119130
<li><a href="../../cat_interpreter/CATInterpreter/validateOnScheme.html">validateOnScheme</a></li>

docs/cat_interpreter/CATInterpreter/CATInterpreter.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,18 @@ <h5>CATInterpreter class</h5>
116116
<li><a href="../../cat_interpreter/CATInterpreter/shape.html">shape</a></li>
117117

118118
<li class="section-title"><a href="../../cat_interpreter/CATInterpreter-class.html#instance-methods">Methods</a></li>
119+
<li><a href="../../cat_interpreter/CATInterpreter/copyCells.html">copyCells</a></li>
120+
<li><a href="../../cat_interpreter/CATInterpreter/fillEmpty.html">fillEmpty</a></li>
121+
<li><a href="../../cat_interpreter/CATInterpreter/go.html">go</a></li>
122+
<li><a href="../../cat_interpreter/CATInterpreter/goCell.html">goCell</a></li>
123+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorBoard.html">mirrorBoard</a></li>
124+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorCells.html">mirrorCells</a></li>
125+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorCommands.html">mirrorCommands</a></li>
119126
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
127+
<li><a href="../../cat_interpreter/CATInterpreter/paintMultileCells.html">paintMultileCells</a></li>
128+
<li><a href="../../cat_interpreter/CATInterpreter/paintPattern.html">paintPattern</a></li>
129+
<li><a href="../../cat_interpreter/CATInterpreter/paintSingleCell.html">paintSingleCell</a></li>
130+
<li><a href="../../cat_interpreter/CATInterpreter/repeatCommands.html">repeatCommands</a></li>
120131
<li><a href="../../cat_interpreter/CATInterpreter/reset.html">reset</a></li>
121132
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/toString.html">toString</a></li>
122133
<li><a href="../../cat_interpreter/CATInterpreter/validateOnScheme.html">validateOnScheme</a></li>

docs/cat_interpreter/CATInterpreter/board.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,18 @@ <h5>CATInterpreter class</h5>
118118
<li><a href="../../cat_interpreter/CATInterpreter/shape.html">shape</a></li>
119119

120120
<li class="section-title"><a href="../../cat_interpreter/CATInterpreter-class.html#instance-methods">Methods</a></li>
121+
<li><a href="../../cat_interpreter/CATInterpreter/copyCells.html">copyCells</a></li>
122+
<li><a href="../../cat_interpreter/CATInterpreter/fillEmpty.html">fillEmpty</a></li>
123+
<li><a href="../../cat_interpreter/CATInterpreter/go.html">go</a></li>
124+
<li><a href="../../cat_interpreter/CATInterpreter/goCell.html">goCell</a></li>
125+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorBoard.html">mirrorBoard</a></li>
126+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorCells.html">mirrorCells</a></li>
127+
<li><a href="../../cat_interpreter/CATInterpreter/mirrorCommands.html">mirrorCommands</a></li>
121128
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
129+
<li><a href="../../cat_interpreter/CATInterpreter/paintMultileCells.html">paintMultileCells</a></li>
130+
<li><a href="../../cat_interpreter/CATInterpreter/paintPattern.html">paintPattern</a></li>
131+
<li><a href="../../cat_interpreter/CATInterpreter/paintSingleCell.html">paintSingleCell</a></li>
132+
<li><a href="../../cat_interpreter/CATInterpreter/repeatCommands.html">repeatCommands</a></li>
122133
<li><a href="../../cat_interpreter/CATInterpreter/reset.html">reset</a></li>
123134
<li class="inherited"><a href="https://api.dart.dev/stable/3.0.0/dart-core/Object/toString.html">toString</a></li>
124135
<li><a href="../../cat_interpreter/CATInterpreter/validateOnScheme.html">validateOnScheme</a></li>

0 commit comments

Comments
 (0)