diff options
| author | ST-DDT <[email protected]> | 2024-06-21 11:41:03 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-06-21 11:41:03 +0200 |
| commit | 5801cc5cad8324a114d08733fafa31f7632d1118 (patch) | |
| tree | 7de3637ce93557f7862c0d7c5e4a64d26cf2efe1 /docs | |
| parent | 909ea01a6cc9f4753aeba45ba9e7bd1726e68916 (diff) | |
| download | faker-5801cc5cad8324a114d08733fafa31f7632d1118.tar.xz faker-5801cc5cad8324a114d08733fafa31f7632d1118.zip | |
docs: separate signature and examples (#2962)
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 | 3 |
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/.vitepress/components/api-docs/method.ts b/docs/.vitepress/components/api-docs/method.ts index 90310ed0..4da480b8 100644 --- a/docs/.vitepress/components/api-docs/method.ts +++ b/docs/.vitepress/components/api-docs/method.ts @@ -6,6 +6,7 @@ export interface ApiDocsMethod { readonly parameters: ApiDocsMethodParameter[]; readonly returns: string; readonly throws: string | undefined; // HTML + readonly signature: string; // HTML readonly examples: string; // HTML readonly seeAlsos: string[]; readonly sourcePath: string; // URL-Suffix diff --git a/docs/.vitepress/components/api-docs/method.vue b/docs/.vitepress/components/api-docs/method.vue index 8e25e8f8..5cd819e9 100644 --- a/docs/.vitepress/components/api-docs/method.vue +++ b/docs/.vitepress/components/api-docs/method.vue @@ -40,6 +40,9 @@ function seeAlsoToUrl(see: string): string { <strong>Throws:</strong> <span v-html="props.method.throws" /> </p> + <div v-html="props.method.signature" /> + + <h3>Examples</h3> <div v-html="props.method.examples" /> <div v-if="props.method.seeAlsos.length > 0"> |