{"id":28404934,"url":"https://github.com/commandapi/javadocs","last_synced_at":"2026-02-18T14:04:18.308Z","repository":{"id":267375762,"uuid":"901055453","full_name":"CommandAPI/javadocs","owner":"CommandAPI","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-02T22:13:14.000Z","size":5132,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-11T13:52:09.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://javadocs.commandapi.dev/","language":"CSS","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/CommandAPI.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,"zenodo":null}},"created_at":"2024-12-10T00:44:08.000Z","updated_at":"2025-04-02T22:13:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"155891c9-c116-4777-8d9b-67a59e229f1c","html_url":"https://github.com/CommandAPI/javadocs","commit_stats":null,"previous_names":["commandapi/javadocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CommandAPI/javadocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommandAPI%2Fjavadocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommandAPI%2Fjavadocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommandAPI%2Fjavadocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommandAPI%2Fjavadocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CommandAPI","download_url":"https://codeload.github.com/CommandAPI/javadocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CommandAPI%2Fjavadocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29581541,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T13:56:48.962Z","status":"ssl_error","status_checked_at":"2026-02-18T13:54:34.145Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-06-01T21:08:36.123Z","updated_at":"2026-02-18T14:04:18.293Z","avatar_url":"https://github.com/CommandAPI.png","language":"CSS","readme":"# CommandAPI Javadocs\n\nThe CommandAPI JavaDocs are manually generated using Doxygen. Doxygen is a documentation generator for C++, which also has some support for Java and a cleaner, more modern interface with support for inheritance diagrams (amongst other features). Doxygen can be downloaded [here](https://www.doxygen.nl/download.html#srcbin).\n\n## Building the JavaDocs\n\n- If necessary, download and install Doxygen as detailed in their documentation [here](https://www.doxygen.nl/manual/install.html).\n\n- Update the git submodules `CommandAPI` and `brigadier-with-javadocs` to point to the version you want to generate javadocs for. Typically, this will be the latest commit on the respective `master` branches. The submodules should already be on the master branch with no local changes, in which case you can simply run `git pull` for each submodule:\n\n```shell\ncd CommandAPI\ngit pull\ncd ..\n\ncd brigadier-with-javadocs\ngit pull\ncd ..\n```\n\n- If necessary, update the `PROJECT_NUMBER` tag in the `Doxyfile` to the appropriate CommandAPI version.\n\n- Run Doxygen via the terminal or graphical Doxywizard application. For the CLI, simply run `doxygen` in the root of this repository. For the GUI:\n    - Go to `File \u003e Open...` and open the `Doxyfile` in the root of this repository\n    - Go to the `Run` tab (next to `Wizard` and `Expert`)\n    - Press the `Run doxygen` button:\n\n      \u003cimg width=\"500\" alt=\"image\" src=\"https://github.com/JorelAli/CommandAPI/assets/4613171/23c9c82f-bcb8-444e-a7c1-8e25482b1b36\"\u003e\n\n## Why Doxygen instead of JavaDocs?\n\nI chose to use Doxygen over JavaDocs because Bukkit's original JavaDocs were also generated using Doxygen and I preferred the UI to the standard JavaDocs UI. Additionally:\n\n- Doxygen has inheritance diagrams:\n\n  \u003cimg width=\"789\" alt=\"image\" src=\"https://user-images.githubusercontent.com/4613171/220895985-b98e5424-400d-45ee-943d-abdfc1bd69d7.png\"\u003e\n\n- Doxygen shows the JavaDocs for inherited methods without requiring you to navigate to the relevant inherited class/interface to view its method descriptions:\n\n  \u003cimg width=\"789\" alt=\"image\" src=\"https://user-images.githubusercontent.com/4613171/220896243-ff2e5056-cacc-448d-8d48-1c437c6ccd4e.png\"\u003e\n\n- Doxygen makes it easy to pull in other projects into the documentation:\n\n  \u003cimg width=\"778\" alt=\"image\" src=\"https://user-images.githubusercontent.com/4613171/220896833-9ef66762-833d-4a33-95e5-d67a9f09cae0.png\"\u003e\n\n## Known issues\n\nJava classes with generics that extend other classes aren't properly generated in Doxygen. For example:\n\n```java\npublic class MyClass\u003cT extends List\u003cString\u003e\u003e {\n  public String someField;\n}\n```\n\nThis is currently a known issue on Dogyxen (see [here](https://github.com/doxygen/doxygen/issues/8495)) and development was done to rectify this (see [here](https://github.com/doxygen/doxygen/pull/8534)), but at the time of writing (Feb 2023) no further progress has been done on this issue.\n\nThis issue can be circumvented using Doxygen's [`\\cond` preprocessor command](https://www.doxygen.nl/manual/commands.html#cmdcond). By applying a `@cond` comment followed by a label, then a subsequent `@endcond` comment around generics, this issue can be avoided. An example of this can be found in the CommandAPI repository at [this commit](https://github.com/CommandAPI/CommandAPI/commit/e6f77968b97133d3739936abdd90fa58e1530b4e).\n\nFor example, if you take this class parameterized with generics `T` and `U`, and the `U` generic extends another class, this will cause Doxygen to skip all methods declared in `MyClass`:\n\n```java\npublic class MyClass\u003cT, U extends SomeOtherClass\u003cT\u003e\u003e {\n  ...\n}\n```\n\nYou can fix this by adding the relevant `\\cond` guards. By default, the CommandAPI uses the label `DOX`:\n\n```java\npublic class MyClass\u003cT, U\n/// @cond DOX\nextends SomeOtherClass\u003cT\u003e\n/// @endcond\n\u003e {\n  ...\n}\n```\n\n## Brigadier JavaDocs\n\nAs the CommandAPI heavily depends on [Mojang/brigadier](https://github.com/Mojang/brigadier), the CommandAPI's JavaDocs also includes Brigadier's JavaDocs. JavaDocs for Brigadier were kindly written by [I-Al-Istannen](https://github.com/I-Al-Istannen) because the main Brigadier repository doesn't have any of their own JavaDocs.\n\nJorelAli currently hosts a fork of [Mojang/brigadier](https://github.com/Mojang/brigadier) which is up-to-date, and incorporates the changes from [I-Al-Istannen/brigadier](https://github.com/I-Al-Istannen/brigadier) which is compatible with Doxygen (it has the `@cond DOX` guards). The fork can be found at [CommandAPI/brigadier-with-javadocs](https://github.com/CommandAPI/brigadier-with-javadocs), and is included as a submodule of this repository.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommandapi%2Fjavadocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommandapi%2Fjavadocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommandapi%2Fjavadocs/lists"}