wikimedia / mediawiki

includes/tidy/Balancer.php

Doc Comments +18 added lines, -3 removed lines

@@ -800,7 +800,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
 	 */
@@ -890,6 +890,7 @@ 
 
 	/**
 	 * Return the adjusted current node.
+	 * @param BalanceElement|null $fragmentContext
 	 */
 	public function adjustedCurrentNode( $fragmentContext ) {
 		return ( $fragmentContext && count( $this->elements ) === 1 ) ?
@@ -899,7 +900,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 );
@@ -1133,7 +1134,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
 	 */
@@ -1499,6 +1500,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;
@@ -1646,6 +1648,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,
@@ -2214,6 +2220,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 );
@@ -3299,6 +3309,11 @@ 
 			return false;
 		}
 	}
+
+	/**
+	 * @param string $token
+	 * @param string $value
+	 */
 	private function inCellMode( $token, $value, $attribs = null, $selfClose = false ) {
 		if ( $token === 'tag' ) {
 			switch ( $value ) {