added documentation on admin manager

client/src/modules/Admin/Components/ManageAdminModal.tsx

@@ -20,6 +20,9 @@ const ManageAdminModal = ({token, open, setOpen}: Props) => {
         setOpen(false)
     }
 
+    /**
+     * Endpoint to get all admins
+     */
     useEffect(() => {
         axios
         .post('/api/getAdmins', {token: token})
@@ -33,6 +36,11 @@ const ManageAdminModal = ({token, open, setOpen}: Props) => {
         })
       }, [token])
 
+    /**
+     * Removes an admin from the list, giving that user 'regular' privilege
+     * @param user assumes that this user already has admin privilege
+     */
+
     function removeAdmin(user: Student) {
         axios
         .post('/api/removeAdmin', {
@@ -49,6 +57,11 @@ const ManageAdminModal = ({token, open, setOpen}: Props) => {
         }).catch((e) => console.log(`Unable to remove admin ${e}`))
     }
 
+    /**
+     * Calls endpoint to add or update a user with admin privilege
+     * @param _netId the user's net id
+     */
+
     function addAdminByNetId(_netId: string) {
         axios
         .post('/api/grantAdmin', {

server/src/admin/admin.data-access.ts

@@ -132,6 +132,11 @@ export const grantAdminPrivilege = async (id: string) => {
   return res
 }
 
+/*
+ * If there is an attempt to grant admin privilege to someone not in the database,
+ * a new user will be created with the given netid and added to the database.
+ */
+
 export const createNewAdminUser = async (id: string) => {
 
   const admin: InsertStudentType = {