docs: replaced @link to @see in jsdoc (#477)

* Replace block `@link` to `@see` * Replace block `@link` with anchor * Fix inline `@link`
vueuse · Apr 29, 2021 · 384845a · 384845a
1 parent eb96ce4
commit 384845a
Show file tree

Hide file tree

Showing 166 changed files with 202 additions and 202 deletions.
diff --git a/packages/core/asyncComputed/index.md b/packages/core/asyncComputed/index.md
@@ -107,7 +107,7 @@ export declare type AsyncComputedOptions = {
 /**
  * Create an asynchronous computed dependency.
  *
- * @link https://vueuse.org/asyncComputed
+ * @see https://vueuse.org/asyncComputed
  * @param evaluationCallback     The promise-returning callback which generates the computed value
  * @param initialState           The initial state, used until the first evaluation finishes
  * @param optionsOrRef           Additional options or a ref passed to receive the updates of the async evaluation

diff --git a/packages/core/asyncComputed/index.ts b/packages/core/asyncComputed/index.ts
@@ -22,7 +22,7 @@ export type AsyncComputedOptions = {
 /**
  * Create an asynchronous computed dependency.
  *
- * @link https://vueuse.org/asyncComputed
+ * @see https://vueuse.org/asyncComputed
  * @param evaluationCallback     The promise-returning callback which generates the computed value
  * @param initialState           The initial state, used until the first evaluation finishes
  * @param optionsOrRef           Additional options or a ref passed to receive the updates of the async evaluation

diff --git a/packages/core/autoResetRef/index.md b/packages/core/autoResetRef/index.md
@@ -27,7 +27,7 @@ const setMessage = () => {
 /**
  * Create a ref which will be reset to the default value after some time.
  *
- * @link https://vueuse.org/autoResetRef
+ * @see https://vueuse.org/autoResetRef
  * @param defaultValue The value which will be set.
  * @param afterMs      A zero-or-greater delay in milliseconds.
  */

diff --git a/packages/core/autoResetRef/index.ts b/packages/core/autoResetRef/index.ts
@@ -4,7 +4,7 @@ import { MaybeRef } from '@vueuse/shared'
 /**
  * Create a ref which will be reset to the default value after some time.
  *
- * @link https://vueuse.org/autoResetRef
+ * @see https://vueuse.org/autoResetRef
  * @param defaultValue The value which will be set.
  * @param afterMs      A zero-or-greater delay in milliseconds.
  */

diff --git a/packages/core/createGlobalState/index.md b/packages/core/createGlobalState/index.md
@@ -37,7 +37,7 @@ export default defineComponent({
 /**
  * Keep states in the global scope to be reusable across Vue instances.
  *
- * @link https://vueuse.org/createGlobalState
+ * @see https://vueuse.org/createGlobalState
  * @param stateFactory A factory function to create the state
  */
 export declare function createGlobalState<T extends object>(

diff --git a/packages/core/createGlobalState/index.ts b/packages/core/createGlobalState/index.ts
@@ -25,7 +25,7 @@ function withScope<T extends object>(factory: () => T): T {
 /**
  * Keep states in the global scope to be reusable across Vue instances.
  *
- * @link https://vueuse.org/createGlobalState
+ * @see https://vueuse.org/createGlobalState
  * @param stateFactory A factory function to create the state
  */
 export function createGlobalState<T extends object>(

diff --git a/packages/core/onClickOutside/index.md b/packages/core/onClickOutside/index.md
@@ -44,7 +44,7 @@ declare type EventType = WindowEventMap[typeof events[number]]
 /**
  * Listen for clicks outside of an element.
  *
- * @link https://vueuse.org/onClickOutside
+ * @see https://vueuse.org/onClickOutside
  * @param target
  * @param handler
  * @param options

diff --git a/packages/core/onClickOutside/index.ts b/packages/core/onClickOutside/index.ts
@@ -9,7 +9,7 @@ type EventType = WindowEventMap[(typeof events)[number]]
 /**
  * Listen for clicks outside of an element.
  *
- * @link https://vueuse.org/onClickOutside
+ * @see https://vueuse.org/onClickOutside
  * @param target
  * @param handler
  * @param options

diff --git a/packages/core/onKeyStroke/index.md b/packages/core/onKeyStroke/index.md
@@ -62,7 +62,7 @@ export declare type KeyStrokeOptions = {
 /**
  * Listen for keyboard keys being stroked.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options
@@ -75,7 +75,7 @@ export declare function onKeyStroke(
 /**
  * Listen to the keydown event of the given key.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options
@@ -88,7 +88,7 @@ export declare function onKeyDown(
 /**
  * Listen to the keypress event of the given key.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options
@@ -101,7 +101,7 @@ export declare function onKeyPressed(
 /**
  * Listen to the keyup event of the given key.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options

diff --git a/packages/core/onKeyStroke/index.ts b/packages/core/onKeyStroke/index.ts
@@ -23,7 +23,7 @@ const createKeyPredicate = (keyFilter: KeyFilter): KeyPredicate =>
 /**
  * Listen for keyboard keys being stroked.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options
@@ -42,7 +42,7 @@ export function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => v
 /**
  * Listen to the keydown event of the given key.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options
@@ -54,7 +54,7 @@ export function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => voi
 /**
  * Listen to the keypress event of the given key.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options
@@ -66,7 +66,7 @@ export function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) =>
 /**
  * Listen to the keyup event of the given key.
  *
- * @link https://vueuse.org/onKeyStroke
+ * @see https://vueuse.org/onKeyStroke
  * @param key
  * @param handler
  * @param options

diff --git a/packages/core/onStartTyping/index.md b/packages/core/onStartTyping/index.md
@@ -39,7 +39,7 @@ export default {
 /**
  * Fires when users start typing on non-editable elements.
  *
- * @link https://vueuse.org/onStartTyping
+ * @see https://vueuse.org/onStartTyping
  * @param callback
  * @param options
  */

diff --git a/packages/core/onStartTyping/index.ts b/packages/core/onStartTyping/index.ts
@@ -47,7 +47,7 @@ const isTypedCharValid = ({
 /**
  * Fires when users start typing on non-editable elements.
  *
- * @link https://vueuse.org/onStartTyping
+ * @see https://vueuse.org/onStartTyping
  * @param callback
  * @param options
  */

diff --git a/packages/core/templateRef/index.md b/packages/core/templateRef/index.md
@@ -64,7 +64,7 @@ const target = ref<HTMLElement | null>(null)
 /**
  * Shorthand for binding ref to template element.
  *
- * @link https://vueuse.org/templateRef
+ * @see https://vueuse.org/templateRef
  * @param key
  * @param initialValue
  */

diff --git a/packages/core/templateRef/index.ts b/packages/core/templateRef/index.ts
@@ -3,7 +3,7 @@ import { getCurrentInstance, onMounted, onUpdated, customRef, Ref } from 'vue-de
 /**
  * Shorthand for binding ref to template element.
  *
- * @link https://vueuse.org/templateRef
+ * @see https://vueuse.org/templateRef
  * @param key
  * @param initialValue
  */

diff --git a/packages/core/toRefs/index.md b/packages/core/toRefs/index.md
@@ -60,7 +60,7 @@ export default {
 /**
  * Extended `toRefs` that also accepts refs of an object.
  *
- * @link https://vueuse.org/toRefs
+ * @see https://vueuse.org/toRefs
  * @param objectRef A ref or normal object or array.
  */
 export declare function toRefs<T extends object>(

diff --git a/packages/core/toRefs/index.ts b/packages/core/toRefs/index.ts
@@ -4,7 +4,7 @@ import { MaybeRef } from '@vueuse/shared'
 /**
  * Extended `toRefs` that also accepts refs of an object.
  *
- * @link https://vueuse.org/toRefs
+ * @see https://vueuse.org/toRefs
  * @param objectRef A ref or normal object or array.
  */
 export function toRefs<T extends object>(

diff --git a/packages/core/useActiveElement/index.md b/packages/core/useActiveElement/index.md
@@ -25,7 +25,7 @@ watch(activeElement, (el) => {
 /**
  * Reactive `document.activeElement`
  *
- * @link https://vueuse.org/useActiveElement
+ * @see https://vueuse.org/useActiveElement
  * @param options
  */
 export declare function useActiveElement<T extends HTMLElement>(

diff --git a/packages/core/useActiveElement/index.ts b/packages/core/useActiveElement/index.ts
@@ -5,7 +5,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable'
 /**
  * Reactive `document.activeElement`
  *
- * @link https://vueuse.org/useActiveElement
+ * @see https://vueuse.org/useActiveElement
  * @param options
  */
 export function useActiveElement<T extends HTMLElement>(options: ConfigurableWindow = {}) {

diff --git a/packages/core/useAsyncState/index.md b/packages/core/useAsyncState/index.md
@@ -50,7 +50,7 @@ export interface AsyncStateOptions {
  * Reactive async state. Will not block your setup function and will triggers changes once
  * the promise is ready.
  *
- * @link https://vueuse.org/useAsyncState
+ * @see https://vueuse.org/useAsyncState
  * @param promise         The promise / async function to be resolved
  * @param initialState    The initial state, used until the first evaluation finishes
  * @param options

diff --git a/packages/core/useAsyncState/index.ts b/packages/core/useAsyncState/index.ts
@@ -29,7 +29,7 @@ export interface AsyncStateOptions {
  * Reactive async state. Will not block your setup function and will triggers changes once
  * the promise is ready.
  *
- * @link https://vueuse.org/useAsyncState
+ * @see https://vueuse.org/useAsyncState
  * @param promise         The promise / async function to be resolved
  * @param initialState    The initial state, used until the first evaluation finishes
  * @param options

diff --git a/packages/core/useBattery/index.md b/packages/core/useBattery/index.md
@@ -44,7 +44,7 @@ export interface BatteryManager extends EventTarget {
 /**
  * Reactive Battery Status API.
  *
- * @link https://vueuse.org/useBattery
+ * @see https://vueuse.org/useBattery
  * @param options
  */
 export declare function useBattery({

diff --git a/packages/core/useBattery/index.ts b/packages/core/useBattery/index.ts
@@ -18,7 +18,7 @@ type NavigatorWithBattery = Navigator & {
 /**
  * Reactive Battery Status API.
  *
- * @link https://vueuse.org/useBattery
+ * @see https://vueuse.org/useBattery
  * @param options
  */
 export function useBattery({ navigator = defaultNavigator }: ConfigurableNavigator = {}) {

diff --git a/packages/core/useBreakpoints/breakpoints.ts b/packages/core/useBreakpoints/breakpoints.ts
@@ -1,7 +1,7 @@
 /**
  * Breakpoints from Tailwind V2
  *
- * @link https://tailwindcss.com/docs/breakpoints
+ * @see https://tailwindcss.com/docs/breakpoints
  */
 export const breakpointsTailwind = {
   'sm': 640,
@@ -14,7 +14,7 @@ export const breakpointsTailwind = {
 /**
  * Breakpoints from Bootstrap V5
  *
- * @link https://getbootstrap.com/docs/5.0/layout/breakpoints
+ * @see https://getbootstrap.com/docs/5.0/layout/breakpoints
  */
 export const breakpointsBootstrapV5 = {
   sm: 576,
@@ -27,7 +27,7 @@ export const breakpointsBootstrapV5 = {
 /**
  * Breakpoints from Vuetify V2
  *
- * @link https://vuetifyjs.com/en/features/breakpoints
+ * @see https://vuetifyjs.com/en/features/breakpoints
  */
 export const breakpointsVuetify = {
   xs: 600,
@@ -39,7 +39,7 @@ export const breakpointsVuetify = {
 /**
  * Breakpoints from Ant Design
  *
- * @link https://ant.design/components/layout/#breakpoint-width
+ * @see https://ant.design/components/layout/#breakpoint-width
  */
 export const breakpointsAntDesign = {
   xs: 480,

diff --git a/packages/core/useBreakpoints/index.md b/packages/core/useBreakpoints/index.md
@@ -41,7 +41,7 @@ export declare type Breakpoints<K extends string = string> = Record<
 /**
  * Reactively viewport breakpoints
  *
- * @link https://vueuse.org/useBreakpoints
+ * @see https://vueuse.org/useBreakpoints
  * @param options
  */
 export declare function useBreakpoints<K extends string>(

diff --git a/packages/core/useBreakpoints/index.ts b/packages/core/useBreakpoints/index.ts
@@ -8,7 +8,7 @@ export type Breakpoints<K extends string = string> = Record<K, number | string>
 /**
  * Reactively viewport breakpoints
  *
- * @link https://vueuse.org/useBreakpoints
+ * @see https://vueuse.org/useBreakpoints
  * @param options
  */
 export function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, options: ConfigurableWindow = {}) {

diff --git a/packages/core/useBrowserLocation/index.md b/packages/core/useBrowserLocation/index.md
@@ -36,7 +36,7 @@ export interface BrowserLocationState {
 /**
  * Reactive browser location.
  *
- * @link https://vueuse.org/useBrowserLocation
+ * @see https://vueuse.org/useBrowserLocation
  * @param options
  */
 export declare function useBrowserLocation({

diff --git a/packages/core/useBrowserLocation/index.ts b/packages/core/useBrowserLocation/index.ts
@@ -22,7 +22,7 @@ export interface BrowserLocationState {
 /**
  * Reactive browser location.
  *
- * @link https://vueuse.org/useBrowserLocation
+ * @see https://vueuse.org/useBrowserLocation
  * @param options
  */
 export function useBrowserLocation({ window = defaultWindow }: ConfigurableWindow = {}) {

diff --git a/packages/core/useClipboard/index.md b/packages/core/useClipboard/index.md
@@ -56,7 +56,7 @@ export interface ClipboardReturn<Optional> {
 /**
  * Reactive Clipboard API.
  *
- * @link https://vueuse.org/useClipboard
+ * @see https://vueuse.org/useClipboard
  * @param options
  */
 export declare function useClipboard(

diff --git a/packages/core/useClipboard/index.ts b/packages/core/useClipboard/index.ts
@@ -36,7 +36,7 @@ export interface ClipboardReturn<Optional> {
 /**
  * Reactive Clipboard API.
  *
- * @link https://vueuse.org/useClipboard
+ * @see https://vueuse.org/useClipboard
  * @param options
  */
 export function useClipboard(options?: ClipboardOptions<undefined>): ClipboardReturn<false>

diff --git a/packages/core/useCssVar/index.md b/packages/core/useCssVar/index.md
@@ -23,7 +23,7 @@ const color = useCssVar('--color', el)
 /**
  * Manipulate CSS variables.
  *
- * @link https://vueuse.org/useCssVar
+ * @see https://vueuse.org/useCssVar
  * @param prop
  * @param el
  * @param options

diff --git a/packages/core/useCssVar/index.ts b/packages/core/useCssVar/index.ts
@@ -5,7 +5,7 @@ import { MaybeElementRef, unrefElement } from '../unrefElement'
 /**
  * Manipulate CSS variables.
  *
- * @link https://vueuse.org/useCssVar
+ * @see https://vueuse.org/useCssVar
  * @param prop
  * @param el
  * @param options

diff --git a/packages/core/useDark/index.md b/packages/core/useDark/index.md
@@ -126,7 +126,7 @@ export declare type ColorSchemes = "light" | "dark" | "auto"
 /**
  * Reactive dark mode with auto data persistence.
  *
- * @link https://vueuse.org/useDark
+ * @see https://vueuse.org/useDark
  * @param options
  */
 export declare function useDark(

diff --git a/packages/core/useDark/index.ts b/packages/core/useDark/index.ts
@@ -63,7 +63,7 @@ export type ColorSchemes = 'light' | 'dark' | 'auto'
 /**
  * Reactive dark mode with auto data persistence.
  *
- * @link https://vueuse.org/useDark
+ * @see https://vueuse.org/useDark
  * @param options
  */
 export function useDark(options: UseDarkOptions = {}) {

diff --git a/packages/core/useDeviceLight/index.md b/packages/core/useDeviceLight/index.md
@@ -26,7 +26,7 @@ const light = useDeviceLight()
 /**
  * Reactive DeviceLightEvent.
  *
- * @link https://vueuse.org/useDeviceLight
+ * @see https://vueuse.org/useDeviceLight
  * @param options
  */
 export declare function useDeviceLight({

diff --git a/packages/core/useDeviceLight/index.ts b/packages/core/useDeviceLight/index.ts
@@ -7,7 +7,7 @@ import { ConfigurableWindow, defaultWindow } from '../_configurable'
 /**
  * Reactive DeviceLightEvent.
  *
- * @link https://vueuse.org/useDeviceLight
+ * @see https://vueuse.org/useDeviceLight
  * @param options
  */
 export function useDeviceLight({ window = defaultWindow }: ConfigurableWindow = {}) {