Issue #203 adding documentation

alaashafaee · Apr 23, 2014 · 90555e5 · 90555e5
1 parent b95c66d
commit 90555e5
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/tutor/app/controllers/tracks_controller.rb b/tutor/app/controllers/tracks_controller.rb
@@ -68,6 +68,11 @@ def create
 		end
 	end
 
+	# [Recommendatio to students - Story 5.7]
+	# returns a json object contains a Hash of classmates
+	# Parameters: none 
+	# Returns: json
+	# Author: Mohab Ghanim
 	def show_classmates
 		problem = Problem.find_by_id(params[:id])
 		track = problem.track
@@ -93,6 +98,11 @@ def show_classmates
 		render json: students_receiving_recommendation
 	end
 
+	# [Recommendatio to students - Story 5.7]
+	# Inserts a record in recommendation table
+	# Parameters: none 
+	# Returns: json
+	# Author: Mohab Ghanim
 	def insert_recommendation
 		problem_id = params[:p_id]
 		student_id = params[:s_id]