From fc6738f0691d9f04c4d0fe9f5535385dd3524649 Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Thu, 26 May 2016 13:56:59 +0200 Subject: [PATCH] Add more documentation tags --- .../lib/data/user/online/UserOnline.class.php | 4 ++++ .../object/AbstractLabelObjectHandler.class.php | 1 + .../lib/system/session/SessionHandler.class.php | 15 +++++++++++++++ .../event/IUserNotificationEvent.class.php | 12 +++++++----- 4 files changed, 27 insertions(+), 5 deletions(-) diff --git a/wcfsetup/install/files/lib/data/user/online/UserOnline.class.php b/wcfsetup/install/files/lib/data/user/online/UserOnline.class.php index 033a3ea369..a83c3382a1 100644 --- a/wcfsetup/install/files/lib/data/user/online/UserOnline.class.php +++ b/wcfsetup/install/files/lib/data/user/online/UserOnline.class.php @@ -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 { /** diff --git a/wcfsetup/install/files/lib/system/label/object/AbstractLabelObjectHandler.class.php b/wcfsetup/install/files/lib/system/label/object/AbstractLabelObjectHandler.class.php index 2427575760..ef6db8d214 100644 --- a/wcfsetup/install/files/lib/system/label/object/AbstractLabelObjectHandler.class.php +++ b/wcfsetup/install/files/lib/system/label/object/AbstractLabelObjectHandler.class.php @@ -57,6 +57,7 @@ abstract class AbstractLabelObjectHandler extends SingletonFactory implements IL /** * @inheritDoc + * @return ViewableLabelGroup[] */ public function getLabelGroups(array $parameters = []) { $groupIDs = $this->getLabelGroupIDs($parameters); diff --git a/wcfsetup/install/files/lib/system/session/SessionHandler.class.php b/wcfsetup/install/files/lib/system/session/SessionHandler.class.php index 1cf6e0a027..b14da1a4ba 100644 --- a/wcfsetup/install/files/lib/system/session/SessionHandler.class.php +++ b/wcfsetup/install/files/lib/system/session/SessionHandler.class.php @@ -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 { /** diff --git a/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php b/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php index 54ba0bffda..c34a0cc294 100644 --- a/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php +++ b/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php @@ -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(); -- 2.20.1