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: Support java-17 version of the javadoc for doc generator #3536

Draft
wants to merge 2 commits into
base: java-17
Choose a base branch
from

Conversation

lanseg
Copy link

@lanseg lanseg commented Jan 9, 2025

Breaks backwards compatibility because of the HTML differences in javadoc generated by java-11 and java-17.

@sebr72 sebr72 self-requested a review January 9, 2025 12:18
Copy link
Contributor

@sebr72 sebr72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add test to ensure the generated javadoc is similar in Java 17 to java 11.

@sebr72 sebr72 marked this pull request as draft January 10, 2025 10:54
@lanseg
Copy link
Author

lanseg commented Jan 13, 2025

Code to compare java-11 docs and java-17 docs.

rm -rf compare
mkdir -p compare/imgs

export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64/
git checkout java-17
../gradlew clean
../gradlew :docs:buildDocs
cp -rfv build/site compare/site-17

export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/
git checkout master
../gradlew clean
../gradlew :docs:buildDocs
cp -rfv build/site compare/site-11

for i in `find compare/site-17 -iname '*html' | grep -v javadoc`
do
    google-chrome --headless --screenshot="`pwd`/compare/imgs/`basename $i`-17.png" --window-size=1920,5000 $i
done

for i in `find compare/site-11 -iname '*html' | grep -v javadoc`
do
    google-chrome --headless --screenshot="`pwd`/compare/imgs/`basename $i`-11.png" --window-size=1920,5000 $i
done

for i in `find compare/imgs | grep -o ^.*html | sort | uniq`
do
    PSNR=`compare -metric PSNR -compose src $i-11.png $i-17.png $i-diff.png 2>&1`
    printf "DIFF %8s %25s %25s\n" $PSNR "$i-11.png" "$i-17.png"
done | tee compare/result.txt

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