https://github.com/marchof/io.javaalmanac.javadoclink
Generator for Javadoc deep links
https://github.com/marchof/io.javaalmanac.javadoclink
java javaalmanac-io javadoc
Last synced: over 1 year ago
JSON representation
Generator for Javadoc deep links
- Host: GitHub
- URL: https://github.com/marchof/io.javaalmanac.javadoclink
- Owner: marchof
- License: mit
- Created: 2021-09-11T08:48:59.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-10T10:28:27.000Z (over 1 year ago)
- Last Synced: 2025-03-19T01:45:18.339Z (over 1 year ago)
- Topics: java, javaalmanac-io, javadoc
- Language: Java
- Homepage: https://github.com/marchof/io.javaalmanac.javadoclink
- Size: 83 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
io.javaalmanac.javadoclink - Deep links for Javadoc
===================================================
Small Java library to create deep links into generated Javadoc for all Java
versions from 1.1 to 25.
The library can create links for
* modules
* packages
* types (classes, interfaces, enums, records, annotations)
* methods and constructors
* fields
based on the internal names (class files) or on Java reflection types.
## Usage
The latest version can be obtained with the following Maven dependency:
```xml
io.javaalmanac
javadoclink
1.7.0
```
The only public interface of the library is `io.javaalmanac.javadoclink.JavaDocLink`. It
is used to get instances, the base URL and retrieve links for different Java
language elements. This For example this snippet creates a link to the
`java.lang.String` class:
```java
JavaDocLink.forVersion("11")
.withBaseUrl("https://docs.oracle.com/en/java/javase/11/docs/api/")
.classLink(String.class);
```
Or using internal vm names:
```java
JavaDocLink.forVersion("11")
.withBaseUrl("https://docs.oracle.com/en/java/javase/11/docs/api/")
.classLink("java.base", "java/lang/String");
```
## License
This code is provided "as is" under the [MIT License](LICENSE.md), without warranty of any kind.
## Trademarks
Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.