Issue #206 Added Documentation

alaashafaee · Apr 22, 2014 · 4538284 · 4538284
1 parent b27bc82
commit 4538284
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 2 deletions.
diff --git a/tutor/app/controllers/lecturers_controller.rb b/tutor/app/controllers/lecturers_controller.rb
@@ -1,4 +1,10 @@
 class LecturersController < ApplicationController
+	# [Profile - Story 5.8]
+	# Displays the profile of the lecturer chosen
+	# Parameters:
+	#	id: the Lecturer's id
+	# Returns: none
+	# Author: Serag
 	def show
 		@lecturer = Lecturer.find(params[:id])
 	end

diff --git a/tutor/app/controllers/students_controller.rb b/tutor/app/controllers/students_controller.rb
@@ -1,4 +1,10 @@
 class StudentsController < ApplicationController
+	# [Profile - Story 5.8]
+	# Displays the profile of the student chosen
+	# Parameters:
+	#	id: the Student's id
+	# Returns: none
+	# Author: Serag
 	def show
 		@student = Student.find(params[:id])
 	end

diff --git a/tutor/app/controllers/teaching_assistants_controller.rb b/tutor/app/controllers/teaching_assistants_controller.rb
@@ -1,4 +1,10 @@
 class TeachingAssistantsController < ApplicationController
+	# [Profile - Story 5.8]
+	# Displays the profile of the teaching assistant chosen
+	# Parameters:
+	#	id: the Teaching Assistant's id
+	# Returns: none
+	# Author: Serag
 	def show
 		@teaching_assistant = TeachingAssistant.find(params[:id])
 	end

diff --git a/tutor/app/views/students/show.html.erb b/tutor/app/views/students/show.html.erb
@@ -66,7 +66,7 @@
 </script>
 <html>
 	<head>
-		<title>CoolSoft - Java tutor | <%= @student.id%>'s Profile</title>
+		<title> <%= @student.id%>'s Profile </title>
 	<body>
 		<h1> <%= @student.name%>'s Profile </h1>
 		<div class="tabs">

diff --git a/tutor/config/routes.rb b/tutor/config/routes.rb
@@ -88,4 +88,5 @@
 	#     # Directs /admin/products/* to Admin::ProductsController
 	#     # (app/controllers/admin/products_controller.rb)
 	#     resources :products
-	#   end
+	#   end
+end