From 55df54e5dbf26e6824123410784d00aa793c3781 Mon Sep 17 00:00:00 2001
From: Yuuta Liang <yuutaw@students.cs.ubc.ca>
Date: Sat, 14 Oct 2023 07:53:12 +0800
Subject: Fix comments in UI

Signed-off-by: Yuuta Liang <yuutaw@students.cs.ubc.ca>
---
 src/main/ui/TemplatesScreen.java | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'src/main/ui/TemplatesScreen.java')

diff --git a/src/main/ui/TemplatesScreen.java b/src/main/ui/TemplatesScreen.java
index 9b0bf3e..3bdbebe 100644
--- a/src/main/ui/TemplatesScreen.java
+++ b/src/main/ui/TemplatesScreen.java
@@ -2,6 +2,9 @@ package ui;
 
 import model.ca.Template;
 
+/**
+ * The screen that allows users to list templates and manage them.
+ */
 public class TemplatesScreen implements UIHandler {
     private final JCA session;
 
@@ -12,6 +15,9 @@ public class TemplatesScreen implements UIHandler {
         this.session = session;
     }
 
+    /**
+     * EFFECTS: Print help.
+     */
     @Override
     public void help() {
         System.out.println("show\tList templates\n"
@@ -23,6 +29,9 @@ public class TemplatesScreen implements UIHandler {
                 + "help\tPrint this message");
     }
 
+    /**
+     * EFFECTS: List templates in Name[ENABLED / DISABLED] Subject Validity format.
+     */
     @Override
     public void show() {
         session.getTemplates().forEach(tem ->
@@ -33,6 +42,9 @@ public class TemplatesScreen implements UIHandler {
                         tem.getValidity()));
     }
 
+    /**
+     * EFFECTS: Create a new template with the given name and switch to the template set screen.
+     */
     private void handleAdd(String... args) {
         if (args.length <= 1) {
             System.out.println("Usage: add <name>");
@@ -47,6 +59,10 @@ public class TemplatesScreen implements UIHandler {
                 new Template(args[1], false, null, 30));
     }
 
+    /**
+     * EFFECTS: Handle the enable / disable commands.
+     * MODIFIES: session
+     */
     private void handleEnableDisable(boolean enable, String... args) {
         if (args.length <= 1) {
             System.out.printf("Usage: %s <template>\n", enable ? "enable" : "disable");
@@ -61,6 +77,10 @@ public class TemplatesScreen implements UIHandler {
         session.log("A template was enabled / disabled.");
     }
 
+    /**
+     * EFFECTS: Handle the delete command
+     * MODIFIES: session
+     */
     private void handleDelete(String... args) {
         if (args.length <= 1) {
             System.out.println("Usage: delete <template>");
@@ -75,6 +95,9 @@ public class TemplatesScreen implements UIHandler {
         session.log("A template was deleted.");
     }
 
+    /**
+     * EFFECTS: Handle commands.
+     */
     @Override
     public void command(String... args) {
         switch (args[0]) {
@@ -96,11 +119,17 @@ public class TemplatesScreen implements UIHandler {
         }
     }
 
+    /**
+     * EFFECTS: Go to main menu.
+     */
     @Override
     public Screen exit() {
         return Screen.MAIN;
     }
 
+    /**
+     * EFFECTS: Return "/templates/ %"
+     */
     @Override
     public String getPS1() {
         return "/templates/ %";
-- 
cgit v1.2.3