nanoeth
nanoeth copied to clipboard
Auto-generate package-info.java from README.md
Javadoc supports adding package-level documentation, by adding it in a package-info.java
file in the package.
See this link to see what that looks like.
Currently, there is a lot of useful documentation in README.md
files in most packages, however this information is not being carried over to the Javadoc, creating an unfortunate fragmentation of the documentation.
It would be neat if someone could come up with a script that would automatically render the Markdown to HTML, then take that HTML and wrap it in a package-info.java
file.
Bonus points if this can be done entirely from within the Gradle build script.
As a first easy step, it would be nice to:
- [ ] add links to README files in manually create
package-info.java
files