Remove globals in api docs

Author: craigtaub

lib/browser/progress.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module Progress
+*/
+
 /**
  * Expose `Progress`.
  */

lib/cli/collect-files.js

@@ -81,6 +81,7 @@ module.exports = ({ignore, extension, file, recursive, sort, spec} = {}) => {
 
 /**
  * An object to configure how Mocha gathers test files
+ * @private
  * @typedef {Object} FileCollectionOptions
  * @property {string[]} extension - File extensions to use
  * @property {string[]} spec - Files, dirs, globs to run

lib/interfaces/common.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module common
+*/
+
 var Suite = require('../suite');
 var errors = require('../errors');
 var createMissingArgumentError = errors.createMissingArgumentError;
@@ -9,6 +13,7 @@ var createForbiddenExclusivityError = errors.createForbiddenExclusivityError;
 /**
  * Functions common to more than one interface.
  *
+ * @private
  * @param {Suite[]} suites
  * @param {Context} context
  * @param {Mocha} mocha

lib/mocha.js

@@ -35,23 +35,28 @@ exports = module.exports = Mocha;
 /**
  * A Mocha instance is a finite state machine.
  * These are the states it can be in.
+ * @private
  */
 var mochaStates = utils.defineConstants({
   /**
    * Initial state of the mocha instance
+   * @private
    */
   INIT: 'init',
   /**
    * Mocha instance is running tests
+   * @private
    */
   RUNNING: 'running',
   /**
    * Mocha instance is done running tests and references to test functions and hooks are cleaned.
    * You can reset this state by unloading the test files.
+   * @private
    */
   REFERENCES_CLEANED: 'referencesCleaned',
   /**
    * Mocha instance is disposed and can no longer be used.
+   * @private
    */
   DISPOSED: 'disposed'
 });
@@ -67,6 +72,7 @@ if (!utils.isBrowser() && typeof module.paths !== 'undefined') {
 
 /**
  * Expose internals.
+ * @private
  */
 
 exports.utils = utils;
@@ -921,6 +927,7 @@ Object.defineProperty(Mocha.prototype, 'version', {
 /**
  * Callback to be invoked when test execution is complete.
  *
+ * @private
  * @callback DoneCB
  * @param {number} failures - Number of failures that occurred.
  */
@@ -1091,6 +1098,7 @@ Mocha.prototype.lazyLoadFiles = function lazyLoadFiles(enable) {
 
 /**
  * An alternative way to define root hooks that works with parallel runs.
+ * @private
  * @typedef {Object} MochaRootHookObject
  * @property {Function|Function[]} [beforeAll] - "Before all" hook(s)
  * @property {Function|Function[]} [beforeEach] - "Before each" hook(s)
@@ -1100,6 +1108,7 @@ Mocha.prototype.lazyLoadFiles = function lazyLoadFiles(enable) {
 
 /**
  * An function that returns a {@link MochaRootHookObject}, either sync or async.
+ * @private
  * @callback MochaRootHookFunction
  * @returns {MochaRootHookObject|Promise<MochaRootHookObject>}
  */

lib/nodejs/parallel-buffered-runner.js

@@ -281,12 +281,14 @@ module.exports = ParallelBufferedRunner;
 
 /**
  * Listener function intended to be bound to `Process.SIGINT` event
+ * @private
  * @callback SigIntListener
  * @returns {Promise<void>}
  */
 
 /**
  * A function accepting a test file path and returning the results of a test run
+ * @private
  * @callback FileRunner
  * @param {string} filename - File to run
  * @returns {Promise<SerializedWorkerResult>}

lib/nodejs/serializer.js

@@ -387,6 +387,7 @@ exports.SerializableWorkerResult = SerializableWorkerResult;
 /**
  * The result of calling `SerializableEvent.serialize`, as received
  * by the deserializer.
+ * @private
  * @typedef {Object} SerializedEvent
  * @property {object?} data - Optional serialized data
  * @property {object?} error - Optional serialized `Error`
@@ -395,6 +396,7 @@ exports.SerializableWorkerResult = SerializableWorkerResult;
 /**
  * The result of calling `SerializableWorkerResult.serialize` as received
  * by the deserializer.
+ * @private
  * @typedef {Object} SerializedWorkerResult
  * @property {number} failureCount - Number of failures
  * @property {SerializedEvent[]} events - Serialized events

lib/pending.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module Pending
+*/
+
 module.exports = Pending;
 
 /**

lib/runnable.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module Runnable
+*/
+
 var EventEmitter = require('events').EventEmitter;
 var Pending = require('./pending');
 var debug = require('debug')('mocha:runnable');

lib/runner.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module Runner
+*/
+
 /**
  * Module dependencies.
  */

lib/suite.js

@@ -1,5 +1,9 @@
 'use strict';
 
+/**
+ @module Suite
+*/
+
 /**
  * Module dependencies.
  */