chore: clean some jsdoc

Author: Shinigami92

src/address.ts

@@ -30,12 +30,12 @@ export class Address {
    * @param format The optional format used to generate the the zip code.
    * By default, a random format is used from the locale zip formats.
    *
+   * @see faker.helpers.replaceSymbols()
+   *
    * @example
    * faker.address.zipCode() // '17839'
    * faker.address.zipCode('####') // '6925'
    *
-   * @see
-   * faker.helpers.replaceSymbols()
    */
   zipCode(format?: string): string {
     // if zip format is not specified, use the zip format defined for the locale

src/company.ts

@@ -32,6 +32,7 @@ export class Company {
 
   /**
    * Generates a random company name.
+   *
    * @param format The optional format index used to select a format.
    *
    * @example

src/date.ts

@@ -20,12 +20,12 @@ export class _Date {
    * @param years The range of years the date may be in the past. Defaults to `1`.
    * @param refDate The date to use as reference point for the newly generated date. Defaults to now.
    *
+   * @see faker.date.recent()
+   *
    * @example
    * faker.date.past() // '2021-12-03T05:40:44.408Z'
    * faker.date.past(10) // '2017-10-25T21:34:19.488Z'
    * faker.date.past(10, '2020-01-01T00:00:00.000Z') // '2017-08-18T02:59:12.350Z'
-   *
-   * @see faker.date.recent()
    */
   past(years?: number, refDate?: string): Date {
     let date = new Date();
@@ -51,12 +51,12 @@ export class _Date {
    * @param years The range of years the date may be in the future. Defaults to `1`.
    * @param refDate The date to use as reference point for the newly generated date. Defaults to now.
    *
+   * @see faker.date.soon()
+   *
    * @example
    * faker.date.future() // '2022-11-19T05:52:49.100Z'
    * faker.date.future(10) // '2030-11-23T09:38:28.710Z'
    * faker.date.future(10, '2020-01-01T00:00:00.000Z') // '2020-12-13T22:45:10.252Z'
-   *
-   * @see faker.date.soon()
    */
   future(years?: number, refDate?: string): Date {
     let date = new Date();
@@ -135,12 +135,12 @@ export class _Date {
    * @param days The range of days the date may be in the past. Defaults to `1`.
    * @param refDate The date to use as reference point for the newly generated date. Defaults to now.
    *
+   * @see faker.date.past()
+   *
    * @example
    * faker.date.recent() // '2022-02-04T02:09:35.077Z'
    * faker.date.recent(10) // '2022-01-29T06:12:12.829Z'
    * faker.date.recent(10, '2020-01-01T00:00:00.000Z') // '2019-12-27T18:11:19.117Z'
-   *
-   * @see faker.date.past()
    */
   recent(days?: number, refDate?: string): Date {
     let date = new Date();
@@ -166,12 +166,12 @@ export class _Date {
    * @param days The range of days the date may be in the future. Defaults to `1`.
    * @param refDate The date to use as reference point for the newly generated date. Defaults to now.
    *
+   * @see faker.date.future()
+   *
    * @example
    * faker.date.soon() // '2022-02-05T09:55:39.216Z'
    * faker.date.soon(10) // '2022-02-11T05:14:39.138Z'
    * faker.date.soon(10, '2020-01-01T00:00:00.000Z') // '2020-01-01T02:40:44.990Z'
-   *
-   * @see faker.date.future()
    */
   soon(days?: number, refDate?: string): Date {
     let date = new Date();

src/finance.ts

@@ -77,7 +77,7 @@ export class Finance {
 
   /**
    * Generates a random masked number.
-
+   *
    * @param length The length of the unmasked number. Defaults to `4`.
    * @param parens Whether to use surrounding parenthesis. Defaults to `true`.
    * @param ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`.

src/git.ts

@@ -48,6 +48,9 @@ export class Git {
   /**
    * Generates a random commit entry.
    *
+   * @param options Options for the commit entry.
+   * @param options.merge Set to `true` to generate a merge message line.
+   *
    * @example
    * faker.git.commitEntry()
    * // commit fe8c38a965d13d9794eb36918cb24cebe49a45c2

src/helpers.ts

@@ -452,8 +452,6 @@ export class Helpers {
    * @param data The data used to populate the placeholders.
    * This is a record where the key is the template placeholder,
    * whereas the value is either a string or a function suitable for `String.replace()`.
-   *
-   * @method faker.helpers.mustache
    */
   mustache(
     str: string | undefined,

src/image_providers/lorempicsum.ts

@@ -4,14 +4,12 @@ export class LoremPicsum {
   constructor(private readonly faker: Faker) {}
 
   /**
-   * image
+   * Search image from unsplash
    *
    * @param width
    * @param height
    * @param grayscale
    * @param blur 1-10
-   * @method faker.image.lorempicsum.image
-   * @description search image from unsplash
    */
   image(
     width?: number,
@@ -23,26 +21,22 @@ export class LoremPicsum {
   }
 
   /**
-   * imageGrayscaled
+   * Search grayscale image from unsplash
    *
    * @param width
    * @param height
    * @param grayscale
-   * @method faker.image.lorempicsum.imageGrayscaled
-   * @description search grayscale image from unsplash
    */
   imageGrayscale(width?: number, height?: number, grayscale?: boolean): string {
     return this.imageUrl(width, height, grayscale);
   }
 
   /**
-   * imageBlurred
+   * Search blurred image from unsplash
    *
    * @param width
    * @param height
    * @param blur 1-10
-   * @method faker.image.lorempicsum.imageBlurred
-   * @description search blurred image from unsplash
    */
   imageBlurred(
     width?: number,
@@ -53,15 +47,13 @@ export class LoremPicsum {
   }
 
   /**
-   * imageRandomSeeded
+   * Search same random image from unsplash, based on a seed
    *
    * @param width
    * @param height
    * @param grayscale
    * @param blur 1-10
    * @param seed
-   * @method faker.image.lorempicsum.imageRandomSeeded
-   * @description search same random image from unsplash, based on a seed
    */
   imageRandomSeeded(
     width?: number,
@@ -75,8 +67,6 @@ export class LoremPicsum {
 
   /**
    * avatar
-   *
-   * @method faker.image.lorempicsum.avatar
    */
   avatar(): string {
     return this.faker.internet.avatar();
@@ -90,7 +80,6 @@ export class LoremPicsum {
    * @param grayscale
    * @param blur 1-10
    * @param seed
-   * @method faker.image.lorempicsum.imageUrl
    */
   imageUrl(
     width?: number,

src/image_providers/lorempixel.ts

@@ -9,7 +9,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.image
    */
   image(width?: number, height?: number, randomize?: boolean): string {
     const categories = [
@@ -36,8 +35,6 @@ export class Lorempixel {
 
   /**
    * avatar
-   *
-   * @method faker.image.lorempixel.avatar
    */
   avatar(): string {
     return this.faker.internet.avatar();
@@ -50,7 +47,6 @@ export class Lorempixel {
    * @param height
    * @param category
    * @param randomize
-   * @method faker.image.lorempixel.imageUrl
    */
   imageUrl(
     width?: number,
@@ -79,7 +75,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.abstract
    */
   abstract(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -96,7 +91,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.animals
    */
   animals(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -113,7 +107,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.business
    */
   business(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -130,7 +123,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.cats
    */
   cats(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -147,7 +139,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.city
    */
   city(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -164,7 +155,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.food
    */
   food(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -181,7 +171,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.nightlife
    */
   nightlife(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -198,7 +187,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.fashion
    */
   fashion(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -215,7 +203,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.people
    */
   people(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -232,7 +219,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.nature
    */
   nature(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -249,7 +235,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.sports
    */
   sports(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -266,7 +251,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.technics
    */
   technics(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(
@@ -283,7 +267,6 @@ export class Lorempixel {
    * @param width
    * @param height
    * @param randomize
-   * @method faker.image.lorempixel.transport
    */
   transport(width?: number, height?: number, randomize?: boolean): string {
     return this.faker.image.lorempixel.imageUrl(

src/image_providers/unsplash.ts

@@ -13,22 +13,18 @@ export class Unsplash {
   constructor(private readonly faker: Faker) {}
 
   /**
-   * image
+   * Search image from unsplash
    *
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.image
-   * @description search image from unsplash
    */
   image(width?: number, height?: number, keyword?: string): string {
     return this.imageUrl(width, height, undefined, keyword);
   }
 
   /**
    * avatar
-   *
-   * @method faker.image.unsplash.avatar
    */
   avatar(): string {
     return this.faker.internet.avatar();
@@ -41,7 +37,6 @@ export class Unsplash {
    * @param height
    * @param category
    * @param keyword
-   * @method faker.image.unsplash.imageUrl
    */
   imageUrl(
     width?: number,
@@ -78,7 +73,6 @@ export class Unsplash {
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.food
    */
   food(width?: number, height?: number, keyword?: string): string {
     return this.faker.image.unsplash.imageUrl(width, height, 'food', keyword);
@@ -90,7 +84,6 @@ export class Unsplash {
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.people
    */
   people(width?: number, height?: number, keyword?: string): string {
     return this.faker.image.unsplash.imageUrl(width, height, 'people', keyword);
@@ -102,7 +95,6 @@ export class Unsplash {
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.nature
    */
   nature(width?: number, height?: number, keyword?: string): string {
     return this.faker.image.unsplash.imageUrl(width, height, 'nature', keyword);
@@ -114,7 +106,6 @@ export class Unsplash {
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.technology
    */
   technology(width?: number, height?: number, keyword?: string): string {
     return this.faker.image.unsplash.imageUrl(
@@ -131,7 +122,6 @@ export class Unsplash {
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.objects
    */
   objects(width?: number, height?: number, keyword?: string): string {
     return this.faker.image.unsplash.imageUrl(
@@ -148,7 +138,6 @@ export class Unsplash {
    * @param width
    * @param height
    * @param keyword
-   * @method faker.image.unsplash.buildings
    */
   buildings(width?: number, height?: number, keyword?: string): string {
     return this.faker.image.unsplash.imageUrl(