docs: add jsdocs to the pre-built instances (#3193)

69 files changed, 413 insertions, 0 deletions

diff --git a/src/locales/af_ZA/index.ts b/src/locales/af_ZA/index.ts
index 3bde3758..e1d1a8f9 100644
--- a/src/locales/af_ZA/index.ts
+++ b/src/locales/af_ZA/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `af_ZA` locale.
+ *
+ * - Language: Afrikaans (South Africa)
+ * - Endonym: Afrikaans (Suid-Afrika)
+ */
 const af_ZA: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/ar/index.ts b/src/locales/ar/index.ts
index 6d7b46e0..62a98aef 100644
--- a/src/locales/ar/index.ts
+++ b/src/locales/ar/index.ts
@@ -14,6 +14,12 @@ import person from './person';
 import team from './team';
 import vehicle from './vehicle';
 
+/**
+ * The locale data for the `ar` locale.
+ *
+ * - Language: Arabic
+ * - Endonym: اَلْعَرَبِيَّةُ
+ */
 const ar: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/az/index.ts b/src/locales/az/index.ts
index 923480de..9155e125 100644
--- a/src/locales/az/index.ts
+++ b/src/locales/az/index.ts
@@ -13,6 +13,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `az` locale.
+ *
+ * - Language: Azerbaijani
+ * - Endonym: azərbaycan dili
+ */
 const az: LocaleDefinition = {
   color,
   commerce,
diff --git a/src/locales/base/index.ts b/src/locales/base/index.ts
index 0a031fbb..2e260172 100644
--- a/src/locales/base/index.ts
+++ b/src/locales/base/index.ts
@@ -12,6 +12,11 @@ import location from './location';
 import metadata from './metadata';
 import system from './system';
 
+/**
+ * The locale data for the `base` locale.
+ *
+ * The base locale contains data that is shared across all locales such as ISO codes, time zones, and more.
+ */
 const base: LocaleDefinition = {
   color,
   database,
diff --git a/src/locales/cs_CZ/index.ts b/src/locales/cs_CZ/index.ts
index c3770c00..3f1be315 100644
--- a/src/locales/cs_CZ/index.ts
+++ b/src/locales/cs_CZ/index.ts
@@ -12,6 +12,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `cs_CZ` locale.
+ *
+ * - Language: Czech (Czechia)
+ * - Endonym: čeština (Česká republika)
+ */
 const cs_CZ: LocaleDefinition = {
   company,
   date,
diff --git a/src/locales/da/index.ts b/src/locales/da/index.ts
index d2335413..d454db43 100644
--- a/src/locales/da/index.ts
+++ b/src/locales/da/index.ts
@@ -13,6 +13,12 @@ import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
+/**
+ * The locale data for the `da` locale.
+ *
+ * - Language: Danish
+ * - Endonym: Dansk
+ */
 const da: LocaleDefinition = {
   commerce,
   company,
diff --git a/src/locales/de/index.ts b/src/locales/de/index.ts
index 4bdeb76f..a64e7755 100644
--- a/src/locales/de/index.ts
+++ b/src/locales/de/index.ts
@@ -16,6 +16,12 @@ import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
+/**
+ * The locale data for the `de` locale.
+ *
+ * - Language: German
+ * - Endonym: Deutsch
+ */
 const de: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/de_AT/index.ts b/src/locales/de_AT/index.ts
index 8ed90a8d..3b3f5c0e 100644
--- a/src/locales/de_AT/index.ts
+++ b/src/locales/de_AT/index.ts
@@ -12,6 +12,12 @@ import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
+/**
+ * The locale data for the `de_AT` locale.
+ *
+ * - Language: German (Austria)
+ * - Endonym: Deutsch (Österreich)
+ */
 const de_AT: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/de_CH/index.ts b/src/locales/de_CH/index.ts
index ec19b44c..22c6465c 100644
--- a/src/locales/de_CH/index.ts
+++ b/src/locales/de_CH/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `de_CH` locale.
+ *
+ * - Language: German (Switzerland)
+ * - Endonym: Deutsch (Schweiz)
+ */
 const de_CH: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/dv/index.ts b/src/locales/dv/index.ts
index 1c534b6c..bddb4fc4 100644
--- a/src/locales/dv/index.ts
+++ b/src/locales/dv/index.ts
@@ -13,6 +13,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `dv` locale.
+ *
+ * - Language: Maldivian
+ * - Endonym: ދިވެހި
+ */
 const dv: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/el/index.ts b/src/locales/el/index.ts
index 42a1f59a..80c132d6 100644
--- a/src/locales/el/index.ts
+++ b/src/locales/el/index.ts
@@ -18,6 +18,12 @@ import person from './person';
 import phone_number from './phone_number';
 import team from './team';
 
+/**
+ * The locale data for the `el` locale.
+ *
+ * - Language: Greek
+ * - Endonym: Ελληνικά
+ */
 const el: LocaleDefinition = {
   app,
   cell_phone,
diff --git a/src/locales/en/index.ts b/src/locales/en/index.ts
index 7c932075..c84e786d 100644
--- a/src/locales/en/index.ts
+++ b/src/locales/en/index.ts
@@ -28,6 +28,12 @@ import team from './team';
 import vehicle from './vehicle';
 import word from './word';
 
+/**
+ * The locale data for the `en` locale.
+ *
+ * - Language: English
+ * - Endonym: English
+ */
 const en: LocaleDefinition = {
   airline,
   animal,
diff --git a/src/locales/en_AU/index.ts b/src/locales/en_AU/index.ts
index ee3bf460..cab310d2 100644
--- a/src/locales/en_AU/index.ts
+++ b/src/locales/en_AU/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_AU` locale.
+ *
+ * - Language: English (Australia)
+ * - Endonym: English (Australia)
+ */
 const en_AU: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/en_AU_ocker/index.ts b/src/locales/en_AU_ocker/index.ts
index 0a15fa0d..c599542e 100644
--- a/src/locales/en_AU_ocker/index.ts
+++ b/src/locales/en_AU_ocker/index.ts
@@ -9,6 +9,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_AU_ocker` locale.
+ *
+ * - Language: English (Australia Ocker)
+ * - Endonym: English (Australia)
+ */
 const en_AU_ocker: LocaleDefinition = {
   internet,
   location,
diff --git a/src/locales/en_BORK/index.ts b/src/locales/en_BORK/index.ts
index c214e7ae..2c0e46e0 100644
--- a/src/locales/en_BORK/index.ts
+++ b/src/locales/en_BORK/index.ts
@@ -7,6 +7,12 @@ import lorem from './lorem';
 import metadata from './metadata';
 import person from './person';
 
+/**
+ * The locale data for the `en_BORK` locale.
+ *
+ * - Language: English (Bork)
+ * - Endonym: English (Bork)
+ */
 const en_BORK: LocaleDefinition = {
   lorem,
   metadata,
diff --git a/src/locales/en_CA/index.ts b/src/locales/en_CA/index.ts
index cb6dbd35..a2a690b8 100644
--- a/src/locales/en_CA/index.ts
+++ b/src/locales/en_CA/index.ts
@@ -9,6 +9,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_CA` locale.
+ *
+ * - Language: English (Canada)
+ * - Endonym: English (Canada)
+ */
 const en_CA: LocaleDefinition = {
   internet,
   location,
diff --git a/src/locales/en_GB/index.ts b/src/locales/en_GB/index.ts
index ae59fada..5ef7c081 100644
--- a/src/locales/en_GB/index.ts
+++ b/src/locales/en_GB/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_GB` locale.
+ *
+ * - Language: English (Great Britain)
+ * - Endonym: English (Great Britain)
+ */
 const en_GB: LocaleDefinition = {
   cell_phone,
   internet,
diff --git a/src/locales/en_GH/index.ts b/src/locales/en_GH/index.ts
index c4ca5da3..178e4ac7 100644
--- a/src/locales/en_GH/index.ts
+++ b/src/locales/en_GH/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_GH` locale.
+ *
+ * - Language: English (Ghana)
+ * - Endonym: English (Ghana)
+ */
 const en_GH: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/en_HK/index.ts b/src/locales/en_HK/index.ts
index cbbfed81..d164a40f 100644
--- a/src/locales/en_HK/index.ts
+++ b/src/locales/en_HK/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_HK` locale.
+ *
+ * - Language: English (Hong Kong)
+ * - Endonym: English (Hong Kong)
+ */
 const en_HK: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/en_IE/index.ts b/src/locales/en_IE/index.ts
index c54df543..76f87a93 100644
--- a/src/locales/en_IE/index.ts
+++ b/src/locales/en_IE/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_IE` locale.
+ *
+ * - Language: English (Ireland)
+ * - Endonym: English (Ireland)
+ */
 const en_IE: LocaleDefinition = {
   cell_phone,
   internet,
diff --git a/src/locales/en_IN/index.ts b/src/locales/en_IN/index.ts
index df86966d..f5d51b53 100644
--- a/src/locales/en_IN/index.ts
+++ b/src/locales/en_IN/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_IN` locale.
+ *
+ * - Language: English (India)
+ * - Endonym: English (India)
+ */
 const en_IN: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/en_NG/index.ts b/src/locales/en_NG/index.ts
index 5831d9e1..e7b1567c 100644
--- a/src/locales/en_NG/index.ts
+++ b/src/locales/en_NG/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_NG` locale.
+ *
+ * - Language: English (Nigeria)
+ * - Endonym: English (Nigeria)
+ */
 const en_NG: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/en_US/index.ts b/src/locales/en_US/index.ts
index ddadf9c8..ee9f825c 100644
--- a/src/locales/en_US/index.ts
+++ b/src/locales/en_US/index.ts
@@ -9,6 +9,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_US` locale.
+ *
+ * - Language: English (United States)
+ * - Endonym: English (United States)
+ */
 const en_US: LocaleDefinition = {
   internet,
   location,
diff --git a/src/locales/en_ZA/index.ts b/src/locales/en_ZA/index.ts
index 43199703..80fd9d8a 100644
--- a/src/locales/en_ZA/index.ts
+++ b/src/locales/en_ZA/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `en_ZA` locale.
+ *
+ * - Language: English (South Africa)
+ * - Endonym: English (South Africa)
+ */
 const en_ZA: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/eo/index.ts b/src/locales/eo/index.ts
index 83141fb2..5b5e4ed2 100644
--- a/src/locales/eo/index.ts
+++ b/src/locales/eo/index.ts
@@ -15,6 +15,12 @@ import person from './person';
 import science from './science';
 import vehicle from './vehicle';
 
+/**
+ * The locale data for the `eo` locale.
+ *
+ * - Language: Esperanto
+ * - Endonym: Esperanto
+ */
 const eo: LocaleDefinition = {
   animal,
   color,
diff --git a/src/locales/es/index.ts b/src/locales/es/index.ts
index 880d4dee..f7fef2c7 100644
--- a/src/locales/es/index.ts
+++ b/src/locales/es/index.ts
@@ -14,6 +14,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `es` locale.
+ *
+ * - Language: Spanish
+ * - Endonym: Español
+ */
 const es: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/es_MX/index.ts b/src/locales/es_MX/index.ts
index 334e8e5a..425632d0 100644
--- a/src/locales/es_MX/index.ts
+++ b/src/locales/es_MX/index.ts
@@ -15,6 +15,12 @@ import person from './person';
 import phone_number from './phone_number';
 import team from './team';
 
+/**
+ * The locale data for the `es_MX` locale.
+ *
+ * - Language: Spanish (Mexico)
+ * - Endonym: Español (México)
+ */
 const es_MX: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/fa/index.ts b/src/locales/fa/index.ts
index 910711be..0b07f4fa 100644
--- a/src/locales/fa/index.ts
+++ b/src/locales/fa/index.ts
@@ -19,6 +19,12 @@ import phone_number from './phone_number';
 import vehicle from './vehicle';
 import word from './word';
 
+/**
+ * The locale data for the `fa` locale.
+ *
+ * - Language: Farsi/Persian
+ * - Endonym: فارسی
+ */
 const fa: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/fi/index.ts b/src/locales/fi/index.ts
index 73dabe6f..b8e287d3 100644
--- a/src/locales/fi/index.ts
+++ b/src/locales/fi/index.ts
@@ -7,6 +7,12 @@ import location from './location';
 import metadata from './metadata';
 import person from './person';
 
+/**
+ * The locale data for the `fi` locale.
+ *
+ * - Language: Finnish
+ * - Endonym: suomi
+ */
 const fi: LocaleDefinition = {
   location,
   metadata,
diff --git a/src/locales/fr/index.ts b/src/locales/fr/index.ts
index 2c8874fa..f1de2300 100644
--- a/src/locales/fr/index.ts
+++ b/src/locales/fr/index.ts
@@ -19,6 +19,12 @@ import phone_number from './phone_number';
 import vehicle from './vehicle';
 import word from './word';
 
+/**
+ * The locale data for the `fr` locale.
+ *
+ * - Language: French
+ * - Endonym: Français
+ */
 const fr: LocaleDefinition = {
   animal,
   color,
diff --git a/src/locales/fr_BE/index.ts b/src/locales/fr_BE/index.ts
index fb4ad649..8503bac8 100644
--- a/src/locales/fr_BE/index.ts
+++ b/src/locales/fr_BE/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `fr_BE` locale.
+ *
+ * - Language: French (Belgium)
+ * - Endonym: Français (Belgique)
+ */
 const fr_BE: LocaleDefinition = {
   cell_phone,
   internet,
diff --git a/src/locales/fr_CA/index.ts b/src/locales/fr_CA/index.ts
index 0d4a749e..18843cea 100644
--- a/src/locales/fr_CA/index.ts
+++ b/src/locales/fr_CA/index.ts
@@ -9,6 +9,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `fr_CA` locale.
+ *
+ * - Language: French (Canada)
+ * - Endonym: Français (Canada)
+ */
 const fr_CA: LocaleDefinition = {
   internet,
   location,
diff --git a/src/locales/fr_CH/index.ts b/src/locales/fr_CH/index.ts
index 36c67c18..9eec70e5 100644
--- a/src/locales/fr_CH/index.ts
+++ b/src/locales/fr_CH/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `fr_CH` locale.
+ *
+ * - Language: French (Switzerland)
+ * - Endonym: Français (Suisse)
+ */
 const fr_CH: LocaleDefinition = {
   cell_phone,
   internet,
diff --git a/src/locales/fr_LU/index.ts b/src/locales/fr_LU/index.ts
index 63c2151d..4bcd1513 100644
--- a/src/locales/fr_LU/index.ts
+++ b/src/locales/fr_LU/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `fr_LU` locale.
+ *
+ * - Language: French (Luxembourg)
+ * - Endonym: Français (Luxembourg)
+ */
 const fr_LU: LocaleDefinition = {
   cell_phone,
   internet,
diff --git a/src/locales/fr_SN/index.ts b/src/locales/fr_SN/index.ts
index 7b766e77..60a2608e 100644
--- a/src/locales/fr_SN/index.ts
+++ b/src/locales/fr_SN/index.ts
@@ -8,6 +8,12 @@ import location from './location';
 import metadata from './metadata';
 import person from './person';
 
+/**
+ * The locale data for the `fr_SN` locale.
+ *
+ * - Language: French (Senegal)
+ * - Endonym: Français (Sénégal)
+ */
 const fr_SN: LocaleDefinition = {
   internet,
   location,
diff --git a/src/locales/he/index.ts b/src/locales/he/index.ts
index b6e5dd8b..96af387d 100644
--- a/src/locales/he/index.ts
+++ b/src/locales/he/index.ts
@@ -15,6 +15,12 @@ import music from './music';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `he` locale.
+ *
+ * - Language: Hebrew
+ * - Endonym: עברית
+ */
 const he: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/hr/index.ts b/src/locales/hr/index.ts
index 5225cbc6..20cd5c6d 100644
--- a/src/locales/hr/index.ts
+++ b/src/locales/hr/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `hr` locale.
+ *
+ * - Language: Croatian
+ * - Endonym: Hrvatski
+ */
 const hr: LocaleDefinition = {
   cell_phone,
   date,
diff --git a/src/locales/hu/index.ts b/src/locales/hu/index.ts
index 8ae89f48..2154c6d0 100644
--- a/src/locales/hu/index.ts
+++ b/src/locales/hu/index.ts
@@ -16,6 +16,12 @@ import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
+/**
+ * The locale data for the `hu` locale.
+ *
+ * - Language: Hungarian
+ * - Endonym: magyar
+ */
 const hu: LocaleDefinition = {
   animal,
   color,
diff --git a/src/locales/hy/index.ts b/src/locales/hy/index.ts
index 2b8aef3e..592e5d90 100644
--- a/src/locales/hy/index.ts
+++ b/src/locales/hy/index.ts
@@ -12,6 +12,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `hy` locale.
+ *
+ * - Language: Armenian
+ * - Endonym: Հայերեն
+ */
 const hy: LocaleDefinition = {
   color,
   date,
diff --git a/src/locales/id_ID/index.ts b/src/locales/id_ID/index.ts
index 4b9e7ad9..4b864625 100644
--- a/src/locales/id_ID/index.ts
+++ b/src/locales/id_ID/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `id_ID` locale.
+ *
+ * - Language: Indonesian (Indonesia)
+ * - Endonym: Bahasa Indonesia (Indonesia)
+ */
 const id_ID: LocaleDefinition = {
   company,
   date,
diff --git a/src/locales/it/index.ts b/src/locales/it/index.ts
index 5e2af4e8..c97c7261 100644
--- a/src/locales/it/index.ts
+++ b/src/locales/it/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `it` locale.
+ *
+ * - Language: Italian
+ * - Endonym: Italiano
+ */
 const it: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/ja/index.ts b/src/locales/ja/index.ts
index b6d01961..8e6730c3 100644
--- a/src/locales/ja/index.ts
+++ b/src/locales/ja/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `ja` locale.
+ *
+ * - Language: Japanese
+ * - Endonym: 日本語
+ */
 const ja: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/ka_GE/index.ts b/src/locales/ka_GE/index.ts
index ea959663..b8146fdd 100644
--- a/src/locales/ka_GE/index.ts
+++ b/src/locales/ka_GE/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `ka_GE` locale.
+ *
+ * - Language: Georgian (Georgia)
+ * - Endonym: ქართული (საქართველო)
+ */
 const ka_GE: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/ko/index.ts b/src/locales/ko/index.ts
index 48fc7bc9..3fd3a96b 100644
--- a/src/locales/ko/index.ts
+++ b/src/locales/ko/index.ts
@@ -14,6 +14,12 @@ import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
+/**
+ * The locale data for the `ko` locale.
+ *
+ * - Language: Korean
+ * - Endonym: 한국어
+ */
 const ko: LocaleDefinition = {
   color,
   company,
diff --git a/src/locales/lv/index.ts b/src/locales/lv/index.ts
index f9c9a72c..cc91593a 100644
--- a/src/locales/lv/index.ts
+++ b/src/locales/lv/index.ts
@@ -15,6 +15,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `lv` locale.
+ *
+ * - Language: Latvian
+ * - Endonym: latviešu valoda
+ */
 const lv: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/mk/index.ts b/src/locales/mk/index.ts
index 68d5f6f4..78e543dd 100644
--- a/src/locales/mk/index.ts
+++ b/src/locales/mk/index.ts
@@ -12,6 +12,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `mk` locale.
+ *
+ * - Language: Macedonian
+ * - Endonym: македонски јазик
+ */
 const mk: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/nb_NO/index.ts b/src/locales/nb_NO/index.ts
index d9fa3d48..a4747890 100644
--- a/src/locales/nb_NO/index.ts
+++ b/src/locales/nb_NO/index.ts
@@ -14,6 +14,12 @@ import phone_number from './phone_number';
 import science from './science';
 import word from './word';
 
+/**
+ * The locale data for the `nb_NO` locale.
+ *
+ * - Language: Norwegian (Norway)
+ * - Endonym: Norsk bokmål (Norge)
+ */
 const nb_NO: LocaleDefinition = {
   color,
   commerce,
diff --git a/src/locales/ne/index.ts b/src/locales/ne/index.ts
index 451ad1cf..ab65258f 100644
--- a/src/locales/ne/index.ts
+++ b/src/locales/ne/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `ne` locale.
+ *
+ * - Language: Nepali
+ * - Endonym: नेपाली
+ */
 const ne: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/nl/index.ts b/src/locales/nl/index.ts
index b7039fc2..e0032a22 100644
--- a/src/locales/nl/index.ts
+++ b/src/locales/nl/index.ts
@@ -15,6 +15,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `nl` locale.
+ *
+ * - Language: Dutch
+ * - Endonym: Nederlands
+ */
 const nl: LocaleDefinition = {
   color,
   commerce,
diff --git a/src/locales/nl_BE/index.ts b/src/locales/nl_BE/index.ts
index cc6da2f4..5ed6b99a 100644
--- a/src/locales/nl_BE/index.ts
+++ b/src/locales/nl_BE/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `nl_BE` locale.
+ *
+ * - Language: Dutch (Belgium)
+ * - Endonym: Nederlands (België)
+ */
 const nl_BE: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/pl/index.ts b/src/locales/pl/index.ts
index b05c5f4e..bc0a3636 100644
--- a/src/locales/pl/index.ts
+++ b/src/locales/pl/index.ts
@@ -18,6 +18,12 @@ import phone_number from './phone_number';
 import science from './science';
 import team from './team';
 
+/**
+ * The locale data for the `pl` locale.
+ *
+ * - Language: Polish
+ * - Endonym: Polski
+ */
 const pl: LocaleDefinition = {
   animal,
   book,
diff --git a/src/locales/pt_BR/index.ts b/src/locales/pt_BR/index.ts
index d654ab9d..00236a9a 100644
--- a/src/locales/pt_BR/index.ts
+++ b/src/locales/pt_BR/index.ts
@@ -14,6 +14,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `pt_BR` locale.
+ *
+ * - Language: Portuguese (Brazil)
+ * - Endonym: Português (Brasil)
+ */
 const pt_BR: LocaleDefinition = {
   color,
   commerce,
diff --git a/src/locales/pt_PT/index.ts b/src/locales/pt_PT/index.ts
index e60fe0ab..6f052da4 100644
--- a/src/locales/pt_PT/index.ts
+++ b/src/locales/pt_PT/index.ts
@@ -14,6 +14,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `pt_PT` locale.
+ *
+ * - Language: Portuguese (Portugal)
+ * - Endonym: Português (Portugal)
+ */
 const pt_PT: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/ro/index.ts b/src/locales/ro/index.ts
index 87c61aa4..27ca849e 100644
--- a/src/locales/ro/index.ts
+++ b/src/locales/ro/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `ro` locale.
+ *
+ * - Language: Romanian
+ * - Endonym: Română
+ */
 const ro: LocaleDefinition = {
   cell_phone,
   date,
diff --git a/src/locales/ro_MD/index.ts b/src/locales/ro_MD/index.ts
index 705ae65e..451ea9be 100644
--- a/src/locales/ro_MD/index.ts
+++ b/src/locales/ro_MD/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `ro_MD` locale.
+ *
+ * - Language: Romanian (Moldova)
+ * - Endonym: Română (Moldova)
+ */
 const ro_MD: LocaleDefinition = {
   cell_phone,
   date,
diff --git a/src/locales/ru/index.ts b/src/locales/ru/index.ts
index e2e7d0e6..a696c22f 100644
--- a/src/locales/ru/index.ts
+++ b/src/locales/ru/index.ts
@@ -15,6 +15,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `ru` locale.
+ *
+ * - Language: Russian
+ * - Endonym: Русский
+ */
 const ru: LocaleDefinition = {
   color,
   commerce,
diff --git a/src/locales/sk/index.ts b/src/locales/sk/index.ts
index 3f274dbd..f548144d 100644
--- a/src/locales/sk/index.ts
+++ b/src/locales/sk/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `sk` locale.
+ *
+ * - Language: Slovak
+ * - Endonym: slovenčina
+ */
 const sk: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/sr_RS_latin/index.ts b/src/locales/sr_RS_latin/index.ts
index caaef346..eb1feed8 100644
--- a/src/locales/sr_RS_latin/index.ts
+++ b/src/locales/sr_RS_latin/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `sr_RS_latin` locale.
+ *
+ * - Language: Serbian (Serbia, Latin)
+ * - Endonym: srpski (Srbija, latinica)
+ */
 const sr_RS_latin: LocaleDefinition = {
   cell_phone,
   date,
diff --git a/src/locales/sv/index.ts b/src/locales/sv/index.ts
index c851468f..6eca718e 100644
--- a/src/locales/sv/index.ts
+++ b/src/locales/sv/index.ts
@@ -15,6 +15,12 @@ import person from './person';
 import phone_number from './phone_number';
 import team from './team';
 
+/**
+ * The locale data for the `sv` locale.
+ *
+ * - Language: Swedish
+ * - Endonym: Svenska
+ */
 const sv: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/th/index.ts b/src/locales/th/index.ts
index fe9562c5..a28027ce 100644
--- a/src/locales/th/index.ts
+++ b/src/locales/th/index.ts
@@ -12,6 +12,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `th` locale.
+ *
+ * - Language: Thai
+ * - Endonym: ไทย
+ */
 const th: LocaleDefinition = {
   animal,
   color,
diff --git a/src/locales/tr/index.ts b/src/locales/tr/index.ts
index b72e1854..a6c6d500 100644
--- a/src/locales/tr/index.ts
+++ b/src/locales/tr/index.ts
@@ -13,6 +13,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `tr` locale.
+ *
+ * - Language: Turkish
+ * - Endonym: Türkçe
+ */
 const tr: LocaleDefinition = {
   cell_phone,
   color,
diff --git a/src/locales/uk/index.ts b/src/locales/uk/index.ts
index 31ba1899..4915b3c3 100644
--- a/src/locales/uk/index.ts
+++ b/src/locales/uk/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `uk` locale.
+ *
+ * - Language: Ukrainian
+ * - Endonym: Українська
+ */
 const uk: LocaleDefinition = {
   company,
   internet,
diff --git a/src/locales/ur/index.ts b/src/locales/ur/index.ts
index f9fcaec8..4d5b3674 100644
--- a/src/locales/ur/index.ts
+++ b/src/locales/ur/index.ts
@@ -18,6 +18,12 @@ import person from './person';
 import team from './team';
 import vehicle from './vehicle';
 
+/**
+ * The locale data for the `ur` locale.
+ *
+ * - Language: Urdu
+ * - Endonym: اردو
+ */
 const ur: LocaleDefinition = {
   animal,
   app,
diff --git a/src/locales/uz_UZ_latin/index.ts b/src/locales/uz_UZ_latin/index.ts
index af7692b2..ba1a956f 100644
--- a/src/locales/uz_UZ_latin/index.ts
+++ b/src/locales/uz_UZ_latin/index.ts
@@ -11,6 +11,12 @@ import lorem from './lorem';
 import metadata from './metadata';
 import person from './person';
 
+/**
+ * The locale data for the `uz_UZ_latin` locale.
+ *
+ * - Language: Uzbek (Uzbekistan, Latin)
+ * - Endonym: O'zbekcha
+ */
 const uz_UZ_latin: LocaleDefinition = {
   color,
   commerce,
diff --git a/src/locales/vi/index.ts b/src/locales/vi/index.ts
index 519f1490..26f05187 100644
--- a/src/locales/vi/index.ts
+++ b/src/locales/vi/index.ts
@@ -13,6 +13,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `vi` locale.
+ *
+ * - Language: Vietnamese
+ * - Endonym: Tiếng Việt
+ */
 const vi: LocaleDefinition = {
   cell_phone,
   company,
diff --git a/src/locales/yo_NG/index.ts b/src/locales/yo_NG/index.ts
index 967e785c..33a18948 100644
--- a/src/locales/yo_NG/index.ts
+++ b/src/locales/yo_NG/index.ts
@@ -6,6 +6,12 @@ import type { LocaleDefinition } from '../..';
 import metadata from './metadata';
 import person from './person';
 
+/**
+ * The locale data for the `yo_NG` locale.
+ *
+ * - Language: Yoruba (Nigeria)
+ * - Endonym: Yoruba (Naijiria)
+ */
 const yo_NG: LocaleDefinition = {
   metadata,
   person,
diff --git a/src/locales/zh_CN/index.ts b/src/locales/zh_CN/index.ts
index 9666df9a..7f83558d 100644
--- a/src/locales/zh_CN/index.ts
+++ b/src/locales/zh_CN/index.ts
@@ -22,6 +22,12 @@ import science from './science';
 import vehicle from './vehicle';
 import word from './word';
 
+/**
+ * The locale data for the `zh_CN` locale.
+ *
+ * - Language: Chinese (China)
+ * - Endonym: 中文 (中国)
+ */
 const zh_CN: LocaleDefinition = {
   airline,
   animal,
diff --git a/src/locales/zh_TW/index.ts b/src/locales/zh_TW/index.ts
index d837b7e0..17ae61ed 100644
--- a/src/locales/zh_TW/index.ts
+++ b/src/locales/zh_TW/index.ts
@@ -10,6 +10,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `zh_TW` locale.
+ *
+ * - Language: Chinese (Taiwan)
+ * - Endonym: 中文 (臺灣)
+ */
 const zh_TW: LocaleDefinition = {
   color,
   date,
diff --git a/src/locales/zu_ZA/index.ts b/src/locales/zu_ZA/index.ts
index 0e86ac70..740d594e 100644
--- a/src/locales/zu_ZA/index.ts
+++ b/src/locales/zu_ZA/index.ts
@@ -11,6 +11,12 @@ import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
+/**
+ * The locale data for the `zu_ZA` locale.
+ *
+ * - Language: Zulu (South Africa)
+ * - Endonym: isiZulu (Iningizimu Afrika)
+ */
 const zu_ZA: LocaleDefinition = {
   cell_phone,
   company,