You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Gili (JIRA)" <ji...@apache.org> on 2019/01/31 19:27:00 UTC
[jira] [Comment Edited] (MJAVADOC-574) Unable to inherit Javadoc
comments for overriden JDK methods
[ https://issues.apache.org/jira/browse/MJAVADOC-574?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16757652#comment-16757652 ]
Gili edited comment on MJAVADOC-574 at 1/31/19 7:26 PM:
--------------------------------------------------------
Related links:
[https://stackoverflow.com/a/38708383/14731|https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8187386]
[https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8187386]
Conclusion: it looks like this expected (albeit sub-optimal) behavior.
The good news is that as of JDK 10 users can pass {{--overridden-methods=summary}} to the Javadoc tool and such methods will get moved down to the "Methods inherited from X" section where a Javadoc body is not needed (method names link to the Javadoc comments in the base class).
I think we can close this issue, unless you want to do the whole JDK-on-the-sourcepath thing on behalf of users.
was (Author: cowwoc):
Related links:
[https://stackoverflow.com/a/38708383/14731|https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8187386]
[https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8187386]
Conclusion: it looks like this expected (albeit sub-optimal) behavior.
The good news is that as of JDK 10 users can pass {{--overridden-methods=summary}} to the Javadoc tool and such methods will get moved down to the "Methods inherited from X" section where a Javadoc body is not needed (method names link to the Javadoc comments in the base class).
> Unable to inherit Javadoc comments for overriden JDK methods
> ------------------------------------------------------------
>
> Key: MJAVADOC-574
> URL: https://issues.apache.org/jira/browse/MJAVADOC-574
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
> Affects Versions: 3.1.0
> Environment: JDK 11.0.2
> Reporter: Gili
> Priority: Major
> Attachments: testcase.zip
>
>
> If you run {{mvn javadoc:jar}} on the attached testcase you will notice that any overriden methods end up with empty Javadoc (aside from a small "Overrides" section. According to [https://manpages.debian.org/testing/openjdk-11-jdk-headless/javadoc.1.en.html#METHOD%C2%A0COMMENT%C2%A0INHERITANCE] the inherited method must be on the {{-sourcepath}} but I'm not sure whether that's even possible for core JDK classes. I mean, am I supposed to download the JDK source-code and link to it somehow?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)