Inspection of "Daily Inspection: Merge "mw.widgets.CategorySelect..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (99b842)

unknown

created 2016-07-13 17:14 UTC

Status

Doc Comments +22 added lines, -16 removed lines patch added patch discarded remove patch

@@ -420,7 +420,7 @@  discard block
 block discarded – undo
 	 * one is set.
 	 *
 	 * @since 1.25
-	 * @return bool|string
+	 * @return boolean
 	 */
 	public function getCanonicalUrl() {
 		return $this->mCanonicalUrl;
@@ -984,7 +984,7 @@  discard block
 block discarded – undo
 	/**
 	 * Replace the subtitle with $str
 	 *
-	 * @param string|Message $str New value of the subtitle. String should be safe HTML.
+	 * @param string $str New value of the subtitle. String should be safe HTML.
 	 */
 	public function setSubtitle( $str ) {
 		$this->clearSubtitle();
@@ -1593,7 +1593,7 @@  discard block
 block discarded – undo
 	 * Get the timestamp of displayed revision.
 	 * This will be null if not filled by setRevisionTimestamp().
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getRevisionTimestamp() {
 		return $this->mRevisionTimestamp;
@@ -1602,7 +1602,7 @@  discard block
 block discarded – undo
 	/**
 	 * Set the displayed file version
 	 *
-	 * @param File|bool $file
+	 * @param File $file
 	 * @return mixed Previous value
 	 */
 	public function setFileVersion( $file ) {
@@ -1948,7 +1948,7 @@  discard block
 block discarded – undo
 	/**
 	 * Get the list of cookies that will influence on the cache
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function getCacheVaryCookies() {
 		static $cookies;
@@ -2327,7 +2327,7 @@  discard block
 block discarded – undo
 	 * indexing, clear the current text and redirect, set the page's title
 	 * and optionally an custom HTML title (content of the "<title>" tag).
 	 *
-	 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
+	 * @param Message $pageTitle Will be passed directly to setPageTitle()
 	 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
 	 *                   optional, if not passed the "<title>" attribute will be
 	 *                   based on $pageTitle
@@ -2353,8 +2353,8 @@  discard block
 block discarded – undo
 	 * showErrorPage( 'titlemsg', $messageObject );
 	 * showErrorPage( $titleMessageObject, $messageObject );
 	 *
-	 * @param string|Message $title Message key (string) for page title, or a Message object
-	 * @param string|Message $msg Message key (string) for page text, or a Message object
+	 * @param string $title Message key (string) for page title, or a Message object
+	 * @param string $msg Message key (string) for page text, or a Message object
 	 * @param array $params Message parameters; ignored if $msg is a Message object
 	 */
 	public function showErrorPage( $title, $msg, $params = [] ) {
@@ -2550,6 +2550,9 @@  discard block
 block discarded – undo
 		}
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function showFatalError( $message ) {
 		$this->prepareErrorPage( $this->msg( 'internalerror' ) );
 
@@ -2568,6 +2571,9 @@  discard block
 block discarded – undo
 		$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function showFileDeleteError( $name ) {
 		$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
 	}
@@ -2594,7 +2600,7 @@  discard block
 block discarded – undo
 	 * Add a "return to" link pointing to a specified title,
 	 * or the title indicated in the request, or else the main page
 	 *
-	 * @param mixed $unused
+	 * @param null|boolean $unused
 	 * @param Title|string $returnto Title or String to return to
 	 * @param string $returntoquery Query string for the return to link
 	 */
@@ -2905,7 +2911,7 @@  discard block
 block discarded – undo
 	/**
 	 * Build html output from an array of links from makeResourceLoaderLink.
 	 * @param array $links
-	 * @return string|WrappedStringList HTML
+	 * @return WrappedStringList HTML
 	 */
 	protected static function getHtmlFromLoaderLinks( array $links ) {
 		$html = [];
@@ -2944,7 +2950,7 @@  discard block
 block discarded – undo
 	 * <script src="..."> tags for "<head>".This is the startup module
 	 * and other modules marked with position 'top'.
 	 *
-	 * @return string|WrappedStringList HTML
+	 * @return WrappedStringList HTML
 	 */
 	function getExternalHeadScripts() {
 		// Startup - this provides the client with the module
@@ -2957,7 +2963,7 @@  discard block
 block discarded – undo
 	/**
 	 * Inline "<script>" tags to put in "<head>".
 	 *
-	 * @return string|WrappedStringList HTML
+	 * @return WrappedStringList HTML
 	 */
 	function getInlineHeadScripts() {
 		$links = [];
@@ -3017,7 +3023,7 @@  discard block
 block discarded – undo
 	 *
 	 * @param bool $unused Previously used to let this method change its output based
 	 *  on whether it was called by getExternalHeadScripts() or getBottomScripts().
-	 * @return string|WrappedStringList HTML
+	 * @return WrappedStringList HTML
 	 */
 	function getScriptsForBottomQueue( $unused = null ) {
 		// Scripts "only" requests marked for bottom inclusion
@@ -3084,7 +3090,7 @@  discard block
 block discarded – undo
 
 	/**
 	 * JS stuff to put at the bottom of the "<body>"
-	 * @return string
+	 * @return WrappedStringList
 	 */
 	function getBottomScripts() {
 		return $this->getScriptsForBottomQueue();
@@ -3618,7 +3624,7 @@  discard block
 block discarded – undo
 	/**
 	 * Build a set of "<link>" elements for stylesheets specified in the $this->styles array.
 	 *
-	 * @return string|WrappedStringList HTML
+	 * @return WrappedStringList HTML
 	 */
 	public function buildCssLinks() {
 		global $wgContLang;
@@ -3833,7 +3839,7 @@  discard block
 block discarded – undo
 	 * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
 	 *
 	 * @since 1.27
-	 * @param string $remotePath URL path prefix that points to $localPath
+	 * @param string $remotePathPrefix URL path prefix that points to $localPath
 	 * @param string $localPath File directory exposed at $remotePath
 	 * @param string $file Path to target file relative to $localPath
 	 * @return string URL

Please login to merge, or discard this patch.

		@@ -420,7 +420,7 @@ discard block
		block discarded – undo
420	420	* one is set.
421	421	*
422	422	* @since 1.25
423		- * @return bool\|string
	423	+ * @return boolean
424	424	*/
425	425	public function getCanonicalUrl() {
426	426	return $this->mCanonicalUrl;
		@@ -984,7 +984,7 @@ discard block
		block discarded – undo
984	984	/**
985	985	* Replace the subtitle with $str
986	986	*
987		- * @param string\|Message $str New value of the subtitle. String should be safe HTML.
	987	+ * @param string $str New value of the subtitle. String should be safe HTML.
988	988	*/
989	989	public function setSubtitle( $str ) {
990	990	$this->clearSubtitle();
		@@ -1593,7 +1593,7 @@ discard block
		block discarded – undo
1593	1593	* Get the timestamp of displayed revision.
1594	1594	* This will be null if not filled by setRevisionTimestamp().
1595	1595	*
1596		- * @return string\|null
	1596	+ * @return string
1597	1597	*/
1598	1598	public function getRevisionTimestamp() {
1599	1599	return $this->mRevisionTimestamp;
		@@ -1602,7 +1602,7 @@ discard block
		block discarded – undo
1602	1602	/**
1603	1603	* Set the displayed file version
1604	1604	*
1605		- * @param File\|bool $file
	1605	+ * @param File $file
1606	1606	* @return mixed Previous value
1607	1607	*/
1608	1608	public function setFileVersion( $file ) {
		@@ -1948,7 +1948,7 @@ discard block
		block discarded – undo
1948	1948	/**
1949	1949	* Get the list of cookies that will influence on the cache
1950	1950	*
1951		- * @return array
	1951	+ * @return string[]
1952	1952	*/
1953	1953	function getCacheVaryCookies() {
1954	1954	static $cookies;
		@@ -2327,7 +2327,7 @@ discard block
		block discarded – undo
2327	2327	* indexing, clear the current text and redirect, set the page's title
2328	2328	* and optionally an custom HTML title (content of the "<title>" tag).
2329	2329	*
2330		- * @param string\|Message $pageTitle Will be passed directly to setPageTitle()
	2330	+ * @param Message $pageTitle Will be passed directly to setPageTitle()
2331	2331	* @param string\|Message $htmlTitle Will be passed directly to setHTMLTitle();
2332	2332	* optional, if not passed the "<title>" attribute will be
2333	2333	* based on $pageTitle
		@@ -2353,8 +2353,8 @@ discard block
		block discarded – undo
2353	2353	* showErrorPage( 'titlemsg', $messageObject );
2354	2354	* showErrorPage( $titleMessageObject, $messageObject );
2355	2355	*
2356		- * @param string\|Message $title Message key (string) for page title, or a Message object
2357		- * @param string\|Message $msg Message key (string) for page text, or a Message object
	2356	+ * @param string $title Message key (string) for page title, or a Message object
	2357	+ * @param string $msg Message key (string) for page text, or a Message object
2358	2358	* @param array $params Message parameters; ignored if $msg is a Message object
2359	2359	*/
2360	2360	public function showErrorPage( $title, $msg, $params = [] ) {
		@@ -2550,6 +2550,9 @@ discard block
		block discarded – undo
2550	2550	}
2551	2551	}
2552	2552
	2553	+ /**
	2554	+ * @param string $message
	2555	+ */
2553	2556	public function showFatalError( $message ) {
2554	2557	$this->prepareErrorPage( $this->msg( 'internalerror' ) );
2555	2558
		@@ -2568,6 +2571,9 @@ discard block
		block discarded – undo
2568	2571	$this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2569	2572	}
2570	2573
	2574	+ /**
	2575	+ * @param string $name
	2576	+ */
2571	2577	public function showFileDeleteError( $name ) {
2572	2578	$this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2573	2579	}
		@@ -2594,7 +2600,7 @@ discard block
		block discarded – undo
2594	2600	* Add a "return to" link pointing to a specified title,
2595	2601	* or the title indicated in the request, or else the main page
2596	2602	*
2597		- * @param mixed $unused
	2603	+ * @param null\|boolean $unused
2598	2604	* @param Title\|string $returnto Title or String to return to
2599	2605	* @param string $returntoquery Query string for the return to link
2600	2606	*/
		@@ -2905,7 +2911,7 @@ discard block
		block discarded – undo
2905	2911	/**
2906	2912	* Build html output from an array of links from makeResourceLoaderLink.
2907	2913	* @param array $links
2908		- * @return string\|WrappedStringList HTML
	2914	+ * @return WrappedStringList HTML
2909	2915	*/
2910	2916	protected static function getHtmlFromLoaderLinks( array $links ) {
2911	2917	$html = [];
		@@ -2944,7 +2950,7 @@ discard block
		block discarded – undo
2944	2950	* <script src="..."> tags for "<head>".This is the startup module
2945	2951	* and other modules marked with position 'top'.
2946	2952	*
2947		- * @return string\|WrappedStringList HTML
	2953	+ * @return WrappedStringList HTML
2948	2954	*/
2949	2955	function getExternalHeadScripts() {
2950	2956	// Startup - this provides the client with the module
		@@ -2957,7 +2963,7 @@ discard block
		block discarded – undo
2957	2963	/**
2958	2964	* Inline "<script>" tags to put in "<head>".
2959	2965	*
2960		- * @return string\|WrappedStringList HTML
	2966	+ * @return WrappedStringList HTML
2961	2967	*/
2962	2968	function getInlineHeadScripts() {
2963	2969	$links = [];
		@@ -3017,7 +3023,7 @@ discard block
		block discarded – undo
3017	3023	*
3018	3024	* @param bool $unused Previously used to let this method change its output based
3019	3025	* on whether it was called by getExternalHeadScripts() or getBottomScripts().
3020		- * @return string\|WrappedStringList HTML
	3026	+ * @return WrappedStringList HTML
3021	3027	*/
3022	3028	function getScriptsForBottomQueue( $unused = null ) {
3023	3029	// Scripts "only" requests marked for bottom inclusion
		@@ -3084,7 +3090,7 @@ discard block
		block discarded – undo
3084	3090
3085	3091	/**
3086	3092	* JS stuff to put at the bottom of the "<body>"
3087		- * @return string
	3093	+ * @return WrappedStringList
3088	3094	*/
3089	3095	function getBottomScripts() {
3090	3096	return $this->getScriptsForBottomQueue();
		@@ -3618,7 +3624,7 @@ discard block
		block discarded – undo
3618	3624	/**
3619	3625	* Build a set of "<link>" elements for stylesheets specified in the $this->styles array.
3620	3626	*
3621		- * @return string\|WrappedStringList HTML
	3627	+ * @return WrappedStringList HTML
3622	3628	*/
3623	3629	public function buildCssLinks() {
3624	3630	global $wgContLang;
		@@ -3833,7 +3839,7 @@ discard block
		block discarded – undo
3833	3839	* Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
3834	3840	*
3835	3841	* @since 1.27
3836		- * @param string $remotePath URL path prefix that points to $localPath
	3842	+ * @param string $remotePathPrefix URL path prefix that points to $localPath
3837	3843	* @param string $localPath File directory exposed at $remotePath
3838	3844	* @param string $file Path to target file relative to $localPath
3839	3845	* @return string URL

wikimedia / mediawiki

Branch — master (99b842)

Status

Category

Doc Comments +22 added lines, -16 removed lines patch added patch discarded remove patch