db done

createdb.sql

@@ -202,7 +202,7 @@ BEGIN
 
 --    if (locate("@",email) = 0
 	-- 	Select "invalid email as Error";
-
+-- ADDS A ROW TO THE PARENTS TABLE WHILE FORMATTING THE id CORRECTLY
         INSERT INTO Parents(parentID,fname,lname,email,phonenum) values
 	(md5(concat(email,passwerd)),fname,lname,email,phonenum);
 END$$addParent
@@ -235,7 +235,8 @@ delimiter $$
 CREATE PROCEDURE VoltoStuRatio(
 	IN ageGroup int(3),
 	IN noOfVols int(10))
-
+-- CONVERTS THE AGE GROUP INTO THE MAX NUMBER OF
+-- STUDENTS ALLOWED PER 1 VOLUNTEER
 BEGIN
 				IF ageGroup=1
 					THEN
@@ -255,6 +256,7 @@ DELIMITER ;
 drop procedure if exists addBadgereq;
 delimiter $$
 CREATE PROCEDURE addBadgereq(
+  -- ADDS A REQUIREMENT FOR A BADGE`
 	IN youNeed varchar(40),
 	IN  toGet varchar(40))
 	-- I use this naming scheme as it just makes it easy to understand
@@ -274,6 +276,7 @@ DELIMITER ;
 drop procedure if exists addBadge;
 delimiter $$
 CREATE PROCEDURE addBadge(
+  -- CREATES BADGE
 	IN badgeName varchar(40),
 	IN badgeDesc varchar(255))
 
@@ -291,6 +294,7 @@ DELIMITER ;
 drop procedure if exists `applyToGroup`;
 delimiter $$
 CREATE PROCEDURE applyToGroup(
+-- PUTS THE Student ON THE WaitList
 	IN studentID varchar(40),
 	IN groupID varchar(40),
 ageGroup int(2))
@@ -330,6 +334,7 @@ DELIMITER ;
 drop procedure if exists viewStudent;
 delimiter $$
 CREATE PROCEDURE viewStudent(
+  -- EITHER SHOWS ALL THE INFO ON A SPECIFIC OR ALL STUDENTS
 	IN studentvID varchar(40))
 BEGIN
 	If LENGTH(studentvID) = 0
@@ -345,6 +350,7 @@ DELIMITER ;
 drop procedure if exists viewVolunteer;
 delimiter $$
 CREATE PROCEDURE viewVolunteer(
+  -- SHOWS ALL THE INFO ON A SPECIFIC OR ALL Volunteers
 	IN VolunteervID varchar(40))
 BEGIN
 	If LENGTH(volunteervID) = 0
@@ -359,6 +365,7 @@ DELIMITER ;
 drop procedure if exists Studentattends;
 delimiter $$
 CREATE PROCEDURE Studentattends(
+  -- REPRESENTS A STUDENT ATTENDING A SPECIFIC SESSION
     IN studentID varchar(40),
 		IN sessionID varchar(40))
 
@@ -373,6 +380,7 @@ DELIMITER ;
 drop procedure if exists volunteerattends;
 delimiter $$
 CREATE PROCEDURE volunteerattends(
+  -- RESPRESENTS A VOLUNTEER VOLUNTEERING
     IN volunteerID varchar(40),
 		IN sessionID varchar(40))
 
@@ -387,6 +395,8 @@ DELIMITER ;
 drop procedure if exists addSession;
 delimiter $$
 CREATE PROCEDURE addSession(
+  -- CREATES A NEW ROW ON THE SESSION TABLE
+  -- WHILST CORRECTLY FORMATTING THE ITEMS
 	IN location varchar(35),
 	IN duration int(10),
 	IN learderID varchar(40),
@@ -408,6 +418,7 @@ DELIMITER ;
 drop procedure if exists ReviewSession;
 delimiter $$
 CREATE PROCEDURE ReviewSession(
+  -- UPDATES THE SESSION TABLE ADDING A review OF THE SESSION
 	IN SessionID varchar(40),
 	IN reviewOfProgression varchar(400),
 	IN reviewOfstaffSafety varchar(400))
@@ -421,7 +432,7 @@ drop procedure if exists `addToGroup`;
 delimiter $$
 CREATE PROCEDURE addToGroup(
 	IN grapeID varchar(40))
-
+-- adds students off the waitlist to fill the group
 BEGIN
 DECLARE toad INT DEFAULT 0;
 DECLARE x INT Default 0;
@@ -471,6 +482,7 @@ DELIMITER ;
 drop procedure if exists updateDBS;
 delimiter $$
 CREATE PROCEDURE updateDBS(
+  -- updates the dbs check
 	IN VolunteerID varchar(40),
 	IN DateOfDBSApproval date)
 
@@ -480,6 +492,7 @@ END$$
 DELIMITER ;
 
 drop procedure if exists viewBadges;
+-- shows all the badges and their status of a specific student
 delimiter $$
 CREATE PROCEDURE viewBadges(
 	-- This function shows
@@ -501,7 +514,9 @@ DELIMITER ;
 drop procedure if exists volunteerviewBadges;
 delimiter $$
 CREATE PROCEDURE volunteerviewBadges()
+
 	-- This function shows all badge applications for a volunteer
+  -- so they can approve or deny them
 BEGIN
 
  	SELECT awardedID,(select fname from students where studentID=b0.awardedto) as `applicant`,
@@ -537,6 +552,7 @@ DELIMITER ;
 drop procedure if exists updateSG;
 delimiter $$
 CREATE PROCEDURE updateSG(
+  -- update the supergeeeks check date
 	IN VolunteerID varchar(40),
 	IN DateOfSGApproval date)
 
@@ -548,7 +564,8 @@ DELIMITER ;
 drop procedure if exists ViewCheckExpiries;
 delimiter $$
 CREATE PROCEDURE ViewCheckExpiries()
-
+-- creates a report on all volunteers who have a check THAT
+-- expires in the next 6 months
 BEGIN
         SELECT volunteerID,fname,lname,DBSdue,SGdue,
 				if(date_sub(DBSdue, interval 6 month) > CURDATE()=1,
@@ -569,6 +586,7 @@ DELIMITER ;
 drop procedure if exists StudentBadgeApply;
 delimiter $$
 CREATE PROCEDURE StudentBadgeApply(
+  -- submit an application for a specific badge
     IN studentID varchar(40),
 		IN BadgeID varchar(40),
 		IN badgeEvidence varchar(1000))
@@ -583,6 +601,7 @@ DELIMITER ;
 drop procedure if exists badgeApprove;
 delimiter $$
 CREATE PROCEDURE badgeApprove(
+  -- approves or denies a specific badge from a specific volunteer
     IN awardedID varchar(40),
 		IN volunteerID varchar(40),
 		IN result int(2))
@@ -593,4 +612,3 @@ BEGIN
 
 END$$
 DELIMITER ;
-