Skip to content

chore: remove links from docs #13425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions packages/svelte/src/action/public.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@
* };
* }
* ```
*
* Docs: https://svelte.dev/docs/svelte-action
*/
export interface ActionReturn<
Parameter = undefined,
Expand Down Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion packages/svelte/src/animate/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions packages/svelte/src/compiler/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand All @@ -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
Expand All @@ -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]
Expand All @@ -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}
Expand Down
1 change: 0 additions & 1 deletion packages/svelte/src/compiler/preprocess/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
31 changes: 0 additions & 31 deletions packages/svelte/src/easing/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
Expand All @@ -13,7 +12,6 @@ export function linear(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -24,7 +22,6 @@ export function backInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -34,7 +31,6 @@ export function backIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -44,7 +40,6 @@ export function backOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -66,7 +61,6 @@ export function bounceOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -75,7 +69,6 @@ export function bounceInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -84,7 +77,6 @@ export function bounceIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -94,7 +86,6 @@ export function circInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -103,7 +94,6 @@ export function circIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -112,7 +102,6 @@ export function circOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -121,7 +110,6 @@ export function cubicInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -130,7 +118,6 @@ export function cubicIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -140,7 +127,6 @@ export function cubicOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -154,7 +140,6 @@ export function elasticInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -163,7 +148,6 @@ export function elasticIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -172,7 +156,6 @@ export function elasticOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -185,7 +168,6 @@ export function expoInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -194,7 +176,6 @@ export function expoIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -203,7 +184,6 @@ export function expoOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -215,7 +195,6 @@ export function quadInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -224,7 +203,6 @@ export function quadIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -233,7 +211,6 @@ export function quadOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -242,7 +219,6 @@ export function quartInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -251,7 +227,6 @@ export function quartIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -260,7 +235,6 @@ export function quartOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -270,7 +244,6 @@ export function quintInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -279,7 +252,6 @@ export function quintIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -288,7 +260,6 @@ export function quintOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -297,7 +268,6 @@ export function sineInOut(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand All @@ -308,7 +278,6 @@ export function sineIn(t) {
}

/**
* https://svelte.dev/docs/svelte-easing
* @param {number} t
* @returns {number}
*/
Expand Down
5 changes: 0 additions & 5 deletions packages/svelte/src/index-client.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand All @@ -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}
*/
Expand Down Expand Up @@ -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>}
Expand Down Expand Up @@ -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}
Expand All @@ -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}
Expand Down
4 changes: 0 additions & 4 deletions packages/svelte/src/internal/client/runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand All @@ -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
Expand All @@ -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}
*/
Expand All @@ -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}
*/
Expand Down
Loading