Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.5 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.5 KB
Raw

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 24.

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:

<dependency>
    <groupId>io.javaalmanac</groupId>
    <artifactId>javadoclink</artifactId>
    <version>1.6.0</version>
</dependency>

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:

JavaDocLink.forVersion("11")
           .withBaseUrl("https://docs.oracle.com/en/java/javase/11/docs/api/")
           .classLink(String.class);

Or using internal vm names:

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, 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.