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

@@ -1,6 +1,7 @@
getJasmineRequireObj().CallTracker = function(j$) {
/**
* @namespace Spy#calls
* @since 2.0.0
*/
function CallTracker() {
var calls = [];
@@ -16,6 +17,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Check whether this spy has been invoked.
* @name Spy#calls#any
* @since 2.0.0
* @function
* @return {Boolean}
*/
@@ -26,6 +28,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Get the number of invocations of this spy.
* @name Spy#calls#count
* @since 2.0.0
* @function
* @return {Integer}
*/
@@ -36,6 +39,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Get the arguments that were passed to a specific invocation of this spy.
* @name Spy#calls#argsFor
* @since 2.0.0
* @function
* @param {Integer} index The 0-based invocation index.
* @return {Array}
@@ -48,6 +52,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Get the raw calls array for this spy.
* @name Spy#calls#all
* @since 2.0.0
* @function
* @return {Spy.callData[]}
*/
@@ -58,6 +63,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Get all of the arguments for each invocation of this spy in the order they were received.
* @name Spy#calls#allArgs
* @since 2.0.0
* @function
* @return {Array}
*/
@@ -73,6 +79,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Get the first invocation of this spy.
* @name Spy#calls#first
* @since 2.0.0
* @function
* @return {ObjecSpy.callData}
*/
@@ -83,6 +90,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Get the most recent invocation of this spy.
* @name Spy#calls#mostRecent
* @since 2.0.0
* @function
* @return {ObjecSpy.callData}
*/
@@ -93,6 +101,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Reset this spy as if it has never been called.
* @name Spy#calls#reset
* @since 2.0.0
* @function
*/
this.reset = function() {
@@ -102,6 +111,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
/**
* Set this spy to do a shallow clone of arguments passed to each invocation.
* @name Spy#calls#saveArgumentsByValue
* @since 2.5.0
* @function
*/
this.saveArgumentsByValue = function() {