RFR: 8303480: Miscellaneous fixes to mostly invisible doc comments [v2]
Pavel Rappo
prappo at openjdk.org
Mon Mar 6 20:22:48 UTC 2023
> Please review this superficial documentation cleanup that was triggered by unrelated analysis of doc comments in JDK API.
>
> The only effect that this multi-area PR has on the JDK API Documentation (i.e. the observable effect on the generated HTML pages) can be summarized as follows:
>
>
> diff -ur build/macosx-aarch64/images/docs-before/api/serialized-form.html build/macosx-aarch64/images/docs-after/api/serialized-form.html
> --- build/macosx-aarch64/images/docs-before/api/serialized-form.html 2023-03-02 11:47:44
> +++ build/macosx-aarch64/images/docs-after/api/serialized-form.html 2023-03-02 11:48:45
> @@ -17084,7 +17084,7 @@
> throws <span class="exceptions"><a href="java.base/java/io/IOException.html" title="class in java.io">IOException</a>,
> <a href="java.base/java/lang/ClassNotFoundException.html" title="class in java.lang">ClassNotFoundException</a></span></div>
> <div class="block"><code>readObject</code> is called to restore the state of the
> - (@code BasicPermission} from a stream.</div>
> + <code>BasicPermission</code> from a stream.</div>
> <dl class="notes">
> <dt>Parameters:</dt>
> <dd><code>s</code> - the <code>ObjectInputStream</code> from which data is read</dd>
>
> Notes
> -----
>
> * I'm not an expert in any of the affected areas, except for jdk.javadoc, and I was merely after misused tags. Because of that, I would appreciate reviews from experts in other areas.
> * I discovered many more issues than I included in this PR. The excluded issues seem to occur in infrequently updated third-party code (e.g. javax.xml), which I assume we shouldn't touch unless necessary.
> * I will update copyright years after (and if) the fix had been approved, as required.
Pavel Rappo has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains two additional commits since the last revision:
- Merge branch 'master' into 8303480
- Initial commit
-------------
Changes:
- all: https://git.openjdk.org/jdk/pull/12826/files
- new: https://git.openjdk.org/jdk/pull/12826/files/d2f4a553..87166408
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jdk&pr=12826&range=01
- incr: https://webrevs.openjdk.org/?repo=jdk&pr=12826&range=00-01
Stats: 13433 lines in 415 files changed: 9003 ins; 2610 del; 1820 mod
Patch: https://git.openjdk.org/jdk/pull/12826.diff
Fetch: git fetch https://git.openjdk.org/jdk pull/12826/head:pull/12826
PR: https://git.openjdk.org/jdk/pull/12826
More information about the ide-support-dev
mailing list