Enalean / tuleap

plugins/tests/include/simpletest/form.php

Doc Comments +1 added lines, -2 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)) {

plugins/tests/include/simpletest/frames.php

Doc Comments +4 added lines, -4 removed lines

@@ -468,7 +468,7 @@ 
     /**
      *    Finds a held form by button label. Will only
      *    search correctly built forms.
-     *    @param SimpleSelector $selector       Button finder.
+     *    @param SimpleByLabel $selector       Button finder.
      *    @return SimpleForm                    Form object containing
      *                                          the button.
      *    @access public
@@ -483,7 +483,7 @@ 
      *    Will only search correctly built forms. The first
      *    form found either within the focused frame, or
      *    across frames, will be the one returned.
-     *    @param SimpleSelector $selector  Image finder.
+     *    @param SimpleByLabel $selector  Image finder.
      *    @return SimpleForm               Form object containing
      *                                     the image.
      *    @access public
@@ -562,7 +562,7 @@ 
      *    available.
      *    @param SimpleSelector $selector    Field finder.
      *    @param string $value               Value to set field to.
-     *    @return boolean                    True if value is valid.
+     *    @return boolean|null                    True if value is valid.
      *    @access public
      */
     function setField($selector, $value) {
@@ -577,7 +577,7 @@ 
 
     /**
      *    Accessor for a form element value within a page.
-     *    @param SimpleSelector $selector    Field finder.
+     *    @param SimpleByName $selector    Field finder.
      *    @return string/boolean             A string if the field is
      *                                       present, false if unchecked
      *                                       and null if missing.

plugins/tests/include/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() {

plugins/tests/include/simpletest/mock_objects.php

Doc Comments +9 added lines, -14 removed lines

@@ -36,12 +36,6 @@ 
 
     /**
      *    Sets the expected parameter list.
-     *    @param array $parameters  Array of parameters including
-     *                              those that are wildcarded.
-     *                              If the value is not an array
-     *                              then it is considered to match any.
-     *    @param string $message    Customised message on failure.
-     *    @access public
      */
     function ParametersExpectation($expected = false, $message = '%s') {
         $this->SimpleExpectation($message);
@@ -73,7 +67,7 @@ 
      *    Tests an individual parameter.
      *    @param mixed $parameter    Value to test.
      *    @param mixed $expected     Comparison value.
-     *    @return boolean            True if expectation
+     *    @return boolean|null            True if expectation
      *                               fulfilled.
      *    @access private
      */
@@ -84,10 +78,6 @@ 
 
     /**
      *    Returns a human readable test message.
-     *    @param array $comparison   Incoming parameter list.
-     *    @return string             Description of success
-     *                               or failure.
-     *    @access public
      */
     function testMessage($parameters) {
         if ($this->test($parameters)) {
@@ -102,7 +92,7 @@ 
     /**
      *    Message to display if expectation differs from
      *    the parameters actually received.
-     *    @param array $expected      Expected parameters as list.
+     *    @param boolean $expected      Expected parameters as list.
      *    @param array $parameters    Actual parameters received.
      *    @return string              Description of difference.
      *    @access private
@@ -674,7 +664,7 @@ 
 
     /**
      *    Finds currently running test.
-     *    @return SimpeTestCase    Current test case.
+     *    @return SimpleTestCase    Current test case.
      *    @access protected
      */
     function &_getCurrentTestCase() {
@@ -686,7 +676,7 @@ 
      *    Die if bad arguments array is passed.
      *    @param mixed $args     The arguments value to be checked.
      *    @param string $task    Description of task attempt.
-     *    @return boolean        Valid arguments
+     *    @return boolean|null        Valid arguments
      *    @access private
      */
     function _checkArgumentsIsArray($args, $task) {
@@ -1362,6 +1352,11 @@ 
         return $code;
     }
 
+    /**
+     * @param string $mock_class
+     * @param string $class
+     * @param string $constructor
+     */
     private function getNamespace(&$mock_class, &$class, &$constructor) {
         $code = '';
         $last_backslash = strrpos($this->_class, '\\');

plugins/tests/include/simpletest/page.php

Doc Comments +6 added lines, -6 removed lines

@@ -169,8 +169,8 @@ 
 
     /**
      *    Creates the parser used with the builder.
-     *    @param $listener SimpleSaxListener   Target of parser.
-     *    @return SimpleSaxParser              Parser to generate
+     *    @param SimplePageBuilder $listener SimpleSaxListener   Target of parser.
+     *    @return SimpleHtmlSaxParser              Parser to generate
      *                                         events for the builder.
      *    @access protected
      */
@@ -405,7 +405,7 @@ 
 
     /**
      *    Original request as bytes sent down the wire.
-     *    @return mixed              Sent content.
+     *    @return string|false              Sent content.
      *    @access public
      */
     function getRequest() {
@@ -414,7 +414,7 @@ 
 
     /**
      *    Accessor for raw text of page.
-     *    @return string        Raw unparsed content.
+     *    @return boolean        Raw unparsed content.
      *    @access public
      */
     function getRaw() {
@@ -466,7 +466,7 @@ 
 
     /**
      *    Base URL if set via BASE tag page url otherwise
-     *    @return SimpleUrl        Base url.
+     *    @return boolean        Base url.
      *    @access public
      */
     function getBaseUrl() {
@@ -657,7 +657,7 @@ 
     /**
      *    Opens a frameset. A frameset may contain nested
      *    frameset tags.
-     *    @param SimpleFramesetTag $tag      Tag to accept.
+     *    @param SimpleTag $tag      Tag to accept.
      *    @access public
      */
     function acceptFramesetStart(&$tag) {

plugins/tests/include/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) {

plugins/tests/include/simpletest/remote.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
     /**
      *    Creates the XML parser.
      *    @param SimpleReporter $reporter    Target of test results.
-     *    @return SimpleTestXmlListener      XML reader.
+     *    @return SimpleTestXmlParser      XML reader.
      *    @access protected
      */
     function &_createParser(&$reporter) {

plugins/tests/include/simpletest/reporter.php

Doc Comments +1 added lines

@@ -351,6 +351,7 @@
      *    name was specified at the beginning, then all tests
      *    can run.
      *    @param string $method       The incoming test method.
+     * @param string $test_case
      *    @return boolean             True if matched.
      *    @access protected
      */

plugins/tests/include/simpletest/scorer.php

Doc Comments +2 added lines, -4 removed lines

@@ -287,8 +287,6 @@ 
      *    Paints the end of a group test. Will paint the page
      *    footer if the stack of tests has unwound.
      *    @param string $test_name   Name of test that is ending.
-     *    @param integer $progress   Number of test cases ending.
-     *    @access public
      */
     function paintGroupEnd($test_name) {
         array_pop($this->_test_stack);
@@ -603,7 +601,7 @@ 
      *    Chains to the wrapped reporter.
      *    @param string $type        Event type as text.
      *    @param mixed $payload      Message or object.
-     *    @return boolean            Should return false if this
+     *    @return boolean|null            Should return false if this
      *                               type of signal should fail the
      *                               test suite.
      *    @access public
@@ -849,7 +847,7 @@ 
      *    Chains to the wrapped reporter.
      *    @param string $type        Event type as text.
      *    @param mixed $payload      Message or object.
-     *    @return boolean            Should return false if this
+     *    @return boolean|null            Should return false if this
      *                               type of signal should fail the
      *                               test suite.
      *    @access public