Adds documentation for wcf\data\IDatabaseObjectProcessor

diff --git a/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php b/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php
index a08d833e959437aaac108f5497554f07e91ef2c5..f3a04bd7990fce24f6cc20469811b89d3409f86f 100644 (file)
--- a/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php
+++ b/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php
@@ -1,9 +1,48 @@
 <?php
 namespace wcf\data;
 
+/**
+ * Default interface for DatabaseObject processors.
+ *
+ * @author     Marcel Werk
+ * @copyright  2001-2011 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage data
+ * @category   Community Framework
+ */
 interface IDatabaseObjectProcessor {
+       /**
+        * Creates a new instance of a database object processor.
+        * 
+        * @param       wcf\data\DatabaseObject         $object
+        */
        public function __construct(DatabaseObject $object);
+       
+       /**
+        * Delegates property accesses to the processed object if the processor
+        * object has no such property.
+        *   
+        * @param       string          $name
+        * @return      mixed
+        */
        public function __get($name);
+       
+       /**
+        * Delegates isset calls for object properties to the processed object if
+        * the processor object has no such property.
+        * 
+        * @param       string          $name
+        * @return      boolean
+        */
        public function __isset($name);
+       
+       /**
+        * Delegates inaccessible methods calls to the processed database object.
+        *  
+        * @param       string          $name
+        * @param       array           $arguments
+        * @return      mixed
+        */
        public function __call($name, $arguments);
 }