Cleanup api generated example docblocks

[civicrm-core.git] / tests / phpunit / HelloTest.php

diff --git a/tests/phpunit/HelloTest.php b/tests/phpunit/HelloTest.php
index 03f40a67adff5819f025901c115b02ea0ea8403a..30746e342dddd453984f1835f1b158fe0ac9f930 100644 (file)
--- a/tests/phpunit/HelloTest.php
+++ b/tests/phpunit/HelloTest.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * @file HelloTest.php
@@ -47,34 +47,40 @@ class HelloTest extends PHPUnit_Framework_TestCase {
   var $abc;
 
   /**
-   * @param null $name
+   * @param string|null $name
    */
   public function __construct($name = NULL) {
     parent::__construct($name);
   }
 
-  // called before the test functions will be executed
-  // this function is defined in PHPUnit_TestCase and overwritten
-  // here
+  /**
+   * Called before the test functions will be executed.
+   * this function is defined in PHPUnit_TestCase and overwritten
+   * here
+   */
   public function setUp() {
     // create a new instance of String with the
     // string 'abc'
     $this->abc = "hello";
   }
 
-  // called after the test functions are executed
-  // this function is defined in PHPUnit_TestCase and overwritten
-  // here
+  /**
+   * Called after the test functions are executed.
+   * this function is defined in PHPUnit_TestCase and overwritten
+   * here.
+   */
   public function tearDown() {
     // delete your instance
     unset($this->abc);
   }
 
-  // test the toString function
+  /**
+   * test the toString function.
+   */
   public function testHello() {
     $result = $this->abc;
     $expected = 'hello';
     $this->assertEquals($result, $expected);
   }
-}
 
+}