diff options
| author | ST-DDT <[email protected]> | 2023-09-24 01:24:37 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-09-23 23:24:37 +0000 |
| commit | 24415ee993a9c6e3c8f0dffa544f492dcb29463c (patch) | |
| tree | bce36d80dbd989b8cd9fbbf47be411d14fd167d4 /scripts/apidoc/parameterDefaults.ts | |
| parent | 74eecccd3af702d8a1d8072f94032ccb54293cb1 (diff) | |
| download | faker-24415ee993a9c6e3c8f0dffa544f492dcb29463c.tar.xz faker-24415ee993a9c6e3c8f0dffa544f492dcb29463c.zip | |
infra: lint all existing jsdocs (#2408)
Diffstat (limited to 'scripts/apidoc/parameterDefaults.ts')
| -rw-r--r-- | scripts/apidoc/parameterDefaults.ts | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/apidoc/parameterDefaults.ts b/scripts/apidoc/parameterDefaults.ts index b889fe24..7e02afc6 100644 --- a/scripts/apidoc/parameterDefaults.ts +++ b/scripts/apidoc/parameterDefaults.ts @@ -18,6 +18,9 @@ interface ParameterDefaultsAware extends Reflection { /** * TypeDoc EventCallback for EVENT_CREATE_DECLARATION events that reads the default parameters from the implementation. + * + * @param context The converter context. + * @param reflection The reflection to read the default parameters from. */ export const parameterDefaultReader: EventCallback = ( context: Context, @@ -44,6 +47,7 @@ export const parameterDefaultReader: EventCallback = ( * Removes compile expressions that don't add any value for readers. * * @param value The default value to clean. + * * @returns The cleaned default value. */ function cleanParameterDefault(value: string): string; |