Skip to content

Commit

Permalink
Remove a bunch of jsdoc comments that introduced wrong output
Browse files Browse the repository at this point in the history
  • Loading branch information
Munter authored and boneskull committed May 17, 2018
1 parent f4c2bf9 commit 9dc45a0
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 67 deletions.
17 changes: 3 additions & 14 deletions lib/hook.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
'use strict';
/**
* @module Hook
*
*/
/**
* Module dependencies.
*/

var Runnable = require('./runnable');
var inherits = require('./utils').inherits;
Expand All @@ -17,15 +10,12 @@ var inherits = require('./utils').inherits;
module.exports = Hook;

/**
* Initialize a new `Hook` with the given `title` and callback `fn`. Derived from
* `Runnable`.
* Initialize a new `Hook` with the given `title` and callback `fn`
*
* @memberof Mocha
* @public
* @class
* @extends Runnable
* @param {String} title
* @param {Function} fn
* @api private
*/
function Hook (title, fn) {
Runnable.call(this, title, fn);
Expand All @@ -40,11 +30,10 @@ inherits(Hook, Runnable);
/**
* Get or set the test `err`.
*
* @memberof Mocha.Hook
* @memberof Hook
* @public
* @param {Error} err
* @return {Error}
* @api public
*/
Hook.prototype.error = function (err) {
if (!arguments.length) {
Expand Down
6 changes: 1 addition & 5 deletions lib/interfaces/bdd.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
'use strict';

/**
* Module dependencies.
*/

var Test = require('../test');

/**
Expand All @@ -23,7 +19,7 @@ var Test = require('../test');
*
* @param {Suite} suite Root suite.
*/
module.exports = function (suite) {
module.exports = function bddInterface (suite) {
var suites = [suite];

suite.on('pre-require', function (context, file, mocha) {
Expand Down
5 changes: 0 additions & 5 deletions lib/interfaces/exports.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
'use strict';

/**
* Module dependencies.
*/

var Suite = require('../suite');
var Test = require('../test');

Expand Down
6 changes: 1 addition & 5 deletions lib/interfaces/qunit.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
'use strict';

/**
* Module dependencies.
*/

var Test = require('../test');

/**
Expand Down Expand Up @@ -31,7 +27,7 @@ var Test = require('../test');
*
* @param {Suite} suite Root suite.
*/
module.exports = function (suite) {
module.exports = function qUnitInterface (suite) {
var suites = [suite];

suite.on('pre-require', function (context, file, mocha) {
Expand Down
4 changes: 0 additions & 4 deletions lib/interfaces/tdd.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
'use strict';

/**
* Module dependencies.
*/

var Test = require('../test');

/**
Expand Down
5 changes: 1 addition & 4 deletions lib/mocha.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
* MIT Licensed
*/


var escapeRe = require('escape-string-regexp');
var path = require('path');
var reporters = require('./reporters');
Expand Down Expand Up @@ -54,7 +53,7 @@ exports.Test = require('./test');
/**
* Return image `name` path.
*
* @api private
* @private
* @param {string} name
* @return {string}
*/
Expand All @@ -78,10 +77,8 @@ function image (name) {
* - `fullTrace` display the full stack-trace on failing
* - `grep` string or regexp to filter tests with
*
* @public
* @class Mocha
* @param {Object} options
* @api public
*/
function Mocha (options) {
options = options || {};
Expand Down
4 changes: 0 additions & 4 deletions lib/pending.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
'use strict';

/**
* Expose `Pending`.
*/

module.exports = Pending;

/**
Expand Down
17 changes: 1 addition & 16 deletions lib/runnable.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
'use strict';
/**
* @module Runnable
*/
/**
* Module dependencies.
*/
var EventEmitter = require('events').EventEmitter;
var Pending = require('./pending');
var debug = require('debug')('mocha:runnable');
Expand All @@ -23,24 +17,15 @@ var clearTimeout = global.clearTimeout;
var clearInterval = global.clearInterval;
/* eslint-enable no-unused-vars, no-native-reassign */

/**
* Object#toString().
*/

var toString = Object.prototype.toString;

/**
* Expose `Runnable`.
*/

module.exports = Runnable;

/**
* Initialize a new `Runnable` with the given `title` and callback `fn`. Derived from [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)
*
* @memberof Mocha
* @public
* @class
* @extends EventEmitter
* @param {String} title
* @param {Function} fn
*/
Expand Down
12 changes: 2 additions & 10 deletions lib/test.js
Original file line number Diff line number Diff line change
@@ -1,23 +1,15 @@
'use strict';

/**
* Module dependencies.
*/

var Runnable = require('./runnable');
var utils = require('./utils');
var isString = utils.isString;

/**
* Expose `Test`.
*/

module.exports = Test;

/**
* Initialize a new `Test` with the given `title` and callback `fn`.
*
* @api private
* @class
* @extends Runnable
* @param {String} title
* @param {Function} fn
*/
Expand Down

0 comments on commit 9dc45a0

Please sign in to comment.