RFR: 8164408: Add module support for @see, @link and @linkplain javadoc tags.
Jonathan Gibbons
jonathan.gibbons at oracle.com
Tue Jun 2 15:24:10 UTC 2020
On 6/2/20 8:14 AM, Jonathan Gibbons wrote:
>
> On 6/2/20 7:13 AM, Hannes Wallnoefer wrote:
>> That’s correct, the toString() representation and default link label
>> will be different from the actual string in the doc comment. The
>> rationale is that the trailing slash is there just to disambiguate
>> the link as a module reference, and the slash is not part of the
>> actual module name.
>>
>> If it is important to preserve the link signature as-is we can keep
>> it in the signature. We’ll have to check for it later on when
>> checking for external module references, but that is not a problem.
>>
>> Hannes
>
> Hannes,
>
> The tree .toString() should be an accurate/exact rendition of the
> input. It's a "syntax" tree representing the input. It should not be
> desugared/pre-rendered into what we might want for the output.
>
> The form of any generated text should be determined when generating
> the text,
>
> -- Jon
>
(The reason is because javadoc and the standard doclet are not the only
client of the API. We want to be able to support other clients ... for
example, imagine an app that wants to reflow comment text using the
DocCommentTree representation. They want the exact text available in
the tree.)
-- Jon
More information about the javadoc-dev
mailing list