From 7a2ae99931f3ecbcfbdb740c96149e41212a2a31 Mon Sep 17 00:00:00 2001
From: misja <misja@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Tue, 8 Apr 2008 14:36:39 +0000
Subject: Misja Hoebe <misja@curverider.co.uk> Fixing doctags

git-svn-id: https://code.elgg.org/elgg/trunk@420 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/lib/annotations.php | 30 ++++++++++++++++++++++++++++--
 engine/lib/sites.php       | 18 +++++++++++++++++-
 engine/lib/users.php       | 26 ++++++++++++++++++++++----
 3 files changed, 67 insertions(+), 7 deletions(-)

(limited to 'engine/lib')

diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index dc37cb665..f37e22154 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -11,11 +11,19 @@
 	 * @link http://elgg.org/
 	 */
 
-	require_once('extender.php'); // include the superclass
+    /**
+     * Include the ElggExtender superclass
+     * 
+     */
+	require_once('extender.php');
 
 	/**
-	 * @class ElggAnnotation
+	 * ElggAnnotation
+	 * 
 	 * An annotation is similar to metadata each entity can contain more than one of each annotation.
+	 * 
+	 * @package Elgg
+	 * @subpackage Core
 	 * @author Marcus Povey <marcus@dushka.co.uk>
 	 */
 	class ElggAnnotation extends ElggExtender
@@ -46,14 +54,32 @@
 			}
 		}
 		
+		/**
+		 * Class variable getter overloading
+		 *
+		 * @param string $name
+		 * @return mixed
+		 */
 		function __get($name) {
 			return $this->get($name);
 		}
 		
+		/**
+		 * Class variable setter overloading
+		 *
+		 * @param string $name
+		 * @param mixed $value
+		 * @return void
+		 */
 		function __set($name, $value) {
 			return $this->set($name, $value);
 		}		
 		
+		/**
+		 * Save this instance
+		 *
+		 * @return int an object id
+		 */
 		function save()
 		{
 			if ($this->id > 0)
diff --git a/engine/lib/sites.php b/engine/lib/sites.php
index 9f296fc51..fa49d26fc 100644
--- a/engine/lib/sites.php
+++ b/engine/lib/sites.php
@@ -13,9 +13,11 @@
 	 */
 
 	/**
-	 * @class ElggSite
+	 * ElggSite
 	 * Representation of a "site" in the system.
 	 * @author Marcus Povey <marcus@dushka.co.uk>
+	 * @package Elgg
+	 * @subpackage Core
 	 */
 	class ElggSite extends ElggEntity
 	{
@@ -82,7 +84,21 @@
 			}
 		}
 		
+		/**
+		 * Class variable getter overloading
+		 *
+		 * @param string $name
+		 * @return mixed
+		 */
 		function __get($name) { return $this->get($name); }
+		
+		/**
+		 * Class variable setter overloading
+		 *
+		 * @param string $name
+		 * @param mixed $value
+		 * @return mixed
+		 */
 		function __set($name, $value) { return $this->set($name, $value); }
 		
 		/**
diff --git a/engine/lib/users.php b/engine/lib/users.php
index 2447ea93c..2b4f89704 100644
--- a/engine/lib/users.php
+++ b/engine/lib/users.php
@@ -13,8 +13,12 @@
 	 */
 
 	/**
-	 * @class ElggUser
-	 * Representation of a "user" in the system.
+	 * ElggUser
+	 * 
+	 * Representation of a "user" in the system.
+	 * 
+	 * @package Elgg
+	 * @subpackage Core
 	 */
 	class ElggUser extends ElggEntity
 	{
@@ -84,8 +88,22 @@
 				}
 			}
 		}
-		
-		function __get($name) { return $this->get($name); }
+		
+		/**
+		 * Class variable getter overloading
+		 *
+		 * @param string $name
+		 * @return mixed
+		 */
+		function __get($name) { return $this->get($name); }
+		
+		/**
+		 * Class variable setter overloading
+		 *
+		 * @param string $name
+		 * @param mixed $value
+		 * @return mixed
+		 */
 		function __set($name, $value) { return $this->set($name, $value); }
 		
 		/**
-- 
cgit v1.2.3