aboutsummaryrefslogtreecommitdiff
path: root/scripts/apidoc/parameterDefaults.ts
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/apidoc/parameterDefaults.ts')
-rw-r--r--scripts/apidoc/parameterDefaults.ts4
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;