Browse files

Expanding class documentation for `\data\Entity`.

  • Loading branch information...
1 parent 56c34df commit a93f529ec0758952725526beb07f4f097e22c0e7 @nateabele nateabele committed Jun 23, 2010
Showing with 8 additions and 2 deletions.
  1. +8 −2 libraries/lithium/data/Entity.php
View
10 libraries/lithium/data/Entity.php
@@ -13,8 +13,14 @@
use \lithium\util\Collection as Col;
/**
- * `Entity` class. Represents data such as a row or document in a database. Entities have fields
- * (often known as columns in databases).
+ * `Entity` is a smart data object which represents data such as a row or document in a
+ * database. Entities have fields (often known as columns in databases), and track changes to its
+ * fields, as well as associated validation errors, etc.
+ *
+ * The `Entity` class can also be used as a base class for your own custom data objects, and is the
+ * basis for generating forms with the `Form` helper.
+ *
+ * @see lithium\template\helper\Form
*/
class Entity extends \lithium\core\Object {

0 comments on commit a93f529

Please sign in to comment.