From: Timo Tijhof <krinklemail@gmail.com>
Date: Sat, 1 Jul 2017 00:31:56 +0000 (-0700)
Subject: resourceloader: Minor documentation and coding style improvements
X-Git-Tag: 1.31.0-rc.0~2813^2
X-Git-Url: http://git.heureux-cyclage.org/?a=commitdiff_plain;h=98b148d24744fa71663352ac9bd3bca9d1e099a1;p=lhc%2Fweb%2Fwiklou.git

resourceloader: Minor documentation and coding style improvements

Based on current non-voting codesniffer warnings.

Change-Id: I34cbc31eda3eaa519a71fe2c04122859f2f15914
---

diff --git a/includes/resourceloader/ResourceLoaderClientHtml.php b/includes/resourceloader/ResourceLoaderClientHtml.php
index ace8f4126a..197ac511d1 100644
--- a/includes/resourceloader/ResourceLoaderClientHtml.php
+++ b/includes/resourceloader/ResourceLoaderClientHtml.php
@@ -109,7 +109,7 @@ class ResourceLoaderClientHtml {
 	 *
 	 * See OutputPage::buildExemptModules() for use cases.
 	 *
-	 * @param array $modules Module state keyed by module name
+	 * @param array $states Module state keyed by module name
 	 */
 	public function setExemptStates( array $states ) {
 		$this->exemptStates = $states;
@@ -370,7 +370,6 @@ class ResourceLoaderClientHtml {
 		sort( $modules );
 
 		if ( $mainContext->getDebug() && count( $modules ) > 1 ) {
-
 			$chunks = [];
 			// Recursively call us for every item
 			foreach ( $modules as $name ) {
diff --git a/includes/resourceloader/ResourceLoaderFileModule.php b/includes/resourceloader/ResourceLoaderFileModule.php
index 725bc6a05e..79b8e79d08 100644
--- a/includes/resourceloader/ResourceLoaderFileModule.php
+++ b/includes/resourceloader/ResourceLoaderFileModule.php
@@ -980,18 +980,19 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
 		$files = $compiler->AllParsedFiles();
 		$this->localFileRefs = array_merge( $this->localFileRefs, $files );
 
+		// Cache for 24 hours (86400 seconds).
 		$cache->set( $cacheKey, [
 			'css'   => $css,
 			'files' => $files,
 			'hash'  => FileContentsHasher::getFileContentsHash( $files ),
-		], 60 * 60 * 24 );  // 86400 seconds, or 24 hours.
+		], 3600 * 24 );
 
 		return $css;
 	}
 
 	/**
 	 * Takes named templates by the module and returns an array mapping.
-	 * @return array of templates mapping template alias to content
+	 * @return array Templates mapping template alias to content
 	 * @throws MWException
 	 */
 	public function getTemplates() {
@@ -1022,7 +1023,8 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
 	 * the BOM character is not valid in the middle of a string.
 	 * We already assume UTF-8 everywhere, so this should be safe.
 	 *
-	 * @return string input minus the intial BOM char
+	 * @param string $input
+	 * @return string Input minus the intial BOM char
 	 */
 	protected function stripBom( $input ) {
 		if ( substr_compare( "\xef\xbb\xbf", $input, 0, 3 ) === 0 ) {
diff --git a/includes/resourceloader/ResourceLoaderImage.php b/includes/resourceloader/ResourceLoaderImage.php
index 19d54714f5..072ae7944b 100644
--- a/includes/resourceloader/ResourceLoaderImage.php
+++ b/includes/resourceloader/ResourceLoaderImage.php
@@ -148,9 +148,8 @@ class ResourceLoaderImage {
 	public function getExtension( $format = 'original' ) {
 		if ( $format === 'rasterized' && $this->extension === 'svg' ) {
 			return 'png';
-		} else {
-			return $this->extension;
 		}
+		return $this->extension;
 	}
 
 	/**
diff --git a/includes/resourceloader/ResourceLoaderSiteModule.php b/includes/resourceloader/ResourceLoaderSiteModule.php
index 7401d58e70..08641b0c30 100644
--- a/includes/resourceloader/ResourceLoaderSiteModule.php
+++ b/includes/resourceloader/ResourceLoaderSiteModule.php
@@ -42,7 +42,7 @@ class ResourceLoaderSiteModule extends ResourceLoaderWikiModule {
 		return $pages;
 	}
 
-	/*
+	/**
 	 * @return array
 	 */
 	public function getDependencies( ResourceLoaderContext $context = null ) {
diff --git a/includes/resourceloader/ResourceLoaderUploadDialogModule.php b/includes/resourceloader/ResourceLoaderUploadDialogModule.php
index 52e221089f..9377ed6e26 100644
--- a/includes/resourceloader/ResourceLoaderUploadDialogModule.php
+++ b/includes/resourceloader/ResourceLoaderUploadDialogModule.php
@@ -29,6 +29,9 @@ class ResourceLoaderUploadDialogModule extends ResourceLoaderModule {
 
 	protected $targets = [ 'desktop', 'mobile' ];
 
+	/**
+	 * @return string JavaScript code
+	 */
 	public function getScript( ResourceLoaderContext $context ) {
 		$config = $context->getResourceLoader()->getConfig();
 		return ResourceLoader::makeConfigSetScript( [
@@ -36,6 +39,9 @@ class ResourceLoaderUploadDialogModule extends ResourceLoaderModule {
 		] );
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function enableModuleContentVersion() {
 		return true;
 	}