update: model phpdocs

- `use` the relation types
- Use sentence case
- Write better summaries similar to laravel's documentation (don't just repeat the type and the model)
This commit is contained in:
Roardom
2025-09-13 04:38:03 +00:00
parent b11d41269b
commit 3988eaaf70
108 changed files with 1509 additions and 1190 deletions
+4 -3
View File
@@ -19,6 +19,7 @@ namespace App\Models;
use App\Traits\Auditable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
/**
* App\Models\Option.
@@ -47,11 +48,11 @@ class Option extends Model
];
/**
* Belongs To A Poll.
* Get the poll that owns the option.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<Poll, $this>
* @return BelongsTo<Poll, $this>
*/
public function poll(): \Illuminate\Database\Eloquent\Relations\BelongsTo
public function poll(): BelongsTo
{
return $this->belongsTo(Poll::class);
}