diff --git a/lib/chai/utils/addChainableMethod.js b/lib/chai/utils/addChainableMethod.js index ff3b154a9..7cb4e495b 100644 --- a/lib/chai/utils/addChainableMethod.js +++ b/lib/chai/utils/addChainableMethod.js @@ -33,7 +33,7 @@ var call = Function.prototype.call, apply = Function.prototype.apply; /** - * ### addChainableMethod (ctx, name, method, chainingBehavior) + * ### .addChainableMethod(ctx, name, method, chainingBehavior) * * Adds a method to an object, such that the method can also be chained. * diff --git a/lib/chai/utils/addLengthGuard.js b/lib/chai/utils/addLengthGuard.js index f74c7a0cc..1f27e8b25 100644 --- a/lib/chai/utils/addLengthGuard.js +++ b/lib/chai/utils/addLengthGuard.js @@ -9,7 +9,7 @@ var fnLengthDesc = Object.getOwnPropertyDescriptor(function () {}, 'length'); */ /** - * # addLengthGuard(fn, assertionName, isChainable) + * ### .addLengthGuard(fn, assertionName, isChainable) * * Define `length` as a getter on the given uninvoked method assertion. The * getter acts as a guard against chaining `length` directly off of an uninvoked diff --git a/lib/chai/utils/addMethod.js b/lib/chai/utils/addMethod.js index a5d32060a..56bd5b818 100644 --- a/lib/chai/utils/addMethod.js +++ b/lib/chai/utils/addMethod.js @@ -11,7 +11,7 @@ var proxify = require('./proxify'); var transferFlags = require('./transferFlags'); /** - * ### .addMethod (ctx, name, method) + * ### .addMethod(ctx, name, method) * * Adds a method to the prototype of an object. * diff --git a/lib/chai/utils/addProperty.js b/lib/chai/utils/addProperty.js index f58400e5d..d3757e6c4 100644 --- a/lib/chai/utils/addProperty.js +++ b/lib/chai/utils/addProperty.js @@ -10,7 +10,7 @@ var isProxyEnabled = require('./isProxyEnabled'); var transferFlags = require('./transferFlags'); /** - * ### addProperty (ctx, name, getter) + * ### .addProperty(ctx, name, getter) * * Adds a property to the prototype of an object. * diff --git a/lib/chai/utils/compareByInspect.js b/lib/chai/utils/compareByInspect.js index 708ff28c0..fde48d46c 100644 --- a/lib/chai/utils/compareByInspect.js +++ b/lib/chai/utils/compareByInspect.js @@ -11,7 +11,7 @@ var inspect = require('./inspect'); /** - * ### .compareByInspect (mixed, mixed) + * ### .compareByInspect(mixed, mixed) * * To be used as a compareFunction with Array.prototype.sort. Compares elements * using inspect instead of default behavior of using toString so that Symbols diff --git a/lib/chai/utils/expectTypes.js b/lib/chai/utils/expectTypes.js index 4b0bd4564..48d842f7a 100644 --- a/lib/chai/utils/expectTypes.js +++ b/lib/chai/utils/expectTypes.js @@ -5,7 +5,7 @@ */ /** - * ### expectTypes(obj, types) + * ### .expectTypes(obj, types) * * Ensures that the object being tested against is of a valid type. * diff --git a/lib/chai/utils/flag.js b/lib/chai/utils/flag.js index ffb48f068..dd53bfbf8 100644 --- a/lib/chai/utils/flag.js +++ b/lib/chai/utils/flag.js @@ -5,7 +5,7 @@ */ /** - * ### flag(object, key, [value]) + * ### .flag(object, key, [value]) * * Get or set a flag value on an object. If a * value is provided it will be set, else it will diff --git a/lib/chai/utils/getActual.js b/lib/chai/utils/getActual.js index 2b5b3fa5f..976e11259 100644 --- a/lib/chai/utils/getActual.js +++ b/lib/chai/utils/getActual.js @@ -5,7 +5,7 @@ */ /** - * # getActual(object, [actual]) + * ### .getActual(object, [actual]) * * Returns the `actual` value for an Assertion. * diff --git a/lib/chai/utils/inspect.js b/lib/chai/utils/inspect.js index edbc55c5c..af2cdb185 100644 --- a/lib/chai/utils/inspect.js +++ b/lib/chai/utils/inspect.js @@ -9,12 +9,14 @@ var config = require('../config'); module.exports = inspect; /** + * ### .inspect(obj, [showHidden], [depth], [colors]) + * * Echoes the value of a value. Tries to print the value out * in the best way possible given the different types. * * @param {Object} obj The object to print out. * @param {Boolean} showHidden Flag that shows hidden (not enumerable) - * properties of objects. + * properties of objects. Default is false. * @param {Number} depth Depth in which to descend in object. Default is 2. * @param {Boolean} colors Flag to turn on ANSI escape codes to color the * output. Default is false (no coloring). diff --git a/lib/chai/utils/isNaN.js b/lib/chai/utils/isNaN.js index 113256d7f..d64f7f4aa 100644 --- a/lib/chai/utils/isNaN.js +++ b/lib/chai/utils/isNaN.js @@ -5,7 +5,7 @@ */ /** - * ### isNaN(value) + * ### .isNaN(value) * * Checks if the given value is NaN or not. * diff --git a/lib/chai/utils/isProxyEnabled.js b/lib/chai/utils/isProxyEnabled.js index f0ef041db..aa17dfa82 100644 --- a/lib/chai/utils/isProxyEnabled.js +++ b/lib/chai/utils/isProxyEnabled.js @@ -7,7 +7,7 @@ var config = require('../config'); */ /** - * # isProxyEnabled() + * ### .isProxyEnabled() * * Helper function to check if Chai's proxy protection feature is enabled. If * proxies are unsupported or disabled via the user's Chai config, then return diff --git a/lib/chai/utils/objDisplay.js b/lib/chai/utils/objDisplay.js index d87d938e1..32eacfa70 100644 --- a/lib/chai/utils/objDisplay.js +++ b/lib/chai/utils/objDisplay.js @@ -12,7 +12,7 @@ var inspect = require('./inspect'); var config = require('../config'); /** - * ### .objDisplay (object) + * ### .objDisplay(object) * * Determines if an object or an array matches * criteria to be inspected in-line for error diff --git a/lib/chai/utils/overwriteChainableMethod.js b/lib/chai/utils/overwriteChainableMethod.js index 4d28f5aa7..3ca922492 100644 --- a/lib/chai/utils/overwriteChainableMethod.js +++ b/lib/chai/utils/overwriteChainableMethod.js @@ -8,7 +8,7 @@ var chai = require('../../chai'); var transferFlags = require('./transferFlags'); /** - * ### overwriteChainableMethod (ctx, name, method, chainingBehavior) + * ### .overwriteChainableMethod(ctx, name, method, chainingBehavior) * * Overwites an already existing chainable method * and provides access to the previous function or diff --git a/lib/chai/utils/overwriteMethod.js b/lib/chai/utils/overwriteMethod.js index 5d2306e8e..004b85cdd 100644 --- a/lib/chai/utils/overwriteMethod.js +++ b/lib/chai/utils/overwriteMethod.js @@ -11,7 +11,7 @@ var proxify = require('./proxify'); var transferFlags = require('./transferFlags'); /** - * ### overwriteMethod (ctx, name, fn) + * ### .overwriteMethod(ctx, name, fn) * * Overwites an already existing method and provides * access to previous function. Must return function diff --git a/lib/chai/utils/overwriteProperty.js b/lib/chai/utils/overwriteProperty.js index f988ced32..73e62180a 100644 --- a/lib/chai/utils/overwriteProperty.js +++ b/lib/chai/utils/overwriteProperty.js @@ -10,7 +10,7 @@ var isProxyEnabled = require('./isProxyEnabled'); var transferFlags = require('./transferFlags'); /** - * ### overwriteProperty (ctx, name, fn) + * ### .overwriteProperty(ctx, name, fn) * * Overwites an already existing property getter and provides * access to previous value. Must return function to use as getter. diff --git a/lib/chai/utils/proxify.js b/lib/chai/utils/proxify.js index 85c6cbf08..9ea8b7f49 100644 --- a/lib/chai/utils/proxify.js +++ b/lib/chai/utils/proxify.js @@ -10,7 +10,7 @@ var isProxyEnabled = require('./isProxyEnabled'); */ /** - * # proxify(object) + * ### .proxify(object) * * Return a proxy of given object that throws an error when a non-existent * property is read. By default, the root cause is assumed to be a misspelled diff --git a/lib/chai/utils/test.js b/lib/chai/utils/test.js index 4afc5fc5c..6c4fc4a69 100644 --- a/lib/chai/utils/test.js +++ b/lib/chai/utils/test.js @@ -11,7 +11,7 @@ var flag = require('./flag'); /** - * # test(object, expression) + * ### .test(object, expression) * * Test and object for expression. * diff --git a/lib/chai/utils/transferFlags.js b/lib/chai/utils/transferFlags.js index ea1316b54..16684047d 100644 --- a/lib/chai/utils/transferFlags.js +++ b/lib/chai/utils/transferFlags.js @@ -5,7 +5,7 @@ */ /** - * ### transferFlags(assertion, object, includeAll = true) + * ### .transferFlags(assertion, object, includeAll = true) * * Transfer all the flags for `assertion` to `object`. If * `includeAll` is set to `false`, then the base Chai