docs/Chess/CGame.html in chess-0.3.6 vs docs/Chess/CGame.html in chess-0.4.0

- old
+ new

@@ -92,12 +92,12 @@ <dl> <dt>Defined in:</dt> - <dd>ext/chess.c<span class="defines">,<br /> - ext/chess.c</span> + <dd>ext/chess/chess.c<span class="defines">,<br /> + ext/chess/chess.c</span> </dd> </dl> </div> @@ -387,11 +387,11 @@ <span class="summary_desc"><div class='inline'> -<p>The game result is set to &#39;1-0&#39; if <code>color</code> is <em>black</em>, otherwise is set to &#39;0-1&#39; if color is <em>white</em>.</p> +<p>The game result is set to ‘1-0’ if <code>color</code> is <em>black</em>, otherwise is set to ‘0-1’ if color is <em>white</em>.</p> </div></span> </li> @@ -609,11 +609,11 @@ 218 219 220</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 210</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 210</span> VALUE game_boards (VALUE self, VALUE index) { Game *g; @@ -689,11 +689,11 @@ 265 266 267</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 258</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 258</span> VALUE game_coord_moves (VALUE self) { Game *g; @@ -769,11 +769,11 @@ 232 233 234</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 228</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 228</span> VALUE game_current_board (VALUE self) { Game *g; @@ -843,11 +843,11 @@ 200 201 202</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 195</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 195</span> VALUE game_draw (VALUE self) { Game *g; @@ -962,11 +962,11 @@ 351 352 353</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 339</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 339</span> VALUE game_each (VALUE self) { if (!rb_block_given_p ()) @@ -1030,11 +1030,11 @@ 276 277 278</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 273</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 273</span> VALUE game_full_moves (VALUE self) { printf (&quot;DEPRECATION WARNING: `full_moves` is deprecated and will be removed, please use `coord_moves` to get the array with all moves done in coordinate chess notation.\n&quot;); @@ -1091,11 +1091,11 @@ &mdash; <div class='inline'> -<p>The character of the moving piece <em>(&#39;P&#39;, &#39;R&#39;, &#39;N&#39;, &#39;B&#39;, &#39;Q&#39;, &#39;K&#39;)</em>.</p> +<p>The character of the moving piece <em>(‘P’, ‘R’, ‘N’, ‘B’, ‘Q’, ‘K’)</em>.</p> </div> </li> <li> @@ -1107,17 +1107,17 @@ &mdash; <div class='inline'> -<p>When two (or more) identical pieces can move to the same square, the moving piece is uniquely identified by specifying the piece&#39;s letter, followed by (in descending order of preference):</p> +<p>When two (or more) identical pieces can move to the same square, the moving piece is uniquely identified by specifying the piece’s letter, followed by (in descending order of preference):</p> <ul><li> <p>the file of departure (if they differ);</p> </li><li> <p>the rank of departure (if the files are the same but the ranks differ);</p> </li><li> -<p>both the rank and file (if neither alone is sufficient to identify the piece—which occurs only in rare cases where one or more pawns have promoted, resulting in a player having three or more identical pieces able to reach the same square). Keep <code>nil</code> if no needed.</p> +<p>both the rank and file (if neither alone is sufficient to identify the piece—which occurs only in rare cases where one or more pawns have promoted, resulting in a player having three or more identical pieces able to reach the same square). Keep <code>nil</code> if no needed.</p> </li></ul> </div> </li> @@ -1130,11 +1130,11 @@ &mdash; <div class='inline'> -<p>The square where the moving piece will <em>(&#39;a1&#39;, &#39;a2&#39;, … , &#39;h7&#39;, &#39;h8&#39;)</em>.</p> +<p>The square where the moving piece will <em>(‘a1’, ‘a2’, … , ‘h7’, ‘h8’)</em>.</p> </div> </li> <li> @@ -1146,11 +1146,11 @@ &mdash; <div class='inline'> -<p>The character of promotion piece <em>(&#39;R&#39;, &#39;N&#39;, &#39;B&#39;, &#39;Q&#39;)</em>. If not <code>nil</code> and no promotion occured raise an <span class='object_link'><a href="IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>. If <code>nil</code>, <em>&#39;Q&#39;</em> is the default.</p> +<p>The character of promotion piece <em>(‘R’, ‘N’, ‘B’, ‘Q’)</em>. If not <code>nil</code> and no promotion occured raise an <span class='object_link'><a href="IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>. If <code>nil</code>, <em>‘Q’</em> is the default.</p> </div> </li> </ul> @@ -1215,11 +1215,11 @@ 87 88 89</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 71</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 71</span> VALUE game_move (VALUE self, VALUE rb_piece, VALUE rb_disambiguating, VALUE rb_to_coord, VALUE rb_promote_in) { Game *g; @@ -1289,11 +1289,11 @@ &mdash; <div class='inline'> -<p>The 2 character string representing the starting square of the moving piece <em>(&#39;a1&#39;, &#39;a2&#39;, … , &#39;h7&#39;, &#39;h8&#39;)</em>.</p> +<p>The 2 character string representing the starting square of the moving piece <em>(‘a1’, ‘a2’, … , ‘h7’, ‘h8’)</em>.</p> </div> </li> <li> @@ -1305,11 +1305,11 @@ &mdash; <div class='inline'> -<p>The 2 character string representing the ending square of the moving piece <em>(&#39;a1&#39;, &#39;a2&#39;, … , &#39;h7&#39;, &#39;h8&#39;)</em>.</p> +<p>The 2 character string representing the ending square of the moving piece <em>(‘a1’, ‘a2’, … , ‘h7’, ‘h8’)</em>.</p> </div> </li> <li> @@ -1321,11 +1321,11 @@ &mdash; <div class='inline'> -<p>The character of promotion piece <em>(&#39;R&#39;, &#39;N&#39;, &#39;B&#39;, &#39;Q&#39;)</em>. If not <code>nil</code> and no promotion occured raise an <span class='object_link'><a href="IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>. If <code>nil</code>, <em>&#39;Q&#39;</em> is the default.</p> +<p>The character of promotion piece <em>(‘R’, ‘N’, ‘B’, ‘Q’)</em>. If not <code>nil</code> and no promotion occured raise an <span class='object_link'><a href="IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>. If <code>nil</code>, <em>‘Q’</em> is the default.</p> </div> </li> </ul> @@ -1385,11 +1385,11 @@ 117 118 119</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 106</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 106</span> VALUE game_move2 (VALUE self, VALUE rb_from, VALUE rb_to, VALUE rb_promote_in) { Game *g; @@ -1498,11 +1498,11 @@ &mdash; <div class='inline'> -<p>The character of promotion piece <em>(&#39;R&#39;, &#39;N&#39;, &#39;B&#39;, &#39;Q&#39;)</em>. If not <code>nil</code> and no promotion occured raise an <span class='object_link'><a href="IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>. If <code>nil</code>, <em>&#39;Q&#39;</em> is the default.</p> +<p>The character of promotion piece <em>(‘R’, ‘N’, ‘B’, ‘Q’)</em>. If not <code>nil</code> and no promotion occured raise an <span class='object_link'><a href="IllegalMoveError.html" title="Chess::IllegalMoveError (class)">IllegalMoveError</a></span>. If <code>nil</code>, <em>‘Q’</em> is the default.</p> </div> </li> </ul> @@ -1562,11 +1562,11 @@ 161 162 163</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 150</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 150</span> VALUE game_move3 (VALUE self, VALUE rb_from, VALUE rb_to, VALUE rb_promote_in) { Game *g; @@ -1645,11 +1645,11 @@ 248 249 250</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 241</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 241</span> VALUE game_moves (VALUE self) { Game *g; @@ -1682,11 +1682,11 @@ <div class="tags"> <div class="docstring"> <div class="discussion"> -<p>The game result is set to &#39;1-0&#39; if <code>color</code> is <em>black</em>, otherwise is set to &#39;0-1&#39; if color is <em>white</em>.</p> +<p>The game result is set to ‘1-0’ if <code>color</code> is <em>black</em>, otherwise is set to ‘0-1’ if color is <em>white</em>.</p> </div> </div> <div class="tags"> @@ -1750,11 +1750,11 @@ 186 187 188</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 173</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 173</span> VALUE game_resign (VALUE self, VALUE color) { Game *g; @@ -1849,11 +1849,11 @@ 313 314 315</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 306</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 306</span> VALUE game_result (VALUE self) { Game *g; @@ -1931,11 +1931,11 @@ 365 366 367</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 360</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 360</span> VALUE game_rollback (VALUE self) { Game *g; @@ -2031,11 +2031,11 @@ 41 42 43</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 36</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 36</span> VALUE game_set_fen (VALUE self, VALUE fen) { Game *g; @@ -2105,11 +2105,11 @@ 326 327 328</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 322</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 322</span> VALUE game_size (VALUE self) { Game *g; @@ -2181,11 +2181,11 @@ 292 293 294</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 285</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 285</span> VALUE game_threefold_repetition (VALUE self) { Game *g; @@ -2261,11 +2261,11 @@ 382 383 384</pre> </td> <td> - <pre class="code"><span class="info file"># File 'ext/chess.c', line 374</span> + <pre class="code"><span class="info file"># File 'ext/chess/chess.c', line 374</span> VALUE game_to_s (VALUE self) { Game *g; @@ -2284,12 +2284,12 @@ </div> </div> <div id="footer"> - Generated on Thu Jan 28 17:31:41 2021 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.9.26 (ruby-2.6.1). + Generated on Fri Aug 30 11:09:51 2024 by + <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.9.36 (ruby-3.3.2). </div> </div> </body> </html> \ No newline at end of file