This project show some techniques to extract documentation from your project like:
-
Extract code documentation (javadoc)
-
Use annotation
-
Extract xml information
-
Execute code to find values
-
Formating documentation
-
Generate graph
It’s also present use cases like:
-
Create a glossary
-
Retrieve good example from code
-
Visualize workflow
-
Document tests
-
Visualize dependencies
-
Create a release note
Prerequisites
-
JDK 11
-
Maven
-
Docker
This project is auto-documented. To generate full documentation, just call
. ./generateDoc.shDocumentation is generated in ./target/docs folder.
A generated documentation is already available here: https://sfauvel.github.io/livingdocumentation