From 6283acd758783c1b0c8834ff553fd3c3c2f41670 Mon Sep 17 00:00:00 2001 From: Andrew Jakubowicz Date: Tue, 14 Dec 2021 13:50:56 -0800 Subject: [PATCH] Revert to a link syntax lit.dev understands. See https://github.com/lit/lit.dev/issues/503 for @link issue. --- .../src/decorators/query-assigned-elements.ts | 9 ++++----- .../src/decorators/query-assigned-nodes.ts | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/packages/reactive-element/src/decorators/query-assigned-elements.ts b/packages/reactive-element/src/decorators/query-assigned-elements.ts index 425d4cadc6..9fdf47e45b 100644 --- a/packages/reactive-element/src/decorators/query-assigned-elements.ts +++ b/packages/reactive-element/src/decorators/query-assigned-elements.ts @@ -17,8 +17,8 @@ import type {ReactiveElement} from '../reactive-element.js'; import type {QueryAssignedNodesOptions} from './query-assigned-nodes.js'; /** - * Options for the {@link queryAssignedElements} decorator. Extends from the - * options that can be passed into + * Options for the [[`queryAssignedElements`]] decorator. Extends the options + * that can be passed into * [HTMLSlotElement.assignedElements](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSlotElement/assignedElements). */ export interface QueryAssignedElementsOptions @@ -36,6 +36,8 @@ export interface QueryAssignedElementsOptions * way to use * [`slot.assignedElements`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSlotElement/assignedElements). * + * Can be passed an optional [[`QueryAssignedElementsOptions`]] object. + * * Example usage: * ```ts * class MyElement { @@ -55,9 +57,6 @@ export interface QueryAssignedElementsOptions * * Note, the type of this property should be annotated as `Array`. * - * @param options Object that sets options for nodes to be returned. See - * {@link QueryAssignedElementsOptions} for all available options. - * * @category Decorator */ export function queryAssignedElements(options?: QueryAssignedElementsOptions) { diff --git a/packages/reactive-element/src/decorators/query-assigned-nodes.ts b/packages/reactive-element/src/decorators/query-assigned-nodes.ts index 6404f33e23..f2b664a049 100644 --- a/packages/reactive-element/src/decorators/query-assigned-nodes.ts +++ b/packages/reactive-element/src/decorators/query-assigned-nodes.ts @@ -16,8 +16,8 @@ import {decorateProperty} from './base.js'; import type {ReactiveElement} from '../reactive-element.js'; /** - * Options for the {@link queryAssignedNodes} decorator. Extends from the - * options that can be passed into + * Options for the [[`queryAssignedNodes`]] decorator. Extends the options that + * can be passed into * [HTMLSlotElement.assignedNodes](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSlotElement/assignedNodes). */ export interface QueryAssignedNodesOptions extends AssignedNodesOptions { @@ -35,6 +35,8 @@ type TSDecoratorReturnType = void | any; * A property decorator that converts a class property into a getter that * returns the `assignedNodes` of the given `slot`. * + * Can be passed an optional [[`QueryAssignedNodesOptions`]] object. + * * Example usage: * ```ts * class MyElement { @@ -51,9 +53,6 @@ type TSDecoratorReturnType = void | any; * * Note the type of this property should be annotated as `Array`. * - * @param options Object that sets options for nodes to be returned. See - * {@link QueryAssignedNodesOptions} for all available options. - * * @category Decorator */ export function queryAssignedNodes(