RFR: JDK-8310118: Resource files should be moved to appropriate directories [v2]

[Jonathan Gibbons]

On Tue, 8 Aug 2023 09:14:00 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> Please review a change to rename the directories previoiusly called `resources` and `script-dir` in `javadoc`-generated documentation to `resource-files` and `script-files`, and consistently moving all files that are not related to the documented code into these directories. This includes scripts and stylesheets added via command line options.
>> 
>> In the process I cleaned up the code which copies scripts and resources. I added a new private `HtmlDoclet.copyResource` method which takes care of resolving resources relative to the `doclet.formats.html` or `doclet.toolkit` packages and determines whether a resource needs localization based on the file extension of the source resource. The new code will also throw an exception if the source resource does not exist, while previously `DocFile.copyResource` returned silently. 
>> 
>> Another unrelated cleanup was to remove a bunch of jQuery-UI image files in a resource subdirectory that were not used anymore.
>> 
>> In addition to make sure all tests pass I did extensive manual testing of the generated docs to make sure all scripts and resources are loaded correctly. This includes the `@import` statement for `resources/fonts/dejavu.css` in the default stylesheet, which is now changed to `fonts/dejavu.css` assuming the `fonts` directory will now be located in `resource-files`.
>
> Hannes Wallnöfer has updated the pull request incrementally with two additional commits since the last revision:
> 
>  - Move HTML resources from toolkit to formats.html
>  - Fix snippets tests

I wish there was a way to reduce the number of `.resolve` calls in `HtmlDoclet.init`, since they do clutter up the code a bit.

However, I don't have any simple fixups, and such suggestions that I have would be a bigger change than is probably warranted here. For example,

   copyResources(Path toDir, String... resources)


Maybe next time, unless you're feeling keen and eager now.

Approved by default.

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

Marked as reviewed by jjg (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/15180#pullrequestreview-1568147104