com phpruntests: doc blocks: src/testcase/output/rtTestOutputWriterList.php src/testcase/output/rtTestOutputWriterXML.php
src/testcase/preconditions/rtHasMandatorySections.php src/testcase/preconditions/rtHasNoDuplicateSections.php
src/testcase/preconditions/rtIsSectionImplemented.php src/testcase/preconditions/rtIsValidSectionName.php
src/testcase/sections/configurationsections/rtArgsSection.php src/testcase/sections/configurationsections/rtEnvS
| From: | David Soria Parra | Date: | Mon, 25 May 2009 12:12:47 +0000 |
| Subject: | com phpruntests: doc blocks: src/testcase/output/rtTestOutputWriterList.php src/testcase/output/rtTestOutputWriterXML.php src/testcase/preconditions/rtHasMandatorySections.php src/testcase/preconditions/rtHasNoDuplicateSections.php src/testcase/preconditions/rtIsSectionImplemented.php src/testcase/preconditions/rtIsValidSectionName.php src/testcase/sections/configurationsections/rtArgsSection.php src/testcase/sections/configurationsections/rtEnvS |
||
| Groups: | php.qa | ||
| Request: | Send a blank email to php-qa+get-66436@lists.php.net to get a copy of this message | ||
Commit: cbcee974cc8b52a12bb626f497d3fa0298db27f0
Author: Zoe Slattery <zoe@php.net> Mon, 25 May 2009 12:12:47 +0000
Parents: 044c13e34b6ecb9d5ac3e80d73e61809d5b8919f
Branches: master
Link: http://git.php.net/?p=phpruntests.git;a=commitdiff;h=cbcee974cc8b52a12bb626f497d3fa0298db27f0
Log:
doc blocks
Changed paths:
M src/testcase/output/rtTestOutputWriterList.php
M src/testcase/output/rtTestOutputWriterXML.php
M src/testcase/preconditions/rtHasMandatorySections.php
M src/testcase/preconditions/rtHasNoDuplicateSections.php
M src/testcase/preconditions/rtIsSectionImplemented.php
M src/testcase/preconditions/rtIsValidSectionName.php
M src/testcase/sections/configurationsections/rtArgsSection.php
M src/testcase/sections/configurationsections/rtEnvSection.php
M src/testcase/sections/configurationsections/rtIniSection.php
M src/testcase/sections/executablesections/rtCleanSection.php
M src/testcase/sections/executablesections/rtSkipIfSection.php
M src/testcase/sections/informationsections/rtCreditsSection.php
M src/testcase/sections/informationsections/rtTestHeaderSection.php
M src/testcase/sections/informationsections/rtXfailSection.php
M src/testcase/sections/outputsections/rtExpectFSection.php
M src/testcase/sections/outputsections/rtExpectHeadersSection.php
M src/testcase/sections/outputsections/rtExpectRegexSection.php
M src/testcase/sections/outputsections/rtExpectSection.php
diff --git a/src/testcase/output/rtTestOutputWriterList.php b/src/testcase/output/rtTestOutputWriterList.php index 5b0249b..7ea7ab8 100644 --- a/src/testcase/output/rtTestOutputWriterList.php +++ b/src/testcase/output/rtTestOutputWriterList.php @@ -1,6 +1,17 @@ <?php /** + * rtTestOutputWriterList * + * Write test output line by line to stdout + * + * @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 rtTestOutputWriterList extends rtTestOutputWriter { @@ -23,8 +34,6 @@ class rtTestOutputWriterList extends rtTestOutputWriter $outputString = ""; $testStatus = $testResult->getStatus(); ksort($testStatus); - //Status can be PASS and WARN or FAIL and WARN. I think these are the olny two combinations - //but there may be more foreach ($testStatus as $status => $message) { $outputString .= strtoupper($status); $outputString .= " " . $message; diff --git a/src/testcase/output/rtTestOutputWriterXML.php b/src/testcase/output/rtTestOutputWriterXML.php index 410c9eb..65b3996 100644 --- a/src/testcase/output/rtTestOutputWriterXML.php +++ b/src/testcase/output/rtTestOutputWriterXML.php @@ -1,6 +1,17 @@ <?php /** + * rtTestOutputWriterXML * + * Write test output as XML + * + * @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 rtTestOutputWriterXML extends rtTestOutputWriter { diff --git a/src/testcase/preconditions/rtHasMandatorySections.php b/src/testcase/preconditions/rtHasMandatorySections.php index fd05ad9..2b96ca8 100644 --- a/src/testcase/preconditions/rtHasMandatorySections.php +++ b/src/testcase/preconditions/rtHasMandatorySections.php @@ -1,6 +1,17 @@ <?php /** + * rtHasMandatorySections * + * Checks that the test case has mandatory sections + * + * @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 rtHasMandatorySections implements rtTestPreCondition { diff --git a/src/testcase/preconditions/rtHasNoDuplicateSections.php b/src/testcase/preconditions/rtHasNoDuplicateSections.php index 78e14df..5f09753 100644 --- a/src/testcase/preconditions/rtHasNoDuplicateSections.php +++ b/src/testcase/preconditions/rtHasNoDuplicateSections.php @@ -1,6 +1,17 @@ <?php /** + * rtHasNoDuplicateSections * + * Checks that the test case does not have duplicate sections + * + * @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 rtHasNoDuplicateSections implements rtTestPreCondition { diff --git a/src/testcase/preconditions/rtIsSectionImplemented.php b/src/testcase/preconditions/rtIsSectionImplemented.php index ce44b64..24567af 100644 --- a/src/testcase/preconditions/rtIsSectionImplemented.php +++ b/src/testcase/preconditions/rtIsSectionImplemented.php @@ -1,6 +1,17 @@ <?php /** + * rtIsSectionImplemented * + * Checks whether this version of run tests has implemented a section + * + * @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 rtIsSectionImplemented implements rtTestPreCondition { diff --git a/src/testcase/preconditions/rtIsValidSectionName.php b/src/testcase/preconditions/rtIsValidSectionName.php index 2a0ff47..50cd734 100644 --- a/src/testcase/preconditions/rtIsValidSectionName.php +++ b/src/testcase/preconditions/rtIsValidSectionName.php @@ -1,6 +1,17 @@ <?php /** + * rtIsValidSEctionName * + * Checks that a section name is valid + * + * @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 rtIsValidSectionName implements rtTestPreCondition { @@ -29,7 +40,6 @@ class rtIsValidSectionName implements rtTestPreCondition 'REDIRECTTEST', 'HEADERS', 'EXPECTHEADERS', - '===DONE===', ); /** diff --git a/src/testcase/sections/configurationsections/rtArgsSection.php b/src/testcase/sections/configurationsections/rtArgsSection.php index 47ae97b..584be57 100644 --- a/src/testcase/sections/configurationsections/rtArgsSection.php +++ b/src/testcase/sections/configurationsections/rtArgsSection.php @@ -1,6 +1,17 @@ <?php /** + * rtArgsSection * + * Adds section content to the test command line arguments + * + * @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 rtArgsSection extends rtConfigurationSection { diff --git a/src/testcase/sections/configurationsections/rtEnvSection.php b/src/testcase/sections/configurationsections/rtEnvSection.php index c537974..8b6430c 100644 --- a/src/testcase/sections/configurationsections/rtEnvSection.php +++ b/src/testcase/sections/configurationsections/rtEnvSection.php @@ -1,6 +1,17 @@ <?php /** + * rtEnvSection * + * Adds section content to the test environment variables + * + * @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 rtEnvSection extends rtConfigurationSection { diff --git a/src/testcase/sections/configurationsections/rtIniSection.php b/src/testcase/sections/configurationsections/rtIniSection.php index 85fe279..a748ccd 100644 --- a/src/testcase/sections/configurationsections/rtIniSection.php +++ b/src/testcase/sections/configurationsections/rtIniSection.php @@ -1,6 +1,17 @@ <?php /** + * rtIniSection * + * Adds section content to the test ini settings + * + * @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 rtIniSection extends rtConfigurationSection { diff --git a/src/testcase/sections/executablesections/rtCleanSection.php b/src/testcase/sections/executablesections/rtCleanSection.php index eb8a8ad..54c4243 100644 --- a/src/testcase/sections/executablesections/rtCleanSection.php +++ b/src/testcase/sections/executablesections/rtCleanSection.php @@ -1,20 +1,9 @@ <?php /** * rtCleanSection - * - * @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/ - */ - -/** + * * Executes the code in the --CLEAN-- section * - * * @category Testing * @package RUNTESTS * @author Zoe Slattery <zoe@php.net> diff --git a/src/testcase/sections/executablesections/rtSkipIfSection.php b/src/testcase/sections/executablesections/rtSkipIfSection.php index 9bb2de3..20a1094 100644 --- a/src/testcase/sections/executablesections/rtSkipIfSection.php +++ b/src/testcase/sections/executablesections/rtSkipIfSection.php @@ -1,19 +1,8 @@ <?php /** * rtSkipIfSection - * - * @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/ - */ - -/** - * Executes the code in the --SKIPIF-- section - * + * + * Executes the code in the --SKIPIF-- section * * @category Testing * @package RUNTESTS diff --git a/src/testcase/sections/informationsections/rtCreditsSection.php b/src/testcase/sections/informationsections/rtCreditsSection.php index e86336b..1d0646d 100644 --- a/src/testcase/sections/informationsections/rtCreditsSection.php +++ b/src/testcase/sections/informationsections/rtCreditsSection.php @@ -1,7 +1,16 @@ <?php /** - * Class for --CREDITS-- section + * rtCreditsSection + * + * Deals with information in test credits section * + * @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 rtCreditsSection extends rtInformationSection { diff --git a/src/testcase/sections/informationsections/rtTestHeaderSection.php b/src/testcase/sections/informationsections/rtTestHeaderSection.php index 9da8d69..241f219 100644 --- a/src/testcase/sections/informationsections/rtTestHeaderSection.php +++ b/src/testcase/sections/informationsections/rtTestHeaderSection.php @@ -1,6 +1,16 @@ <?php /** - * Class for the --TEST-- section + * rtTestHeaderSection + * + * Deals with information in test header (TEST) section + * + * @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 rtTestHeaderSection extends rtInformationSection { diff --git a/src/testcase/sections/informationsections/rtXfailSection.php b/src/testcase/sections/informationsections/rtXfailSection.php index 5c196f0..74d4c64 100644 --- a/src/testcase/sections/informationsections/rtXfailSection.php +++ b/src/testcase/sections/informationsections/rtXfailSection.php @@ -1,7 +1,16 @@ <?php /** - * Class for the --XFAIL-- section + * rtXfailSection + * + * Deals with information in the Xfail section * + * @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 rtXfailSection extends rtInformationSection { diff --git a/src/testcase/sections/outputsections/rtExpectFSection.php b/src/testcase/sections/outputsections/rtExpectFSection.php index 80c698b..03239cc 100644 --- a/src/testcase/sections/outputsections/rtExpectFSection.php +++ b/src/testcase/sections/outputsections/rtExpectFSection.php @@ -1,6 +1,16 @@ <?php /** - * Class representing expected and actual output from a test + * rtExpectFSection + * + * Class for handling EXPECTF sections + * + * @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 rtExpectFSection extends rtOutputSection { diff --git a/src/testcase/sections/outputsections/rtExpectHeadersSection.php b/src/testcase/sections/outputsections/rtExpectHeadersSection.php index 096aa1c..71b8bb4 100644 --- a/src/testcase/sections/outputsections/rtExpectHeadersSection.php +++ b/src/testcase/sections/outputsections/rtExpectHeadersSection.php @@ -1,7 +1,7 @@ <?php /** * rtExpectHeadersSection - * Sets environment variables for EXPECT_HEADERS section + * Class for expected headers (EXPECT_HEADERS) section * * * @category Testing diff --git a/src/testcase/sections/outputsections/rtExpectRegexSection.php b/src/testcase/sections/outputsections/rtExpectRegexSection.php index 0dca266..7d4d9d6 100644 --- a/src/testcase/sections/outputsections/rtExpectRegexSection.php +++ b/src/testcase/sections/outputsections/rtExpectRegexSection.php @@ -1,6 +1,16 @@ <?php /** - * Class representing expected output and actual output + * rtExpectRegexSection + * + * Class for handling EXPECTREGEX sections + * + * @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 rtExpectRegexSection extends rtOutputSection { diff --git a/src/testcase/sections/outputsections/rtExpectSection.php b/src/testcase/sections/outputsections/rtExpectSection.php index e2d789f..2f447c6 100644 --- a/src/testcase/sections/outputsections/rtExpectSection.php +++ b/src/testcase/sections/outputsections/rtExpectSection.php @@ -1,6 +1,16 @@ <?php /** - * Class representing expected output and actual output + * rtExpectSection + * + * Class for handling EXPECT sections + * + * @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 rtExpectSection extends rtOutputSection {
diff --git a/src/testcase/output/rtTestOutputWriterList.php b/src/testcase/output/rtTestOutputWriterList.php index 5b0249b..7ea7ab8 100644 --- a/src/testcase/output/rtTestOutputWriterList.php +++ b/src/testcase/output/rtTestOutputWriterList.php @@ -1,6 +1,17 @@ <?php /** + * rtTestOutputWriterList * + * Write test output line by line to stdout + * + * @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 rtTestOutputWriterList extends rtTestOutputWriter { @@ -23,8 +34,6 @@ class rtTestOutputWriterList extends rtTestOutputWriter $outputString = ""; $testStatus = $testResult->getStatus(); ksort($testStatus); - //Status can be PASS and WARN or FAIL and WARN. I think these are the olny two combinations - //but there may be more foreach ($testStatus as $status => $message) { $outputString .= strtoupper($status); $outputString .= " " . $message; diff --git a/src/testcase/output/rtTestOutputWriterXML.php b/src/testcase/output/rtTestOutputWriterXML.php index 410c9eb..65b3996 100644 --- a/src/testcase/output/rtTestOutputWriterXML.php +++ b/src/testcase/output/rtTestOutputWriterXML.php @@ -1,6 +1,17 @@ <?php /** + * rtTestOutputWriterXML * + * Write test output as XML + * + * @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 rtTestOutputWriterXML extends rtTestOutputWriter { diff --git a/src/testcase/preconditions/rtHasMandatorySections.php b/src/testcase/preconditions/rtHasMandatorySections.php index fd05ad9..2b96ca8 100644 --- a/src/testcase/preconditions/rtHasMandatorySections.php +++ b/src/testcase/preconditions/rtHasMandatorySections.php @@ -1,6 +1,17 @@ <?php /** + * rtHasMandatorySections * + * Checks that the test case has mandatory sections + * + * @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 rtHasMandatorySections implements rtTestPreCondition { diff --git a/src/testcase/preconditions/rtHasNoDuplicateSections.php b/src/testcase/preconditions/rtHasNoDuplicateSections.php index 78e14df..5f09753 100644 --- a/src/testcase/preconditions/rtHasNoDuplicateSections.php +++ b/src/testcase/preconditions/rtHasNoDuplicateSections.php @@ -1,6 +1,17 @@ <?php /** + * rtHasNoDuplicateSections * + * Checks that the test case does not have duplicate sections + * + * @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 rtHasNoDuplicateSections implements rtTestPreCondition { diff --git a/src/testcase/preconditions/rtIsSectionImplemented.php b/src/testcase/preconditions/rtIsSectionImplemented.php index ce44b64..24567af 100644 --- a/src/testcase/preconditions/rtIsSectionImplemented.php +++ b/src/testcase/preconditions/rtIsSectionImplemented.php @@ -1,6 +1,17 @@ <?php /** + * rtIsSectionImplemented * + * Checks whether this version of run tests has implemented a section + * + * @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 rtIsSectionImplemented implements rtTestPreCondition { diff --git a/src/testcase/preconditions/rtIsValidSectionName.php b/src/testcase/preconditions/rtIsValidSectionName.php index 2a0ff47..50cd734 100644 --- a/src/testcase/preconditions/rtIsValidSectionName.php +++ b/src/testcase/preconditions/rtIsValidSectionName.php @@ -1,6 +1,17 @@ <?php /** + * rtIsValidSEctionName * + * Checks that a section name is valid + * + * @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 rtIsValidSectionName implements rtTestPreCondition { @@ -29,7 +40,6 @@ class rtIsValidSectionName implements rtTestPreCondition 'REDIRECTTEST', 'HEADERS', 'EXPECTHEADERS', - '===DONE===', ); /** diff --git a/src/testcase/sections/configurationsections/rtArgsSection.php b/src/testcase/sections/configurationsections/rtArgsSection.php index 47ae97b..584be57 100644 --- a/src/testcase/sections/configurationsections/rtArgsSection.php +++ b/src/testcase/sections/configurationsections/rtArgsSection.php @@ -1,6 +1,17 @@ <?php /** + * rtArgsSection * + * Adds section content to the test command line arguments + * + * @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 rtArgsSection extends rtConfigurationSection { diff --git a/src/testcase/sections/configurationsections/rtEnvSection.php b/src/testcase/sections/configurationsections/rtEnvSection.php index c537974..8b6430c 100644 --- a/src/testcase/sections/configurationsections/rtEnvSection.php +++ b/src/testcase/sections/configurationsections/rtEnvSection.php @@ -1,6 +1,17 @@ <?php /** + * rtEnvSection * + * Adds section content to the test environment variables + * + * @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 rtEnvSection extends rtConfigurationSection { diff --git a/src/testcase/sections/configurationsections/rtIniSection.php b/src/testcase/sections/configurationsections/rtIniSection.php index 85fe279..a748ccd 100644 --- a/src/testcase/sections/configurationsections/rtIniSection.php +++ b/src/testcase/sections/configurationsections/rtIniSection.php @@ -1,6 +1,17 @@ <?php /** + * rtIniSection * + * Adds section content to the test ini settings + * + * @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 rtIniSection extends rtConfigurationSection { diff --git a/src/testcase/sections/executablesections/rtCleanSection.php b/src/testcase/sections/executablesections/rtCleanSection.php index eb8a8ad..54c4243 100644 --- a/src/testcase/sections/executablesections/rtCleanSection.php +++ b/src/testcase/sections/executablesections/rtCleanSection.php @@ -1,20 +1,9 @@ <?php /** * rtCleanSection - * - * @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/ - */ - -/** + * * Executes the code in the --CLEAN-- section * - * * @category Testing * @package RUNTESTS * @author Zoe Slattery <zoe@php.net> diff --git a/src/testcase/sections/executablesections/rtSkipIfSection.php b/src/testcase/sections/executablesections/rtSkipIfSection.php index 9bb2de3..20a1094 100644 --- a/src/testcase/sections/executablesections/rtSkipIfSection.php +++ b/src/testcase/sections/executablesections/rtSkipIfSection.php @@ -1,19 +1,8 @@ <?php /** * rtSkipIfSection - * - * @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/ - */ - -/** - * Executes the code in the --SKIPIF-- section - * + * + * Executes the code in the --SKIPIF-- section * * @category Testing * @package RUNTESTS diff --git a/src/testcase/sections/informationsections/rtCreditsSection.php b/src/testcase/sections/informationsections/rtCreditsSection.php index e86336b..1d0646d 100644 --- a/src/testcase/sections/informationsections/rtCreditsSection.php +++ b/src/testcase/sections/informationsections/rtCreditsSection.php @@ -1,7 +1,16 @@ <?php /** - * Class for --CREDITS-- section + * rtCreditsSection + * + * Deals with information in test credits section * + * @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 rtCreditsSection extends rtInformationSection { diff --git a/src/testcase/sections/informationsections/rtTestHeaderSection.php b/src/testcase/sections/informationsections/rtTestHeaderSection.php index 9da8d69..241f219 100644 --- a/src/testcase/sections/informationsections/rtTestHeaderSection.php +++ b/src/testcase/sections/informationsections/rtTestHeaderSection.php @@ -1,6 +1,16 @@ <?php /** - * Class for the --TEST-- section + * rtTestHeaderSection + * + * Deals with information in test header (TEST) section + * + * @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 rtTestHeaderSection extends rtInformationSection { diff --git a/src/testcase/sections/informationsections/rtXfailSection.php b/src/testcase/sections/informationsections/rtXfailSection.php index 5c196f0..74d4c64 100644 --- a/src/testcase/sections/informationsections/rtXfailSection.php +++ b/src/testcase/sections/informationsections/rtXfailSection.php @@ -1,7 +1,16 @@ <?php /** - * Class for the --XFAIL-- section + * rtXfailSection + * + * Deals with information in the Xfail section * + * @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 rtXfailSection extends rtInformationSection { diff --git a/src/testcase/sections/outputsections/rtExpectFSection.php b/src/testcase/sections/outputsections/rtExpectFSection.php index 80c698b..03239cc 100644 --- a/src/testcase/sections/outputsections/rtExpectFSection.php +++ b/src/testcase/sections/outputsections/rtExpectFSection.php @@ -1,6 +1,16 @@ <?php /** - * Class representing expected and actual output from a test + * rtExpectFSection + * + * Class for handling EXPECTF sections + * + * @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 rtExpectFSection extends rtOutputSection { diff --git a/src/testcase/sections/outputsections/rtExpectHeadersSection.php b/src/testcase/sections/outputsections/rtExpectHeadersSection.php index 096aa1c..71b8bb4 100644 --- a/src/testcase/sections/outputsections/rtExpectHeadersSection.php +++ b/src/testcase/sections/outputsections/rtExpectHeadersSection.php @@ -1,7 +1,7 @@ <?php /** * rtExpectHeadersSection - * Sets environment variables for EXPECT_HEADERS section + * Class for expected headers (EXPECT_HEADERS) section * * * @category Testing diff --git a/src/testcase/sections/outputsections/rtExpectRegexSection.php b/src/testcase/sections/outputsections/rtExpectRegexSection.php index 0dca266..7d4d9d6 100644 --- a/src/testcase/sections/outputsections/rtExpectRegexSection.php +++ b/src/testcase/sections/outputsections/rtExpectRegexSection.php @@ -1,6 +1,16 @@ <?php /** - * Class representing expected output and actual output + * rtExpectRegexSection + * + * Class for handling EXPECTREGEX sections + * + * @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 rtExpectRegexSection extends rtOutputSection { diff --git a/src/testcase/sections/outputsections/rtExpectSection.php b/src/testcase/sections/outputsections/rtExpectSection.php index e2d789f..2f447c6 100644 --- a/src/testcase/sections/outputsections/rtExpectSection.php +++ b/src/testcase/sections/outputsections/rtExpectSection.php @@ -1,6 +1,16 @@ <?php /** - * Class representing expected output and actual output + * rtExpectSection + * + * Class for handling EXPECT sections + * + * @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 rtExpectSection extends rtOutputSection {