Docs: Improve documentation for tests/phpunit/includes/testcase-ajax.php.

Props andizer, SergeyBiryukov.
Fixes #47568.

git-svn-id: https://develop.svn.wordpress.org/trunk@47041 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-01-05 15:31:10 +00:00
parent 5f600eb32a
commit cd5b7df8b8
2 changed files with 38 additions and 35 deletions

View File

@@ -5,13 +5,14 @@ class WP_Tests_Exception extends PHPUnit_Framework_Exception {
}
/**
* General exception for wp_die()
* General exception for wp_die().
*/
class WPDieException extends Exception {}
/**
* Exception for cases of wp_die(), for ajax tests.
* This means there was an error (no output, and a call to wp_die)
* Exception for cases of wp_die(), for Ajax tests.
*
* This means there was an error (no output, and a call to wp_die).
*
* @package WordPress
* @subpackage Unit Tests
@@ -20,11 +21,11 @@ class WPDieException extends Exception {}
class WPAjaxDieStopException extends WPDieException {}
/**
* Exception for cases of wp_die(), for ajax tests.
* This means execution of the ajax function should be halted, but the unit
* test can continue. The function finished normally and there was not an
* error (output happened, but wp_die was called to end execution) This is
* used with WP_Ajax_Response::send
* Exception for cases of wp_die(), for Ajax tests.
*
* This means the execution of the Ajax function should be halted, but the unit test
* can continue. The function finished normally and there was no error (output happened,
* but wp_die was called to end execution). This is used with WP_Ajax_Response::send().
*
* @package WordPress
* @subpackage Unit Tests