8340082: Use inline return tag in java.base #20981

jddarcy · 2024-09-13T02:47:18Z

Candidates for this refactoring were found programmatically; the program to find candidates is in a comment on the bug.

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-8340082: Use inline return tag in java.base (Enhancement - P4)

Reviewers

Iris Clark (@irisclark - Reviewer)
Pavel Rappo (@pavelrappo - Reviewer)
Lance Andersen (@LanceAndersen - Reviewer)
Daniel Jeliński (@djelinski - Reviewer)
Naoto Sato (@naotoj - Reviewer)
Chen Liang (@liach - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 20981

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-09-13T02:48:05Z

👋 Welcome back darcy! 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 · 2024-09-13T02:48:20Z

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

8340082: Use inline return tag in java.base

Reviewed-by: iris, prappo, lancea, djelinski, naoto, liach

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

1a0a538: 8340120: Remove redundant code in SegmentBulkOperations::mismatch
89ca89c: 8338626: ClassLoaderExt::process_jar_manifest() should allow / separator on Windows
3e0da58: 8333843: Provide guidelines on MemorySegment to read strings with known lengths
3c4d15b: 8334301: Errors in jpackage man page
4d01178: 8339927: Man page update for deprecating jhsdb debugd for removal
bd44cf8: 8330302: strace004 can still fail
8a4ea09: 8336492: Regression in lambda serialization
358ff19: 8339727: Open source several AWT focus tests - series 1
0c36177: 8340089: Simplify SegmentBulkOperations::powerOfProperty
bacd046: 8321010: RISC-V: C2 RoundVF
... and 3 more: https://git.openjdk.org/jdk/compare/5e5942a282e14846404b68c65d43594d6b9226d9...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 · 2024-09-13T02:48:56Z

@jddarcy The following labels will be automatically applied to this pull request:

core-libs
i18n
nio
security

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.

mlbridge · 2024-09-13T02:52:36Z

Webrevs

00: Full (f7cb6e23)

ExE-Boss

The old version of the doc comments had a . at the end of the first sentence:

ExE-Boss · 2024-09-13T07:25:38Z

src/java.base/share/classes/java/io/ObjectInputFilter.java

            /**
-             * Returns the pattern used to create this filter.
-             * @return the pattern used to create this filter
+             * {@return the pattern used to create this filter}


Suggested change

* {@return the pattern used to create this filter}

* {@return the pattern used to create this filter}.

ExE-Boss · 2024-09-13T07:25:43Z

src/java.base/share/classes/java/io/ObjectInputStream.java

        /**
-         * Returns the number of bytes read from the input stream.
-         * @return the number of bytes read from the input stream
+         * {@return the number of bytes read from the input stream}


Suggested change

* {@return the number of bytes read from the input stream}

* {@return the number of bytes read from the input stream}.

ExE-Boss · 2024-09-13T07:25:48Z

src/java.base/share/classes/java/lang/annotation/Retention.java

    /**
-     * Returns the retention policy.
-     * @return the retention policy
+     * {@return the retention policy}


Suggested change

* {@return the retention policy}

* {@return the retention policy}.

ExE-Boss · 2024-09-13T07:25:51Z

src/java.base/share/classes/java/nio/charset/MalformedInputException.java

    /**
-     * Returns the length of the input.
-     * @return the length of the input
+     * {@return the length of the input}


Suggested change

* {@return the length of the input}

* {@return the length of the input}.

ExE-Boss · 2024-09-13T07:25:55Z

src/java.base/share/classes/java/nio/charset/MalformedInputException.java

    /**
-     * Returns the message.
-     * @return the message
+     * {@return the message}


Suggested change

* {@return the message}

* {@return the message}.

ExE-Boss · 2024-09-13T07:27:03Z

src/java.base/share/classes/java/util/zip/Inflater.java

+     * {@return true if the end of the compressed data stream has been
+     * reached}


Suggested change

* {@return true if the end of the compressed data stream has been

* reached}

* {@return true if the end of the compressed data stream has been

* reached}.

ExE-Boss · 2024-09-13T07:27:07Z

src/java.base/share/classes/java/util/zip/Inflater.java

    /**
-     * Returns the ADLER-32 value of the uncompressed data.
-     * @return the ADLER-32 value of the uncompressed data
+     * {@return the ADLER-32 value of the uncompressed data}


Suggested change

* {@return the ADLER-32 value of the uncompressed data}

* {@return the ADLER-32 value of the uncompressed data}.

ExE-Boss · 2024-09-13T07:27:14Z

src/java.base/share/classes/java/util/zip/ZipEntry.java

    /**
-     * Returns the name of the entry.
-     * @return the name of the entry
+     * {@return the name of the entry}


Suggested change

* {@return the name of the entry}

* {@return the name of the entry}.

ExE-Boss · 2024-09-13T07:27:18Z

src/java.base/share/classes/java/util/zip/ZipFile.java

    /**
-     * Returns the path name of the ZIP file.
-     * @return the path name of the ZIP file
+     * {@return the path name of the ZIP file}


Suggested change

* {@return the path name of the ZIP file}

* {@return the path name of the ZIP file}.

ExE-Boss · 2024-09-13T07:27:23Z

src/java.base/share/classes/java/util/zip/ZipFile.java

    /**
-     * Returns an enumeration of the ZIP file entries.
-     * @return an enumeration of the ZIP file entries
+     * {@return an enumeration of the ZIP file entries}


Suggested change

* {@return an enumeration of the ZIP file entries}

* {@return an enumeration of the ZIP file entries}.

pavelrappo · 2024-09-13T09:13:25Z

The old version of the doc comments had a . at the end of the first sentence:

The new version has it too, but in the final, generated form: https://docs.oracle.com/en/java/javase/22/docs/specs/javadoc/doc-comment-spec.html#return

{@return blah} expands to Returns blah.

pavelrappo

Thanks, Joe. This looks good, especially considering that the change was produced with the help of a quick-and-dirty, regex-based script. This change is certainly enough to spread awareness of this relatively new javadoc feature.

I remember I had a more involved script that used javax.lang.model and string similarity metrics. That script captured a lot more candidates for {@return}. But on the other hand, once you start considering non-exact matches, it requires human judgement and increases review effort.

Separately, this PR has helped me put a finger on what I don't like about {@return}. What I don't like is the generated HTML. {@return} saves mental effort when reading raw javadoc in source, but it provides no similar service to the reader of the final, HTML form. Maybe it's just me, but it looks needlessly bloated and silly:

browser screenshot of javax.lang.model.element.AnnotationValue#getValue

Maybe if a method's main description consisted only of {@return}, we could skip the first sentence in the "Method Details" section and just output Returns:? Any further discussion should happen on the javadoc-dev mailing list.

LanceAndersen

I went through the changes and they look fine.

liach · 2024-09-13T13:07:03Z

This patch only captures one-line returns without extra sentences. Is it possible for us to handle slightly more complex documentations like ParameterizedType::getActualTypeArguments?

jdk/src/java.base/share/classes/java/lang/reflect/ParameterizedType.java

Lines 50 to 58 in f7cb6e2

    
                * Returns an array of {@code Type} objects representing the actual type 
        
                * arguments to this type. 
        
                * 
        
                * <p>Note that in some cases, the returned array be empty. This can occur 
        
                * if this type represents a non-parameterized type nested within 
        
                * a parameterized type. 
        
                * 
        
                * @return an array of {@code Type} objects representing the actual type 
        
                *     arguments to this type

pavelrappo · 2024-09-13T13:13:58Z

This patch only captures one-line returns without extra sentences. Is it possible for us to handle slightly more complex documentations like ParameterizedType::getActualTypeArguments?

Sure, it is possible. However, there's a tradeoff between comprehensiveness and the effort required. Joe's script provides a lot for a little.

If there's interest in it, we could file follow-up bugs to fix more cases with more powerful tools.

naotoj

java.nio.charset and java.time.format changes look good

jddarcy · 2024-09-13T16:35:25Z

This patch only captures one-line returns without extra sentences. Is it possible for us to handle slightly more complex documentations like ParameterizedType::getActualTypeArguments?

Sure, it is possible. However, there's a tradeoff between comprehensiveness and the effort required. Joe's script provides a lot for a little.

If there's interest in it, we could file follow-up bugs to fix more cases with more powerful tools.

Yes, the quick and dirty program is only a "minimum viable product" level of functionality. It is not complete and doesn't catch all cases. Future improvements welcome!

liach

Looks good. It might be feasible to run a more complex tool that analyzes the tokenized javadoc AST from javac as later work.

Annotation changes look good.

jddarcy · 2024-09-13T16:49:19Z

/integrate

openjdk · 2024-09-13T16:49:29Z

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

1a0a538: 8340120: Remove redundant code in SegmentBulkOperations::mismatch
89ca89c: 8338626: ClassLoaderExt::process_jar_manifest() should allow / separator on Windows
3e0da58: 8333843: Provide guidelines on MemorySegment to read strings with known lengths
3c4d15b: 8334301: Errors in jpackage man page
4d01178: 8339927: Man page update for deprecating jhsdb debugd for removal
bd44cf8: 8330302: strace004 can still fail
8a4ea09: 8336492: Regression in lambda serialization
358ff19: 8339727: Open source several AWT focus tests - series 1
0c36177: 8340089: Simplify SegmentBulkOperations::powerOfProperty
bacd046: 8321010: RISC-V: C2 RoundVF
... and 3 more: https://git.openjdk.org/jdk/compare/5e5942a282e14846404b68c65d43594d6b9226d9...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-09-13T16:49:36Z

@jddarcy Pushed as commit 89c172a.

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

JDK-8340082: Use inline return tag in java.base

f7cb6e2

openjdk bot changed the title ~~JDK-8340082: Use inline return tag in java.base~~ 8340082: Use inline return tag in java.base Sep 13, 2024

openjdk bot added the rfr Pull request is ready for review label Sep 13, 2024

openjdk bot added security security-dev@openjdk.org nio nio-dev@openjdk.org core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Sep 13, 2024

irisclark approved these changes Sep 13, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Sep 13, 2024

ExE-Boss reviewed Sep 13, 2024

View reviewed changes

pavelrappo approved these changes Sep 13, 2024

View reviewed changes

LanceAndersen approved these changes Sep 13, 2024

View reviewed changes

djelinski approved these changes Sep 13, 2024

View reviewed changes

naotoj approved these changes Sep 13, 2024

View reviewed changes

liach approved these changes Sep 13, 2024

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Sep 13, 2024

openjdk bot closed this Sep 13, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 13, 2024

jddarcy deleted the JDK-8340082 branch October 17, 2024 16:46

	* {@return the pattern used to create this filter}
	* {@return the pattern used to create this filter}.

	* {@return the number of bytes read from the input stream}
	* {@return the number of bytes read from the input stream}.

	* {@return the retention policy}
	* {@return the retention policy}.

	* {@return the length of the input}
	* {@return the length of the input}.

		* {@return true if the end of the compressed data stream has been
		* reached}

	* {@return the ADLER-32 value of the uncompressed data}
	* {@return the ADLER-32 value of the uncompressed data}.

	* {@return the name of the entry}
	* {@return the name of the entry}.

	* {@return the path name of the ZIP file}
	* {@return the path name of the ZIP file}.

	* {@return an enumeration of the ZIP file entries}
	* {@return an enumeration of the ZIP file entries}.

8340082: Use inline return tag in java.base #20981

8340082: Use inline return tag in java.base #20981

Uh oh!

Conversation

jddarcy commented Sep 13, 2024 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Sep 13, 2024

Uh oh!

openjdk bot commented Sep 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Sep 13, 2024

Uh oh!

mlbridge bot commented Sep 13, 2024

Webrevs

Uh oh!

ExE-Boss left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pavelrappo commented Sep 13, 2024

Uh oh!

pavelrappo left a comment

Choose a reason for hiding this comment

Uh oh!

LanceAndersen left a comment

Choose a reason for hiding this comment

Uh oh!

liach commented Sep 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pavelrappo commented Sep 13, 2024

Uh oh!

naotoj left a comment

Choose a reason for hiding this comment

Uh oh!

jddarcy commented Sep 13, 2024

Uh oh!

liach left a comment

Choose a reason for hiding this comment

Uh oh!

jddarcy commented Sep 13, 2024

Uh oh!

openjdk bot commented Sep 13, 2024

Uh oh!

openjdk bot commented Sep 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

8 participants

jddarcy commented Sep 13, 2024 •

edited by openjdk bot

Loading

openjdk bot commented Sep 13, 2024 •

edited

Loading

liach commented Sep 13, 2024 •

edited

Loading