From: Daniel Friesen <dantman@users.mediawiki.org>
Date: Sun, 5 Dec 2010 04:22:29 +0000 (+0000)
Subject: Add method documentation for getCommonStylePath and getSkinStylePath.
X-Git-Tag: 1.31.0-rc.0~33562
X-Git-Url: http://git.cyclocoop.org/%40spipnet%40?a=commitdiff_plain;h=7c143e5fb009ef522190cf42253fcce2c5f7ba9d;p=lhc%2Fweb%2Fwiklou.git

Add method documentation for getCommonStylePath and getSkinStylePath.
---

diff --git a/includes/Skin.php b/includes/Skin.php
index fcaa0c8ef0..271e4f0de7 100644
--- a/includes/Skin.php
+++ b/includes/Skin.php
@@ -2036,14 +2036,28 @@ class Skin extends Linker {
 		}
 	}
 
+	/**
+	 * Return a fully resolved style path url to images or styles stored in the common folder.
+	 * This method returns a url resolved using the configured skin style path
+	 * and includes the style version inside of the url.
+	 * @param $name String: The name or path of the common file to return the full path for.
+	 * @return String The fully resolved style path url including styleversion
+	 */
 	function getCommonStylePath( $name ) {
 		global $wgStylePath, $wgStyleVersion;
-		return "{$wgStylePath}/common/$name?$wgStyleVersion";
+		return "{$wgStylePath}/common/$name?{$wgStyleVersion}";
 	}
 
+	/**
+	 * Return a fully resolved style path url to images or styles stored in the curent skins's folder.
+	 * This method returns a url resolved using the configured skin style path
+	 * and includes the style version inside of the url.
+	 * @param $name String: The name or path of the skin resource file to return the full path for.
+	 * @return String The fully resolved style path url including styleversion
+	 */
 	function getSkinStylePath( $name ) {
 		global $wgStylePath, $wgStyleVersion;
-		return "{$wgStylePath}/{$this->stylename}/$name?$wgStyleVersion";
+		return "{$wgStylePath}/{$this->stylename}/$name?{$wgStyleVersion}";
 	}
 
 	/* these are used extensively in SkinTemplate, but also some other places */