From 9219128b89574e187e7a31c4112de6a01a483a86 Mon Sep 17 00:00:00 2001 From: sciencesakura Date: Sat, 25 Jul 2026 13:41:36 +0900 Subject: [PATCH] docs: Change the edition of JVMS from 21 to 25. --- .github/workflows/publish-docs.yaml | 1 + README.md | 4 ++-- packages/mutf-8-stream/src/index.ts | 4 ++-- packages/mutf-8/src/index.ts | 4 ++-- typedoc.json | 1 + 5 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml index 00813aa..2a140d9 100644 --- a/.github/workflows/publish-docs.yaml +++ b/.github/workflows/publish-docs.yaml @@ -11,6 +11,7 @@ on: - '!packages/**/*.test.*' - 'README.md' - 'tsconfig.json' + - 'typedoc.json' jobs: publish-api-docs: diff --git a/README.md b/README.md index c072e9d..eb4c8a4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Modified UTF-8 is a variant of UTF-8 encoding used internally by the Java platfo - **Null character**: The null character U+0000 is encoded as a 2-byte sequence 0xC0 0x80 instead of the single byte 0x00. - **Supplementary characters**: Characters whose code points are above U+FFFF are encoded as two 3-byte sequences instead of a single 4-byte sequence. -See [The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7](https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7) for more details. +See [The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7](https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7) for more details. ## Installation @@ -33,7 +33,7 @@ npm install mutf-8-stream ## Usage -The APIs are compatible with the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) standard, providing a simple interface for encoding and decoding Modified UTF-8. +The APIs are compatible with the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/), providing a simple interface for encoding and decoding Modified UTF-8. ### Basic Encoding and Decoding diff --git a/packages/mutf-8-stream/src/index.ts b/packages/mutf-8-stream/src/index.ts index bc8ed4e..bf5f9de 100644 --- a/packages/mutf-8-stream/src/index.ts +++ b/packages/mutf-8-stream/src/index.ts @@ -22,7 +22,7 @@ import { type AllowSharedBufferSource, MUtf8Decoder, MUtf8Encoder, type TextDeco * ``` * * @see {@link https://encoding.spec.whatwg.org/#interface-textdecoderstream | WHATWG Encoding Standard, TextDecoderStream} - * @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7} + * @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7} * @since v1.2.0 */ export class MUtf8DecoderStream extends TransformStream { @@ -99,7 +99,7 @@ export class MUtf8DecoderStream extends TransformStream { diff --git a/packages/mutf-8/src/index.ts b/packages/mutf-8/src/index.ts index f36e3d1..e32e5ba 100644 --- a/packages/mutf-8/src/index.ts +++ b/packages/mutf-8/src/index.ts @@ -121,7 +121,7 @@ export type AllowSharedBufferSource = ArrayBuffer | SharedArrayBuffer | ArrayBuf * ``` * * @see {@link https://encoding.spec.whatwg.org/#interface-textdecoder | WHATWG Encoding Standard, TextDecoder} - * @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7} + * @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7} */ export class MUtf8Decoder { readonly #fatal: boolean; @@ -311,7 +311,7 @@ export class MUtf8Decoder { * ``` * * @see {@link https://encoding.spec.whatwg.org/#interface-textencoder | WHATWG Encoding Standard, TextEncoder} - * @see {@link https://docs.oracle.com/javase/specs/jvms/se21/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 21 Edition, Section 4.4.7} + * @see {@link https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.4.7 | The Java Virtual Machine Specification, Java SE 25 Edition, Section 4.4.7} */ export class MUtf8Encoder { /** diff --git a/typedoc.json b/typedoc.json index 04892c9..13ddfe3 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,4 +1,5 @@ { + "$schema": "https://typedoc.org/schema.json", "entryPointStrategy": "packages", "entryPoints": ["packages/*"], "packageOptions": {