docs: fix missing or invalid jsdocs (#2630)

1 files changed, 11 insertions, 0 deletions

diff --git a/src/faker.ts b/src/faker.ts
index f43b9c36..97a513d0 100644
--- a/src/faker.ts
+++ b/src/faker.ts
@@ -140,6 +140,8 @@ export class Faker extends SimpleFaker {
    * customFaker.person.lastName(); // 'Ocampo Corrales'
    *
    * customFaker.music.genre(); // throws Error as this data is not available in `es`
+   *
+   * @since 8.0.0
    */
   constructor(options: {
     /**
@@ -173,6 +175,11 @@ export class Faker extends SimpleFaker {
    * @param options.locale The name of the main locale to use.
    * @param options.localeFallback The name of the fallback locale to use.
    *
+   * @example
+   * new Faker({ locales: allLocales });
+   *
+   * @since 6.0.0
+   *
    * @deprecated Use `new Faker({ locale: [locale, localeFallback] })` instead.
    */
   constructor(options: {
@@ -210,6 +217,8 @@ export class Faker extends SimpleFaker {
    * customFaker.person.lastName(); // 'Ocampo Corrales'
    *
    * customFaker.music.genre(); // throws Error as this data is not available in `es`
+   *
+   * @since 8.0.0
    */
   constructor(
     options:
@@ -317,6 +326,8 @@ export class Faker extends SimpleFaker {
    * // const { faker, fakerES_MX } = require("@faker-js/faker")
    * faker.getMetadata(); // { title: 'English', code: 'en', language: 'en', endonym: 'English', dir: 'ltr', script: 'Latn' }
    * fakerES_MX.getMetadata(); // { title: 'Spanish (Mexico)', code: 'es_MX', language: 'es', endonym: 'Español (México)', dir: 'ltr', script: 'Latn', country: 'MX' }
+   *
+   * @since 8.1.0
    */
   getMetadata(): MetadataDefinition {
     return this.rawDefinitions.metadata ?? {};