JavaDoc errors for inherited methods?

I have methods that either replace other implementations or are implementations of interfaces, etc. IntelliJ warns me that these methods do not have "full" javadoc, even though I have an @see tag referencing the class/method that has those requirements.

Can this inspection be modified to allow for @see tags to replace full Javadoc, or at least have the option in settings to relax the requirements for inherited methods?

Thoughts?

Thanks,

Clint

4 comments

You shouldn't have to do that at all. IDEA's javadoc inspections should
understand the way javadoc comments are inherited and not issue warnings
as long as the method/class will have javadoc from SOME source. (A
superior feature might be to be able to configure the inspection to
issue a warning if a class or method inherits ALL its documentation from
a super-class or interface definition.)

Clint wrote:

I have methods that either replace other implementations or are implementations of interfaces, etc. IntelliJ warns me that these methods do not have "full" javadoc, even though I have an @see tag referencing the class/method that has those requirements.

Can this inspection be modified to allow for @see tags to replace full Javadoc, or at least have the option in settings to relax the requirements for inherited methods?

Thoughts?

Thanks,

Clint

0

Hello Michael,

Please, file a JIRA issue

Thank you.

-


Anna Kozlova
JetBrains Inc.
http://www.intellij.com
"Develop with pleasure!"

You shouldn't have to do that at all. IDEA's javadoc inspections
should understand the way javadoc comments are inherited and not issue
warnings as long as the method/class will have javadoc from SOME
source. (A superior feature might be to be able to configure the
inspection to issue a warning if a class or method inherits ALL its
documentation from a super-class or interface definition.)

Clint wrote:

>> I have methods that either replace other implementations or are
>> implementations of interfaces, etc. IntelliJ warns me that these
>> methods do not have "full" javadoc, even though I have an @see tag
>> referencing the class/method that has those requirements.
>>
>> Can this inspection be modified to allow for @see tags to replace
>> full Javadoc, or at least have the option in settings to relax the
>> requirements for inherited methods?
>>
>> Thoughts?
>>
>> Thanks,
>>
>> Clint
>>


0

Hello Michael,

Thanks

-


Anna Kozlova
JetBrains Inc.
http://www.intellij.com
"Develop with pleasure!"

I already did.

http://www.jetbrains.net/jira/browse/IDEA-7138



0

Please sign in to leave a comment.