Re: RFR: 8322708: Global HTML attributes are not allowed [v5]

2024-06-18 Thread Jonathan Gibbons
On Fri, 14 Jun 2024 02:32:16 GMT, Nizar Benalla wrote: >> Nizar Benalla has updated the pull request incrementally with one additional >> commit since the last revision: >> >> whitespace > > src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/Checker.java line > 695: > >> 693:

Re: RFR: 8322708: Global HTML attributes are not allowed [v5]

2024-06-18 Thread Jonathan Gibbons
On Fri, 14 Jun 2024 19:16:26 GMT, Nizar Benalla wrote: >> Can I please get a review for this change, that aims to add support for >> Global HTML tags. >> Here is the >> [link](https://cr.openjdk.org/~nbenalla/javadocGlobalPR/pkg1/package-summary.html) >> to the generated docs. >> Thanks in

Re: RFR: 8322708: Global HTML attributes are not allowed [v3]

2024-06-14 Thread Jonathan Gibbons
On Tue, 11 Jun 2024 13:03:47 GMT, Pavel Rappo wrote: >> Nizar Benalla has updated the pull request with a new target base due to a >> merge or a rebase. The incremental webrev excludes the unrelated changes >> brought in by the merge/rebase. The pull request contains ten additional >> commits

Re: RFR: 8322708: Global HTML attributes are not allowed [v3]

2024-06-14 Thread Jonathan Gibbons
On Tue, 11 Jun 2024 22:12:42 GMT, Jonathan Gibbons wrote: >> Nizar Benalla has updated the pull request with a new target base due to a >> merge or a rebase. The incremental webrev excludes the unrelated changes >> brought in by the merge/rebase. The pull request conta

Re: RFR: 8322708: Global HTML attributes are not allowed [v3]

2024-06-14 Thread Jonathan Gibbons
On Fri, 14 Jun 2024 12:12:51 GMT, Nizar Benalla wrote: >> Can I please get a review for this change, that aims to add support for >> Global HTML tags. >> Here is the >> [link](https://cr.openjdk.org/~nbenalla/javadocGlobalPR/pkg1/package-summary.html) >> to the generated docs. >> Thanks in

Re: RFR: 8322708: Global HTML attributes are not allowed [v3]

2024-06-14 Thread Jonathan Gibbons
On Tue, 11 Jun 2024 13:41:58 GMT, Pavel Rappo wrote: >> If we are ordering the entries, we can use comparable to check that an attr >> is greater than the start of the global attr, something like >> >> private static boolean isGlobalAttr(Attr value) { >> return

Re: RFR: 8322708: Global HTML attributes are not allowed [v3]

2024-06-14 Thread Jonathan Gibbons
On Tue, 11 Jun 2024 12:40:23 GMT, Nizar Benalla wrote: >> Either what Chen has suggested or re-sort the complete list alphabetically >> as it was prior to this change, well, almost. > >> Either what Chen has suggested or re-sort the complete list alphabetically >> as it was prior to this

Re: RFR: 8322708: Global HTML attributes are not allowed [v3]

2024-06-14 Thread Jonathan Gibbons
On Tue, 11 Jun 2024 15:09:03 GMT, Pavel Rappo wrote: >> I think like being slightly restrictive and safe. > > As @jonathan-gibbons likes to point out, javadoc is not an HTML validation > tool. So I think, it's okay to leave the code simple. Maybe this would be > even simp

Re: RFR: 8325690: The scrollable element with non-interactive content is not tabbable [v23]

2024-06-13 Thread Jonathan Gibbons
On Mon, 3 Jun 2024 06:37:22 GMT, psoujany wrote: >> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Table.java >> line 349: >> >>> 347: * For more information on the `widget_tabbable_single` >>> rule, please refer to the following documentation: >>> 348:

Re: RFR: 8333827: JDK 23 RDP1 L10n resource files update [v2]

2024-06-10 Thread Jonathan Gibbons
the language or tools, (e.g. >> `the name of this class`, ``, ``. >> >> This change seems to be going backwards. >> >> Whatever the policy we use for translating (or not translating) parts of a >> message, we should be consistent across all tools and documents. >

Re: RFR: 8333827: JDK 23 RDP1 L10n resource files update

2024-06-10 Thread Jonathan Gibbons
y, the diffs are viewable here and was generated using Jonathan > Gibbons' diff tool for l10n: > https://cr.openjdk.org/~dnguyen/output2/ src/jdk.compiler/share/classes/com/sun/tools/javac/resources/compiler_de.properties line 409: > 407: compiler.err.unconditional.pattern.and.default=Switch umfas

Re: RFR: 8333827: JDK 23 RDP1 L10n resource files update

2024-06-10 Thread Jonathan Gibbons
On Sun, 9 Jun 2024 22:07:44 GMT, Damon Nguyen wrote: >> src/jdk.jshell/share/classes/jdk/internal/jshell/tool/resources/l10n_de.properties >> line 183: >> >>> 181: jshell.fix.wrong.shortcut =Unerwartetes Zeichen nach >>> Umschalt+Tab.\nVerwenden Sie "I" für automatischen Import, "V" zur >>>

Re: [External] : Re: Missing element-list for https://docs.oracle.com/javase/8/docs/jre/api/security/jgss/spec

2024-06-06 Thread Jonathan Gibbons
On 6/5/24 2:51 AM, Osipov, Michael wrote: On 2024-05-31 21:38, Jonathan Gibbons wrote: Michael, There is no `element-list` file for any version of JDK before JDK 9. Before JDK 9, the appropriate information was in the `package-list` file. In JDK 9, with the introduction of modules, the format

Re: RFR: 8332039: Cannot invoke "com.sun.source.util.DocTreePath.getTreePath()" because "path" is null

2024-05-31 Thread Jonathan Gibbons
On Fri, 31 May 2024 09:20:27 GMT, Pavel Rappo wrote: >> I understand the solution and see how it logically parallels the existing >> link between `getDocTreePath` and inheritable taglets. That said, I dislike >> the solution, but also cannot propose a better one at this time. The logic >> is

Re: RFR: 8325168: JShell should support Markdown comments [v5]

2024-05-31 Thread Jonathan Gibbons
On Fri, 31 May 2024 06:28:28 GMT, Jan Lahoda wrote: >> This is an attempt to add Markdown support in documentation comments to >> JShell. >> >> It works by converting the Markdown text to HTML during the process of >> resolving `{@inheritDoc}` tags. > > Jan Lahoda has updated the pull request

Re: Missing element-list for https://docs.oracle.com/javase/8/docs/jre/api/security/jgss/spec

2024-05-31 Thread Jonathan Gibbons
Michael, There is no `element-list` file for any version of JDK before JDK 9.    Before JDK 9, the appropriate information was in the `package-list` file. In JDK 9, with the introduction of modules, the format of the file was updated to include modules, and because this was an incompatible

Re: RFR: 8329537: Nested and enclosing classes should be linked separately in breadcrumb navigation

2024-05-30 Thread Jonathan Gibbons
On Wed, 29 May 2024 19:39:14 GMT, Hannes Wallnöfer wrote: > Please review a patch to change the breadcrumb sub-navigation in API docs to > display nested classes as separate links. > > The change itself is simple, I replaced the `getBreadCrumbLink` method in > `HtmlDocletWriter` which

Re: RFR: 8331579: Reference to primitive type fails without error or warning

2024-05-30 Thread Jonathan Gibbons
On Tue, 28 May 2024 12:28:53 GMT, Hannes Wallnöfer wrote: > Please review a simple fix to make DocLint report an error when linking to > non-declared types in `{@link}` or `@see` tags. This has been implemented > when the Standard Doclet is running without DocLint in >

Re: RFR: 8332039: Cannot invoke "com.sun.source.util.DocTreePath.getTreePath()" because "path" is null

2024-05-30 Thread Jonathan Gibbons
On Thu, 30 May 2024 18:43:28 GMT, Pavel Rappo wrote: > I understand the solution and see how it logically parallels the existing > link between `getDocTreePath` and inheritable taglets. That said, I dislike > the solution, but also cannot propose a better one at this time. The logic is >

Re: RFR: 8332039: Cannot invoke "com.sun.source.util.DocTreePath.getTreePath()" because "path" is null

2024-05-30 Thread Jonathan Gibbons
On Thu, 23 May 2024 10:39:52 GMT, Hannes Wallnöfer wrote: > Please review a patch to fix a NPE thrown when a `@since` tag inherited by a > nested class contains a nested inline tag. The solution is to make > `CommentHelper.getDocTreePath(DocTree)` able to handle block tags inherited > by

Re: RFR: 8332039: Cannot invoke "com.sun.source.util.DocTreePath.getTreePath()" because "path" is null

2024-05-30 Thread Jonathan Gibbons
On Thu, 30 May 2024 18:33:25 GMT, Jonathan Gibbons wrote: >> Please review a patch to fix a NPE thrown when a `@since` tag inherited by a >> nested class contains a nested inline tag. The solution is to make >> `CommentHelper.getDocTreePath(DocTree)` able to handle bl

Re: RFR: 8332858: References with escapes have broken positions after they are transformed [v2]

2024-05-29 Thread Jonathan Gibbons
On Wed, 29 May 2024 11:50:14 GMT, Jan Lahoda wrote: >> If the javadoc comment contains a (Markdown) link like: >> >> [java.util.Arrays#asList(Object[])] >> >> >> The transformer that converts this link into the Javadoc link will not find >> the reference, as it is looking for

Re: RFR: 8332858: References with escapes have broken positions after they are transformed

2024-05-28 Thread Jonathan Gibbons
On Tue, 28 May 2024 19:07:06 GMT, Vicente Romero wrote: >> Sorry for the belated answer. Yes, regexps are usually not very performant, >> but it is only happening when the exact match fails. And, hopefully, the >> regexp should not be too difficult to handle. I was considering writing the >>

Re: RFR: 8332858: References with escapes have broken positions after they are transformed

2024-05-28 Thread Jonathan Gibbons
On Fri, 24 May 2024 09:05:20 GMT, Jan Lahoda wrote: > If the javadoc comment contains a (Markdown) link like: > > [java.util.Arrays#asList(Object[])] > > > The transformer that converts this link into the Javadoc link will not find > the reference, as it is looking for

Re: RFR: 8331873: Improve/expand info in `New API In` on Help page

2024-05-28 Thread Jonathan Gibbons
On Fri, 24 May 2024 15:47:02 GMT, Hannes Wallnöfer wrote: >> Please review a relatively simple update to the generated Help page, as part >> of the ongoing campaign to improve the documentation around the overall use >> of `@since` tags. > >

Integrated: 8332545: Fix handling of HTML5 entities in Markdown comments

2024-05-20 Thread Jonathan Gibbons
On Mon, 20 May 2024 20:17:10 GMT, Jonathan Gibbons wrote: > Please review a small fix to address a crash when handling HTML5 entities in > a Markdown doc comment. > > The path for the `entities.txt` (originally `entities.properties`) was not > correctly imported when impor

Re: RFR: 8332545: Fix handling of HTML5 entities in Markdown comments

2024-05-20 Thread Jonathan Gibbons
On Mon, 20 May 2024 23:21:31 GMT, Erik Joelsson wrote: > Build change looks good. Thank you - PR Comment: https://git.openjdk.org/jdk/pull/19317#issuecomment-2121488205

Re: RFR: 8332545: Fix handling of HTML5 entities in Markdown comments

2024-05-20 Thread Jonathan Gibbons
On Mon, 20 May 2024 21:20:29 GMT, Pavel Rappo wrote: > Assuming the test fails without the fix, but passes with it, looks good. Confirmed the test fails without the fix (crash, as reported) and passes with the fix. - PR Comment:

RFR: 8332545: Fix handling of HTML5 entities in Markdown comments

2024-05-20 Thread Jonathan Gibbons
Please review a small fix to address a crash when handling HTML5 entities in a Markdown doc comment. The path for the `entities.txt` (originally `entities.properties`) was not correctly imported when importing the latest version of `commonmark-java`. And, the makefiles need to be updated to

Integrated: 8298405: Implement JEP 467: Markdown Documentation Comments

2024-05-17 Thread Jonathan Gibbons
On Thu, 26 Oct 2023 23:29:00 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 `JavaTokeniz

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

2024-05-16 Thread Jonathan Gibbons
On Thu, 16 May 2024 16:44:51 GMT, Hannes Wallnöfer wrote: >> Jonathan Gibbons has updated the pull request incrementally with one >> additional commit since the last revision: >> >> update tests for dangling doc comments, per review feedback > > src/jdk.jav

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

2024-05-16 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revisi

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

2024-05-16 Thread Jonathan Gibbons
On Thu, 16 May 2024 15:05:32 GMT, Jonathan Gibbons wrote: > There were some community comments objecting the use of `///` for markdown > documentation, and called for alternative syntaxes like `/*markdown */`. This was [addressed](https://openjdk.org/jeps/467#Using-///-for-Ma

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

2024-05-16 Thread Jonathan Gibbons
On Thu, 16 May 2024 15:03:26 GMT, Pavel Rappo wrote: > If you are concerned with it being a lint warning rather than a **doc**lint > warning, then it's a technicality: doclint sees less than lint sees, and > sadly not enough for that check. Thus, that check was put in `lint. To clarify that a

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

2024-05-16 Thread Jonathan Gibbons
On Thu, 16 May 2024 15:03:26 GMT, Pavel Rappo wrote: > My rationale for a potential preview is that we changed > `-Xlint:dangling-doc-comments` as `///` is now dangling doc comment. Is this > considered a Java programming language change? There were some community > comments objecting the use

Re: RFR: 8332239: Improve CSS for block tags

2024-05-16 Thread Jonathan Gibbons
On Thu, 16 May 2024 10:56:26 GMT, Hannes Wallnöfer wrote: > Please review a change to improve the layout of definition lists used to > display block tags: > > - Add indentation to the `` elements used for block tag details > - Set the margin of lists within block tag details so they do not

Re: RFR: 8317621: --add-script should support JavaScript modules [v2]

2024-05-15 Thread Jonathan Gibbons
On Wed, 15 May 2024 13:08:39 GMT, Hannes Wallnöfer wrote: >> Please review an enhancement to detect [JavaScript >> modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) >> when added to `javadoc` with the `--add-script` option, which require a >> different `type`

Re: RFR: 8329617: Update stylesheet for specs and tool documentation

2024-05-15 Thread Jonathan Gibbons
On Tue, 9 Apr 2024 13:06:28 GMT, Hannes Wallnöfer wrote: > Please review an update to the `jdk-default.css` stylesheet used for > specifications and tool guides. The original purpose was to make use of the > Dejavu web fonts provided by the API docs and to update the navigation bar to > match

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`

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

2024-05-15 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: update t

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

2024-05-15 Thread Jonathan Gibbons
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

Re: RFR: 8294880: Review running time of jdk/internal/shellsupport/doc/JavadocHelperTest.java [v3]

2024-05-14 Thread Jonathan Gibbons
On Fri, 10 May 2024 13:42:43 GMT, Hannes Wallnöfer wrote: >> Please review a change to move a long-running shellsupport test from >> langtools tier1 to tier2, while modifying the tier1 test to only retrieve >> doc comments for members of `java.lang.StringBuilder`, which is where [the >>

Re: RFR: 8329617: Update stylesheet for specs and tool documentation

2024-05-14 Thread Jonathan Gibbons
On Tue, 9 Apr 2024 13:06:28 GMT, Hannes Wallnöfer wrote: > Please review an update to the `jdk-default.css` stylesheet used for > specifications and tool guides. The original purpose was to make use of the > Dejavu web fonts provided by the API docs and to update the navigation bar to > match

Re: RFR: 8317621: --add-script should support JavaScript modules

2024-05-14 Thread Jonathan Gibbons
On Fri, 29 Mar 2024 09:39:18 GMT, Hannes Wallnöfer wrote: > Please review an enhancement to detect [JavaScript > modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) > when added to `javadoc` with the `--add-script` option, which require a > different `type`

Re: RFR: 8332109: Convert remaining tests using com.sun.tools.classfile to ClassFile API

2024-05-14 Thread Jonathan Gibbons
On Sun, 12 May 2024 08:36:44 GMT, Chen Liang wrote: > Some tests are not migrated to the ClassFile API in previous migrations. > > - Some are simple oversights that didn't remove usages of > com.sun.tools.classfile; > - The CallerSensitive ones used an old utility, replaced by CF API-based

RFR: 8331873: Improve/expand info in `New API In` on Help page.

2024-05-13 Thread Jonathan Gibbons
Please review a relatively simple update to the generated Help page, as part of the ongoing campaign to improve the documentation around the overall use of `@since` tags. - Commit messages: - 8331873: Improve/expand info in `New API In` on Help page. Changes:

Re: RFR: 8332080: Update troff man page for javadoc

2024-05-10 Thread Jonathan Gibbons
On Fri, 10 May 2024 16:15:36 GMT, Hannes Wallnöfer wrote: > Please review a patch to update to the javadoc man page to add the > `--no-fonts` option and fix a typo. Marked as reviewed by jjg (Reviewer). - PR Review:

Re: RFR: 8329718: Incorrect `@since` tags in elements in jdk.compiler and java.compiler

2024-05-07 Thread Jonathan Gibbons
On Fri, 26 Apr 2024 11:05:03 GMT, Nizar Benalla wrote: > This PR aims to add `@since` tags in elements in both `jdk.compiler` and > `java.compiler`. > A lot of these changes have to do with handling of preview features. > > The existing rules for handling of `@since` for preview elements: > -

Re: RFR: 8330205: Initial troff manpage generation for JDK 24

2024-05-07 Thread Jonathan Gibbons
On Tue, 7 May 2024 11:53:19 GMT, Pavel Rappo wrote: > Please review this mechanical change to man pages. This PR should be > integrated after https://github.com/openjdk/jdk/pull/18787. Marked as reviewed by jjg (Reviewer). - PR Review:

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

2024-05-07 Thread Jonathan Gibbons
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

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

2024-05-06 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revisio

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

2024-05-06 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: U

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

2024-05-01 Thread Jonathan Gibbons
On Fri, 12 Apr 2024 17:39:11 GMT, Joe Darcy wrote: > There should be some quick testing of the new default method on Elements > using the VacuousElements implementation; see > `test/langtools/tools/javac/processing/model/util/elements` for some examples. @jddarcy I've reorganized the tests in

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

2024-05-01 Thread Jonathan Gibbons
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

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

2024-05-01 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: addre

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

2024-04-30 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revis

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

2024-04-30 Thread Jonathan Gibbons
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

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

2024-04-30 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: upda

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

2024-04-29 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: Remove

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

2024-04-26 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: Su

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

2024-04-26 Thread Jonathan Gibbons
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

Integrated: 8303689: javac -Xlint could/should report on "dangling" doc comments

2024-04-26 Thread Jonathan Gibbons
On Wed, 27 Mar 2024 22:04:30 GMT, Jonathan Gibbons wrote: > Please review the updates to support a proposed new > `-Xlint:dangling-doc-comments` option. > > The work can be thought of as in 3 parts: > > 1. An update to the `javac` internal class `DeferredLintHandler` so that

Re: RFR: 8296175: Output warning if generated docs contain diagnostic markers

2024-04-26 Thread Jonathan Gibbons
On Fri, 26 Apr 2024 16:40:33 GMT, Pavel Rappo wrote: > The feature is good, but I'm surprised to see it being tested in > DocLintTest.java. Yeah, good point. The message should be generated independently of any doclint settings. - PR Comment:

Re: RFR: 8296175: Output warning if generated docs contain diagnostic markers

2024-04-26 Thread Jonathan Gibbons
On Fri, 26 Apr 2024 15:14:04 GMT, Hannes Wallnöfer wrote: > Please review a change to print a terminal message if the documentation > generated by `HtmlDoclet` contains any diagnostic marker elements for invalid > input. The message is printed after the documentation has been generated and >

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v10]

2024-04-26 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/**

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v9]

2024-04-25 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/**` t

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v8]

2024-04-25 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/*

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v7]

2024-04-23 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/*

Integrated: 8330704: Clean up non-standard use of /** comments in some langtools tests

2024-04-22 Thread Jonathan Gibbons
On Mon, 22 Apr 2024 18:02:39 GMT, Jonathan Gibbons wrote: > Please review a simple change to clean up inappropriate use of `/**` comments > in test code -- most notably to enclose the `jtreg` test description. > > There is no change to the functionality of any test, and (ob

RFR: 8330704: Clean up non-standard use of /** comments in some langtools tests

2024-04-22 Thread Jonathan Gibbons
Please review a simple change to clean up inappropriate use of `/**` comments in test code -- most notably to enclose the `jtreg` test description. There is no change to the functionality of any test, and (obviously) all tests continue to pass. - Commit messages: - JDK-8330704:

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v6]

2024-04-18 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/*

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v5]

2024-04-18 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/**` t

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v4]

2024-04-18 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/**`

Integrated: 8324342: Doclet should default @since for a nested class to that of its enclosing class

2024-04-18 Thread Jonathan Gibbons
On Wed, 20 Mar 2024 19:04:04 GMT, Jonathan Gibbons wrote: > Please review changes to the support for `since`, `author`, and `version` > tags, such that if there are no such tags on a nested class, the doclet will > look for any such tags in enclosing classes. This pull request has

Re: RFR: 8324342: Doclet should default @since for a nested class to that of its enclosing class [v2]

2024-04-18 Thread Jonathan Gibbons
> Please review changes to the support for `since`, `author`, and `version` > tags, such that if there are no such tags on a nested class, the doclet will > look for any such tags in enclosing classes. Jonathan Gibbons has updated the pull request incrementally with one additional com

Re: RFR: 8324342: Doclet should default @since for a nested class to that of its enclosing class

2024-04-18 Thread Jonathan Gibbons
On Mon, 8 Apr 2024 12:07:25 GMT, Pavel Rappo wrote: > This looks like the right thing to do; thanks for doing this. > > A general comment regarding the test cases. It would be better if: > > * the nesting was at least two levels deep (`public class Foo { static class > Bar { static class Baz

Re: RFR: 8324342: Doclet should default @since for a nested class to that of its enclosing class

2024-04-16 Thread Jonathan Gibbons
On Mon, 8 Apr 2024 11:53:25 GMT, Pavel Rappo wrote: >> Please review changes to the support for `since`, `author`, and `version` >> tags, such that if there are no such tags on a nested class, the doclet will >> look for any such tags in enclosing classes. > >

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v3]

2024-04-12 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/**`

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v2]

2024-04-12 Thread Jonathan Gibbons
On Wed, 3 Apr 2024 10:01:37 GMT, Magnus Ihse Bursie wrote: >> Jonathan Gibbons has updated the pull request incrementally with one >> additional commit since the last revision: >> >> adjust call for `saveDanglingDocComments` for enum members > > The build change

Re: RFR: 8303689: javac -Xlint could/should report on "dangling" doc comments [v2]

2024-04-11 Thread Jonathan Gibbons
for the dangling > * comments, subject to the {@code -Xlint} and > * {@code @SuppressWarnings}. > > > 3. Updates to the make files to disable the warnings in modules for which > the > warning is generated. This is often because of the confusing use of `/**` t

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

2024-04-11 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: addre

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

2024-04-11 Thread Jonathan Gibbons
On Tue, 9 Apr 2024 08:53:10 GMT, Pavel Rappo wrote: >> Jonathan Gibbons has updated the pull request incrementally with one >> additional commit since the last revision: >> >> add support for JDK-8329296: Update Elements for '///' documentation >> comments >

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

2024-04-08 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: add s

Re: RFR: 8325088: Overloads that differ in type parameters may be lost [v5]

2024-04-05 Thread Jonathan Gibbons
On Fri, 5 Apr 2024 19:47:40 GMT, Pavel Rappo wrote: > Does this make sense? While I am dubious about 3-tuples, your explanation makes enough sense that I accept your reply. Thanks for the explanation. - PR Comment: https://git.openjdk.org/jdk/pull/18519#issuecomment-2040539618

Re: RFR: JDK-8329717 Missing @since tags in elements in DocumentationTool and Taglet [v2]

2024-04-05 Thread Jonathan Gibbons
On Fri, 5 Apr 2024 15:53:40 GMT, Nizar Benalla wrote: >> Nizar Benalla has updated the pull request incrementally with one additional >> commit since the last revision: >> >> add blank line > > This PR is ready, I plan on integrating it at a later point. > I won't make anymore changes, I

Re: RFR: 8325088: Overloads that differ in type parameters may be lost [v5]

2024-04-05 Thread Jonathan Gibbons
On Fri, 5 Apr 2024 15:03:36 GMT, Pavel Rappo wrote: >> Creating a link to a constructor or a method or comparing constructors or >> methods __does not__ factor in type parameters. When constructors or methods >> are overloaded and differ only in type parameters -- a situation which is >>

Re: RFR: 8325088: Overloads that differ in type parameters may be lost [v4]

2024-04-04 Thread Jonathan Gibbons
On Thu, 4 Apr 2024 21:52:20 GMT, Pavel Rappo wrote: >> If you use `forMember` on an `ExecutableElement` whose enclosing element is >> an annotation type interface, you know there cannot be any type parameters. > > Right, but some accommodation/special-casing for annotations will be there >

Re: RFR: 8325088: Overloads that differ in type parameters may be lost [v4]

2024-04-04 Thread Jonathan Gibbons
On Thu, 4 Apr 2024 21:20:19 GMT, Pavel Rappo wrote: >> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlIds.java >> line 567: >> >>> 565: var methods = >>> vmt.getVisibleMembers(VisibleMemberTable.Kind.METHODS); >>> 566: // for whatever reason

Re: RFR: 8325088: Overloads that differ in type parameters may be lost [v4]

2024-04-04 Thread Jonathan Gibbons
On Thu, 4 Apr 2024 12:28:23 GMT, Pavel Rappo wrote: >> Creating a link to a constructor or a method or comparing constructors or >> methods __does not__ factor in type parameters. When constructors or methods >> are overloaded and differ only in type parameters -- a situation which is >>

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

2024-03-28 Thread Jonathan Gibbons
On Thu, 29 Feb 2024 11:39:41 GMT, Hannes Wallnöfer wrote: >> Setext headings only come in "level 1" and "level 2" flavors. >> And, at the time the renderer sees the AST, the difference between ATX and >> setext headings is erased. They're just "headings". >> >> I also think it is better to

Re: RFR: 8325088: Overloads that differ in type parameters may be lost

2024-03-28 Thread Jonathan Gibbons
On Thu, 28 Mar 2024 12:54:10 GMT, Pavel Rappo wrote: > While I've been working with javadoc for the last five years, somehow I've > never had to deal with composability functionality provided by `link` and > `linkoffline`. These options have been there since at least 1998: the > earliest bug

Re: RFR: JDK-8303689: javac -Xlint could/should report on "dangling" doc comments

2024-03-27 Thread Jonathan Gibbons
On Wed, 27 Mar 2024 22:41:33 GMT, Pavel Rappo wrote: > Would this be the first lint -- not doclint -- warning related to comments, > let alone doc comments? No. `-Xlint:dep-ann` correlates `@Deprecated` annotations with `@deprecated` tags in doc comments. >

Re: RFR: 8325088: Overloads that differ in type parameters may be lost

2024-03-27 Thread Jonathan Gibbons
On Wed, 27 Mar 2024 21:56:48 GMT, Chen Liang wrote: >> Creating a link to a constructor or a method or comparing constructors or >> methods __does not__ factor in type parameters. When constructors or methods >> are overloaded and differ only in type parameters -- a situation which is >>

RFR: JDK-8303689: javac -Xlint could/should report on "dangling" doc comments

2024-03-27 Thread Jonathan Gibbons
Please review the updates to support a proposed new `-Xlint:dangling-doc-comments` option. The work can be thought of as in 3 parts: 1. An update to the `javac` internal class `DeferredLintHandler` so that it is possible to specify the appropriately configured `Lint` object when it is time to

Re: RFR: 8325088: Overloads that differ in type parameters may be lost

2024-03-27 Thread Jonathan Gibbons
On Wed, 27 Mar 2024 17:19:35 GMT, Pavel Rappo wrote: > Creating a link to a constructor or a method or comparing constructors or > methods __does not__ factor in type parameters. When constructors or methods > are overloaded and differ only in type parameters -- a situation which is > absent

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

2024-03-27 Thread Jonathan Gibbons
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 incrementally with one additional commit since the last revision: add s

Re: RFR: JDK-8324774: Add DejaVu web fonts [v2]

2024-03-26 Thread Jonathan Gibbons
On Wed, 20 Mar 2024 15:54:12 GMT, Hannes Wallnöfer wrote: >> This change adds the DejaVu web fonts that were previously maintained >> externally to the open repository so they are available both in JDK API >> documentation and any API documentation generated with the `javadoc` tool. >> All

Re: RFR: 8325168: JShell should support Markdown comments

2024-03-25 Thread Jonathan Gibbons
On Fri, 2 Feb 2024 14:02:28 GMT, Jan Lahoda wrote: > This is an attempt to add Markdown support in documentation comments to > JShell. > > It works by converting the Markdown text to HTML during the process of > resolving `{@inheritDoc}` tags. Changes requested by jjg (Reviewer). Compared

Re: Inaccuracy in the documentation of the -group option?

2024-03-23 Thread Jonathan Gibbons
Martin, Thank you for the report. I have filed JDK-8328848 to fix the documentation. There is currently no way to also group packages in a multi-modules project. -- Jon https://bugs.openjdk.org/browse/JDK-8328848 On 3/23/24 3:59 AM, Martin Desruisseaux wrote: Hello The documentation for

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

2024-03-21 Thread Jonathan Gibbons
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

  1   2   3   4   5   6   7   8   9   >