Integrated: JDK-8310118: Resource files should be moved to appropriate directories

Hannes Wallnöfer hannesw at openjdk.org
Wed Aug 9 07:38:58 UTC 2023


On Mon, 7 Aug 2023 14:42:08 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`.

This pull request has now been integrated.

Changeset: 77e5739f
Author:    Hannes Wallnöfer <hannesw at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/77e5739f60d5a3d62642be55462e90d66c374bf3
Stats:     253 lines in 44 files changed: 58 ins; 79 del; 116 mod

8310118: Resource files should be moved to appropriate directories

Reviewed-by: jjg

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

PR: https://git.openjdk.org/jdk/pull/15180


More information about the javadoc-dev mailing list