docs: include JSDoc in website API markers

website/zh-CN/api/cordis/context.md

@@ -12,6 +12,15 @@ A context is a proxy: normal property reads go through the service resolver, whi
 ### ctx.extend(meta?)
 
 ```ts website-api
+/**
+ * Create a child context with extra metadata on top of the current scope.
+ *
+ * The child prototypally inherits every property of this context; own
+ * properties of `meta` shadow the inherited ones. The parent is not mutated.
+ *
+ * @param meta — own properties (including symbol keys) to define on the child.
+ * @returns a child context inheriting from this one.
+ */
 extend(meta = {}): this
 ```
 
@@ -27,6 +36,18 @@ The child prototypally inherits every property of this context; own properties o
 ### ctx.isolate(name, label?)
 
 ```ts website-api
+/**
+ * Create a child context with an independent service scope for `name`.
+ *
+ * Below the returned context, reads and writes of the service `name`
+ * resolve against the new label instead of the parent's, so a different
+ * implementation can be provided without affecting the parent scope.
+ * Passing the same `label` to two `isolate()` calls joins their scopes.
+ *
+ * @param name — the service name to isolate.
+ * @param label — scope label to join; defaults to a fresh unique symbol.
+ * @returns a child context whose `name` service resolves in the new scope.
+ */
 isolate(name: string, label?: symbol)
 ```
 
@@ -43,6 +64,18 @@ Below the returned context, reads and writes of the service `name` resolve again
 ### ctx.intercept(name, config)
 
 ```ts website-api
+/**
+ * Add service-specific intercept config for plugins started below this
+ * context.
+ *
+ * Plugins loaded under the returned context see `config` merged into the
+ * service's resolved config (ancestor entries first; see
+ * `Service[symbols.resolveConfig]`). The parent context is not affected.
+ *
+ * @param name — the service name whose config to intercept.
+ * @param config — the intercept config to merge for that service.
+ * @returns a child context carrying the additional intercept entry.
+ */
 intercept<K extends InjectKey>(name: K, config: Context[K] extends { [symbols.config]: infer T } ? T : never): this
 intercept(name: string, config: any): this
 ```
@@ -60,6 +93,7 @@ Plugins loaded under the returned context see `config` merged into the service's
 ### ctx.root
 
 ```ts website-api
+/** The root context of the application (every child context shares it). @experimental */
 root: this
 ```
 
@@ -70,6 +104,7 @@ The root context of the application (every child context shares it). @experiment
 ### ctx.baseUrl
 
 ```ts website-api
+/** Base URL used to resolve relative plugin/module specifiers, if the runtime sets one. */
 baseUrl?: string
 ```
 
@@ -80,6 +115,7 @@ Base URL used to resolve relative plugin/module specifiers, if the runtime sets
 ### ctx.events
 
 ```ts website-api
+/** The event bus. Its methods are also mixed onto `ctx` (`ctx.on`, `ctx.emit`, ...). */
 events: EventsService
 ```
 
@@ -90,6 +126,7 @@ The event bus. Its methods are also mixed onto `ctx` (`ctx.on`, `ctx.emit`, ...)
 ### ctx.logger
 
 ```ts website-api
+/** The logging service. Call `ctx.logger(name)` for a named logger. */
 logger: LoggerService
 ```
 
@@ -100,6 +137,7 @@ The logging service. Call `ctx.logger(name)` for a named logger.
 ### ctx.reflect
 
 ```ts website-api
+/** The reflection layer backing the context proxy (`ctx.get`, `ctx.provide`, ...). */
 reflect: ReflectService
 ```
 
@@ -110,6 +148,7 @@ The reflection layer backing the context proxy (`ctx.get`, `ctx.provide`, ...).
 ### ctx.registry
 
 ```ts website-api
+/** The plugin registry. Its methods are mixed onto `ctx` (`ctx.plugin`, `ctx.inject`). */
 registry: RegistryService
 ```
 
@@ -122,6 +161,7 @@ The plugin registry. Its methods are mixed onto `ctx` (`ctx.plugin`, `ctx.inject
 ### Context.effect
 
 ```ts website-api
+/** Symbol key under which a disposer exposes its {@link EffectMeta} diagnostics tree. */
 static readonly effect: unique symbol
 ```
 
@@ -132,6 +172,7 @@ Symbol key under which a disposer exposes its EffectMeta diagnostics tree.
 ### Context.filter
 
 ```ts website-api
+/** Symbol key for a context's listener filter, consulted on every event dispatch. */
 static readonly filter: unique symbol
 ```
 
@@ -142,6 +183,7 @@ Symbol key for a context's listener filter, consulted on every event dispatch.
 ### Context.isolate
 
 ```ts website-api
+/** Symbol key of the isolation map (see the `Context[symbols.isolate]` property). */
 static readonly isolate: unique symbol
 ```
 
@@ -152,6 +194,7 @@ Symbol key of the isolation map (see the `Context[symbols.isolate]` property).
 ### Context.intercept
 
 ```ts website-api
+/** Symbol key of the intercept map (see the `Context[symbols.intercept]` property). */
 static readonly intercept: unique symbol
 ```
 
@@ -162,6 +205,15 @@ Symbol key of the intercept map (see the `Context[symbols.intercept]` property).
 ### Context.is(value)
 
 ```ts website-api
+/**
+ * Returns true for Cordis context proxies and context prototypes.
+ *
+ * Works across realms and across multiple copies of cordis, because the
+ * brand is keyed by a global symbol rather than by `instanceof`.
+ *
+ * @param value — the value to test.
+ * @returns `true` if `value` is a Cordis context, narrowing its type.
+ */
 static is(value: any): value is Context
 ```
 
@@ -179,6 +231,14 @@ Works across realms and across multiple copies of cordis, because the brand is k
 ### ctx.get(name, strict?)
 
 ```ts website-api
+/**
+ * Read a service from the store without the inject requirement.
+ *
+ * @param name — the service name.
+ * @param strict — when `true` (default), only return implementations
+ * whose providing fiber is currently active.
+ * @returns the service value, or `undefined` when not (yet) provided.
+ */
 get<K extends string & keyof this>(name: K, strict?: boolean): undefined | this[K]
 get(name: string, strict?: boolean): any
 ```
@@ -195,6 +255,15 @@ Read a service from the store without the inject requirement.
 ### ctx.set(name, value)
 
 ```ts website-api
+/**
+ * Overwrite a provided service's value.
+ *
+ * Only the fiber that provided the service may set it; setting an
+ * unprovided name throws.
+ *
+ * @param name — the service name.
+ * @param value — the new service value.
+ */
 set<K extends string & keyof this>(name: K, value: undefined | this[K]): void
 set(name: string, value: any): void
 ```
@@ -210,6 +279,18 @@ Only the fiber that provided the service may set it; setting an unprovided name
 ### ctx.provide(name, value)
 
 ```ts website-api
+/**
+ * Register a service implementation owned by the current fiber.
+ *
+ * The service becomes visible to dependents in the same isolation scope
+ * once the fiber is active; it is unregistered (waking dependents) when
+ * the returned disposer runs or the fiber unloads. Throws if the name is
+ * already provided in this scope or declared as an accessor.
+ *
+ * @param name — the service name.
+ * @param value — the service value.
+ * @returns a disposer that unregisters the service.
+ */
 provide<K extends string & keyof this>(name: K, value: undefined | this[K]): () => void
 provide(name: string, value?: any): () => void
 ```
@@ -227,6 +308,15 @@ The service becomes visible to dependents in the same isolation scope once the f
 ### ctx.accessor(name, options)
 
 ```ts website-api
+/**
+ * Define a computed context property backed by get/set hooks.
+ *
+ * The accessor is removed when the current fiber unloads. Throws if the
+ * name is already declared.
+ *
+ * @param name — the context property name.
+ * @param options — the `get` hook and optional `set` hook.
+ */
 accessor(name: string, options: Omit<Property.Accessor, 'type'>): void
 ```
 
@@ -241,6 +331,16 @@ The accessor is removed when the current fiber unloads. Throws if the name is al
 ### ctx.mixin(name, mixins)
 
 ```ts website-api
+/**
+ * Expose selected members of a service directly on `ctx`.
+ *
+ * Each mixed-in key becomes an accessor that forwards to the service
+ * (binding methods to it), so e.g. `ctx.on` forwards to `ctx.events.on`.
+ * Mixins are removed when the current fiber unloads.
+ *
+ * @param name — the context property holding the source service.
+ * @param mixins — keys to forward, or a source-key → ctx-key map.
+ */
 mixin<K extends string & keyof this>(name: K, mixins: (keyof this & keyof this[K])[] | Dict<string>): void
 mixin<T extends {}>(source: T, mixins: (keyof this & keyof T)[] | Dict<string>): void
 ```

website/zh-CN/api/cordis/events.md

@@ -7,6 +7,13 @@ The event system mixed into every context. Harness-defined events are cataloged
 ### ctx.parallel(name, ...args)
 
 ```ts website-api
+/**
+ * Dispatch an event, running all listeners concurrently.
+ *
+ * @param name — the event name.
+ * @param args — arguments passed to every listener.
+ * @returns a promise resolving once every listener has settled.
+ */
 parallel<K extends keyof Events>(name: K, ...args: Parameters<Events[K]>): Promise<void>
 parallel<K extends keyof Events>(thisArg: NoInfer<ThisType<Events[K]>>, name: K, ...args: Parameters<Events[K]>): Promise<void>
 ```
@@ -23,6 +30,12 @@ Dispatch an event, running all listeners concurrently.
 ### ctx.emit(name, ...args)
 
 ```ts website-api
+/**
+ * Dispatch an event synchronously, ignoring listener return values.
+ *
+ * @param name — the event name.
+ * @param args — arguments passed to every listener.
+ */
 emit<K extends keyof Events>(name: K, ...args: Parameters<Events[K]>): void
 emit<K extends keyof Events>(thisArg: NoInfer<ThisType<Events[K]>>, name: K, ...args: Parameters<Events[K]>): void
 ```
@@ -37,6 +50,13 @@ Dispatch an event synchronously, ignoring listener return values.
 ### ctx.serial(name, ...args)
 
 ```ts website-api
+/**
+ * Dispatch an event, awaiting listeners in order until one bails.
+ *
+ * @param name — the event name.
+ * @param args — arguments passed to each listener.
+ * @returns the first bail value (non-null, non-false, non-undefined), if any.
+ */
 serial<K extends keyof Events>(name: K, ...args: Parameters<Events[K]>): Promisify<ReturnType<Events[K]>>
 serial<K extends keyof Events>(thisArg: NoInfer<ThisType<Events[K]>>, name: K, ...args: Parameters<Events[K]>): Promisify<ReturnType<Events[K]>>
 ```
@@ -53,6 +73,13 @@ Dispatch an event, awaiting listeners in order until one bails.
 ### ctx.bail(name, ...args)
 
 ```ts website-api
+/**
+ * Dispatch an event, calling listeners in order until one bails.
+ *
+ * @param name — the event name.
+ * @param args — arguments passed to each listener.
+ * @returns the first bail value (non-null, non-false, non-undefined), if any.
+ */
 bail<K extends keyof Events>(name: K, ...args: Parameters<Events[K]>): ReturnType<Events[K]>
 bail<K extends keyof Events>(thisArg: NoInfer<ThisType<Events[K]>>, name: K, ...args: Parameters<Events[K]>): ReturnType<Events[K]>
 ```
@@ -69,6 +96,16 @@ Dispatch an event, calling listeners in order until one bails.
 ### ctx.waterfall(name, ...args)
 
 ```ts website-api
+/**
+ * Dispatch an event whose last argument is a `next` continuation.
+ *
+ * Each listener wraps the rest of the chain: calling `next()` invokes the
+ * next listener (finally the built-in behavior); not calling it vetoes.
+ *
+ * @param name — the event name.
+ * @param args — listener arguments; the final one is the innermost `next`.
+ * @returns the outermost listener's return value.
+ */
 waterfall<K extends keyof Events>(name: K, ...args: Parameters<Events[K]>): ReturnType<Events[K]>
 waterfall<K extends keyof Events>(thisArg: NoInfer<ThisType<Events[K]>>, name: K, ...args: Parameters<Events[K]>): ReturnType<Events[K]>
 ```
@@ -86,6 +123,14 @@ Each listener wraps the rest of the chain: calling `next()` invokes the next lis
 ### ctx.on(name, listener, options?)
 
 ```ts website-api
+/**
+ * Register an event listener owned by the current fiber.
+ *
+ * @param name — the event name to listen for.
+ * @param listener — called with the dispatch arguments.
+ * @param options — listener options; a boolean is shorthand for `prepend`.
+ * @returns a disposer removing the listener; `true` if it was still registered.
+ */
 on<K extends keyof Events>(name: K, listener: Events[K], options?: boolean | EventOptions): () => boolean
 ```
 
@@ -102,6 +147,14 @@ Register an event listener owned by the current fiber.
 ### ctx.once(name, listener, options?)
 
 ```ts website-api
+/**
+ * Same as `on()`, but the listener disposes itself after its first call.
+ *
+ * @param name — the event name to listen for.
+ * @param listener — called at most once with the dispatch arguments.
+ * @param options — listener options; a boolean is shorthand for `prepend`.
+ * @returns a disposer removing the listener; `true` if it was still registered.
+ */
 once<K extends keyof Events>(name: K, listener: Events[K], options?: boolean | EventOptions): () => boolean
 ```
 
@@ -120,6 +173,7 @@ Same as `on()`, but the listener disposes itself after its first call.
 Options accepted by `ctx.on()` and `ctx.once()`.
 
 ```ts website-api
+/** Options accepted by `ctx.on()` and `ctx.once()`. */
 interface EventOptions {
   /** Add the listener before existing listeners for the same event. */
   prepend?: boolean
@@ -136,6 +190,14 @@ Event dispatch strategy used by the event service.
 `emit` runs synchronous listeners without awaiting them, `parallel` awaits all listeners together, `serial` awaits them in order until one bails, `bail` stops on the first synchronous bail value, and `waterfall` composes listeners around a final `next` callback.
 
 ```ts website-api
+/**
+ * Event dispatch strategy used by the event service.
+ *
+ * `emit` runs synchronous listeners without awaiting them, `parallel` awaits
+ * all listeners together, `serial` awaits them in order until one bails,
+ * `bail` stops on the first synchronous bail value, and `waterfall` composes
+ * listeners around a final `next` callback.
+ */
 type DispatchMode = 'emit' | 'parallel' | 'serial' | 'bail' | 'waterfall'
 ```
 

website/zh-CN/api/cordis/fiber.md

@@ -7,6 +7,19 @@ A fiber is one loaded plugin instance: its lifecycle state, validated config, an
 ### ctx.effect(execute, label?)
 
 ```ts website-api
+/**
+ * Register a cleanup-aware effect on this fiber.
+ *
+ * `execute` runs immediately; the disposers it produces are collected and
+ * run (in reverse order) either when the returned disposer is called or
+ * when the fiber unloads, whichever comes first. Calling the disposer twice
+ * is a no-op. Throws `CordisError('INACTIVE_EFFECT')` if the fiber is
+ * already disposed, and `TypeError` if `execute` returns an invalid shape.
+ *
+ * @param execute — the effect body; see {@link Effect} for accepted shapes.
+ * @param label — effect label shown in `getEffects()` diagnostics.
+ * @returns a disposer that tears the effect down and settles once done.
+ */
 effect(execute: () => SyncEffect, label?: string): Disposable<Promise<void>>
 effect(execute: () => Effect, label?: string): AsyncDisposable<Promise<void>>
 ```
@@ -24,6 +37,7 @@ Register a cleanup-aware effect on this fiber.
 ### ctx.fiber
 
 ```ts website-api
+/** The fiber (plugin runtime instance) that owns this context. */
 fiber: Fiber
 ```
 
@@ -41,6 +55,7 @@ A fiber tracks dependency state, validated config, lifecycle effects, and cleanu
 ### fiber.uid
 
 ```ts website-api
+/** Unique id within the registry; 0 for the root fiber, `null` once disposed. */
 public uid: number | null
 ```
 
@@ -51,6 +66,7 @@ Unique id within the registry; 0 for the root fiber, `null` once disposed.
 ### fiber.ctx
 
 ```ts website-api
+/** The context this fiber's plugin runs in (extends the parent context). */
 public readonly ctx: Context
 ```
 
@@ -61,6 +77,7 @@ The context this fiber's plugin runs in (extends the parent context).
 ### fiber.config
 
 ```ts website-api
+/** The validated plugin config (updated by `update()`). */
 public config: any
 ```
 
@@ -71,6 +88,7 @@ The validated plugin config (updated by `update()`).
 ### fiber.state
 
 ```ts website-api
+/** Current lifecycle state; transitions emit `internal/status`. */
 public state
 ```
 
@@ -81,6 +99,7 @@ Current lifecycle state; transitions emit `internal/status`.
 ### fiber.dispose
 
 ```ts website-api
+/** Dispose this fiber: unload the plugin, then settle once cleanup finished. */
 public readonly dispose: () => Promise<void>
 ```
 
@@ -91,6 +110,7 @@ Dispose this fiber: unload the plugin, then settle once cleanup finished.
 ### fiber.store
 
 ```ts website-api
+/** Snapshot of required service implementations while loaded; `undefined` otherwise. */
 public store: Dict<Impl> | undefined
 ```
 
@@ -101,6 +121,7 @@ Snapshot of required service implementations while loaded; `undefined` otherwise
 ### fiber.inertia
 
 ```ts website-api
+/** The in-flight load/unload transition, if one is currently running. */
 public inertia: Promise<void> | undefined
 ```
 
@@ -111,6 +132,7 @@ The in-flight load/unload transition, if one is currently running.
 ### fiber.name
 
 ```ts website-api
+/** The plugin's display name, inherited from the nearest named ancestor, else `'root'`. */
 get name()
 ```
 
@@ -121,6 +143,12 @@ The plugin's display name, inherited from the nearest named ancestor, else `'roo
 ### fiber.assertActive()
 
 ```ts website-api
+/**
+ * Throw if the fiber has already been disposed.
+ *
+ * @returns nothing when the fiber is still active.
+ * @throws {CordisError} `INACTIVE_EFFECT` when the fiber's uid has been cleared.
+ */
 assertActive()
 ```
 
@@ -133,6 +161,19 @@ Throw if the fiber has already been disposed.
 ### fiber.effect(execute, label?)
 
 ```ts website-api
+/**
+ * Register a cleanup-aware effect on this fiber.
+ *
+ * `execute` runs immediately; the disposers it produces are collected and
+ * run (in reverse order) either when the returned disposer is called or
+ * when the fiber unloads, whichever comes first. Calling the disposer twice
+ * is a no-op. Throws `CordisError('INACTIVE_EFFECT')` if the fiber is
+ * already disposed, and `TypeError` if `execute` returns an invalid shape.
+ *
+ * @param execute — the effect body; see {@link Effect} for accepted shapes.
+ * @param label — effect label shown in `getEffects()` diagnostics.
+ * @returns a disposer that tears the effect down and settles once done.
+ */
 effect(execute: () => SyncEffect, label?: string): Disposable<Promise<void>>
 effect(execute: () => Effect, label?: string): AsyncDisposable<Promise<void>>
 ```
@@ -150,6 +191,11 @@ Register a cleanup-aware effect on this fiber.
 ### fiber.getEffects()
 
 ```ts website-api
+/**
+ * Return metadata for currently registered effects.
+ *
+ * @returns one {@link EffectMeta} tree per labeled live effect.
+ */
 getEffects()
 ```
 
@@ -162,6 +208,12 @@ Return metadata for currently registered effects.
 ### fiber.await()
 
 ```ts website-api
+/**
+ * Wait for current lifecycle work and rethrow startup errors.
+ *
+ * @returns this fiber, once it has settled into a stable state.
+ * @throws the config-validation or plugin-startup error, if any.
+ */
 async await()
 ```
 
@@ -174,6 +226,12 @@ Wait for current lifecycle work and rethrow startup errors.
 ### fiber.restart()
 
 ```ts website-api
+/**
+ * Dispose and immediately reload this plugin with its current config.
+ *
+ * @returns a promise resolving once the reload settled.
+ * @throws {CordisError} `INACTIVE_EFFECT` when the fiber is already disposed.
+ */
 async restart()
 ```
 
@@ -186,6 +244,17 @@ Dispose and immediately reload this plugin with its current config.
 ### fiber.update(config, noSave?)
 
 ```ts website-api
+/**
+ * Validate and apply new config, then restart the plugin.
+ *
+ * Runs the `internal/update` waterfall first, so update hooks (and HMR)
+ * can veto or replace the restart.
+ *
+ * @param config — the new raw config; validated before anything restarts.
+ * @param noSave — hint for persistence hooks not to write the change back.
+ * @returns nothing; the restart runs behind the `internal/update` waterfall.
+ * @throws {ValidationError} when the new config fails validation.
+ */
 update(config: any, noSave = false)
 ```
 
@@ -205,6 +274,13 @@ Effect body result accepted by `ctx.effect()` and plugin startup.
 Either a single disposer, a promise of one, or a (possibly async) iterable yielding several — generator effects register each yielded disposer as it is produced.
 
 ```ts website-api
+/**
+ * Effect body result accepted by `ctx.effect()` and plugin startup.
+ *
+ * Either a single disposer, a promise of one, or a (possibly async) iterable
+ * yielding several — generator effects register each yielded disposer as it
+ * is produced.
+ */
 type Effect<T = any> =
   | SyncEffect<T>
   | AsyncEffect<T>
@@ -218,6 +294,12 @@ Function returned by an effect to release resources during disposal.
 Disposers run in reverse registration order when the owning fiber unloads; they may be async, in which case unloading awaits them.
 
 ```ts website-api
+/**
+ * Function returned by an effect to release resources during disposal.
+ *
+ * Disposers run in reverse registration order when the owning fiber unloads;
+ * they may be async, in which case unloading awaits them.
+ */
 type Disposable<T = any> = () => T
 ```
 
@@ -228,6 +310,7 @@ type Disposable<T = any> = () => T
 Tree node used to expose nested effect labels for diagnostics.
 
 ```ts website-api
+/** Tree node used to expose nested effect labels for diagnostics. */
 interface EffectMeta {
   /** Human-readable effect label, e.g. `ctx.on("event")` or `ctx.provide("name")`. */
   label: string
@@ -243,6 +326,7 @@ interface EffectMeta {
 Framework error with a stable machine-readable code.
 
 ```ts website-api
+/** Framework error with a stable machine-readable code. */
 class CordisError extends Error {
   /**
    * @param code — the stable error code; also the default message.
@@ -251,6 +335,7 @@ class CordisError extends Error {
   constructor(public code: CordisError.Code, message?: string)
 }
 
+/** Cordis error code definitions. */
 namespace CordisError {
   export type Code = keyof typeof Code
 
@@ -267,6 +352,7 @@ namespace CordisError {
 Error raised when plugin configuration fails standard-schema validation.
 
 ```ts website-api
+/** Error raised when plugin configuration fails standard-schema validation. */
 class ValidationError extends TypeError {
   name = 'ValidationError'
 

website/zh-CN/api/cordis/registry.md

@@ -7,6 +7,16 @@ Plugin loading and dependency injection.
 ### ctx.inject(deps, callback)
 
 ```ts website-api
+/**
+ * Run a callback once the requested services are available.
+ *
+ * Shorthand for `ctx.plugin({ inject, apply: callback })`: the callback
+ * is unloaded and re-run whenever a required service changes.
+ *
+ * @param deps — required services, as an array or a name → config map.
+ * @param callback — plugin body called with `(ctx, config)`.
+ * @returns the fiber; awaiting it settles once loading finished.
+ */
 inject(deps: Inject, callback: Plugin.Function<void>): Fiber & PromiseLike<Fiber>
 ```
 
@@ -23,6 +33,14 @@ Shorthand for `ctx.plugin({ inject, apply: callback })`: the callback is unloade
 ### ctx.plugin(plugin, ...args)
 
 ```ts website-api
+/**
+ * Load a plugin in the current context.
+ *
+ * @param plugin — a function, class, or `{ apply }` object plugin.
+ * @param args — the plugin config, validated against its `Config` schema.
+ * @returns the fiber; awaiting it settles once loading finished
+ * (rejecting on config or startup errors).
+ */
 plugin<P extends Plugin>(plugin: P, ...args: Spread<GetPluginConfig<P>>): Fiber & PromiseLike<Fiber>
 ```
 
@@ -40,11 +58,13 @@ Load a plugin in the current context.
 Supported plugin entrypoint shapes.
 
 ```ts website-api
+/** Supported plugin entrypoint shapes. */
 type Plugin<T = any> =
   | Plugin.Function<T>
   | Plugin.Constructor<T>
   | Plugin.Object<T>
 
+/** Types associated with plugin entrypoints and runtime records. */
 namespace Plugin {
   /** Shared metadata understood by the plugin registry and related tooling. */
   export interface Base<T = any> {
@@ -104,8 +124,16 @@ Service dependency declaration accepted by plugins and the `@Inject` decorator.
 Array form requests services without intercept config. Object form maps each service name to optional intercept config for the plugin context.
 
 ```ts website-api
+/**
+ * Service dependency declaration accepted by plugins and the `@Inject`
+ * decorator.
+ *
+ * Array form requests services without intercept config. Object form maps each
+ * service name to optional intercept config for the plugin context.
+ */
 type Inject<M = Dict> = (keyof M)[] | { [K in keyof M]?: M[K] }
 
+/** Utilities for normalizing plugin dependency declarations. */
 namespace Inject {
   /**
    * Convert array/object/class-inherited inject metadata into a plain map.

website/zh-CN/api/cordis/service.md

@@ -12,6 +12,7 @@ Subclasses call `super(ctx, name)` from their constructor. The service is regist
 ### service.name
 
 ```ts website-api
+/** The service name this instance is registered under. */
 public name!: string
 ```
 
@@ -24,6 +25,7 @@ The service name this instance is registered under.
 ### Service.init
 
 ```ts website-api
+/** Symbol key of an instance method run after construction (class plugins). */
 static readonly init: unique symbol
 ```
 
@@ -34,6 +36,7 @@ Symbol key of an instance method run after construction (class plugins).
 ### Service.check
 
 ```ts website-api
+/** Symbol key of the availability predicate passed to `ctx.provide()`. */
 static readonly check: unique symbol
 ```
 
@@ -44,6 +47,7 @@ Symbol key of the availability predicate passed to `ctx.provide()`.
 ### Service.config
 
 ```ts website-api
+/** Symbol key of the phantom intercept-config type parameter. */
 static readonly config: unique symbol
 ```
 
@@ -54,6 +58,7 @@ Symbol key of the phantom intercept-config type parameter.
 ### Service.invoke
 
 ```ts website-api
+/** Symbol key of the call body making a service callable (e.g. `ctx.logger()`). */
 static readonly invoke: unique symbol
 ```
 
@@ -64,6 +69,7 @@ Symbol key of the call body making a service callable (e.g. `ctx.logger()`).
 ### Service.extend
 
 ```ts website-api
+/** Symbol key of the helper deriving an extended service instance. */
 static readonly extend: unique symbol
 ```
 
@@ -74,6 +80,7 @@ Symbol key of the helper deriving an extended service instance.
 ### Service.tracker
 
 ```ts website-api
+/** Symbol key of the tracker metadata used for context tracing. */
 static readonly tracker: unique symbol
 ```
 
@@ -84,6 +91,7 @@ Symbol key of the tracker metadata used for context tracing.
 ### Service.resolveConfig
 
 ```ts website-api
+/** Symbol key of the intercept-config resolution helper below. */
 static readonly resolveConfig: unique symbol
 ```