refactor(php-doc) : add/edit phpdoc to every controller method

- Create PHPDocs for ActiveTasksController
- Create PHPDocs for DashboardController
- Create PHPDocs for ExecuteTasksController
- Update PHPDocs in TasksController

Author: carusogabriel

src/Http/Controllers/ActiveTasksController.php

@@ -22,13 +22,25 @@ public function __construct(TaskInterface $tasks)
         $this->tasks = $tasks;
     }
 
+    /**
+     * Store a newly active task in storage.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\Response
+     */
     public function store(Request $request)
     {
         $task = $this->tasks->activate($request->all());
 
         return response()->json($task, 200);
     }
 
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param  int  $id
+     * @return \Illuminate\Http\Response
+     */
     public function destroy($id)
     {
         $task = $this->tasks->deactivate($id);

src/Http/Controllers/DashboardController.php

@@ -4,6 +4,11 @@
 
 class DashboardController extends Controller
 {
+    /**
+     * Single page application catch-all route.
+     *
+     * @return \Illuminate\Http\Response
+     */
     public function index()
     {
         return redirect()->route('totem.tasks.all');

src/Http/Controllers/ExecuteTasksController.php

@@ -6,6 +6,11 @@
 
 class ExecuteTasksController extends Controller
 {
+    /**
+     * Execute a specific task.
+     *
+     * @return \Illuminate\Http\Response
+     */
     public function index($task)
     {
         $command = app($task->command);

src/Http/Controllers/TasksController.php

@@ -22,6 +22,7 @@ class TasksController extends Controller
 
     /**
      * TasksController constructor.
+     *
      * @param TaskInterface $tasks
      * @param Kernel $kernel
      */
@@ -34,6 +35,8 @@ public function __construct(TaskInterface $tasks, Kernel $kernel)
     }
 
     /**
+     * Display a listing of the tasks.
+     *
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
     public function index()
@@ -44,6 +47,8 @@ public function index()
     }
 
     /**
+     * Show the form for creating a new task.
+     *
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
     public function create()
@@ -57,6 +62,8 @@ public function create()
     }
 
     /**
+     * Store a newly created task in storage.
+     *
      * @param TaskRequest $request
      * @return \Illuminate\Http\RedirectResponse
      */
@@ -70,6 +77,8 @@ public function store(TaskRequest $request)
     }
 
     /**
+     * Display the specified task.
+     *
      * @param $task
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
@@ -81,6 +90,8 @@ public function view($task)
     }
 
     /**
+     * Show the form for editing the specified task.
+     *
      * @param $task
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
@@ -95,6 +106,8 @@ public function edit($task)
     }
 
     /**
+     * Update the specified task in storage.
+     *
      * @param TaskRequest $request
      * @param $task
      * @return \Illuminate\Http\RedirectResponse
@@ -109,6 +122,8 @@ public function update(TaskRequest $request, $task)
     }
 
     /**
+     * Remove the specified task from storage.
+     *
      * @param $task
      * @return \Illuminate\Http\RedirectResponse
      */