add documentation

1 files changed, 42 insertions, 0 deletions

diff --git a/src/Q5/Citizen.java b/src/Q5/Citizen.java
index 748a848..ab13859 100644
--- a/src/Q5/Citizen.java
+++ b/src/Q5/Citizen.java
@@ -1,3 +1,11 @@
+/**
+ * Assignment 2, COMP268 Class: Citizen.java
+ *
+ * @description A citizen with an id and educational qualifiation.
+ * @author: mo khan Student ID: 3431709
+ * @date Jul 13, 2019
+ * @version 1.0
+ */
 package Q5;
 
 import java.util.*;
@@ -11,32 +19,66 @@ public class Citizen {
   public static final int UNDERGRADUATE = 2;
   private static int id = 0;
 
+  /**
+   * Creates an instance of a citizen with a specific id.
+   *
+   * @param citizenId the identifier for the citizen
+   */
   public Citizen(int citizenId) {
     this(citizenId, Citizen.generateEducationalQualification());
   }
 
+  /**
+   * Creates an instance of a citizen with a specific id and qualification.
+   *
+   * @param citizenId the identifier for the citizen
+   * @param qualification the educational qualification of the citizen
+   */
   public Citizen(int citizenId, int qualification) {
     this.citizenId = citizenId;
     this.educationalQualification = qualification;
   }
 
+  /**
+   * Returns the educational qualification
+   *
+   * @return the educational qualfication represented as an integer value.
+   */
   public int getEducationalQualification() {
     return this.educationalQualification;
   }
 
+  /**
+   * Generates a random educational qualification.
+   *
+   * @return educational qualification.
+   */
   public static int generateEducationalQualification() {
     return new Random().nextInt(4) + 1;
   }
 
+  /**
+   * Generates a unique id for a citizen.
+   *
+   * @return a new id for a citizen.
+   */
   public static int generateId() {
     id++;
     return id;
   }
 
+  /**
+   * Converts an integer to a string.
+   *
+   * @return the converted integer as a string.
+   */
   public static String convert(int i) {
     return String.valueOf(i);
   }
 
+  /**
+   * Resets the internal id counter to zero.
+   */
   public static void resetId() {
     id = 0;
   }