HomePhabricator

Remove broken/outdated @param/@throws tags from @dataProviders

Description

Remove broken/outdated @param/@throws tags from @dataProviders

My personal best practice is to not document @params when there
is a @dataProvider. I mean, these test…() functions are not
meant to be called from anywhere. They do not really need
documentation. @param tags don't do much but duplicate what the
@dataProvider does. This is error-prone, as demonstrated by the
examples in this patch.

This patch also removes @throws tags from tests. A test…() can
never throw an exception. Otherwise the test would fail.

Most of these are found by the not yet released I10559d8.

Change-Id: I3782bca43f875687cd2be972144a7ab6b298454e

Details

Provenance
thiemowmdeAuthored on Jan 14 2021, 8:09 AM
KrinkleCommitted on Jan 21 2021, 3:42 AM
Parents
rMW2f66b3754fa6: tests: Remove @param docs from test code that just repeat the signature
Branches
Unknown
Tags
Unknown
ChangeId
I3782bca43f875687cd2be972144a7ab6b298454e

Event Timeline