From 4028f90e0515d1a4b86ebc07d48e64f107a5a5d2 Mon Sep 17 00:00:00 2001
From: ben <ben@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Thu, 12 Jun 2008 12:11:26 +0000
Subject: Some extra entity documentation

git-svn-id: https://code.elgg.org/elgg/trunk@883 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/lib/entities.php | 39 ++++++++++++++++-----------------------
 1 file changed, 16 insertions(+), 23 deletions(-)

(limited to 'engine/lib')

diff --git a/engine/lib/entities.php b/engine/lib/entities.php
index 7735b651b..998b996de 100644
--- a/engine/lib/entities.php
+++ b/engine/lib/entities.php
@@ -335,26 +335,23 @@
 		}
 		
 		/**
-		 * Enter description here...
+		 * Obtain this entity's access ID
 		 *
-		 * @return unknown
-		 * @todo document me
+		 * @return int The access ID
 		 */
 		public function getAccessID() { return $this->get('access_id'); }
 		
 		/**
-		 * Enter description here...
+		 * Obtain this entity's GUID
 		 *
-		 * @return unknown
-		 * @todo document me
+		 * @return int GUID
 		 */
 		public function getGUID() { return $this->get('guid'); }
 		
 		/**
-		 * Enter description here...
+		 * Get the owner of this entity
 		 *
-		 * @return unknown
-		 * @todo document me
+		 * @return int The owner GUID
 		 */
 		public function getOwner() { return $this->get('owner_guid'); }
 		
@@ -366,34 +363,30 @@
 		public function getOwnerEntity() { return get_entity($this->get('owner_guid')); }
 		
 		/**
-		 * Enter description here...
+		 * Gets the type of entity this is
 		 *
-		 * @return unknown
-		 * @todo document me
+		 * @return string Entity type
 		 */
 		public function getType() { return $this->get('type'); }
 		
 		/**
-		 * Enter description here...
+		 * Returns the subtype of this entity
 		 *
-		 * @return unknown
-		 * @todo document me
+		 * @return string The entity subtype
 		 */
 		public function getSubtype() { return get_subtype_from_id($this->get('subtype')); }
 		
 		/**
-		 * Enter description here...
+		 * Gets the UNIX epoch time that this entity was created
 		 *
-		 * @return unknown
-		 * @todo document me
+		 * @return int UNIX epoch time
 		 */
 		public function getTimeCreated() { return $this->get('time_created'); }
 		
-		/**
-		 * Enter description here...
-		 *
-		 * @return unknown
-		 * @todo document me
+		/**
+		 * Gets the UNIX epoch time that this entity was last updated
+		 *
+		 * @return int UNIX epoch time
 		 */
 		public function getTimeUpdated() { return $this->get('time_updated'); }
 		
-- 
cgit v1.2.3