Documenting Controllers

app/Http/Controllers/CompanyController.php

@@ -19,12 +19,23 @@ use Crater\Currency;
 use Crater\CompanySetting;
 
 class CompanyController extends Controller
-{
+{   
+    /**
+     * Retrive the Admin account.
+     * @return \Crater\User
+     */
     public function getAdmin()
     {
         return User::find(1);
     }
 
+    /**
+     * Update the Admin profile.
+     * Includes name, email and (or) password
+     *
+     * @param  \Crater\Http\Requests\ProfileRequest $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function updateAdminProfile(ProfileRequest $request)
     {
         $verifyEmail = User::where('email', $request->email)->first();
@@ -54,6 +65,14 @@ class CompanyController extends Controller
         ]);
     }
 
+
+    
+    /**
+     * Get Admin Account alongside the country from the addresses table and 
+     * The company from companies table
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function getAdminCompany()
     {
         $user = User::with(['addresses', 'addresses.country', 'company'])->find(1);
@@ -63,6 +82,13 @@ class CompanyController extends Controller
         ]);
     }
 
+
+
+    /**
+     * Update Admin Company Details
+     * @param \Crater\Http\Requests\CompanyRequest $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function updateAdminCompany(CompanyRequest $request)
     {
         $user = User::find(1);
@@ -85,6 +111,11 @@ class CompanyController extends Controller
         ]);
     }
 
+    /**
+     * Retrieve General App Settings
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function getGeneralSettings(Request $request)
     {
         $date_formats = DateFormatter::get_list();
@@ -133,6 +164,13 @@ class CompanyController extends Controller
         ]);
     }
 
+
+
+    /**
+     * Update General App Settings
+     * @param \Crater\Http\Requests\CompanySettingRequest $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function updateGeneralSettings(CompanySettingRequest $request)
     {
         $sets = [
@@ -153,6 +191,11 @@ class CompanyController extends Controller
         ]);
     }
 
+    /**
+     * Update a specific Company Setting
+     * @param \Crater\Http\Requests\SettingRequest $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function updateSetting(SettingRequest $request)
     {
         CompanySetting::setSetting($request->key, $request->value, $request->header('company'));
@@ -162,6 +205,11 @@ class CompanyController extends Controller
         ]);
     }
 
+    /**
+     * Retrieve Specific Company Setting
+     * @param \Crater\Http\Requests\SettingKeyRequest $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function getSetting(SettingKeyRequest $request)
     {
         $setting = CompanySetting::getSetting($request->key, $request->header('company'));
@@ -171,6 +219,12 @@ class CompanyController extends Controller
         ]);
     }
 
+
+    /**
+     * Retrieve App Colors
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function getColors(Request $request)
     {
         $colors = [
@@ -205,7 +259,7 @@ class CompanyController extends Controller
      * Upload the company logo to storage.
      *
      * @param  \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function uploadCompanyLogo(Request $request)
     {
@@ -232,7 +286,7 @@ class CompanyController extends Controller
      * Upload the Admin Avatar to public storage.
      *
      * @param  \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function uploadAdminAvatar(Request $request)
     {