Merge pull request #4040 from MetaMask/dm-docs-2

Even more documentation for various controllers and libs.

1 files changed, 13 insertions, 5 deletions

diff --git a/app/scripts/lib/seed-phrase-verifier.js b/app/scripts/lib/seed-phrase-verifier.js
index 7ba712c0d..3b5afb800 100644
--- a/app/scripts/lib/seed-phrase-verifier.js
+++ b/app/scripts/lib/seed-phrase-verifier.js
@@ -3,11 +3,19 @@ const log = require('loglevel')
 
 const seedPhraseVerifier = {
 
-  // Verifies if the seed words can restore the accounts.
-  //
-  // The seed words can recreate the primary keyring and the accounts belonging to it.
-  // The created accounts in the primary keyring are always the same.
-  // The keyring always creates the accounts in the same sequence.
+  /**
+   * Verifies if the seed words can restore the accounts.
+   *
+   * Key notes:
+   * - The seed words can recreate the primary keyring and the accounts belonging to it.
+   * - The created accounts in the primary keyring are always the same.
+   * - The keyring always creates the accounts in the same sequence.
+   *
+   * @param {array} createdAccounts The accounts to restore
+   * @param {string} seedWords The seed words to verify
+   * @returns {Promise<void>} Promises undefined
+   *
+  */
   verifyAccounts (createdAccounts, seedWords) {
 
     return new Promise((resolve, reject) => {