FInal

kinbald · Apr 16, 2017 · babff33 · babff33
1 parent 9cf9651
commit babff33
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 25 deletions.
diff --git a/App/modules/moteur.c b/App/modules/moteur.c
@@ -16,7 +16,7 @@ extern PLATEAU plateau_jeu;
 extern SCORE scores[2];
 
 /*!
- * \brief décalage des pions
+ * \brief Décalage des pions
  * @param plateau Plateau du jeu à accéder
  * @param colonnePiochee Colonne de la case piochée
  * @param lignePiochee Ligne de la case piochée
@@ -195,7 +195,7 @@ int decalage(PLATEAU * plateau, int colonnePiochee, int lignePiochee, int colonn
 }
 
 /*!
- * \brief verification de la victoire d'un joueur par les lignes'
+ * \brief Vérification de la victoire d'un joueur par les lignes
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
@@ -227,7 +227,7 @@ int testeVictoireLigne1V1(PLATEAU * plateau, int joueurCourant)
 }
 
 /*!
- * \brief verification de la victoire d'un joueur par les colonnes
+ * \brief Vérification de la victoire d'un joueur par les colonnes
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
@@ -258,7 +258,7 @@ int testeVictoireColonne1V1(PLATEAU * plateau, int joueurCourant)
 }
 
 /*!
- * \brief verification de la victoire d'un joueur par la diagonale de gauche haut vers droite bas
+ * \brief Vérification de la victoire d'un joueur par la diagonale de gauche haut vers droite bas
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
@@ -284,7 +284,7 @@ int testeVictoireDiagonaleG1V1(PLATEAU * plateau, int joueurCourant)
 }
 
 /*!
- * \brief verification de la victoire d'un joueur par la diagonale de gauche bas vers droite haut
+ * \brief Vérification de la victoire d'un joueur par la diagonale de gauche bas vers droite haut
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
@@ -311,7 +311,7 @@ int testeVictoireDiagonaleD1V1(PLATEAU * plateau, int joueurCourant)
 }
 
 /*!
- * \brief verification de la victoire en 2V2 d'un joueur par les ligne
+ * \brief Vérification de la victoire en 2V2 d'un joueur par les lignes
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -344,7 +344,7 @@ int testeVictoireLigne2V2(PLATEAU * plateau, int joueurCourant, int joueurAllier
 }
 
 /*!
- * \brief verification de la victoire en 2V2 d'un joueur par les colonnes
+ * \brief Vérification de la victoire en 2V2 d'un joueur par les colonnes
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -375,7 +375,7 @@ int testeVictoireColonne2V2(PLATEAU * plateau, int joueurCourant, int joueurAlli
 }
 
 /*!
- * \brief verification de la victoire en 2V2 d'un joueur par la  diagonale de gauche haut vers droite bas
+ * \brief Vérification de la victoire en 2V2 d'un joueur par la diagonale de gauche haut vers droite bas
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -403,7 +403,7 @@ int testeVictoireDiagonaleG2V2(PLATEAU * plateau, int joueurCourant, int joueurA
 }
 
 /*!
- * \brief verification de la victoire d'un joueur en 2V2 par la diagonale de gauche bas vers droite haut
+ * \brief Vérification de la victoire d'un joueur en 2V2 par la diagonale de gauche bas vers droite haut.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -431,8 +431,8 @@ int testeVictoireDiagonaleD2V2(PLATEAU * plateau, int joueurCourant, int joueurA
 }
 
 /*!
- * \brief appel des fonctions de test de victiore pour le mode 2v2 et 1V1
- * \brief /!\ si on est en mode 1V1 alors  joueurAllier = 0
+ * \brief Appel des fonctions de test de victoire pour le mode 2v2 et 1V1. /!\ si on est en mode 1V1 alors joueurAllier = 0
+ *
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -551,7 +551,7 @@ int verifieSymbole(PLATEAU * plateau, CASE * clicJoueur, int joueurCourant)
 }
 
 /*!
- * \brief Fonction qui déterminer les cases où le joueur peut déposer le cube qu'il a pioché
+ * \brief Fonction qui détermine les cases où le joueur peut déposer le cube qu'il a pioché
  * @param casePiochee Coordonnées de la case que le joueur a pioché
  * @return 0
  */

diff --git a/App/modules/moteur.h b/App/modules/moteur.h
@@ -11,7 +11,7 @@
 #include "outils.h"
 
 /*!
- * \brief décalage des pions
+ * \brief Décalage des pions.
  * @param plateau Plateau du jeu à accéder
  * @param colonnePiochee Colonne de la case piochée
  * @param lignePiochee Ligne de la case piochée
@@ -22,48 +22,47 @@
 int decalage(PLATEAU * plateau, int colonnePiochee, int lignePiochee, int colonneJouee, int ligneJouee);
 
 /*!
- * \brief verification de la victoire d'un joueur par les lignes'
+ * \brief Vérification de la victoire d'un joueur par les lignes.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
  */
 int testeVictoireLigne1V1(PLATEAU * plateau, int joueurCourant);
 
 /*!
- * \brief verification de la victoire d'un joueur par les colonnes
+ * \brief Vérification de la victoire d'un joueur par les colonnes.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
  */
 int testeVictoireColonne1V1(PLATEAU * plateau, int joueurCourant);
 
 /*!
- * \brief verification de la victoire d'un joueur par la diagonale de gauche haut vers droite bas
+ * \brief Vérification de la victoire d'un joueur par la diagonale de gauche haut vers droite bas.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
  */
 int testeVictoireDiagonaleG1V1(PLATEAU * plateau, int joueurCourant);
 
 /*!
- * \brief verification de la victoire d'un joueur par la diagonale de gauche bas vers droite haut
+ * \brief Vérification de la victoire d'un joueur par la diagonale de gauche bas vers droite haut.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @return :: joueurCourant si il a gagné sinon -1
  */
 int testeVictoireDiagonaleD1V1(PLATEAU * plateau, int joueurCourant);
 
 /*!
- * \brief verification de la victoire en 2V2 d'un joueur par les ligne
+ * \brief Vérification de la victoire en 2V2 d'un joueur par les lignes.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
  * @return :: joueurCourant si il a gagné sinon -1
  */
 int testeVictoireLigne2V2(PLATEAU * plateau, int joueurCourant, int joueurAllier);
-
 /*!
- * \brief verification de la victoire en 2V2 d'un joueur par les colonnes
+ * \brief Vérification de la victoire en 2V2 d'un joueur par les colonnes.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -72,7 +71,7 @@ int testeVictoireLigne2V2(PLATEAU * plateau, int joueurCourant, int joueurAllier
 int testeVictoireColonne2V2(PLATEAU * plateau, int joueurCourant, int joueurAllier);
 
 /*!
- * \brief verification de la victoire en 2V2 d'un joueur par la  diagonale de gauche haut vers droite bas
+ * \brief Vérification de la victoire en 2V2 d'un joueur par la diagonale de gauche haut vers droite bas.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -81,16 +80,16 @@ int testeVictoireColonne2V2(PLATEAU * plateau, int joueurCourant, int joueurAlli
 int testeVictoireDiagonaleG2V2(PLATEAU * plateau, int joueurCourant, int joueurAllier);
 
 /*!
- * \brief verification de la victoire d'un joueur en 2V2 par la diagonale de gauche bas vers droite haut
+ * \brief Vérification de la victoire d'un joueur en 2V2 par la diagonale de gauche bas vers droite haut.
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
  * @return :: joueurCourant si il a gagné sinon -1
  */
 int testeVictoireDiagonaleD2V2(PLATEAU * plateau, int joueurCourant, int joueurAllier);
+
 /*!
- * \brief appel des fonctions de test de victiore pour le mode 2v2 et 1V1
- * \brief /!\ si on est en mode 1V1 alors  joueurAllier = 0
+ * \brief Appel des fonctions de test de victoire pour le mode 2v2 et 1V1. /!\ si on est en mode 1V1 alors joueurAllier = 0
  * @param plateau Plateau du jeu à accéder
  * @param joueurCourant
  * @param joueurAllier
@@ -127,7 +126,7 @@ int testeVictoire(PLATEAU * plateau, int joueurCourant, int joueurAllier);
 int verifieSymbole(PLATEAU * plateau, CASE * clicJoueur, int joueurCourant);
 
 /*!
- * \brief Fonction qui déterminer les cases où le joueur peut déposer le cube qu'il a pioché
+ * \brief Fonction qui détermine les cases où le joueur peut déposer le cube qu'il a pioché
  * @param casePiochee Coordonnées de la case que le joueur a pioché
  * @return 0
  */

diff --git a/README.md b/README.md
@@ -1,2 +1,22 @@
 # Quixo
 Implémentation en C du jeu de plateau Quixo. Quixo est un jeu de pions abstrait dérivé du "Tic-Tac-Toc" (jeu d'alignement). Le matériel se compose d'un plateau et de 25 cubes.
+
+## Requis
+
+Paquets nécessaires :
+- Doxygen (<= 1.8.11)
+- Graphviz
+- indent
+
+## Jeu
+
+Compilation dans le dossier App/ à l'aide de la commande `make`.
+Lancement avec `./main`.
+
+Lors d'une partie en mode "1 VS IA", l'ordinateur peut mettre un temps significatif avant de jouer son tour.
+
+Le jeu se joue intégralement à l'aide de cliques gauches de souris.
+
+La touche q (Q) permet à tout moment de quitter le jeu.
+
+La touche f (F) permet de passer en mode plein écran.
diff --git a/html/mainpage.md b/html/mainpage.md
@@ -20,3 +20,4 @@ Projet réalisé par :
 - Guillaume Desrumaux
 - Marion Bouteille
 - Pierre Parrat
+- Christophe Bostyn