Re: RFR: JDK-8298405: Implement JEP 467: Markdown Documentation Comments [v51]

2024-03-18 Thread Jonathan Gibbons
> Please review a patch to add support for Markdown syntax in documentation 
> comments, as described in the associated JEP.
> 
> Notable features:
> 
> * support for `///` documentation comments in `JavaTokenizer`
> * new module `jdk.internal.md` -- a private copy of the `commonmark-java` 
> library
> * updates to `DocCommentParser` to treat `///` comments as Markdown
> * updates to the standard doclet to render Markdown comments in HTML

Jonathan Gibbons has updated the pull request with a new target base due to a 
merge or a rebase. The pull request now contains 71 commits:

 - update man page
 - Merge remote-tracking branch 'upstream/master' into 
8298405.doclet-markdown-v3
 - Merge with upstream/master
 - Merge with upstream/master
 - improve first-sentence break in Markdown comments
 - add test cases for links to anchors
 - fix `textOf` method to accommodate Markdown content.
 - avoid relying on unspecified behavior `List.toString`
 - fix test after merge
 - Merge remote-tracking branch 'upstream/master' into 
8298405.doclet-markdown-v3
 - ... and 61 more: https://git.openjdk.org/jdk/compare/c901da48...03652d2f

-

Changes: https://git.openjdk.org/jdk/pull/16388/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk=16388=50
  Stats: 23609 lines in 209 files changed: 22986 ins; 254 del; 369 mod
  Patch: https://git.openjdk.org/jdk/pull/16388.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/16388/head:pull/16388

PR: https://git.openjdk.org/jdk/pull/16388


Re: RFR: 8297879: javadoc link to preview JEP 1000 has grouping character comma

2024-03-18 Thread Vicente Romero
On Mon, 18 Mar 2024 14:53:44 GMT, Pavel Rappo  wrote:

> Please review this simple bugfix to properly construct links to preview JEPs.
> 
> The most straightforward fix I could think of was to pass `String` rather 
> than `int` (`Integer`) to a method, which eventually calls 
> `java.text.MessageFormat.format(String, Object...)`.
> 
> For the test, I decided to be ~lazy~ practical and piggyback on the existing 
> infrastructure. The alternatives were:
> 
>  1. slap `noreg-hard` on the JBS bug and skip testing
>  2. create a sophisticated test that dynamically adds a constant into the 
> `PreviewFeature.Feature` enum, annotates some class with `PreviewFeature` 
> with that constant, and finally documents that class with `PreviewFeature` 
> patched into `java.base`
> 
> While (1) is insufficient, (2) seems overkill in this case.

lgtm

-

Marked as reviewed by vromero (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/18350#pullrequestreview-1943594610


Re: RFR: 8297879: javadoc link to preview JEP 1000 has grouping character comma

2024-03-18 Thread Pavel Rappo
On Mon, 18 Mar 2024 14:53:44 GMT, Pavel Rappo  wrote:

> Please review this simple bugfix to properly construct links to preview JEPs.
> 
> The most straightforward fix I could think of was to pass `String` rather 
> than `int` (`Integer`) to a method, which eventually calls 
> `java.text.MessageFormat.format(String, Object...)`.
> 
> For the test, I decided to be ~lazy~ practical and piggyback on the existing 
> infrastructure. The alternatives were:
> 
>  1. slap `noreg-hard` on the JBS bug and skip testing
>  2. create a sophisticated test that dynamically adds a constant into the 
> `PreviewFeature.Feature` enum, annotates some class with `PreviewFeature` 
> with that constant, and finally documents that class with `PreviewFeature` 
> patched into `java.base`
> 
> While (1) is insufficient, (2) seems overkill in this case.

Hm... it's surprising to see that the Skara bots consider that 
src/java.base/share/classes/jdk/internal/javac/PreviewFeature.java belongs to 
core-libs, but not to compiler. Let me manually add it.

-

PR Comment: https://git.openjdk.org/jdk/pull/18350#issuecomment-2004168270


Re: RFR: 8297879: javadoc link to preview JEP 1000 has grouping character comma

2024-03-18 Thread Jonathan Gibbons
On Mon, 18 Mar 2024 14:53:44 GMT, Pavel Rappo  wrote:

> Please review this simple bugfix to properly construct links to preview JEPs.
> 
> The most straightforward fix I could think of was to pass `String` rather 
> than `int` (`Integer`) to a method, which eventually calls 
> `java.text.MessageFormat.format(String, Object...)`.
> 
> For the test, I decided to be ~lazy~ practical and piggyback on the existing 
> infrastructure. The alternatives were:
> 
>  1. slap `noreg-hard` on the JBS bug and skip testing
>  2. create a sophisticated test that dynamically adds a constant into the 
> `PreviewFeature.Feature` enum, annotates some class with `PreviewFeature` 
> with that constant, and finally documents that class with `PreviewFeature` 
> patched into `java.base`
> 
> While (1) is insufficient, (2) seems overkill in this case.

Marked as reviewed by jjg (Reviewer).

-

PR Review: https://git.openjdk.org/jdk/pull/18350#pullrequestreview-1943374124


RFR: 8297879: javadoc link to preview JEP 1000 has grouping character comma

2024-03-18 Thread Pavel Rappo
Please review this simple bugfix to properly construct links to preview JEPs.

The most straightforward fix I could think of was to pass `String` rather than 
`int` (`Integer`) to a method, which eventually calls 
`java.text.MessageFormat.format(String, Object...)`.

For the test, I decided to be ~lazy~ practical and piggyback on the existing 
infrastructure. The alternatives were:

 1. slap `noreg-hard` on the JBS bug and skip testing
 2. create a sophisticated test that dynamically adds a constant into the 
`PreviewFeature.Feature` enum, annotates some class with `PreviewFeature` with 
that constant, and finally documents that class with `PreviewFeature` patched 
into `java.base`

While (1) is insufficient, (2) seems overkill in this case.

-

Commit messages:
 - Initial commit

Changes: https://git.openjdk.org/jdk/pull/18350/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk=18350=00
  Issue: https://bugs.openjdk.org/browse/JDK-8297879
  Stats: 5 lines in 3 files changed: 0 ins; 0 del; 5 mod
  Patch: https://git.openjdk.org/jdk/pull/18350.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/18350/head:pull/18350

PR: https://git.openjdk.org/jdk/pull/18350