plantuml/plantuml
View on GitHub[Wanted feature][docs] Improve Doc (JavaDoc, GH) [`package-info.java`, `readme.md`]
Open
#1547 opened on Sep 24, 2023
documentationgood first issue
Description
Hello PlantUML team, and all,
Here is a wanted feature, (to continue #1520):
- It will be good to improve the source doc (JavaDoc, GH site) of this project, with adding
package-info.javaand perhaps alsoreadme.mdfiles.
Ref.:
- https://rules.sonarsource.com/java/tag/convention/RSPEC-1228/
- https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#packagecomment
- https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
- https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDBFGCF
- https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDJGIJB
Adding new ref.:
Regards, Th.