Re: RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v67]

2024-05-15 Thread Jonathan Gibbons
On Wed, 15 May 2024 10:08:19 GMT, Pavel Rappo  wrote:

> I think we should add a test to verify that if `--disable-line-doc-comments` 
> is specified, no `///` dangling comments are reported.

Added more tests for dangling doc comments.

Note we cannot currently use `-Xlint:dangling-doc-comments` in javadoc itself, 
so the new tests are part of the javac set of tests.

-

PR Comment: https://git.openjdk.org/jdk/pull/16388#issuecomment-2113453038


Re: RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v67]

2024-05-15 Thread Pavel Rappo
On Tue, 7 May 2024 17:31:29 GMT, Jonathan Gibbons  wrote:

>> 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 91 commits:
> 
>  - Merge remote-tracking branch 'upstream/master' into 
> 8298405.doclet-markdown-v3
>  - Remove `--no-fonts` from `MISSING_IN_MAN_PAGE`
>  - Update javadoc.1 troff man page
>  - Merge remote-tracking branch 'upstream/master' into 
> 8298405.doclet-markdown-v3
>  - address review feedback, to improve testing of changes to Elements
>  - update copyright years
>  - Merge remote-tracking branch 'upstream/master' into 
> 8298405.doclet-markdown-v3
>  - update commonmark-java from 0.21.0 to 0.22.0
>  - Remove links to `jdk.javadoc` module from `java.compiler` module`
>  - Suppress warnings building tests
>  - ... and 81 more: https://git.openjdk.org/jdk/compare/524aaad9...cc12140a

I think we should add a test to verify that if `--disable-line-doc-comments` is 
specified, no `///` dangling comments are reported.

-

PR Comment: https://git.openjdk.org/jdk/pull/16388#issuecomment-2112100605


Re: RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v67]

2024-05-07 Thread Joe Darcy
On Tue, 7 May 2024 17:31:29 GMT, Jonathan Gibbons  wrote:

>> 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 91 commits:
> 
>  - Merge remote-tracking branch 'upstream/master' into 
> 8298405.doclet-markdown-v3
>  - Remove `--no-fonts` from `MISSING_IN_MAN_PAGE`
>  - Update javadoc.1 troff man page
>  - Merge remote-tracking branch 'upstream/master' into 
> 8298405.doclet-markdown-v3
>  - address review feedback, to improve testing of changes to Elements
>  - update copyright years
>  - Merge remote-tracking branch 'upstream/master' into 
> 8298405.doclet-markdown-v3
>  - update commonmark-java from 0.21.0 to 0.22.0
>  - Remove links to `jdk.javadoc` module from `java.compiler` module`
>  - Suppress warnings building tests
>  - ... and 81 more: https://git.openjdk.org/jdk/compare/524aaad9...cc12140a

The `javax.lang.model` portions look good; the reminder needs review by others.

-

Marked as reviewed by darcy (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/16388#pullrequestreview-2044237602


Re: RFR: 8298405: Implement JEP 467: Markdown Documentation Comments [v67]

2024-05-07 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 91 commits:

 - Merge remote-tracking branch 'upstream/master' into 
8298405.doclet-markdown-v3
 - Remove `--no-fonts` from `MISSING_IN_MAN_PAGE`
 - Update javadoc.1 troff man page
 - Merge remote-tracking branch 'upstream/master' into 
8298405.doclet-markdown-v3
 - address review feedback, to improve testing of changes to Elements
 - update copyright years
 - Merge remote-tracking branch 'upstream/master' into 
8298405.doclet-markdown-v3
 - update commonmark-java from 0.21.0 to 0.22.0
 - Remove links to `jdk.javadoc` module from `java.compiler` module`
 - Suppress warnings building tests
 - ... and 81 more: https://git.openjdk.org/jdk/compare/524aaad9...cc12140a

-

Changes: https://git.openjdk.org/jdk/pull/16388/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk=16388=66
  Stats: 26446 lines in 243 files changed: 25749 ins; 257 del; 440 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