Standardized code in all of core, not including language files, tests, or core mods.

git-svn-id: http://code.elgg.org/elgg/trunk@7124 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 56 insertions, 7 deletions

diff --git a/engine/classes/ODDEntity.php b/engine/classes/ODDEntity.php
index 727c96733..acdfe2f71 100644
--- a/engine/classes/ODDEntity.php
+++ b/engine/classes/ODDEntity.php
@@ -2,10 +2,19 @@
 
 /**
  * ODD Entity class.
- * @package Elgg
- * @subpackage Core
+ *
+ * @package    Elgg.Core
+ * @subpackage ODD
  */
 class ODDEntity extends ODD {
+
+	/**
+	 * New ODD Entity
+	 *
+	 * @param string $uuid     A universally unique ID
+	 * @param string $class    Class
+	 * @param string $subclass Subclass
+	 */
 	function __construct($uuid, $class, $subclass = "") {
 		parent::__construct();
 
@@ -14,15 +23,34 @@ class ODDEntity extends ODD {
 		$this->setAttribute('subclass', $subclass);
 	}
 
-	protected function getTagName() { return "entity"; }
+	/**
+	 * Returns entity.
+	 *
+	 * @return 'entity'
+	 */
+	protected function getTagName() {
+		return "entity";
+	}
 }
 
 /**
  * ODD Metadata class.
- * @package Elgg
- * @subpackage Core
+ *
+ * @package    Elgg.Core
+ * @subpackage ODD
  */
 class ODDMetaData extends ODD {
+
+	/**
+	 * New ODD metadata
+	 *
+	 * @param unknown_type $uuid        Unique ID
+	 * @param unknown_type $entity_uuid Another unique ID
+	 * @param unknown_type $name        Name
+	 * @param unknown_type $value       Value
+	 * @param unknown_type $type        Type
+	 * @param unknown_type $owner_uuid  Owner ID
+	 */
 	function __construct($uuid, $entity_uuid, $name, $value, $type = "", $owner_uuid = "") {
 		parent::__construct();
 
@@ -34,6 +62,11 @@ class ODDMetaData extends ODD {
 		$this->setBody($value);
 	}
 
+	/**
+	 * Returns 'metadata'
+	 *
+	 * @return 'metadata'
+	 */
 	protected function getTagName() {
 		return "metadata";
 	}
@@ -41,10 +74,19 @@ class ODDMetaData extends ODD {
 
 /**
  * ODD Relationship class.
- * @package Elgg
+ *
+ * @package    Elgg
  * @subpackage Core
  */
 class ODDRelationship extends ODD {
+
+	/**
+	 * New ODD Relationship
+	 *
+	 * @param unknown_type $uuid1 First UUID
+	 * @param unknown_type $type  Type of telationship
+	 * @param unknown_type $uuid2 Second UUId
+	 */
 	function __construct($uuid1, $type, $uuid2) {
 		parent::__construct();
 
@@ -53,5 +95,12 @@ class ODDRelationship extends ODD {
 		$this->setAttribute('uuid2', $uuid2);
 	}
 
-	protected function getTagName() { return "relationship"; }
+	/**
+	 * Returns 'relationship'
+	 *
+	 * @return 'relationship'
+	 */
+	protected function getTagName() {
+		return "relationship";
+	}
 }
\ No newline at end of file