* Prints status updates on stdout and counts up the total
* number and percentage of passed tests.
*
- * @param array of strings $filenames
- * @return bool True if passed all tests, false if any tests failed.
+ * @param $filenames Array of strings
+ * @return Boolean: true if passed all tests, false if any tests failed.
*/
public function runTestsFromFiles( $filenames ) {
$this->recorder->start();
* and compare the output against the expected results.
* Prints status and explanatory messages to stdout.
*
- * @param string $input Wikitext to try rendering
- * @param string $result Result to output
- * @return bool
+ * @param $desc String: test's description
+ * @param $input String: wikitext to try rendering
+ * @param $result String: result to output
+ * @param $opts Array: test's options
+ * @param $config String: overrides for global variables, one per line
+ * @return Boolean
*/
public function runTest( $desc, $input, $result, $opts, $config ) {
if( $this->showProgress ) {
/**
* Use a regex to find out the value of an option
- * @param $key name of option val to retrieve
+ * @param $key String: name of option val to retrieve
* @param $opts Options array to look in
- * @param $defaults Default value returned if not found
+ * @param $default Mixed: default value returned if not found
*/
private static function getOptionValue( $key, $opts, $default ) {
$key = strtolower( $key );
/**
* Create a dummy uploads directory which will contain a couple
* of files in order to pass existence tests.
- * @return string The directory
+ *
+ * @return String: the directory
*/
private function setupUploadDir() {
global $IP;
/**
* Delete the specified files, if they exist.
- * @param array $files full paths to files to delete.
+ * @param $files Array: full paths to files to delete.
*/
private static function deleteFiles( $files ) {
foreach( $files as $file ) {
/**
* Delete the specified directories, if they exist. Must be empty.
- * @param array $dirs full paths to directories to delete.
+ * @param $dirs Array: full paths to directories to delete.
*/
private static function deleteDirs( $dirs ) {
foreach( $dirs as $dir ) {
/**
* Print a happy success message.
*
- * @param string $desc The test name
- * @return bool
+ * @param $desc String: the test name
+ * @return Boolean
*/
protected function showSuccess( $desc ) {
if( $this->showProgress ) {
* Print a failure message and provide some explanatory output
* about what went wrong if so configured.
*
- * @param string $desc The test name
- * @param string $result Expected HTML output
- * @param string $html Actual HTML output
- * @return bool
+ * @param $desc String: the test name
+ * @param $result String: expected HTML output
+ * @param $html String: actual HTML output
+ * @return Boolean
*/
protected function showFailure( $desc, $result, $html ) {
if( $this->showFailure ) {
* Run given strings through a diff and return the (colorized) output.
* Requires writable /tmp directory and a 'diff' command in the PATH.
*
- * @param string $input
- * @param string $output
- * @param string $inFileTail Tailing for the input file name
- * @param string $outFileTail Tailing for the output file name
- * @return string
+ * @param $input String
+ * @param $output String
+ * @param $inFileTail String: tailing for the input file name
+ * @param $outFileTail String: tailing for the output file name
+ * @return String
*/
protected function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
$prefix = wfTempDir() . "/mwParser-" . mt_rand();
/**
* Write the given string to a file, adding a final newline.
*
- * @param string $data
- * @param string $filename
+ * @param $data String
+ * @param $filename String
*/
private function dumpToFile( $data, $filename ) {
$file = fopen( $filename, "wt" );
* Colorize unified diff output if set for ANSI color output.
* Subtractions are colored blue, additions red.
*
- * @param string $text
- * @return string
+ * @param $text String
+ * @return String
*/
protected function colorDiff( $text ) {
return preg_replace(
/**
* Show "Reading tests from ..."
*
- * @param String $path
+ * @param $path String
*/
public function showRunFile( $path ){
print $this->term->color( 1 ) .
/**
* Insert a temporary test article
- * @param string $name the title, including any prefix
- * @param string $text the article text
- * @param int $line the input line number, for reporting errors
+ * @param $name String: the title, including any prefix
+ * @param $text String: the article text
+ * @param $line Integer: the input line number, for reporting errors
*/
public function addArticle($name, $text, $line) {
$this->setupGlobals();
* Steal a callback function from the primary parser, save it for
* application to our scary parser. If the hook is not installed,
* die a painful dead to warn the others.
- * @param string $name
+ *
+ * @param $name String
*/
public function requireHook( $name ) {
global $wgParser;
* Steal a callback function from the primary parser, save it for
* application to our scary parser. If the hook is not installed,
* die a painful dead to warn the others.
- * @param string $name
+ *
+ * @param $name String
*/
private function requireFunctionHook( $name ) {
global $wgParser;
* Run the "tidy" command on text if the $wgUseTidy
* global is true
*
- * @param string $text the text to tidy
- * @return string
+ * @param $text String: the text to tidy
+ * @return String
* @static
*/
private function tidy( $text ) {
/**
* Return ANSI terminal escape code for changing text attribs/color
*
- * @param string $color Semicolon-separated list of attribute/color codes
- * @return string
+ * @param $color String: semicolon-separated list of attribute/color codes
+ * @return String
*/
public function color( $color ) {
global $wgCommandLineDarkBg;
/**
* Return ANSI terminal escape code for restoring default text attributes
*
- * @return string
+ * @return String
*/
public function reset() {
return $this->color( 0 );
/**
* Record an individual test item's success or failure to the db
- * @param string $test
- * @param bool $result
+ *
+ * @param $test String
+ * @param $result Boolean
*/
function record( $test, $result ) {
parent::record( $test, $result );
/**
* Inform a CodeReview instance that we've started or completed a test run...
- * @param $remote array: info on remote target
+ *
* @param $status string: "running" - tell it we've started
* "complete" - provide test results array
* "abort" - something went horribly awry
- * @param $data array of test name => true/false
+ * @param $results array of test name => true/false
*/
function ping( $status, $results=false ) {
global $wgParserTestRemote, $IP;
dépôts / lhc / web / wiklou.git / commitdiff