On Thu, 26 Sep 2024 21:33:10 GMT, Kevin Rushforth <k...@openjdk.org> wrote:
> This PR modifies the header and footer of the javadoc-generated API docs to > add "DRAFT $VER-ea+$BLD" to clearly identify an ea build of the docs, and > also to make it clear which build number the docs refer to. This matches was > the JDK does. For GA builds, there will be no change to what we generate > today. Since I had to add logic to filter the javadoc properties defined in > `build.javadoc` to add the DRAFT message if not a GA build, I also changed > the properties to not hard-code the major version of JavaFX, thus reducing > the duplication. > > I ran three builds to test this, an ordinary developer build, an EA build, > and a GA build as follows: > > #### Developer build > > Command line: > > gradle javadoc > > > Generated docs: https://cr.openjdk.org/~kcr/8340829/javadoc-internal/ > > #### EA build > > Command line: > > gradle -PPROMOTED_BUILD_NUMBER=98 -PHUDSON_BUILD_NUMBER=1234 > -PHUDSON_JOB_NAME=jfx-dev javadoc > > > Generated docs: https://cr.openjdk.org/~kcr/8340829/javadoc-ea/ > > #### GA build > > Command line: > > gradle -PMILESTONE_FCS=true -PPROMOTED_BUILD_NUMBER=99 > -PHUDSON_BUILD_NUMBER=4321 -PHUDSON_JOB_NAME=jfx-dev javadoc > > > Generated docs: https://cr.openjdk.org/~kcr/8340829/javadoc-fcs/ In an offline comment, Iris noted three additional things that could be improved in the JavaFX docs relative to the JDK docs: 1. For EA docs, the JDK has a top "This specification change is not final and is subject to change..." banner, which is missing from the JavaFX EA docs. 2. The JDK docs adds an HTML comment in the bottom section with the full build identifier, which would be useful for the JavaFX docs to clearly identify which build (especially if there is ever a GA respin). 3. For GA docs, the "JavaFX NN" version number in the upper right is not vertically centered in the blue header bar, whereas it is vertically centered in the JDK docs. I have fixed 1 and 2, and will file a follow-on bug for 3 (it wasn't obvious how to do that one). I updated the generated docs on `cr.openjdk.org` in place. ------------- PR Comment: https://git.openjdk.org/jfx/pull/1583#issuecomment-2379236961
