Merge pull request #15422 from artfulrobot/queue-parallel

[civicrm-core.git] / Civi / Test / HeadlessInterface.php

diff --git a/Civi/Test/HeadlessInterface.php b/Civi/Test/HeadlessInterface.php
index fb1cbf4f541645bc5b684b105b4053717a296661..95227f76856ccf292a9429451964beab8333a929 100644 (file)
--- a/Civi/Test/HeadlessInterface.php
+++ b/Civi/Test/HeadlessInterface.php
@@ -7,7 +7,7 @@ namespace Civi\Test;
  * @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.
@@ -23,15 +23,17 @@ namespace Civi\Test;
 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 `CiviTester` 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.
    *
-   * @see CiviTester
+   * @see \Civi\Test
    */
   public function setUpHeadless();