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
+10 -9
View File
@@ -18,6 +18,7 @@ namespace App\Models;
use App\Traits\Auditable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class AutomaticTorrentFreeleech extends Model
{
@@ -26,31 +27,31 @@ class AutomaticTorrentFreeleech extends Model
protected $guarded = [];
/**
* Belongs To A Category.
* Get the category that owns automatic torrent freeleech.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<Category, $this>
* @return BelongsTo<Category, $this>
*/
public function category(): \Illuminate\Database\Eloquent\Relations\BelongsTo
public function category(): BelongsTo
{
return $this->belongsTo(Category::class);
}
/**
* Belongs To A Type.
* Get the type that owns automatic torrent freeleech.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<Type, $this>
* @return BelongsTo<Type, $this>
*/
public function type(): \Illuminate\Database\Eloquent\Relations\BelongsTo
public function type(): BelongsTo
{
return $this->belongsTo(Type::class);
}
/**
* Belongs To A Resolution.
* Get the resolution that owns automatic torrent freeleech.
*
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo<Resolution, $this>
* @return BelongsTo<Resolution, $this>
*/
public function resolution(): \Illuminate\Database\Eloquent\Relations\BelongsTo
public function resolution(): BelongsTo
{
return $this->belongsTo(Resolution::class);
}