make lib/stats-collector a private API

mochajs · Dec 13, 2018 · 6160a6a · 6160a6a
1 parent 0ed25c6
commit 6160a6a
Showing 1 changed file with 14 additions and 5 deletions.
diff --git a/lib/stats-collector.js b/lib/stats-collector.js
@@ -1,8 +1,15 @@
 'use strict';
 
+/**
+ * Provides a factory function for a {@link StatsCollector} object.
+ * @private
+ * @module
+ */
+
 /**
  * Test statistics collector.
  *
+ * @private
  * @typedef {Object} StatsCollector
  * @property {number} suites - integer count of suites run.
  * @property {number} tests - integer count of tests run.
@@ -15,14 +22,16 @@
  */
 
 /**
- * Provides stats such as test duration,
- * number of tests passed / failed etc.
+ * Provides stats such as test duration, number of tests passed / failed etc., by listening for events emitted by `runner`.
  *
- * @public
- * @memberof Mocha
- * @param {Runner} runner
+ * @private
+ * @param {Runner} runner - Runner instance
+ * @throws {TypeError} If falsy `runner`
  */
 function createStatsCollector(runner) {
+  /**
+   * @type StatsCollector
+   */
   var stats = {
     suites: 0,
     tests: 0,