Enalean / tuleap

plugins/tests/include/simpletest/test_case.php

Doc Comments +3 added lines, -2 removed lines

@@ -225,7 +225,7 @@ 
 
     /**
      *    Sets up an observer for the test end.
-     *    @param object $observer    Must have atTestEnd()
+     *    @param SimpleMock $observer    Must have atTestEnd()
      *                               method.
      *    @access public
      */
@@ -339,7 +339,7 @@ 
      *    Sends a formatted dump of a variable to the
      *    test suite for those emergency debugging
      *    situations.
-     *    @param mixed $variable    Variable to display.
+     *    @param string|boolean $variable    Variable to display.
      *    @param string $message    Message to display.
      *    @return mixed             The original variable.
      *    @access public
@@ -552,6 +552,7 @@ 
 
     /**
      *    @deprecated
+     * @param string $test_file
      */
     function addTestFile($test_file) {
         $this->addFile($test_file);

plugins/tests/include/simpletest/unit_tester.php

Doc Comments +11 added lines, -7 removed lines

@@ -162,9 +162,9 @@ 
     /**
      *    Will trigger a pass if the if the first parameter
      *    is near enough to the second by the margin.
-     *    @param mixed $first          Value to compare.
-     *    @param mixed $second         Value to compare.
-     *    @param mixed $margin         Fuzziness of match.
+     *    @param integer $first          Value to compare.
+     *    @param double $second         Value to compare.
+     *    @param double $margin         Fuzziness of match.
      *    @param string $message       Message to display.
      *    @return boolean              True on pass
      *    @access public
@@ -179,9 +179,9 @@ 
     /**
      *    Will trigger a pass if the two parameters differ
      *    by more than the margin.
-     *    @param mixed $first          Value to compare.
-     *    @param mixed $second         Value to compare.
-     *    @param mixed $margin         Fuzziness of match.
+     *    @param integer $first          Value to compare.
+     *    @param double $second         Value to compare.
+     *    @param double $margin         Fuzziness of match.
      *    @param string $message       Message to display.
      *    @return boolean              True on pass
      *    @access public
@@ -304,6 +304,8 @@ 
 
     /**
      *    @deprecated
+     * @param string $pattern
+     * @param string $subject
      */
     function assertWantedPattern($pattern, $subject, $message = '%s') {
         return $this->assertPattern($pattern, $subject, $message);
@@ -328,6 +330,7 @@ 
 
     /**
      *    @deprecated
+     * @param string $pattern
      */
     function assertNoUnwantedPattern($pattern, $subject, $message = '%s') {
         return $this->assertNoPattern($pattern, $subject, $message);
@@ -395,7 +398,7 @@ 
      *    Creates an equality expectation if the
      *    object/value is not already some type
      *    of expectation.
-     *    @param mixed $expected      Expected value.
+     *    @param boolean $expected      Expected value.
      *    @return SimpleExpectation   Expectation object.
      *    @access private
      */
@@ -412,6 +415,7 @@ 
 
     /**
      *    @deprecated
+     * @param string $pattern
      */
     function assertErrorPattern($pattern, $message = '%s') {
         return $this->assertError(new PatternExpectation($pattern), $message);

plugins/tests/include/simpletest/url.php

Doc Comments +3 added lines, -2 removed lines

@@ -178,7 +178,7 @@ 
     /**
      *    Breaks the request down into an object.
      *    @param string $raw           Raw request.
-     *    @return SimpleFormEncoding    Parsed data.
+     *    @return SimpleGetEncoding    Parsed data.
      *    @access private
      */
     function _parseRequest($raw) {
@@ -266,7 +266,7 @@ 
     /**
      *    Accessor for page if any. This may be a
      *    directory name if ambiguious.
-     *    @return            Page name.
+     *    @return            false|string name.
      *    @access public
      */
     function getPage() {
@@ -466,6 +466,7 @@ 
      *    @param string/SimpleUrl $base       Base URL.
      *    @param string                       Absolute path.
      *    @access private
+     * @return string
      */
     function _extractAbsolutePath($base) {
         if ($this->getHost()) {

plugins/tests/include/simpletest/user_agent.php

Doc Comments +1 added lines, -4 removed lines

@@ -232,7 +232,7 @@ 
      *    Fetches the page until no longer redirected or
      *    until the redirect limit runs out.
      *    @param SimpleUrl $url                  Target to fetch.
-     *    @param SimpelFormEncoding $encoding    Additional parameters for request.
+     *    @param SimpleEncoding $encoding    Additional parameters for request.
      *    @return SimpleHttpResponse             Hopefully the target page.
      *    @access private
      */
@@ -290,9 +290,6 @@ 
     /**
      *    Builds the appropriate HTTP request object.
      *    @param SimpleUrl $url                  Target to fetch as url object.
-     *    @param SimpleFormEncoding $parameters  POST/GET parameters.
-     *    @return SimpleHttpRequest              New request object.
-     *    @access protected
      */
     function &_createHttpRequest($url, $encoding) {
         $request = &new SimpleHttpRequest($this->_createRoute($url), $encoding);

plugins/tests/include/simpletest/web_tester.php

Doc Comments +27 added lines, -34 removed lines

@@ -174,7 +174,7 @@ 
     /**
      *    Tests the expectation. True if it matches
      *    a string value or an array value in any order.
-     *    @param mixed $compare   Raw header block to search.
+     *    @param false|string $compare   Raw header block to search.
      *    @return boolean         True if header present.
      *    @access public
      */
@@ -277,7 +277,7 @@ 
     
     /**
      *    Tests that the unwanted header is not found.
-     *    @param mixed $compare   Raw header block to search.
+     *    @param string $compare   Raw header block to search.
      *    @return boolean         True if header present.
      *    @access public
      */
@@ -499,7 +499,7 @@ 
     /**
      *    Creates a new default web browser object.
      *    Will be cleared at the end of the test method.
-     *    @return TestBrowser           New browser.
+     *    @return SimpleBrowser           New browser.
      *    @access public
      */
     function &createBrowser() {
@@ -617,7 +617,7 @@ 
      *    Issues a fail if there is a transport error anywhere
      *    in the current frameset. Only one such error is
      *    reported.
-     *    @param string/boolean $result   HTML or failure.
+     *    @param boolean $result   HTML or failure.
      *    @return string/boolean $result  Passes through result.
      *    @access private
      */
@@ -685,7 +685,7 @@ 
      *    the base URL reflects the new location.
      *    @param string $url          URL to fetch.
      *    @param hash $parameters     Optional additional GET data.
-     *    @return boolean/string      Raw page on success.
+     *    @return boolean      Raw page on success.
      *    @access public
      */
     function get($url, $parameters = false) {
@@ -699,7 +699,7 @@ 
      *    the base URL reflects the new location.
      *    @param string $url          URL to fetch.
      *    @param hash $parameters     Optional additional GET data.
-     *    @return boolean/string      Raw page on success.
+     *    @return boolean      Raw page on success.
      *    @access public
      */
     function post($url, $parameters = false) {
@@ -858,7 +858,7 @@ 
      *    @param string $label    Button label. An unlabeled
      *                            button can be triggered by 'Submit'.
      *    @param hash $additional Additional form values.
-     *    @return boolean/string  Page on success, else false.
+     *    @return boolean  Page on success, else false.
      *    @access public
      */
     function clickSubmit($label = 'Submit', $additional = false) {
@@ -871,7 +871,7 @@ 
      *    form will be submitted by this.
      *    @param string $name     Name attribute of button.
      *    @param hash $additional Additional form values.
-     *    @return boolean/string  Page on success.
+     *    @return boolean  Page on success.
      *    @access public
      */
     function clickSubmitByName($name, $additional = false) {
@@ -884,7 +884,7 @@ 
      *    form will be submitted by this.
      *    @param string $id       ID attribute of button.
      *    @param hash $additional Additional form values.
-     *    @return boolean/string  Page on success.
+     *    @return boolean  Page on success.
      *    @access public
      */
     function clickSubmitById($id, $additional = false) {
@@ -914,7 +914,7 @@ 
      *    @param integer $x       X-coordinate of imaginary click.
      *    @param integer $y       Y-coordinate of imaginary click.
      *    @param hash $additional Additional form values.
-     *    @return boolean/string  Page on success.
+     *    @return boolean  Page on success.
      *    @access public
      */
     function clickImage($label, $x = 1, $y = 1, $additional = false) {
@@ -932,7 +932,7 @@ 
      *    @param integer $x       X-coordinate of imaginary click.
      *    @param integer $y       Y-coordinate of imaginary click.
      *    @param hash $additional Additional form values.
-     *    @return boolean/string  Page on success.
+     *    @return boolean  Page on success.
      *    @access public
      */
     function clickImageByName($name, $x = 1, $y = 1, $additional = false) {
@@ -945,11 +945,11 @@ 
      *    form will be submitted by this. Clicking outside of
      *    the boundary of the coordinates will result in
      *    a failure.
-     *    @param integer/string $id   ID attribute of button.
+     *    @param integer $id   ID attribute of button.
      *    @param integer $x           X-coordinate of imaginary click.
      *    @param integer $y           Y-coordinate of imaginary click.
      *    @param hash $additional     Additional form values.
-     *    @return boolean/string      Page on success.
+     *    @return boolean      Page on success.
      *    @access public
      */
     function clickImageById($id, $x = 1, $y = 1, $additional = false) {
@@ -987,7 +987,7 @@ 
      *    with normalised space.
      *    @param string $label     Text between the anchor tags.
      *    @param integer $index    Link position counting from zero.
-     *    @return boolean/string   Page on success.
+     *    @return boolean   Page on success.
      *    @access public
      */
     function clickLink($label, $index = 0) {
@@ -997,7 +997,7 @@ 
     /**
      *    Follows a link by id attribute.
      *    @param string $id        ID attribute value.
-     *    @return boolean/string   Page on success.
+     *    @return boolean   Page on success.
      *    @access public
      */
     function clickLinkById($id) {
@@ -1028,7 +1028,7 @@ 
     /**
      *    Tests for the non-presence of a link label. Match is
      *    case insensitive with normalised space.
-     *    @param string/integer $label    Text between the anchor tags
+     *    @param string $label    Text between the anchor tags
      *                                    or ID attribute.
      *    @param string $message          Message to display. Default
      *                                    can be embedded with %s.
@@ -1079,10 +1079,7 @@ 
     /**
      *    Sets all form fields with that label, or name if there
      *    is no label attached.
-     *    @param string $name    Name of field in forms.
-     *    @param string $value   New value of field.
-     *    @return boolean        True if field exists, otherwise false.
-     *    @access public
+     * @param string $label
      */
     function setField($label, $value, $position=false) {
         return $this->_browser->setField($label, $value, $position);
@@ -1101,7 +1098,7 @@ 
         
     /**
      *    Sets all form fields with that id.
-     *    @param string/integer $id   Id of field in forms.
+     *    @param integer $id   Id of field in forms.
      *    @param string $value        New value of field.
      *    @return boolean             True if field exists, otherwise false.
      *    @access public
@@ -1115,13 +1112,7 @@ 
      *    to the expected value. A missing form will always
      *    fail. If no value is given then only the existence
      *    of the field is checked.
-     *    @param string $name       Name of field in forms.
-     *    @param mixed $expected    Expected string/array value or
-     *                              false for unset fields.
-     *    @param string $message    Message to display. Default
-     *                              can be embedded with %s.
-     *    @return boolean           True if pass.
-     *    @access public
+     * @param string $label
      */
     function assertField($label, $expected = true, $message = '%s') {
         $value = $this->_browser->getField($label);
@@ -1191,7 +1182,7 @@ 
     /**
      *    Checks the response code against a list
      *    of possible values.
-     *    @param array $responses    Possible responses for a pass.
+     *    @param integer $responses    Possible responses for a pass.
      *    @param string $message     Message to display. Default
      *                               can be embedded with %s.
      *    @return boolean            True if pass.
@@ -1208,7 +1199,7 @@ 
     /**
      *    Checks the mime type against a list
      *    of possible values.
-     *    @param array $types      Possible mime types for a pass.
+     *    @param string $types      Possible mime types for a pass.
      *    @param string $message   Message to display.
      *    @return boolean          True if pass.
      *    @access public
@@ -1294,6 +1285,8 @@ 
         
     /**
      *    @deprecated
+     * @param string $header
+     * @param string $pattern
      */
     function assertHeaderPattern($header, $pattern, $message = '%s') {
         return $this->assert(
@@ -1497,8 +1490,8 @@ 
      *    Will trigger a pass if the two parameters have
      *    the same value only. Otherwise a fail. This
      *    is for testing hand extracted text, etc.
-     *    @param mixed $first          Value to compare.
-     *    @param mixed $second         Value to compare.
+     *    @param string|false $first          Value to compare.
+     *    @param string $second         Value to compare.
      *    @param string $message       Message to display.
      *    @return boolean              True on pass
      *    @access public
@@ -1514,8 +1507,8 @@ 
      *    Will trigger a pass if the two parameters have
      *    a different value. Otherwise a fail. This
      *    is for testing hand extracted text, etc.
-     *    @param mixed $first           Value to compare.
-     *    @param mixed $second          Value to compare.
+     *    @param string $first           Value to compare.
+     *    @param string $second          Value to compare.
      *    @param string $message        Message to display.
      *    @return boolean               True on pass
      *    @access public

plugins/tests/include/simpletest/xml.php

Doc Comments -2 removed lines

@@ -132,8 +132,6 @@
     /**
      *    Paints the end of a test method.
      *    @param string $test_name   Name of test that is ending.
-     *    @param integer $progress   Number of test cases ending.
-     *    @access public
      */
     function paintMethodEnd($test_name) {
         print $this->_getIndent();

plugins/tests/include/TestsPluginFilterIterator.class.php

Doc Comments +6 added lines

@@ -27,10 +27,16 @@
         return (strpos($file->getPathname(), '/_') === false && preg_match($this->pattern, $file->getFilename()));
     }
     
+    /**
+     * @param string $pattern
+     */
     public function setPattern($pattern) {
         $this->pattern = $pattern;
     }
     
+    /**
+     * @param string $path
+     */
     public static function apply($path, $pattern = '@Test.php$@') {        
         $RecursiveIt    =  new RecursiveCachingIterator(new RecursiveDirectoryIterator($path));
         $RecursiveIt    = new RecursiveIteratorIterator($RecursiveIt, RecursiveIteratorIterator::SELF_FIRST);

plugins/tests/include/testsPluginInfo.class.php

Doc Comments +3 added lines

@@ -13,6 +13,9 @@
 
 class testsPluginInfo extends PluginInfo {
     
+    /**
+     * @param testsPlugin $plugin
+     */
     function testsPluginInfo(&$plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new testsPluginDescriptor());

plugins/tests/include/TestsPluginOrderedSuite.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
     
     protected $testPaths = array();
     
+    /**
+     * @param string $order
+     */
     public function runByOrder(&$reporter, $order) {
         $this->addTestFiles();
         if ($order === 'invert') {