From 33a7b22bcbbcb22ef4485aad37b4cf55ffe34bca Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Sun, 7 Jul 2019 17:15:26 +0200 Subject: [PATCH] Fix documentation issues --- .../files/lib/acp/form/UserGroupPromoteOwnerForm.class.php | 3 ++- wcfsetup/install/files/lib/data/style/StyleAction.class.php | 2 -- wcfsetup/install/files/lib/form/RegisterForm.class.php | 1 - .../install/files/lib/system/ad/location/IAdLocation.class.php | 1 + .../install/files/lib/system/bbcode/BBCodeParser.class.php | 1 - .../install/files/lib/system/breadcrumb/Breadcrumbs.class.php | 2 -- .../lib/system/form/builder/field/TMultipleFormField.class.php | 2 +- .../lib/system/html/node/AbstractHtmlNodeProcessor.class.php | 2 +- .../install/files/lib/system/language/I18nHandler.class.php | 2 ++ .../install/files/lib/system/request/ControllerMap.class.php | 1 - .../system/trophy/condition/TrophyConditionHandler.class.php | 1 + 11 files changed, 8 insertions(+), 10 deletions(-) diff --git a/wcfsetup/install/files/lib/acp/form/UserGroupPromoteOwnerForm.class.php b/wcfsetup/install/files/lib/acp/form/UserGroupPromoteOwnerForm.class.php index 9ae2344294..15f6527348 100644 --- a/wcfsetup/install/files/lib/acp/form/UserGroupPromoteOwnerForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/UserGroupPromoteOwnerForm.class.php @@ -27,7 +27,8 @@ class UserGroupPromoteOwnerForm extends AbstractFormBuilderForm { public $activeMenuItem = 'wcf.acp.menu.link.group.list'; /** - * @var UserGroup + * user groups that can be promoted to owner group + * @var UserGroup[] */ public $groups = []; diff --git a/wcfsetup/install/files/lib/data/style/StyleAction.class.php b/wcfsetup/install/files/lib/data/style/StyleAction.class.php index 97e039d5c1..93f035eb6f 100644 --- a/wcfsetup/install/files/lib/data/style/StyleAction.class.php +++ b/wcfsetup/install/files/lib/data/style/StyleAction.class.php @@ -1028,8 +1028,6 @@ BROWSERCONFIG; /** * Changes user style. - * - * @return string[] */ public function changeStyle() { StyleHandler::getInstance()->changeStyle($this->style->styleID); diff --git a/wcfsetup/install/files/lib/form/RegisterForm.class.php b/wcfsetup/install/files/lib/form/RegisterForm.class.php index 1d2d2b3345..1b465a5876 100644 --- a/wcfsetup/install/files/lib/form/RegisterForm.class.php +++ b/wcfsetup/install/files/lib/form/RegisterForm.class.php @@ -534,7 +534,6 @@ class RegisterForm extends UserAddForm { /** * @param User $user - * @throws SystemException * @since 5.2 */ protected function fireNotificationEvent(User $user) { diff --git a/wcfsetup/install/files/lib/system/ad/location/IAdLocation.class.php b/wcfsetup/install/files/lib/system/ad/location/IAdLocation.class.php index dd8afabdd4..7a48f972f4 100644 --- a/wcfsetup/install/files/lib/system/ad/location/IAdLocation.class.php +++ b/wcfsetup/install/files/lib/system/ad/location/IAdLocation.class.php @@ -26,6 +26,7 @@ interface IAdLocation { /** * Replaces all relevant variables in the given ad and returns the processed ad. * + * @param string $ad * @return string */ public function replaceVariables($ad); diff --git a/wcfsetup/install/files/lib/system/bbcode/BBCodeParser.class.php b/wcfsetup/install/files/lib/system/bbcode/BBCodeParser.class.php index 7851e313fd..0689479aa6 100644 --- a/wcfsetup/install/files/lib/system/bbcode/BBCodeParser.class.php +++ b/wcfsetup/install/files/lib/system/bbcode/BBCodeParser.class.php @@ -543,7 +543,6 @@ class BBCodeParser extends SingletonFactory { * * @param string $text * @param string[] $allowedBBCodes - * @return string[] * @deprecated 3.0 - please use HtmlInputProcessor::validate() instead */ public function validateBBCodes($text, array $allowedBBCodes) { diff --git a/wcfsetup/install/files/lib/system/breadcrumb/Breadcrumbs.class.php b/wcfsetup/install/files/lib/system/breadcrumb/Breadcrumbs.class.php index 82ec36d52b..a20c90bad9 100644 --- a/wcfsetup/install/files/lib/system/breadcrumb/Breadcrumbs.class.php +++ b/wcfsetup/install/files/lib/system/breadcrumb/Breadcrumbs.class.php @@ -58,7 +58,6 @@ class Breadcrumbs extends SingletonFactory implements \Countable, \Iterator { * * @param Breadcrumb $item * @param integer $index - * @return boolean * @deprecated 3.0 */ public function replace(Breadcrumb $item, $index) { @@ -69,7 +68,6 @@ class Breadcrumbs extends SingletonFactory implements \Countable, \Iterator { * Removes a breadcrumb, returns true if deletion was successful. * * @param integer $index - * @return boolean * @deprecated 3.0 */ public function remove($index) { diff --git a/wcfsetup/install/files/lib/system/form/builder/field/TMultipleFormField.class.php b/wcfsetup/install/files/lib/system/form/builder/field/TMultipleFormField.class.php index 6af342deab..a18365fc7c 100644 --- a/wcfsetup/install/files/lib/system/form/builder/field/TMultipleFormField.class.php +++ b/wcfsetup/install/files/lib/system/form/builder/field/TMultipleFormField.class.php @@ -109,7 +109,7 @@ trait TMultipleFormField { * Sets the minimum number of values that can be selected or set and returns * this field. * - * @param int $maximum maximum number of values + * @param int $minimum maximum number of values * @return static this field * * @throws \InvalidArgumentException if the given minimum number of values is invalid diff --git a/wcfsetup/install/files/lib/system/html/node/AbstractHtmlNodeProcessor.class.php b/wcfsetup/install/files/lib/system/html/node/AbstractHtmlNodeProcessor.class.php index 2a23cd0daa..f3fdfe0f3c 100644 --- a/wcfsetup/install/files/lib/system/html/node/AbstractHtmlNodeProcessor.class.php +++ b/wcfsetup/install/files/lib/system/html/node/AbstractHtmlNodeProcessor.class.php @@ -45,7 +45,7 @@ abstract class AbstractHtmlNodeProcessor implements IHtmlNodeProcessor { protected $xpath; /** - * @inheritDOc + * @inheritDoc */ public function load(IHtmlProcessor $htmlProcessor, $html) { $this->htmlProcessor = $htmlProcessor; diff --git a/wcfsetup/install/files/lib/system/language/I18nHandler.class.php b/wcfsetup/install/files/lib/system/language/I18nHandler.class.php index 4bd4dd3a80..706fa0a718 100644 --- a/wcfsetup/install/files/lib/system/language/I18nHandler.class.php +++ b/wcfsetup/install/files/lib/system/language/I18nHandler.class.php @@ -94,6 +94,8 @@ class I18nHandler extends SingletonFactory { /** * Reads plain and i18n values from request data. + * + * @param array|null $requestData used request data (if `null`, `$_POST` is used) */ public function readValues(array $requestData = null) { if ($requestData === null) { diff --git a/wcfsetup/install/files/lib/system/request/ControllerMap.class.php b/wcfsetup/install/files/lib/system/request/ControllerMap.class.php index da289fcb60..71a72f68c5 100644 --- a/wcfsetup/install/files/lib/system/request/ControllerMap.class.php +++ b/wcfsetup/install/files/lib/system/request/ControllerMap.class.php @@ -47,7 +47,6 @@ class ControllerMap extends SingletonFactory { /** * @inheritDoc - * @throws SystemException */ protected function init() { $this->applicationOverrides = RoutingCacheBuilder::getInstance()->getData([], 'applicationOverrides'); diff --git a/wcfsetup/install/files/lib/system/trophy/condition/TrophyConditionHandler.class.php b/wcfsetup/install/files/lib/system/trophy/condition/TrophyConditionHandler.class.php index bcd7655a5c..09bc0c88c1 100644 --- a/wcfsetup/install/files/lib/system/trophy/condition/TrophyConditionHandler.class.php +++ b/wcfsetup/install/files/lib/system/trophy/condition/TrophyConditionHandler.class.php @@ -137,6 +137,7 @@ class TrophyConditionHandler extends SingletonFactory { * Returns the userTrophyIDs of the users, which no longer fulfills the trophy conditions. * * @param Trophy $trophy + * @param integer $maxTrophyIDs maximum number of trophies that are processed * @return integer[] * @since 5.2 */ -- 2.20.1