updates to docblocks for phpDocumentor

extensions/coverage/autocoverage.php

@@ -1,6 +1,12 @@
 <?php
-# Include this in any file to start coverage, coverage will automatically end
-# when process dies.
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
+/**
+ * Include this in any file to start coverage, coverage will automatically end
+ * when process dies.
+ */
 require_once(dirname(__FILE__) .'/coverage.php');
 
 if (CodeCoverage::isCoverageOn()) {

extensions/coverage/bin/php-coverage-close.php

@@ -1,7 +1,12 @@
 <?php
-# 
-# Close code coverage data collection, next step is to generate report
-#
+/**
+ * Close code coverage data collection, next step is to generate report
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
+/**
+ * include coverage files
+ */
 require_once(dirname(__FILE__) . '/../coverage.php');
 $cc = CodeCoverage::getInstance();
 $cc->readSettings();

extensions/coverage/bin/php-coverage-open.php

@@ -1,20 +1,25 @@
 <?php
-# 
-# Initialize code coverage data collection, next step is to run your tests
-# with ini setting auto_prepend_file=autocoverage.php ...
-# 
+/**
+ * Initialize code coverage data collection, next step is to run your tests
+ * with ini setting auto_prepend_file=autocoverage.php ...
+ *
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */ 
 # optional arguments:
 #  --include=<some filepath regexp>      these files should be included coverage report
 #  --exclude=<come filepath regexp>      these files should not be included in coverage report
 #  --maxdepth=2                          when considering which file were not touched, scan directories 
-#                                        this deep
 #
 # Example: 
-#  php-coverage-open.php --include='.*\.php$' --include='.*\.inc$' --exclude='.*/tests/.*'
-
+# php-coverage-open.php --include='.*\.php$' --include='.*\.inc$' --exclude='.*/tests/.*' 
+/**#@+
+ * include coverage files
+ */
 require_once(dirname(__FILE__) . '/../coverage_utils.php');
 CoverageUtils::requireSqlite();
 require_once(dirname(__FILE__) . '/../coverage.php');
+/**#@-*/
 $cc = new CodeCoverage();
 $cc->log = 'coverage.sqlite';
 $args = CoverageUtils::parseArguments($_SERVER['argv'], TRUE);

extensions/coverage/bin/php-coverage-report.php

@@ -1,14 +1,21 @@
 <?php
-# 
-# Generate a code coverage report
-#
+/**
+ * Generate a code coverage report
+ *
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
 # optional arguments:
 #  --reportDir=some/directory    the default is ./coverage-report
 #  --title='My Coverage Report'  title the main page of your report
-#
+
+/**#@+
+ * include coverage files
+ */
 require_once(dirname(__FILE__) . '/../coverage_utils.php');
 require_once(dirname(__FILE__) . '/../coverage.php');
 require_once(dirname(__FILE__) . '/../coverage_reporter.php');
+/**#@-*/
 $cc = CodeCoverage::getInstance();
 $cc->readSettings();
 $handler = new CoverageDataHandler($cc->log);

extensions/coverage/coverage.php

@@ -1,10 +1,18 @@
 <?php
-
+/**
+* @package        SimpleTest
+* @subpackage     Extensions
+*/
+/**
+* load coverage data handle
+*/
 require_once dirname(__FILE__) . '/coverage_data_handler.php';
 
 /**
  * Orchestrates code coverage both in this thread and in subthread under apache
  * Assumes this is running on same machine as apache.
+ * @package        SimpleTest
+ * @subpackage     Extensions
  */
 class CodeCoverage  {
     var $log;

extensions/coverage/coverage_calculator.php

@@ -1,4 +1,12 @@
 <?php
+/**
+* @package        SimpleTest
+* @subpackage     Extensions
+*/
+/**
+* @package        SimpleTest
+* @subpackage     Extensions
+*/
 class CoverageCalculator {
 
     function coverageByFileVariables($file, $coverage) {

extensions/coverage/coverage_data_handler.php

@@ -1,12 +1,20 @@
 <?php
-
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
+/**
+ * @todo	which db abstraction layer is this?
+ */
 require_once 'DB/sqlite.php';
 
 /**
  * Persists code coverage data into SQLite database and aggregate data for convienent
  * interpretation in report generator.  Be sure to not to keep an instance longer
  * than you have, otherwise you risk overwriting database edits from another process
  * also trying to make updates.
+ * @package        SimpleTest
+ * @subpackage     Extensions
  */
 class CoverageDataHandler {
 

extensions/coverage/coverage_reporter.php

@@ -1,12 +1,21 @@
 <?php
-
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
+/**#@+
+ * include additional coverage files
+ */
 require_once dirname(__FILE__) .'/coverage_calculator.php';
 require_once dirname(__FILE__) .'/coverage_utils.php';
 require_once dirname(__FILE__) .'/simple_coverage_writer.php';
+/**#@-*/
 
 /**
  * Take aggregated coverage data and generate reports from it using smarty
  * templates
+ * @package        SimpleTest
+ * @subpackage     Extensions
  */
 class CoverageReporter {
     var $coverage;

extensions/coverage/coverage_utils.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
 class CoverageUtils {
 
     static function mkdir($dir) {

extensions/coverage/coverage_writer.php

@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
+/**
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
 interface CoverageWriter {
 
     function writeSummary($out, $variables);

extensions/coverage/simple_coverage_writer.php

@@ -1,7 +1,20 @@
 <?php
-
+/**
+ *  SimpleCoverageWriter class file
+ *  @package    SimpleTest
+ *  @subpackage UnitTester
+ *  @version    $Id: unit_tester.php 1882 2009-07-01 14:30:05Z lastcraft $
+ */
+/**
+ * base coverage writer class
+ */
 require_once dirname(__FILE__) .'/coverage_writer.php';
 
+/**
+ *  SimpleCoverageWriter class
+ *  @package    SimpleTest
+ *  @subpackage UnitTester
+ */
 class SimpleCoverageWriter implements CoverageWriter {
 
     function writeSummary($out, $variables) {

extensions/dom_tester/css_selector.php

@@ -17,8 +17,9 @@
  * derived from sfDomCssSelector Id 3053 (Symfony version 1.0.2) - Fabien Potencier, 2006-12-16
  * http://www.symfony-project.com/api/symfony/util/sfDomCssSelector.html
  *
+ *	@package	SimpleTest
+ *	@subpackage	DomTestCase
  * @param DomDocument $dom
- *
  */
 
 class CssSelector {

extensions/selenium.php

@@ -5,12 +5,18 @@
  *	@subpackage	Extensions
  *	@version	$Id$
  */
+/**#@+
+ *  include other SimpleTest class files
+ */
 require_once dirname(__FILE__) . '/../unit_tester.php';
 require_once dirname(__FILE__) . '/selenium/remote-control.php';
+/**#@-*/
 
 /**
  * Provides test case wrapper to a Selenium remote
  * control instance.
+ *	@package	SimpleTest
+ *	@subpackage	Extensions
  */
 class SeleniumTestCase extends UnitTestCase
 {

extensions/selenium/remote-control.php

@@ -1,14 +1,17 @@
 <?php
-
-
-
+/**
+ * Selenium Remote Control Class
+ * @package        SimpleTest
+ * @subpackage     Extensions
+ */
 /**
  *
  * Based on the Domain51_Testing_Selenium class available at
  * http://domain51.googlecode.com/svn/Domain51/trunk/
  *
  * @author Travis Swicegood <development [at] domain51 [dot] com>
- *
+ * @package        SimpleTest
+ * @subpackage     Extensions
  */
 class SimpleSeleniumRemoteControl
 {

extensions/treemap_reporter.php

@@ -5,8 +5,12 @@
  *  @subpackage     Extensions
  *	@version	$Id$
  */
+/**#@+
+ *  include other SimpleTest class files
+ */
 require_once(dirname(__FILE__) . '/../scorer.php');
 require_once(dirname(__FILE__) . '/treemap_reporter/treemap_recorder.php');
+/**#@-*/
 
 /**
  * Constructs and renders a treemap visualization of a test run

extensions/treemap_reporter/jquery.php

@@ -5,10 +5,13 @@
  *  @subpackage     Extensions
  *	@version	$Id$
  */
+/**
+ * include treemap reporter
+ */
 require_once dirname(__FILE__) . '/../treemap_reporter.php';
 
 /**
- * outputs <ul> representing treemap of test report,
+ * outputs unordered list representing treemap of test report,
  * and attaches jQuery Treemap to render results.
  *
  *  @package        SimpleTest

mock_objects.php

@@ -466,7 +466,6 @@ function expectArguments($method, $args, $message) {
      *    @param array $args        The parameters making up the
      *                              rest of the call.
      *    @return mixed             The result of the action.
-     *    @access public.
      */
     function &respond($step, $method, $args) {
         $method = strtolower($method);

socket.php

@@ -66,6 +66,10 @@ function clearError() {
     }
 }
 
+/**
+ *    @package SimpleTest
+ *    @subpackage WebTester
+ */
 class SimpleFileSocket extends SimpleStickyError {
     private $handle;
     private $is_open = false;

test_case.php

@@ -19,13 +19,13 @@
 require_once(dirname(__FILE__) . '/simpletest.php');
 require_once(dirname(__FILE__) . '/exceptions.php');
 require_once(dirname(__FILE__) . '/reflection_php5.php');
+/**#@-*/
 if (! defined('SIMPLE_TEST')) {
     /**
      * @ignore
      */
     define('SIMPLE_TEST', dirname(__FILE__) . DIRECTORY_SEPARATOR);
 }
-/**#@-*/
 
 /**
  *    Basic test case. This is the smallest unit of a test
@@ -362,6 +362,8 @@ function getSize() {
 
 /**
  *  Helps to extract test cases automatically from a file.
+ *    @package      SimpleTest
+ *    @subpackage   UnitTester
  */
 class SimpleFileLoader {