com phpruntests: doc blocks: src/configuration/rtAddToCommandLine.php src/configuration/rtCommandLineOptions.php
src/configuration/rtEnvironmentVariables.php src/configuration/rtIniAsCommandLineArgs.php src/configuration/rtPreCondition.php
src/configuration/rtPreConditionList.php src/configuration/rtRuntestsConfiguration.php src/configuration/rtSetting.php

From: Date: Mon, 25 May 2009 08:56:23 +0000
Subject: com phpruntests: doc blocks: src/configuration/rtAddToCommandLine.php src/configuration/rtCommandLineOptions.php
src/configuration/rtEnvironmentVariables.php src/configuration/rtIniAsCommandLineArgs.php src/configuration/rtPreCondition.php
src/configuration/rtPreConditionList.php src/configuration/rtRuntestsConfiguration.php src/configuration/rtSetting.php
Groups: php.qa 
Request: Send a blank email to php-qa+get-66437@lists.php.net to get a copy of this message
Commit: 044c13e34b6ecb9d5ac3e80d73e61809d5b8919f Author: Zoe Slattery <zoe@php.net> Mon, 25 May 2009 08:56:23 +0000 Parents: c0a16d1137827415d5ad7043fb7d89fc9d197f07 Branches: master Link: http://git.php.net/?p=phpruntests.git;a=commitdiff;h=044c13e34b6ecb9d5ac3e80d73e61809d5b8919f Log: doc blocks Changed paths: M src/configuration/rtAddToCommandLine.php M src/configuration/rtCommandLineOptions.php M src/configuration/rtEnvironmentVariables.php M src/configuration/rtIniAsCommandLineArgs.php M src/configuration/rtPreCondition.php M src/configuration/rtPreConditionList.php M src/configuration/rtRuntestsConfiguration.php M src/configuration/rtSetting.php Diff: diff --git a/src/configuration/rtAddToCommandLine.php b/src/configuration/rtAddToCommandLine.php index 89f9717..9abea47 100644 --- a/src/configuration/rtAddToCommandLine.php +++ b/src/configuration/rtAddToCommandLine.php @@ -1,9 +1,18 @@ <?php - /** - * Command line arguments can be supplied by an env variable. This class ensures - * that additional arguments are parsed + * rtAddToCommandLine * + * Command line arguments can be supplied by an env variable. + * This class ensures that additional arguments are parsed + * + * @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 rtAddToCommandLine { diff --git a/src/configuration/rtCommandLineOptions.php b/src/configuration/rtCommandLineOptions.php index 4e70140..00351aa 100644 --- a/src/configuration/rtCommandLineOptions.php +++ b/src/configuration/rtCommandLineOptions.php @@ -1,11 +1,17 @@ <?php /** - * Parse command line options - * - * @package control - * @author Zoe Slattery <zoe.slattery@googlemail.com> - * @license PHP http://www.php.net/license/3_01.txt + * rtCommandLineOptions * + * Parse command line options for run-tests.php + * + * @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 rtCommandLineOptions { diff --git a/src/configuration/rtEnvironmentVariables.php b/src/configuration/rtEnvironmentVariables.php index e7f7821..d9b03d3 100644 --- a/src/configuration/rtEnvironmentVariables.php +++ b/src/configuration/rtEnvironmentVariables.php @@ -1,9 +1,18 @@ <?php - /** - * Class to retrieve the values of environmnetal variables and store them - * Needs some changes - don't document till complete + * rtEnvironmentVariables * + * Class to retrieve the values of environmental variables and + * store them. + * + * @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 rtEnvironmentVariables { diff --git a/src/configuration/rtIniAsCommandLineArgs.php b/src/configuration/rtIniAsCommandLineArgs.php index 5ed38cf..3ee33a3 100644 --- a/src/configuration/rtIniAsCommandLineArgs.php +++ b/src/configuration/rtIniAsCommandLineArgs.php @@ -1,5 +1,18 @@ <?php - +/** + * rtIniAsCommandLineArgs + * + * Class to handle overrides of ini settings in run-tests + * + * @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 rtIniAsCommandLineArgs { protected $iniOverwrites = array( diff --git a/src/configuration/rtPreCondition.php b/src/configuration/rtPreCondition.php index 73bc782..e0e7660 100644 --- a/src/configuration/rtPreCondition.php +++ b/src/configuration/rtPreCondition.php @@ -1,12 +1,22 @@ <?php - /** - * A pre-condtion for running a test + * rtPreCondtion + * + * Parent class for run pre-condidtions + * + * @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 rtPreCondition { /** - * The message to use if teh pre-condition is not met + * The message to use if the pre-condition is not met * */ public function getMessage() diff --git a/src/configuration/rtPreConditionList.php b/src/configuration/rtPreConditionList.php index 4f06157..be3b73f 100644 --- a/src/configuration/rtPreConditionList.php +++ b/src/configuration/rtPreConditionList.php @@ -1,9 +1,18 @@ <?php - /** - * Class containing the base set of pre-conditions that must be met whatever - * platform run-tests is executed on + * rtPreCondtionList * + * Class containing the base set of pre-conditions that must be + * met whatever platform (OS) run-tests is executed on + * + * @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/ + * */ abstract class rtPreConditionList { diff --git a/src/configuration/rtRuntestsConfiguration.php b/src/configuration/rtRuntestsConfiguration.php index 24357f8..1a5e137 100644 --- a/src/configuration/rtRuntestsConfiguration.php +++ b/src/configuration/rtRuntestsConfiguration.php @@ -1,23 +1,12 @@ <?php /** * rtRuntestsConfiguration - * - * @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/ - */ - -/** + * * Sets up the configuration for the whole test run * * Settings are derived from command line options and/or environment variables. - * Runtests also overrides a number of ini settings. + * Runtests also overrides a number of ini settings. * - * * @category Testing * @package RUNTESTS * @author Zoe Slattery <zoe@php.net> diff --git a/src/configuration/rtSetting.php b/src/configuration/rtSetting.php index 6fb7c8b..255a6eb 100644 --- a/src/configuration/rtSetting.php +++ b/src/configuration/rtSetting.php @@ -1,12 +1,20 @@ <?php - /** + * rtSetting + * * Classes that set things in the test configuration. * Settings may instantiate other settings to retrieve values they need. * This leads to some settings being instantiated multiple times, and * being redundantly calculated, but makes settings independent from the order * in which they are processed in rtRuntestsConfiguration. - * + * + * @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/ */ abstract class rtSetting {

« previous php.qa (#66437) next »