com phpruntests: doc blocs: src/configuration/settings/rtCurrentDirectorySetting.php src/configuration/settings/rtLogFormatSetting.php
src/configuration/settings/rtPhpCgiExecutableSetting.php src/configuration/settings/rtPhpCommandLineArgSetting.php
src/configuration/settings/rtPhpExecutableSetting.php src/configuration/settings/rtTestDirectorySetting.php
src/configuration/settings/rtTestFileSetting.php src/configuration/settings/rtWorkingDirecto
| From: | David Soria Parra | Date: | Mon, 25 May 2009 08:36:59 +0000 |
| Subject: | com phpruntests: doc blocs: src/configuration/settings/rtCurrentDirectorySetting.php src/configuration/settings/rtLogFormatSetting.php src/configuration/settings/rtPhpCgiExecutableSetting.php src/configuration/settings/rtPhpCommandLineArgSetting.php src/configuration/settings/rtPhpExecutableSetting.php src/configuration/settings/rtTestDirectorySetting.php src/configuration/settings/rtTestFileSetting.php src/configuration/settings/rtWorkingDirecto |
||
| Groups: | php.qa | ||
| Request: | Send a blank email to php-qa+get-66439@lists.php.net to get a copy of this message | ||
Commit: 3f0c12b7fd8950a6b813bd1fb49ec81763317d35
Author: Zoe Slattery <zoe@php.net> Mon, 25 May 2009 08:36:59 +0000
Parents: 4065f322b0c1e3836bc8683640ff688428822977
Branches: master
Link: http://git.php.net/?p=phpruntests.git;a=commitdiff;h=3f0c12b7fd8950a6b813bd1fb49ec81763317d35
Log:
doc blocs
Changed paths:
M src/configuration/settings/rtCurrentDirectorySetting.php
M src/configuration/settings/rtLogFormatSetting.php
M src/configuration/settings/rtPhpCgiExecutableSetting.php
M src/configuration/settings/rtPhpCommandLineArgSetting.php
M src/configuration/settings/rtPhpExecutableSetting.php
M src/configuration/settings/rtTestDirectorySetting.php
M src/configuration/settings/rtTestFileSetting.php
M src/configuration/settings/rtWorkingDirectorySetting.php
Diff:
diff --git a/src/configuration/settings/rtCurrentDirectorySetting.php
b/src/configuration/settings/rtCurrentDirectorySetting.php
index e007a3f..b041a9d 100644
--- a/src/configuration/settings/rtCurrentDirectorySetting.php
+++ b/src/configuration/settings/rtCurrentDirectorySetting.php
@@ -1,8 +1,17 @@
<?php
-
/**
- * Class to set the directory at the start of the run
+ * rtCurrentDirectorySetting
*
+ * Class to set the directory at the start of the run
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa..php.net/
+ *
*/
class rtCurrentDirectorySetting extends rtSetting
{
diff --git a/src/configuration/settings/rtLogFormatSetting.php
b/src/configuration/settings/rtLogFormatSetting.php
index 1069b2c..29cfe25 100644
--- a/src/configuration/settings/rtLogFormatSetting.php
+++ b/src/configuration/settings/rtLogFormatSetting.php
@@ -1,8 +1,21 @@
<?php
-
/**
- * Sets the format of the log file
+ * rtLogFormatSetting
*
+ * Determines which log files ae written.
+ * L=log, E=exp, O=out, D=diff
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa.php.net/
+ *
+ */
+/*
+ * @todo don't have anything implemented that checks this yet
*/
class rtLogFormatSetting extends rtSetting
{
diff --git a/src/configuration/settings/rtPhpCgiExecutableSetting.php
b/src/configuration/settings/rtPhpCgiExecutableSetting.php
index 7b17d1d..2d1c141 100644
--- a/src/configuration/settings/rtPhpCgiExecutableSetting.php
+++ b/src/configuration/settings/rtPhpCgiExecutableSetting.php
@@ -1,8 +1,17 @@
<?php
-
/**
- * Class for setting the PHP CGI executable
+ * rtPhpCgiSetting
*
+ * Class for setting the PHP CGI executable name
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa.php.net/
+ *
*/
class rtPhpCgiExecutableSetting extends rtSetting
{
diff --git a/src/configuration/settings/rtPhpCommandLineArgSetting.php
b/src/configuration/settings/rtPhpCommandLineArgSetting.php
index d5eee8c..b18fa99 100644
--- a/src/configuration/settings/rtPhpCommandLineArgSetting.php
+++ b/src/configuration/settings/rtPhpCommandLineArgSetting.php
@@ -1,9 +1,18 @@
<?php
-
/**
- * Sets the arguments to teh PHP command line, initially as ini overrides
- * converted to -d flags
+ * rtPhpCommandLineArgSetting
*
+ * Sets the arguments to the PHP command line.
+ * Initially as ini overrides, converted to -d flags
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa.php.net/
+ *
*/
class rtPhpCommandLineArgSetting extends rtSetting
{
diff --git a/src/configuration/settings/rtPhpExecutableSetting.php
b/src/configuration/settings/rtPhpExecutableSetting.php
index ec32ef6..bc2a36b 100644
--- a/src/configuration/settings/rtPhpExecutableSetting.php
+++ b/src/configuration/settings/rtPhpExecutableSetting.php
@@ -1,8 +1,17 @@
<?php
-
/**
- * Class to set the PHP executable to be tested
+ * rtPhpExecutableSetting
*
+ * Class to set the PHP executable to be tested.
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa.php.net/
+ *
*/
class rtPhpExecutableSetting extends rtSetting
{
diff --git a/src/configuration/settings/rtTestDirectorySetting.php
b/src/configuration/settings/rtTestDirectorySetting.php
index 97c6deb..fde918c 100644
--- a/src/configuration/settings/rtTestDirectorySetting.php
+++ b/src/configuration/settings/rtTestDirectorySetting.php
@@ -1,9 +1,19 @@
<?php
-
/**
- * Class for setting the test directory (or directories) - these contain PHPT files
- * to be tested and can be provided on teh command line or by TEST_PHP_USER
+ * rtTestDirectorySetting
*
+ * Class for setting the test directory (or directories) - these
+ * contain PHPT files to be tested and can be provided on
+ * the command line or by TEST_PHP_USER
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa.php.net/
+ *
*/
class rtTestDirectorySetting extends rtSetting
{
diff --git a/src/configuration/settings/rtTestFileSetting.php
b/src/configuration/settings/rtTestFileSetting.php
index 08b2ac4..69104ec 100644
--- a/src/configuration/settings/rtTestFileSetting.php
+++ b/src/configuration/settings/rtTestFileSetting.php
@@ -1,9 +1,19 @@
<?php
-
/**
- * Class for setting a file or list of PHPT files to be run. These are provided either
- * from the command line or as lists in files using the command line -r or -l options
+ * rtTestFileSetting
*
+ * Class for setting a file or list of PHPT files to be run.
+ * These are provided either from the command line or as
+ * lists in files using the command line -r or -l options
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php..net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php..net/license/3_01.txt PHP License
3.01
+ * @link http://qa.php.net/
+ *
*/
class rtTestFileSetting extends rtSetting
{
diff --git a/src/configuration/settings/rtWorkingDirectorySetting.php
b/src/configuration/settings/rtWorkingDirectorySetting.php
index a54b2c3..9c36178 100644
--- a/src/configuration/settings/rtWorkingDirectorySetting.php
+++ b/src/configuration/settings/rtWorkingDirectorySetting.php
@@ -1,9 +1,18 @@
<?php
-
/**
- * Class for setting the working directory (may be different to the directory
- * that run-tests.php was started from)
+ * rtWorkingDirectorySetting
*
+ * Class for setting the working directory (may be different to
+ * the directory that run-tests.php was started from)
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt PHP License 3.01
+ * @link http://qa.php.net/
+ *
*/
class rtWorkingDirectorySetting extends rtSetting
{