Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop 'apiref' macro for use in Antora #40066

Open
philwebb opened this issue Mar 22, 2024 · 1 comment
Open

Develop 'apiref' macro for use in Antora #40066

philwebb opened this issue Mar 22, 2024 · 1 comment
Labels
type: documentation A documentation update
Milestone

Comments

@philwebb
Copy link
Member

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.

@philwebb philwebb added the type: documentation A documentation update label Mar 22, 2024
@philwebb philwebb added this to the 3.x milestone Mar 22, 2024
@wilkinsona
Copy link
Member

See also #13741.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

2 participants