Page MenuHomePhabricator

Improve documentation of abstract methods in Tallier class [M]
Closed, ResolvedPublic

Description

The Tallier class has several abstract methods, with sparse documentation about how they should be overridden.

We should do the following for each one:

Then, for each of these methods implemented in each subclass, we should:

  • Ensure the return type declarations are consistent with the parent
  • Use the @inheritDoc annotation instead of repeating the documentation

Event Timeline

ARamirez_WMF renamed this task from Improve documentation of abstract methods in Tallier class to Improve documentation of abstract methods in Tallier class [M].Jun 9 2021, 4:58 PM

Change 700674 had a related patch set uploaded (by AGueyte; author: AGueyte):

[mediawiki/extensions/SecurePoll@master] WIP Add documentation Tallier

https://gerrit.wikimedia.org/r/700674

Change 700674 merged by jenkins-bot:

[mediawiki/extensions/SecurePoll@master] Add documentation Tallier

https://gerrit.wikimedia.org/r/700674