From: Matthias Schmidt <gravatronics@live.com>
Date: Thu, 22 Sep 2011 10:54:46 +0000 (+0200)
Subject: Updates documentation of DatabaseObject and ProcessibleDatabaseObject
X-Git-Tag: 2.0.0_Beta_1~1780^2~1
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=05e544c6d1103742c34edf39e1513f07adddb9e0;p=GitHub%2FWoltLab%2FWCF.git

Updates documentation of DatabaseObject and ProcessibleDatabaseObject
---

diff --git a/wcfsetup/install/files/lib/data/DatabaseObject.class.php b/wcfsetup/install/files/lib/data/DatabaseObject.class.php
index ddfa28255e..bac9d2843e 100644
--- a/wcfsetup/install/files/lib/data/DatabaseObject.class.php
+++ b/wcfsetup/install/files/lib/data/DatabaseObject.class.php
@@ -15,47 +15,46 @@ use wcf\system\WCF;
 abstract class DatabaseObject implements IStorableObject {
 	/**
 	 * database table for this object
-	 * @var string
+	 * @var	string
 	 */
 	protected static $databaseTableName = '';
 	
 	/**
 	 * indicates if database table index is an identity column
-	 * @var boolean 
+	 * @var	boolean 
 	 */	
 	protected static $databaseTableIndexIsIdentity = true;
 	
 	/**
 	 * name of the primary index column
-	 * @var string
+	 * @var	string
 	 */
 	protected static $databaseTableIndexName = '';
 	
 	/**
 	 * sort field
-	 * @var mixed
+	 * @var	mixed
 	 */
 	protected static $sortBy = null;
 	
 	/**
 	 * sort order
-	 * @var mixed
+	 * @var	mixed
 	 */
 	protected static $sortOrder = null;
 	
 	/**
 	 * object data
-	 * @var array
+	 * @var	array
 	 */
 	protected $data = null;
 	
 	/**
 	 * Creates a new instance of the DatabaseObject class.
-	 * Stores object data.
 	 *  
-	 * @param	mixed			$id
-	 * @param	array			$row
-	 * @param	DatabaseObject		$object
+	 * @param	mixed				$id
+	 * @param	array				$row
+	 * @param	wcf\data\DatabaseObject		$object
 	 */
 	public function __construct($id, array $row = null, DatabaseObject $object = null) {
 		if ($id !== null) {
@@ -91,7 +90,7 @@ abstract class DatabaseObject implements IStorableObject {
 	}
 
 	/**
-	 * @see wcf\data\IStorableObject::__get()
+	 * @see	wcf\data\IStorableObject::__get()
 	 */
 	public function __get($name) {
 		if (isset($this->data[$name])) {
@@ -103,14 +102,14 @@ abstract class DatabaseObject implements IStorableObject {
 	}
 	
 	/**
-	 * @see wcf\data\IStorableObject::__isset()
+	 * @see	wcf\data\IStorableObject::__isset()
 	 */
 	public function __isset($name) {
 		return isset($this->data[$name]);
 	}
 	
 	/**
-	 * @see wcf\data\IStorableObject::getDatabaseTableName()
+	 * @see	wcf\data\IStorableObject::getDatabaseTableName()
 	 */
 	public static function getDatabaseTableName() {
 		return 'wcf'.WCF_N.'_'.static::$databaseTableName;
@@ -131,7 +130,7 @@ abstract class DatabaseObject implements IStorableObject {
 	}
 	
 	/**
-	 * @see wcf\data\IStorableObject::getDatabaseTableIndexName()
+	 * @see	wcf\data\IStorableObject::getDatabaseTableIndexName()
 	 */
 	public static function getDatabaseTableIndexName() {
 		return static::$databaseTableIndexName;
@@ -140,9 +139,9 @@ abstract class DatabaseObject implements IStorableObject {
 	/**
 	 * Sorts a list of database objects.
 	 *
-	 * @param	array<DatabaseObject>	$objects
-	 * @param	mixed			$sortBy
-	 * @param	string			$sortOrder
+	 * @param	array<wcf\data\DatabaseObject>	$objects
+	 * @param	mixed				$sortBy
+	 * @param	string				$sortOrder
 	 * @return	boolean
 	 */
 	public static function sort(&$objects, $sortBy, $sortOrder = 'ASC', $maintainIndexAssociation = true) {
@@ -160,8 +159,8 @@ abstract class DatabaseObject implements IStorableObject {
 	/**
 	 * Compares to database objects.
 	 *
-	 * @param	DatabaseObject		$objectA
-	 * @param	DatabaseObject		$objectB
+	 * @param	wcf\data\DatabaseObject		$objectA
+	 * @param	wcf\data\DatabaseObject		$objectB
 	 * @return	float
 	 */
 	protected static function compareObjects($objectA, $objectB) {
diff --git a/wcfsetup/install/files/lib/data/ProcessibleDatabaseObject.class.php b/wcfsetup/install/files/lib/data/ProcessibleDatabaseObject.class.php
index 9f6ceb9556..823a0c337f 100644
--- a/wcfsetup/install/files/lib/data/ProcessibleDatabaseObject.class.php
+++ b/wcfsetup/install/files/lib/data/ProcessibleDatabaseObject.class.php
@@ -16,20 +16,20 @@ use wcf\util\ClassUtil;
 class ProcessibleDatabaseObject extends DatabaseObject {
 	/**
 	 * name of the interface the processor of this database object should implement
-	 * @var string
+	 * @var	string
 	 */
 	protected static $processorInterface = '';
 	
 	/**
 	 * processor this database object
-	 * @var wcf\data\IDatabaseObjectProcessor
+	 * @var	wcf\data\IDatabaseObjectProcessor
 	 */
 	protected $processor = null;
 	
 	/**
 	 * Returns the processor this database object.
 	 * 
-	 * @return wcf\data\IDatabaseObjectProcessor
+	 * @return	wcf\data\IDatabaseObjectProcessor
 	 */
 	public function getProcessor() {
 		if ($this->processor === null) {