https://github.com/cerus/java-documenter

Generates Java documentation in form of a Markdown file.
https://github.com/cerus/java-documenter

documentation documentation-generator documentation-tool java

Last synced: over 1 year ago
JSON representation

Generates Java documentation in form of a Markdown file.

• Host: GitHub
• URL: https://github.com/cerus/java-documenter
• Owner: cerus
• License: gpl-3.0
• Created: 2020-03-10T20:20:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-12T12:16:43.000Z (over 6 years ago)
• Last Synced: 2025-01-24T17:44:48.223Z (over 1 year ago)
• Topics: documentation, documentation-generator, documentation-tool, java
• Language: Java
• Homepage:
• Size: 94.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![GitHub](https://img.shields.io/github/license/RealCerus/java-documenter)](https://github.com/RealCerus/java-documenter/blob/master/LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/098ee136153a4f44bcb68000aecadcf9)](https://www.codacy.com/manual/RealCerus/java-documenter?utm_source=github.com&utm_medium=referral&utm_content=RealCerus/java-documenter&utm_campaign=Badge_Grade) ![Discord](https://img.shields.io/discord/405752989182197760) [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat)](#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](https://img.shields.io/github/downloads/RealCerus/java-documenter/latest/total)](https://github.com/RealCerus/java-documenter/releases/latest)

## 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](https://github.com/RealCerus/java-documenter/tree/master/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](https://allcontributors.org/docs/en/emoji-key)):

  

    
Maximilian D.
💻 📖 💡

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## License

This project is licensed under the [GPLv3](https://github.com/RealCerus/java-documenter/blob/master/LICENSE).