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.

Sign up for GitHub

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

Jump to bottom

Migrate class references to full javadoc links #43239

Closed
philwebb opened this issue Nov 21, 2024 · 1 comment
Closed

Migrate class references to full javadoc links #43239

philwebb opened this issue Nov 21, 2024 · 1 comment
Assignees
@philwebb
Labels
status: forward-port An issue tracking the forward-port of a change made in an earlier branch type: documentation A documentation update
Milestone
3.4.0

Comments

@philwebb
Copy link
Member

Forward port of #41614 to 3.4.x
@philwebb philwebb added this to the 3.4.x milestone Nov 21, 2024
@philwebb philwebb self-assigned this Nov 21, 2024
@philwebb philwebb added type: documentation A documentation update status: forward-port An issue tracking the forward-port of a change made in an earlier branch labels Nov 21, 2024
@philwebb
Copy link
Member Author

We won't do this one as a merge commit since most of the process is automated and it's easier to reapply it.

philwebb added a commit that referenced this issue Nov 21, 2024
@philwebb
Temporarily escape monospaced text that will not be linked
e8e9592 
Escape elements that we know cannot be converted to a javadoc link.

See gh-43239
philwebb added a commit that referenced this issue Nov 21, 2024
@philwebb
Use fully-qualified names for ambiguous type references
0e62778 
Update type references to use a fully qualified name when we have
more than one candidate available to us.

See gh-43239
philwebb added a commit that referenced this issue Nov 21, 2024
@philwebb
Migrate class references to full javadoc links
e9e018c 
Update documentation to use `javadoc:...` macro for class and interface
references.

Migrated using https://github.com/philwebb/asciidoctor-javadoc-migration

See gh-43239
philwebb added a commit that referenced this issue Nov 21, 2024
@philwebb
Restore monospaced text to unescaped form
11415a9 
See gh-43239
@philwebb philwebb modified the milestones: 3.4.x, 3.4.0 Nov 21, 2024
@Netyyyy Netyyyy mentioned this issue Dec 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philwebb philwebb

Labels
status: forward-port An issue tracking the forward-port of a change made in an earlier branch type: documentation A documentation update
Projects
None yet
Milestone
3.4.0
Development

No branches or pull requests
1 participant
@philwebb