LinkConfig

Defines a list of base URLs for API links which allows the use of the @:api directive in markup.

Different base URLs can be defined for different packages, so that fully qualified class names point to the correct external sources. In markup it is then sufficient to pass the fully qualified class name to the directive (e.g. @:api(com.foo.Person))

Defines a list of base URLs for links to the sources of referenced classes which allows the use of the @:source directive in markup.

Different base URLs can be defined for different packages, so that fully qualified class names or a relative path to a markup source file point to the correct external sources. In markup it is then sufficient to pass the fully qualified class name to the directive (e.g. @:source(com.foo.Person)) or, when pointing to markup sources, its relative path (e.g. @:source(setup/intro.md))

List of global link definitions, mapping an identifier to an internal or external target.

Allows to centralize commonly used URLs and associate them with an id that can be used in markup sources, avoiding the repetitive definition of those URLs in the markup.

The use of these ids in markup does not require a directive, it can be used with "native" markup syntax, e.g. [linkText][linkId] in Markdown where linkId is the identifier defined here.