Skip to content

Commit

Permalink
Correcting doc blocks.
Browse files Browse the repository at this point in the history
  • Loading branch information
markstory committed Jan 10, 2010
1 parent 1e0215b commit 8a56793
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions cake/tests/lib/test_manager.php
Expand Up @@ -97,6 +97,7 @@ function _installSimpleTest() {
* @param boolean $testing Are tests supposed to be auto run. Set to true to return testcase list.
* @return mixed
* @access public
* @static
*/
function runAllTests(&$reporter, $testing = false) {
$manager =& new TestManager();
Expand Down Expand Up @@ -181,6 +182,7 @@ function runGroupTest($groupTestName, &$reporter) {
* @param string $directory The directory to add tests from.
* @return void
* @access public
* @static
*/
function addTestCasesFromDirectory(&$groupTest, $directory = '.') {
$manager =& new TestManager();
Expand All @@ -197,6 +199,7 @@ function addTestCasesFromDirectory(&$groupTest, $directory = '.') {
* @param string $file The file name, minus the suffix to add.
* @return void
* @access public
* @static
*/
function addTestFile(&$groupTest, $file) {
$manager =& new TestManager();
Expand All @@ -223,6 +226,7 @@ function &getTestCaseList() {
/**
* Builds the list of test cases from a given directory
*
* @param string $directory Directory to get test case list from.
* @access public
*/
function &_getTestCaseList($directory = '.') {
Expand All @@ -237,7 +241,8 @@ function &_getTestCaseList($directory = '.') {
/**
* Returns a list of test files from a given directory
*
* @access public
* @param string $directory Directory to get test case files from.
* @access protected
*/
function &_getTestFileList($directory = '.') {
$return = $this->_getRecursiveFileList($directory, array(&$this, '_isTestCaseFile'));
Expand All @@ -248,6 +253,7 @@ function &_getTestFileList($directory = '.') {
* Returns a list of group tests found in the current valid test case path
*
* @access public
* @static
*/
function &getGroupTestList() {
$manager =& new TestManager();
Expand All @@ -259,7 +265,7 @@ function &getGroupTestList() {
* Returns a list of group test files from a given directory
*
* @param string $directory The directory to get group test files from.
* @access public
* @access protected
*/
function &_getTestGroupFileList($directory = '.') {
$return = $this->_getRecursiveFileList($directory, array(&$this, '_isTestGroupFile'));
Expand All @@ -270,7 +276,7 @@ function &_getTestGroupFileList($directory = '.') {
* Returns a list of group test files from a given directory
*
* @param string $directory The directory to get group tests from.
* @access public
* @access protected
*/
function &_getTestGroupList($directory = '.') {
$fileList =& $this->_getTestGroupFileList($directory);
Expand All @@ -287,7 +293,7 @@ function &_getTestGroupList($directory = '.') {
* Returns a list of class names from a group test file
*
* @param string $groupTestFile The groupTest file to scan for TestSuite classnames.
* @access public
* @access protected
*/
function &_getGroupTestClassNames($groupTestFile) {
$file = implode("\n", file($groupTestFile));
Expand All @@ -306,7 +312,7 @@ function &_getGroupTestClassNames($groupTestFile) {
*
* @param string $directory The directory to scan for files.
* @param mixed $fileTestFunction
* @access public
* @access protected
*/
function &_getRecursiveFileList($directory = '.', $fileTestFunction) {
$fileList = array();
Expand All @@ -332,7 +338,7 @@ function &_getRecursiveFileList($directory = '.', $fileTestFunction) {
*
* @param string $file
* @return void
* @access public
* @access protected
*/
function _isTestCaseFile($file) {
return $this->_hasExpectedExtension($file, $this->_testExtension);
Expand All @@ -343,7 +349,7 @@ function _isTestCaseFile($file) {
*
* @param string $file
* @return void
* @access public
* @access protected
*/
function _isTestGroupFile($file) {
return $this->_hasExpectedExtension($file, $this->_groupExtension);
Expand All @@ -355,7 +361,7 @@ function _isTestGroupFile($file) {
* @param string $file
* @param string $extension
* @return void
* @access public
* @access protected
*/
function _hasExpectedExtension($file, $extension) {
return $extension == strtolower(substr($file, (0 - strlen($extension))));
Expand All @@ -366,7 +372,7 @@ function _hasExpectedExtension($file, $extension) {
*
* @param string $type either 'cases' or 'groups'
* @return string The path tests are located on
* @access public
* @access protected
*/
function _getTestsPath($type = 'cases') {
if (!empty($this->appTest)) {
Expand Down

0 comments on commit 8a56793

Please sign in to comment.