Skip to content

Commit 984aa6d

Browse files
committed
more doc polish
1 parent df1cb93 commit 984aa6d

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ main()
4242
[tests]: https://github.com/justjake/quickjs-emscripten/blob/master/ts/quickjs.test.ts
4343
[values]: #interfacing-with-the-interpreter
4444
[asyncify]: #asyncify
45-
[functons]: #exposing-apis
45+
[functions]: #exposing-apis
4646

4747
## Usage
4848

@@ -355,7 +355,7 @@ To use asyncify features, use the following functions:
355355

356356
[newasyncruntime]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newasyncruntime
357357
[newasynccontext]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newasynccontext
358-
[newasynccontext]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newquickjsasyncwasmmodule
358+
[newquickjsasyncwasmmodule]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newquickjsasyncwasmmodule
359359

360360
These functions are asynchronous because they always create a new underlying
361361
WebAssembly module so that each instance can suspend and resume independently,
@@ -437,7 +437,7 @@ console.log(upperCaseData) // 'VERY USEFUL DATA'
437437

438438
### More Documentation
439439

440-
[Github](https://github.com/justjake/quickjs-emscripten) | [NPM](https://www.npmjs.com/package/quickjs-emscripten) | [API Documentation](https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md) | [Examples](https://github.com/justjake/quickjs-emscripten/blob/master/ts/quickjs.test.ts)
440+
[Github] | [NPM] | [API Documentation][api] | [Examples][tests]
441441

442442
## Background
443443

doc/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ main()
4444
[tests]: https://github.com/justjake/quickjs-emscripten/blob/master/ts/quickjs.test.ts
4545
[values]: #interfacing-with-the-interpreter
4646
[asyncify]: #asyncify
47-
[functons]: #exposing-apis
47+
[functions]: #exposing-apis
4848

4949
## Usage
5050

@@ -357,7 +357,7 @@ To use asyncify features, use the following functions:
357357

358358
[newasyncruntime]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newasyncruntime
359359
[newasynccontext]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newasynccontext
360-
[newasynccontext]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newquickjsasyncwasmmodule
360+
[newquickjsasyncwasmmodule]: https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md#newquickjsasyncwasmmodule
361361

362362
These functions are asynchronous because they always create a new underlying
363363
WebAssembly module so that each instance can suspend and resume independently,
@@ -439,7 +439,7 @@ console.log(upperCaseData) // 'VERY USEFUL DATA'
439439

440440
### More Documentation
441441

442-
[Github](https://github.com/justjake/quickjs-emscripten) | [NPM](https://www.npmjs.com/package/quickjs-emscripten) | [API Documentation](https://github.com/justjake/quickjs-emscripten/blob/master/doc/modules.md) | [Examples](https://github.com/justjake/quickjs-emscripten/blob/master/ts/quickjs.test.ts)
442+
[Github] | [NPM] | [API Documentation][api] | [Examples][tests]
443443

444444
## Background
445445

doc/classes/QuickJSAsyncContext.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Class: QuickJSAsyncContext
44

5-
Asyncified version of [QuickJSContext].
5+
Asyncified version of [QuickJSContext](QuickJSContext.md).
66

77
*Asyncify* allows normally synchronous code to wait for asynchronous Promises
88
or callbacks. The asyncified version of QuickJSContext can wait for async
@@ -446,7 +446,7 @@ ___
446446

447447
**evalCodeAsync**(`code`, `filename?`, `options?`): `Promise`<[`VmCallResult`](../modules.md#vmcallresult)<[`QuickJSHandle`](../modules.md#quickjshandle)\>\>
448448

449-
Asyncified version of [evalCode].
449+
Asyncified version of [evalCode](QuickJSAsyncContext.md#evalcode).
450450

451451
#### Parameters
452452

@@ -573,7 +573,7 @@ ___
573573

574574
**newAsyncifiedFunction**(`name`, `fn`): [`QuickJSHandle`](../modules.md#quickjshandle)
575575

576-
Similar to [newFunction].
576+
Similar to [newFunction](QuickJSAsyncContext.md#newfunction).
577577
Convert an async host Javascript function into a synchronous QuickJS function value.
578578

579579
Whenever QuickJS calls this function, the VM's stack will be unwound while

doc/modules.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ ___
182182
Ƭ **QuickJSPropertyKey**: `number` \| `string` \| [`QuickJSHandle`](modules.md#quickjshandle)
183183

184184
Property key for getting or setting a property on a handle with
185-
[QuickJSContext.getProp], [QuickJSContext.setProp], or [QuickJSContext.defineProp].
185+
[QuickJSContext.getProp](classes/QuickJSContext.md#getprop), [QuickJSContext.setProp](classes/QuickJSContext.md#setprop), or [QuickJSContext.defineProp](classes/QuickJSContext.md#defineprop).
186186

187187
#### Defined in
188188

@@ -389,7 +389,7 @@ ___
389389

390390
**newAsyncContext**(`options?`): `Promise`<[`QuickJSAsyncContext`](classes/QuickJSAsyncContext.md)\>
391391

392-
Create a new [QuickJSAsyncContext] (with an associated runtime) in an
392+
Create a new [QuickJSAsyncContext](classes/QuickJSAsyncContext.md) (with an associated runtime) in an
393393
separate WebAssembly module.
394394

395395
Each context is isolated in a separate WebAssembly module, so that errors in
@@ -420,7 +420,7 @@ ___
420420

421421
**newAsyncRuntime**(`options?`): `Promise`<[`QuickJSAsyncRuntime`](classes/QuickJSAsyncRuntime.md)\>
422422

423-
Create a new [QuickJSAsyncRuntime] in a separate WebAssembly module.
423+
Create a new [QuickJSAsyncRuntime](classes/QuickJSAsyncRuntime.md) in a separate WebAssembly module.
424424

425425
Each runtime is isolated in a separate WebAssembly module, so that errors in
426426
one runtime cannot contaminate another runtime, and each runtime can execute

ts/context-asyncify.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type AsyncFunctionImplementation = (
1515
) => Promise<QuickJSHandle | VmCallResult<QuickJSHandle> | void>
1616

1717
/**
18-
* Asyncified version of [QuickJSContext].
18+
* Asyncified version of [[QuickJSContext]].
1919
*
2020
* *Asyncify* allows normally synchronous code to wait for asynchronous Promises
2121
* or callbacks. The asyncified version of QuickJSContext can wait for async
@@ -29,7 +29,7 @@ export class QuickJSAsyncContext extends QuickJSContext {
2929
protected declare callbacks: QuickJSModuleCallbacks
3030

3131
/**
32-
* Asyncified version of [evalCode].
32+
* Asyncified version of [[evalCode]].
3333
*/
3434
async evalCodeAsync(
3535
code: string,
@@ -65,7 +65,7 @@ export class QuickJSAsyncContext extends QuickJSContext {
6565
}
6666

6767
/**
68-
* Similar to [newFunction].
68+
* Similar to [[newFunction]].
6969
* Convert an async host Javascript function into a synchronous QuickJS function value.
7070
*
7171
* Whenever QuickJS calls this function, the VM's stack will be unwound while

ts/context.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import {
3535

3636
/**
3737
* Property key for getting or setting a property on a handle with
38-
* [QuickJSContext.getProp], [QuickJSContext.setProp], or [QuickJSContext.defineProp].
38+
* [[QuickJSContext.getProp]], [[QuickJSContext.setProp]], or [[QuickJSContext.defineProp]].
3939
*/
4040
export type QuickJSPropertyKey = number | string | QuickJSHandle
4141

ts/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export async function newQuickJSAsyncWASMModule(): Promise<QuickJSAsyncWASMModul
116116
}
117117

118118
/**
119-
* Create a new [QuickJSAsyncRuntime] in a separate WebAssembly module.
119+
* Create a new [[QuickJSAsyncRuntime]] in a separate WebAssembly module.
120120
*
121121
* Each runtime is isolated in a separate WebAssembly module, so that errors in
122122
* one runtime cannot contaminate another runtime, and each runtime can execute
@@ -132,7 +132,7 @@ export async function newAsyncRuntime(options?: AsyncRuntimeOptions): Promise<Qu
132132
}
133133

134134
/**
135-
* Create a new [QuickJSAsyncContext] (with an associated runtime) in an
135+
* Create a new [[QuickJSAsyncContext]] (with an associated runtime) in an
136136
* separate WebAssembly module.
137137
*
138138
* Each context is isolated in a separate WebAssembly module, so that errors in

0 commit comments

Comments
 (0)