aboutsummaryrefslogtreecommitdiff
path: root/src/modules/internet
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-11-21 00:23:16 +0100
committerGitHub <[email protected]>2023-11-20 23:23:16 +0000
commit808aa82f3f86a0b25f272c0c1760115a0920b614 (patch)
tree94a4485ebd3933b710b9280fe8f68c2d041d4adb /src/modules/internet
parent96195673448e9b56ea330a1d02ff63374a11ca8b (diff)
downloadfaker-808aa82f3f86a0b25f272c0c1760115a0920b614.tar.xz
faker-808aa82f3f86a0b25f272c0c1760115a0920b614.zip
docs: consistent @see jsdoc tags (#2473)
Diffstat (limited to 'src/modules/internet')
-rw-r--r--src/modules/internet/index.ts12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/modules/internet/index.ts b/src/modules/internet/index.ts
index bdc84dd6..8367825f 100644
--- a/src/modules/internet/index.ts
+++ b/src/modules/internet/index.ts
@@ -493,7 +493,7 @@ export class InternetModule extends ModuleBase {
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
*
- * @see faker.internet.displayName()
+ * @see faker.internet.displayName(): For generating an Unicode display name.
*
* @example
* faker.internet.userName() // 'Nettie_Zboncak40'
@@ -530,7 +530,7 @@ export class InternetModule extends ModuleBase {
* @param firstName The optional first name to use. If not specified, a random one will be chosen.
* @param lastName The optional last name to use. If not specified, a random one will be chosen.
*
- * @see faker.internet.displayName()
+ * @see faker.internet.displayName(): For generating an Unicode display name.
*
* @example
* faker.internet.userName() // 'Nettie_Zboncak40'
@@ -558,7 +558,7 @@ export class InternetModule extends ModuleBase {
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param legacyLastName The optional last name to use. If not specified, a random one will be chosen.
*
- * @see faker.internet.displayName()
+ * @see faker.internet.displayName(): For generating an Unicode display name.
*
* @example
* faker.internet.userName() // 'Nettie_Zboncak40'
@@ -685,7 +685,7 @@ export class InternetModule extends ModuleBase {
* @param options.firstName The optional first name to use. If not specified, a random one will be chosen.
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
*
- * @see faker.internet.userName()
+ * @see faker.internet.userName(): For generating a plain ASCII username.
*
* @example
* faker.internet.displayName() // 'Nettie_Zboncak40'
@@ -720,7 +720,7 @@ export class InternetModule extends ModuleBase {
* @param firstName The optional first name to use. If not specified, a random one will be chosen.
* @param lastName The optional last name to use. If not specified, a random one will be chosen.
*
- * @see faker.internet.userName()
+ * @see faker.internet.userName(): For generating a plain ASCII username.
*
* @example
* faker.internet.displayName() // 'Nettie_Zboncak40'
@@ -746,7 +746,7 @@ export class InternetModule extends ModuleBase {
* @param options.lastName The optional last name to use. If not specified, a random one will be chosen.
* @param legacyLastName The optional last name to use. If not specified, a random one will be chosen.
*
- * @see faker.internet.userName()
+ * @see faker.internet.userName(): For generating a plain ASCII username.
*
* @example
* faker.internet.displayName() // 'Nettie_Zboncak40'