From f17c3a2778f6c02cef7bdb02437fd77424a3fd1c Mon Sep 17 00:00:00 2001
From: Toby Zerner <toby.zerner@gmail.com>
Date: Tue, 7 Jul 2015 19:20:18 +0930
Subject: [PATCH] Add todos to document magic properties on models

---
 framework/core/src/Api/AccessToken.php                  | 3 +++
 framework/core/src/Core/Activity/Activity.php           | 2 ++
 framework/core/src/Core/Discussions/Discussion.php      | 3 +++
 framework/core/src/Core/Discussions/DiscussionState.php | 2 ++
 framework/core/src/Core/Groups/Group.php                | 3 +++
 framework/core/src/Core/Notifications/Notification.php  | 2 ++
 framework/core/src/Core/Posts/Post.php                  | 3 +++
 framework/core/src/Core/Users/EmailToken.php            | 3 +++
 framework/core/src/Core/Users/PasswordToken.php         | 3 +++
 framework/core/src/Core/Users/User.php                  | 3 +++
 10 files changed, 27 insertions(+)

diff --git a/framework/core/src/Api/AccessToken.php b/framework/core/src/Api/AccessToken.php
index 5f00b1f62..c44ae85fd 100644
--- a/framework/core/src/Api/AccessToken.php
+++ b/framework/core/src/Api/AccessToken.php
@@ -2,6 +2,9 @@
 
 use Flarum\Core\Model;
 
+/**
+ * @todo document database columns with @property
+ */
 class AccessToken extends Model
 {
     /**
diff --git a/framework/core/src/Core/Activity/Activity.php b/framework/core/src/Core/Activity/Activity.php
index bc7d42c12..4048b2f0b 100644
--- a/framework/core/src/Core/Activity/Activity.php
+++ b/framework/core/src/Core/Activity/Activity.php
@@ -14,6 +14,8 @@ use Flarum\Core\Model;
  * in the activity feed, and what *subject* is associated with it. For example,
  * the 'posted' activity type represents that a user made a post. Its subject is
  * a post, of which the ID is stored in the `subject_id` column.
+ *
+ * @todo document database columns with @property
  */
 class Activity extends Model
 {
diff --git a/framework/core/src/Core/Discussions/Discussion.php b/framework/core/src/Core/Discussions/Discussion.php
index e30ee73e7..b05129a3f 100755
--- a/framework/core/src/Core/Discussions/Discussion.php
+++ b/framework/core/src/Core/Discussions/Discussion.php
@@ -14,6 +14,9 @@ use Flarum\Core\Support\Locked;
 use Flarum\Core\Support\VisibleScope;
 use Flarum\Core\Support\ValidatesBeforeSave;
 
+/**
+ * @todo document database columns with @property
+ */
 class Discussion extends Model
 {
     use EventGenerator;
diff --git a/framework/core/src/Core/Discussions/DiscussionState.php b/framework/core/src/Core/Discussions/DiscussionState.php
index e487e8e15..74c651a45 100644
--- a/framework/core/src/Core/Discussions/DiscussionState.php
+++ b/framework/core/src/Core/Discussions/DiscussionState.php
@@ -11,6 +11,8 @@ use Illuminate\Database\Eloquent\Builder;
  * Stores information about how much of a discussion a user has read. Can also
  * be used to store other information, if the appropriate columns are added to
  * the database, like a user's subscription status for a discussion.
+ *
+ * @todo document database columns with @property
  */
 class DiscussionState extends Model
 {
diff --git a/framework/core/src/Core/Groups/Group.php b/framework/core/src/Core/Groups/Group.php
index a4f010f6e..ec505ea9f 100755
--- a/framework/core/src/Core/Groups/Group.php
+++ b/framework/core/src/Core/Groups/Group.php
@@ -2,6 +2,9 @@
 
 use Flarum\Core\Model;
 
+/**
+ * @todo document database columns with @property
+ */
 class Group extends Model
 {
     /**
diff --git a/framework/core/src/Core/Notifications/Notification.php b/framework/core/src/Core/Notifications/Notification.php
index 0990f0bc7..baae5147b 100644
--- a/framework/core/src/Core/Notifications/Notification.php
+++ b/framework/core/src/Core/Notifications/Notification.php
@@ -15,6 +15,8 @@ use Flarum\Core\Model;
  * For example, the 'discussionRenamed' notification type represents that
  * someone renamed a user's discussion. Its subject is a discussion, of which
  * the ID is stored in the `subject_id` column.
+ *
+ * @todo document database columns with @property
  */
 class Notification extends Model
 {
diff --git a/framework/core/src/Core/Posts/Post.php b/framework/core/src/Core/Posts/Post.php
index 64650b459..1fec767b8 100755
--- a/framework/core/src/Core/Posts/Post.php
+++ b/framework/core/src/Core/Posts/Post.php
@@ -8,6 +8,9 @@ use Flarum\Core\Support\EventGenerator;
 use Flarum\Core\Support\ValidatesBeforeSave;
 use Illuminate\Database\Eloquent\Builder;
 
+/**
+ * @todo document database columns with @property
+ */
 class Post extends Model
 {
     use EventGenerator;
diff --git a/framework/core/src/Core/Users/EmailToken.php b/framework/core/src/Core/Users/EmailToken.php
index 020c033e9..be5b57d68 100644
--- a/framework/core/src/Core/Users/EmailToken.php
+++ b/framework/core/src/Core/Users/EmailToken.php
@@ -2,6 +2,9 @@
 
 use Flarum\Core\Model;
 
+/**
+ * @todo document database columns with @property
+ */
 class EmailToken extends Model
 {
     /**
diff --git a/framework/core/src/Core/Users/PasswordToken.php b/framework/core/src/Core/Users/PasswordToken.php
index e9de0687c..354875189 100644
--- a/framework/core/src/Core/Users/PasswordToken.php
+++ b/framework/core/src/Core/Users/PasswordToken.php
@@ -2,6 +2,9 @@
 
 use Flarum\Core\Model;
 
+/**
+ * @todo document database columns with @property
+ */
 class PasswordToken extends Model
 {
     /**
diff --git a/framework/core/src/Core/Users/User.php b/framework/core/src/Core/Users/User.php
index 19a44d76a..fa45ff66a 100755
--- a/framework/core/src/Core/Users/User.php
+++ b/framework/core/src/Core/Users/User.php
@@ -19,6 +19,9 @@ use Flarum\Core\Support\VisibleScope;
 use Flarum\Core\Support\EventGenerator;
 use Flarum\Core\Support\ValidatesBeforeSave;
 
+/**
+ * @todo document database columns with @property
+ */
 class User extends Model
 {
     use EventGenerator;