#1583 added doc comments

Author: walker-sean

src/backend/src/utils/reimbursement-requests.utils.ts

@@ -396,6 +396,12 @@ export const validateUserEditRRPermissions = async (
   }
 };
 
+/**
+ * Validates that the refund amount is less than the total amount owed to the user
+ * @param user the user reporting or editing a refund
+ * @param refundAmount the amount of the refund
+ * @param organizationId the organization the request pertains to
+ */
 export const validateRefund = async (user: User, refundAmount: number, organizationId: string) => {
   const totalOwed = await prisma.reimbursement_Request
     .findMany({

src/frontend/src/hooks/finance.hooks.ts

@@ -426,6 +426,10 @@ export const useReportRefund = () => {
   );
 };
 
+/**
+ * Custom react hook to edit a refund
+ * @returns the edited refund
+ */
 export const useEditRefund = () => {
   const queryClient = useQueryClient();