[apex] ApexDoc false-positive for the first method of an annotated Apex class

[liqingjun123]

Affects PMD Version: 7.0.0-rc4

Rule: ApexDoc

Description:

Code Sample demonstrating the issue:

/**
 * @description       : rest service
 **/
@RestResource(urlMapping='/api/v1/get/*') 
global without sharing class TestService {
    /**
     * @description Bar
     */
    public void bar() { return; }
}

Expected outcome:

PMD reports a violation at line 9, but that's wrong. That's a false positive.

"rest.cls","3","9","Missing ApexDoc comment","Documentation","ApexDoc"

Running PMD through: [CLI]

[liqingjun123]

Hi Team, @clement.fournier@tu-dresden.de could you please help on the issue ASAP? Thanks very much

[jsotuyod]

This is not a false positive. As per the rule's documentation, the rule will flag:

• ApexDoc comments on void or constructor methods should not contain @return.

Your sample bar method's doc is effectively a violation.

[liqingjun123]

This is not a false positive. As per the rule's documentation, the rule will flag:

• ApexDoc comments on void or constructor methods should not contain @return.

Your sample bar method's doc is effectively a violation.

@jsotuyod
I have updated the comments for the function bar method. Now the issue still exists as below.
"rest.cls","3","9","Missing ApexDoc comment","Documentation","ApexDoc"

[adangel]

I can confirm: If the annotation @RestResource is removed, then the formal parameter of the method is present in the AST and the rule works. But if the annotation is added, then the formal parameter of the method is missing in the AST...

I guess, there is a bug when we map the comments to the (nearest) node.

[liqingjun123]

@adangel The issue blocks my project to use 7.0+.

[adangel]

Thanks for the reminder. I've just verified, that this is actually already fixed in the current master branch, probably with the switch from Jorje to apex-parser (#3766).