diff options
| author | ST-DDT <[email protected]> | 2023-11-21 00:23:16 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-11-20 23:23:16 +0000 |
| commit | 808aa82f3f86a0b25f272c0c1760115a0920b614 (patch) | |
| tree | 94a4485ebd3933b710b9280fe8f68c2d041d4adb /src/modules/random | |
| parent | 96195673448e9b56ea330a1d02ff63374a11ca8b (diff) | |
| download | faker-808aa82f3f86a0b25f272c0c1760115a0920b614.tar.xz faker-808aa82f3f86a0b25f272c0c1760115a0920b614.zip | |
docs: consistent @see jsdoc tags (#2473)
Diffstat (limited to 'src/modules/random')
| -rw-r--r-- | src/modules/random/index.ts | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/modules/random/index.ts b/src/modules/random/index.ts index 474e8ca6..371c810e 100644 --- a/src/modules/random/index.ts +++ b/src/modules/random/index.ts @@ -18,8 +18,8 @@ export class RandomModule extends ModuleBase { /** * Returns a random word. * - * @see faker.lorem.word() - * @see faker.word.sample() + * @see faker.lorem.word(): For generating a random placeholder word. + * @see faker.word.sample(): For generating a random real word. * * @example * faker.random.word() // 'Seamless' @@ -157,8 +157,8 @@ export class RandomModule extends ModuleBase { * @param count.min The minimum number of words. Defaults to `1`. * @param count.max The maximum number of words. Defaults to `3`. * - * @see faker.lorem.words() - * @see faker.word.words() + * @see faker.lorem.words(): For generating a sequence of random placeholder words. + * @see faker.word.words(): For generating a sequence of random real words. * * @example * faker.random.words() // 'neural' @@ -220,7 +220,7 @@ export class RandomModule extends ModuleBase { * @param options.casing The casing of the characters. Defaults to `'mixed'`. * @param options.bannedChars An array with characters to exclude. Defaults to `[]`. * - * @see faker.string.alpha() + * @see faker.string.alpha(): For the replacement method. * * @example * faker.random.alpha() // 'b' @@ -280,7 +280,7 @@ export class RandomModule extends ModuleBase { * @param options.casing The casing of the characters. Defaults to `'lower'`. * @param options.bannedChars An array of characters and digits which should be banned in the generated string. Defaults to `[]`. * - * @see faker.string.alphanumeric() + * @see faker.string.alphanumeric(): For the replacement method. * * @example * faker.random.alphaNumeric() // '2' @@ -329,7 +329,7 @@ export class RandomModule extends ModuleBase { * @param options.allowLeadingZeros Whether leading zeros are allowed or not. Defaults to `true`. * @param options.bannedDigits An array of digits which should be banned in the generated string. Defaults to `[]`. * - * @see faker.string.numeric() + * @see faker.string.numeric(): For the replacement method. * * @example * faker.random.numeric() // '2' |
