Skip to content

Commit 00df0b6

Browse files
authored
Merge pull request pterodactyl#1148 from pterodactyl/feature/doc-block-improvements
@throws docblock improvements
2 parents 002efdd + b232055 commit 00df0b6

23 files changed

+47
-15
lines changed

app/Console/Commands/Environment/EmailSettingsCommand.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ public function __construct(ConfigRepository $config)
5959

6060
/**
6161
* Handle command execution.
62+
* @throws \Pterodactyl\Exceptions\PterodactylException
6263
*/
6364
public function handle()
6465
{

app/Http/Controllers/Admin/ApiController.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ public function index(Request $request): View
6565
* Render view allowing an admin to create a new application API key.
6666
*
6767
* @return \Illuminate\View\View
68+
* @throws \ReflectionException
6869
*/
6970
public function create(): View
7071
{

app/Http/Controllers/Admin/LocationController.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ public function view($id)
103103
* @return \Illuminate\Http\RedirectResponse
104104
*
105105
* @throws \Throwable
106-
* @throws \Watson\Validating\ValidationException
107106
*/
108107
public function create(LocationFormRequest $request)
109108
{
@@ -121,7 +120,6 @@ public function create(LocationFormRequest $request)
121120
* @return \Illuminate\Http\RedirectResponse
122121
*
123122
* @throws \Throwable
124-
* @throws \Watson\Validating\ValidationException
125123
*/
126124
public function update(LocationFormRequest $request, Location $location)
127125
{

app/Http/Controllers/Admin/Nests/EggVariableController.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,11 @@ public function view(int $egg): View
9090
* Handle a request to create a new Egg variable.
9191
*
9292
* @param \Pterodactyl\Http\Requests\Admin\Egg\EggVariableFormRequest $request
93-
* @param \Pterodactyl\Models\Egg $egg
93+
* @param \Pterodactyl\Models\Egg $egg
9494
*
9595
* @return \Illuminate\Http\RedirectResponse
9696
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
97+
* @throws \Pterodactyl\Exceptions\Service\Egg\Variable\BadValidationRuleException
9798
* @throws \Pterodactyl\Exceptions\Service\Egg\Variable\ReservedVariableNameException
9899
*/
99100
public function store(EggVariableFormRequest $request, Egg $egg): RedirectResponse

app/Http/Controllers/Admin/ServersController.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,7 @@ public function reinstallServer(Server $server)
462462
*
463463
* @param \Pterodactyl\Models\Server $server
464464
* @return \Illuminate\Http\RedirectResponse
465+
* @throws \Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException
465466
*/
466467
public function rebuildContainer(Server $server)
467468
{
@@ -536,11 +537,12 @@ public function delete(Request $request, Server $server)
536537
/**
537538
* Update the startup command as well as variables.
538539
*
539-
* @param \Illuminate\Http\Request $request
540+
* @param \Illuminate\Http\Request $request
540541
* @param \Pterodactyl\Models\Server $server
541542
* @return \Illuminate\Http\RedirectResponse
542543
*
543-
* @throws \Pterodactyl\Exceptions\DisplayException
544+
* @throws \Illuminate\Validation\ValidationException
545+
* @throws \Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException
544546
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
545547
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
546548
*/

app/Http/Controllers/Admin/Settings/AdvancedController.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ public function index(): View
7676
/**
7777
* @param \Pterodactyl\Http\Requests\Admin\Settings\AdvancedSettingsFormRequest $request
7878
* @return \Illuminate\Http\RedirectResponse
79+
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
80+
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
7981
*/
8082
public function update(AdvancedSettingsFormRequest $request): RedirectResponse
8183
{

app/Http/Controllers/Admin/Settings/IndexController.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ public function index(): View
7474
*
7575
* @param \Pterodactyl\Http\Requests\Admin\Settings\BaseSettingsFormRequest $request
7676
* @return \Illuminate\Http\RedirectResponse
77+
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
78+
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
7779
*/
7880
public function update(BaseSettingsFormRequest $request): RedirectResponse
7981
{

app/Http/Controllers/Admin/Settings/MailController.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ public function index(): View
8383
* @param \Pterodactyl\Http\Requests\Admin\Settings\MailSettingsFormRequest $request
8484
* @return \Illuminate\Http\RedirectResponse
8585
*
86-
* @throws \Pterodactyl\Exceptions\DisplayException
86+
* @throws DisplayException
87+
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
88+
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
8789
*/
8890
public function update(MailSettingsFormRequest $request): RedirectResponse
8991
{

app/Http/Requests/Admin/Api/StoreApplicationApiKeyRequest.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ class StoreApplicationApiKeyRequest extends AdminFormRequest
1010
{
1111
/**
1212
* @return array
13+
* @throws \ReflectionException
14+
* @throws \ReflectionException
1315
*/
1416
public function rules()
1517
{

app/Models/EggVariable.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ class EggVariable extends Model implements CleansAttributes, ValidableContract
8282
];
8383

8484
/**
85+
* @param $value
8586
* @return bool
8687
*/
8788
public function getRequiredAttribute($value)

0 commit comments

Comments
 (0)