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

JDK-8249634: doclint should report implicit constructor as missing javadoc comments #4695

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Jul 6, 2021

Please review a simple update to doclint, to generate messages for the "effectively missing" comment on default constructors on "normal" classes (not enums classes or record classes.)

The change does affect a bunch of tests, mostly doclint tests, which all use atypical "toy" classes to host the comments to be tested, and which generally do not have explicit constructors ... and so trigger the new warning about using default constructors.

There is no one solution applied to all tests. The general theme of the changes is to minimize the changes, and in almost all cases to avoid changing any "golden files" or "expected output".

The following techniques are used to modify tests:

where it does not significantly interact with other test options, disable the check for missing comments when that is not the primary function of the test
where it would not affect any line numbers in any expected output, add an explicit no-args constructor at the end of the class body
add an explicit no-args constructor on the same line as the opening { of the class body (i.e.in order not to change line numbers in reference output)


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8249634: doclint should report implicit constructor as missing javadoc comments

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/4695/head:pull/4695
$ git checkout pull/4695

Update a local copy of the PR:
$ git checkout pull/4695
$ git pull https://git.openjdk.java.net/jdk pull/4695/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4695

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/4695.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Jul 6, 2021

👋 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
Copy link

openjdk bot commented Jul 6, 2021

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

  • compiler
  • javadoc

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

@openjdk openjdk bot added javadoc compiler labels Jul 6, 2021
@openjdk openjdk bot added the rfr label Jul 6, 2021
@mlbridge
Copy link

mlbridge bot commented Jul 6, 2021

Webrevs

hns
hns approved these changes Jul 19, 2021
Copy link
Member

@hns hns left a comment

Looks good! The long list of required test changes is a bit frightening, but I accept it's an artifact of "toy" test classes.

@openjdk
Copy link

openjdk bot commented Jul 19, 2021

@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:

8249634: doclint should report implicit constructor as missing javadoc comments

Reviewed-by: hannesw

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 157 new commits pushed to the master branch:

  • a8f1542: 8270455: Remove unused JFR tracer related code in G1CollectedHeap
  • edff556: 8263385: IGV: Graph is not opened in the window that has focus.
  • e7cdfeb: 8270862: Fix problem list entries for 32-bit
  • f8ec3b6: 8270801: Print VM arguments with java -Xlog:arguments
  • a5c9094: Merge
  • 2dddcce: 8270858: Problem List java/awt/Window/MultiWindowApp/MultiWindowAppTest.java on Linux
  • 1350e2b: 8270556: Exclude security/infra/java/security/cert/CertPathValidator/certification/LetsEncryptCA
  • 58f1ada: 8269636: Change outputStream's print_raw() and print_raw_cr() second parameter to size_t type
  • 67dc1c5: 8270837: fix typos in test TestSigParse.java
  • 1d8d72d: 8270540: G1: Refactor range checking in G1BlockOffsetTablePart::block_start* to asserts
  • ... and 147 more: https://git.openjdk.java.net/jdk/compare/1578979df706ae9f4324931e1fc0d58265762c79...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this 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.

@openjdk openjdk bot added the ready label Jul 19, 2021
@jonathan-gibbons
Copy link
Contributor Author

jonathan-gibbons commented Jul 22, 2021

/integrate

@openjdk
Copy link

openjdk bot commented Jul 22, 2021

Going to push as commit c1c4048.
Since your change was applied there have been 210 commits pushed to the master branch:

  • 09e5321: 8225313: serviceability/jvmti/HeapMonitor/MyPackage/HeapMonitorStatObjectCorrectnessTest.java failed with Unexpected high difference percentage
  • 258f188: 8270961: [TESTBUG] Move GotWrongOOMEException into vm.share.gc package
  • 3cadc36: 8270336: [TESTBUG] Fix initialization in NonbranchyTree
  • c2ed336: 8270912: Clean up G1CollectedHeap::process_discovered_references()
  • 8e27d4e: 8271043: Rename G1CollectedHeap::g1mm()
  • d1257d5: 8271126: ProblemList runtime/InvocationTests/invokevirtualTests.java
  • 50bb731: 8270286: com.sun.net.httpserver.spi.HttpServerProvider: remove use of deprecated API
  • 9131a8f: 8267940: [macos] java/awt/print/Dialog/DialogOwnerTest.java fails
  • 6096dd9: 8268893: jcmd to trim the glibc heap
  • c36755d: Merge
  • ... and 200 more: https://git.openjdk.java.net/jdk/compare/1578979df706ae9f4324931e1fc0d58265762c79...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Jul 22, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Jul 22, 2021
@openjdk
Copy link

openjdk bot commented Jul 22, 2021

@jonathan-gibbons Pushed as commit c1c4048.

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

@jonathan-gibbons jonathan-gibbons deleted the 8249634.implict-constructor branch Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler integrated javadoc
2 participants