From: umherirrender <umherirrender_de.wp@web.de>
Date: Wed, 23 Apr 2014 09:37:59 +0000 (+0200)
Subject: Fixed some @params documentation (includes/[WebRequest.php|Xml.php])
X-Git-Tag: 1.31.0-rc.0~16063
X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=30fe862c20b015c9a71935fb5524182da1ac2b33;p=lhc%2Fweb%2Fwiklou.git

Fixed some @params documentation (includes/[WebRequest.php|Xml.php])

Swapped some "$var type" to "type $var" or added missing types
before the $var. Changed some other types to match the more common
spelling. Makes beginning of some text in captial.

Change-Id: I4ca5231119f33039d91da3b57a41cd40719a576b
---

diff --git a/includes/WebRequest.php b/includes/WebRequest.php
index 01366f4310..9a9cdf16bc 100644
--- a/includes/WebRequest.php
+++ b/includes/WebRequest.php
@@ -46,7 +46,7 @@ class WebRequest {
 
 	/**
 	 * Cached client IP address
-	 * @var String
+	 * @var string
 	 */
 	private $ip;
 
@@ -80,7 +80,7 @@ class WebRequest {
 	 * will return an empty array if it determines that the URL is
 	 * inside a rewrite path.
 	 *
-	 * @return Array: Any query arguments found in path matches.
+	 * @return array Any query arguments found in path matches.
 	 */
 	public static function getPathInfo( $want = 'all' ) {
 		global $wgUsePathInfo;
@@ -246,11 +246,11 @@ class WebRequest {
 	 * URL rewriting function; tries to extract page title and,
 	 * optionally, one other fixed parameter value from a URL path.
 	 *
-	 * @param string $path the URL path given from the client
-	 * @param array $bases one or more URLs, optionally with $1 at the end
-	 * @param string $key if provided, the matching key in $bases will be
-	 *             passed on as the value of this URL parameter
-	 * @return array of URL variables to interpolate; empty if no match
+	 * @param string $path The URL path given from the client
+	 * @param array $bases One or more URLs, optionally with $1 at the end
+	 * @param string $key If provided, the matching key in $bases will be
+	 *    passed on as the value of this URL parameter
+	 * @return array Array of URL variables to interpolate; empty if no match
 	 */
 	static function extractTitle( $path, $bases, $key = false ) {
 		foreach ( (array)$bases as $keyValue => $base ) {
@@ -279,7 +279,7 @@ class WebRequest {
 	 * @param bool $topLevel Specifies if the array passed is from the top
 	 * level of the source. In PHP5 magic_quotes only escapes the first level
 	 * of keys that belong to an array.
-	 * @return array the original array
+	 * @return array The original array
 	 * @see http://www.php.net/manual/en/function.get-magic-quotes-gpc.php#49612
 	 */
 	private function &fix_magic_quotes( &$arr, $topLevel = true ) {
@@ -319,8 +319,8 @@ class WebRequest {
 	/**
 	 * Recursively normalizes UTF-8 strings in the given array.
 	 *
-	 * @param $data string|array
-	 * @return array|string cleaned-up version of the given
+	 * @param string|array $data
+	 * @return array|string Cleaned-up version of the given
 	 * @private
 	 */
 	function normalizeUnicode( $data ) {
@@ -338,9 +338,9 @@ class WebRequest {
 	/**
 	 * Fetch a value from the given array or return $default if it's not set.
 	 *
-	 * @param $arr Array
-	 * @param $name String
-	 * @param $default Mixed
+	 * @param array $arr
+	 * @param string $name
+	 * @param mixed $default
 	 * @return mixed
 	 */
 	private function getGPCVal( $arr, $name, $default ) {
@@ -370,9 +370,9 @@ class WebRequest {
 	 * non-freeform text inputs (e.g. predefined internal text keys
 	 * selected by a drop-down menu). For freeform input, see getText().
 	 *
-	 * @param $name String
-	 * @param string $default optional default (or NULL)
-	 * @return String
+	 * @param string $name
+	 * @param string $default Optional default (or NULL)
+	 * @return string
 	 */
 	public function getVal( $name, $default = null ) {
 		$val = $this->getGPCVal( $this->data, $name, $default );
@@ -389,9 +389,9 @@ class WebRequest {
 	/**
 	 * Set an arbitrary value into our get/post data.
 	 *
-	 * @param string $key key name to use
-	 * @param $value Mixed: value to set
-	 * @return Mixed: old value if one was present, null otherwise
+	 * @param string $key Key name to use
+	 * @param mixed $value Value to set
+	 * @return mixed Old value if one was present, null otherwise
 	 */
 	public function setVal( $key, $value ) {
 		$ret = isset( $this->data[$key] ) ? $this->data[$key] : null;
@@ -402,8 +402,8 @@ class WebRequest {
 	/**
 	 * Unset an arbitrary value from our get/post data.
 	 *
-	 * @param string $key key name to use
-	 * @return Mixed: old value if one was present, null otherwise
+	 * @param string $key Key name to use
+	 * @return mixed Old value if one was present, null otherwise
 	 */
 	public function unsetVal( $key ) {
 		if ( !isset( $this->data[$key] ) ) {
@@ -420,9 +420,9 @@ class WebRequest {
 	 * If source was scalar, will return an array with a single element.
 	 * If no source and no default, returns NULL.
 	 *
-	 * @param $name String
-	 * @param array $default optional default (or NULL)
-	 * @return Array
+	 * @param string $name
+	 * @param array $default Optional default (or NULL)
+	 * @return array
 	 */
 	public function getArray( $name, $default = null ) {
 		$val = $this->getGPCVal( $this->data, $name, $default );
@@ -439,9 +439,9 @@ class WebRequest {
 	 * If no source and no default, returns NULL.
 	 * If an array is returned, contents are guaranteed to be integers.
 	 *
-	 * @param $name String
+	 * @param string $name
 	 * @param array $default option default (or NULL)
-	 * @return Array of ints
+	 * @return array Array of ints
 	 */
 	public function getIntArray( $name, $default = null ) {
 		$val = $this->getArray( $name, $default );
@@ -456,9 +456,9 @@ class WebRequest {
 	 * Guaranteed to return an integer; non-numeric input will typically
 	 * return 0.
 	 *
-	 * @param $name String
-	 * @param $default Integer
-	 * @return Integer
+	 * @param string $name
+	 * @param int $default
+	 * @return int
 	 */
 	public function getInt( $name, $default = 0 ) {
 		return intval( $this->getVal( $name, $default ) );
@@ -469,8 +469,8 @@ class WebRequest {
 	 * Guaranteed to return an integer or null; non-numeric input will
 	 * typically return null.
 	 *
-	 * @param $name String
-	 * @return Integer
+	 * @param string $name
+	 * @return int|null
 	 */
 	public function getIntOrNull( $name ) {
 		$val = $this->getVal( $name );
@@ -485,9 +485,9 @@ class WebRequest {
 	 * return 0.
 	 *
 	 * @since 1.23
-	 * @param $name String
-	 * @param $default Float
-	 * @return Float
+	 * @param string $name
+	 * @param float $default
+	 * @return float
 	 */
 	public function getFloat( $name, $default = 0 ) {
 		return floatval( $this->getVal( $name, $default ) );
@@ -498,9 +498,9 @@ class WebRequest {
 	 * Guaranteed to return true or false, with normal PHP semantics for
 	 * boolean interpretation of strings.
 	 *
-	 * @param $name String
-	 * @param $default Boolean
-	 * @return Boolean
+	 * @param string $name
+	 * @param bool $default
+	 * @return bool
 	 */
 	public function getBool( $name, $default = false ) {
 		return (bool)$this->getVal( $name, $default );
@@ -511,9 +511,9 @@ class WebRequest {
 	 * Unlike getBool, the string "false" will result in boolean false, which is
 	 * useful when interpreting information sent from JavaScript.
 	 *
-	 * @param $name String
-	 * @param $default Boolean
-	 * @return Boolean
+	 * @param string $name
+	 * @param bool $default
+	 * @return bool
 	 */
 	public function getFuzzyBool( $name, $default = false ) {
 		return $this->getBool( $name, $default ) && strcasecmp( $this->getVal( $name ), 'false' ) !== 0;
@@ -524,8 +524,8 @@ class WebRequest {
 	 * value is (even "0"). Return false if the named value is not set.
 	 * Example use is checking for the presence of check boxes in forms.
 	 *
-	 * @param $name String
-	 * @return Boolean
+	 * @param string $name
+	 * @return bool
 	 */
 	public function getCheck( $name ) {
 		# Checkboxes and buttons are only present when clicked
@@ -541,9 +541,9 @@ class WebRequest {
 	 * user-supplied freeform text input (for which input transformations may
 	 * be required - e.g.  Esperanto x-coding).
 	 *
-	 * @param $name String
-	 * @param string $default optional
-	 * @return String
+	 * @param string $name
+	 * @param string $default Optional
+	 * @return string
 	 */
 	public function getText( $name, $default = '' ) {
 		global $wgContLang;
@@ -578,7 +578,7 @@ class WebRequest {
 	/**
 	 * Returns the names of all input values excluding those in $exclude.
 	 *
-	 * @param $exclude Array
+	 * @param array $exclude
 	 * @return array
 	 */
 	public function getValueNames( $exclude = array() ) {
@@ -589,7 +589,7 @@ class WebRequest {
 	 * Get the values passed in the query string.
 	 * No transformation is performed on the values.
 	 *
-	 * @return Array
+	 * @return array
 	 */
 	public function getQueryValues() {
 		return $_GET;
@@ -599,7 +599,7 @@ class WebRequest {
 	 * Return the contents of the Query with no decoding. Use when you need to
 	 * know exactly what was sent, e.g. for an OAuth signature over the elements.
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function getRawQueryString() {
 		return $_SERVER['QUERY_STRING'];
@@ -609,7 +609,7 @@ class WebRequest {
 	 * Return the contents of the POST with no decoding. Use when you need to
 	 * know exactly what was sent, e.g. for an OAuth signature over the elements.
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function getRawPostString() {
 		if ( !$this->wasPosted() ) {
@@ -623,7 +623,7 @@ class WebRequest {
 	 * disallow reading the stream more than once. As stated in the php docs, this
 	 * does not work with enctype="multipart/form-data".
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function getRawInput() {
 		static $input = false;
@@ -636,7 +636,7 @@ class WebRequest {
 	/**
 	 * Get the HTTP method used for this request.
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function getMethod() {
 		return isset( $_SERVER['REQUEST_METHOD'] ) ? $_SERVER['REQUEST_METHOD'] : 'GET';
@@ -649,7 +649,7 @@ class WebRequest {
 	 * Note that values retrieved by the object may come from the
 	 * GET URL etc even on a POST request.
 	 *
-	 * @return Boolean
+	 * @return bool
 	 */
 	public function wasPosted() {
 		return $this->getMethod() == 'POST';
@@ -664,7 +664,7 @@ class WebRequest {
 	 * during the current request (in which case the cookie will
 	 * be sent back to the client at the end of the script run).
 	 *
-	 * @return Boolean
+	 * @return bool
 	 */
 	public function checkSessionCookie() {
 		return isset( $_COOKIE[session_name()] );
@@ -673,10 +673,10 @@ class WebRequest {
 	/**
 	 * Get a cookie from the $_COOKIE jar
 	 *
-	 * @param string $key the name of the cookie
-	 * @param string $prefix a prefix to use for the cookie name, if not $wgCookiePrefix
-	 * @param $default Mixed: what to return if the value isn't found
-	 * @return Mixed: cookie value or $default if the cookie not set
+	 * @param string $key The name of the cookie
+	 * @param string $prefix A prefix to use for the cookie name, if not $wgCookiePrefix
+	 * @param mixed $default What to return if the value isn't found
+	 * @return mixed Cookie value or $default if the cookie not set
 	 */
 	public function getCookie( $key, $prefix = null, $default = null ) {
 		if ( $prefix === null ) {
@@ -691,7 +691,7 @@ class WebRequest {
 	 * This will be suitable for use as a relative link in HTML output.
 	 *
 	 * @throws MWException
-	 * @return String
+	 * @return string
 	 */
 	public function getRequestURL() {
 		if ( isset( $_SERVER['REQUEST_URI'] ) && strlen( $_SERVER['REQUEST_URI'] ) ) {
@@ -736,7 +736,7 @@ class WebRequest {
 	 * If $wgServer is protocol-relative, this will return a fully
 	 * qualified URL with the protocol that was used for this request.
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function getFullRequestURL() {
 		return wfExpandUrl( $this->getRequestURL(), PROTO_CURRENT );
@@ -746,7 +746,7 @@ class WebRequest {
 	 * Take an arbitrary query and rewrite the present URL to include it
 	 * @param string $query query string fragment; do not include initial '?'
 	 *
-	 * @return String
+	 * @return string
 	 */
 	public function appendQuery( $query ) {
 		return $this->appendQueryArray( wfCgiToArray( $query ) );
@@ -756,18 +756,18 @@ class WebRequest {
 	 * HTML-safe version of appendQuery().
 	 * @deprecated: Deprecated in 1.20, warnings in 1.21, remove in 1.22.
 	 *
-	 * @param string $query query string fragment; do not include initial '?'
-	 * @return String
+	 * @param string $query Query string fragment; do not include initial '?'
+	 * @return string
 	 */
 	public function escapeAppendQuery( $query ) {
 		return htmlspecialchars( $this->appendQuery( $query ) );
 	}
 
 	/**
-	 * @param $key
-	 * @param $value
-	 * @param $onlyquery bool
-	 * @return String
+	 * @param string $key
+	 * @param string $value
+	 * @param bool $onlyquery
+	 * @return string
 	 */
 	public function appendQueryValue( $key, $value, $onlyquery = false ) {
 		return $this->appendQueryArray( array( $key => $value ), $onlyquery );
@@ -776,10 +776,9 @@ class WebRequest {
 	/**
 	 * Appends or replaces value of query variables.
 	 *
-	 * @param array $array of values to replace/add to query
-	 * @param bool $onlyquery whether to only return the query string and not
-	 *                   the complete URL
-	 * @return String
+	 * @param array $array Array of values to replace/add to query
+	 * @param bool $onlyquery Whether to only return the query string and not the complete URL
+	 * @return string
 	 */
 	public function appendQueryArray( $array, $onlyquery = false ) {
 		global $wgTitle;
@@ -795,9 +794,9 @@ class WebRequest {
 	 * defaults if not given. The limit must be positive and is capped at 5000.
 	 * Offset must be positive but is not capped.
 	 *
-	 * @param $deflimit Integer: limit to use if no input and the user hasn't set the option.
-	 * @param string $optionname to specify an option other than rclimit to pull from.
-	 * @return array first element is limit, second is offset
+	 * @param int $deflimit Limit to use if no input and the user hasn't set the option.
+	 * @param string $optionname To specify an option other than rclimit to pull from.
+	 * @return array First element is limit, second is offset
 	 */
 	public function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
 		global $wgUser;
@@ -827,8 +826,8 @@ class WebRequest {
 	/**
 	 * Return the path to the temporary file where PHP has stored the upload.
 	 *
-	 * @param $key String:
-	 * @return string or NULL if no such file.
+	 * @param string $key
+	 * @return string|null string or null if no such file.
 	 */
 	public function getFileTempname( $key ) {
 		$file = new WebRequestUpload( $this, $key );
@@ -838,8 +837,8 @@ class WebRequest {
 	/**
 	 * Return the upload error or 0
 	 *
-	 * @param $key String:
-	 * @return integer
+	 * @param string $key
+	 * @return int
 	 */
 	public function getUploadError( $key ) {
 		$file = new WebRequestUpload( $this, $key );
@@ -854,8 +853,8 @@ class WebRequest {
 	 *
 	 * Other than this the name is not verified for being a safe filename.
 	 *
-	 * @param $key String:
-	 * @return string or NULL if no such file.
+	 * @param string $key
+	 * @return string|null string or null if no such file.
 	 */
 	public function getFileName( $key ) {
 		$file = new WebRequestUpload( $this, $key );
@@ -865,7 +864,7 @@ class WebRequest {
 	/**
 	 * Return a WebRequestUpload object corresponding to the key
 	 *
-	 * @param $key string
+	 * @param string $key
 	 * @return WebRequestUpload
 	 */
 	public function getUpload( $key ) {
@@ -915,7 +914,7 @@ class WebRequest {
 	/**
 	 * Get an array containing all request headers
 	 *
-	 * @return Array mapping header name to its value
+	 * @return array Mapping header name to its value
 	 */
 	public function getAllHeaders() {
 		$this->initHeaders();
@@ -941,8 +940,8 @@ class WebRequest {
 	/**
 	 * Get data from $_SESSION
 	 *
-	 * @param string $key name of key in $_SESSION
-	 * @return Mixed
+	 * @param string $key Name of key in $_SESSION
+	 * @return mixed
 	 */
 	public function getSessionData( $key ) {
 		if ( !isset( $_SESSION[$key] ) ) {
@@ -954,8 +953,8 @@ class WebRequest {
 	/**
 	 * Set session data
 	 *
-	 * @param string $key name of key in $_SESSION
-	 * @param $data Mixed
+	 * @param string $key Name of key in $_SESSION
+	 * @param mixed $data
 	 */
 	public function setSessionData( $key, $data ) {
 		$_SESSION[$key] = $data;
@@ -967,7 +966,7 @@ class WebRequest {
 	 * message or redirect to a safer URL. Returns true if the URL is OK, and
 	 * false if an error message has been shown and the request should be aborted.
 	 *
-	 * @param $extWhitelist array
+	 * @param array $extWhitelist
 	 * @throws HttpError
 	 * @return bool
 	 */
@@ -993,7 +992,7 @@ class WebRequest {
 	 * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in
 	 * IE 6. Returns true if it was successful, false otherwise.
 	 *
-	 * @param $url string
+	 * @param string $url
 	 * @return bool
 	 */
 	protected function doSecurityRedirect( $url ) {
@@ -1077,7 +1076,7 @@ HTML;
 	 * @since 1.19
 	 *
 	 * @throws MWException
-	 * @return String
+	 * @return string
 	 */
 	protected function getRawIP() {
 		if ( !isset( $_SERVER['REMOTE_ADDR'] ) ) {
@@ -1184,7 +1183,7 @@ class WebRequestUpload {
 	/**
 	 * Constructor. Should only be called by WebRequest
 	 *
-	 * @param $request WebRequest The associated request
+	 * @param WebRequest $request The associated request
 	 * @param string $key Key in $_FILES array (name of form field)
 	 */
 	public function __construct( $request, $key ) {
@@ -1207,7 +1206,7 @@ class WebRequestUpload {
 	/**
 	 * Return the original filename of the uploaded file
 	 *
-	 * @return mixed Filename or null if non-existent
+	 * @return string|null Filename or null if non-existent
 	 */
 	public function getName() {
 		if ( !$this->exists() ) {
@@ -1241,7 +1240,7 @@ class WebRequestUpload {
 	/**
 	 * Return the path to the temporary file
 	 *
-	 * @return mixed Path or null if non-existent
+	 * @return string|null Path or null if non-existent
 	 */
 	public function getTempName() {
 		if ( !$this->exists() ) {
@@ -1299,8 +1298,8 @@ class FauxRequest extends WebRequest {
 	/**
 	 * @param array $data of *non*-urlencoded key => value pairs, the
 	 *   fake GET/POST values
-	 * @param bool $wasPosted whether to treat the data as POST
-	 * @param $session Mixed: session array or null
+	 * @param bool $wasPosted Whether to treat the data as POST
+	 * @param array|null $session Session array or null
 	 * @param string $protocol 'http' or 'https'
 	 * @throws MWException
 	 */
@@ -1318,7 +1317,7 @@ class FauxRequest extends WebRequest {
 	}
 
 	/**
-	 * @param $method string
+	 * @param string $method
 	 * @throws MWException
 	 */
 	private function notImplemented( $method ) {
@@ -1326,8 +1325,8 @@ class FauxRequest extends WebRequest {
 	}
 
 	/**
-	 * @param $name string
-	 * @param $default string
+	 * @param string $name
+	 * @param string $default
 	 * @return string
 	 */
 	public function getText( $name, $default = '' ) {
@@ -1336,7 +1335,7 @@ class FauxRequest extends WebRequest {
 	}
 
 	/**
-	 * @return Array
+	 * @return array
 	 */
 	public function getValues() {
 		return $this->data;
@@ -1390,8 +1389,8 @@ class FauxRequest extends WebRequest {
 	}
 
 	/**
-	 * @param $name string
-	 * @param $val string
+	 * @param string $name
+	 * @param string $val
 	 */
 	public function setHeader( $name, $val ) {
 		$name = strtoupper( $name );
@@ -1399,8 +1398,8 @@ class FauxRequest extends WebRequest {
 	}
 
 	/**
-	 * @param $key
-	 * @return mixed
+	 * @param string $key
+	 * @return array|null
 	 */
 	public function getSessionData( $key ) {
 		if ( isset( $this->session[$key] ) ) {
@@ -1410,15 +1409,15 @@ class FauxRequest extends WebRequest {
 	}
 
 	/**
-	 * @param $key
-	 * @param $data
+	 * @param string $key
+	 * @param array $data
 	 */
 	public function setSessionData( $key, $data ) {
 		$this->session[$key] = $data;
 	}
 
 	/**
-	 * @return array|Mixed|null
+	 * @return array|mixed|null
 	 */
 	public function getSessionArray() {
 		return $this->session;
@@ -1426,7 +1425,7 @@ class FauxRequest extends WebRequest {
 
 	/**
 	 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
-	 * @return String
+	 * @return string
 	 */
 	public function getRawQueryString() {
 		return '';
@@ -1434,7 +1433,7 @@ class FauxRequest extends WebRequest {
 
 	/**
 	 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
-	 * @return String
+	 * @return string
 	 */
 	public function getRawPostString() {
 		return '';
@@ -1442,7 +1441,7 @@ class FauxRequest extends WebRequest {
 
 	/**
 	 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
-	 * @return String
+	 * @return string
 	 */
 	public function getRawInput() {
 		return '';
diff --git a/includes/Xml.php b/includes/Xml.php
index 3b82c64551..66d9cb5135 100644
--- a/includes/Xml.php
+++ b/includes/Xml.php
@@ -30,10 +30,10 @@ class Xml {
 	 * Strings are assumed to not contain XML-illegal characters; special
 	 * characters (<, >, &) are escaped but illegals are not touched.
 	 *
-	 * @param string $element element name
+	 * @param string $element Element name
 	 * @param array $attribs Name=>value pairs. Values will be escaped.
 	 * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
-	 * @param bool $allowShortTag whether '' in $contents will result in a contentless closed tag
+	 * @param bool $allowShortTag Whether '' in $contents will result in a contentless closed tag
 	 * @return string
 	 */
 	public static function element( $element, $attribs = null, $contents = '', $allowShortTag = true ) {
@@ -58,7 +58,7 @@ class Xml {
 	 * to set the XML attributes : attributename="value".
 	 * The values are passed to Sanitizer::encodeAttribute.
 	 * Return null if no attributes given.
-	 * @param array $attribs of attributes for an XML element
+	 * @param array $attribs Array of attributes for an XML element
 	 * @throws MWException
 	 * @return null|string
 	 */
@@ -81,7 +81,7 @@ class Xml {
 	 * $wgContLang->normalize() validator first to ensure that no invalid UTF-8
 	 * is passed.
 	 *
-	 * @param $element String:
+	 * @param string $element
 	 * @param array $attribs Name=>value pairs. Values will be escaped.
 	 * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
 	 * @return string
@@ -102,8 +102,8 @@ class Xml {
 	/**
 	 * This opens an XML element
 	 *
-	 * @param string $element name of the element
-	 * @param array $attribs of attributes, see Xml::expandAttributes()
+	 * @param string $element Name of the element
+	 * @param array $attribs Array of attributes, see Xml::expandAttributes()
 	 * @return string
 	 */
 	public static function openElement( $element, $attribs = null ) {
@@ -112,7 +112,7 @@ class Xml {
 
 	/**
 	 * Shortcut to close an XML element
-	 * @param string $element element name
+	 * @param string $element Element name
 	 * @return string
 	 */
 	public static function closeElement( $element ) {
@@ -123,9 +123,9 @@ class Xml {
 	 * Same as Xml::element(), but does not escape contents. Handy when the
 	 * content you have is already valid xml.
 	 *
-	 * @param string $element element name
-	 * @param array $attribs of attributes
-	 * @param string $contents content of the element
+	 * @param string $element Element name
+	 * @param array $attribs Array of attributes
+	 * @param string $contents Content of the element
 	 * @return string
 	 */
 	public static function tags( $element, $attribs = null, $contents ) {
@@ -135,10 +135,10 @@ class Xml {
 	/**
 	 * Build a drop-down box for selecting a namespace
 	 *
-	 * @param $selected Mixed: Namespace which should be pre-selected
-	 * @param $all Mixed: Value of an item denoting all namespaces, or null to omit
-	 * @param $element_name String: value of the "name" attribute of the select tag
-	 * @param string $label optional label to add to the field
+	 * @param string $selected Namespace which should be pre-selected
+	 * @param string|null $all Value of an item denoting all namespaces, or null to omit
+	 * @param string $element_name Value of the "name" attribute of the select tag
+	 * @param string $label Optional label to add to the field
 	 * @return string
 	 * @deprecated since 1.19
 	 */
@@ -158,10 +158,10 @@ class Xml {
 	/**
 	 * Create a date selector
 	 *
-	 * @param $selected Mixed: the month which should be selected, default ''
-	 * @param string $allmonths value of a special item denoting all month. Null to not include (default)
+	 * @param string $selected The month which should be selected, default ''
+	 * @param string $allmonths Value of a special item denoting all month. Null to not include (default)
 	 * @param string $id Element identifier
-	 * @return String: Html string containing the month selector
+	 * @return string Html string containing the month selector
 	 */
 	public static function monthSelector( $selected = '', $allmonths = null, $id = 'month' ) {
 		global $wgLang;
@@ -181,8 +181,8 @@ class Xml {
 	}
 
 	/**
-	 * @param $year Integer
-	 * @param $month Integer
+	 * @param int $year
+	 * @param int $month
 	 * @return string Formatted HTML
 	 */
 	public static function dateMenu( $year, $month ) {
@@ -216,7 +216,7 @@ class Xml {
 	 * Construct a language selector appropriate for use in a form or preferences
 	 *
 	 * @param string $selected The language code of the selected language
-	 * @param boolean $customisedOnly If true only languages which have some content are listed
+	 * @param bool $customisedOnly If true only languages which have some content are listed
 	 * @param string $inLanguage The ISO code of the language to display the select list in (optional)
 	 * @param array $overrideAttrs Override the attributes of the select tag (since 1.20)
 	 * @param Message|null $msg Label message key (since 1.20)
@@ -262,9 +262,9 @@ class Xml {
 
 	/**
 	 * Shortcut to make a span element
-	 * @param string $text content of the element, will be escaped
-	 * @param string $class class name of the span element
-	 * @param array $attribs other attributes
+	 * @param string $text Content of the element, will be escaped
+	 * @param string $class Class name of the span element
+	 * @param array $attribs Other attributes
 	 * @return string
 	 */
 	public static function span( $text, $class, $attribs = array() ) {
@@ -273,10 +273,10 @@ class Xml {
 
 	/**
 	 * Shortcut to make a specific element with a class attribute
-	 * @param string $text content of the element, will be escaped
-	 * @param string $class class name of the span element
-	 * @param string $tag element name
-	 * @param array $attribs other attributes
+	 * @param string $text Content of the element, will be escaped
+	 * @param string $class Class name of the span element
+	 * @param string $tag Element name
+	 * @param array $attribs Other attributes
 	 * @return string
 	 */
 	public static function wrapClass( $text, $class, $tag = 'span', $attribs = array() ) {
@@ -285,10 +285,10 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML text input field
-	 * @param string $name value of the name attribute
-	 * @param int $size value of the size attribute
-	 * @param $value mixed value of the value attribute
-	 * @param array $attribs other attributes
+	 * @param string $name Value of the name attribute
+	 * @param int $size Value of the size attribute
+	 * @param mixed $value Value of the value attribute
+	 * @param array $attribs Other attributes
 	 * @return string HTML
 	 */
 	public static function input( $name, $size = false, $value = false, $attribs = array() ) {
@@ -307,10 +307,10 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML password input field
-	 * @param string $name value of the name attribute
-	 * @param int $size value of the size attribute
-	 * @param $value mixed value of the value attribute
-	 * @param array $attribs other attributes
+	 * @param string $name Value of the name attribute
+	 * @param int $size Value of the size attribute
+	 * @param mixed $value Value of the value attribute
+	 * @param array $attribs Other attributes
 	 * @return string HTML
 	 */
 	public static function password( $name, $size = false, $value = false, $attribs = array() ) {
@@ -320,8 +320,8 @@ class Xml {
 	/**
 	 * Internal function for use in checkboxes and radio buttons and such.
 	 *
-	 * @param $name string
-	 * @param $present bool
+	 * @param string $name
+	 * @param bool $present
 	 *
 	 * @return array
 	 */
@@ -331,9 +331,9 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML checkbox
-	 * @param string $name value of the name attribute
+	 * @param string $name Value of the name attribute
 	 * @param bool $checked Whether the checkbox is checked or not
-	 * @param array $attribs other attributes
+	 * @param array $attribs Array other attributes
 	 * @return string HTML
 	 */
 	public static function check( $name, $checked = false, $attribs = array() ) {
@@ -348,10 +348,10 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML radio button
-	 * @param string $name value of the name attribute
-	 * @param string $value value of the value attribute
+	 * @param string $name Value of the name attribute
+	 * @param string $value Value of the value attribute
 	 * @param bool $checked Whether the checkbox is checked or not
-	 * @param array $attribs other attributes
+	 * @param array $attribs Other attributes
 	 * @return string HTML
 	 */
 	public static function radio( $name, $value, $checked = false, $attribs = array() ) {
@@ -363,9 +363,9 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML form label
-	 * @param string $label text of the label
-	 * @param $id
-	 * @param array $attribs an attribute array.  This will usually be
+	 * @param string $label Text of the label
+	 * @param string $id
+	 * @param array $attribs An attribute array.  This will usually be
 	 *     the same array as is passed to the corresponding input element,
 	 *     so this function will cherry-pick appropriate attributes to
 	 *     apply to the label as well; only class and title are applied.
@@ -387,12 +387,12 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML text input field with a label
-	 * @param string $label text of the label
-	 * @param string $name value of the name attribute
-	 * @param string $id id of the input
-	 * @param int|Bool $size value of the size attribute
-	 * @param string|Bool $value value of the value attribute
-	 * @param array $attribs other attributes
+	 * @param string $label Text of the label
+	 * @param string $name Value of the name attribute
+	 * @param string $id Id of the input
+	 * @param int|bool $size Value of the size attribute
+	 * @param string|bool $value Value of the value attribute
+	 * @param array $attribs Other attributes
 	 * @return string HTML
 	 */
 	public static function inputLabel( $label, $name, $id, $size = false, $value = false, $attribs = array() ) {
@@ -403,12 +403,12 @@ class Xml {
 	/**
 	 * Same as Xml::inputLabel() but return input and label in an array
 	 *
-	 * @param $label String
-	 * @param $name String
-	 * @param $id String
-	 * @param $size Int|Bool
-	 * @param $value String|Bool
-	 * @param $attribs array
+	 * @param string $label
+	 * @param string $name
+	 * @param string $id
+	 * @param int|bool $size
+	 * @param string|bool $value
+	 * @param array $attribs
 	 *
 	 * @return array
 	 */
@@ -422,11 +422,11 @@ class Xml {
 	/**
 	 * Convenience function to build an HTML checkbox with a label
 	 *
-	 * @param $label
-	 * @param $name
-	 * @param $id
-	 * @param $checked bool
-	 * @param $attribs array
+	 * @param string $label
+	 * @param string $name
+	 * @param string $id
+	 * @param bool $checked
+	 * @param array $attribs
 	 *
 	 * @return string HTML
 	 */
@@ -439,12 +439,12 @@ class Xml {
 	/**
 	 * Convenience function to build an HTML radio button with a label
 	 *
-	 * @param $label
-	 * @param $name
-	 * @param $value
-	 * @param $id
-	 * @param $checked bool
-	 * @param $attribs array
+	 * @param string $label
+	 * @param string $name
+	 * @param string $value
+	 * @param string $id
+	 * @param bool $checked
+	 * @param array $attribs
 	 *
 	 * @return string HTML
 	 */
@@ -456,8 +456,8 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML submit button
-	 * @param string $value label text for the button
-	 * @param array $attribs optional custom attributes
+	 * @param string $value Label text for the button
+	 * @param array $attribs Optional custom attributes
 	 * @return string HTML
 	 */
 	public static function submitButton( $value, $attribs = array() ) {
@@ -466,10 +466,10 @@ class Xml {
 
 	/**
 	 * Convenience function to build an HTML drop-down list item.
-	 * @param string $text text for this item. Will be HTML escaped
-	 * @param string $value form submission value; if empty, use text
-	 * @param $selected boolean: if true, will be the default selected item
-	 * @param array $attribs optional additional HTML attributes
+	 * @param string $text Text for this item. Will be HTML escaped
+	 * @param string $value Form submission value; if empty, use text
+	 * @param bool $selected If true, will be the default selected item
+	 * @param array $attribs Optional additional HTML attributes
 	 * @return string HTML
 	 */
 	public static function option( $text, $value = null, $selected = false,
@@ -486,12 +486,12 @@ class Xml {
 	/**
 	 * Build a drop-down box from a textual list.
 	 *
-	 * @param $name Mixed: Name and id for the drop-down
-	 * @param $list Mixed: Correctly formatted text (newline delimited) to be used to generate the options
-	 * @param $other Mixed: Text for the "Other reasons" option
-	 * @param $selected Mixed: Option which should be pre-selected
-	 * @param $class Mixed: CSS classes for the drop-down
-	 * @param $tabindex Mixed: Value of the tabindex attribute
+	 * @param string $name Name and id for the drop-down
+	 * @param string $list Correctly formatted text (newline delimited) to be used to generate the options
+	 * @param string $other Text for the "Other reasons" option
+	 * @param string $selected Option which should be pre-selected
+	 * @param string $class CSS classes for the drop-down
+	 * @param int $tabindex Value of the tabindex attribute
 	 * @return string
 	 */
 	public static function listDropDown( $name = '', $list = '', $other = '', $selected = '', $class = '', $tabindex = null ) {
@@ -603,8 +603,8 @@ class Xml {
 	 * Illegal control characters are assumed not to be present.
 	 *
 	 * @deprecated since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
-	 * @param string $string to escape
-	 * @return String
+	 * @param string $string String to escape
+	 * @return string
 	 */
 	public static function escapeJsString( $string ) {
 		// See ECMA 262 section 7.8.4 for string literal format
@@ -642,7 +642,7 @@ class Xml {
 	 *
 	 * @param mixed $value The value being encoded. Can be any type except a resource.
 	 * @param bool $pretty If true, add non-significant whitespace to improve readability.
-	 * @return string|bool: String if successful; false upon failure
+	 * @return string|bool String if successful; false upon failure
 	 */
 	public static function encodeJsVar( $value, $pretty = false ) {
 		if ( $value instanceof XmlJsCode ) {
@@ -660,7 +660,7 @@ class Xml {
 	 *    which evaluates to a function object which is called.
 	 * @param array $args The arguments to pass to the function.
 	 * @param bool $pretty If true, add non-significant whitespace to improve readability.
-	 * @return string|bool: String if successful; false upon failure
+	 * @return string|bool String if successful; false upon failure
 	 */
 	public static function encodeJsCall( $name, $args, $pretty = false ) {
 		foreach ( $args as &$arg ) {
@@ -680,7 +680,7 @@ class Xml {
 	 * Check if a string is well-formed XML.
 	 * Must include the surrounding tag.
 	 *
-	 * @param string $text string to test.
+	 * @param string $text String to test.
 	 * @return bool
 	 *
 	 * @todo Error position reporting return
@@ -710,7 +710,7 @@ class Xml {
 	 * Wraps fragment in an \<html\> bit and doctype, so it can be a fragment
 	 * and can use HTML named entities.
 	 *
-	 * @param $text String:
+	 * @param string $text
 	 * @return bool
 	 */
 	public static function isWellFormedXmlFragment( $text ) {
@@ -727,7 +727,7 @@ class Xml {
 	 * Replace " > and < with their respective HTML entities ( &quot;,
 	 * &gt;, &lt;)
 	 *
-	 * @param string $in text that might contain HTML tags.
+	 * @param string $in Text that might contain HTML tags.
 	 * @return string Escaped string
 	 */
 	public static function escapeTagsOnly( $in ) {
@@ -859,22 +859,22 @@ class XmlSelect {
 	}
 
 	/**
-	 * @param $default
+	 * @param string $default
 	 */
 	public function setDefault( $default ) {
 		$this->default = $default;
 	}
 
 	/**
-	 * @param $name string
-	 * @param $value
+	 * @param string $name
+	 * @param array $value
 	 */
 	public function setAttribute( $name, $value ) {
 		$this->attributes[$name] = $value;
 	}
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @return array|null
 	 */
 	public function getAttribute( $name ) {
@@ -886,8 +886,8 @@ class XmlSelect {
 	}
 
 	/**
-	 * @param $name
-	 * @param $value bool
+	 * @param string $name
+	 * @param bool $value
 	 */
 	public function addOption( $name, $value = false ) {
 		// Stab stab stab
@@ -901,7 +901,7 @@ class XmlSelect {
 	 * label => value
 	 * label => ( label => value, label => value )
 	 *
-	 * @param $options
+	 * @param array $options
 	 */
 	public function addOptions( $options ) {
 		$this->options[] = $options;
@@ -912,7 +912,7 @@ class XmlSelect {
 	 * label => value
 	 * label => ( label => value, label => value )
 	 *
-	 * @param $options
+	 * @param array $options
 	 * @param bool $default
 	 * @return string
 	 */