Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag [v4]

2023-09-05 Thread Jonathan Gibbons
On Tue, 5 Sep 2023 22:15:28 GMT, Pavel Rappo wrote: >> This PR makes JavaDoc and DocLint produce more helpful diagnostic output >> when encounter an unknown tag. >> >> Before: >> >> >> MyClass.java:4: warning: no main description >> * @implSpite {@linkpain Object#hashCode}} >>^ >> MyClas

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag [v4]

2023-09-05 Thread Pavel Rappo
> This PR makes JavaDoc and DocLint produce more helpful diagnostic output when > encounter an unknown tag. > > Before: > > > MyClass.java:4: warning: no main description > * @implSpite {@linkpain Object#hashCode}} >^ > MyClass.java:4: error: unknown tag: implSpite > * @implSpite {@linkpa

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag [v3]

2023-09-05 Thread Pavel Rappo
> This PR makes JavaDoc and DocLint produce more helpful diagnostic output when > encounter an unknown tag. > > Before: > > > MyClass.java:4: warning: no main description > * @implSpite {@linkpain Object#hashCode}} >^ > MyClass.java:4: error: unknown tag: implSpite > * @implSpite {@linkpa

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag [v2]

2023-09-05 Thread Jonathan Gibbons
On Fri, 1 Sep 2023 09:23:11 GMT, Pavel Rappo wrote: >> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/DocLint.java line >> 380: >> >>> 378: >>> 379: public static List suggestSimilar(Collection >>> knownTags, String unknownTag) { >>> 380: final double MIN_SIMILARITY =

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag [v2]

2023-09-05 Thread Jonathan Gibbons
On Tue, 5 Sep 2023 09:19:34 GMT, Pavel Rappo wrote: >> This PR makes JavaDoc and DocLint produce more helpful diagnostic output >> when encounter an unknown tag. >> >> Before: >> >> >> MyClass.java:4: warning: no main description >> * @implSpite {@linkpain Object#hashCode}} >>^ >> MyClas

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-09-05 Thread Pavel Rappo
On Wed, 30 Aug 2023 16:34:58 GMT, Pavel Rappo wrote: > This PR makes JavaDoc and DocLint produce more helpful diagnostic output when > encounter an unknown tag. > > Before: > > > MyClass.java:4: warning: no main description > * @implSpite {@linkpain Object#hashCode}} >^ > MyClass.java:4:

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag [v2]

2023-09-05 Thread Pavel Rappo
> This PR makes JavaDoc and DocLint produce more helpful diagnostic output when > encounter an unknown tag. > > Before: > > > MyClass.java:4: warning: no main description > * @implSpite {@linkpain Object#hashCode}} >^ > MyClass.java:4: error: unknown tag: implSpite > * @implSpite {@linkpa

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-09-01 Thread Pavel Rappo
On Thu, 31 Aug 2023 22:59:57 GMT, Jonathan Gibbons wrote: >> This PR makes JavaDoc and DocLint produce more helpful diagnostic output >> when encounter an unknown tag. >> >> Before: >> >> >> MyClass.java:4: warning: no main description >> * @implSpite {@linkpain Object#hashCode}} >>^ >>

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-09-01 Thread Pavel Rappo
On Thu, 31 Aug 2023 22:55:08 GMT, Jonathan Gibbons wrote: >> This PR makes JavaDoc and DocLint produce more helpful diagnostic output >> when encounter an unknown tag. >> >> Before: >> >> >> MyClass.java:4: warning: no main description >> * @implSpite {@linkpain Object#hashCode}} >>^ >>

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-09-01 Thread Pavel Rappo
On Thu, 31 Aug 2023 22:53:49 GMT, Jonathan Gibbons wrote: > This is a bit terse. I'd suggest to split it in two lines, the first > containing a statement of fact. (`An unknown tag has been reported.`), and > the second containing a more complete helpful sentence, such as "Did you > mistype it,

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-08-31 Thread Jonathan Gibbons
On Wed, 30 Aug 2023 16:34:58 GMT, Pavel Rappo wrote: > This PR makes JavaDoc and DocLint produce more helpful diagnostic output when > encounter an unknown tag. > > Before: > > > MyClass.java:4: warning: no main description > * @implSpite {@linkpain Object#hashCode}} >^ > MyClass.java:4:

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-08-31 Thread Pavel Rappo
On Thu, 31 Aug 2023 09:04:29 GMT, Hannes Wallnöfer wrote: > I really like this feature, but my immediate reaction is to also worry about > decreased readability caused by increased verbosity. Some ideas: > > * `the most similar tags are: ...` is quite long, and there are now 4 colon > characte

Re: RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-08-31 Thread Hannes Wallnöfer
On Wed, 30 Aug 2023 16:34:58 GMT, Pavel Rappo wrote: > This PR makes JavaDoc and DocLint produce more helpful diagnostic output when > encounter an unknown tag. > > Before: > > > MyClass.java:4: warning: no main description > * @implSpite {@linkpain Object#hashCode}} >^ > MyClass.java:4:

RFR: 8288660: JavaDoc should be more helpful if it doesn't recognize a tag

2023-08-30 Thread Pavel Rappo
This PR makes JavaDoc and DocLint produce more helpful diagnostic output when encounter an unknown tag. Before: MyClass.java:4: warning: no main description * @implSpite {@linkpain Object#hashCode}} ^ MyClass.java:4: error: unknown tag: implSpite * @implSpite {@linkpain Object#hashCode}}