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(docs): generate javadocs #1534

Merged
merged 2 commits into from
Apr 3, 2024
Merged

fix(docs): generate javadocs #1534

merged 2 commits into from
Apr 3, 2024

Conversation

yury-s
Copy link
Member

@yury-s yury-s commented Apr 3, 2024

Javadoc options generated by the plugin have changed to include -source 8:

$ diff good.txt bad.txt 
5a6,7
> -source
> '8'
24a27,28
> 'https://docs.oracle.com/javase/8/docs/api' '/Users/yurys/playwright-java/playwright/target/javadoc-bundle-options'
> -linkoffline

The options are from the following:

Command line was: /Library/Java/JavaVirtualMachines/jdk-21.jdk/Contents/Home/bin/javadoc @options

Refer to the generated Javadoc files in '/Users/<user>/playwright-java/playwright/target/site/apidocs' dir.

Turns out -source '8' triggers an assertion in the javadoc tool, so for now we just pass 11 as the source version. Our sources are compiled with java 8 compatibility mode, so it shouldn't make any difference in the generated docs.

Reference #1533

@yury-s yury-s requested a review from mxschmitt April 3, 2024 18:35
@yury-s yury-s merged commit a917f2e into microsoft:main Apr 3, 2024
17 of 21 checks passed
yury-s added a commit to yury-s/playwright-java that referenced this pull request Apr 3, 2024
yury-s added a commit that referenced this pull request Apr 3, 2024
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.

2 participants