Generates Java documentation in form of a Markdown file.
NOTE: This software does only work for java source files (.java) and not for compiled java files (.class)
From source:
Prerequisites: Git, Maven
- Clone this repository (
git clone https://github.com/RealCerus/java-documenter
) - Build the jar (
mvn package
) - The final jar is in the
target
folder
java -jar javadocsgenerator-VERSION.jar --files=FILENAME.java,ANOTHER_FILENAME.java,... --output=JAVA_DOCS.md
NOTE: To use a class for documentation generation add a '@DocumentationScan' annotation over the class declaration and over every method which you want to use. Alternatively you can use java doc comments for methods.
Arguments:
--files
: Required. Specifies the files that should be used for documentation generation.
--output
: Optional. Will default to ./JAVA_DOC.md
. Specifies the file in which the generated documentation should be saved.
Add wildcard support for file namesImplement some sort of annotation system to replace the '//DOC' comment (It's ugly)- Parse stuff like '@since 1.0.0' or '@param xy' from java doc comments
- Make a GitHub Action
- Make a Maven plugin
- Implement feature requests
Thanks goes to these wonderful people (emoji key):
Maximilian D. 💻 📖 💡 |
This project follows the all-contributors specification. Contributions of any kind welcome!
This project is licensed under the GPLv3.