You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@reef.apache.org by Andrew Chung <af...@gmail.com> on 2015/08/13 22:40:21 UTC

References in JavaDocs

Hi,

I have noticed many obsolete references in JavaDoc links. Are there any
checkstyle rules to detect these automatically?

Thanks,
Andrew

RE: References in JavaDocs

Posted by Mariia Mykhailova <ma...@microsoft.com>.
One more relevant feature request, at Maven Javadoc plugin: https://issues.apache.org/jira/browse/MJAVADOC-314
But this one is several years old and doesn't look likely to be done soon either

-Mariia

-----Original Message-----
From: Mariia Mykhailova [mailto:mamykhai@microsoft.com] 
Sent: Thursday, August 13, 2015 2:51 PM
To: dev@reef.incubator.apache.org
Subject: RE: References in JavaDocs

Looks like there are none. The closest checkstyle would be https://na01.safelinks.protection.outlook.com/?url=http%3a%2f%2fcheckstyle.sourceforge.net%2fconfig_javadoc.html%23JavadocMethod%2c&data=01%7c01%7cmamykhai%40microsoft.com%7c75fe183f23974aa1ff1d08d2a4294886%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=TBjoByjTkbKodNQYqy7AMV9RYJTb4Z06YDn6qc9WBOg%3d but it doesn't check for obsolete references. It doesn't check for obsolete parameters in @param either (it has a check for parameters which don't have corresponding @param tag but not the other way round), which we also have in our code.

Relevant discussion on checkstyle github: https://na01.safelinks.protection.outlook.com/?url=https%3a%2f%2fgithub.com%2fcheckstyle%2fcheckstyle%2fissues%2f915&data=01%7c01%7cmamykhai%40microsoft.com%7c75fe183f23974aa1ff1d08d2a4294886%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=kRlcEppz0e3e1oEjWwIZ5ztJD6q78IumodVeC0wr8K8%3d 

-Mariia

-----Original Message-----
From: Andrew Chung [mailto:afchung90@gmail.com] 
Sent: Thursday, August 13, 2015 1:40 PM
To: dev@reef.incubator.apache.org
Subject: References in JavaDocs

Hi,

I have noticed many obsolete references in JavaDoc links. Are there any checkstyle rules to detect these automatically?

Thanks,
Andrew

RE: References in JavaDocs

Posted by Mariia Mykhailova <ma...@microsoft.com>.
Looks like there are none. The closest checkstyle would be http://checkstyle.sourceforge.net/config_javadoc.html#JavadocMethod, but it doesn't check for obsolete references. It doesn't check for obsolete parameters in @param either (it has a check for parameters which don't have corresponding @param tag but not the other way round), which we also have in our code.

Relevant discussion on checkstyle github: https://github.com/checkstyle/checkstyle/issues/915 

-Mariia

-----Original Message-----
From: Andrew Chung [mailto:afchung90@gmail.com] 
Sent: Thursday, August 13, 2015 1:40 PM
To: dev@reef.incubator.apache.org
Subject: References in JavaDocs

Hi,

I have noticed many obsolete references in JavaDoc links. Are there any checkstyle rules to detect these automatically?

Thanks,
Andrew