{"id":16375019,"url":"https://github.com/moderocky/autodocs","last_synced_at":"2026-03-31T17:30:18.617Z","repository":{"id":103957125,"uuid":"446100041","full_name":"Moderocky/AutoDocs","owner":"Moderocky","description":"Adaptive procedural documentation generator for compiled code.","archived":false,"fork":false,"pushed_at":"2022-01-29T11:26:42.000Z","size":393,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-01T04:15:15.670Z","etag":null,"topics":["documentation","documentation-generator","documentation-tool","example-generator","examples","generator","javadocs"],"latest_commit_sha":null,"homepage":"https://autodocs.kenzie.mx","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Moderocky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2022-01-09T13:43:59.000Z","updated_at":"2022-01-10T22:56:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"aa0c8657-e2df-47a1-904d-44f2db13f1a3","html_url":"https://github.com/Moderocky/AutoDocs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moderocky%2FAutoDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moderocky%2FAutoDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moderocky%2FAutoDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moderocky%2FAutoDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Moderocky","download_url":"https://codeload.github.com/Moderocky/AutoDocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239954756,"owners_count":19724300,"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","example-generator","examples","generator","javadocs"],"created_at":"2024-10-11T03:19:08.387Z","updated_at":"2026-03-31T17:30:18.575Z","avatar_url":"https://github.com/Moderocky.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AutoDocs\n\n### Opus #13\n\nAutoDocs provides a modern, clean and easy-to-adapt alternative to the JDK's JavaDocs.\n\n## Visit the documentation [here](https://autodocs.kenzie.mx).\n\nRather than relying on the outdated, gate-kept JavaDoc API, AutoDocs has an entirely separate implementation.\n\nThis has three major advantages over JavaDocs.\n1. The documentation can be extracted from a compiled jar. \\\nJavaDocs are only present in the source files, making it impossible to find documentation unless the source is public. \\\nAutoDocs includes the basic data in the compiled Jar, so that documentation sites can be generated from library Jars or even compiled proprietary software.\n2. The documentation format is controllable. \\\nWhile the default output is a bootstrap website, AutoDocs is designed to support other output schemas like JSON files. \\\nThe default website is easy to customise and add to using 'Annotation Handlers' which allow for custom documentation elements.\n3. Multiple languages are supported. \\\nWhile AutoDocs is designed for extracting documentation from Java classes, other elements can be fed to the writing system. \\\nThis allows for procedurally-generated documentation from non-Java sources.\n\n## Using AutoDocs\n\nBasic documentation is controlled through a set of simple annotations.\n\nMost IDEs support folding/collapsing annotations to avoid taking up screen space.\n\n### @Description\nThis is used to add a multi-line description.\nIt supports `MARKDOWN` (which parses the content as markdown), `HTML` (which leaves the content raw) and `OTHER` (which sanitises basic HTML tags but will otherwise leave it untouched.)\nThe default mode is `MARKDOWN`.\n\n```java\nimport mx.kenzie.autodoc.api.note.Description;\n\n@Description(\"\"\"\n    This is my cool class!\n    Markdown is supported here, so I can use `code` stuff.\n    \n    This also supports basic language highlighting in code blocks.\n    \"\"\")\npublic class MyClass {\n\n} \n```\n\n### @Example\nThis is used to add multi-line examples.\nThis annotation can be used multiple times.\n\nThe example language will default to `java`, but supports all basic `highlight.js` languages.\n\n```java\nimport mx.kenzie.autodoc.api.note.Example;\n\n@Example(\"\"\"\n    new MyClass().whatever();\n    \"\"\")\n@Example(\"\"\"\n    final MyClass thing = new MyClass();\n    \"\"\")\npublic class MyClass {\n\n} \n```\n\n### @Warning\nThis is used to add a multi-line warning message to an element.\nThis annotation can be used multiple times.\nIt supports `MARKDOWN` (which parses the content as markdown), `HTML` (which leaves the content raw) and `OTHER` (which sanitises basic HTML tags but will otherwise leave it untouched.)\nThe default mode is `MARKDOWN`.\n\n```java\nimport mx.kenzie.autodoc.api.note.Warning;\n\n@Warning(\"\"\"\n    This class will be removed in version 8.5.1! :(\n    \"\"\")\npublic class MyClass {\n\n} \n```\n\n### @Ignore\nThis causes the element to be skipped in any documentation.\nPrivate elements will be skipped by default, since they would be inaccessible to third-party code.\n\n```java\nimport mx.kenzie.autodoc.api.note.Ignore;\n\n@Ignore\npublic class MyClass {\n\n} \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoderocky%2Fautodocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoderocky%2Fautodocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoderocky%2Fautodocs/lists"}