Javadoc Joueur

Author: Pierre36

src/main/java/org/ecn/medev/Joueur.java

@@ -6,45 +6,60 @@
 import java.util.Random;
 /**
  * Classe Joueur
- * @author erwan
+ * @author Erwan
  */
 public class Joueur {
 
-    /** Le nom du joueur. */
+    /** 
+     * Le nom du joueur. 
+     */
     private String nom;
-    /** La fortune du joueur. */
+    
+    /** 
+     * La fortune du joueur. 
+     */
     private int fortune;
-    /** La position du joueur. */
+    
+    /** 
+     * La position du joueur. 
+     */
     private int position;
 
     /** Constructeur de Joueur.
-     * @param nom Nom du Joueur.
-     * @param fortune Fortune du Joueur.
-     * @param position Position du Joueur.
+     * @param nom le nom du Joueur.
+     * @param fortune la fortune du Joueur.
+     * @param position la position du Joueur.
     */
     public Joueur(String nom, int fortune, int position) {
         this.nom = nom;
         this.fortune = fortune;
         this.position = position;
     }
 
-    /** Constructeur par defaut de Joueur avec nom. */
+    /** 
+     * Constructeur par defaut de Joueur avec nom. 
+     * @param nom le nom du joueur
+     */
     public Joueur(String nom) {
         this.nom = nom;
         this.fortune = 100000;
         this.position = 0;       
     }
 
-    /** Constructeur par defaut de Joueur. */
+    /** 
+     * Constructeur par defaut de Joueur. 
+     */
     public Joueur() {
         this.nom = "Jacques";
         this.fortune = 100000;
         this.position = 0;       
     }
 
-    /** Paiement d'un autre joueur.
+    /** 
+     * Paiement d'un autre joueur.
      * @param cout cout du paiement.
      * @param j Joueur a payer.
+     * @throws org.ecn.medev.NoMoreMoney
     */    
     public void payer(int cout, Joueur j) throws NoMoreMoney {
         if(this.fortune > cout) {
@@ -58,8 +73,10 @@ public void payer(int cout, Joueur j) throws NoMoreMoney {
         }
     }
 
-    /** Paiement a la banque.
+    /** 
+     * Paiement a la banque.
      * @param cout cout du paiement.
+     * @throws org.ecn.medev.NoMoreMoney
     */    
     public void payer(int cout) throws NoMoreMoney {
         if(this.fortune > cout) {
@@ -71,41 +88,67 @@ public void payer(int cout) throws NoMoreMoney {
         }
     }
 
+    /**
+     * Renvoie le nom du joueur.
+     * @return le nom
+     */
     public String getNom() {
         return nom;
     }
 
+    /**
+     * Définit le nom du joueur.
+     * @param nom le nouveau nom
+     */
     public void setNom(String nom) {
         this.nom = nom;
     }
 
+    /**
+     * Renvoie la fortune du joueur.
+     * @return la fortune.
+     */
     public int getFortune() {
         return fortune;
     }
 
+    /**
+     * Définit la fortune du joueur.
+     * @param fortune la nouvelle fortune
+     */
     public void setFortune(int fortune) {
         this.fortune = fortune;
     }
 
+    /**
+     * Renvoie la position du joueur.
+     * @return la position
+     */
     public int getPosition() {
         return position;
     }
 
+    /**
+     * Définit la position du joueur.
+     * @param position la nouvelle position
+     */
     public void setPosition(int position) {
         this.position = position;
     }
 
     /**
-     * méthode qui retourne une valeur aléatoire représentant la valeur d'un dé lancé
-     * @return deval un entier qui represente la valeur du dé lancé
+     * Retourne une valeur aléatoire représentant la valeur d'un dé lancé.
+     * @return un entier qui represente la valeur du dé lancé
      */
     public static int lanceLeDe() {
         int deval = (int) Math.floor(Math.random()*6+1);
         return deval;
     }
+    
+    
     /**
-     * Le joueur avance d'un nb de cases
-     * @param nbCase
+     * Le joueur avance d'un nombre de cases.
+     * @param nbCase le nombre de case dont on avance
      */
     public void avancer(int nbCase){
         for(int i=1; i<nbCase+1; i++){
@@ -116,6 +159,10 @@ public void avancer(int nbCase){
         }
     }
 
+    /**
+     * Renvoie une chaine de caractères représentant le joueur.
+     * @return la chaine de caractères
+     */
     @Override
     public String toString() {
         return "Joueur{" +
@@ -124,8 +171,10 @@ public String toString() {
                 '}' + " Il a les finances suivantes: " + fortune;
     }
 
+    /**
+     * Gère le tour de jeu.
+     */
     public void tourDeJeu(){
         int de = lanceLeDe();
-
     }
 }