Add more documentation tags
authorMatthias Schmidt <gravatronics@live.com>
Thu, 26 May 2016 11:56:59 +0000 (13:56 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Thu, 26 May 2016 11:56:59 +0000 (13:56 +0200)
wcfsetup/install/files/lib/data/user/online/UserOnline.class.php
wcfsetup/install/files/lib/system/label/object/AbstractLabelObjectHandler.class.php
wcfsetup/install/files/lib/system/session/SessionHandler.class.php
wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php

index 033a3ea369cb00410f4bd61ea47cc1bce63c8499..a83c3382a17406bff1c8d320a01502d676267975 100644 (file)
@@ -19,6 +19,10 @@ use wcf\util\UserUtil;
  * @package    com.woltlab.wcf
  * @subpackage data.user.online
  * @category   Community Framework
+ *
+ * @property-read      integer|null    $pageID
+ * @property-read      integer|null    $pageObjectID
+ * @property-read      integer|null    $parentPageObjectID
  */
 class UserOnline extends UserProfile {
        /**
index 242757576031f5e7d6a9d98333926d1a2f7459ca..ef6db8d214a0d6e682692f112d3089f7c7448ff1 100644 (file)
@@ -57,6 +57,7 @@ abstract class AbstractLabelObjectHandler extends SingletonFactory implements IL
        
        /**
         * @inheritDoc
+        * @return      ViewableLabelGroup[]
         */
        public function getLabelGroups(array $parameters = []) {
                $groupIDs = $this->getLabelGroupIDs($parameters);
index 1cf6e0a02722d151a4cd13e8abc52e9ea55b21ae..b14da1a4baa75e6db6ca06fbe611486fd4b1cb04 100644 (file)
@@ -35,6 +35,21 @@ use wcf\util\UserUtil;
  * @package    com.woltlab.wcf
  * @subpackage system.session
  * @category   Community Framework
+ * 
+ * @property-read      string          $sessionID
+ * @property-read      integer|null    $userID
+ * @property-read      string          $ipAddress
+ * @property-read      string          $userAgent
+ * @property-read      integer         $lastActivityTime
+ * @property-read      string          $requestURI
+ * @property-read      string          $requestMethod
+ * @property-read      string          $controller
+ * @property-read      string          $parentObjectType
+ * @property-read      integer         $parentObjectID
+ * @property-read      string          $objectType
+ * @property-read      integer         $objectID
+ * @property-read      string          $sessionVariables
+ * @property-read      string          $spiderID
  */
 class SessionHandler extends SingletonFactory {
        /**
index 54ba0bffda84def9d5f0af36e3972225028677f1..c34a0cc294d521618212f02e9666dcbdb35d6c54 100644 (file)
@@ -16,6 +16,8 @@ use wcf\system\user\notification\object\IUserNotificationObject;
  * @package    com.woltlab.wcf
  * @subpackage system.user.notification.event
  * @category   Community Framework
+ * 
+ * @mixin      UserNotificationEvent
  */
 interface IUserNotificationEvent extends IDatabaseObjectProcessor {
        /**
@@ -99,10 +101,10 @@ interface IUserNotificationEvent extends IDatabaseObjectProcessor {
        /**
         * Sets the object for the event.
         * 
-        * @param       \wcf\data\user\notification\UserNotification                    $notification
-        * @param       \wcf\system\user\notification\object\IUserNotificationObject    $object
-        * @param       \wcf\data\user\UserProfile                                      $author
-        * @param       mixed[]                                                         $additionalData
+        * @param       UserNotification                $notification
+        * @param       IUserNotificationObject         $object
+        * @param       UserProfile                     $author
+        * @param       array                           $additionalData
         */
        public function setObject(UserNotification $notification, IUserNotificationObject $object, UserProfile $author, array $additionalData = []);
        
@@ -153,7 +155,7 @@ interface IUserNotificationEvent extends IDatabaseObjectProcessor {
        /**
         * Returns the underlying notification object.
         * 
-        * @return      \wcf\data\user\notification\UserNotification
+        * @return      UserNotification
         */
        public function getNotification();