{"id":21597470,"url":"https://github.com/cerus/java-documenter","last_synced_at":"2025-03-18T11:25:53.433Z","repository":{"id":115796250,"uuid":"246399937","full_name":"cerus/java-documenter","owner":"cerus","description":"Generates Java documentation in form of a Markdown file.","archived":false,"fork":false,"pushed_at":"2020-03-12T12:16:43.000Z","size":97,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-24T17:44:48.223Z","etag":null,"topics":["documentation","documentation-generator","documentation-tool","java"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cerus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-10T20:20:34.000Z","updated_at":"2020-03-23T11:09:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"1ec959be-f770-438c-9d26-e4e2fb053805","html_url":"https://github.com/cerus/java-documenter","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cerus%2Fjava-documenter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cerus%2Fjava-documenter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cerus%2Fjava-documenter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cerus%2Fjava-documenter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cerus","download_url":"https://codeload.github.com/cerus/java-documenter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244209569,"owners_count":20416307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","documentation-generator","documentation-tool","java"],"created_at":"2024-11-24T18:09:06.889Z","updated_at":"2025-03-18T11:25:53.427Z","avatar_url":"https://github.com/cerus.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"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\u0026amp;utm_medium=referral\u0026amp;utm_content=RealCerus/java-documenter\u0026amp;utm_campaign=Badge_Grade) ![Discord](https://img.shields.io/discord/405752989182197760)\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat)](#contributors-) \u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n# java-documenter\nGenerates Java documentation in form of a Markdown file.\n\u003e NOTE: This software does only work for java source files (.java) and **not** for compiled java files (.class)\n\n## Installation\n**From source:**\\\n`Prerequisites: Git, Maven`\n1. Clone this repository (`git clone https://github.com/RealCerus/java-documenter`)\n2. Build the jar (`mvn package`)\n3. The final jar is in the `target` folder\n\n**Releases:**\\\n[![GitHub Releases](https://img.shields.io/github/downloads/RealCerus/java-documenter/latest/total)](https://github.com/RealCerus/java-documenter/releases/latest)\n\n## Usage\n`java -jar javadocsgenerator-VERSION.jar --files=FILENAME.java,ANOTHER_FILENAME.java,... --output=JAVA_DOCS.md`\n\u003e 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.\n\nArguments:\\\n`--files`: Required. Specifies the files that should be used for documentation generation.\\\n`--output`: Optional. Will default to `./JAVA_DOC.md`. Specifies the file in which the generated documentation should be saved.\n\n## Examples\n[src/main/java/example](https://github.com/RealCerus/java-documenter/tree/master/src/main/java/example)\n\n## Todo\n-   ~~Add wildcard support for file names~~\n-   ~~Implement some sort of annotation system to replace the '//DOC' comment (It's ugly)~~\n-   Parse stuff like '@since 1.0.0' or '@param xy' from java doc comments\n-   Make a GitHub Action\n-   Make a Maven plugin\n-   Implement feature requests\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://cerus-dev.de\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/46848982?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMaximilian D.\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/RealCerus/java-documenter/commits?author=RealCerus\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/RealCerus/java-documenter/commits?author=RealCerus\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#example-RealCerus\" title=\"Examples\"\u003e💡\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## License\nThis project is licensed under the [GPLv3](https://github.com/RealCerus/java-documenter/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcerus%2Fjava-documenter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcerus%2Fjava-documenter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcerus%2Fjava-documenter/lists"}