docs(tests): docs qa

flex-development · May 23, 2022 · 35cd18f · 35cd18f
1 parent 8afd47e
commit 35cd18f
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 16 deletions.
diff --git a/__tests__/config/global-fixtures.ts b/__tests__/config/global-fixtures.ts
@@ -1,6 +1,6 @@
 /**
  * @file Test Configuration - Global Fixtures
- * @module tests/config/globalFixtures
+ * @module tests/config/global-fixtures
  * @see https://mochajs.org/#global-setup-fixtures
  * @see https://mochajs.org/#global-teardown-fixtures
  */

diff --git a/__tests__/config/root-hooks.ts b/__tests__/config/root-hooks.ts
@@ -1,12 +1,19 @@
 /**
  * @file Test Configuration - Root Hooks
- * @module tests/config/rootHooks
- * @see https://mochajs.org/#defining-a-root-hook-plugin
+ * @module tests/config/root-hooks
  */
 
 import type { RootHookObject } from 'mocha'
 import { inspect } from 'node:util'
 
+/**
+ * Root hooks.
+ *
+ * These functions run before or after **every test in every file**.
+ *
+ * @see https://mochajs.org/#available-root-hooks
+ * @see https://mochajs.org/#defining-a-root-hook-plugin
+ */
 export const mochaHooks: RootHookObject = {
   /**
    * Handles the test environment state after all tests are run.
@@ -25,8 +32,8 @@ export const mochaHooks: RootHookObject = {
    * - Resetting the history of all [stubs][1] created via the default sandbox
    * - Restoring all [fakes][2] created via the default sandbox
    *
-   * [1]: https://sinonjs.org/releases/v11.1.2/stubs
-   * [2]: https://sinonjs.org/releases/v11.1.2/fakes
+   * [1]: https://sinonjs.org/releases/v14/stubs
+   * [2]: https://sinonjs.org/releases/v14/fakes
    *
    * @param {Mocha.Context} this - Current test context
    * @return {void} Nothing when complete

diff --git a/__tests__/interfaces/index.ts b/__tests__/interfaces/index.ts
@@ -1,5 +1,5 @@
 /**
- * @file Entry Point - Global Test Interfaces
+ * @file Entry Point - Test Environment Interfaces
  * @module tests/interfaces
  */
 

diff --git a/__tests__/interfaces/report.interface.ts b/__tests__/interfaces/report.interface.ts
@@ -1,9 +1,9 @@
 /**
- * @file Test Interfaces - Report
+ * @file Test Environment Interfaces - Report
  * @module tests/interfaces/Report
  */
 
-import type { MochaSuiteSummary, MochaTestSummary } from '@tests/types'
+import type { MochaSuiteSummary, MochaTestSummary } from '../types'
 
 /**
  * Custom test reporter output.

diff --git a/__tests__/interfaces/reporter-options.interface.ts b/__tests__/interfaces/reporter-options.interface.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Interfaces - ReporterOptions
+ * @file Test Environment Interfaces - ReporterOptions
  * @module tests/interfaces/ReporterOptions
  */
 

diff --git a/__tests__/interfaces/spy.interface.ts b/__tests__/interfaces/spy.interface.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Interfaces - Spy
+ * @file Test Environment Interfaces - Spy
  * @module tests/interfaces/Spy
  */
 

diff --git a/__tests__/interfaces/testcase-called.interface.ts b/__tests__/interfaces/testcase-called.interface.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Interfaces - TestcaseCalled
+ * @file Test Environment Interfaces - TestcaseCalled
  * @module tests/interfaces/TestcaseCalled
  */
 

diff --git a/__tests__/interfaces/testcase-fn.interface.ts b/__tests__/interfaces/testcase-fn.interface.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Interfaces - TestcaseFn
+ * @file Test Environment Interfaces - TestcaseFn
  * @module tests/interfaces/TestcaseFn
  */
 

diff --git a/__tests__/interfaces/testcase.interface.ts b/__tests__/interfaces/testcase.interface.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Interfaces - Testcase
+ * @file Test Environment Interfaces - Testcase
  * @module tests/interfaces/Testcase
  */
 

diff --git a/__tests__/types/index.ts b/__tests__/types/index.ts
@@ -1,5 +1,5 @@
 /**
- * @file Entry Point - Test Type Definitions
+ * @file Entry Point - Test Environment Types
  * @module tests/types
  */
 

diff --git a/__tests__/types/mocha-suite-summary.type.ts b/__tests__/types/mocha-suite-summary.type.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Type Definitions - MochaSuiteSummary
+ * @file Test Environment Types - MochaSuiteSummary
  * @module tests/types/MochaSuiteSummary
  */
 

diff --git a/__tests__/types/mocha-test-summary.type.ts b/__tests__/types/mocha-test-summary.type.ts
@@ -1,5 +1,5 @@
 /**
- * @file Test Type Definitions - MochaTestSummary
+ * @file Test Environment Types - MochaTestSummary
  * @module tests/types/MochaTestSummary
  */