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

Fix ExternalLink class to support 'element-list' module definitions #145

Merged
merged 9 commits into from
Feb 19, 2019

Conversation

sjoerdtalsma
Copy link
Contributor

@sjoerdtalsma sjoerdtalsma commented Feb 19, 2019

This pull request intends to fix #142

There is also an issue in the maven-javadoc-plugin that does not resolve openjdk 11 documentation by default.
We can work around it by providing it explicitly, e.g.

<links>
    <link>https://docs.oracle.com/en/java/javase/11/docs/api</link>
</links>

That will include links in the documentation, but because the modules are part of the path (and no package-list is published, but an element-list instead) the UML classes do not contain links.

@sjoerdtalsma
Copy link
Contributor Author

We'll need to figure out when to add the module name to the link path and when not to do that 😢

The JDK 10 documentation does contain an element-list (instead of package-list): https://docs.oracle.com/javase/10/docs/api/element-list

However, it does not include the module name in the documentation url:
https://docs.oracle.com/javase/10/docs/api/java/lang/Object.html
(instead of https://docs.oracle.com/javase/10/docs/api/java.base/java/lang/Object.html)

@sjoerdtalsma sjoerdtalsma changed the title WIP: Fix ExternalLink class to support 'element-list' module definitions Fix ExternalLink class to support 'element-list' module definitions Feb 19, 2019
@sjoerdtalsma sjoerdtalsma merged commit ace1c97 into develop Feb 19, 2019
@sjoerdtalsma sjoerdtalsma deleted the module-names branch February 19, 2019 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support Javadoc modules from links
1 participant