remove unsupported @api tag in docstrings

mochajs · Nov 30, 2018 · 4bef574 · 4bef574
1 parent 955a71e
commit 4bef574
Show file tree

Hide file tree

Showing 19 changed files with 89 additions and 117 deletions.
diff --git a/lib/browser/progress.js b/lib/browser/progress.js
@@ -19,7 +19,7 @@ function Progress() {
 /**
  * Set progress size to `size`.
  *
- * @api public
+ * @public
  * @param {number} size
  * @return {Progress} Progress instance.
  */
@@ -31,7 +31,7 @@ Progress.prototype.size = function(size) {
 /**
  * Set text to `text`.
  *
- * @api public
+ * @public
  * @param {string} text
  * @return {Progress} Progress instance.
  */
@@ -43,7 +43,7 @@ Progress.prototype.text = function(text) {
 /**
  * Set font size to `size`.
  *
- * @api public
+ * @public
  * @param {number} size
  * @return {Progress} Progress instance.
  */

diff --git a/lib/context.js b/lib/context.js
@@ -11,14 +11,14 @@ module.exports = Context;
 /**
  * Initialize a new `Context`.
  *
- * @api private
+ * @private
  */
 function Context() {}
 
 /**
  * Set or get the context `Runnable` to `runnable`.
  *
- * @api private
+ * @private
  * @param {Runnable} runnable
  * @return {Context} context
  */
@@ -33,7 +33,7 @@ Context.prototype.runnable = function(runnable) {
 /**
  * Set or get test timeout `ms`.
  *
- * @api private
+ * @private
  * @param {number} ms
  * @return {Context} self
  */
@@ -48,7 +48,7 @@ Context.prototype.timeout = function(ms) {
 /**
  * Set test timeout `enabled`.
  *
- * @api private
+ * @private
  * @param {boolean} enabled
  * @return {Context} self
  */
@@ -63,7 +63,7 @@ Context.prototype.enableTimeouts = function(enabled) {
 /**
  * Set or get test slowness threshold `ms`.
  *
- * @api private
+ * @private
  * @param {number} ms
  * @return {Context} self
  */
@@ -78,7 +78,7 @@ Context.prototype.slow = function(ms) {
 /**
  * Mark a test as skipped.
  *
- * @api private
+ * @private
  * @throws Pending
  */
 Context.prototype.skip = function() {
@@ -88,7 +88,7 @@ Context.prototype.skip = function() {
 /**
  * Set or get a number of allowed retries on failed tests
  *
- * @api private
+ * @private
  * @param {number} n
  * @return {Context} self
  */

diff --git a/lib/reporters/base.js b/lib/reporters/base.js
@@ -105,7 +105,7 @@ if (process.platform === 'win32') {
  * @param {string} type
  * @param {string} str
  * @return {string}
- * @api private
+ * @private
  */
 var color = (exports.color = function(type, str) {
   if (!exports.useColors) {
@@ -198,7 +198,6 @@ var generateDiff = (exports.generateDiff = function(actual, expected) {
  * @memberof Mocha.reporters.Base
  * @variation 1
  * @param {Array} failures
- * @api public
  */
 
 exports.list = function(failures) {
@@ -279,7 +278,6 @@ exports.list = function(failures) {
  * @public
  * @class
  * @param {Runner} runner
- * @api public
  */
 
 function Base(runner) {
@@ -353,7 +351,6 @@ function Base(runner) {
  *
  * @memberof Mocha.reporters.Base
  * @public
- * @api public
  */
 Base.prototype.epilogue = function() {
   var stats = this.stats;
@@ -392,7 +389,7 @@ Base.prototype.epilogue = function() {
 /**
  * Pad the given `str` to `len`.
  *
- * @api private
+ * @private
  * @param {string} str
  * @param {string} len
  * @return {string}
@@ -405,7 +402,7 @@ function pad(str, len) {
 /**
  * Returns an inline diff between 2 strings with coloured ANSI output.
  *
- * @api private
+ * @private
  * @param {String} actual
  * @param {String} expected
  * @return {string} Diff
@@ -442,7 +439,7 @@ function inlineDiff(actual, expected) {
 /**
  * Returns a unified diff between two strings with coloured ANSI output.
  *
- * @api private
+ * @private
  * @param {String} actual
  * @param {String} expected
  * @return {string} The diff.
@@ -485,7 +482,7 @@ function unifiedDiff(actual, expected) {
 /**
  * Return a character diff for `err`.
  *
- * @api private
+ * @private
  * @param {String} actual
  * @param {String} expected
  * @return {string} the diff
@@ -508,7 +505,7 @@ function errorDiff(actual, expected) {
 /**
  * Color lines for `str`, using the color `name`.
  *
- * @api private
+ * @private
  * @param {string} name
  * @param {string} str
  * @return {string}
@@ -530,7 +527,7 @@ var objToString = Object.prototype.toString;
 /**
  * Check that a / b have the same type.
  *
- * @api private
+ * @private
  * @param {Object} a
  * @param {Object} b
  * @return {boolean}

diff --git a/lib/reporters/doc.js b/lib/reporters/doc.js
@@ -23,7 +23,6 @@ exports = module.exports = Doc;
  * @extends {Base}
  * @public
  * @param {Runner} runner
- * @api public
  */
 function Doc(runner) {
   Base.call(this, runner);

diff --git a/lib/reporters/dot.js b/lib/reporters/dot.js
@@ -22,7 +22,6 @@ exports = module.exports = Dot;
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
  * @public
- * @api public
  * @param {Runner} runner
  */
 function Dot(runner) {

diff --git a/lib/reporters/html.js b/lib/reporters/html.js
@@ -53,7 +53,6 @@ var playIcon = '&#x2023;';
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function HTML(runner) {

diff --git a/lib/reporters/json.js b/lib/reporters/json.js
@@ -21,7 +21,6 @@ exports = module.exports = JSONReporter;
  * @class JSON
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function JSONReporter(runner) {
@@ -68,7 +67,7 @@ function JSONReporter(runner) {
  * Return a plain-object representation of `test`
  * free of cyclic properties etc.
  *
- * @api private
+ * @private
  * @param {Object} test
  * @return {Object}
  */
@@ -90,7 +89,7 @@ function clean(test) {
 /**
  * Replaces any circular references inside `obj` with '[object Object]'
  *
- * @api private
+ * @private
  * @param {Object} obj
  * @return {Object}
  */
@@ -114,7 +113,7 @@ function cleanCycles(obj) {
 /**
  * Transform an Error object into a JSON object.
  *
- * @api private
+ * @private
  * @param {Error} err
  * @return {Object}
  */

diff --git a/lib/reporters/landing.js b/lib/reporters/landing.js
@@ -42,7 +42,6 @@ Base.colors.runway = 90;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function Landing(runner) {

diff --git a/lib/reporters/list.js b/lib/reporters/list.js
@@ -24,7 +24,6 @@ exports = module.exports = List;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function List(runner) {

diff --git a/lib/reporters/markdown.js b/lib/reporters/markdown.js
@@ -28,7 +28,6 @@ exports = module.exports = Markdown;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function Markdown(runner) {

diff --git a/lib/reporters/min.js b/lib/reporters/min.js
@@ -22,7 +22,6 @@ exports = module.exports = Min;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function Min(runner) {

diff --git a/lib/reporters/nyan.js b/lib/reporters/nyan.js
@@ -19,7 +19,6 @@ exports = module.exports = NyanCat;
  * Initialize a new `Dot` matrix test reporter.
  *
  * @param {Runner} runner
- * @api public
  * @public
  * @class Nyan
  * @memberof Mocha.reporters
@@ -75,7 +74,7 @@ inherits(NyanCat, Base);
 /**
  * Draw the nyan cat
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.draw = function() {
@@ -90,7 +89,7 @@ NyanCat.prototype.draw = function() {
  * Draw the "scoreboard" showing the number
  * of passes, failures and pending tests.
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.drawScoreboard = function() {
@@ -113,7 +112,7 @@ NyanCat.prototype.drawScoreboard = function() {
 /**
  * Append the rainbow.
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.appendRainbow = function() {
@@ -132,7 +131,7 @@ NyanCat.prototype.appendRainbow = function() {
 /**
  * Draw the rainbow.
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.drawRainbow = function() {
@@ -150,7 +149,7 @@ NyanCat.prototype.drawRainbow = function() {
 /**
  * Draw the nyan cat
  *
- * @api private
+ * @private
  */
 NyanCat.prototype.drawNyanCat = function() {
   var self = this;
@@ -184,7 +183,7 @@ NyanCat.prototype.drawNyanCat = function() {
 /**
  * Draw nyan cat face.
  *
- * @api private
+ * @private
  * @return {string}
  */
 
@@ -203,7 +202,7 @@ NyanCat.prototype.face = function() {
 /**
  * Move cursor up `n`.
  *
- * @api private
+ * @private
  * @param {number} n
  */
 
@@ -214,7 +213,7 @@ NyanCat.prototype.cursorUp = function(n) {
 /**
  * Move cursor down `n`.
  *
- * @api private
+ * @private
  * @param {number} n
  */
 
@@ -225,7 +224,7 @@ NyanCat.prototype.cursorDown = function(n) {
 /**
  * Generate rainbow colors.
  *
- * @api private
+ * @private
  * @return {Array}
  */
 NyanCat.prototype.generateColors = function() {
@@ -246,7 +245,7 @@ NyanCat.prototype.generateColors = function() {
 /**
  * Apply rainbow to the given `str`.
  *
- * @api private
+ * @private
  * @param {string} str
  * @return {string}
  */

diff --git a/lib/reporters/progress.js b/lib/reporters/progress.js
@@ -30,7 +30,6 @@ Base.colors.progress = 90;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  * @param {Object} options
  */

diff --git a/lib/reporters/spec.js b/lib/reporters/spec.js
@@ -23,7 +23,6 @@ exports = module.exports = Spec;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function Spec(runner) {

diff --git a/lib/reporters/xunit.js b/lib/reporters/xunit.js
@@ -39,7 +39,6 @@ exports = module.exports = XUnit;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
 function XUnit(runner, options) {