` tag. Defaults to `false`.
+ *
* @returns The converted HTML string.
*/
export function mdToHtml(md: string, inline: boolean = false): string {
diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts
index 89f234db273..33255a170cb 100644
--- a/scripts/apidoc/moduleMethods.ts
+++ b/scripts/apidoc/moduleMethods.ts
@@ -23,6 +23,7 @@ import { adjustUrls } from './utils';
* Analyzes and writes the documentation for modules and their methods such as `faker.animal.cat()`.
*
* @param project The project used to extract the modules.
+ *
* @returns The generated pages.
*/
export async function processModules(
@@ -35,6 +36,7 @@ export async function processModules(
* Analyzes and writes the documentation for a module and its methods such as `faker.animal.cat()`.
*
* @param module The module to process.
+ *
* @returns The generated pages.
*/
async function processModule(
@@ -63,6 +65,7 @@ async function processModule(
* Analyzes the documentation for a class.
*
* @param module The class to process.
+ *
* @returns The class information.
*/
export function analyzeModule(module: DeclarationReflection): {
@@ -85,6 +88,7 @@ export function analyzeModule(module: DeclarationReflection): {
*
* @param module The module to process.
* @param accessor The code used to access the methods within the module.
+ *
* @returns A list containing the documentation for the api methods in the given module.
*/
export async function processModuleMethods(
@@ -99,6 +103,7 @@ export async function processModuleMethods(
*
* @param signatures The signatures to process.
* @param accessor The code used to access the methods.
+ *
* @returns A list containing the documentation for the api methods.
*/
export async function processMethods(
diff --git a/scripts/apidoc/parameterDefaults.ts b/scripts/apidoc/parameterDefaults.ts
index b889fe243ed..7e02afc6491 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;
diff --git a/scripts/apidoc/signature.ts b/scripts/apidoc/signature.ts
index 2cba4904e99..113df911650 100644
--- a/scripts/apidoc/signature.ts
+++ b/scripts/apidoc/signature.ts
@@ -314,6 +314,7 @@ async function signatureTypeToText(
* Extracts and removed the parameter default from the comments.
*
* @param comment The comment to extract the default from.
+ *
* @returns The extracted default value.
*/
function extractDefaultFromComment(comment?: Comment): string | undefined {
diff --git a/scripts/apidoc/typedoc.ts b/scripts/apidoc/typedoc.ts
index 268ae1f474f..28a3db8545a 100644
--- a/scripts/apidoc/typedoc.ts
+++ b/scripts/apidoc/typedoc.ts
@@ -28,6 +28,7 @@ type CommentHolder = Pickbar
and baz
.",
],
"since": "",
- "sourcePath": "test/scripts/apidoc/signature.example.ts#L335",
+ "sourcePath": "test/scripts/apidoc/signature.example.ts#L336",
"throws": undefined,
}
`;
@@ -325,7 +325,7 @@ exports[`signature > analyzeSignature() > methodWithSinceMarker 1`] = `
"returns": "number",
"seeAlsos": [],
"since": "1.0.0",
- "sourcePath": "test/scripts/apidoc/signature.example.ts#L344",
+ "sourcePath": "test/scripts/apidoc/signature.example.ts#L345",
"throws": undefined,
}
`;
@@ -342,7 +342,7 @@ exports[`signature > analyzeSignature() > methodWithThrows 1`] = `
"returns": "number",
"seeAlsos": [],
"since": "",
- "sourcePath": "test/scripts/apidoc/signature.example.ts#L286",
+ "sourcePath": "test/scripts/apidoc/signature.example.ts#L287",
"throws": "a Faker error",
}
`;
@@ -491,7 +491,7 @@ It also has a more complex description.