Docs for find_tested.php

Initial Pass, also fixing the extra space before the extract_tests function name to keep with standards.

diff --git a/scripts/dev/find_tested.php b/scripts/dev/find_tested.php
index e841e2e9595208fd9ea1c603e1964d312e341fb7..0881e9ea471831761ee22994daf2a62a19c17335 100644 (file)
--- a/scripts/dev/find_tested.php
+++ b/scripts/dev/find_tested.php
@@ -68,7 +68,10 @@ get_phpt_files($extension_test_path, $count, $phpt_files);
 
 $extension_method_info = mark_methods_as_tested($extension_method_info, $phpt_files);
 
-
+/**
+ * The loop to ouput the test coverage info
+ * Should output: Extension, Class Name, Method/Function Name, Test Status, Test Files
+ */ 
 foreach($extension_method_info as $record) {
     echo $record[EXTENSION_NAME] . ",";
     echo $record[CLASS_NAME] . ",";
@@ -193,11 +196,14 @@ function get_phpt_files($dir, &$phpt_file_count, &$all_phpt)
     }
 }
 
-function  extract_tests($file) {
+/**
+ * Extract tests from a specified file, returns an array of tested function tokens 
+ */ 
+function extract_tests($file) {
        $code = file_get_contents($file);
        
        if (!preg_match('/--FILE--\s*(.*)\s*--(EXPECTF|EXPECTREGEX|EXPECT)?--/is', $code, $r)) {
-//             print "Unable to get code in ".$file."\n";
+               //print "Unable to get code in ".$file."\n";
                return array();
        }