RFR: JDK-8262875: doccheck: empty paragraphs, etc in java.base module

Alan Bateman alanb at openjdk.java.net
Tue Mar 2 19:46:41 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,

Marked as reviewed by alanb (Reviewer).

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

PR: https://git.openjdk.java.net/jdk/pull/2795


More information about the security-dev mailing list