[prev in list] [next in list] [prev in thread] [next in thread] 

List:       openjdk-openjfx-dev
Subject:    Integrated: 8180066: Convert package.html files to package-info.java
From:       Kevin Rushforth <kcr () openjdk ! org>
Date:       2023-06-22 12:32:14
Message-ID: wS6O6jC9e7ZkoxblrIHJeJ44UiwyZzP75-RdT8YN_DI=.f5cb015e-4b6c-4254-b7be-f8ddf5091462 () github ! com
[Download RAW message or body]

On Wed, 21 Jun 2023 15:05:47 GMT, Kevin Rushforth <kcr@openjdk.org> wrote:

> This is a doc cleanup task to convert all `package.html` files to \
> `package-info.java`, which is the recommended way to provide package documentation. \
>  The first commit is the result of running a shell script that @jonathan-gibbons \
> provided. The second commit removes an errant `<h2>` tag from the \
> `package-info.java` for one package, `javafx.util.converter` that is unneeded and \
> unwanted. That same file also had a redundant first sentence, which was \
> coincidentally removed by the tool, so once I removed the `<h2>` tag the docs for \
> that package now looks good and matches the other packages. There are no other \
> changes in the javadoc-generated API docs. 
> One thing I didn't do is add a ` *` at the beginning of the lines that are now part \
> of a javadoc-style comment block. This minimizes the diffs, but it means we won't \
> be using the usual pattern for those comment blocks. I'm inclined to file a \
> follow-up issue rather than changing that now.

This pull request has now been integrated.

Changeset: c2246159
Author:    Kevin Rushforth <kcr@openjdk.org>
URL:       https://git.openjdk.org/jfx/commit/c224615991fb0f3647c21786ecd68b78ade4bcb6
                
Stats:     2982 lines in 68 files changed: 1289 ins; 1649 del; 44 mod

8180066: Convert package.html files to package-info.java

Reviewed-by: angorya

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

PR: https://git.openjdk.org/jfx/pull/1159


[prev in list] [next in list] [prev in thread] [next in thread]