Updates documentations of two object interfaces
authorMatthias Schmidt <gravatronics@live.com>
Wed, 7 Sep 2011 08:32:51 +0000 (10:32 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Wed, 7 Sep 2011 08:32:51 +0000 (10:32 +0200)
wcfsetup/install/files/lib/data/IEditableObject.class.php
wcfsetup/install/files/lib/data/IStorableObject.class.php

index bb61b47ac5f64ca5f8818945ba028e9ed6115f6b..6a978085c58404fda1bd8f13a3f9e03df6cb266c 100644 (file)
@@ -33,7 +33,8 @@ interface IEditableObject extends IStorableObject {
        public function delete();
        
        /**
-        * Deletes all given objects.
+        * Deletes all the objects with the given ids and returns the number of
+        * deleted objects.
         * 
         * @param       array           $objectIDs
         * @return      integer
index a052b2a350d7f780ba7cbb3d2f160e6fc1d65247..5137e63b7c44839fce5731924776790a21b5cdd7 100644 (file)
@@ -13,7 +13,7 @@ namespace wcf\data;
  */
 interface IStorableObject {
        /**
-        * Returns the value of a variable in object data.
+        * Returns the value of a object data variable.
         * 
         * @param       string          $name           variable name
         * @return      mixed           value
@@ -31,7 +31,7 @@ interface IStorableObject {
        /**
         * Returns the name of the database table.
         * 
-        * @return string
+        * @return      string
         */
        public static function getDatabaseTableName();
        
@@ -52,7 +52,7 @@ interface IStorableObject {
        /**
         * Returns the name of the database table index.
         * 
-        * @return string
+        * @return      string
         */
        public static function getDatabaseTableIndexName();
 }