Fix JSDoc naming for Env functions

- See #1565
This commit is contained in:
Gregg Van Hove
2018-06-06 17:13:52 -07:00
parent 03998c1b20
commit e2895a92dc
2 changed files with 14 additions and 14 deletions

View File

@@ -962,7 +962,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Sets whether Jasmine should throw an Error when an expectation fails. * Sets whether Jasmine should throw an Error when an expectation fails.
* This causes a spec to only have one expectation failure. * This causes a spec to only have one expectation failure.
* @name throwOnExpectationFailure * @name Env#throwOnExpectationFailure
* @function * @function
* @param {Boolean} value Whether to throw when a expectation fails * @param {Boolean} value Whether to throw when a expectation fails
*/ */
@@ -976,7 +976,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Set whether to stop suite execution when a spec fails * Set whether to stop suite execution when a spec fails
* @name stopOnSpecFailure * @name Env#stopOnSpecFailure
* @function * @function
* @param {Boolean} value Whether to stop suite execution when a spec fails * @param {Boolean} value Whether to stop suite execution when a spec fails
*/ */
@@ -990,7 +990,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Set whether to randomize test execution order * Set whether to randomize test execution order
* @name randomizeTests * @name Env#randomizeTests
* @function * @function
* @param {Boolean} value Whether to randomize execution order * @param {Boolean} value Whether to randomize execution order
*/ */
@@ -1004,7 +1004,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Set the random number seed for spec randomization * Set the random number seed for spec randomization
* @name seed * @name Env#seed
* @function * @function
* @param {Number} value The seed value * @param {Number} value The seed value
*/ */
@@ -1020,7 +1020,7 @@ getJasmineRequireObj().Env = function(j$) {
}; };
/** /**
* @name hideDisabled * @name Env#hideDisabled
* @function * @function
*/ */
this.hideDisabled = function(value) { this.hideDisabled = function(value) {
@@ -1256,7 +1256,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Provide a fallback reporter if no other reporters have been specified. * Provide a fallback reporter if no other reporters have been specified.
* @name provideFallbackReporter * @name Env#provideFallbackReporter
* @function * @function
* @param {Reporter} reporterToAdd The reporter * @param {Reporter} reporterToAdd The reporter
* @see custom_reporter * @see custom_reporter
@@ -1267,7 +1267,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Clear all registered reporters * Clear all registered reporters
* @name clearReporters * @name Env#clearReporters
* @function * @function
*/ */
this.clearReporters = function() { this.clearReporters = function() {

View File

@@ -191,7 +191,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Sets whether Jasmine should throw an Error when an expectation fails. * Sets whether Jasmine should throw an Error when an expectation fails.
* This causes a spec to only have one expectation failure. * This causes a spec to only have one expectation failure.
* @name throwOnExpectationFailure * @name Env#throwOnExpectationFailure
* @function * @function
* @param {Boolean} value Whether to throw when a expectation fails * @param {Boolean} value Whether to throw when a expectation fails
*/ */
@@ -205,7 +205,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Set whether to stop suite execution when a spec fails * Set whether to stop suite execution when a spec fails
* @name stopOnSpecFailure * @name Env#stopOnSpecFailure
* @function * @function
* @param {Boolean} value Whether to stop suite execution when a spec fails * @param {Boolean} value Whether to stop suite execution when a spec fails
*/ */
@@ -219,7 +219,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Set whether to randomize test execution order * Set whether to randomize test execution order
* @name randomizeTests * @name Env#randomizeTests
* @function * @function
* @param {Boolean} value Whether to randomize execution order * @param {Boolean} value Whether to randomize execution order
*/ */
@@ -233,7 +233,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Set the random number seed for spec randomization * Set the random number seed for spec randomization
* @name seed * @name Env#seed
* @function * @function
* @param {Number} value The seed value * @param {Number} value The seed value
*/ */
@@ -249,7 +249,7 @@ getJasmineRequireObj().Env = function(j$) {
}; };
/** /**
* @name hideDisabled * @name Env#hideDisabled
* @function * @function
*/ */
this.hideDisabled = function(value) { this.hideDisabled = function(value) {
@@ -485,7 +485,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Provide a fallback reporter if no other reporters have been specified. * Provide a fallback reporter if no other reporters have been specified.
* @name provideFallbackReporter * @name Env#provideFallbackReporter
* @function * @function
* @param {Reporter} reporterToAdd The reporter * @param {Reporter} reporterToAdd The reporter
* @see custom_reporter * @see custom_reporter
@@ -496,7 +496,7 @@ getJasmineRequireObj().Env = function(j$) {
/** /**
* Clear all registered reporters * Clear all registered reporters
* @name clearReporters * @name Env#clearReporters
* @function * @function
*/ */
this.clearReporters = function() { this.clearReporters = function() {