(phpcs) Restyle /** doxygen comments */ an in .phpcs of MediaWiki core

edwardspec · Jul 7, 2018 · ac40260 · ac40260
1 parent 1b5b113
commit ac40260
Show file tree

Hide file tree

Showing 98 changed files with 1,011 additions and 1,011 deletions.
diff --git a/Moderation.alias.php b/Moderation.alias.php
@@ -16,13 +16,13 @@
 */
 
 /**
-	@file
-	@brief Aliases of [[Special:Moderation]] in other languages.
-*/
+ * @file
+ * @brief Aliases of [[Special:Moderation]] in other languages.
+ */
 
 $specialPageAliases = [];
 
- /** English
+/** English
  * @author Edward Chernenko
  */
 $specialPageAliases['en'] = [

diff --git a/Moderation.php b/Moderation.php
@@ -1,8 +1,8 @@
 <?php
 
 /**
-	@file
-	@brief Backward compatibility file to support require_once() in LocalSettings.
+ * @file
+ * @brief Backward compatibility file to support require_once() in LocalSettings.
 
 	Modern syntax (to enable Moderation in LocalSettings.php) is
 		wfLoadExtension( 'Moderation' );

diff --git a/ModerationLogFormatter.php b/ModerationLogFormatter.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Defines the format of [[Special:Log/moderation]]
-*/
+ * @file
+ * @brief Defines the format of [[Special:Log/moderation]]
+ */
 
 class ModerationLogFormatter extends LogFormatter {
 	public function getMessageParameters() {
@@ -88,8 +88,8 @@ public function getMessageParameters() {
 	}
 
 	/**
-		@brief List of Titles to be fed to LinkBatch (to check their existence).
-	*/
+	 * @brief List of Titles to be fed to LinkBatch (to check their existence).
+	 */
 	public function getPreloadTitles() {
 		$type = $this->entry->getSubtype();
 		$params = $this->entry->getParameters();

diff --git a/ModerationSpecialUpload.php b/ModerationSpecialUpload.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Proxy class for SpecialUpload.
-*/
+ * @file
+ * @brief Proxy class for SpecialUpload.
+ */
 
 /*
 	This class is only needed to gain access to the

diff --git a/SpecialModeration.php b/SpecialModeration.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements [[Special:Moderation]].
+ */
 
 class SpecialModeration extends QueryPage {
 	public $folder; // Currently selected folder (when viewing the moderation table)

diff --git a/action/ModerationAction.php b/action/ModerationAction.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Parent class for all moderation actions.
-*/
+ * @file
+ * @brief Parent class for all moderation actions.
+ */
 
 abstract class ModerationAction extends ContextSource {
 	protected $id;
@@ -68,24 +68,24 @@ public function requiresWrite() {
 	}
 
 	/**
-		@brief Function called when the action is invoked.
-		@return Array containing API response.
-		@throws ModerationError
-	*/
+	 * @brief Function called when the action is invoked.
+	 * @return Array containing API response.
+	 * @throws ModerationError
+	 */
 
 	abstract public function execute();
 
 	/**
-		@brief Print the result of execute() in a human-readable way.
-		@param $result Value returned by execute().
-		@param $out OutputPage object.
-	*/
+	 * @brief Print the result of execute() in a human-readable way.
+	 * @param $result Value returned by execute().
+	 * @param $out OutputPage object.
+	 */
 	abstract public function outputResult( array $result, OutputPage &$out );
 
 	/**
-		@brief Utility function. Get userpage of user who made this edit.
-		@returns Title object or false.
-	*/
+	 * @brief Utility function. Get userpage of user who made this edit.
+	 * @returns Title object or false.
+	 */
 	protected function getUserpageOfPerformer() {
 		$dbw = wfGetDB( DB_MASTER ); # Need latest data without lag
 		$username = $dbw->selectField( 'moderation', 'mod_user_text',

diff --git a/action/ModerationActionApprove.php b/action/ModerationActionApprove.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=approve(all) on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=approve(all) on [[Special:Moderation]].
+ */
 
 class ModerationActionApprove extends ModerationAction {
 

diff --git a/action/ModerationActionBlock.php b/action/ModerationActionBlock.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=(un)block on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=(un)block on [[Special:Moderation]].
+ */
 
 class ModerationActionBlock extends ModerationAction {
 

diff --git a/action/ModerationActionMerge.php b/action/ModerationActionMerge.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=merge on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=merge on [[Special:Moderation]].
+ */
 
 class ModerationActionMerge extends ModerationAction {
 

diff --git a/action/ModerationActionPreview.php b/action/ModerationActionPreview.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=preview on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=preview on [[Special:Moderation]].
+ */
 
 class ModerationActionPreview extends ModerationAction {
 
@@ -67,8 +67,8 @@ public function execute() {
 	}
 
 	/**
-		@brief Returns ParserOptions object to be used for parsing.
-	*/
+	 * @brief Returns ParserOptions object to be used for parsing.
+	 */
 	protected function getParserOptions() {
 		global $wgVersion;
 

diff --git a/action/ModerationActionReject.php b/action/ModerationActionReject.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=reject(all) on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=reject(all) on [[Special:Moderation]].
+ */
 
 class ModerationActionReject extends ModerationAction {
 

diff --git a/action/ModerationActionShow.php b/action/ModerationActionShow.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=show on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=show on [[Special:Moderation]].
+ */
 
 class ModerationActionShow extends ModerationAction {
 

diff --git a/action/ModerationActionShowImage.php b/action/ModerationActionShowImage.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Implements modaction=showimg on [[Special:Moderation]].
-*/
+ * @file
+ * @brief Implements modaction=showimg on [[Special:Moderation]].
+ */
 
 class ModerationActionShowImage extends ModerationAction {
 

diff --git a/api/ApiModeration.php b/api/ApiModeration.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief API to invoke moderation actions like Approve, Reject, etc.
-*/
+ * @file
+ * @brief API to invoke moderation actions like Approve, Reject, etc.
+ */
 
 class ApiModeration extends ApiBase {
 

diff --git a/api/ApiQueryModerationPreload.php b/api/ApiQueryModerationPreload.php
@@ -16,8 +16,8 @@
 */
 
 /**
-	@file
-	@brief API to preload edits which are pending moderation.
+ * @file
+ * @brief API to preload edits which are pending moderation.
 
 	This can be used by API-based JavaScript editors,
 	for example Extension:VisualEditor or Extension:MobileFrontend.
@@ -74,9 +74,9 @@ public function execute() {
 	}
 
 	/**
-		@brief Parse $wikitext and return the results.
-		@returns array with keys 'text', 'categorieshtml', 'displaytitle'
-	*/
+	 * @brief Parse $wikitext and return the results.
+	 * @returns array with keys 'text', 'categorieshtml', 'displaytitle'
+	 */
 	protected function parse( Title $title, $wikitext ) {
 		$apiParams = [
 			'action' => 'parse',

diff --git a/hooks/ModerationApiHooks.php b/hooks/ModerationApiHooks.php
@@ -16,9 +16,9 @@
 */
 
 /**
-	@file
-	@brief Hooks related to edits/uploads via API.
-*/
+ * @file
+ * @brief Hooks related to edits/uploads via API.
+ */
 
 class ModerationApiHooks {
 
@@ -131,8 +131,8 @@ public static function onApiBeforeMain( &$main ) {
 	}
 
 	/**
-		@brief Adds qppage=Moderation to api.php?action=query&list=querypage.
-	*/
+	 * @brief Adds qppage=Moderation to api.php?action=query&list=querypage.
+	 */
 	public static function onwgQueryPages( &$wgQueryPages ) {
 		$wgQueryPages[] = [ SpecialModeration::class, 'Moderation' ];
 		return true;