RFR: JDK-8276964: Better indicate a snippet that could not be processed

[Hannes Wallnöfer]

On Mon, 29 Nov 2021 12:07:26 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

> What "details" should provide depends on the target audience. Who is the target audience of this feature? Is it the author who composes the doc comment in source? Is it the tool user who builds the documentation from this comment? Or is it the reader who reads only the resulting documentation?

The target audience is the person building the documentation, which may or may not be the code author. It's definitely not the end user of the documentation, as javadoc will exit with an error and erroneous documentation should not be released to the end user. It's an additional way to deliver the error message "in context", with the purpose of making the problem easier to locate and to fix.

-------------

PR: https://git.openjdk.java.net/jdk/pull/6579