From 43073b3bc537fbb1de3a51348e4d1ff515c33aa4 Mon Sep 17 00:00:00 2001
From: Steve Gravrock <sdg@panix.com>
Date: Thu, 29 Jul 2021 19:32:15 -0700
Subject: [PATCH] Added API docs for Suite#id and Spec#id

These properties are the only way to obtain runnable IDs, without which
you can't call the form of Env#execute that takes an array of IDs.
---
 lib/jasmine-core/jasmine.js | 12 ++++++++++++
 src/core/Spec.js            |  6 ++++++
 src/core/Suite.js           |  6 ++++++
 3 files changed, 24 insertions(+)

diff --git a/lib/jasmine-core/jasmine.js b/lib/jasmine-core/jasmine.js
index df224cb8..282b9fe4 100644
--- a/lib/jasmine-core/jasmine.js
+++ b/lib/jasmine-core/jasmine.js
@@ -712,6 +712,12 @@ getJasmineRequireObj().Spec = function(j$) {
     this.expectationFactory = attrs.expectationFactory;
     this.asyncExpectationFactory = attrs.asyncExpectationFactory;
     this.resultCallback = attrs.resultCallback || function() {};
+    /**
+     * The unique ID of this spec.
+     * @name Spec#id
+     * @readonly
+     * @type {string}
+     */
     this.id = attrs.id;
     /**
      * The description passed to the {@link it} that created this spec.
@@ -9242,6 +9248,12 @@ getJasmineRequireObj().Suite = function(j$) {
    */
   function Suite(attrs) {
     this.env = attrs.env;
+    /**
+     * The unique ID of this suite.
+     * @name Suite#id
+     * @readonly
+     * @type {string}
+     */
     this.id = attrs.id;
     /**
      * The parent of this suite, or null if this is the top suite.
diff --git a/src/core/Spec.js b/src/core/Spec.js
index 81d244dd..826f7157 100644
--- a/src/core/Spec.js
+++ b/src/core/Spec.js
@@ -7,6 +7,12 @@ getJasmineRequireObj().Spec = function(j$) {
     this.expectationFactory = attrs.expectationFactory;
     this.asyncExpectationFactory = attrs.asyncExpectationFactory;
     this.resultCallback = attrs.resultCallback || function() {};
+    /**
+     * The unique ID of this spec.
+     * @name Spec#id
+     * @readonly
+     * @type {string}
+     */
     this.id = attrs.id;
     /**
      * The description passed to the {@link it} that created this spec.
diff --git a/src/core/Suite.js b/src/core/Suite.js
index 5043017b..c3e475bd 100644
--- a/src/core/Suite.js
+++ b/src/core/Suite.js
@@ -5,6 +5,12 @@ getJasmineRequireObj().Suite = function(j$) {
    */
   function Suite(attrs) {
     this.env = attrs.env;
+    /**
+     * The unique ID of this suite.
+     * @name Suite#id
+     * @readonly
+     * @type {string}
+     */
     this.id = attrs.id;
     /**
      * The parent of this suite, or null if this is the top suite.