diff options
| author | Matt Mayer <[email protected]> | 2023-04-16 20:03:38 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-04-16 15:03:38 +0200 |
| commit | ec4d428863a4aa670338b22439031495911fbd1b (patch) | |
| tree | 03212a46ef132b157ef5e8d1fb3b0e7049401d72 /docs | |
| parent | bc58f22588d53a141e332bbdd146786e83455281 (diff) | |
| download | faker-ec4d428863a4aa670338b22439031495911fbd1b.tar.xz faker-ec4d428863a4aa670338b22439031495911fbd1b.zip | |
docs: document @throws parameter in API docs (#2050)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.vitepress/components/api-docs/method.ts | 1 | ||||
| -rw-r--r-- | docs/.vitepress/components/api-docs/method.vue | 4 |
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/.vitepress/components/api-docs/method.ts b/docs/.vitepress/components/api-docs/method.ts index 6601a5ca..3c1b9b95 100644 --- a/docs/.vitepress/components/api-docs/method.ts +++ b/docs/.vitepress/components/api-docs/method.ts @@ -8,6 +8,7 @@ export interface Method { readonly since: string; readonly sourcePath: string; // URL-Suffix readonly seeAlsos: string[]; + readonly throws?: string; // HTML } export interface MethodParameter { diff --git a/docs/.vitepress/components/api-docs/method.vue b/docs/.vitepress/components/api-docs/method.vue index 38d10586..2b3f0c5b 100644 --- a/docs/.vitepress/components/api-docs/method.vue +++ b/docs/.vitepress/components/api-docs/method.vue @@ -36,6 +36,10 @@ function seeAlsoToUrl(see: string): string { <p><strong>Returns:</strong> {{ props.method.returns }}</p> + <p v-if="props.method.throws"> + <strong>Throws:</strong> <span v-html="props.method.throws" /> + </p> + <div v-html="props.method.examples" /> <div v-if="props.method.seeAlsos.length > 0"> |