Ajoute les commentaires et la documentation RDoc

This commit is contained in:
julien committed 2026-10-08 21:05:59 +02:00
1 parent 1a390a0c37
commit cbc8b5c7c5
5 files changed
+49 -5

No files matched your search

+42 -1
View File
@@ -8,7 +8,7 @@
<title>README - RDoc Documentation</title>
<meta name="keywords" content="ruby,documentation,README">
<meta name="description" content="README: # Écarté">
<meta name="description" content="README: Écarté Implémentation en Ruby du jeu de l&#39;Écarté. Le projet est développé progressivement au fur et à mesure de mon apprentissage de Ruby, avec pour ">
<script type="text/javascript">
@@ -64,6 +64,28 @@
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li>
<details open>
<summary> <a href="#label-C3-89cart-C3-A9">Écarté</a>
</summary>
<ul class="link-list" role="directory">
<li> <a href="#label-Documentation">Documentation</a>
<li> <a href="#label-Lancer+le+jeu">Lancer le jeu</a>
<li> <a href="#label-C3-89tat+du+projet">État du projet</a>
</ul>
</details>
</li>
</ul>
</div>
<div id="fileindex-section" class="nav-section">
<h3>Pages</h3>
@@ -86,5 +108,24 @@
<h1 id="label-C3-89cart-C3-A9">Écarté<span><a href="#label-C3-89cart-C3-A9">&para;</a> <a href="#top">&uarr;</a></span></h1>
<p>Implémentation en Ruby du jeu de l’Écarté.</p>
<p>Le projet est développé progressivement au fur et à mesure de mon apprentissage de Ruby, avec pour premier objectif de permettre une partie à deux joueurs dans le terminal.</p>
<h2 id="label-Documentation">Documentation<span><a href="#label-Documentation">&para;</a> <a href="#top">&uarr;</a></span></h2>
<p>La documentation générée avec RDoc est disponible ici :</p>
<p><a href="https://docs.netig.net/ecarte">docs.netig.net/ecarte</a>/</p>
<h2 id="label-Lancer+le+jeu">Lancer le jeu<span><a href="#label-Lancer+le+jeu">&para;</a> <a href="#top">&uarr;</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">ruby</span> <span class="ruby-identifier">main</span>.<span class="ruby-identifier">rb</span>
</pre>
<h2 id="label-C3-89tat+du+projet">État du projet<span><a href="#label-C3-89tat+du+projet">&para;</a> <a href="#top">&uarr;</a></span></h2>
<p>Le jeu des plis est en cours d’implémentation. Les règles complètes de l’Écarté seront ajoutées progressivement.</p>
</main>
+3 -3
View File
@@ -1,8 +1,8 @@
Thu, 08 Oct 2026 19:38:51 +0200
/home/julien/src/ecarte/README.md Tue, 06 Oct 2026 15:31:12 +0200
Thu, 08 Oct 2026 21:05:51 +0200
/home/julien/src/ecarte/README.md Thu, 08 Oct 2026 21:05:03 +0200
/home/julien/src/ecarte/lib/card.rb Thu, 08 Oct 2026 19:34:18 +0200
/home/julien/src/ecarte/lib/deck.rb Thu, 08 Oct 2026 19:33:38 +0200
/home/julien/src/ecarte/lib/game.rb Thu, 08 Oct 2026 19:33:06 +0200
/home/julien/src/ecarte/lib/player.rb Thu, 08 Oct 2026 19:32:32 +0200
/home/julien/src/ecarte/lib/terminal_ui.rb Thu, 08 Oct 2026 19:37:44 +0200
/home/julien/src/ecarte/main.rb Thu, 08 Oct 2026 18:35:18 +0200
/home/julien/src/ecarte/main.rb Thu, 08 Oct 2026 19:41:38 +0200
+1 -1
View File
@@ -1 +1 @@
var search_data = {"index":{"searchIndex":["card","deck","game","player","terminalui","add_point()","change_dealer()","choose_card()","clear_hand()","deal()","debug_game()","determine_dealer()","display_trick_winner()","display_wrong_card()","draw()","game_winner()","new()","new()","new()","new()","other_player()","play()","play()","play_trick()","receive()","shuffle()","stock()","strength()","to_s()","valid_follow_card?()","readme"],"longSearchIndex":["card","deck","game","player","terminalui","player#add_point()","game#change_dealer()","terminalui#choose_card()","player#clear_hand()","game#deal()","terminalui#debug_game()","game#determine_dealer()","terminalui#display_trick_winner()","terminalui#display_wrong_card()","deck#draw()","game#game_winner()","card::new()","deck::new()","game::new()","player::new()","game#other_player()","game#play()","player#play()","game#play_trick()","player#receive()","deck#shuffle()","game#stock()","card#strength()","card#to_s()","game#valid_follow_card?()",""],"info":[["Card","","Card.html","","<p>Représente une carte à jouer avec sa valeur et sa couleur.\n"],["Deck","","Deck.html","","<p>Représente un paquet de cartes et gère son contenu.\n"],["Game","","Game.html","","<p>Gère le déroulement et les règles d’une partie d’Écarté.\n"],["Player","","Player.html","","<p>Représente un joueur, sa main et son score.\n"],["TerminalUI","","TerminalUI.html","","<p>Gère l’affichage et les saisies dans le terminal.\n"],["add_point","Player","Player.html#method-i-add_point","()","<p>Ajoute un point au joueur.\n"],["change_dealer","Game","Game.html#method-i-change_dealer","()","<p>Échange les rôles de donneur et de non-donneur.\n"],["choose_card","TerminalUI","TerminalUI.html#method-i-choose_card","(player)","<p>Demande au joueur de choisir une carte et la retourne.\n"],["clear_hand","Player","Player.html#method-i-clear_hand","()","<p>Vide la main du joueur.\n"],["deal","Game","Game.html#method-i-deal","()","<p>Distribue les cartes et pose la retourne.\n"],["debug_game","TerminalUI","TerminalUI.html#method-i-debug_game","(game)","<p>Affiche les informations de débogage.\n"],["determine_dealer","Game","Game.html#method-i-determine_dealer","()","<p>Simule une coupe pour déterminer quel joueur sera le donneur.\n"],["display_trick_winner","TerminalUI","TerminalUI.html#method-i-display_trick_winner","(player)","<p>Affiche le joueur ayant remporté le pli.\n"],["display_wrong_card","TerminalUI","TerminalUI.html#method-i-display_wrong_card","()","<p>Affiche un avertissement si le coup joué ne respecte pas les règles.\n"],["draw","Deck","Deck.html#method-i-draw","()","<p>Retire et retourne la dernière carte du paquet.\n"],["game_winner","Game","Game.html#method-i-game_winner","()","<p>Retourne le joueur ayant le meilleur score.\n"],["new","Card","Card.html#method-c-new","(value, suit)",""],["new","Deck","Deck.html#method-c-new","()",""],["new","Game","Game.html#method-c-new","(player_name1, player_name2)",""],["new","Player","Player.html#method-c-new","(name)",""],["other_player","Game","Game.html#method-i-other_player","(player)","<p>Retourne l’autre joueur.\n"],["play","Game","Game.html#method-i-play","()","<p>Joue une partie.\n"],["play","Player","Player.html#method-i-play","(card)","<p>Retire une carte de la main du joueur.\n"],["play_trick","Game","Game.html#method-i-play_trick","(lead_player, follow_player)","<p>Joue un pli.\n"],["receive","Player","Player.html#method-i-receive","(card)","<p>Ajoute une carte à la main du joueur.\n"],["shuffle","Deck","Deck.html#method-i-shuffle","()","<p>Mélange les cartes du paquet.\n"],["stock","Game","Game.html#method-i-stock","()","<p>Retourne les cartes restantes dans le talon.\n"],["strength","Card","Card.html#method-i-strength","()","<p>Retourne la force de la carte sous forme d’integer.\n"],["to_s","Card","Card.html#method-i-to_s","()","<p>Retourne une représentation de la carte sous forme de string.\n"],["valid_follow_card?","Game","Game.html#method-i-valid_follow_card-3F","(follow_player, lead_card, follow_card)","<p>Vérifie si le coup du second joueur respecte les règles.\n"],["README","","README_md.html","","<p>Écarté\n"]]}}
var search_data = {"index":{"searchIndex":["card","deck","game","player","terminalui","add_point()","change_dealer()","choose_card()","clear_hand()","deal()","debug_game()","determine_dealer()","display_trick_winner()","display_wrong_card()","draw()","game_winner()","new()","new()","new()","new()","other_player()","play()","play()","play_trick()","receive()","shuffle()","stock()","strength()","to_s()","valid_follow_card?()","readme"],"longSearchIndex":["card","deck","game","player","terminalui","player#add_point()","game#change_dealer()","terminalui#choose_card()","player#clear_hand()","game#deal()","terminalui#debug_game()","game#determine_dealer()","terminalui#display_trick_winner()","terminalui#display_wrong_card()","deck#draw()","game#game_winner()","card::new()","deck::new()","game::new()","player::new()","game#other_player()","game#play()","player#play()","game#play_trick()","player#receive()","deck#shuffle()","game#stock()","card#strength()","card#to_s()","game#valid_follow_card?()",""],"info":[["Card","","Card.html","","<p>Représente une carte à jouer avec sa valeur et sa couleur.\n"],["Deck","","Deck.html","","<p>Représente un paquet de cartes et gère son contenu.\n"],["Game","","Game.html","","<p>Gère le déroulement et les règles d’une partie d’Écarté.\n"],["Player","","Player.html","","<p>Représente un joueur, sa main et son score.\n"],["TerminalUI","","TerminalUI.html","","<p>Gère l’affichage et les saisies dans le terminal.\n"],["add_point","Player","Player.html#method-i-add_point","()","<p>Ajoute un point au joueur.\n"],["change_dealer","Game","Game.html#method-i-change_dealer","()","<p>Échange les rôles de donneur et de non-donneur.\n"],["choose_card","TerminalUI","TerminalUI.html#method-i-choose_card","(player)","<p>Demande au joueur de choisir une carte et la retourne.\n"],["clear_hand","Player","Player.html#method-i-clear_hand","()","<p>Vide la main du joueur.\n"],["deal","Game","Game.html#method-i-deal","()","<p>Distribue les cartes et pose la retourne.\n"],["debug_game","TerminalUI","TerminalUI.html#method-i-debug_game","(game)","<p>Affiche les informations de débogage.\n"],["determine_dealer","Game","Game.html#method-i-determine_dealer","()","<p>Simule une coupe pour déterminer quel joueur sera le donneur.\n"],["display_trick_winner","TerminalUI","TerminalUI.html#method-i-display_trick_winner","(player)","<p>Affiche le joueur ayant remporté le pli.\n"],["display_wrong_card","TerminalUI","TerminalUI.html#method-i-display_wrong_card","()","<p>Affiche un avertissement si le coup joué ne respecte pas les règles.\n"],["draw","Deck","Deck.html#method-i-draw","()","<p>Retire et retourne la dernière carte du paquet.\n"],["game_winner","Game","Game.html#method-i-game_winner","()","<p>Retourne le joueur ayant le meilleur score.\n"],["new","Card","Card.html#method-c-new","(value, suit)",""],["new","Deck","Deck.html#method-c-new","()",""],["new","Game","Game.html#method-c-new","(player_name1, player_name2)",""],["new","Player","Player.html#method-c-new","(name)",""],["other_player","Game","Game.html#method-i-other_player","(player)","<p>Retourne l’autre joueur.\n"],["play","Game","Game.html#method-i-play","()","<p>Joue une partie.\n"],["play","Player","Player.html#method-i-play","(card)","<p>Retire une carte de la main du joueur.\n"],["play_trick","Game","Game.html#method-i-play_trick","(lead_player, follow_player)","<p>Joue un pli.\n"],["receive","Player","Player.html#method-i-receive","(card)","<p>Ajoute une carte à la main du joueur.\n"],["shuffle","Deck","Deck.html#method-i-shuffle","()","<p>Mélange les cartes du paquet.\n"],["stock","Game","Game.html#method-i-stock","()","<p>Retourne les cartes restantes dans le talon.\n"],["strength","Card","Card.html#method-i-strength","()","<p>Retourne la force de la carte sous forme d’integer.\n"],["to_s","Card","Card.html#method-i-to_s","()","<p>Retourne une représentation de la carte sous forme de string.\n"],["valid_follow_card?","Game","Game.html#method-i-valid_follow_card-3F","(follow_player, lead_card, follow_card)","<p>Vérifie si le coup du second joueur respecte les règles.\n"],["README","","README_md.html","","<p>Écarté\n<p>Implémentation en Ruby du jeu de l’Écarté.\n<p>Le projet est développé progressivement au fur et …\n"]]}}
Binary file not shown.
+3
View File
@@ -82,6 +82,9 @@
<ul>
<li><a href="README_md.html#label-C3-89cart-C3-A9">Écarté</a>
<li><a href="README_md.html#label-Documentation">Documentation</a>
<li><a href="README_md.html#label-Lancer+le+jeu">Lancer le jeu</a>
<li><a href="README_md.html#label-C3-89tat+du+projet">État du projet</a>
</ul>
</li>
</ul>