JDK-8313204: Inconsistent order of sections in generated class documentation

[jonathan-gibbons]

Please review a minor change to ClassWriter to make the order of sections consistent across member-kinds and between summary and detail sections. The change to ClassWriter is just to reorder the sections, and to add some explanatory comments.

One test detected the change and is therefore updated.
Another test is updated to include a check for the section ordering.

Note: the changes to ClassWriter may soon be superseded by work on JDK-8312201. The primary goal of this PR is to establish the preferred order and update the tests accordingly.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8313204: Inconsistent order of sections in generated class documentation (Bug - P4)

Reviewers

• Hannes Wallnöfer (@hns - Reviewer)
• Pavel Rappo (@pavelrappo - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/15046/head:pull/15046
$ git checkout pull/15046

Update a local copy of the PR:
$ git checkout pull/15046
$ git pull https://git.openjdk.org/jdk.git pull/15046/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15046

View PR using the GUI difftool:
$ git pr show -t 15046

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/15046.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons The following label will be automatically applied to this pull request:

• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 01: Full - Incremental (f9a96fec)
• 00: Full (0bf7c205)

[hns]

Looks good to me.

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8313204: Inconsistent order of sections in generated class documentation

Reviewed-by: hannesw, prappo

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[pavelrappo]

On JavaFX-style properties: is the suggested order something that JavaFX folk agree with? I'm not an expert, but it might be important for JavaFX documentation to display properties first on a page.

[jonathan-gibbons]

On JavaFX-style properties: is the suggested order something that JavaFX folk agree with? I'm not an expert, but it might be important for JavaFX documentation to display properties first on a page.

I checked with the JavaFX team, to give them a heads up. There was no pushback on this change.

My reading of the code and situation is that the code was previously updated without a better understanding of the big picture and consequences of the changes. Support for both properties and type annotations was added by "external" contributors.

[jonathan-gibbons]

/integrate

[pavelrappo]

Thanks for checking with the JavaFX team.

Looks good to me.

[openjdk]

Going to push as commit e2cb0bc.

[openjdk]

@jonathan-gibbons Pushed as commit e2cb0bc.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.