D-Scanner icon indicating copy to clipboard operation
D-Scanner copied to clipboard

Flaky "undocumented parameter" report

Open andrej-petrovic opened this issue 5 years ago • 0 comments

D-Scanner seems to inconsistently report undocumented parameters of public functions. Sometimes it correctly reports that it's missing from Params:, sometimes it says it's missing even when it's there, and sometimes it doesn't report the undocumented parameter if it really is missing.

For example, D-Scanner reports no issues and exits with code 1 when run on the following file:

void main()
{
    foo(2);
}

/**
 *
 */
public T foo(T)(T x)
{
    return x;
}

But both T and x are undocumented. Adding an empty Params: section to the doc comment doesn't change anything.

I couldn't reliably reproduce the other cases, and it seems to randomly fix/break sometimes.

EDIT: I just realized it's not reporting the missing Returns: section either 🤔

andrej-petrovic avatar Mar 07 '20 22:03 andrej-petrovic