com phpruntests: doc blocks: src/BuildClassMap.php src/rtAutoload.php src/rtClassMap.php src/rtDirectoryList.php src/rtPhptFilterIterator.php
src/rtText.php src/rtUtil.php
| From: | David Soria Parra | Date: | Mon, 25 May 2009 12:39:46 +0000 |
| Subject: | com phpruntests: doc blocks: src/BuildClassMap.php src/rtAutoload.php src/rtClassMap.php src/rtDirectoryList.php src/rtPhptFilterIterator.php src/rtText.php src/rtUtil.php |
||
| Groups: | php.qa | ||
| Request: | Send a blank email to php-qa+get-66432@lists.php.net to get a copy of this message | ||
Commit: 51c8c984965fda5cddf02fd99b694599f3500eb0
Author: Zoe Slattery <zoe@php.net> Mon, 25 May 2009 12:39:46 +0000
Parents: 062717d69e78ce2ceb8134d9a27c1d7d089a8df6
Branches: master
Link: http://git.php.net/?p=phpruntests.git;a=commitdiff;h=51c8c984965fda5cddf02fd99b694599f3500eb0
Log:
doc blocks
Changed paths:
M src/BuildClassMap.php
M src/rtAutoload.php
M src/rtClassMap.php
M src/rtDirectoryList.php
M src/rtPhptFilterIterator.php
M src/rtText.php
M src/rtUtil.php
Diff:
diff --git a/src/BuildClassMap.php b/src/BuildClassMap.php
index 9a91b5d..181b8bb 100644
--- a/src/BuildClassMap.php
+++ b/src/BuildClassMap.php
@@ -1,8 +1,17 @@
<?php
/**
+ * BuildClassMap
+ *
* This is stand alone code to build the file rtClassMap used by rtAutoload to find classes.
* It assumes that all classes have the same name at the file name (less .php) and all are
prefixed by 'rt'
- *
+ *
+ * @category Testing
+ * @package run-tests
+ * @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
+ *
*/
$map = new BuildClassMap();
diff --git a/src/rtAutoload.php b/src/rtAutoload.php
index 0400084..0e33d5e 100644
--- a/src/rtAutoload.php
+++ b/src/rtAutoload.php
@@ -1,11 +1,21 @@
<?php
-
-rtAutoload::init();
-
/**
+ * rtAutoload
+ *
* Autoloader using a map file (rtClassMap.php)
* defining the file to load each class from.
+ *
+ * @category Testing
+ * @package run-tests
+ * @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
+ *
*/
+
+rtAutoload::init();
+
class rtAutoload
{
/**
diff --git a/src/rtClassMap.php b/src/rtClassMap.php
index f2aba5f..1c2adfa 100644
--- a/src/rtClassMap.php
+++ b/src/rtClassMap.php
@@ -1,10 +1,20 @@
<?php
/**
+ * rtClassMap
+ *
* Autoload Class Map
*
* This is a generated file. Do not edit!
*
* To re-generate this file, run the script BuildClassMap.php.
+ *
+ * @category Testing
+ * @package run-tests
+ * @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
+ *
*/
$rtClassMap = array(
'rtEnvironmentException' =>
'configuration/exceptions/rtEnvironmentException.php',
diff --git a/src/rtDirectoryList.php b/src/rtDirectoryList.php
index cd8fe50..d7f93cf 100644
--- a/src/rtDirectoryList.php
+++ b/src/rtDirectoryList.php
@@ -1,8 +1,16 @@
<?php
-
/**
+ * rtDirectoryList
+ *
* Lists all of the directories under a top level directory.
* This is currently not used for anything
+ *
+ * @category Testing
+ * @package run-tests
+ * @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
*
*/
class rtDirectoryList
diff --git a/src/rtPhptFilterIterator..php b/src/rtPhptFilterIterator.php
index d5046d0..9908556 100644
--- a/src/rtPhptFilterIterator.php
+++ b/src/rtPhptFilterIterator.php
@@ -1,6 +1,15 @@
<?php
-
/**
+ * rtPhpFilterIterator
+ *
+ * Filter for .phpt file types
+ *
+ * @category Testing
+ * @package run-tests
+ * @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
*
*/
class rtPhptFilterIterator extends FilterIterator
diff --git a/src/rtText.php b/src/rtText.php
index 06580de..0fc7400 100644
--- a/src/rtText.php
+++ b/src/rtText.php
@@ -2,21 +2,9 @@
/**
* rtText
*
- * @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/
- */
-
-/**
- * Reads texts stored in texts/ subdirectory
- *
* rtText reads named texts from texts/ subdirectory
* optionally replacing %n placeholders.
- *
+ *
* @category Testing
* @package RUNTESTS
* @author Zoe Slattery <zoe@php.net>
diff --git a/src/rtUtil.php b/src/rtUtil.php
index d215d66..4dcf873 100644
--- a/src/rtUtil.php
+++ b/src/rtUtil.php
@@ -1,7 +1,16 @@
<?php
-
/**
+ * rtUtil
*
+ * Static utility methods
+ *
+ * @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 rtUtil
{