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
+8 -7
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\HasMany;
/**
* App\Models\Resolution.
@@ -35,7 +36,7 @@ class Resolution extends Model
use HasFactory;
/**
* Indicates If The Model Should Be Timestamped.
* Indicates if the model should be timestamped.
*
* @var bool
*/
@@ -49,21 +50,21 @@ class Resolution extends Model
protected $guarded = ['id', 'created_at', 'updated_at'];
/**
* Has Many Torrents.
* Get all torrents for the resolution.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany<Torrent, $this>
* @return HasMany<Torrent, $this>
*/
public function torrents(): \Illuminate\Database\Eloquent\Relations\HasMany
public function torrents(): HasMany
{
return $this->hasMany(Torrent::class);
}
/**
* Has Many Torrent Requests.
* Get all requests for the resolution.
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany<TorrentRequest, $this>
* @return HasMany<TorrentRequest, $this>
*/
public function requests(): \Illuminate\Database\Eloquent\Relations\HasMany
public function requests(): HasMany
{
return $this->hasMany(TorrentRequest::class);
}