{"id":17929462,"url":"https://github.com/marchof/io.javaalmanac.javadoclink","last_synced_at":"2025-03-24T04:31:03.105Z","repository":{"id":147578410,"uuid":"405329142","full_name":"marchof/io.javaalmanac.javadoclink","owner":"marchof","description":"Generator for Javadoc deep links","archived":false,"fork":false,"pushed_at":"2025-02-10T10:28:27.000Z","size":85,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-19T01:45:18.339Z","etag":null,"topics":["java","javaalmanac-io","javadoc"],"latest_commit_sha":null,"homepage":"https://github.com/marchof/io.javaalmanac.javadoclink","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/marchof.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-09-11T08:48:59.000Z","updated_at":"2025-02-10T10:27:17.000Z","dependencies_parsed_at":"2023-12-08T09:27:07.866Z","dependency_job_id":"da53fa6a-17a3-488c-8636-52ce8e7eb095","html_url":"https://github.com/marchof/io.javaalmanac.javadoclink","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marchof%2Fio.javaalmanac.javadoclink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marchof%2Fio.javaalmanac.javadoclink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marchof%2Fio.javaalmanac.javadoclink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marchof%2Fio.javaalmanac.javadoclink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marchof","download_url":"https://codeload.github.com/marchof/io.javaalmanac.javadoclink/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245210927,"owners_count":20578316,"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":["java","javaalmanac-io","javadoc"],"created_at":"2024-10-28T21:09:19.707Z","updated_at":"2025-03-24T04:31:03.099Z","avatar_url":"https://github.com/marchof.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"io.javaalmanac.javadoclink - Deep links for Javadoc\n===================================================\n\nSmall Java library to create deep links into generated Javadoc for all Java\nversions from 1.1 to 25.\n\nThe library can create links for\n\n* modules\n* packages\n* types (classes, interfaces, enums, records, annotations)\n* methods and constructors\n* fields\n\nbased on the internal names (class files) or on Java reflection types.\n\n\n## Usage\n\nThe latest version can be obtained with the following Maven dependency:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.javaalmanac\u003c/groupId\u003e\n    \u003cartifactId\u003ejavadoclink\u003c/artifactId\u003e\n    \u003cversion\u003e1.7.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nThe only public interface of the library is `io.javaalmanac.javadoclink.JavaDocLink`. It\nis used to get instances, the base URL and retrieve links for different Java\nlanguage elements. This For example this snippet creates a link to the\n`java.lang.String` class:\n\n```java\nJavaDocLink.forVersion(\"11\")\n           .withBaseUrl(\"https://docs.oracle.com/en/java/javase/11/docs/api/\")\n           .classLink(String.class);\n```\n\nOr using internal vm names:\n\n```java\nJavaDocLink.forVersion(\"11\")\n           .withBaseUrl(\"https://docs.oracle.com/en/java/javase/11/docs/api/\")\n           .classLink(\"java.base\", \"java/lang/String\");\n```\n\n\n## License\n\nThis code is provided \"as is\" under the [MIT License](LICENSE.md), without warranty of any kind.\n\n\n## Trademarks\n\nJava are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarchof%2Fio.javaalmanac.javadoclink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarchof%2Fio.javaalmanac.javadoclink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarchof%2Fio.javaalmanac.javadoclink/lists"}