* @package Civi\Test
*
* To run your test against a fake, headless database, flag it with the
- * HeadlessInterface. CiviTestListener will automatically boot
+ * HeadlessInterface. CiviTestListener will automatically boot Civi.
*
* Alternatively, if you wish to run a test in a live (CMS-enabled) environment,
* flag it with EndToEndInterface.
interface HeadlessInterface {
/**
- * The setupHeadless functions runs at the start of each test case.
+ * The setupHeadless function runs at the start of each test case, right before
+ * the headless environment reboots.
+ *
* It should perform any necessary steps required for putting the database
* in a consistent baseline -- such as loading schema and extensions.
*
- * The utility class `\Civi\Test` provides a number of helper functions
+ * The utility `\Civi\Test::headless()` provides a number of helper functions
* for managing this setup, and it includes optimizations to avoid redundant
* setup work.
*