wikimedia / mediawiki

includes/Sanitizer.php

Doc Comments +4 added lines, -4 removed lines

@@ -1206,7 +1206,7 @@ 
 	 * @since 1.27
 	 *
 	 * @param string $referenceString Space delimited list of ids
-	 * @param string|array $options String or array of strings (default is array()):
+	 * @param string $options String or array of strings (default is array()):
 	 *   'noninitial': This is a non-initial fragment of an id, not a full id,
 	 *       so don't pay attention if the first character isn't valid at the
 	 *       beginning of an id.  Only matters if $wgExperimentalHtmlIds is
@@ -1334,7 +1334,7 @@ 
 	 * Pick the appropriate attribute value from a match set from the
 	 * attribs regex matches.
 	 *
-	 * @param array $set
+	 * @param string[] $set
 	 * @throws MWException When tag conditions are not met.
 	 * @return string
 	 */
@@ -1850,7 +1850,7 @@ 
 
 	/**
 	 * @param string $url
-	 * @return mixed|string
+	 * @return string
 	 */
 	static function cleanUrl( $url ) {
 		# Normalize any HTML entities in input. They will be
@@ -1936,7 +1936,7 @@ 
 	 * @since 1.18
 	 *
 	 * @param string $addr E-mail address
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public static function validateEmail( $addr ) {
 		$result = null;

includes/tidy/Balancer.php

Doc Comments +18 added lines, -3 removed lines

@@ -751,7 +751,7 @@ 
 
 	/**
 	 * Determine if the stack has $tag in button scope.
-	 * @param BalanceElement|array|string $tag
+	 * @param string $tag
 	 * @return bool
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#has-an-element-in-button-scope
 	 */
@@ -831,6 +831,7 @@ 
 
 	/**
 	 * Return the adjusted current node.
+	 * @param BalanceElement|null $fragmentContext
 	 */
 	public function adjustedCurrentNode( $fragmentContext ) {
 		return ( $fragmentContext && $this->length() === 1 ) ?
@@ -840,7 +841,7 @@ 
 	/**
 	 * Return an iterator over this stack which visits the current node
 	 * first, and the root node last.
-	 * @return Iterator
+	 * @return ReverseArrayIterator
 	 */
 	public function getIterator() {
 		return new ReverseArrayIterator( $this->elements );
@@ -1063,7 +1064,7 @@ 
 	 * @param string $tag The subject tag name.
 	 * @param BalanceActiveFormattingElements $afe The current
 	 *   active formatting elements list.
-	 * @return true if the adoption agency algorithm "did something", false
+	 * @return boolean if the adoption agency algorithm "did something", false
 	 *   if more processing is required by the caller.
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#adoption-agency-algorithm
 	 */
@@ -1441,6 +1442,7 @@ 
 	 * Find and return the last element with the specified tag between the
 	 * end of the list and the last marker on the list.
 	 * Used when parsing <a> "in body mode".
+	 * @param string $tag
 	 */
 	public function findElementByTag( $tag ) {
 		$elt = $this->tail;
@@ -1588,6 +1590,10 @@ 
 	 * @see https://html.spec.whatwg.org/multipage/syntax.html#reconstruct-the-active-formatting-elements
 	 */
 	// @codingStandardsIgnoreEnd
+
+	/**
+	 * @param BalanceStack|null $stack
+	 */
 	public function reconstruct( $stack ) {
 		$entry = $this->tail;
 		// If there are no entries in the list of active formatting elements,
@@ -2051,6 +2057,10 @@ 
 		return $oldMode;
 	}
 
+	/**
+	 * @param string $mode
+	 * @param boolean $selfclose
+	 */
 	private function switchModeAndReprocess( $mode, $token, $value, $attribs, $selfclose ) {
 		$this->switchMode( $mode );
 		return $this->insertToken( $token, $value, $attribs, $selfclose );
@@ -3080,6 +3090,11 @@ 
 			return false;
 		}
 	}
+
+	/**
+	 * @param string $token
+	 * @param string $value
+	 */
 	private function inCellMode( $token, $value, $attribs = null, $selfclose = false ) {
 		if ( $token === 'tag' ) {
 			switch ( $value ) {