Skip to content

Commit df20c0a

Browse files
committed
Fix doc comments in TOTP files
1 parent 2ab3198 commit df20c0a

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

packages/auth/src/mfa/assertions/totp.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export class TotpMultiFactorGenerator {
4646
* the totp(Time-based One Time Password) second factor.
4747
* This assertion is used to complete enrollment in TOTP second factor.
4848
*
49-
* @param secret {@link TotpSecret}.
49+
* @param secret A {@link TotpSecret} containing the shared secret key and other TOTP parameters.
5050
* @param oneTimePassword One-time password from TOTP App.
5151
* @returns A {@link TotpMultiFactorAssertion} which can be used with
5252
* {@link MultiFactorUser.enroll}.
@@ -78,12 +78,12 @@ export class TotpMultiFactorGenerator {
7878
}
7979

8080
/**
81-
* Returns a promise to {@link TOTPSecret} which contains the TOTP shared secret key and other parameters.
81+
* Returns a promise to {@link TotpSecret} which contains the TOTP shared secret key and other parameters.
8282
* Creates a TOTP secret as part of enrolling a TOTP second factor.
8383
* Used for generating a QRCode URL or inputting into a TOTP App.
8484
* This method uses the auth instance corresponding to the user in the multiFactorSession.
8585
*
86-
* @param session A link to {@MultiFactorSession}.
86+
* @param session The {@link MultiFactorSession} that the user is part of.
8787
* @returns A promise to {@link TotpSecret}.
8888
*/
8989
static async generateSecret(
@@ -184,7 +184,7 @@ export class TotpMultiFactorAssertionImpl
184184
*/
185185
export class TotpSecret {
186186
/**
187-
* Shared secret key/seed used for enrolling in TOTP MFA and generating otps.
187+
* Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.
188188
*/
189189
readonly secretKey: string;
190190
/**

packages/auth/src/model/public_types.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1240,7 +1240,8 @@ export interface Dependencies {
12401240

12411241
/**
12421242
* The class for asserting ownership of a totp second factor. Provided by
1243-
* {@link TotpMultiFactorGenerator.assertion}.
1243+
* {@link TotpMultiFactorGenerator.assertionForEnrollment} and
1244+
* {@link TotpMultiFactorGenerator.assertionForSignIn}.
12441245
*
12451246
* @public
12461247
*/

0 commit comments

Comments
 (0)