add missing doc comment

EotvosCollegium · Mar 23, 2024 · b32a1f7 · b32a1f7
1 parent 552dcc9
commit b32a1f7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/app/Http/Livewire/ListUsers.php b/app/Http/Livewire/ListUsers.php
@@ -6,6 +6,7 @@
 use App\Models\User;
 use App\Utils\UserFilter;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
 use Livewire\Component;
 use Maatwebsite\Excel\Facades\Excel;
 
@@ -36,7 +37,10 @@ private function createFilteredQuery(): User|Builder
         return $filter->getQuery();
     }
 
-    public function getUsersProperty()
+    /**
+     * @return array|User[]|Collection the users that match the specified filters, so the users that should be listed
+     */
+    public function getUsersProperty(): array|Collection
     {
         return $this->createFilteredQuery()
             ->with(['roles', 'workshops', 'educationalInformation', 'semesterStatuses'])