Integrated: JDK-8262875: doccheck: empty paragraphs, etc in java.base module
Jonathan Gibbons
jjg at openjdk.java.net
Tue Mar 2 20:38:45 UTC 2021
On Tue, 2 Mar 2021 19:35:47 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
> Please review some minor doc fixes, for issues found by _doccheck_. There are two kinds of errors that are addressed.
>
> 1. Incorrect use of `<p>`. In HTML, `<p>` marks the *beginning* of a paragraph. It is not a terminator, to mark the end of a paragraph, or a separator to mark the boundary between paragraphs. In particular, it should not be used at the end of a description before a javadoc block tag, such as `@param` or before other HTML block tags, like `<ul>` or `<table>`.
>
> 2. References to the id `package-description`, following the recent standardization of all ids generated by javadoc,
This pull request has now been integrated.
Changeset: 20b9ba53
Author: Jonathan Gibbons <jjg at openjdk.org>
URL: https://git.openjdk.java.net/jdk/commit/20b9ba53
Stats: 9 lines in 8 files changed: 0 ins; 1 del; 8 mod
8262875: doccheck: empty paragraphs, etc in java.base module
Reviewed-by: alanb, darcy, lancea
-------------
PR: https://git.openjdk.java.net/jdk/pull/2795
More information about the core-libs-dev
mailing list