On Mon, 29 Apr 2024 17:26:53 GMT, Chen Liang <li...@openjdk.org> wrote:
>> src/java.base/share/classes/java/io/FileInputStream.java line 345: >> >>> 343: * @throws IllegalArgumentException {@inheritDoc} >>> 344: * @throws IOException {@inheritDoc} >>> 345: * @throws OutOfMemoryError {@inheritDoc} >> >> Re: inheriting _unchecked_ exception documentation here and elsewhere in >> this PR >> >> This PR's title suggests that the PR has nothing to do with exception >> documentation. If you feel that it should be addressed, please file a >> separate bug and move these changes there. >> >> FWIW, I agree that `@throws ... {@inheritDoc}` for such exceptions are at >> least worth being considered. It's a common misconception that all exception >> documentation is inherited automatically. > > This is because the tool from #18934 has no easy way to fetch the doc comment > from a superclass/superinterface overridden method when this class only has a > plain override. Javadoc handles this in complex logic in > `VisibleMemberTable`; it's hard for other clients to try to emulate the > behavior of doc finding, and the tool just incorrectly assumes such methods > (what I have been talking about before) are reusing `@since` from the class > docs. Pavel, can I simply change the PR/issue title to be more descriptive? As I want to include the the inherit doc because of the unchecked exceptions, rather than clean this up in a different PR ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/18954#discussion_r1583479753