From fcb0b50468f2a529dc4e0ee3aec111d2bc60a4a2 Mon Sep 17 00:00:00 2001 From: Nathan Lum <33772546+Templarre@users.noreply.github.com> Date: Mon, 25 Feb 2019 17:45:06 -0700 Subject: [PATCH] Added Javadocs comments --- src/Start.java | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/src/Start.java b/src/Start.java index 4fd7ee8..8f5f72a 100644 --- a/src/Start.java +++ b/src/Start.java @@ -3,21 +3,41 @@ public class Start { private Player player; + /** + * getter method for obtaining a player object. + * + * @return returns player object + */ public Player getPlayer() { Player playerTemp = new Player(player); return playerTemp; } + /** + * setter method that takes in a Player object as an argument. + * + * @param player object of the class Player + */ public void setPlayer(Player player) { Player playerTemp = new Player(player); this.player = playerTemp; } + /** + * Asks the user to input the name that they would like to be called in the game + * + * @param name the name that you would like to be called in the game + */ public void setFirm (String name) { if (name.length() <= 22) { player.setName(name); } } + + /** + * Initializes the game by asking for your name and if you would like to start with either: 1) money and a debt or + * 2) guns and no cash/debt. + */ public void initialize() { Scanner userInput = new Scanner(System.in); @@ -46,6 +66,10 @@ public class Start } + /** + * Copy constructor. + * @param player object of the class Player + */ public Start(Player player) { Player playerTemp = new Player(player);