From 81dfbe4a34faed327b21ab823be29ce3310ea2c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A1bio=20Ferreira?= <fabio.ferreira@noop.pt>
Date: Wed, 22 Jan 2025 13:04:52 +0000
Subject: [PATCH] docs: add PHPDoc annotations for model properties in
 Activity, Page, Project, and User classes

---
 app/Models/Activity.php |  7 +++++++
 app/Models/Page.php     | 10 ++++++++++
 app/Models/Project.php  |  7 +++++++
 app/Models/User.php     | 10 ++++++++++
 4 files changed, 34 insertions(+)

diff --git a/app/Models/Activity.php b/app/Models/Activity.php
index 8658444..719eefe 100644
--- a/app/Models/Activity.php
+++ b/app/Models/Activity.php
@@ -8,6 +8,13 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int $id
+ * @property int $project_id
+ * @property array $events
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
 final class Activity extends Model
 {
     /** @use HasFactory<\Database\Factories\ActivityFactory> */
diff --git a/app/Models/Page.php b/app/Models/Page.php
index c5effc4..4c8fb2a 100644
--- a/app/Models/Page.php
+++ b/app/Models/Page.php
@@ -8,6 +8,16 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property int $id
+ * @property int $project_id
+ * @property string $path
+ * @property \Carbon\Carbon $bucket
+ * @property int $views
+ * @property int $average_time
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
 final class Page extends Model
 {
     /** @use HasFactory<\Database\Factories\PageFactory> */
diff --git a/app/Models/Project.php b/app/Models/Project.php
index 766935d..49dbb25 100644
--- a/app/Models/Project.php
+++ b/app/Models/Project.php
@@ -10,6 +10,13 @@
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
+/**
+ * @property int $id
+ * @property int $user_id
+ * @property string $name
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
 final class Project extends Model
 {
     /** @use HasFactory<ProjectFactory> */
diff --git a/app/Models/User.php b/app/Models/User.php
index bd752fd..9f97da5 100644
--- a/app/Models/User.php
+++ b/app/Models/User.php
@@ -10,6 +10,16 @@
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
 
+/**
+ * @property int $id
+ * @property string $name
+ * @property string $email
+ * @property \Carbon\Carbon|null $email_verified_at
+ * @property string $password
+ * @property string|null $remember_token
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ */
 final class User extends Authenticatable
 {
     /** @use HasFactory<\Database\Factories\UserFactory> */