Skip to content

Commit

Permalink
Revert to a link syntax lit.dev understands.
Browse files Browse the repository at this point in the history
See lit/lit.dev#503 for @link issue.
  • Loading branch information
AndrewJakubowicz committed Dec 14, 2021
1 parent dce5aba commit 6283acd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 {
Expand All @@ -55,9 +57,6 @@ export interface QueryAssignedElementsOptions
*
* Note, the type of this property should be annotated as `Array<HTMLElement>`.
*
* @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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand All @@ -51,9 +53,6 @@ type TSDecoratorReturnType = void | any;
*
* Note the type of this property should be annotated as `Array<Node>`.
*
* @param options Object that sets options for nodes to be returned. See
* {@link QueryAssignedNodesOptions} for all available options.
*
* @category Decorator
*/
export function queryAssignedNodes(
Expand Down

0 comments on commit 6283acd

Please sign in to comment.