From 5507155f4fee4e159a94fef9b060741ec72a26de Mon Sep 17 00:00:00 2001
From: BEAUVAIS ANTOINE <antoine.beauvais@etu.unistra.fr>
Date: Mon, 27 Sep 2021 00:02:13 +0200
Subject: [PATCH] Updated Javadoc. #1
---
.../unistra/sil/erp/back/controller/web/LoginController.java | 1 +
src/main/java/fr/unistra/sil/erp/back/package-info.java | 3 ++-
src/main/java/overview.html | 3 ++-
3 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/web/LoginController.java b/src/main/java/fr/unistra/sil/erp/back/controller/web/LoginController.java
index 4dcb024..14afb70 100644
--- a/src/main/java/fr/unistra/sil/erp/back/controller/web/LoginController.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/web/LoginController.java
@@ -23,6 +23,7 @@ public class LoginController {
* Logic for handling login.
*
* TODO: Actual implementation.
+ * @return the name of the template to use.
*/
@GetMapping(MAPPING_LOGIN)
public String login()
diff --git a/src/main/java/fr/unistra/sil/erp/back/package-info.java b/src/main/java/fr/unistra/sil/erp/back/package-info.java
index 0cf38f5..4470665 100644
--- a/src/main/java/fr/unistra/sil/erp/back/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/package-info.java
@@ -10,7 +10,8 @@
* <li>Web interface for regular Human-Machine Interface (HMI) interactions.
* </ul>
*
- * Notice: Only the API is currently implemented (partially) for now.
+ * Currently, the RESTful API is partly implemented and the Web interface
+ * has only just been started.
*
* @version 0.0.1
* @author BEAUVAIS ANTOINE
diff --git a/src/main/java/overview.html b/src/main/java/overview.html
index 276c855..8979b4c 100644
--- a/src/main/java/overview.html
+++ b/src/main/java/overview.html
@@ -15,5 +15,6 @@ https://cecill.info/licences/Licence_CeCILL-B_V1-fr.html
<li>a Web interface for managing the software and data.</li>
</ul>
- <p>Currently, only the RESTful API is partially implemented.</p>
+ <p>Currently, the RESTful API is partly implemented and the Web interface
+ has only just been started.</p>
</body>
\ No newline at end of file
--
GitLab