Add willReturnOnConsecutiveCalls to documentation

[duncancumming]

[This duplicates this ticket https://github.com/sebastianbergmann/phpunit-documentation/issues/488 which has been closed since the documentation was moved to separate projects per language]

In phpunit-mock-objects/src/Builder/InvocationMocker.php there's a willReturnOnConsecutiveCalls method, which isn't mentioned in the PHPUnit documentation.
https://github.com/sebastianbergmann/phpunit-mock-objects/blob/master/src/Builder/InvocationMocker.php#L173

Can we get that added please?

[plucht]

These shorthand methods aren't mentioned either:

• willReturnArgument()
• willReturnCallback()
• willReturnMap()
• willReturnSelf()
• willThrowException()

Would it make sense to add a table to the page about test doubles, which compares these methods to their equivalents (e.g. will($this->returnArgument(1)))?

[SvenBrunk]

It's more than 3 years now... how about doing it? ;)
BTW: there is a variant of this mentioned in https://phpunit.readthedocs.io/en/9.5/test-doubles.html#test-doubles-stubs-examples-stubtest7-php

[seth-xdam]

This issue was resolved two years ago, but it the additional documentation was removed again two months ago in commit 2c6a4cd. The only comment on the commit is "Remove table". Why was the documentation on these additional functions deleted?

[terrylin104]

Probably it were deprecated in PHPUnit 12.
sebastianbergmann/phpunit#5425
But I didn't see any @deprecated annotation in 10.3 or later version.