fix up errors too

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

.changeset/lazy-dodos-drum.md

@@ -1,4 +1,5 @@
 ---
+'@backstage/errors': patch
 '@backstage/integration': patch
 '@backstage/theme': patch
 ---

packages/errors/api-report.md

@@ -17,7 +17,6 @@ export class ConflictError extends CustomErrorBase {}
 // @public
 export class CustomErrorBase extends Error {
   constructor(message?: string, cause?: Error | unknown);
-  // (undocumented)
   readonly cause?: Error | undefined;
 }
 

packages/errors/src/errors/CustomErrorBase.ts

@@ -33,6 +33,9 @@ import { isError } from './assertion';
  * ```
  */
 export class CustomErrorBase extends Error {
+  /**
+   * An inner error that caused this error to be thrown, if any.
+   */
   readonly cause?: Error | undefined;
 
   constructor(message?: string, cause?: Error | unknown) {

packages/integration/api-report.md

@@ -344,9 +344,6 @@ export function replaceGitHubUrlType(
 // @public
 export interface ScmIntegration {
   resolveEditUrl(url: string): string;
-  // 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-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
   resolveUrl(options: {
     url: string;
     base: string;
@@ -370,9 +367,6 @@ export interface ScmIntegrationRegistry
   // (undocumented)
   gitlab: ScmIntegrationsGroup<GitLabIntegration>;
   resolveEditUrl(url: string): string;
-  // 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-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
-  // Warning: (tsdoc-param-tag-with-invalid-name) The @param block should be followed by a valid parameter name: The identifier cannot non-word characters
   resolveUrl(options: {
     url: string;
     base: string;

packages/integration/src/registry.ts

@@ -45,14 +45,19 @@ export interface ScmIntegrationRegistry
    * within the file tree of a certain repo, an absolute path of `/b.yaml` does
    * not resolve to `https://hostname/b.yaml` but rather to
    * `<repo root url>/b.yaml` inside the file tree of that same repo.
-   *
-   * @param options.url - The (absolute or relative) URL or path to resolve
-   * @param options.base - The base URL onto which this resolution happens
-   * @param options.lineNumber - The line number in the target file to link to, starting with 1. Only applicable when linking to files.
    */
   resolveUrl(options: {
+    /**
+     * The (absolute or relative) URL or path to resolve.
+     */
     url: string;
+    /**
+     * The base URL onto which this resolution happens
+     */
     base: string;
+    /**
+     * The line number in the target file to link to, starting with 1. Only applicable when linking to files.
+     */
     lineNumber?: number;
   }): string;
 

packages/integration/src/types.ts

@@ -44,14 +44,19 @@ export interface ScmIntegration {
    * within the file tree of a certain repo, an absolute path of `/b.yaml` does
    * not resolve to `https://hostname/b.yaml` but rather to
    * `<repo root url>/b.yaml` inside the file tree of that same repo.
-   *
-   * @param options.url - The (absolute or relative) URL or path to resolve
-   * @param options.base - The base URL onto which this resolution happens
-   * @param options.lineNumber - The line number in the target file to link to, starting with 1. Only applicable when linking to files.
    */
   resolveUrl(options: {
+    /**
+     * The (absolute or relative) URL or path to resolve
+     */
     url: string;
+    /**
+     * The base URL onto which this resolution happens
+     */
     base: string;
+    /**
+     * The line number in the target file to link to, starting with 1. Only applicable when linking to files.
+     */
     lineNumber?: number;
   }): string;