wikimedia / mediawiki

includes/WatchedItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -197,7 +197,7 @@ 
 	/**
 	 * Get the notification timestamp of this entry.
 	 *
-	 * @return bool|null|string False if the page is not watched, the value of
+	 * @return false|string False if the page is not watched, the value of
 	 *   the wl_notificationtimestamp field otherwise
 	 */
 	public function getNotificationTimestamp() {
@@ -216,7 +216,7 @@ 
 	/**
 	 * Reset the notification timestamp of this entry
 	 *
-	 * @param bool $force Whether to force the write query to be executed even if the
+	 * @param string|boolean $force Whether to force the write query to be executed even if the
 	 *    page is not watched or the notification timestamp is already NULL.
 	 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
 	 * @mode int $mode WatchedItem::DEFERRED/IMMEDIATE

includes/WebRequest.php

Doc Comments +5 added lines, -5 removed lines

@@ -223,7 +223,7 @@ 
 	 * This is for use prior to Setup.php, when no WebRequest object is available.
 	 * At other times, use the non-static function getProtocol().
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function detectProtocol() {
 		if ( ( !empty( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ) ||
@@ -381,7 +381,7 @@ 
 	 * Set an arbitrary value into our get/post data.
 	 *
 	 * @param string $key Key name to use
-	 * @param mixed $value Value to set
+	 * @param string $value Value to set
 	 * @return mixed Old value if one was present, null otherwise
 	 */
 	public function setVal( $key, $value ) {
@@ -569,7 +569,7 @@ 
 	/**
 	 * Returns the names of all input values excluding those in $exclude.
 	 *
-	 * @param array $exclude
+	 * @param string[] $exclude
 	 * @return array
 	 */
 	public function getValueNames( $exclude = array() ) {
@@ -693,7 +693,7 @@ 
 	 * @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
+	 * @return string Cookie value or $default if the cookie not set
 	 */
 	public function getCookie( $key, $prefix = null, $default = null ) {
 		if ( $prefix === null ) {
@@ -946,7 +946,7 @@ 
 	 *
 	 * @note Prefer $this->getSession() instead if making multiple calls.
 	 * @param string $key Name of key in the session
-	 * @return mixed
+	 * @return string
 	 */
 	public function getSessionData( $key ) {
 		return $this->getSession()->get( $key );

includes/WebResponse.php

Doc Comments +3 added lines, -3 removed lines

@@ -80,7 +80,7 @@ 
 	 * Set the browser cookie
 	 * @param string $name The name of the cookie.
 	 * @param string $value The value to be stored in the cookie.
-	 * @param int|null $expire Unix timestamp (in seconds) when the cookie should expire.
+	 * @param integer $expire Unix timestamp (in seconds) when the cookie should expire.
 	 *        0 (the default) causes it to expire $wgCookieExpiration seconds from now.
 	 *        null causes it to be a session cookie.
 	 * @param array $options Assoc of additional cookie options:
@@ -227,7 +227,7 @@ 
 	/**
 	 * Get the HTTP response code, null if not set
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	public function getStatusCode() {
 		return $this->code;
@@ -236,7 +236,7 @@ 
 	/**
 	 * @param string $name The name of the cookie.
 	 * @param string $value The value to be stored in the cookie.
-	 * @param int|null $expire Ignored in this faux subclass.
+	 * @param integer $expire Ignored in this faux subclass.
 	 * @param array $options Ignored in this faux subclass.
 	 */
 	public function setCookie( $name, $value, $expire = 0, $options = array() ) {

includes/widget/ComplexNamespaceInputWidget.php

Doc Comments -14 removed lines

@@ -22,20 +22,6 @@
 
 	/**
 	 * @param array $config Configuration options
-	 * @param array $config['namespace'] Configuration for the NamespaceInputWidget
-	 *  dropdown with list of namespaces
-	 * @param string $config['namespace']['includeAllValue'] If specified,
-	 *  add an "all namespaces" option to the dropdown, and use this as the input value for it
-	 * @param array|null $config['invert'] Configuration for the "invert selection"
-	 *  CheckboxInputWidget. If null, the checkbox will not be generated.
-	 * @param array|null $config['associated'] Configuration for the "include associated namespace"
-	 *  CheckboxInputWidget. If null, the checkbox will not be generated.
-	 * @param array $config['invertLabel'] Configuration for the FieldLayout with label
-	 *  wrapping the "invert selection" checkbox
-	 * @param string $config['invertLabel']['label'] Label text for the label
-	 * @param array $config['associatedLabel'] Configuration for the FieldLayout with label
-	 *  wrapping the "include associated namespace" checkbox
-	 * @param string $config['associatedLabel']['label'] Label text for the label
 	 */
 	public function __construct( array $config = array() ) {
 		// Configuration initialization

includes/widget/ComplexTitleInputWidget.php

Doc Comments -3 removed lines

@@ -19,9 +19,6 @@
 	 * Like TitleInputWidget, but the namespace has to be input through a separate dropdown field.
 	 *
 	 * @param array $config Configuration options
-	 * @param array $config['namespace'] Configuration for the NamespaceInputWidget dropdown
-	 *  with list of namespaces
-	 * @param array $config['title'] Configuration for the TitleInputWidget text field
 	 */
 	public function __construct( array $config = array() ) {
 		// Configuration initialization

includes/widget/NamespaceInputWidget.php

Doc Comments -3 removed lines

@@ -16,9 +16,6 @@
 
 	/**
 	 * @param array $config Configuration options
-	 * @param string $config['includeAllValue'] If specified, add a "all namespaces" option to the
-	 *     namespace dropdown, and use this as the input value for it
-	 * @param number[] $config['exclude'] List of namespace numbers to exclude from the selector
 	 */
 	public function __construct( array $config = array() ) {
 		// Configuration initialization

includes/widget/TitleInputWidget.php

Doc Comments -8 removed lines

@@ -20,14 +20,6 @@
 
 	/**
 	 * @param array $config Configuration options
-	 * @param int|null $config['namespace'] Namespace to prepend to queries
-	 * @param bool|null $config['relative'] If a namespace is set,
-	 *  return a title relative to it (default: true)
-	 * @param bool|null $config['suggestions'] Display search suggestions (default: true)
-	 * @param bool|null $config['highlightFirst'] Automatically highlight
-	 *  the first result (default: true)
-	 * @param bool|null $config['validateTitle'] Whether the input must
-	 *  be a valid title (default: true)
 	 */
 	public function __construct( array $config = array() ) {
 		// Parent constructor

includes/WikiMap.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,7 +109,7 @@ 
 	 *
 	 * @todo We can give more info than just the wiki id!
 	 * @param string $wikiID Wiki'd id (generally database name)
-	 * @return string|int Wiki's name or $wiki_id if the wiki was not found
+	 * @return string|null Wiki's name or $wiki_id if the wiki was not found
 	 */
 	public static function getWikiName( $wikiID ) {
 		$wiki = WikiMap::getWiki( $wikiID );
@@ -160,7 +160,7 @@ 
 	 * @param string $page Page name (must be normalised before calling this function!)
 	 * @param string|null $fragmentId
 	 *
-	 * @return string|bool URL or false if the wiki was not found
+	 * @return string|false URL or false if the wiki was not found
 	 */
 	public static function getForeignURL( $wikiID, $page, $fragmentId = null ) {
 		$wiki = WikiMap::getWiki( $wikiID );

includes/Xml.php

Doc Comments +4 added lines, -4 removed lines

@@ -199,7 +199,7 @@ 
 	 * @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)
-	 * @return array Array containing 2 items: label HTML and select list HTML
+	 * @return string[] Array containing 2 items: label HTML and select list HTML
 	 */
 	public static function languageSelector( $selected, $customisedOnly = true,
 		$inLanguage = null, $overrideAttrs = array(), Message $msg = null
@@ -373,7 +373,7 @@ 
 	 * @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 integer $size Value of the size attribute
 	 * @param string|bool $value Value of the value attribute
 	 * @param array $attribs Other attributes
 	 * @return string HTML
@@ -395,7 +395,7 @@ 
 	 * @param string|bool $value
 	 * @param array $attribs
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function inputLabelSep( $label, $name, $id, $size = false,
 		$value = false, $attribs = array()
@@ -677,7 +677,7 @@ 
 	 *    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 false|string String if successful; false upon failure
 	 */
 	public static function encodeJsCall( $name, $args, $pretty = false ) {
 		foreach ( $args as &$arg ) {