Updated function comments

balajidharma · balajidharma · commit d4f071acff6d · 2022-12-28T21:20:07.000-05:00
diff --git a/app/Http/Controllers/Admin/PermissionController.php b/app/Http/Controllers/Admin/PermissionController.php
@@ -22,7 +22,7 @@ public function __construct()
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function index()
     {
@@ -60,7 +60,7 @@ public function index()
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function create()
     {
@@ -71,7 +71,7 @@ public function create()
      * Store a newly created resource in storage.
      *
      * @param  \App\Http\Requests\Admin\StorePermissionRequest  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(StorePermissionRequest $request)
     {
@@ -85,7 +85,7 @@ public function store(StorePermissionRequest $request)
      * Display the specified resource.
      *
      * @param  \App\Models\Permission  $permission
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function show(Permission $permission)
     {
@@ -98,7 +98,7 @@ public function show(Permission $permission)
      * Show the form for editing the specified resource.
      *
      * @param  \App\Models\Permission  $permission
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function edit(Permission $permission)
     {
@@ -112,7 +112,7 @@ public function edit(Permission $permission)
      *
      * @param  \App\Http\Requests\Admin\UpdatePermissionRequest  $request
      * @param  \App\Models\Permission  $permission
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(UpdatePermissionRequest $request, Permission $permission)
     {
@@ -126,7 +126,7 @@ public function update(UpdatePermissionRequest $request, Permission $permission)
      * Remove the specified resource from storage.
      *
      * @param  \App\Models\Permission  $permission
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroy(Permission $permission)
     {
diff --git a/app/Http/Controllers/Admin/RoleController.php b/app/Http/Controllers/Admin/RoleController.php
@@ -23,7 +23,7 @@ public function __construct()
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function index()
     {
@@ -61,7 +61,7 @@ public function index()
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function create()
     {
@@ -76,7 +76,7 @@ public function create()
      * Store a newly created resource in storage.
      *
      * @param  \App\Http\Requests\Admin\StoreRoleRequest  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(StoreRoleRequest $request)
     {
@@ -94,7 +94,7 @@ public function store(StoreRoleRequest $request)
      * Display the specified resource.
      *
      * @param  \App\Models\Role  $role
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function show(Role $role)
     {
@@ -112,7 +112,7 @@ public function show(Role $role)
      * Show the form for editing the specified resource.
      *
      * @param  \App\Models\Role  $role
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function edit(Role $role)
     {
@@ -131,7 +131,7 @@ public function edit(Role $role)
      *
      * @param  \App\Http\Requests\Admin\UpdateRoleRequest  $request
      * @param  \App\Models\Role  $role
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(UpdateRoleRequest $request, Role $role)
     {
@@ -147,7 +147,7 @@ public function update(UpdateRoleRequest $request, Role $role)
      * Remove the specified resource from storage.
      *
      * @param  \App\Models\Role  $role
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroy(Role $role)
     {
diff --git a/app/Http/Controllers/Admin/UserController.php b/app/Http/Controllers/Admin/UserController.php
@@ -28,7 +28,7 @@ public function __construct()
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function index()
     {
@@ -66,7 +66,7 @@ public function index()
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function create()
     {
@@ -96,7 +96,7 @@ public function store(StoreUserRequest $request, CreateUser $createUser)
      * Display the specified resource.
      *
      * @param  \App\Models\User  $user
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function show(User $user)
     {
@@ -114,7 +114,7 @@ public function show(User $user)
      * Show the form for editing the specified resource.
      *
      * @param  \App\Models\User  $user
-     * @return \Illuminate\Http\Response
+     * @return \Inertia\Response
      */
     public function edit(User $user)
     {
@@ -134,7 +134,7 @@ public function edit(User $user)
      * @param  \App\Http\Requests\Admin\UpdateUserRequest  $request
      * @param  \App\Models\User  $user
      * @param  \App\Actions\Admin\User\UpdateUser  $updateUser
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(UpdateUserRequest $request, User $user, UpdateUser $updateUser)
     {
@@ -148,7 +148,7 @@ public function update(UpdateUserRequest $request, User $user, UpdateUser $updat
      * Remove the specified resource from storage.
      *
      * @param  \App\Models\User  $user
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroy(User $user)
     {
@@ -160,6 +160,8 @@ public function destroy(User $user)
 
     /**
      * Show the user a form to change their personal information & password.
+     *
+     * @return \Inertia\Response
      */
     public function accountInfo()
     {
@@ -172,6 +174,9 @@ public function accountInfo()
 
     /**
      * Save the modified personal information for a user.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function accountInfoStore(Request $request)
     {
@@ -193,6 +198,9 @@ public function accountInfoStore(Request $request)
 
     /**
      * Save the new password for a user.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function changePasswordStore(Request $request)
     {

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public function __construct()`
`22`	`22`	`/**`
`23`	`23`	`* Display a listing of the resource.`
`24`	`24`	`*`
`25`		`- * @return \Illuminate\Http\Response`
	`25`	`+ * @return \Inertia\Response`
`26`	`26`	`*/`
`27`	`27`	`public function index()`
`28`	`28`	`{`
`@@ -60,7 +60,7 @@ public function index()`
`60`	`60`	`/**`
`61`	`61`	`* Show the form for creating a new resource.`
`62`	`62`	`*`
`63`		`- * @return \Illuminate\Http\Response`
	`63`	`+ * @return \Inertia\Response`
`64`	`64`	`*/`
`65`	`65`	`public function create()`
`66`	`66`	`{`
`@@ -71,7 +71,7 @@ public function create()`
`71`	`71`	`* Store a newly created resource in storage.`
`72`	`72`	`*`
`73`	`73`	`* @param \App\Http\Requests\Admin\StorePermissionRequest $request`
`74`		`- * @return \Illuminate\Http\Response`
	`74`	`+ * @return \Illuminate\Http\RedirectResponse`
`75`	`75`	`*/`
`76`	`76`	`public function store(StorePermissionRequest $request)`
`77`	`77`	`{`
`@@ -85,7 +85,7 @@ public function store(StorePermissionRequest $request)`
`85`	`85`	`* Display the specified resource.`
`86`	`86`	`*`
`87`	`87`	`* @param \App\Models\Permission $permission`
`88`		`- * @return \Illuminate\Http\Response`
	`88`	`+ * @return \Inertia\Response`
`89`	`89`	`*/`
`90`	`90`	`public function show(Permission $permission)`
`91`	`91`	`{`
`@@ -98,7 +98,7 @@ public function show(Permission $permission)`
`98`	`98`	`* Show the form for editing the specified resource.`
`99`	`99`	`*`
`100`	`100`	`* @param \App\Models\Permission $permission`
`101`		`- * @return \Illuminate\Http\Response`
	`101`	`+ * @return \Inertia\Response`
`102`	`102`	`*/`
`103`	`103`	`public function edit(Permission $permission)`
`104`	`104`	`{`
`@@ -112,7 +112,7 @@ public function edit(Permission $permission)`
`112`	`112`	`*`
`113`	`113`	`* @param \App\Http\Requests\Admin\UpdatePermissionRequest $request`
`114`	`114`	`* @param \App\Models\Permission $permission`
`115`		`- * @return \Illuminate\Http\Response`
	`115`	`+ * @return \Illuminate\Http\RedirectResponse`
`116`	`116`	`*/`
`117`	`117`	`public function update(UpdatePermissionRequest $request, Permission $permission)`
`118`	`118`	`{`
`@@ -126,7 +126,7 @@ public function update(UpdatePermissionRequest $request, Permission $permission)`
`126`	`126`	`* Remove the specified resource from storage.`
`127`	`127`	`*`
`128`	`128`	`* @param \App\Models\Permission $permission`
`129`		`- * @return \Illuminate\Http\Response`
	`129`	`+ * @return \Illuminate\Http\RedirectResponse`
`130`	`130`	`*/`
`131`	`131`	`public function destroy(Permission $permission)`
`132`	`132`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function __construct()`
`23`	`23`	`/**`
`24`	`24`	`* Display a listing of the resource.`
`25`	`25`	`*`
`26`		`- * @return \Illuminate\Http\Response`
	`26`	`+ * @return \Inertia\Response`
`27`	`27`	`*/`
`28`	`28`	`public function index()`
`29`	`29`	`{`
`@@ -61,7 +61,7 @@ public function index()`
`61`	`61`	`/**`
`62`	`62`	`* Show the form for creating a new resource.`
`63`	`63`	`*`
`64`		`- * @return \Illuminate\Http\Response`
	`64`	`+ * @return \Inertia\Response`
`65`	`65`	`*/`
`66`	`66`	`public function create()`
`67`	`67`	`{`
`@@ -76,7 +76,7 @@ public function create()`
`76`	`76`	`* Store a newly created resource in storage.`
`77`	`77`	`*`
`78`	`78`	`* @param \App\Http\Requests\Admin\StoreRoleRequest $request`
`79`		`- * @return \Illuminate\Http\Response`
	`79`	`+ * @return \Illuminate\Http\RedirectResponse`
`80`	`80`	`*/`
`81`	`81`	`public function store(StoreRoleRequest $request)`
`82`	`82`	`{`
`@@ -94,7 +94,7 @@ public function store(StoreRoleRequest $request)`
`94`	`94`	`* Display the specified resource.`
`95`	`95`	`*`
`96`	`96`	`* @param \App\Models\Role $role`
`97`		`- * @return \Illuminate\Http\Response`
	`97`	`+ * @return \Inertia\Response`
`98`	`98`	`*/`
`99`	`99`	`public function show(Role $role)`
`100`	`100`	`{`
`@@ -112,7 +112,7 @@ public function show(Role $role)`
`112`	`112`	`* Show the form for editing the specified resource.`
`113`	`113`	`*`
`114`	`114`	`* @param \App\Models\Role $role`
`115`		`- * @return \Illuminate\Http\Response`
	`115`	`+ * @return \Inertia\Response`
`116`	`116`	`*/`
`117`	`117`	`public function edit(Role $role)`
`118`	`118`	`{`
`@@ -131,7 +131,7 @@ public function edit(Role $role)`
`131`	`131`	`*`
`132`	`132`	`* @param \App\Http\Requests\Admin\UpdateRoleRequest $request`
`133`	`133`	`* @param \App\Models\Role $role`
`134`		`- * @return \Illuminate\Http\Response`
	`134`	`+ * @return \Illuminate\Http\RedirectResponse`
`135`	`135`	`*/`
`136`	`136`	`public function update(UpdateRoleRequest $request, Role $role)`
`137`	`137`	`{`
`@@ -147,7 +147,7 @@ public function update(UpdateRoleRequest $request, Role $role)`
`147`	`147`	`* Remove the specified resource from storage.`
`148`	`148`	`*`
`149`	`149`	`* @param \App\Models\Role $role`
`150`		`- * @return \Illuminate\Http\Response`
	`150`	`+ * @return \Illuminate\Http\RedirectResponse`
`151`	`151`	`*/`
`152`	`152`	`public function destroy(Role $role)`
`153`	`153`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function __construct()`
`28`	`28`	`/**`
`29`	`29`	`* Display a listing of the resource.`
`30`	`30`	`*`
`31`		`- * @return \Illuminate\Http\Response`
	`31`	`+ * @return \Inertia\Response`
`32`	`32`	`*/`
`33`	`33`	`public function index()`
`34`	`34`	`{`
`@@ -66,7 +66,7 @@ public function index()`
`66`	`66`	`/**`
`67`	`67`	`* Show the form for creating a new resource.`
`68`	`68`	`*`
`69`		`- * @return \Illuminate\Http\Response`
	`69`	`+ * @return \Inertia\Response`
`70`	`70`	`*/`
`71`	`71`	`public function create()`
`72`	`72`	`{`
`@@ -96,7 +96,7 @@ public function store(StoreUserRequest $request, CreateUser $createUser)`
`96`	`96`	`* Display the specified resource.`
`97`	`97`	`*`
`98`	`98`	`* @param \App\Models\User $user`
`99`		`- * @return \Illuminate\Http\Response`
	`99`	`+ * @return \Inertia\Response`
`100`	`100`	`*/`
`101`	`101`	`public function show(User $user)`
`102`	`102`	`{`
`@@ -114,7 +114,7 @@ public function show(User $user)`
`114`	`114`	`* Show the form for editing the specified resource.`
`115`	`115`	`*`
`116`	`116`	`* @param \App\Models\User $user`
`117`		`- * @return \Illuminate\Http\Response`
	`117`	`+ * @return \Inertia\Response`
`118`	`118`	`*/`
`119`	`119`	`public function edit(User $user)`
`120`	`120`	`{`
`@@ -134,7 +134,7 @@ public function edit(User $user)`
`134`	`134`	`* @param \App\Http\Requests\Admin\UpdateUserRequest $request`
`135`	`135`	`* @param \App\Models\User $user`
`136`	`136`	`* @param \App\Actions\Admin\User\UpdateUser $updateUser`
`137`		`- * @return \Illuminate\Http\Response`
	`137`	`+ * @return \Illuminate\Http\RedirectResponse`
`138`	`138`	`*/`
`139`	`139`	`public function update(UpdateUserRequest $request, User $user, UpdateUser $updateUser)`
`140`	`140`	`{`
`@@ -148,7 +148,7 @@ public function update(UpdateUserRequest $request, User $user, UpdateUser $updat`
`148`	`148`	`* Remove the specified resource from storage.`
`149`	`149`	`*`
`150`	`150`	`* @param \App\Models\User $user`
`151`		`- * @return \Illuminate\Http\Response`
	`151`	`+ * @return \Illuminate\Http\RedirectResponse`
`152`	`152`	`*/`
`153`	`153`	`public function destroy(User $user)`
`154`	`154`	`{`
`@@ -160,6 +160,8 @@ public function destroy(User $user)`
`160`	`160`
`161`	`161`	`/**`
`162`	`162`	`* Show the user a form to change their personal information & password.`
	`163`	`+ *`
	`164`	`+ * @return \Inertia\Response`
`163`	`165`	`*/`
`164`	`166`	`public function accountInfo()`
`165`	`167`	`{`
`@@ -172,6 +174,9 @@ public function accountInfo()`
`172`	`174`
`173`	`175`	`/**`
`174`	`176`	`* Save the modified personal information for a user.`
	`177`	`+ *`
	`178`	`+ * @param \Illuminate\Http\Request $request`
	`179`	`+ * @return \Illuminate\Http\RedirectResponse`
`175`	`180`	`*/`
`176`	`181`	`public function accountInfoStore(Request $request)`
`177`	`182`	`{`
`@@ -193,6 +198,9 @@ public function accountInfoStore(Request $request)`
`193`	`198`
`194`	`199`	`/**`
`195`	`200`	`* Save the new password for a user.`
	`201`	`+ *`
	`202`	`+ * @param \Illuminate\Http\Request $request`
	`203`	`+ * @return \Illuminate\Http\RedirectResponse`
`196`	`204`	`*/`
`197`	`205`	`public function changePasswordStore(Request $request)`
`198`	`206`	`{`