Add jsdoc comments for user verification, password reprompt, and appApiAction (#754)

* Rename and add comments to clarify password reprompt classes

* Add comment for appApiAction

common/src/services/userVerification.service.ts

@@ -7,6 +7,10 @@ import { VerifyOTPRequest } from "../models/request/account/verifyOTPRequest";
 import { SecretVerificationRequest } from "../models/request/secretVerificationRequest";
 import { Verification } from "../types/verification";
 
+/**
+ * Used for general-purpose user verification throughout the app.
+ * Use it to verify the input collected by UserVerificationComponent.
+ */
 export class UserVerificationService implements UserVerificationServiceAbstraction {
   constructor(
     private cryptoService: CryptoService,
@@ -14,6 +18,12 @@ export class UserVerificationService implements UserVerificationServiceAbstracti
     private apiService: ApiService
   ) {}
 
+  /**
+   * Create a new request model to be used for server-side verification
+   * @param verification User-supplied verification data (Master Password or OTP)
+   * @param requestClass The request model to create
+   * @param alreadyHashed Whether the master password is already hashed
+   */
   async buildRequest<T extends SecretVerificationRequest>(
     verification: Verification,
     requestClass?: new () => T,
@@ -35,6 +45,11 @@ export class UserVerificationService implements UserVerificationServiceAbstracti
     return request;
   }
 
+  /**
+   * Used to verify the Master Password client-side, or send the OTP to the server for verification (with no other data)
+   * Generally used for client-side verification only.
+   * @param verification User-supplied verification data (Master Password or OTP)
+   */
   async verifyUser(verification: Verification): Promise<boolean> {
     this.validateInput(verification);