Removed constructors from jsdocs of classes that aren't user-constructable

This commit is contained in:
Steve Gravrock
2021-06-21 14:19:31 -07:00
parent 1893bf6c16
commit 163f93d6ff
5 changed files with 34 additions and 24 deletions

View File

@@ -979,11 +979,12 @@ getJasmineRequireObj().Order = function() {
getJasmineRequireObj().Env = function(j$) {
/**
* _Note:_ Do not construct this directly, Jasmine will make one during booting.
* @name Env
* @class Env
* @since 2.0.0
* @classdesc The Jasmine environment
* @constructor
* @classdesc The Jasmine environment.<br>
* _Note:_ Do not construct this directly. You can obtain the Env instance by
* calling {@link jasmine.getEnv}.
* @hideconstructor
*/
function Env(options) {
options = options || {};
@@ -3165,9 +3166,11 @@ getJasmineRequireObj().Clock = function() {
typeof process.versions.node === 'string';
/**
* _Note:_ Do not construct this directly, Jasmine will make one during booting. You can get the current clock with {@link jasmine.clock}.
* @class Clock
* @classdesc Jasmine's mock clock is used when testing time dependent code.
* @classdesc Jasmine's mock clock is used when testing time dependent code.<br>
* _Note:_ Do not construct this directly. You can get the current clock with
* {@link jasmine.clock}.
* @hideconstructor
*/
function Clock(global, delayedFunctionSchedulerFactory, mockDate) {
var self = this,
@@ -4734,11 +4737,11 @@ getJasmineRequireObj().MatchersUtil = function(j$) {
// TODO: convert all uses of j$.pp to use the injected pp
/**
* @class MatchersUtil
* @classdesc Utilities for use in implementing matchers.<br>
* _Note:_ Do not construct this directly. Jasmine will construct one and
* pass it to matchers and asymmetric equality testers.
* @name MatchersUtil
* @classdesc Utilities for use in implementing matchers
* @constructor
* @hideconstructor
*/
function MatchersUtil(options) {
options = options || {};
@@ -8291,9 +8294,11 @@ getJasmineRequireObj().Spy = function(j$) {
});
/**
* _Note:_ Do not construct this directly, use {@link spyOn}, {@link spyOnProperty}, {@link jasmine.createSpy}, or {@link jasmine.createSpyObj}
* @constructor
* @name Spy
* @classdesc _Note:_ Do not construct this directly. Use {@link spyOn},
* {@link spyOnProperty}, {@link jasmine.createSpy}, or
* {@link jasmine.createSpyObj} instead.
* @class Spy
* @hideconstructor
*/
function Spy(
name,

View File

@@ -6,9 +6,11 @@ getJasmineRequireObj().Clock = function() {
typeof process.versions.node === 'string';
/**
* _Note:_ Do not construct this directly, Jasmine will make one during booting. You can get the current clock with {@link jasmine.clock}.
* @class Clock
* @classdesc Jasmine's mock clock is used when testing time dependent code.
* @classdesc Jasmine's mock clock is used when testing time dependent code.<br>
* _Note:_ Do not construct this directly. You can get the current clock with
* {@link jasmine.clock}.
* @hideconstructor
*/
function Clock(global, delayedFunctionSchedulerFactory, mockDate) {
var self = this,

View File

@@ -1,10 +1,11 @@
getJasmineRequireObj().Env = function(j$) {
/**
* _Note:_ Do not construct this directly, Jasmine will make one during booting.
* @name Env
* @class Env
* @since 2.0.0
* @classdesc The Jasmine environment
* @constructor
* @classdesc The Jasmine environment.<br>
* _Note:_ Do not construct this directly. You can obtain the Env instance by
* calling {@link jasmine.getEnv}.
* @hideconstructor
*/
function Env(options) {
options = options || {};

View File

@@ -13,9 +13,11 @@ getJasmineRequireObj().Spy = function(j$) {
});
/**
* _Note:_ Do not construct this directly, use {@link spyOn}, {@link spyOnProperty}, {@link jasmine.createSpy}, or {@link jasmine.createSpyObj}
* @constructor
* @name Spy
* @classdesc _Note:_ Do not construct this directly. Use {@link spyOn},
* {@link spyOnProperty}, {@link jasmine.createSpy}, or
* {@link jasmine.createSpyObj} instead.
* @class Spy
* @hideconstructor
*/
function Spy(
name,

View File

@@ -2,11 +2,11 @@ getJasmineRequireObj().MatchersUtil = function(j$) {
// TODO: convert all uses of j$.pp to use the injected pp
/**
* @class MatchersUtil
* @classdesc Utilities for use in implementing matchers.<br>
* _Note:_ Do not construct this directly. Jasmine will construct one and
* pass it to matchers and asymmetric equality testers.
* @name MatchersUtil
* @classdesc Utilities for use in implementing matchers
* @constructor
* @hideconstructor
*/
function MatchersUtil(options) {
options = options || {};