{"id":20692477,"url":"https://github.com/dendrodocs/java-tool","last_synced_at":"2025-04-22T17:10:39.346Z","repository":{"id":256287936,"uuid":"851183768","full_name":"dendrodocs/java-tool","owner":"dendrodocs","description":"Java tool to analyze JVM projects/solutions, enabling schema analysis and documentation generation.","archived":false,"fork":false,"pushed_at":"2025-04-14T19:51:30.000Z","size":138,"stargazers_count":2,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-17T05:05:24.268Z","etag":null,"topics":["analyzer","dendrodocs","hacktoberfest","java-parser","living-documentation"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dendrodocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2024-09-02T15:25:29.000Z","updated_at":"2025-03-17T21:27:48.000Z","dependencies_parsed_at":"2024-12-17T09:28:50.812Z","dependency_job_id":"34d457e8-eb85-4990-844e-ad445089f587","html_url":"https://github.com/dendrodocs/java-tool","commit_stats":null,"previous_names":["dendrodocs/java-tool"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fjava-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fjava-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fjava-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dendrodocs%2Fjava-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dendrodocs","download_url":"https://codeload.github.com/dendrodocs/java-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250285697,"owners_count":21405297,"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":["analyzer","dendrodocs","hacktoberfest","java-parser","living-documentation"],"created_at":"2024-11-16T23:21:57.100Z","updated_at":"2025-04-22T17:10:39.329Z","avatar_url":"https://github.com/dendrodocs.png","language":"Java","readme":"# DendroDocs Java Tool\n\n[![Maven Central Version][MAVEN_BADGE]][MAVEN_FEED] [![Coverage Status][COVERALLS_BADGE]][COVERALLS_LINK]\n\n**dev.dendrodocs.tool** is a command-line tool for analyzing Java projects and generating structured JSON output.\nIt forms an integral part of the DendroDocs ecosystem, providing an easy way to bridge the gap between your Java code and up-to-date, detailed documentation.\n\n## Features\n\nA command-line tool that analyzes Java projects and produces a JSON file that follows the schema defined in the [DendroDocs Schema](https://github.com/dendrodocs/schema) repository.\n\n## Prerequisites\n\n* JDK 21 or newer.\n\n## Installation\n\nTo install **dev.dendrodocs.tool**, you can fetch it directly via Maven:\n\n```bash\nmvn dependency:get -Dartifact=\"dev.dendrodocs:tool:LATEST:jar\"\n```\n\nThis will download the tool and store it in your local Maven repository.\n\n## Usage\n\nOnce installed, you can run the tool using the following command, in PowerShell:\n\n```powershell\njava -jar \"$env:USERPROFILE\\.m2\\repository\\dev\\dendrodocs\\tool\\0.1.0\\tool-0.1.0.jar\" --project \"G:\\DendroDocs\\java-tool\\\" --output \"java-tool.json\" --pretty\n```\n\nThis command will analyze the Java project located at `G:\\DendroDocs\\java-tool\\`, generate a pretty-printed JSON file named `java-tool.json`, and store it in the current directory.\n\n### Viewing the Output\n\nTo quickly preview the first few lines of the generated JSON output, use the following PowerShell command:\n\n```powershell\nGet-Content -Path \"java-tool.json\" -Head 8\n```\n\nOutput\n\n```json\n[ {\n  \"FullName\" : \"dev.dendrodocs.tool.descriptions.ForEachDescriptionJsonTest\",\n  \"Fields\" : [ {\n    \"Name\" : \"mapper\",\n    \"Modifiers\" : 132,\n    \"Type\" : \"com.fasterxml.jackson.databind.ObjectMapper\",\n    \"Initializer\" : \"new ObjectMapper()\"\n  } ],\n```\n\nThis JSON output contains detailed descriptions of your Java classes, including fields, methods, types, and modifiers.\n\n## The DendroDocs Ecosystem\n\n**dev.dendrodocs.tool** is part of the larger DendroDocs ecosystem.\nExplore [DendroDocs](https://github.com/dendrodocs) to find more tools, libraries, and documentation resources that help you bridge the gap between your code and its documentation.\n\n## Contributing\n\nContributions are welcome! Please feel free to create [issues](https://github.com/dendrodocs/java-tool/issues) or [pull requests](https://github.com/dendrodocs/java-tool/pulls).\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n[MAVEN_BADGE]: https://img.shields.io/maven-central/v/dev.dendrodocs/tool?style=plastic\n[MAVEN_FEED]: https://central.sonatype.com/artifact/dev.dendrodocs/tool\n[COVERALLS_BADGE]: https://coveralls.io/repos/github/dendrodocs/java-tool/badge.svg?branch=main\n[COVERALLS_LINK]: https://coveralls.io/github/dendrodocs/java-tool?branch=main","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdendrodocs%2Fjava-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdendrodocs%2Fjava-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdendrodocs%2Fjava-tool/lists"}