From 4762864c6fd0faa481adf14d419a8ecf3839c186 Mon Sep 17 00:00:00 2001
From: James Brooks <james@bluebaytravel.co.uk>
Date: Mon, 1 Dec 2014 08:38:26 +0000
Subject: [PATCH] PHPDoc the methods

---
 app/controllers/AuthController.php      | 13 ++++++++++++-
 app/controllers/DashboardController.php |  7 ++++---
 app/controllers/HomeController.php      |  2 +-
 app/controllers/RSSController.php       |  4 ++++
 app/controllers/SetupController.php     |  8 ++++++++
 5 files changed, 29 insertions(+), 5 deletions(-)

diff --git a/app/controllers/AuthController.php b/app/controllers/AuthController.php
index cff51122..7f579643 100644
--- a/app/controllers/AuthController.php
+++ b/app/controllers/AuthController.php
@@ -4,10 +4,18 @@
  * Logs users into their account
  */
 class AuthController extends Controller {
+    /**
+     * Shows the login view.
+     * @return \Illuminate\View\View
+     */
     public function showLogin() {
         return View::make('auth.login');
     }
 
+    /**
+     * Logs the user in.
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function postLogin() {
         if (Auth::attempt(Input::only(['email', 'password']))) {
             return Redirect::intended('dashboard');
@@ -18,9 +26,12 @@ class AuthController extends Controller {
         }
     }
 
+    /**
+     * Logs the user out, deleting their session etc.
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function logoutAction() {
         Auth::logout();
-
         return Redirect::to('/');
     }
 }
diff --git a/app/controllers/DashboardController.php b/app/controllers/DashboardController.php
index 1a94b683..b536472b 100644
--- a/app/controllers/DashboardController.php
+++ b/app/controllers/DashboardController.php
@@ -1,9 +1,10 @@
 <?php
 
-/**
- * AKA the Management Panel.
- */
 class DashboardController extends Controller {
+    /**
+     * Shows the dashboard view.
+     * @return \Illuminate\View\View
+     */
     public function showDashboard() {
         return View::make('dashboard.index');
     }
diff --git a/app/controllers/HomeController.php b/app/controllers/HomeController.php
index 918503c5..06a1d322 100644
--- a/app/controllers/HomeController.php
+++ b/app/controllers/HomeController.php
@@ -3,7 +3,7 @@
 class HomeController extends Controller {
     /**
      * Returns the rendered Blade templates.
-     * @return View
+     * @return \Illuminate\View\View
      */
     public function showIndex() {
         return View::make('index', ['components' => Component::all()]);
diff --git a/app/controllers/RSSController.php b/app/controllers/RSSController.php
index 76b355a3..9cabbb7f 100644
--- a/app/controllers/RSSController.php
+++ b/app/controllers/RSSController.php
@@ -1,6 +1,10 @@
 <?php
 
 class RSSController extends Controller {
+    /**
+     * Generates an RSS feed of all incidents.
+     * @return \Illuminate\Http\Response
+     */
     public function feedAction() {
         $feed = RSS::feed('2.0', 'UTF-8');
         $feed->channel([
diff --git a/app/controllers/SetupController.php b/app/controllers/SetupController.php
index 7b9af9b9..4c826664 100644
--- a/app/controllers/SetupController.php
+++ b/app/controllers/SetupController.php
@@ -1,12 +1,20 @@
 <?php
 
 class SetupController extends Controller {
+    /**
+     * Returns the setup page.
+     * @return \Illuminate\View\View
+     */
     public function showSetup() {
         return View::make('setup')->with([
             'pageTitle' => 'Setup'
         ]);
     }
 
+    /**
+     * Handles the actual app setup.
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function setupCachet() {
         $postData = Input::get();
         $v = Validator::make($postData, [