specials: Fix incomplete documentation of execute() param
authorThiemo Kreuz <thiemo.kreuz@wikimedia.de>
Thu, 28 Mar 2019 11:24:26 +0000 (12:24 +0100)
committerKrinkle <krinklemail@gmail.com>
Thu, 28 Mar 2019 16:26:42 +0000 (16:26 +0000)
commit16847b403132c340c1e31efb7ba0d363da78239b
tree908ae4bb245fb21bf7001b8db53b3ffa16249728
parent8a0f5676c92c486656b260c448c8e0284e5321ca
specials: Fix incomplete documentation of execute() param

The parameter passed to the execute() method of each special page can
be null, and usually is. In some of these files this fact was already
mentioned in the comment, but not listed as a type.

In this patch I also remove comments that do not explain much. Saying
that the execute() method of a special page "executes a special page" or
is the "main entry point to a special page" is not super helpful. That's
usually what the documentation in the parent class shoudl explain.
We can add @inheritDoc tags in all these cases if you prefer. Please
tell me.

Change-Id: I1d811ab0c6d5c956e36f6a74120a425abc4332e6
14 files changed:
includes/specialpage/ChangesListSpecialPage.php
includes/specialpage/FormSpecialPage.php
includes/specialpage/QueryPage.php
includes/specials/SpecialActiveusers.php
includes/specials/SpecialAllMessages.php
includes/specials/SpecialAutoblockList.php
includes/specials/SpecialBlockList.php
includes/specials/SpecialBooksources.php
includes/specials/SpecialComparePages.php
includes/specials/SpecialListusers.php
includes/specials/SpecialNewpages.php
includes/specials/SpecialRecentchanges.php
includes/specials/SpecialUpload.php
includes/specials/SpecialUploadStash.php