From 78ff88e7cdc9a2e33a4b7903011f3da16b8ce8cb Mon Sep 17 00:00:00 2001
From: Hykilpikonna <me@hydev.org>
Date: Sat, 23 Jan 2021 09:09:41 -0500
Subject: [PATCH] [O] Correct comments according to suggestions

---
 README.md                                                       | 2 +-
 build.gradle                                                    | 1 +
 .../java/org/hydev/clock_api/controller/UserController.java     | 1 +
 3 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f7959fd..4c5f198 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ### Setup environment
 
-1. Install Java `dnf install java-11-openjdk-devel` (And add an alias to your `.bashrc`)
+1. Install Java 11 JDK (And add an alias to your `.bashrc`)
 
 ```shell
 alias java11='/usr/lib/jvm/jre-11/bin/java'
diff --git a/build.gradle b/build.gradle
index 081bb18..939fa6d 100644
--- a/build.gradle
+++ b/build.gradle
@@ -75,6 +75,7 @@ compileTestKotlin {
     }
 }
 
+// Remove version number from jar name for deployment
 bootJar {
     archiveFileName = "${archiveBaseName.get()}.${archiveExtension.get()}"
 }
diff --git a/src/main/java/org/hydev/clock_api/controller/UserController.java b/src/main/java/org/hydev/clock_api/controller/UserController.java
index fbe634c..e76e172 100644
--- a/src/main/java/org/hydev/clock_api/controller/UserController.java
+++ b/src/main/java/org/hydev/clock_api/controller/UserController.java
@@ -71,6 +71,7 @@ public class UserController {
 
     /**
      * Create salted hash for user's password
+     * Format: "$username + $password".toLowerMd5();
      *
      * @param username Unique username used as a salt
      * @param password Password initial hash