Skip to content

Migrate class references to full javadoc links #41614

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

Closed
philwebb opened this issue Jul 25, 2024 · 0 comments
Closed

Migrate class references to full javadoc links #41614

philwebb opened this issue Jul 25, 2024 · 0 comments
Assignees
Labels
type: task A general task
Milestone

Comments

@philwebb
Copy link
Member

Extending from #41605 we can migrate class references to javadoc links.

@philwebb philwebb added the type: task A general task label Jul 25, 2024
@philwebb philwebb added this to the 3.3.x milestone Jul 25, 2024
@philwebb philwebb self-assigned this Jul 25, 2024
philwebb added a commit that referenced this issue Jul 30, 2024
philwebb added a commit that referenced this issue Nov 7, 2024
Update javadoc links to include package references when relevant. The
packages are used to populate `javadoc-location-*` attributes that the
Asciidoctor javadoc extension can use.

See gh-41614
philwebb added a commit that referenced this issue Nov 8, 2024
philwebb added a commit that referenced this issue Nov 9, 2024
Fix a few errors and add more javadoc-location package attributes
for use in `.adoc` files.

See gh-41614
philwebb added a commit that referenced this issue Nov 13, 2024
philwebb added a commit that referenced this issue Nov 13, 2024
Update our libraries DSL to support multiple links with the same
name. This will allow us to reference libraries that publish
multiple API sites with each of their releases.

See gh-41614
philwebb added a commit that referenced this issue Nov 13, 2024
philwebb added a commit that referenced this issue Nov 20, 2024
philwebb added a commit that referenced this issue Nov 20, 2024
philwebb added a commit that referenced this issue Nov 20, 2024
Update a few areas of the documentation to use full javadoc
links.

See gh-41614
philwebb added a commit that referenced this issue Nov 20, 2024
philwebb added a commit that referenced this issue Nov 21, 2024
philwebb added a commit that referenced this issue Nov 21, 2024
philwebb added a commit that referenced this issue Nov 21, 2024
Escape elements that we know cannot be converted to a javadoc link.

See gh-41614
philwebb added a commit that referenced this issue Nov 21, 2024
Update type references to use a fully qualified name when we have
more than one candidate available to us.

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

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

See gh-41614
philwebb added a commit that referenced this issue Nov 21, 2024
@philwebb philwebb modified the milestones: 3.3.x, 3.3.6 Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task A general task
Projects
None yet
Development

No branches or pull requests

1 participant