Re: [External] : Re: Snippet specification feedback

2023-04-04 Thread Pavel Rappo
> On 31 Mar 2023, at 13:50, Tagir Valeev wrote: > > > >> It's good that you are looking into this, because it pushes us to improve >> the spec. That said, even javadoc is qui We might want an API, such as the >> one described in this comment >> https://bugs.openjdk.org/browse/JDK-8304408?

Re: [External] : Re: Snippet specification feedback

2023-03-31 Thread Tagir Valeev
Hello! Thank you for the detailed answer, now things are much more clear. > > In fact, the current implementation looks somewhat inconsistent, but > it's unclear whether it's correct or not, as we have no specification. For > example, consider the external snippet: > > > > class Test { > > // @

Re: [External] : Re: Snippet specification feedback

2023-03-31 Thread Pavel Rappo
> On 30 Mar 2023, at 12:40, Tagir Valeev wrote: > > Hello, Pavel! > > Thank you for the detailed answer. > > > 1. Attribute value syntax. The spec says "An attribute value may be an > > identifier, unsigned integer, or enclosed in either single or double quote > > characters; no escape char

Re: Snippet specification feedback

2023-03-30 Thread Tagir Valeev
Hello, Pavel! Thank you for the detailed answer. > 1. Attribute value syntax. The spec says "An attribute value may be an > identifier, unsigned integer, or enclosed in either single or double quote > characters; no escape characters are supported". I assume that {@snippet > class=pkg.Class} is a

Re: Snippet specification feedback

2023-03-30 Thread Pavel Rappo
Here's a more substantial reply to your email, as promised. > On 15 Mar 2023, at 21:14, Tagir Valeev wrote: > > Hello! > > I'm working on @snippet support improvement in IntelliJ IDEA. I'm using the > following page as the primary source of information: > https://docs.oracle.com/en/java/javase

Re: Snippet specification feedback

2023-03-23 Thread Pavel Rappo
Thank you for your email. I think it is the first piece of feedback we have received on the {@snippet} section of the Documentation Comment Specification for the Standard Doclet. So it is quite likely that this section has deficiencies to be fixed. I'll reply in detail shortly. This email is to

Snippet specification feedback

2023-03-21 Thread Tagir Valeev
Hello! I'm working on @snippet support improvement in IntelliJ IDEA. I'm using the following page as the primary source of information: https://docs.oracle.com/en/java/javase/19/docs/specs/javadoc/doc-comment-spec.html#snippet Unfortunately, it leaves many questions about how the snippets should