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/TemplateSetScreen.java | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

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

diff --git a/src/main/ui/TemplateSetScreen.java b/src/main/ui/TemplateSetScreen.java
index 9a31f50..42f393b 100644
--- a/src/main/ui/TemplateSetScreen.java
+++ b/src/main/ui/TemplateSetScreen.java
@@ -3,6 +3,9 @@ package ui;
 import model.asn1.exceptions.ParseException;
 import model.ca.Template;
 
+/**
+ * The screen that modifies the properties of a single template and add it to the store.
+ */
 public class TemplateSetScreen implements UIHandler {
     private final JCA session;
 
@@ -15,6 +18,9 @@ public class TemplateSetScreen implements UIHandler {
 
     private Template template;
 
+    /**
+     * EFFECTS: Print help
+     */
     @Override
     public void help() {
         System.out.println("show\tView the current template settings\n"
@@ -24,6 +30,10 @@ public class TemplateSetScreen implements UIHandler {
                 + "help\tPrint this help message\n");
     }
 
+    /**
+     * EFFECTS: Parse and set / unset the subject of the template
+     * MODIFIES: this#template
+     */
     private void handleSetSubject(String val) {
         try {
             template.setSubject(val);
@@ -32,6 +42,10 @@ public class TemplateSetScreen implements UIHandler {
         }
     }
 
+    /**
+     * EFFECTS: Set the validity of the template to the given integer
+     * MODIFIES: this#template
+     */
     private void handleSetValidity(String val) {
         if (val == null) {
             System.out.println("Cannot unset validity");
@@ -49,6 +63,10 @@ public class TemplateSetScreen implements UIHandler {
         }
     }
 
+    /**
+     * EFFECTS: Handle the `set` command.
+     * MODIFIES: this#template
+     */
     private void handleSet(String... args) {
         if (args.length != 2 && args.length != 3) {
             System.out.println("Usage: set <key> <value>");
@@ -89,6 +107,9 @@ public class TemplateSetScreen implements UIHandler {
         System.out.println("Validity:\t" + template.getValidity() + " days");
     }
 
+    /**
+     * EFFECTS: Handle commands
+     */
     @Override
     public void command(String... args) {
         switch (args[0]) {
-- 
cgit v1.2.3