Skip to content

Develop 'apiref' macro for use in Antora #40066

Open
@philwebb

Description

@philwebb

It would be nice if we could improve the way we link to both external and internal classes. We could probably write an extension that would support the form:

apiref:<reference>:[<java module:>]<java class>[]

The <reference> would be a name that resolves to either an Antora xref name or an external site.

E.g:

apiref:gradle-plugin:org.springframework.boot.gradle.tasks.bundling.BootBuildImage[]
apiref:openjdk:java.base:java.time.Duration[]

With some backend updates we could output monotype text for the small name and offer a hover tip that shows the fully qualified name.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions