mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools
synced 2024-09-23 10:29:11 +00:00
69e8e948b2
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 |
||
|---|---|---|
| .. | ||
| Actions | ||
| Hooks | ||
| Notifications | ||
| ThreadItem | ||
| ApiDiscussionToolsCompare.php | ||
| ApiDiscussionToolsEdit.php | ||
| ApiDiscussionToolsFindComment.php | ||
| ApiDiscussionToolsGetSubscriptions.php | ||
| ApiDiscussionToolsPageInfo.php | ||
| ApiDiscussionToolsPreview.php | ||
| ApiDiscussionToolsSubscribe.php | ||
| ApiDiscussionToolsTrait.php | ||
| ButtonMenuSelectWidget.php | ||
| CommentFormatter.php | ||
| CommentModifier.php | ||
| CommentParser.php | ||
| CommentUtils.php | ||
| ContentThreadItemSet.php | ||
| DatabaseThreadItemSet.php | ||
| ImmutableRange.php | ||
| LanguageData.php | ||
| NodeFilter.php | ||
| OverflowMenuItem.php | ||
| ResourceLoaderData.php | ||
| ServiceWiring.php | ||
| SpecialDiscussionToolsDebug.php | ||
| SpecialFindComment.php | ||
| SpecialGoToComment.php | ||
| SpecialTopicSubscriptions.php | ||
| SubscriptionItem.php | ||
| SubscriptionStore.php | ||
| ThreadItemFormatter.php | ||
| ThreadItemSet.php | ||
| ThreadItemStore.php | ||
| TopicSubscriptionsPager.php | ||
| TreeWalker.php | ||