diff --git a/src/identities/identities.js b/src/identities/identities.js index e005d01..c85d537 100644 --- a/src/identities/identities.js +++ b/src/identities/identities.js @@ -52,7 +52,7 @@ const Identities = async ({ keystore, path, storage, ipfs } = {}) => { /** * Gets an identity by hash. * @param {string} hash An identity hash. - * @return {Identity} An instance of identity. + * @return {module:Identities~Identity} An instance of identity. * @memberof module:Identities~Identities * @instance */ diff --git a/src/identities/identity.js b/src/identities/identity.js index 8290563..00444ef 100644 --- a/src/identities/identity.js +++ b/src/identities/identity.js @@ -13,12 +13,11 @@ const hashStringEncoding = base58btc * @property {object} publicKey A public key. * @property {object} signatures A signed identity id and public key. * @property {string} type The type of identity provider. - * @property {function} sign A sign function. - * @property {function} verify A verify function. + * @property {function} sign A sign function to sign data using this identity. + * @property {function} verify A verify function to verify data signed by this identity. */ const Identity = async ({ id, publicKey, signatures, type, sign, verify } = {}) => { /** - * @namespace module:Identities~Identity * @description The Identity instance. Returned by * [Identities.createIdentity()]{@link module:Identities~Identities#createIdentity}. */