Updated documentation of com.woltlab.wcf.notification
authorMatthias Schmidt <gravatronics@live.com>
Wed, 20 Jul 2011 11:45:44 +0000 (13:45 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Wed, 20 Jul 2011 11:45:44 +0000 (13:45 +0200)
I mainly added namespaces, fixed the class which defines $baseClass in E
ditors (DatabaseObjectDecorator instead of DatabaseObjectEditor like Mar
cel Werk did in commit '54c3136aec39da95e1913276ed4548e5d0f28aed') and c
orrected the class which defines $tableName in PIPs (AbstractPackageInst
allationPlugin instead of AbstractXMLPackageInstallationPlugin, see comm
it 'b5be6fb094b1ea2fb5cd741f758720f010f0eada') for the com.woltlab.wcf.n
otification package.

19 files changed:
com.woltlab.wcf.notification/files/lib/data/user/notification/UserNotification.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/UserNotificationAction.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/UserNotificationEditor.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/UserNotificationList.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/event/UserNotificationEvent.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/event/UserNotificationEventAction.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/event/UserNotificationEventEditor.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/event/UserNotificationEventList.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/object/type/UserNotificationObjectType.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/object/type/UserNotificationObjectTypeAction.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/object/type/UserNotificationObjectTypeEditor.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/object/type/UserNotificationObjectTypeList.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/type/UserNotificationType.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/type/UserNotificationTypeAction.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/type/UserNotificationTypeEditor.class.php
com.woltlab.wcf.notification/files/lib/data/user/notification/type/UserNotificationTypeList.class.php
com.woltlab.wcf.notification/files/lib/system/package/plugin/UserNotificationEventPackageInstallationPlugin.class.php
com.woltlab.wcf.notification/files/lib/system/package/plugin/UserNotificationObjectTypePackageInstallationPlugin.class.php
com.woltlab.wcf.notification/files/lib/system/package/plugin/UserNotificationTypePackageInstallationPlugin.class.php

index 5d656a06a1967b97f67994aa37330fb527c8e938..0b4fcc048862b77a8792277d3832e2eb8cb9d044 100644 (file)
@@ -14,12 +14,12 @@ use wcf\data\DatabaseObject;
  */
 class UserNotification extends DatabaseObject {
        /**
-        * @see DatabaseObject::$databaseTableName
+        * @see wcf\data\DatabaseObject::$databaseTableName
         */
        protected static $databaseTableName = 'user_notification';
        
        /**
-        * @see DatabaseObject::$databaseTableIndexName
+        * @see wcf\data\DatabaseObject::$databaseTableIndexName
         */
        protected static $databaseTableIndexName = 'notificationID';
 }
index 6ff75579a92031e3d76bc2a2ecc5a520f5399b86..e335d70212d8026c9156a30ecbc70d3f2263ba8a 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\AbstractDatabaseObjectAction;
  */
 class UserNotificationAction extends AbstractDatabaseObjectAction {
        /**
-        * @see AbstractDatabaseObjectAction::$className
+        * @see wcf\data\AbstractDatabaseObjectAction::$className
         */
        protected $className = 'wcf\data\user\notification\UserNotificationEditor';
 }
index 56aa391ade3cf077955a2b2898594b5305709752..a83c59659d425c124bff6d3b9fbd231273e64247 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectEditor;
  */
 class UserNotificationEditor extends DatabaseObjectEditor {
        /**
-        * @see DatabaseObjectEditor::$baseClass
+        * @see wcf\data\DatabaseObjectDecorator::$baseClass
         */
        protected static $baseClass = 'wcf\data\user\notification\UserNotification';
 }
index 51ad2876806229926956320d247585ece86179b3..8a60cf14581f026334fba5fca45906a1b692696d 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectList;
  */
 class UserNotificationList extends DatabaseObjectList {
        /**
-        * @see DatabaseObjectList::$className
+        * @see wcf\data\DatabaseObjectList::$className
         */
        public $className = 'wcf\data\user\notification\UserNotification';
 }
index 1def755af5f9a45aaa6391f2e777b63d205b4d50..a7db3c2ca096338a3d14f08bc3385f70ddfe7893 100644 (file)
@@ -14,12 +14,12 @@ use wcf\data\DatabaseObject;
  */
 class UserNotificationEvent extends DatabaseObject {
        /**
-        * @see DatabaseObject::$databaseTableName
+        * @see wcf\data\DatabaseObject::$databaseTableName
         */
        protected static $databaseTableName = 'user_notification_event';
        
        /**
-        * @see DatabaseObject::$databaseTableIndexName
+        * @see wcf\data\DatabaseObject::$databaseTableIndexName
         */
        protected static $databaseTableIndexName = 'eventID';
 }
index 3f82a7c69bcb4611b4ae472472bc4ad83ffc84cc..9321c2c3dd6e6dfc680c093b791fdcd8f1f3ddcd 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\AbstractDatabaseObjectAction;
  */
 class UserNotificationEventAction extends AbstractDatabaseObjectAction {
        /**
-        * @see AbstractDatabaseObjectAction::$className
+        * @see wcf\data\AbstractDatabaseObjectAction::$className
         */
        protected $className = 'wcf\data\user\notification\event\UserNotificationEventEditor';
 }
index 071e0d16a1ad4c445c8b387ff9ddc138ea242494..8f51549a34cdbe476d7679276e50057c3aae4209 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectEditor;
  */
 class UserNotificationEventEditor extends DatabaseObjectEditor {
        /**
-        * @see DatabaseObjectEditor::$baseClass
+        * @see wcf\data\DatabaseObjectDecorator::$baseClass
         */
        protected static $baseClass = 'wcf\data\user\notification\event\UserNotificationEvent';
 }
index 121b1f236625e987cd3fee81dc55f81796548d0d..f55a438d9bb631f3e3a78923199e879ef60c6253 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectList;
  */
 class UserNotificationEventList extends DatabaseObjectList {
        /**
-        * @see DatabaseObjectList::$className
+        * @see wcf\data\DatabaseObjectList::$className
         */
        public $className = 'wcf\data\user\notification\event\UserNotificationEvent';
 }
index 53285f64fd792733e1f35b9e530b47321bee6931..24e5ccd7c5908ee74c7f5fa006a108966d77a94e 100644 (file)
@@ -14,12 +14,12 @@ use wcf\data\DatabaseObject;
  */
 class UserNotificationObjectType extends DatabaseObject {
        /**
-        * @see DatabaseObject::$databaseTableName
+        * @see wcf\data\DatabaseObject::$databaseTableName
         */
        protected static $databaseTableName = 'user_notification_object_type';
        
        /**
-        * @see DatabaseObject::$databaseTableIndexName
+        * @see wcf\data\DatabaseObject::$databaseTableIndexName
         */
        protected static $databaseTableIndexName = 'objectTypeID';
 }
index e093d09ef4417f2968369e77e32f763bfb5fa78d..0e7eea028273565796fe8176c36ab6cb8dc6ba19 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\AbstractDatabaseObjectAction;
  */
 class UserNotificationObjectTypeAction extends AbstractDatabaseObjectAction {
        /**
-        * @see AbstractDatabaseObjectAction::$className
+        * @see wcf\data\AbstractDatabaseObjectAction::$className
         */
        protected $className = 'wcf\data\user\notification\object\type\UserNotificationObjectTypeEditor';
 }
index aef0718da2c1123a8c1bcf9fa79b4e4377517227..8247834740ad3a9c6aac93209aa61b6d06751d63 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectEditor;
  */
 class UserNotificationObjectTypeEditor extends DatabaseObjectEditor {
        /**
-        * @see DatabaseObjectEditor::$baseClass
+        * @see wcf\data\DatabaseObjectDecorator::$baseClass
         */
        protected static $baseClass = 'wcf\data\user\notification\object\type\UserNotificationObjectType';
 }
index 938a19efae0a098749863b57da001f165e84efaf..0bd0b484e1fecd5ccb229f933ce31048a4fd852b 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectList;
  */
 class UserNotificationObjectTypeList extends DatabaseObjectList {
        /**
-        * @see DatabaseObjectList::$className
+        * @see wcf\data\DatabaseObjectList::$className
         */
        public $className = 'wcf\data\user\notification\object\type\UserNotificationObjectType';
 }
index 44ee455823b8e14783c9ec45e3f5b5913e6c1ab6..6a26aaf63cd97f1c3ba8b51e4bf8d7e944d57832 100644 (file)
@@ -14,12 +14,12 @@ use wcf\data\DatabaseObject;
  */
 class UserNotificationType extends DatabaseObject {
        /**
-        * @see DatabaseObject::$databaseTableName
+        * @see wcf\data\DatabaseObject::$databaseTableName
         */
        protected static $databaseTableName = 'user_notification_type';
        
        /**
-        * @see DatabaseObject::$databaseTableIndexName
+        * @see wcf\data\DatabaseObject::$databaseTableIndexName
         */
        protected static $databaseTableIndexName = 'notificationTypeID';
 }
index e115b3c8575819ebceb04e47b52a3a012cba104a..69ef7bae63b4eb85690691941cda73db4a586d1d 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\AbstractDatabaseObjectAction;
  */
 class UserNotificationTypeAction extends AbstractDatabaseObjectAction {
        /**
-        * @see AbstractDatabaseObjectAction::$className
+        * @see wcf\data\AbstractDatabaseObjectAction::$className
         */
        protected $className = 'wcf\data\user\notification\type\UserNotificationTypeEditor';
 }
index da9f8e43eae29e0c00cfcae298351c63a88c5ed3..1794dec311b9befac8d0acd4cfc96a2a8b3c75a7 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectEditor;
  */
 class UserNotificationTypeEditor extends DatabaseObjectEditor {
        /**
-        * @see DatabaseObjectEditor::$baseClass
+        * @see wcf\data\DatabaseObjectDecorator::$baseClass
         */
        protected static $baseClass = 'wcf\data\user\notification\type\UserNotificationType';
 }
index c181f35164939b05d1030bd243b9600dc7019b5b..8e83df0ef236305932f9b23d4d4fefe164a20982 100644 (file)
@@ -14,7 +14,7 @@ use wcf\data\DatabaseObjectList;
  */
 class UserNotificationTypeList extends DatabaseObjectList {
        /**
-        * @see DatabaseObjectList::$className
+        * @see wcf\data\DatabaseObjectList::$className
         */
        public $className = 'wcf\data\user\notification\type\UserNotificationType';
 }
index 1e1eb18d85c6d0482fef89ca513e7c76c09f7e13..9b403e23d37b778165b85e28a9b9f485caceae83 100644 (file)
@@ -14,17 +14,17 @@ use wcf\system\WCF;
  */
 class UserNotificationEventPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin {
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$className
+        * @see wcf\system\package\plugin\AbstractXMLPackageInstallationPlugin::$className
         */
        public $className = 'wcf\data\user\notification\event\UserNotificationEventEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see wcf\system\package\plugin\AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'user_notification_event';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tagName
+        * @see wcf\system\package\plugin\AbstractXMLPackageInstallationPlugin::$tagName
         */     
        public $tagName = 'event';
        
index 9a0e3d69b939be9d60fd1b4d994b4919328ab7b9..b6d1dc62389b9953008b34ce8420423326193662 100644 (file)
@@ -14,17 +14,17 @@ use wcf\system\WCF;
  */
 class UserNotificationObjectTypePackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin {
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$className
+        * @see wcf\system\package\plugin\AbstractXMLPackageInstallationPlugin::$className
         */
        public $className = 'wcf\data\user\notification\object\type\UserNotificationObjectTypeEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see wcf\system\package\plugin\AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'user_notification_object_type';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tagName
+        * @see wcf\system\package\plugin\AbstractXMLPackageInstallationPlugin::$tagName
         */     
        public $tagName = 'objecttype';
        
index a9d32f1114be1eefd61db22af3916e8c9a260d63..d875f30957bdb9c7552a558873e058d9e499502d 100644 (file)
@@ -14,17 +14,17 @@ use wcf\system\WCF;
  */
 class UserNotificationTypePackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin {
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$className
+        * @see wcf\system\package\plugin\AbstractXMLPackageInstallationPlugin::$className
         */
        public $className = 'wcf\data\user\notification\type\UserNotificationTypeEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see wcf\system\package\plugin\AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'user_notification_type';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tagName
+        * @see wcf\system\package\plugin\AbstractXMLPackageInstallationPlugin::$tagName
         */     
        public $tagName = 'notificationtype';