Player class javadoc

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/Player.java

@@ -11,6 +11,12 @@ public class Player {
     private final Portfolio portfolio;
     private final TransactionArchive transactionArchive;
 
+    /**
+     * Creates a new player with a given name and starting capital.
+     *
+     * @param name          the name of the player
+     * @param startingMoney the starting amount of money
+     */
     public Player(String name, BigDecimal startingMoney) {
         this.name = name;
         this.startingMoney = startingMoney;
@@ -19,26 +25,56 @@ public Player(String name, BigDecimal startingMoney) {
         this.transactionArchive = new TransactionArchive();
     }
 
+    /**
+     * Returns the name of the player.
+     *
+     * @return the player's name
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * Returns the players current balance.
+     *
+     * @return the current amount of money
+     */
     public BigDecimal getMoney() {
         return money;
     }
 
+    /**
+     * Adds money to the players balance.
+     *
+     * @param amount the amount to add
+     */
     public void addMoney(BigDecimal amount) {
         money = money.add(amount);
     }
 
+    /**
+     * Withdraws money from the players balance.
+     *
+     * @param amount the amount to withdraw
+     */
     public void withdrawMoney(BigDecimal amount) {
         money = money.subtract(amount);
     }
 
+    /**
+     * Returns the players portfolio.
+     *
+     * @return the portfolio
+     */
     public Portfolio getPortfolio() {
         return portfolio;
     }
 
+    /**
+     * Returns the players transaction archive.
+     *
+     * @return the transaction archive
+     */
     public TransactionArchive getTransactionArchive() {
         return transactionArchive;
     }