silverstripe / silverstripe-framework

thirdparty/php-peg/Compiler.php

Doc Comments +43 added lines

@@ -48,6 +48,9 @@ 
 		return $str ;
 	}
 
+	/**
+	 * @param string $id
+	 */
 	function save($id) {
 		return PHPBuilder::build()
 			->l(
@@ -56,6 +59,9 @@ 
 			);
 	}
 
+	/**
+	 * @param string $id
+	 */
 	function restore( $id, $remove = FALSE ) {
 		$code = PHPBuilder::build()
 			->l(
@@ -71,6 +77,10 @@ 
 		return $code ;
 	}
 
+	/**
+	 * @param string $on
+	 * @param PHPBuilder $fail
+	 */
 	function match_fail_conditional( $on, $match = NULL, $fail = NULL ) {
 		return PHPBuilder::build()
 			->b( 'if (' . $on . ')',
@@ -83,6 +93,9 @@ 
 			);
 	}
 	
+	/**
+	 * @param PHPBuilder $code
+	 */
 	function match_fail_block( $code ) {
 		$id = $this->varid() ;
 
@@ -131,6 +144,9 @@ 
 	public $type ;
 	public $value ;
 
+	/**
+	 * @param string $type
+	 */
 	function __construct( $type, $value = NULL ) {
 		$this->type = $type ;
 		$this->value = $value ;
@@ -269,6 +285,10 @@ 
 }
 
 class TokenLiteral extends TokenExpressionable {
+
+	/**
+	 * @param string $value
+	 */
 	function __construct( $value ) {
 		parent::__construct( 'literal', "'" . substr($value,1,-1) . "'" );
 	}
@@ -294,6 +314,9 @@ 
 		return $rx ;
 	}
 	
+	/**
+	 * @param string $value
+	 */
 	function __construct( $value ) {
 		parent::__construct('rx', self::escape($value));
 	}
@@ -304,6 +327,10 @@ 
 }
 
 class TokenWhitespace extends TokenTerminal {
+
+	/**
+	 * @param boolean $optional
+	 */
 	function __construct( $optional ) {
 		parent::__construct( 'whitespace', $optional ) ;
 	}
@@ -316,6 +343,10 @@ 
 }
 
 class TokenRecurse extends Token {
+
+	/**
+	 * @param string $value
+	 */
 	function __construct( $value ) {
 		parent::__construct( 'recurse', $value ) ;
 	}
@@ -438,6 +469,9 @@ 
 		$this->what = NULL ;
 	}
 
+	/**
+	 * @param string $what
+	 */
 	function set( $what, $val = TRUE ) {
 		$this->what = $what ;
 		$this->val = $val ;
@@ -498,6 +532,9 @@ 
 	public $mode;
 	public $rule;
 	
+	/**
+	 * @param RuleSet $parser
+	 */
 	function __construct($parser, $lines) {
 		$this->parser = $parser;
 		$this->lines = $lines;
@@ -595,6 +632,9 @@ 
 		[^/]               # Anything except /
 	)*/}xu' ;
 
+	/**
+	 * @param string $str
+	 */
 	function tokenize( $str, &$tokens, $o = 0 ) {
 
 		$pending = new Pending() ;
@@ -848,6 +888,9 @@ 
 		return self::$parsers[$class]->compile($indent, $match[3]);
 	}
 
+	/**
+	 * @param string $string
+	 */
 	static function compile( $string ) {
 		static $rx = '@
 			^([\x20\t]*)/\*!\* (?:[\x20\t]*(!?\w*))?   # Start with some indent, a comment with the special marker, then an optional name

thirdparty/php-peg/Parser.php

Doc Comments +25 added lines

@@ -9,6 +9,10 @@ 
  *  the bracket if a failed match + restore has moved the current position backwards - so we have to check that too.
  */
 class ParserRegexp {
+
+	/**
+	 * @param Parser $parser
+	 */
 	function __construct( $parser, $rx ) {
 		$this->parser = $parser ;
 		$this->rx = $rx . 'Sx' ;
@@ -63,6 +67,9 @@ 
 		return FALSE ;
 	}
 
+ 	/**
+ 	 * @param string $token
+ 	 */
  	function literal( $token ) {
  		/* Debugging: * / print( "Looking for token '$token' @ '" . substr( $this->string, $this->pos ) . "'\n" ) ; /* */
  		$toklen = strlen( $token ) ;
@@ -74,11 +81,17 @@ 
 		return FALSE ;
 	}
 
+	/**
+	 * @param string $rx
+	 */
 	function rx( $rx ) {
 		if ( !isset( $this->regexps[$rx] ) ) $this->regexps[$rx] = new ParserRegexp( $this, $rx ) ;
 		return $this->regexps[$rx]->match() ;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function expression( $result, $stack, $value ) {
 		$stack[] = $result; $rv = false;
 		
@@ -100,14 +113,23 @@ 
 		return is_array($rv) ? $rv['text'] : ($rv ? $rv : '');
 	}
 	
+	/**
+	 * @param string $key
+	 */
 	function packhas( $key, $pos ) {
 		return false ;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	function packread( $key, $pos ) {
 		throw 'PackRead after PackHas=>false in Parser.php' ;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	function packwrite( $key, $pos, $res ) {
 		return $res ;
 	}
@@ -144,6 +166,9 @@ 
 		return $result ;
 	}
 
+	/**
+	 * @param string $storetag
+	 */
 	function store ( &$result, $subres, $storetag = NULL ) {
 		$result['text'] .= $subres['text'] ;
 

thirdparty/simpletest/compatibility.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
     
     /**
      *    Creates a copy whether in PHP5 or PHP4.
-     *    @param object $object     Thing to copy.
+     *    @param SimpleFormTag $object     Thing to copy.
      *    @return object            A copy.
      *    @access public
      *    @static

thirdparty/simpletest/cookies.php

Doc Comments -2 removed lines

@@ -239,8 +239,6 @@
     /**
      *    Removes expired and temporary cookies as if
      *    the browser was closed and re-opened.
-     *    @param string/integer $now   Time to test expiry against.
-     *    @access public
      */
     function restartSession($date = false) {
         $surviving_cookies = array();

thirdparty/simpletest/encoding.php

Doc Comments +1 added lines, -1 removed lines

@@ -248,7 +248,7 @@
      *    form encoded packet.
      *    @param string $key          Key to add value to.
      *    @param string $content      Raw data.
-     *    @param hash $filename       Original filename.
+     *    @param string $filename       Original filename.
      *    @access public
      */
     function attach($key, $content, $filename) {

thirdparty/simpletest/form.php

Doc Comments +3 added lines, -4 removed lines

@@ -87,8 +87,7 @@ 
      *    Combined action attribute with current location
      *    to get an absolute form target.
      *    @param string $action    Action attribute from form tag.
-     *    @param SimpleUrl $base   Page location.
-     *    @return SimpleUrl        Absolute form target.
+     * @param SimplePage $page
      */
     function _createAction($action, &$page) {
         if (($action === '') || ($action === false)) {
@@ -221,7 +220,7 @@ 
     
     /**
      *    Sets a widget value within the form.
-     *    @param SimpleSelector $selector   Criteria to apply.
+     *    @param SimpleByName $selector   Criteria to apply.
      *    @param string $value              Value to input into the widget.
      *    @return boolean                   True if value is legal, false
      *                                      otherwise. If the field is not
@@ -293,7 +292,7 @@ 
     
     /**
      *    Gets the submit values for a selected button.
-     *    @param SimpleSelector $selector   Criteria to apply.
+     *    @param SimpleByName $selector   Criteria to apply.
      *    @param hash $additional           Additional data for the form.
      *    @return SimpleEncoding            Submitted values or false
      *                                      if there is no such button

thirdparty/simpletest/http.php

Doc Comments +3 added lines, -13 removed lines

@@ -135,9 +135,6 @@ 
     /**
      *    Creates the first line which is the actual request.
      *    @param string $method   HTTP request method, usually GET.
-     *    @param SimpleUrl $url   URL as object.
-     *    @return string          Request line content.
-     *    @access protected
      */
     function _getRequestLine($method) {
         $url = $this->getUrl();
@@ -149,9 +146,6 @@ 
     
     /**
      *    Creates the host part of the request.
-     *    @param SimpleUrl $url   URL as object.
-     *    @return string          Host line content.
-     *    @access protected
      */
     function _getHostLine() {
         $host = 'Host: ' . $this->_proxy->getHost();
@@ -235,10 +229,6 @@ 
     /**
      *    Sends the headers.
      *    @param SimpleSocket $socket           Open socket.
-     *    @param string $method                 HTTP request method,
-     *                                          usually GET.
-     *    @param SimpleFormEncoding $encoding   Content to send with request.
-     *    @access private
      */
     function _dispatchRequest(&$socket, $encoding) {
         foreach ($this->_headers as $header_line) {
@@ -323,7 +313,7 @@ 
     
     /**
      *    Accessor for parsed HTTP protocol version.
-     *    @return integer           HTTP error code.
+     *    @return false|string           HTTP error code.
      *    @access public
      */
     function getHttpVersion() {
@@ -565,7 +555,7 @@ 
     /**
      *    Accessor for the content after the last
      *    header line.
-     *    @return string           All content.
+     *    @return boolean           All content.
      *    @access public
      */
     function getContent() {
@@ -575,7 +565,7 @@ 
     /**
      *    Accessor for header block. The response is the
      *    combination of this and the content.
-     *    @return SimpleHeaders        Wrapped header block.
+     *    @return SimpleHttpHeaders        Wrapped header block.
      *    @access public
      */
     function getHeaders() {

thirdparty/simpletest/parser.php

Doc Comments +9 added lines, -11 removed lines

@@ -90,8 +90,6 @@ 
      *    regular expression separated with the
      *    "or" operator. Caches the regex.
      *    Will automatically escape (, ) and / tokens.
-     *    @param array $patterns    List of patterns in order.
-     *    @access private
      */
     function _getCompoundedRegex() {
         if ($this->_regex == null) {
@@ -468,7 +466,7 @@ 
     
     /**
      *    List of parsed tags. Others are ignored.
-     *    @return array        List of searched for tags.
+     *    @return string[]        List of searched for tags.
      *    @access private
      */
     function _getParsedTags() {
@@ -573,7 +571,7 @@ 
     
     /**
      *    Sets up the matching lexer. Starts in 'text' mode.
-     *    @param SimpleSaxParser $parser    Event generator, usually $self.
+     *    @param SimpleHtmlSaxParser $parser    Event generator, usually $self.
      *    @return SimpleLexer               Lexer suitable for this parser.
      *    @access public
      *    @static
@@ -591,7 +589,7 @@ 
      *    name is converted to lower case.
      *    @param string $token     Incoming characters.
      *    @param integer $event    Lexer event type.
-     *    @return boolean          False if parse error.
+     *    @return boolean|null          False if parse error.
      *    @access public
      */
     function acceptStartToken($token, $event) {
@@ -619,7 +617,7 @@ 
      *    The element name is converted to lower case.
      *    @param string $token     Incoming characters.
      *    @param integer $event    Lexer event type.
-     *    @return boolean          False if parse error.
+     *    @return boolean|null          False if parse error.
      *    @access public
      */
     function acceptEndToken($token, $event) {
@@ -654,7 +652,7 @@ 
      *    A character entity.
      *    @param string $token    Incoming characters.
      *    @param integer $event   Lexer event type.
-     *    @return boolean         False if parse error.
+     *    @return boolean|null         False if parse error.
      *    @access public
      */
     function acceptEntityToken($token, $event) {
@@ -665,7 +663,7 @@ 
      *    important.
      *    @param string $token     Incoming characters.
      *    @param integer $event    Lexer event type.
-     *    @return boolean          False if parse error.
+     *    @return boolean|null          False if parse error.
      *    @access public
      */
     function acceptTextToken($token, $event) {
@@ -737,7 +735,7 @@ 
      *    @param hash $attributes    Name value pairs.
      *                               Attributes without content
      *                               are marked as true.
-     *    @return boolean            False on parse error.
+     *    @return boolean|null            False on parse error.
      *    @access public
      */
     function startElement($name, $attributes) {
@@ -746,7 +744,7 @@ 
     /**
      *    End of element event.
      *    @param string $name        Element name.
-     *    @return boolean            False on parse error.
+     *    @return boolean|null            False on parse error.
      *    @access public
      */
     function endElement($name) {
@@ -755,7 +753,7 @@ 
     /**
      *    Unparsed, but relevant data.
      *    @param string $text        May include unparsed tags.
-     *    @return boolean            False on parse error.
+     *    @return boolean|null            False on parse error.
      *    @access public
      */
     function addContent($text) {

thirdparty/simpletest/tag.php

Doc Comments +2 added lines

@@ -112,6 +112,7 @@ 
     /**
      *    Sets an attribute.
      *    @param string $label    Attribute name.
+     * @param string $value
      *    @return string $value   New attribute value.
      *    @access protected
      */
@@ -1300,6 +1301,7 @@ 
     /**
      *    Tests to see if a value is allowed.
      *    @param string    Attempted value.
+     * @param string $value
      *    @return boolean  True if a valid value.
      *    @access private
      */