RFR: JDK-8325687: SimpleJavaFileObject specification would benefit from implSpec

[Jonathan Gibbons]

On Wed, 14 Feb 2024 21:51:57 GMT, Joe Darcy <darcy at openjdk.org> wrote:

> While reading the spec in the context of another potential change, noticed some cases where using implSpec would lead to a better structured specification.

src/java.compiler/share/classes/javax/tools/SimpleJavaFileObject.java line 106:

> 104:      * {@inheritDoc FileObject}
> 105:      * @implSpec
> 106:      * This implementation wraps the result of {@linkplain #getCharContent} in a Reader.

suggest `{@code Reader}` or `{@link Reader}`

src/java.compiler/share/classes/javax/tools/SimpleJavaFileObject.java line 139:

> 137:      * {@inheritDoc FileObject}
> 138:      * @implSpec
> 139:      * This implementation wraps the result of openOutputStream in a Writer.

Suggest using `{@code }` or `{@link }` for `openOutputStream` and `Writer`

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/17854#discussion_r1491669533
PR Review Comment: https://git.openjdk.org/jdk/pull/17854#discussion_r1491670667