Re: [jdk17] RFR: 8268736: Use apiNote in AutoCloseable.close javadoc

2021-06-15 Thread Pavel Rappo
On Tue, 15 Jun 2021 18:05:18 GMT, Joe Darcy  wrote:

> The javadoc of AutoCloseable.close is from JDK 7 and thus predates tags like 
> @apiNote. However, some of the discussion contained in AutoCloseable.close is 
> more appropriate as an apiNote that normal text.

I'm confused: I thought that both https://openjdk.java.net/jeps/8068562 and the 
actual usages of `@apiNote` in `java.base` accumulated since then are advisory 
to the API users rather than to API implementors.

-

PR: https://git.openjdk.java.net/jdk17/pull/63


Re: [jdk17] RFR: 8268736: Use apiNote in AutoCloseable.close javadoc

2021-06-15 Thread Naoto Sato
On Tue, 15 Jun 2021 18:05:18 GMT, Joe Darcy  wrote:

> The javadoc of AutoCloseable.close is from JDK 7 and thus predates tags like 
> @apiNote. However, some of the discussion contained in AutoCloseable.close is 
> more appropriate as an apiNote that normal text.

Marked as reviewed by naoto (Reviewer).

-

PR: https://git.openjdk.java.net/jdk17/pull/63


Re: [jdk17] RFR: 8268736: Use apiNote in AutoCloseable.close javadoc

2021-06-15 Thread Brian Burkhalter
On Tue, 15 Jun 2021 18:05:18 GMT, Joe Darcy  wrote:

> The javadoc of AutoCloseable.close is from JDK 7 and thus predates tags like 
> @apiNote. However, some of the discussion contained in AutoCloseable.close is 
> more appropriate as an apiNote that normal text.

Marked as reviewed by bpb (Reviewer).

-

PR: https://git.openjdk.java.net/jdk17/pull/63


[jdk17] RFR: 8268736: Use apiNote in AutoCloseable.close javadoc

2021-06-15 Thread Joe Darcy
The javadoc of AutoCloseable.close is from JDK 7 and thus predates tags like 
@apiNote. However, some of the discussion contained in AutoCloseable.close is 
more appropriate as an apiNote that normal text.

-

Commit messages:
 - 8268736: Use apiNote in AutoCloseable.close javadoc

Changes: https://git.openjdk.java.net/jdk17/pull/63/files
 Webrev: https://webrevs.openjdk.java.net/?repo=jdk17=63=00
  Issue: https://bugs.openjdk.java.net/browse/JDK-8268736
  Stats: 3 lines in 1 file changed: 1 ins; 0 del; 2 mod
  Patch: https://git.openjdk.java.net/jdk17/pull/63.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk17 pull/63/head:pull/63

PR: https://git.openjdk.java.net/jdk17/pull/63