Skip to content

Latest commit

 

History

History
56 lines (43 loc) · 3.31 KB

README.md

File metadata and controls

56 lines (43 loc) · 3.31 KB

GitHub Codacy Badge Discord All Contributors

java-documenter

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)

Installation

From source:
Prerequisites: Git, Maven

  1. Clone this repository (git clone https://github.com/RealCerus/java-documenter)
  2. Build the jar (mvn package)
  3. The final jar is in the target folder

Releases:
GitHub Releases

Usage

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.

Examples

src/main/java/example

Todo

  • Add wildcard support for file names
  • Implement 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

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Maximilian D.

💻 📖 💡

This project follows the all-contributors specification. Contributions of any kind welcome!

License

This project is licensed under the GPLv3.