RFR: JDK-8286101: Support formatting in @value tag

Jonathan Gibbons jjg at openjdk.java.net
Tue May 17 22:00:17 UTC 2022


This PR is for an update to the doc comment `{@value}` tag to permit an optional [format string](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Formatter.html#syntax) after the name of the tag.

    {@value optional-format-string optional-reference}

If given, the format string should either begin with `%` or the string should be quoted with `"`. For example, `%4x` or `"0x%4x"`.  The format string must contain exactly one `%` character.

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

Commit messages:
 - address review feedback
 - Merge remote-tracking branch 'upstream/master' into 8286101.format-at-value
 - JDK-8286101: Support formatting in @value tag

Changes: https://git.openjdk.java.net/jdk/pull/8565/files
 Webrev: https://webrevs.openjdk.java.net/?repo=jdk&pr=8565&range=00
  Issue: https://bugs.openjdk.java.net/browse/JDK-8286101
  Stats: 336 lines in 18 files changed: 322 ins; 0 del; 14 mod
  Patch: https://git.openjdk.java.net/jdk/pull/8565.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/8565/head:pull/8565

PR: https://git.openjdk.java.net/jdk/pull/8565


More information about the javadoc-dev mailing list