PMD / Issues / #1547 [java] UnusedImportRule - False Positive for only usage in Javadoc

#1547 [java] UnusedImportRule - False Positive for only usage in Javadoc - {@link ClassName#CONSTANT}

Milestone: PMD-5.4.4

Status: closed

Owner: Juan Sotuyo

Labels: None

Module: PMD

Priority: 3-Major

Type: Bug

Affects version: 5.4.3

Ruleset / Rule: Imports

Updated: 2016-12-07

Created: 2016-11-15

Creator: Felix Otto

Private: No

The following import gets marked as unused while it is used in the JavaDoc comment.

import java.net.HttpURLConnection;

/**
 * {@link HttpURLConnection#HTTP_NOT_ACCEPTABLE}
 */
public interface Interface {
}

While playing around with some PMD versions wrapped by the related maven plug-in I have seen, that the issue does not occur with PMD 5.0.5 (maven pmd plug-in 3.1) while it does as of PMD 5.1.2 (maven pmd plug-in 3.2).

Discussion

Sebastian Ratz - 2016-11-22

The reason is that \p{Alnum} in the regex does not match _, which is very common in constants:

https://github.com/pmd/pmd/blob/c2cd2fb4bd1056d8c19eb2aac261b8a5b55479c4/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/imports/UnusedImportsRule.java#L40

{@link HttpURLConnection#HTTPNOTACCEPTABLE}
is fine (no false positive).

The regex should use \w instead.

This still won't work for indentifier names that don't match the convention (such as arbitrary unicode characters), but it should fix it for the common use case.

Last edit: Sebastian Ratz 2016-11-22

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Juan Sotuyo - 2016-12-07

assigned_to: Maraxus

Milestone: New Tickets --> PMD-5.4.4

Affects version: 5.5.2 --> 5.4.3
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Juan Sotuyo - 2016-12-07

summary: UnusedCode - False Positive for only usage in Javadoc - {@link ClassName#CONSTANT} --> [java] UnusedCode - False Positive for only usage in Javadoc - {@link ClassName#CONSTANT}
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Juan Sotuyo - 2016-12-07

summary: [java] UnusedCode - False Positive for only usage in Javadoc - {@link ClassName#CONSTANT} --> [java] UnusedImportRule - False Positive for only usage in Javadoc - {@link ClassName#CONSTANT}
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Juan Sotuyo - 2016-12-07

status: open --> closed
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Juan Sotuyo - 2016-12-07

This will be released in PMD 5.4.4, 5.5.3 and later

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

[java] UnusedImportRule - False Positive for only usage in Javadoc - {@link...

A source code analyzer

Milestone

Searches

Help

#1547 [java] UnusedImportRule - False Positive for only usage in Javadoc - {@link ClassName#CONSTANT}

Discussion