Skip to content

apidoc rewrite to jdk 23 layout (minimal)#8368

Merged
ebarboni merged 1 commit intoapache:masterfrom
ebarboni:jdk23apidoc
Apr 1, 2025
Merged

apidoc rewrite to jdk 23 layout (minimal)#8368
ebarboni merged 1 commit intoapache:masterfrom
ebarboni:jdk23apidoc

Conversation

@ebarboni
Copy link
Contributor

This is a proposal to have a bit more modern apidoc. Using css/html from new layout javadoc tool 23.

In order to work, bootstrap ant task

  • linkchecker need upgrade to scan more element, and allow other ordering of attribute to find href/name/id.
  • javadocindex need to parse new div based navigation file.
  • arch.java needs new parameters to render optional element

Inject into arch/apichanges pages

  • new menu + header that looks like normal apidoc page
  • deprecated menu if deprecated.html present.

correct some top level page to not swallow api so we have correct text instead blank text.

css altered to get green header with green taken from APache NetBeans website to make difference when you look at jdk apidoc.

This PR will lead to many checklink errors because ( ) , should be back to the href as before they were replaced by -

Example:
@org-openide-util@/org/openide/util/BaseUtilities.html#isWindows-- needs to be replaced by @org-openide-util@/org/openide/util/BaseUtilities.html#isWindows()

tested on jdk 23 and 24.

@ebarboni ebarboni added the JavaDoc [ci] enable java/javadoc tests and build-javadoc target label Mar 28, 2025
@ebarboni ebarboni requested a review from mbien March 28, 2025 16:19
@mbien mbien added this to the NB26 milestone Mar 29, 2025
@mbien
Copy link
Member

mbien commented Mar 31, 2025

@ebarboni makes sense to me - you showed me the results via slack too and it looked great IMO. Could you rebase so that the build takes #8369 into account?

@ebarboni
Copy link
Contributor Author

ebarboni commented Apr 1, 2025

ok merging so we have a live overview. will need to fix the url in code base to have parenthesis back

@ebarboni ebarboni merged commit 870d1a1 into apache:master Apr 1, 2025
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

JavaDoc [ci] enable java/javadoc tests and build-javadoc target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments