Add @since to most JSDoc comments

- See jasmine/jasmine.github.io#117
This commit is contained in:
Gregg Van Hove
2019-06-12 16:23:12 -07:00
parent 984018bfdf
commit 15f969bee7
44 changed files with 254 additions and 0 deletions

View File

@@ -15,6 +15,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* Calls to `describe` can be nested within other calls to compose your suite as a tree.
* @name describe
* @since 1.3.0
* @function
* @global
* @param {String} description Textual description of the group
@@ -29,6 +30,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* Specs within an `xdescribe` will be marked pending and not executed
* @name xdescribe
* @since 1.3.0
* @function
* @global
* @param {String} description Textual description of the group
@@ -44,6 +46,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
* If suites or specs are focused, only those that are focused will be executed
* @see fit
* @name fdescribe
* @since 2.1.0
* @function
* @global
* @param {String} description Textual description of the group
@@ -58,6 +61,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* A spec whose expectations all succeed will be passing and a spec with any failures will fail.
* @name it
* @since 1.3.0
* @function
* @global
* @param {String} description Textual description of what this spec is checking
@@ -74,6 +78,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* The spec will report as `pending` and will not be executed.
* @name xit
* @since 1.3.0
* @function
* @global
* @param {String} description Textual description of what this spec is checking.
@@ -88,6 +93,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* If suites or specs are focused, only those that are focused will be executed.
* @name fit
* @since 2.1.0
* @function
* @global
* @param {String} description Textual description of what this spec is checking.
@@ -102,6 +108,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Run some shared setup before each of the specs in the {@link describe} in which it is called.
* @name beforeEach
* @since 1.3.0
* @function
* @global
* @param {implementationCallback} [function] Function that contains the code to setup your specs.
@@ -115,6 +122,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Run some shared teardown after each of the specs in the {@link describe} in which it is called.
* @name afterEach
* @since 1.3.0
* @function
* @global
* @param {implementationCallback} [function] Function that contains the code to teardown your specs.
@@ -130,6 +138,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* _Note:_ Be careful, sharing the setup from a beforeAll makes it easy to accidentally leak state between your specs so that they erroneously pass or fail.
* @name beforeAll
* @since 2.1.0
* @function
* @global
* @param {implementationCallback} [function] Function that contains the code to setup your specs.
@@ -145,6 +154,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* _Note:_ Be careful, sharing the teardown from a afterAll makes it easy to accidentally leak state between your specs so that they erroneously pass or fail.
* @name afterAll
* @since 2.1.0
* @function
* @global
* @param {implementationCallback} [function] Function that contains the code to teardown your specs.
@@ -158,6 +168,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Create an expectation for a spec.
* @name expect
* @since 1.3.0
* @function
* @global
* @param {Object} actual - Actual computed value to test expectations against.
@@ -173,6 +184,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
* which must be either returned from the spec or waited for using `await`
* in order for Jasmine to associate them with the correct spec.
* @name expectAsync
* @since 3.3.0
* @function
* @global
* @param {Object} actual - Actual computed value to test expectations against.
@@ -189,6 +201,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Mark a spec as pending, expectation results will be ignored.
* @name pending
* @since 2.0.0
* @function
* @global
* @param {String} [message] - Reason the spec is pending.
@@ -200,6 +213,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Explicitly mark a spec as failed.
* @name fail
* @since 2.1.0
* @function
* @global
* @param {String|Error} [error] - Reason for the failure.
@@ -211,6 +225,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Install a spy onto an existing object.
* @name spyOn
* @since 1.3.0
* @function
* @global
* @param {Object} obj - The object upon which to install the {@link Spy}.
@@ -224,6 +239,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Install a spy on a property installed with `Object.defineProperty` onto an existing object.
* @name spyOnProperty
* @since 2.6.0
* @function
* @global
* @param {Object} obj - The object upon which to install the {@link Spy}
@@ -238,6 +254,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Installs spies on all writable and configurable properties of an object.
* @name spyOnAllFunctions
* @since 3.2.1
* @function
* @global
* @param {Object} obj - The object upon which to install the {@link Spy}s
@@ -262,6 +279,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}.
* @name jasmine.addCustomEqualityTester
* @since 2.0.0
* @function
* @param {Function} tester - A function which takes two arguments to compare and returns a `true` or `false` comparison result if it knows how to compare them, and `undefined` otherwise.
* @see custom_equality
@@ -275,6 +293,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}.
* @name jasmine.addMatchers
* @since 2.0.0
* @function
* @param {Object} matchers - Keys from this object will be the new matcher names.
* @see custom_matcher
@@ -286,6 +305,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Get the currently booted mock {Clock} for this Jasmine environment.
* @name jasmine.clock
* @since 2.0.0
* @function
* @returns {Clock}
*/
@@ -296,6 +316,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Create a bare {@link Spy} object. This won't be installed anywhere and will not have any implementation behind it.
* @name jasmine.createSpy
* @since 1.3.0
* @function
* @param {String} [name] - Name to give the spy. This will be displayed in failure messages.
* @param {Function} [originalFn] - Function to act as the real implementation.
@@ -308,6 +329,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
/**
* Create an object with multiple {@link Spy}s as its members.
* @name jasmine.createSpyObj
* @since 1.3.0
* @function
* @param {String} [baseName] - Base name for the spies in the object.
* @param {String[]|Object} methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}.
@@ -322,6 +344,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
*
* _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}.
* @name jasmine.addSpyStrategy
* @since 3.5.0
* @function
* @param {String} name - The name of the strategy (i.e. what you call from `and`)
* @param {Function} factory - Factory function that returns the plan to be executed.