Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v21]

2024-02-06 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` > libra

Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v18]

2024-02-06 Thread Jonathan Gibbons
On Wed, 7 Feb 2024 00:16:57 GMT, Jonathan Gibbons wrote: >> There are two cases that need consideration: >> 1. A tree that is not modified during the transformation, as in the test >> case here, so that all nodes should be "as before" >> 2. A tree that is modified during the transformation, rais

Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v20]

2024-02-06 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` > libra

Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v18]

2024-02-06 Thread Jonathan Gibbons
On Tue, 6 Feb 2024 19:57:45 GMT, Jonathan Gibbons wrote: >> Uugh. Noted. > > There are two cases that need consideration: > 1. A tree that is not modified during the transformation, as in the test case > here, so that all nodes should be "as before" > 2. A tree that is modified during the trans

Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v19]

2024-02-06 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` > libra

Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v18]

2024-02-06 Thread Jonathan Gibbons
On Tue, 6 Feb 2024 19:27:55 GMT, Jonathan Gibbons wrote: >> src/jdk.internal.md/share/classes/jdk/internal/markdown/MarkdownTransformer.java >> line 1: >> >>> 1: /* >> >> This transformer seems to break positions of the `RawTextTree`. >> For javadoc like: >> >> /// Mar

Re: RFR: JDK-8298405: Support Markdown in Documentation Comments [v18]

2024-02-06 Thread Jonathan Gibbons
On Tue, 6 Feb 2024 07:08:13 GMT, Jan Lahoda wrote: >> Jonathan Gibbons has updated the pull request incrementally with one >> additional commit since the last revision: >> >> First pass at remove DocCommentTransformer from the public API. >> >> It is still declared internally, and instal

Re: Dedicated block tag for side effects

2024-02-06 Thread Jonathan Gibbons
To the best of my knowledge, this has never been raised as an issue. I doubt that this rises to the level of general interest, but you could easily create user-defined tag to use in your own documentation if you wanted that kind of stylized documentation. I would expect that side-effects are b

Re: RFR: 8298044: Fix hidden but significant trailing whitespace in properties files for langtools code

2024-02-06 Thread Justin Lu
On Tue, 6 Feb 2024 16:24:53 GMT, Magnus Ihse Bursie wrote: >> According to [the >> specification](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/util/Properties.html#load(java.io.Reader)) >> trailing whitespaces in the values of properties files are (somewhat >> surprisingly

Re: The doclet "comment inheritance algorithm" spec conformance

2024-02-06 Thread Jonathan Gibbons
javadoc has some changes/fixes/enhancements in this area in JDK 22, both in the code and the Doc Comment Specification. The intent is to better align the lookup for inherited comments with the general lookup rules in JLS. -- Jon On 2/6/24 7:14 AM, I Al Istannen wrote: Hey, I hope this is t

Dedicated block tag for side effects

2024-02-06 Thread Marcin Wiśnicki
Apologies if this belongs to javadoc-next-dev but that list looks dormant so I posted here. Was there ever a discussion about adding dedicated block tag for documenting side effects, e.g. @effects? For example Thread.interrupted() could say: @effects interrupted status of the thread is cleared 

The doclet "comment inheritance algorithm" spec conformance

2024-02-06 Thread I Al Istannen
Hey, I hope this is the right place to ask :) I was recently implementing javadoc comment inheritance for spoon[0] and verified it against IntelliJ IDEA and the standard html doclet. While doing this I found out that IntelliJ and the standard doclet disagree on comment inheritance in this exa

The doclet "comment inheritance algorithm" spec conformance

2024-02-06 Thread I Al Istannen
Hey, I hope this is the right place to ask :) I was recently implementing javadoc comment inheritance for spoon[0] and verified it against IntelliJ IDEA and the standard html doclet. While doing this I found out that IntelliJ and the standard doclet disagree on comment inheritance in this exa

Re: RFR: 8298044: Fix hidden but significant trailing whitespace in properties files for langtools code

2024-02-06 Thread Magnus Ihse Bursie
On Fri, 2 Dec 2022 16:36:22 GMT, Magnus Ihse Bursie wrote: > According to [the > specification](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/util/Properties.html#load(java.io.Reader)) > trailing whitespaces in the values of properties files are (somewhat > surprisingly) ac

Re: RFR: 8325109: Sort method modifiers in canonical order

2024-02-06 Thread Magnus Ihse Bursie
On Thu, 1 Feb 2024 11:57:04 GMT, Magnus Ihse Bursie wrote: > This is a follow-up on > [JDK-8324053](https://bugs.openjdk.org/browse/JDK-8324053). I have run the > bin/blessed-modifier-order.sh on the entire code base, and manually checked > the result. I have reverted all but these trivial and