mediawiki-extensions-Discus.../includes/Hooks
Bartosz Dziewoński 69e8e948b2 Remove now redundant PHPDoc blocks
MediaWiki's PHPCS plugin requires documentation comments on all
methods, unless those methods are fully typed (all parameters and
return value).

It turns out that almost all of our methods are fully typed already.

Procedure:

1. Find: \*(\s*\*\s*(@param \??[\w\\]+(\|null)? &?\$\w+|@return \??[\w\\]+(\|null)?)\n)+\s*\*/
   Replace with: */
   This deletes type annotations, except those not representable
   as PHP type hints such as union types `a|b` or typed arrays `a[]`,
   or those with documentation beyond type hints, or those on
   functions with any other annotations.

2. Find: /\*\*/\n\s*
   Replace with nothing
   This deletes the remaining comments on methods that had no prose
   documentation.

3. Undo all changes that PHPCS complains about (those comments
   were not redundant)

4. Review the diff carefully, these regexps are imprecise :)

Change-Id: Ic82e8b23f2996f44951208dbd9cfb4c8e0738dac
2024-03-10 23:53:04 +00:00
..
BetaPreferenceHooks.php Remove now redundant PHPDoc blocks 2024-03-10 23:53:04 +00:00
DataUpdatesHooks.php Update TODO documentation around parsing 2024-01-10 18:29:40 +00:00
DiscussionToolsAddOverflowMenuItemsHook.php [BREAKING CHANGE] Remove isSectionEditable from overflow hook 2023-10-18 12:56:46 +01:00
DiscussionToolsHooks.php [BREAKING CHANGE] Remove isSectionEditable from overflow hook 2023-10-18 12:56:46 +01:00
DiscussionToolsTermsOfUseMessagesHook.php Use namespaced classes 2023-12-11 16:38:02 +01:00
EchoHooks.php Remove now redundant PHPDoc blocks 2024-03-10 23:53:04 +00:00
HookRunner.php Use namespaced classes 2023-12-11 16:38:02 +01:00
HookUtils.php Remove now redundant PHPDoc blocks 2024-03-10 23:53:04 +00:00
InstallerHooks.php Store permalink data, implement Special:FindComment/GoToComment 2022-08-11 01:19:47 +02:00
PageHooks.php Only include one set of DiscussionTools buttons in the page HTML 2024-03-01 16:51:17 +00:00
ParserHooks.php Properly handle preview scenario for Parsoid rendering 2024-02-14 15:32:47 -06:00
PreferenceHooks.php Use namespaced classes 2023-12-11 16:38:02 +01:00
RegistrationHooks.php Use namespaced classes 2023-12-11 16:38:02 +01:00
ResourceLoaderHooks.php Use namespaced classes 2023-12-11 16:38:02 +01:00
TagHooks.php Remove now redundant PHPDoc blocks 2024-03-10 23:53:04 +00:00