Add reporting feature and update project documentation

A reporting feature has been added to the project. This involves building HTML documentation, which includes the results of the static code analysis (PMD and SpotBugs). Both 'QuickStart.md' and '_Index.md' files in 'documentation/de' and 'documentation/en' folders have been updated to reflect these changes. Furthermore, the 'README.md' file and Maven POM file ('pom.xml') have also been updated accordingly.
This commit is contained in:
Konrad Neitzel
2024-05-09 22:02:43 +02:00
parent 9713d79d52
commit 7cc1877ca6
6 changed files with 113 additions and 7 deletions
+13 -1
View File
@@ -27,7 +27,7 @@ aufrufen.
Um die Anwendung zu übersetzen kannst Du aufrufen:
```./mvnw package```
### Bau des Images zur weitergabe
### Bau des Images zur Weitergabe
Um das Image zu bauen, rufst du einfach Maven mit dem Profil Image und dem
Ziel install auf:
@@ -37,9 +37,21 @@ Ziel install auf:
da dieses Plugin zwingend eine Modulbeschreibung für das Projekt und alle
Abhängigkeiten erfordert.
### Komplette Übersetzung des Projekts incl. Dokumentation
Mit dem folgenden Befehl lässt sich das ganze Projekt von grundauf neu übersetzen incl.
der Erstellung der HTML Dokumentation des Projektes:
```./mvnw -Dimage clean install site```
- **-Dimage** aktiviert das Profil image, das für den Bau des Application Images zuständig ist
- **clean** Mit dem Ziel clean wird am Anfang alles, was bereits ggf. schon an Übersetzungen vorhanden ist, entfernt wird.
- **install** Durch install wird das ganze Projekt gebaut incl. Unit Tests, statischer Codeanalyse, ...
- **site** Es wird die Dokumentation des Projektes gebaut.
## Ergebnisse der statischen Codeanalyse
Die Codeanalyse läuft automatisch beim Bau des Projektes und die Ergebnisse
finden sich in:
- ./target/pmd.xml
- ./target/spotbugsXml.xml
Wenn die Site gebau wird, dann gibt es html Seiten mit den Ergebnissen von PMD und Spotbugs in der Site.
+1
View File
@@ -12,4 +12,5 @@
- [SpotBugs](SpotBugs.md)
## Sonstiges
- Reporting
- Lombok
+9
View File
@@ -33,6 +33,15 @@ To build the image, the profile Image must be used:
**Important** You cannot build an image using the javafx plugin. The javafx plugin requires that you build a modular
Java application and all dependencies providing a module description.
### complete build including documentation
To build the complete project from scratch and build all parts possible, you could use the following command:
```./mvnw -Dimage clean install site```
- **-Dimage** activates the profile image that is responsible to build the application image
- **clean** cleans everything of previous builds.
- **install** build the project (compile, build jar file, ...)
- **site** creates the html documentation of the project
## Static code analysis results
The static code analysis is done during the build of the application. The results can be found in
+1
View File
@@ -12,4 +12,5 @@
- [SpotBugs](SpotBugs.md)
## Other Topics
- Reporting
- Lombok