Skip to content
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

docs: fix broken {@link} hyperlinks #4241

Merged
merged 3 commits into from
Jan 25, 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
8 changes: 5 additions & 3 deletions collections/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@

/**
* Pure functions for common tasks around collection types like arrays and
* objects. Heavily inspired by
* [Kotlin's `kotlin.collections`]{@linkcode https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/}
* objects.
*
* Heavily inspired by
* {@link https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/ | Kotlin's Collections}
* package.
*
* @module.
* @module
*/

export * from "./aggregate_groups.ts";
Expand Down
2 changes: 1 addition & 1 deletion crypto/crypto.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

/**
* Extensions to the
* [Web Crypto API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API}
* {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API | Web Crypto API}
* supporting additional encryption APIs, but also delegating to the built-in
* APIs when possible.
*
Expand Down
10 changes: 5 additions & 5 deletions encoding/ascii85.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.

import { validateBinaryLike } from "./_util.ts";

/**
* Utilities for working with [ascii85]{@link https://en.wikipedia.org/wiki/Ascii85} encoding.
* Utilities for working with {@link https://en.wikipedia.org/wiki/Ascii85 | ascii85} encoding.
*
* This module is browser compatible.
*
Expand All @@ -13,8 +11,8 @@ import { validateBinaryLike } from "./_util.ts";
* By default, all functions are using the most popular Adobe version of ascii85
* and not adding any delimiter. However, there are three more standards
* supported - btoa (different delimiter and additional compression of 4 bytes
* equal to 32), [Z85](https://rfc.zeromq.org/spec/32/) and
* [RFC 1924](https://tools.ietf.org/html/rfc1924). It's possible to use a
* equal to 32), {@link https://rfc.zeromq.org/spec/32/ | Z85} and
* {@link https://tools.ietf.org/html/rfc1924 | RFC 1924}. It's possible to use a
* different encoding by specifying it in `options` object as a second parameter.
*
* Similarly, it's possible to make `encode` add a delimiter (`<~` and `~>` for
Expand All @@ -25,6 +23,8 @@ import { validateBinaryLike } from "./_util.ts";
* @module
*/

import { validateBinaryLike } from "./_util.ts";

/** Supported ascii85 standards for {@linkcode Ascii85Options}. */
export type Ascii85Standard = "Adobe" | "btoa" | "RFC 1924" | "Z85";

Expand Down
6 changes: 3 additions & 3 deletions encoding/base32.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
// Copyright (c) 2014 Jameson Little. MIT License.
// This module is browser compatible.

import { validateBinaryLike } from "./_util.ts";

/**
* Utilities for
* [base32]{@link https://datatracker.ietf.org/doc/html/rfc4648#section-6}
* {@link https://datatracker.ietf.org/doc/html/rfc4648#section-6 | base32}
* encoding and decoding.
*
* Modified from {@link https://github.com/beatgammit/base64-js}.
Expand All @@ -16,6 +14,8 @@ import { validateBinaryLike } from "./_util.ts";
* @module
*/

import { validateBinaryLike } from "./_util.ts";

const lookup: string[] = [];
const revLookup: number[] = [];

Expand Down
6 changes: 3 additions & 3 deletions encoding/base58.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.

import { validateBinaryLike } from "./_util.ts";

/**
* Utilities for
* [base58]{@link https://datatracker.ietf.org/doc/html/draft-msporny-base58-03}
* {@link https://datatracker.ietf.org/doc/html/draft-msporny-base58-03 | base58}
* encoding and decoding.
*
* This module is browser compatible.
*
* @module
*/

import { validateBinaryLike } from "./_util.ts";

// deno-fmt-ignore
const mapBase58: Record<string, number> = {
"1": 0, "2": 1, "3": 2, "4": 3, "5": 4, "6": 5, "7": 6, "8": 7, "9": 8, A: 9,
Expand Down
6 changes: 3 additions & 3 deletions encoding/base64.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.

import { validateBinaryLike } from "./_util.ts";

/**
* Utilities for
* [base64]{@link https://datatracker.ietf.org/doc/html/rfc4648#section-4}
* {@link https://datatracker.ietf.org/doc/html/rfc4648#section-4 | base64}
* encoding and decoding.
*
* This module is browser compatible.
*
* @module
*/

import { validateBinaryLike } from "./_util.ts";

const base64abc = [
"A",
"B",
Expand Down
5 changes: 3 additions & 2 deletions encoding/base64url.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

/**
* Utilities for
* [base64url]{@link https://datatracker.ietf.org/doc/html/rfc4648#section-5}
* {@link https://datatracker.ietf.org/doc/html/rfc4648#section-5 | base64url}
* encoding and decoding.
*
* This module is browser compatible.
Expand All @@ -13,9 +13,10 @@

import * as base64 from "./base64.ts";

/*
/**
* Some variants allow or require omitting the padding '=' signs:
* https://en.wikipedia.org/wiki/Base64#The_URL_applications
*
* @param base64url
*/
function addPaddingToBase64url(base64url: string): string {
Expand Down
6 changes: 3 additions & 3 deletions encoding/hex.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.

import { validateBinaryLike } from "./_util.ts";

/**
* Port of the Go
* [encoding/hex](https://github.com/golang/go/blob/go1.12.5/src/encoding/hex/hex.go)
* {@link https://github.com/golang/go/blob/go1.12.5/src/encoding/hex/hex.go | encoding/hex}
* library.
*
* This module is browser compatible.
Expand All @@ -31,6 +29,8 @@ import { validateBinaryLike } from "./_util.ts";
* @module
*/

import { validateBinaryLike } from "./_util.ts";

const hexTable = new TextEncoder().encode("0123456789abcdef");
const textEncoder = new TextEncoder();
const textDecoder = new TextDecoder();
Expand Down
10 changes: 5 additions & 5 deletions io/buf_reader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

/**
* @module
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/

import { assert } from "../assert/assert.ts";
Expand All @@ -17,7 +17,7 @@ const CR = "\r".charCodeAt(0);
const LF = "\n".charCodeAt(0);

/**
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class BufferFullError extends Error {
override name = "BufferFullError";
Expand All @@ -27,7 +27,7 @@ export class BufferFullError extends Error {
}

/**
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class PartialReadError extends Error {
override name = "PartialReadError";
Expand All @@ -40,15 +40,15 @@ export class PartialReadError extends Error {
/**
* Result type returned by of BufReader.readLine().
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export interface ReadLineResult {
line: Uint8Array;
more: boolean;
}

/**
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class BufReader implements Reader {
#buf!: Uint8Array;
Expand Down
4 changes: 2 additions & 2 deletions io/buf_writer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ abstract class AbstractBufBase {
* flush() method to guarantee all data has been forwarded to
* the underlying deno.Writer.
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class BufWriter extends AbstractBufBase implements Writer {
#writer: Writer;
Expand Down Expand Up @@ -133,7 +133,7 @@ export class BufWriter extends AbstractBufBase implements Writer {
* flush() method to guarantee all data has been forwarded to
* the underlying deno.WriterSync.
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class BufWriterSync extends AbstractBufBase implements WriterSync {
#writer: WriterSync;
Expand Down
2 changes: 1 addition & 1 deletion io/copy_n.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const DEFAULT_BUFFER_SIZE = 32 * 1024;
* @param dest Writer
* @param size Read size
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function copyN(
r: Reader,
Expand Down
2 changes: 1 addition & 1 deletion io/limited_reader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import type { Reader } from "./types.ts";

/**
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class LimitedReader implements Reader {
constructor(public reader: Reader, public limit: number) {}
Expand Down
2 changes: 1 addition & 1 deletion io/multi_reader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { Reader } from "./types.ts";
/**
* Reader utility for combining multiple readers
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class MultiReader implements Reader {
readonly #readers: Reader[];
Expand Down
2 changes: 1 addition & 1 deletion io/read_delim.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function createLPS(pat: Uint8Array): Uint8Array {
/**
* Read delimited bytes from a Reader.
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function* readDelim(
reader: Reader,
Expand Down
2 changes: 1 addition & 1 deletion io/read_int.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { readShort } from "./read_short.ts";
* Read big endian 32bit integer from BufReader
* @param buf
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function readInt(buf: BufReader): Promise<number | null> {
const high = await readShort(buf);
Expand Down
2 changes: 1 addition & 1 deletion io/read_lines.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { concat } from "../bytes/concat.ts";
* }
* ```
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function* readLines(
reader: Reader,
Expand Down
2 changes: 1 addition & 1 deletion io/read_long.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const MAX_SAFE_INTEGER = BigInt(Number.MAX_SAFE_INTEGER);
* Read big endian 64bit long from BufReader
* @param buf
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function readLong(buf: BufReader): Promise<number | null> {
const high = await readInt(buf);
Expand Down
6 changes: 3 additions & 3 deletions io/read_range.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { Reader, ReaderSync } from "./types.ts";
const DEFAULT_BUFFER_SIZE = 32 * 1024;

/**
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export interface ByteRange {
/** The 0 based index of the start byte for a range. */
Expand All @@ -32,7 +32,7 @@ export interface ByteRange {
* assertEquals(bytes.length, 10);
* ```
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function readRange(
r: Reader & Deno.Seeker,
Expand Down Expand Up @@ -72,7 +72,7 @@ export async function readRange(
* assertEquals(bytes.length, 10);
* ```
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export function readRangeSync(
r: ReaderSync & Deno.SeekerSync,
Expand Down
2 changes: 1 addition & 1 deletion io/read_short.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { type BufReader } from "./buf_reader.ts";
* Read big endian 16bit short from BufReader
* @param buf
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function readShort(buf: BufReader): Promise<number | null> {
const high = await buf.readByte();
Expand Down
2 changes: 1 addition & 1 deletion io/read_string_delim.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { readDelim } from "./read_delim.ts";
* }
* ```
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export async function* readStringDelim(
reader: Reader,
Expand Down
2 changes: 1 addition & 1 deletion io/slice_long_to_bytes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* @param d The number to be sliced
* @param dest The sliced array
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export function sliceLongToBytes(
d: number,
Expand Down
2 changes: 1 addition & 1 deletion io/string_reader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import { Buffer } from "./buffer.ts";
* abcdef
* ```
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class StringReader extends Buffer {
constructor(s: string) {
Expand Down
2 changes: 1 addition & 1 deletion io/string_writer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const decoder = new TextDecoder();
* base0123456789
* ```
*
* @deprecated (will be removed after 1.0.0) Use the [Web Streams API]{@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API} instead.
* @deprecated (will be removed after 1.0.0) Use the {@link https://developer.mozilla.org/en-US/docs/Web/API/Streams_API | Web Streams API} instead.
*/
export class StringWriter implements Writer, WriterSync {
#chunks: Uint8Array[] = [];
Expand Down
Loading