From 24415ee993a9c6e3c8f0dffa544f492dcb29463c Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sun, 24 Sep 2023 01:24:37 +0200 Subject: infra: lint all existing jsdocs (#2408) --- scripts/apidoc/parameterDefaults.ts | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'scripts/apidoc/parameterDefaults.ts') 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; -- cgit v1.2.3