From 4f685aac962f2ad2db65adb15125c2093775056d Mon Sep 17 00:00:00 2001
From: Johan Haals <johan.haals@gmail.com>
Date: Tue, 17 Aug 2021 13:17:55 +0200
Subject: [PATCH] Update comments

Signed-off-by: Johan Haals <johan.haals@gmail.com>
---
 plugins/catalog-backend/api-report.md                  | 10 +---------
 plugins/catalog-backend/src/next/NextCatalogBuilder.ts |  4 ++--
 plugins/catalog-backend/src/next/refresh.ts            |  4 +---
 3 files changed, 4 insertions(+), 14 deletions(-)

diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md
index 8f0d6c32e9..a6e67215c9 100644
--- a/plugins/catalog-backend/api-report.md
+++ b/plugins/catalog-backend/api-report.md
@@ -419,19 +419,11 @@ export function createNextRouter(
   options: RouterOptions_2,
 ): Promise<express.Router>;
 
-// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
-// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
-// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-// Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
-// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
-// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
-// Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-// Warning: (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
 // Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
 // Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
 // Warning: (ae-missing-release-tag) "createRandomRefreshInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
-// @public (undocumented)
+// @public
 export function createRandomRefreshInterval(options: {
   minSeconds: number;
   maxSeconds: number;
diff --git a/plugins/catalog-backend/src/next/NextCatalogBuilder.ts b/plugins/catalog-backend/src/next/NextCatalogBuilder.ts
index b277f0b16a..675e170727 100644
--- a/plugins/catalog-backend/src/next/NextCatalogBuilder.ts
+++ b/plugins/catalog-backend/src/next/NextCatalogBuilder.ts
@@ -165,8 +165,8 @@ export class NextCatalogBuilder {
   }
 
   /**
-   * Refresh spread configures configures the minimum and maximum number of seconds
-   * to wait between refreshes in addition to the configured refresh interval.
+   * Overwrites the default refresh interval function used to spread
+   * entity updates in the catalog.
    */
   setRefreshInterval(
     refreshInterval: RefreshIntervalFunction,
diff --git a/plugins/catalog-backend/src/next/refresh.ts b/plugins/catalog-backend/src/next/refresh.ts
index d9f56c3254..aae992f391 100644
--- a/plugins/catalog-backend/src/next/refresh.ts
+++ b/plugins/catalog-backend/src/next/refresh.ts
@@ -20,10 +20,8 @@
 export type RefreshIntervalFunction = () => number;
 
 /**
- * @param {number} options.minSeconds The minimum number of seconds between refreshes
- * @param {number} options.maxSeconds The maximum number of seconds between refreshes
+ * Creates a function that returns a random refresh interval between minSeconds and maxSeconds.
  * @returns {RefreshIntervalFunction} that provides the next refresh interval
- *
  */
 export function createRandomRefreshInterval(options: {
   minSeconds: number;