Completed Javadoc.

ef29e55f · BEAUVAIS ANTOINE · 2520320c · ef29e55f · ef29e55f · ef29e55f
Commit ef29e55f authored 3 years ago by BEAUVAIS ANTOINE
--- a/build.gradle
+++ b/build.gradle
@@ -24,6 +24,11 @@ dependencies {
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 }

+javadoc {
+    title = "SIL ERP BACK 0.0.1 API Specification"
+    options.overview = "src/main/java/overview.html"
+}
+
 test {
 	useJUnitPlatform()
 }
--- a/gradle.properties
+++ b/gradle.properties
@@ -2,3 +2,5 @@ version=1.0

 license=https://cecill.info/licences/Licence_CeCILL-B_V1-fr.html
 netbeans.license=cecill-b
+
+org.gradle.warning.mode=all
\ No newline at end of file
--- a/settings.gradle
+++ b/settings.gradle
-rootProject.name = 'erp.back'
+rootProject.name = 'SIL ERP BACK'
--- a/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java
+++ b/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java
@@ -89,7 +89,7 @@ public class WebMvcConfig implements WebMvcConfigurer {
     * Currently, interceptors are only used for authentication in this 
     * application.
     * 
-     * @param registry 
+     * @param registry the Interceptor Registry to use for additions.
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

--- a/src/main/java/fr/unistra/sil/erp/back/controller/api/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/package-info.java
+/**
+ * API implementations of the HTTP controllers.
+ */
+package fr.unistra.sil.erp.back.controller.api;
\ No newline at end of file
--- a/src/main/java/fr/unistra/sil/erp/back/controller/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/controller/package-info.java
+/**
+ * Controller interfaces to handle HTTP requests.
+ * 
+ * Controllers are responsible for processing requests once they have 
+ * been approved by interceptors.
+ */
+package fr.unistra.sil.erp.back.controller;
\ No newline at end of file
--- a/src/main/java/fr/unistra/sil/erp/back/db/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/db/package-info.java
+/**
+ * Database interfaces and implementations.
+ */
+package fr.unistra.sil.erp.back.db;
\ No newline at end of file
--- a/src/main/java/fr/unistra/sil/erp/back/interceptor/api/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/interceptor/api/package-info.java
+/**
+ * API Interceptors for the HTTP requests.
+ * 
+ * Interceptors are run between the user's request and the associated 
+ * controller. They allow for pre-processing and post-processing of HTTP
+ * requests beyond their respective controllers.
+ */
+package fr.unistra.sil.erp.back.interceptor.api;
\ No newline at end of file
--- a/src/main/java/fr/unistra/sil/erp/back/model/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/model/package-info.java
+/**
+ * Model classes for the module's objects.
+ * 
+ * These are the main classes that represent the data manipulated by 
+ * the application, such as transactions, items, registry entries, etc.
+ */
+package fr.unistra.sil.erp.back.model;
\ No newline at end of file
--- a/src/main/java/fr/unistra/sil/erp/back/package-info.java
+++ b/src/main/java/fr/unistra/sil/erp/back/package-info.java
+/**
+ * BACK module for the ERP solution.
+ * 
+ * The objective of this program is to provide financial documentation 
+ * on request as well as provide item information to the other modules.
+ * 
+ * The application is split in two components:
+ * <ul>
+ * <li>RESTful API for interoperability with the other components,
+ * <li>Web interface for regular Human-Machine Interface (HMI) interactions.
+ * </ul>
+ * 
+ * Notice: Only the API is currently implemented (partially) for now.
+ * 
+ * @version 0.0.1
+ * @author BEAUVAIS ANTOINE
+ */
+package fr.unistra.sil.erp.back;
\ No newline at end of file
--- a/src/main/java/overview.html
+++ b/src/main/java/overview.html
+<!DOCTYPE html>
+<!--
+CONTRAT DE LICENCE DE LOGICIEL LIBRE CeCILL-B
+https://cecill.info/licences/Licence_CeCILL-B_V1-fr.html
+-->
+<body>
+    <p>This is the BACK module for the 2021-2022 M2 SIL ERP project.</p>
+
+    <p>This module is responsible for providing item information to the 
+        other components as well as provide financial documentation.</p>
+
+    <p>It is divided in two components:</p>
+    <ul>
+        <li>a RESTful API for interoperability between the components, and</li>
+        <li>a Web interface for managing the software and data.</li>
+    </ul>
+
+    <p>Currently, only the RESTful API is partially implemented.</p>
+</body>
\ No newline at end of file