From: Reedy <reedy@wikimedia.org>
Date: Fri, 11 May 2012 19:17:39 +0000 (+0100)
Subject: Add/update function level parameter documentation
X-Git-Tag: 1.31.0-rc.0~23611^2
X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=2df7fae3950c699a06c7731323f3750334f58ae9;p=lhc%2Fweb%2Fwiklou.git

Add/update function level parameter documentation

Change-Id: I148b84e3b81c29c63585f3bf524fc445fd7683a7
---

diff --git a/includes/parser/Preprocessor_DOM.php b/includes/parser/Preprocessor_DOM.php
index 602d88fad0..5bb951b4f1 100644
--- a/includes/parser/Preprocessor_DOM.php
+++ b/includes/parser/Preprocessor_DOM.php
@@ -56,7 +56,7 @@ class Preprocessor_DOM implements Preprocessor {
 	}
 
 	/**
-	 * @param $args
+	 * @param $args array
 	 * @return PPCustomFrame_DOM
 	 */
 	function newCustomFrame( $args ) {
diff --git a/includes/parser/Preprocessor_Hash.php b/includes/parser/Preprocessor_Hash.php
index dc2d63a3bd..32ba7070ec 100644
--- a/includes/parser/Preprocessor_Hash.php
+++ b/includes/parser/Preprocessor_Hash.php
@@ -47,7 +47,7 @@ class Preprocessor_Hash implements Preprocessor {
 	}
 
 	/**
-	 * @param $args
+	 * @param $args array
 	 * @return PPCustomFrame_Hash
 	 */
 	function newCustomFrame( $args ) {
diff --git a/includes/parser/Preprocessor_HipHop.hphp b/includes/parser/Preprocessor_HipHop.hphp
index b30b096d89..d7b07162d6 100644
--- a/includes/parser/Preprocessor_HipHop.hphp
+++ b/includes/parser/Preprocessor_HipHop.hphp
@@ -33,6 +33,9 @@ class Preprocessor_HipHop implements Preprocessor {
 
 	const CACHE_VERSION = 1;
 
+	/**
+	 * @param $parser Parser
+	 */
 	function __construct( $parser ) {
 		$this->parser = $parser;
 	}
@@ -45,7 +48,7 @@ class Preprocessor_HipHop implements Preprocessor {
 	}
 
 	/**
-	 * @param $args
+	 * @param $args array
 	 * @return PPCustomFrame_HipHop
 	 */
 	function newCustomFrame( array $args ) {
@@ -103,6 +106,7 @@ class Preprocessor_HipHop implements Preprocessor {
 	 * cache may be implemented at a later date which takes further advantage of these strict
 	 * dependency requirements.
 	 *
+	 * @throws MWException
 	 * @return PPNode_HipHop_Tree
 	 */
 	function preprocessToObj( string $text, int $flags = 0 ) {
@@ -830,16 +834,23 @@ class PPDStack_HipHop {
  * @ingroup Parser
  */
 class PPDStackElement_HipHop {
-	var $open,		        // Opening character (\n for heading)
-		$close,     	    // Matching closing character
+	var $open,              // Opening character (\n for heading)
+		$close,             // Matching closing character
 		$count,             // Number of opening characters found (number of "=" for heading)
 		$parts,             // Array of PPDPart objects describing pipe-separated parts.
 		$lineStart;         // True if the open char appeared at the start of the input line. Not set for headings.
 
+	/**
+	 * @param $obj PPDStackElement_HipHop
+	 * @return PPDStackElement_HipHop
+	 */
 	static function cast( PPDStackElement_HipHop $obj ) {
 		return $obj;
 	}
 
+	/**
+	 * @param $data array
+	 */
 	function __construct( $data = array() ) {
 		$this->parts = array( new PPDPart_HipHop );
 
@@ -848,14 +859,23 @@ class PPDStackElement_HipHop {
 		}
 	}
 
+	/**
+	 * @return PPDAccum_HipHop
+	 */
 	function getAccum() {
 		return PPDAccum_HipHop::cast( $this->parts[count($this->parts) - 1]->out );
 	}
 
+	/**
+	 * @param $s string
+	 */
 	function addPart( $s = '' ) {
 		$this->parts[] = new PPDPart_HipHop( $s );
 	}
 
+	/**
+	 * @return PPDPart_HipHop
+	 */
 	function getCurrentPart() {
 		return PPDPart_HipHop::cast( $this->parts[count($this->parts) - 1] );
 	}
@@ -876,6 +896,7 @@ class PPDStackElement_HipHop {
 	/**
 	 * Get the accumulator that would result if the close is not found.
 	 *
+	 * @param $openingCount bool
 	 * @return PPDAccum_HipHop
 	 */
 	function breakSyntax( $openingCount = false ) {
@@ -1041,9 +1062,10 @@ class PPFrame_HipHop implements PPFrame {
 	 * Create a new child frame
 	 * $args is optionally a multi-root PPNode or array containing the template arguments
 	 *
-	 * @param $args PPNode_HipHop_Array|array
-	 * @param $title Title|false
+	 * @param $args PPNode_HipHop_Array|array|bool
+	 * @param $title Title|bool
 	 *
+	 * @throws MWException
 	 * @return PPTemplateFrame_HipHop
 	 */
 	function newChild( $args = false, $title = false ) {
@@ -1293,6 +1315,7 @@ class PPFrame_HipHop implements PPFrame {
 	/**
 	 * Implode with no flags specified
 	 * This previously called implodeWithFlags but has now been inlined to reduce stack depth
+	 * @param $sep
 	 * @return string
 	 */
 	function implode( $sep /*, ... */ ) {
@@ -1323,6 +1346,7 @@ class PPFrame_HipHop implements PPFrame {
 	 * Makes an object that, when expand()ed, will be the same as one obtained
 	 * with implode()
 	 *
+	 * @param $sep
 	 * @return PPNode_HipHop_Array
 	 */
 	function virtualImplode( $sep /*, ... */ ) {
@@ -1352,6 +1376,9 @@ class PPFrame_HipHop implements PPFrame {
 	/**
 	 * Virtual implode with brackets
 	 *
+	 * @param $start
+	 * @param $sep
+	 * @param $end
 	 * @return PPNode_HipHop_Array
 	 */
 	function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1472,11 +1499,11 @@ class PPTemplateFrame_HipHop extends PPFrame_HipHop {
 	var $numberedExpansionCache, $namedExpansionCache;
 
 	/**
-	 * @param $preprocessor
-	 * @param $parent
+	 * @param $preprocessor Preprocessor_HipHop
+	 * @param $parent bool
 	 * @param $numberedArgs array
 	 * @param $namedArgs array
-	 * @param $title Title
+	 * @param $title Title|bool
 	 */
 	function __construct( $preprocessor, $parent = false, $numberedArgs = array(), $namedArgs = array(), $title = false ) {
 		parent::__construct( $preprocessor );
@@ -1723,6 +1750,10 @@ class PPNode_HipHop_Tree implements PPNode {
 		return $this->nextSibling;
 	}
 
+	/**
+	 * @param $name string
+	 * @return array
+	 */
 	function getChildrenOfType( $name ) {
 		$children = array();
 		for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
@@ -1761,6 +1792,7 @@ class PPNode_HipHop_Tree implements PPNode {
 	 *    index         String index
 	 *    value         PPNode value
 	 *
+	 * @throws MWException
 	 * @return array
 	 */
 	function splitArg() {
@@ -1794,6 +1826,7 @@ class PPNode_HipHop_Tree implements PPNode {
 	 * Split an <ext> node into an associative array containing name, attr, inner and close
 	 * All values in the resulting array are PPNodes. Inner and close are optional.
 	 *
+	 * @throws MWException
 	 * @return array
 	 */
 	function splitExt() {
@@ -1821,6 +1854,7 @@ class PPNode_HipHop_Tree implements PPNode {
 	/**
 	 * Split an <h> node
 	 *
+	 * @throws MWException
 	 * @return array
 	 */
 	function splitHeading() {