diff options
| author | mo khan <mo@mokhan.ca> | 2019-08-11 18:34:29 -0600 |
|---|---|---|
| committer | mo khan <mo@mokhan.ca> | 2019-08-11 18:34:29 -0600 |
| commit | ae42b62aa6e75c172e450ab397ab902c40697b9b (patch) | |
| tree | b519030b8be96c207433856eb7724af030779e92 /src/Q5 | |
| parent | d4932bfe4b6468fb4622bc9d6765d30c44d7edeb (diff) | |
fix javadoc
Diffstat (limited to 'src/Q5')
| -rw-r--r-- | src/Q5/Citizen.java | 1 | ||||
| -rw-r--r-- | src/Q5/ComputeIntellect.java | 5 | ||||
| -rw-r--r-- | src/Q5/Village.java | 15 |
3 files changed, 17 insertions, 4 deletions
diff --git a/src/Q5/Citizen.java b/src/Q5/Citizen.java index 92b836f..c5da9b8 100644 --- a/src/Q5/Citizen.java +++ b/src/Q5/Citizen.java @@ -70,6 +70,7 @@ public class Citizen { /** * Converts an integer to a string. * + * @param i the integer to convert to a string * @return the converted integer as a string. */ public static String convert(int i) { diff --git a/src/Q5/ComputeIntellect.java b/src/Q5/ComputeIntellect.java index 68db941..54ca2fb 100644 --- a/src/Q5/ComputeIntellect.java +++ b/src/Q5/ComputeIntellect.java @@ -53,7 +53,10 @@ public class ComputeIntellect { return this.undergraduate; } - /** Tallys the # of citizens with different educational qualifications. */ + /** + * Tallys the # of citizens with different educational qualifications. + * @param citizens the array of citizens to tally. + * */ public void distributionOfQualification(Citizen[] citizens) { for (Citizen citizen : citizens) switch (citizen.getEducationalQualification()) { diff --git a/src/Q5/Village.java b/src/Q5/Village.java index 47c6891..fba9c8a 100644 --- a/src/Q5/Village.java +++ b/src/Q5/Village.java @@ -20,7 +20,10 @@ public class Village { this(new ArrayList<Citizen>()); } - /** Creates an instance of a village with specific villagers. */ + /** + * Creates an instance of a village with specific villagers. + * @param citizens the list of citizens in the village + */ public Village(List<Citizen> citizens) { this.citizens = citizens; } @@ -30,7 +33,10 @@ public class Village { return this.citizens.size(); } - /** Adds a citizen to the village with a specific qualification. */ + /** + * Adds a citizen to the village with a specific qualification. + * @param qualification the qualification for the citizen + * */ public void addCitizen(int qualification) { this.citizens.add(new Citizen(Citizen.generateId(), qualification)); } @@ -45,7 +51,10 @@ public class Village { return this.citizens.toArray(new Citizen[this.citizens.size()]); } - /** The entry point to the console application. */ + /** + * The entry point to the console application. + * @param args the argument vector given to the program. + * */ public static void main(String[] args) { Scanner in = new Scanner(System.in); Village village = new Village(); |
