On Fri, 25 Mar 2022 10:46:27 GMT, Pavel Rappo <pra...@openjdk.org> wrote:
>> Please review a (mostly) resource-file change to improve the message when
>> the file for an external snippet cannot be found.
>>
>> Previously, the code (re)used an existing resource, "File not found". This
>> resource was used in conjunction with files specified on the command line,
>> like a help file or a stylesheet file. Thus, little extra context was
>> needed.
>>
>> For external snippets, the underlying problem is less overtly connected to
>> anything specific on the command line, although the problem may be on the
>> command line or related to info on the command line. Thus, a new resource
>> is created specifically for external snippet files, that hints at issues
>> with (files on) the source path or snippet path.
>>
>> The main snippet test is updated.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
> line 55:
>
>> 53: for duplicates. Include error messages and the following diagnostic in
>> your report. Thank you.
>> 54: doclet.File_not_found=File not found: {0}
>> 55: doclet.snippet_file_not_found=file not found on source path or snippet
>> path: {0}
>
> Is this error message expected to start with a lower case letter? Other error
> messages in this file seem to start with an upper case letter.
It was deliberate that it didn't. The error messages are inconsistent, and
generally phrases should not be capitalized. Note that many of the surrounding
resources are labels to appear in the generated docs, and so have different
rules/guidelines for capitalization. (This is another reason for the long
overdue cleanup of resource names and values).
-------------
PR: https://git.openjdk.java.net/jdk/pull/7951
