iTwin / itwinjs-core

Monorepo for iTwin.js Library
https://www.itwinjs.org
MIT License
620 stars 210 forks source link

Documentation Issue: WorkerProxy completely missing documentation #7237

Closed pmconne closed 1 month ago

pmconne commented 1 month ago

Doc page: Image

Source code:

/** A proxy for a [web worker](https://developer.mozilla.org/en-US/docs/Web/API/Worker) that provides the operations specified by
 * the methods of `T`.
 * To use a worker proxy, define a worker script that provides [[registerWorker]] with an implementation of `T`, and obtain a proxy
 * via [[createWorkerProxy]] on the main thread. The proxy can then be used to asynchronously invoke methods of `T` on the worker.
 * See [this article]($docs/learning/frontend/WorkerProxy.md) for more details and examples.
 * @beta
 */
export type WorkerProxy<T> = WorkerInterface<T> & {

The article is very detailed with lots of example code, none of it surfaced in the doc site.

Found on page https://www.itwinjs.org/reference/core-frontend/utils/workerproxy - "undefined"

ben-polinsky commented 1 month ago

Fix incoming

ben-polinsky commented 1 month ago

Done. We were not showing any comments beyond tags (@see, etc) for type aliases. In addition, because the same DeclarationReflection.kind is used for any type = type, the badge now displays "Type" instead of "Type Alias".