Skip to content

Commit b030843

Browse files
GiorgiaAuroraAdorniGiorgiaAuroraAdorni
committed
Updated doc
1 parent c439d13 commit b030843

File tree

129 files changed

+7131
-12487
lines changed

Some content is hidden

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

129 files changed

+7131
-12487
lines changed

‎docs/cat_interpreter/BasicColoring-class.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,24 @@ <h1><span class="kind-class">BasicColoring</span> class
6262
</section>
6363

6464

65+
<section>
66+
<dl class="dl-horizontal">
67+
68+
69+
70+
71+
72+
<dt>Implementers</dt>
73+
<dd><ul class="comma-separated clazz-relationships">
74+
<li><a href="../cat_interpreter/Coloring-class.html">Coloring</a></li>
75+
</ul></dd>
76+
77+
78+
79+
80+
81+
</dl>
82+
</section>
6583

6684

6785
<section class="summary offset-anchor" id="constructors">
@@ -465,6 +483,7 @@ <h5>cat_interpreter library</h5>
465483
<li><a href="../cat_interpreter/BasicMoves-class.html">BasicMoves</a></li>
466484
<li><a href="../cat_interpreter/BasicShape-class.html">BasicShape</a></li>
467485
<li><a href="../cat_interpreter/CATInterpreter-class.html">CATInterpreter</a></li>
486+
<li><a href="../cat_interpreter/Coloring-class.html">Coloring</a></li>
468487
<li><a href="../cat_interpreter/CommandCaller-class.html">CommandCaller</a></li>
469488
<li><a href="../cat_interpreter/Cross-class.html">Cross</a></li>
470489
<li><a href="../cat_interpreter/Results-class.html">Results</a></li>

‎docs/cat_interpreter/BasicMoves-class.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,8 @@ <h2>Methods</h2>
268268

269269
</dt>
270270
<dd>
271-
Move to an arbitrary position <code>row,column</code>.
271+
The function <code>toPosition</code> sets the row and column values if they are valid and
272+
returns true, otherwise it returns false.
272273

273274

274275
</dd>
@@ -281,7 +282,7 @@ <h2>Methods</h2>
281282

282283
</dt>
283284
<dd>
284-
A string representation of this object.
285+
The function returns a string representation of the row and column positions.
285286
<div class="features"><span class="feature">override</span></div>
286287

287288
</dd>
@@ -350,6 +351,7 @@ <h5>cat_interpreter library</h5>
350351
<li><a href="../cat_interpreter/BasicMoves-class.html">BasicMoves</a></li>
351352
<li><a href="../cat_interpreter/BasicShape-class.html">BasicShape</a></li>
352353
<li><a href="../cat_interpreter/CATInterpreter-class.html">CATInterpreter</a></li>
354+
<li><a href="../cat_interpreter/Coloring-class.html">Coloring</a></li>
353355
<li><a href="../cat_interpreter/CommandCaller-class.html">CommandCaller</a></li>
354356
<li><a href="../cat_interpreter/Cross-class.html">Cross</a></li>
355357
<li><a href="../cat_interpreter/Results-class.html">Results</a></li>

‎docs/cat_interpreter/BasicMoves/toPosition.html‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,17 @@ <h1><span class="kind-method">toPosition</span> method
6969
</section>
7070

7171
<section class="desc markdown">
72-
<p>Move to an arbitrary position <code>row,column</code>.</p>
73-
<p>Return true on success.</p>
74-
<pre class="language-dart"><code class="language-dart">toPosition(0,0);
75-
toPosition(3,5);
76-
...
77-
</code></pre>
72+
<p>The function <code>toPosition</code> sets the row and column values if they are valid and
73+
returns true, otherwise it returns false.</p>
74+
<p>Args:
75+
row (int): The row parameter represents the row number of a position in a
76+
grid or matrix.
77+
column (int): The "column" parameter represents the column index of a
78+
position in a grid or matrix.</p>
79+
<p>Returns:
80+
a boolean value. It returns true if the position (row, column) is valid and
81+
successfully sets the internal variables _row and _column to the given values.
82+
It returns false if the position is not valid.</p>
7883
</section>
7984

8085

‎docs/cat_interpreter/BasicMoves/toString.html‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,7 @@ <h1><span class="kind-method">toString</span> method
7272
</section>
7373

7474
<section class="desc markdown">
75-
<p>A string representation of this object.</p>
76-
<p>Some classes have a default textual representation,
77-
often paired with a static <code>parse</code> function (like <a href="https://api.dart.dev/stable/3.0.0/dart-core/int/parse.html">int.parse</a>).
78-
These classes will provide the textual representation as
79-
their string representation.</p>
80-
<p>Other classes have no meaningful textual representation
81-
that a program will care about.
82-
Such classes will typically override <code>toString</code> to provide
83-
useful information when inspecting the object,
84-
mainly for debugging or logging.</p>
75+
<p>The function returns a string representation of the row and column positions.</p>
8576
</section>
8677

8778

‎docs/cat_interpreter/BasicShape-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ <h5>cat_interpreter library</h5>
256256
<li><a href="../cat_interpreter/BasicMoves-class.html">BasicMoves</a></li>
257257
<li><a href="../cat_interpreter/BasicShape-class.html">BasicShape</a></li>
258258
<li><a href="../cat_interpreter/CATInterpreter-class.html">CATInterpreter</a></li>
259+
<li><a href="../cat_interpreter/Coloring-class.html">Coloring</a></li>
259260
<li><a href="../cat_interpreter/CommandCaller-class.html">CommandCaller</a></li>
260261
<li><a href="../cat_interpreter/Cross-class.html">Cross</a></li>
261262
<li><a href="../cat_interpreter/Results-class.html">Results</a></li>

‎docs/cat_interpreter/CATInterpreter-class.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h2>Properties</h2>
9191
<dl class="properties">
9292
<dt id="board" class="property">
9393
<span class="name"><a href="../cat_interpreter/CATInterpreter/board.html">board</a></span>
94-
<span class="signature">&#8594; Coloring</span>
94+
<span class="signature">&#8594; <a href="../cat_interpreter/Coloring-class.html">Coloring</a></span>
9595

9696
</dt>
9797
<dd>
@@ -269,6 +269,7 @@ <h5>cat_interpreter library</h5>
269269
<li><a href="../cat_interpreter/BasicMoves-class.html">BasicMoves</a></li>
270270
<li><a href="../cat_interpreter/BasicShape-class.html">BasicShape</a></li>
271271
<li><a href="../cat_interpreter/CATInterpreter-class.html">CATInterpreter</a></li>
272+
<li><a href="../cat_interpreter/Coloring-class.html">Coloring</a></li>
272273
<li><a href="../cat_interpreter/CommandCaller-class.html">CommandCaller</a></li>
273274
<li><a href="../cat_interpreter/Cross-class.html">Cross</a></li>
274275
<li><a href="../cat_interpreter/Results-class.html">Results</a></li>

‎docs/cat_interpreter/CATInterpreter/board.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h1><span class="kind-property">board</span> property
6262

6363
<section class="multi-line-signature">
6464

65-
<span class="returntype">Coloring</span>
65+
<span class="returntype"><a href="../../cat_interpreter/Coloring-class.html">Coloring</a></span>
6666
<span class="name ">board</span>
6767

6868

‎docs/cat_interpreter/CatError.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,7 @@ <h5>cat_interpreter library</h5>
341341
<li><a href="../cat_interpreter/BasicMoves-class.html">BasicMoves</a></li>
342342
<li><a href="../cat_interpreter/BasicShape-class.html">BasicShape</a></li>
343343
<li><a href="../cat_interpreter/CATInterpreter-class.html">CATInterpreter</a></li>
344+
<li><a href="../cat_interpreter/Coloring-class.html">Coloring</a></li>
344345
<li><a href="../cat_interpreter/CommandCaller-class.html">CommandCaller</a></li>
345346
<li><a href="../cat_interpreter/Cross-class.html">Cross</a></li>
346347
<li><a href="../cat_interpreter/Results-class.html">Results</a></li>

0 commit comments

Comments
 (0)