chore: remove links from docs (#13425)

* chore: remove links from docs * regenerate
sveltejs · Sep 28, 2024 · d87bf17 · d87bf17
1 parent 35ebbe6
commit d87bf17
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 194 deletions.
diff --git a/packages/svelte/src/action/public.d.ts b/packages/svelte/src/action/public.d.ts
@@ -23,8 +23,6 @@
  * 	};
  * }
  * ```
- *
- * Docs: https://svelte.dev/docs/svelte-action
  */
 export interface ActionReturn<
 	Parameter = undefined,
@@ -54,8 +52,6 @@ export interface ActionReturn<
  *
  * You can return an object with methods `update` and `destroy` from the function and type which additional attributes and events it has.
  * See interface `ActionReturn` for more details.
- *
- * Docs: https://svelte.dev/docs/svelte-action
  */
 export interface Action<
 	Element = HTMLElement,

diff --git a/packages/svelte/src/animate/index.js b/packages/svelte/src/animate/index.js
@@ -5,7 +5,6 @@ import { cubicOut } from '../easing/index.js';
  * The flip function calculates the start and end position of an element and animates between them, translating the x and y values.
  * `flip` stands for [First, Last, Invert, Play](https://aerotwist.com/blog/flip-your-animations/).
  *
- * https://svelte.dev/docs/svelte-animate#flip
  * @param {Element} node
  * @param {{ from: DOMRect; to: DOMRect }} fromTo
  * @param {FlipParams} params

diff --git a/packages/svelte/src/compiler/index.js b/packages/svelte/src/compiler/index.js
@@ -15,7 +15,6 @@ export { default as preprocess } from './preprocess/index.js';
 /**
  * `compile` converts your `.svelte` source code into a JavaScript module that exports a component
  *
- * https://svelte.dev/docs/svelte-compiler#svelte-compile
  * @param {string} source The component source code
  * @param {CompileOptions} options The compiler options
  * @returns {CompileResult}
@@ -54,7 +53,6 @@ export function compile(source, options) {
 /**
  * `compileModule` takes your JavaScript source code containing runes, and turns it into a JavaScript module.
  *
- * https://svelte.dev/docs/svelte-compiler#svelte-compile
  * @param {string} source The component source code
  * @param {ModuleCompileOptions} options
  * @returns {CompileResult}
@@ -74,7 +72,6 @@ export function compileModule(source, options) {
  * The `modern` option (`false` by default in Svelte 5) makes the parser return a modern AST instead of the legacy AST.
  * `modern` will become `true` by default in Svelte 6, and the option will be removed in Svelte 7.
  *
- * https://svelte.dev/docs/svelte-compiler#svelte-parse
  * @overload
  * @param {string} source
  * @param {{ filename?: string; modern: true }} options
@@ -87,7 +84,6 @@ export function compileModule(source, options) {
  * The `modern` option (`false` by default in Svelte 5) makes the parser return a modern AST instead of the legacy AST.
  * `modern` will become `true` by default in Svelte 6, and the option will be removed in Svelte 7.
  *
- * https://svelte.dev/docs/svelte-compiler#svelte-parse
  * @overload
  * @param {string} source
  * @param {{ filename?: string; modern?: false }} [options]
@@ -100,7 +96,6 @@ export function compileModule(source, options) {
  * The `modern` option (`false` by default in Svelte 5) makes the parser return a modern AST instead of the legacy AST.
  * `modern` will become `true` by default in Svelte 6, and the option will be removed in Svelte 7.
  *
- * https://svelte.dev/docs/svelte-compiler#svelte-parse
  * @param {string} source
  * @param {{ filename?: string; rootDir?: string; modern?: boolean }} [options]
  * @returns {AST.Root | LegacyRoot}

diff --git a/packages/svelte/src/compiler/preprocess/index.js b/packages/svelte/src/compiler/preprocess/index.js
@@ -330,7 +330,6 @@ async function process_markup(process, source) {
  * The preprocess function provides convenient hooks for arbitrarily transforming component source code.
  * For example, it can be used to convert a <style lang="sass"> block into vanilla CSS.
  *
- * https://svelte.dev/docs/svelte-compiler#svelte-preprocess
  * @param {string} source
  * @param {PreprocessorGroup | PreprocessorGroup[]} preprocessor
  * @param {{ filename?: string }} [options]

diff --git a/packages/svelte/src/easing/index.js b/packages/svelte/src/easing/index.js
@@ -4,7 +4,6 @@ Distributed under MIT License https://github.com/mattdesl/eases/blob/master/LICE
 */
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -13,7 +12,6 @@ export function linear(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -24,7 +22,6 @@ export function backInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -34,7 +31,6 @@ export function backIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -44,7 +40,6 @@ export function backOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -66,7 +61,6 @@ export function bounceOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -75,7 +69,6 @@ export function bounceInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -84,7 +77,6 @@ export function bounceIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -94,7 +86,6 @@ export function circInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -103,7 +94,6 @@ export function circIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -112,7 +102,6 @@ export function circOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -121,7 +110,6 @@ export function cubicInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -130,7 +118,6 @@ export function cubicIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -140,7 +127,6 @@ export function cubicOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -154,7 +140,6 @@ export function elasticInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -163,7 +148,6 @@ export function elasticIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -172,7 +156,6 @@ export function elasticOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -185,7 +168,6 @@ export function expoInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -194,7 +176,6 @@ export function expoIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -203,7 +184,6 @@ export function expoOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -215,7 +195,6 @@ export function quadInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -224,7 +203,6 @@ export function quadIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -233,7 +211,6 @@ export function quadOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -242,7 +219,6 @@ export function quartInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -251,7 +227,6 @@ export function quartIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -260,7 +235,6 @@ export function quartOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -270,7 +244,6 @@ export function quintInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -279,7 +252,6 @@ export function quintIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -288,7 +260,6 @@ export function quintOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -297,7 +268,6 @@ export function sineInOut(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */
@@ -308,7 +278,6 @@ export function sineIn(t) {
 }
 
 /**
- * https://svelte.dev/docs/svelte-easing
  * @param {number} t
  * @returns {number}
  */

diff --git a/packages/svelte/src/index-client.js b/packages/svelte/src/index-client.js
@@ -16,7 +16,6 @@ import { lifecycle_outside_component } from './internal/shared/errors.js';
  *
  * `onMount` does not run inside a [server-side component](https://svelte.dev/docs#run-time-server-side-component-api).
  *
- * https://svelte.dev/docs/svelte#onmount
  * @template T
  * @param {() => NotFunction<T> | Promise<NotFunction<T>> | (() => any)} fn
  * @returns {void}
@@ -42,7 +41,6 @@ export function onMount(fn) {
  * Out of `onMount`, `beforeUpdate`, `afterUpdate` and `onDestroy`, this is the
  * only one that runs inside a server-side component.
  *
- * https://svelte.dev/docs/svelte#ondestroy
  * @param {() => any} fn
  * @returns {void}
  */
@@ -84,7 +82,6 @@ function create_custom_event(type, detail, { bubbles = false, cancelable = false
  * }>();
  * ```
  *
- * https://svelte.dev/docs/svelte#createeventdispatcher
  * @deprecated Use callback props and/or the `$host()` rune instead — see https://svelte-5-preview.vercel.app/docs/deprecations#createeventdispatcher
  * @template {Record<string, any>} [EventMap = any]
  * @returns {EventDispatcher<EventMap>}
@@ -124,7 +121,6 @@ export function createEventDispatcher() {
  *
  * In runes mode use `$effect.pre` instead.
  *
- * https://svelte.dev/docs/svelte#beforeupdate
  * @deprecated Use `$effect.pre` instead — see https://svelte-5-preview.vercel.app/docs/deprecations#beforeupdate-and-afterupdate
  * @param {() => void} fn
  * @returns {void}
@@ -148,7 +144,6 @@ export function beforeUpdate(fn) {
  *
  * In runes mode use `$effect` instead.
  *
- * https://svelte.dev/docs/svelte#afterupdate
  * @deprecated Use `$effect` instead — see https://svelte-5-preview.vercel.app/docs/deprecations#beforeupdate-and-afterupdate
  * @param {() => void} fn
  * @returns {void}

diff --git a/packages/svelte/src/internal/client/runtime.js b/packages/svelte/src/internal/client/runtime.js
@@ -859,7 +859,6 @@ export function set_signal_status(signal, status) {
  * Retrieves the context that belongs to the closest parent component with the specified `key`.
  * Must be called during component initialisation.
  *
- * https://svelte.dev/docs/svelte#getcontext
  * @template T
  * @param {any} key
  * @returns {T}
@@ -885,7 +884,6 @@ export function getContext(key) {
  *
  * Like lifecycle functions, this must be called during component initialisation.
  *
- * https://svelte.dev/docs/svelte#setcontext
  * @template T
  * @param {any} key
  * @param {T} context
@@ -901,7 +899,6 @@ export function setContext(key, context) {
  * Checks whether a given `key` has been set in the context of a parent component.
  * Must be called during component initialisation.
  *
- * https://svelte.dev/docs/svelte#hascontext
  * @param {any} key
  * @returns {boolean}
  */
@@ -915,7 +912,6 @@ export function hasContext(key) {
  * Must be called during component initialisation. Useful, for example, if you
  * programmatically create a component and want to pass the existing context to it.
  *
- * https://svelte.dev/docs/svelte#getallcontexts
  * @template {Map<any, any>} [T=Map<any, any>]
  * @returns {T}
  */