auto fix jsdocs based on lint rules

Author: madsrasmussen

src/apps/app/app-auth.controller.ts

@@ -60,6 +60,7 @@ export class UmbAppAuthController extends UmbControllerBase {
 	/**
 	 * Starts the authorization flow.
 	 * It will check which providers are available and either redirect directly to the provider or show a provider selection screen.
+	 * @param userLoginState
 	 */
 	async makeAuthorizationRequest(userLoginState: UmbUserLoginState = 'loggingIn'): Promise<boolean> {
 		if (!this.#authContext) {

src/apps/app/app-error.element.ts

@@ -10,31 +10,27 @@ import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
 export class UmbAppErrorElement extends UmbLitElement {
 	/**
 	 * The headline to display
-	 *
 	 * @attr
 	 */
 	@property()
 	errorHeadline?: string | null;
 
 	/**
 	 * The error message to display
-	 *
 	 * @attr
 	 */
 	@property()
 	errorMessage?: string | null;
 
 	/**
 	 * The error to display
-	 *
 	 * @attr
 	 */
 	@property()
 	error?: unknown;
 
 	/**
 	 * Hide the back button
-	 *
 	 * @attr
 	 */
 	@property({ type: Boolean, attribute: 'hide-back-button' })

src/apps/app/app.element.ts

@@ -25,7 +25,6 @@ import { hasOwnOpener, retrieveStoredPath } from '@umbraco-cms/backoffice/utils'
 export class UmbAppElement extends UmbLitElement {
 	/**
 	 * The base URL of the configured Umbraco server.
-	 *
 	 * @attr
 	 * @remarks This is the base URL of the Umbraco server, not the base URL of the backoffice.
 	 */
@@ -39,7 +38,6 @@ export class UmbAppElement extends UmbLitElement {
 
 	/**
 	 * The base path of the backoffice.
-	 *
 	 * @attr
 	 */
 	@property({ type: String })

src/apps/app/server-connection.ts

@@ -24,7 +24,7 @@ export class UmbServerConnection {
 
 	/**
 	 * Gets the URL of the server.
-	 * @return {*}
+	 * @returns {*}
 	 * @memberof UmbServerConnection
 	 */
 	getUrl() {
@@ -33,7 +33,7 @@ export class UmbServerConnection {
 
 	/**
 	 * Gets the status of the server.
-	 * @return {string}
+	 * @returns {string}
 	 * @memberof UmbServerConnection
 	 */
 	getStatus() {
@@ -43,7 +43,7 @@ export class UmbServerConnection {
 
 	/**
 	 * Checks if the server is connected.
-	 * @return {boolean}
+	 * @returns {boolean}
 	 * @memberof UmbServerConnection
 	 */
 	getIsConnected() {

src/apps/installer/installer.context.ts

@@ -38,7 +38,7 @@ export class UmbInstallerContext {
 	/**
 	 * Observable method to get the current step in the installation process
 	 * @public
-	 * @return {*}  {Observable<number>}
+	 * @returns {*}  {Observable<number>}
 	 * @memberof UmbInstallerContext
 	 */
 	public currentStepChanges(): Observable<number> {
@@ -48,7 +48,7 @@ export class UmbInstallerContext {
 	/**
 	 * Observable method to get the install status in the installation process
 	 * @public
-	 * @return {*}  {(Observable<ProblemDetails | null>)}
+	 * @returns {*}  {(Observable<ProblemDetails | null>)}
 	 * @memberof UmbInstallerContext
 	 */
 	public installStatusChanges(): Observable<ProblemDetails | null> {
@@ -96,7 +96,7 @@ export class UmbInstallerContext {
 	/**
 	 * Get the data for the installation process
 	 * @public
-	 * @return {*}  {PostInstallRequest}
+	 * @returns {*}  {PostInstallRequest}
 	 * @memberof UmbInstallerContext
 	 */
 	public getData(): InstallRequestModel {

src/libs/class-api/class.interface.ts

@@ -13,7 +13,7 @@ export interface UmbClassInterface extends UmbControllerHost {
 	 * @description Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.
 	 * @param {Observable<T>} source An Observable to observe from.
 	 * @param {method} callback Callback method called when data is changed.
-	 * @return {UmbObserverController} Reference to the created Observer Controller instance.
+	 * @returns {UmbObserverController} Reference to the created Observer Controller instance.
 	 * @memberof UmbClassMixin
 	 */
 	observe<
@@ -38,7 +38,7 @@ export interface UmbClassInterface extends UmbControllerHost {
 	 * @description Provide a context API for this or child elements.
 	 * @param {string} contextAlias
 	 * @param {instance} instance The API instance to be exposed.
-	 * @return {UmbContextProviderController} Reference to the created Context Provider Controller instance
+	 * @returns {UmbContextProviderController} Reference to the created Context Provider Controller instance
 	 * @memberof UmbClassMixin
 	 */
 	provideContext<R = unknown>(alias: string | UmbContextToken<R>, instance: R): UmbContextProviderController<R>;
@@ -47,7 +47,7 @@ export interface UmbClassInterface extends UmbControllerHost {
 	 * @description Setup a subscription for a context. The callback is called when the context is resolved.
 	 * @param {string} contextAlias
 	 * @param {method} callback Callback method called when context is resolved.
-	 * @return {UmbContextConsumerController} Reference to the created Context Consumer Controller instance
+	 * @returns {UmbContextConsumerController} Reference to the created Context Consumer Controller instance
 	 * @memberof UmbClassMixin
 	 */
 	consumeContext<BaseType = unknown, ResultType extends BaseType = BaseType>(
@@ -58,7 +58,7 @@ export interface UmbClassInterface extends UmbControllerHost {
 	/**
 	 * @description Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.
 	 * @param {string} contextAlias
-	 * @return {Promise<ContextType>} A Promise with the reference to the Context Api Instance
+	 * @returns {Promise<ContextType>} A Promise with the reference to the Context Api Instance
 	 * @memberof UmbClassMixin
 	 */
 	getContext<BaseType = unknown, ResultType extends BaseType = BaseType>(

src/libs/context-api/consume/context-request.event.ts

@@ -18,7 +18,7 @@ export interface UmbContextRequestEvent<ResultType = unknown> extends Event {
 /**
  * @export
  * @class UmbContextRequestEventImplementation
- * @extends {Event}
+ * @augments {Event}
  * @implements {UmbContextRequestEvent}
  */
 export class UmbContextRequestEventImplementation<ResultType = unknown>

src/libs/context-api/debug/context-data.function.ts

@@ -1,7 +1,6 @@
 /* eslint-disable no-case-declarations */
 /**
  * Change the collection of Contexts into a simplified array of data
- *
  * @param contexts This is a map of the collected contexts from umb-debug
  * @returns An array of simplified context data
  */
@@ -16,7 +15,6 @@ export function contextData(contexts: Map<any, any>): Array<UmbDebugContextData>
 
 /**
  * Used to find the methods and properties of a context
- *
  * @param contextInstance The instance of the context
  * @returns A simplied object contain the properties and methods of the context
  */
@@ -82,8 +80,8 @@ function contextItemData(contextInstance: any): UmbDebugContextItemData {
 
 /**
  * Gets a list of methods from a class
- *
  * @param class The class to get the methods from
+ * @param klass
  * @returns An array of method names as strings
  */
 function getClassMethodNames(klass: any) {
@@ -104,23 +102,20 @@ function getClassMethodNames(klass: any) {
 export interface UmbDebugContextData {
 	/**
 	 * The alias of the context
-	 *
 	 * @type {string}
 	 * @memberof UmbDebugContextData
 	 */
 	alias: string;
 
 	/**
 	 * The type of the context such as object or string
-	 *
 	 * @type {("string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function")}
 	 * @memberof UmbDebugContextData
 	 */
 	type: 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
 
 	/**
 	 * Data about the context that includes method and property names
-	 *
 	 * @type {UmbDebugContextItemData}
 	 * @memberof UmbDebugContextData
 	 */
@@ -137,23 +132,20 @@ export interface UmbDebugContextItemData {
 export interface UmbDebugContextItemPropertyData {
 	/**
 	 * The name of the property
-	 *
 	 * @type {string}
 	 * @memberof UmbDebugContextItemPropertyData
 	 */
 	key: string;
 
 	/**
 	 * The type of the property's value such as string or number
-	 *
 	 * @type {("string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function")}
 	 * @memberof UmbDebugContextItemPropertyData
 	 */
 	type: 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
 
 	/**
 	 * Simple types such as string or number can have their value displayed stored inside the property
-	 *
 	 * @type {("string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function")}
 	 * @memberof UmbDebugContextItemPropertyData
 	 */

src/libs/context-api/provide/context-provide.event.ts

@@ -13,7 +13,7 @@ export interface UmbContextProvideEvent extends Event {
 /**
  * @export
  * @class UmbContextProvideEventImplementation
- * @extends {Event}
+ * @augments {Event}
  * @implements {UmbContextProvideEvent}
  */
 export class UmbContextProvideEventImplementation extends Event implements UmbContextProvideEvent {
@@ -40,7 +40,7 @@ export interface UmbContextUnprovidedEvent extends Event {
 /**
  * @export
  * @class UmbContextUnprovidedEventImplementation
- * @extends {Event}
+ * @augments {Event}
  * @implements {UmbContextUnprovidedEvent}
  */
 /*

src/libs/context-api/provide/context-provider.element.ts

@@ -5,7 +5,6 @@ import { UmbControllerHostElementMixin } from '@umbraco-cms/backoffice/controlle
 
 /**
  * Provides a value to the context down the DOM tree.
- *
  * @remarks This element is a wrapper around the `provideContext` function.
  * @slot - The context will be available to all descendants given in the default slot.
  * @throws {Error} If the key property is not set.