Contact: Meron Brouwer - meren.brouwer@han.nl

Opdracht

Maak een Maven plugin waarmee het mogelijk is om de code-snippets uit MarkDown statisch te checken tegen java-code. Eventueel moet het ook mogelijk zijn de MarkDown te verrijken, zodat Klassen die in een enkelvoudige quote staan, worden vervangen door links naar de betreffende JavaDoc. Zo'n plugin bestaat niet en zou het schrijven van documentatie van java-applicaties in MarkDown erg vergemakkelijken.

• Het moet een Maven plugin betreffen
• Het moet configureerbaar zijn waar in het project de markdown bestanden staan.
• Het moet configureerbaar zijn hoe er wordt omgegaan wanneer genoemde Klassen niet op het module/klasse-pad te vinden zijn. (waarschuwing of falende build).
• Het moet configureerbaar zijn op welke plek (lokaal of extern) de root van de javaDoc staat (zodat de links gegenereerd worden).
• Het moet configureerbaar zijn welke Klassen geskipped kunnen worden.
• Het moet configureerbaar zijn op welke plek de verrijkte MarkDown moet worden weggeschreven (ergens in de /target)

Technische Constraints/ Wensen

• Java 16
• Maven 3 & Maven 4