This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Minor tidy ups

  • Loading branch information...
lastcraft
lastcraft committed Apr 3, 2010
1 parent 0e91f67 commit d560894bd95d08c65412c5354b22ffecd785d6eb
Showing with 1 addition and 25 deletions.
  1. +1 −1 arguments.php
  2. +0 −24 simpletest.php
View
@@ -154,7 +154,7 @@ function __construct($overview = '') {
* @param string/array $flags Flag and alternates. Don't
* worry about leading dashes
* as these are inserted automatically.
- * @param string explanation What that flag group does.
+ * @param string $explanation What that flag group does.
*/
function explainFlag($flags, $explanation) {
$flags = is_array($flags) ? $flags : array($flags);
View
@@ -25,7 +25,6 @@ class SimpleTest {
/**
* Reads the SimpleTest version from the release file.
* @return string Version string.
- * @access public
*/
static function getVersion() {
$content = file(dirname(__FILE__) . '/VERSION');
@@ -35,10 +34,7 @@ static function getVersion() {
/**
* Sets the name of a test case to ignore, usually
* because the class is an abstract case that should
- * not be run. Once PHP4 is dropped this will disappear
- * as a public method and "abstract" will rule.
* @param string $class Add a class to ignore.
- * @access public
*/
static function ignore($class) {
$registry = &SimpleTest::getRegistry();
@@ -57,7 +53,6 @@ static function ignore($class) {
* the ignore() calls. It's just nice to have the ignore()
* calls at the top of the file before the actual declarations.
* @param array $classes Class names of interest.
- * @access public
*/
static function ignoreParentsIfIgnored($classes) {
$registry = &SimpleTest::getRegistry();
@@ -76,7 +71,6 @@ static function ignoreParentsIfIgnored($classes) {
* which can be retrieved with SimpleTest :: preferred() method.
* Instances of the same class are overwritten.
* @param object $object Preferred object
- * @access public
* @see preferred()
*/
static function prefer($object) {
@@ -89,7 +83,6 @@ static function prefer($object) {
* can be applied in order to retrieve the object of the specific
* class
* @param array|string $classes Allowed classes or interfaces.
- * @access public
* @return array|object|null
* @see prefer()
*/
@@ -116,7 +109,6 @@ static function preferred($classes) {
* use it.
* @param string $class Class name to test.
* @return boolean True if should not be run.
- * @access public
*/
static function isIgnored($class) {
$registry = &SimpleTest::getRegistry();
@@ -131,7 +123,6 @@ static function isIgnored($class) {
* @param string $proxy Proxy host as URL.
* @param string $username Proxy username for authentication.
* @param string $password Proxy password for authentication.
- * @access public
*/
static function useProxy($proxy, $username = false, $password = false) {
$registry = &SimpleTest::getRegistry();
@@ -143,7 +134,6 @@ static function useProxy($proxy, $username = false, $password = false) {
/**
* Accessor for default proxy host.
* @return string Proxy URL.
- * @access public
*/
static function getDefaultProxy() {
$registry = &SimpleTest::getRegistry();
@@ -153,7 +143,6 @@ static function getDefaultProxy() {
/**
* Accessor for default proxy username.
* @return string Proxy username for authentication.
- * @access public
*/
static function getDefaultProxyUsername() {
$registry = &SimpleTest::getRegistry();
@@ -163,7 +152,6 @@ static function getDefaultProxyUsername() {
/**
* Accessor for default proxy password.
* @return string Proxy password for authentication.
- * @access public
*/
static function getDefaultProxyPassword() {
$registry = &SimpleTest::getRegistry();
@@ -195,7 +183,6 @@ static function setParsers($parsers) {
/**
* Accessor for global registry of options.
* @return hash All stored values.
- * @access private
*/
protected static function &getRegistry() {
static $registry = false;
@@ -209,7 +196,6 @@ protected static function &getRegistry() {
* Accessor for the context of the current
* test run.
* @return SimpleTestContext Current test run.
- * @access public
*/
static function getContext() {
static $context = false;
@@ -222,7 +208,6 @@ static function getContext() {
/**
* Constant default values.
* @return hash All registry defaults.
- * @access private
*/
protected static function getDefaults() {
return array(
@@ -278,7 +263,6 @@ function clear() {
* global instance can be used by the mock objects
* to send message to the test cases.
* @param SimpleTestCase $test Test case to register.
- * @access public
*/
function setTest($test) {
$this->clear();
@@ -288,7 +272,6 @@ function setTest($test) {
/**
* Accessor for currently running test case.
* @return SimpleTestCase Current test.
- * @access public
*/
function getTest() {
return $this->test;
@@ -299,7 +282,6 @@ function getTest() {
* global instance can be used by the mock objects
* to send messages.
* @param SimpleReporter $reporter Reporter to register.
- * @access public
*/
function setReporter($reporter) {
$this->clear();
@@ -309,7 +291,6 @@ function setReporter($reporter) {
/**
* Accessor for current reporter.
* @return SimpleReporter Current reporter.
- * @access public
*/
function getReporter() {
return $this->reporter;
@@ -318,7 +299,6 @@ function getReporter() {
/**
* Accessor for the Singleton resource.
* @return object Global resource.
- * @access public
*/
function get($resource) {
if (! isset($this->resources[$resource])) {
@@ -352,7 +332,6 @@ function __construct($prefixes) {
* @param array $stack List of stack frames.
* @return string Snippet of test report with line
* number and file.
- * @access public
*/
function traceMethod($stack = false) {
$stack = $stack ? $stack : $this->captureTrace();
@@ -371,7 +350,6 @@ function traceMethod($stack = false) {
* Test to see if error is generated by SimpleTest itself.
* @param array $frame PHP stack frame.
* @return boolean True if a SimpleTest file.
- * @access private
*/
protected function frameLiesWithinSimpleTestFolder($frame) {
if (isset($frame['file'])) {
@@ -389,7 +367,6 @@ protected function frameLiesWithinSimpleTestFolder($frame) {
* Tries to determine if the method call is an assert, etc.
* @param array $frame PHP stack frame.
* @return boolean True if matches a target.
- * @access private
*/
protected function frameMatchesPrefix($frame) {
foreach ($this->prefixes as $prefix) {
@@ -403,7 +380,6 @@ protected function frameMatchesPrefix($frame) {
/**
* Grabs a current stack trace.
* @return array Fulle trace.
- * @access private
*/
protected function captureTrace() {
if (function_exists('debug_backtrace')) {

0 comments on commit d560894

Please sign in to comment.