Adding documentation to the unit test skeleton file.

git-svn-id: http://code.elgg.org/elgg/trunk@3706 36083f99-b078-4883-b0ff-0f9b5a30f544

diff --git a/engine/tests/test_skeleton.php b/engine/tests/test_skeleton.php
index 165ab087227676f64107511d6209b6d64b224906..474cffce0f76375ead446e907866143251362772 100644 (file)
--- a/engine/tests/test_skeleton.php
+++ b/engine/tests/test_skeleton.php
@@ -2,6 +2,16 @@
 /**
  * Elgg Test Skeleton
  *
+ * Plugin authors: copy this file to your plugin's test directory. Register an Elgg
+ * plugin hook and function similar to:
+ *
+ * register_plugin_hook('unit_test', 'system', 'my_new_unit_test');
+ *
+ * function my_new_unit_test($hook, $type, $value, $params) {
+ *   $value[] = "path/to/my/unit_test.php";
+ *   return $value;
+ * }
+ *
  * @package Elgg
  * @subpackage Test
  * @author Curverider Ltd
@@ -15,7 +25,7 @@ class ElggCoreSkeletonTest extends ElggCoreUnitTest {
        public function __construct() {
                parent::__construct();
                
-               // all code should come after here
+               // all __construct() code should come after here
        }
 
        /**
@@ -37,14 +47,14 @@ class ElggCoreSkeletonTest extends ElggCoreUnitTest {
         * Called after each test object.
         */
        public function __destruct() {
-               // all code should go above here
+               // all __destruct() code should go above here
                parent::__destruct();
        }
 
        /**
         * A basic test that will be called and fail.
         */
-       public function testElggEntityConstructor() {
+       public function testFailure() {
                $this->assertTrue(FALSE);
        }
 }