On Wed, 14 Jun 2023 10:07:05 GMT, Pavel Rappo wrote:
>> src/java.base/share/classes/java/util/concurrent/ConcurrentHashMap.java line
>> 1534:
>>
>>> 1532:
>>> 1533: /**
>>> 1534: * {@inheritDoc ConcurrentMap}
>>
>> This clarifies the authors' intent, so is clear progress.
>>
>>
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Wed, 14 Jun 2023 01:15:51 GMT, Martin Buchholz wrote:
> * we never want to inherit AbstractFoo @implNotes
`@implNote`, `@apiNote` and `@implSpec` can only be inherited via explicit
`{@inheritDoc}`:
@implSpec {@inheritDoc}
> * ConcurrentMap does _not_ have the same spec as
On Wed, 14 Jun 2023 01:19:57 GMT, Martin Buchholz wrote:
> We don't currently have a way to diff rendered javadoc, like my ancient
> BlenderRev hack?
I've generated something you might find helpful:
https://cr.openjdk.org/~prappo/8285368/specdiff/overview-summary.html
-
PR
On Tue, 13 Jun 2023 10:11:28 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search
On Tue, 13 Jun 2023 23:24:46 GMT, Stuart Marks wrote:
> I reviewed the changes in java.base. They look fine. I support the notion of
> keeping these changes minimal, with the narrow goal of keeping the resulting
> javadoc output the same. There are many opportunities for improving the
>
On Tue, 13 Jun 2023 10:11:28 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search
On Thu, 8 Jun 2023 15:51:22 GMT, Pavel Rappo wrote:
>> Copying an individual doc element using `{@inheritDoc}` never adds meta
>> information on the generated HTML page to indicate where that doc element
>> was copied from. It so happens in this particular case that the doc
>> element's
On Tue, 13 Jun 2023 10:11:28 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search
On Thu, 8 Jun 2023 14:47:13 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Thu, 8 Jun 2023 15:47:26 GMT, Pavel Rappo wrote:
>> I admit I can't parse this sentence:
>>
>>> then the answer is that it's not necessary for keeping the API
>>> documentation unchanged.
>>
>> Do you mean that you didn't add `@param e {@inheritDoc BlockingDeque}` here
>> to keep the
On Thu, 8 Jun 2023 15:16:09 GMT, Alexey Ivanov wrote:
>> The directed `{@inheritDoc }` works for the main description,
>> `@throws`, `@param` and `@return` tags. If your question is about why that
>> particular doc comment does not use this:
>>
>> @param e {@inheritDoc BlockingDeque}
>>
On Thu, 8 Jun 2023 11:29:44 GMT, Pavel Rappo wrote:
>> src/java.base/share/classes/java/util/concurrent/LinkedBlockingDeque.java
>> line 635:
>>
>>> 633: * @return {@inheritDoc BlockingDeque}
>>> 634: */
>>> 635: public boolean offer(E e) {
>>
>> Does this work for @param tags
On Wed, 7 Jun 2023 20:33:00 GMT, Jonathan Gibbons wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: make warning less scary
>
>
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Thu, 8 Jun 2023 11:27:37 GMT, Pavel Rappo wrote:
> If we were to (re-)structure doc comments in the way you propose, I'd suggest
> we do it in a separate, non-jdk.javadoc PR. I was simply trying to keep JDK
> API documentation unchanged.
Understood, it was just a passing comment that
On Thu, 8 Jun 2023 09:55:27 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Thu, 8 Jun 2023 09:55:27 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Thu, 8 Jun 2023 10:33:17 GMT, Alan Bateman wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: remove unduly restrictive warning
>
> src/java.base/share/classes/java/util/TreeMap.java line 1199:
>
>>
On Thu, 8 Jun 2023 09:55:27 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Thu, 8 Jun 2023 09:55:27 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Wed, 7 Jun 2023 21:39:33 GMT, Jonathan Gibbons wrote:
>> The general criticism here is whether we should restrict in any way the set
>> of super types from which one can inherit documentation, and/or what should
>> the set of checks be?
>>
>> For example, if a method in C inherits a method
On Thu, 8 Jun 2023 09:26:16 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Thu, 8 Jun 2023 09:18:04 GMT, Pavel Rappo wrote:
>> test/langtools/jdk/javadoc/doclet/testDirectedInheritance/TestDirectedInheritance.java
>> line 289:
>>
>>> 287:
>>> 288: /*
>>> 289: * C1.m inherits documentation from B1.m explicitly and undirect.
>>
>> possible typo: do you
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Wed, 7 Jun 2023 20:23:09 GMT, Jonathan Gibbons wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: make warning less scary
>
>
On Wed, 7 Jun 2023 18:55:10 GMT, Jonathan Gibbons wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: make warning less scary
>
>
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Wed, 7 Jun 2023 21:37:42 GMT, Jonathan Gibbons wrote:
>> Sure we can; this relates to an earlier comment of yours on
>> Utils.isDirectSupertype here:
>> https://github.com/openjdk/jdk/pull/14357#discussion_r1222053011
>
> The general criticism here is whether we should restrict in any way
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Wed, 7 Jun 2023 20:48:58 GMT, Pavel Rappo wrote:
>> test/langtools/jdk/javadoc/doclet/testDirectedInheritance/TestDirectedInheritance.java
>> line 673:
>>
>>> 671: *
>>> 672: * For now a warning is issued if a doc comment inherits from
>>> 673: * an indirect supertype.
>>
>>
On Wed, 7 Jun 2023 19:16:51 GMT, Jonathan Gibbons wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: make warning less scary
>
>
On Wed, 7 Jun 2023 19:13:55 GMT, Jonathan Gibbons wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: make warning less scary
>
>
On Wed, 7 Jun 2023 20:29:07 GMT, Jonathan Gibbons wrote:
>> Pavel Rappo has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> feedback: make warning less scary
>
>
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
On Wed, 7 Jun 2023 16:02:40 GMT, Pavel Rappo wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>> search for
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still
On Wed, 7 Jun 2023 14:19:16 GMT, Pavel Rappo wrote:
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for
On Wed, 7 Jun 2023 15:27:28 GMT, Jonathan Gibbons wrote:
>> Please review this long-awaited change to documentation inheritance.
>>
>> This change improves "methods comment algorithm" and introduces directed
>> documentation inheritance. While "methods comment algorithm" -- automatic
>>
On Wed, 7 Jun 2023 14:19:16 GMT, Pavel Rappo wrote:
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for
Please review this long-awaited change to documentation inheritance.
This change improves "methods comment algorithm" and introduces directed
documentation inheritance. While "methods comment algorithm" -- automatic
search for inheritable documentation -- has been improved, it still cannot read
49 matches
Mail list logo
