Skip to content

Commit

Permalink
disable JDK 23 line-doc comments
Browse files Browse the repository at this point in the history
 - codebase has many occurrences of '///' which were never meant to
   appear in javadoc this disables JDK 23+ "line doc comments" for now
 - javadoc CI step should run on JDK 23
  • Loading branch information
mbien committed Oct 24, 2024
1 parent 2237b71 commit 78699aa
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
16 changes: 15 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -416,11 +416,25 @@ jobs:
- name: Build nbms
run: ant $OPTS build-nbms

# 13-14 min
# 13-14 min for javadoc; JDK version must be synced with nb-javac
- name: Set up JDK 23 for javadoc
if: env.test_javadoc == 'true' && success()
uses: actions/setup-java@v4
with:
java-version: 23
distribution: ${{ env.DEFAULT_JAVA_DISTRIBUTION }}

- name: Build javadoc
if: env.test_javadoc == 'true' && success()
run: ant $OPTS build-javadoc

- name: Set up JDK ${{ matrix.java }}
if: env.test_javadoc == 'true' && success()
uses: actions/setup-java@v4
with:
java-version: ${{ matrix.java }}
distribution: ${{ env.DEFAULT_JAVA_DISTRIBUTION }}

# runs only in PRs if requested; ~18 min
- name: Build all Tests
if: env.test_tests == 'true' && github.event_name == 'pull_request' && success()
Expand Down
3 changes: 3 additions & 0 deletions nbbuild/javadoctools/template.xml
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,9 @@ cause it to fail.
<bottom>${javadoc.footer}</bottom>
<!-- Avoid timestamp comments in _all_ html generated files, to reduce unnecessary git commits -->
<arg value="-notimestamp" />
<!-- codebase has many occurrences of '///' which were never meant to appear in javadoc
this disables JDK 23+ "line doc comments" for now -->
<arg value="--disable-line-doc-comments" />
<arg value="-Xdoclint:all" />
<arg value="-Xdoclint:-missing" />
</javadoc>
Expand Down

0 comments on commit 78699aa

Please sign in to comment.