Fix documentation issues
authorMatthias Schmidt <gravatronics@live.com>
Sun, 7 Jul 2019 15:15:26 +0000 (17:15 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Sun, 7 Jul 2019 15:15:26 +0000 (17:15 +0200)
wcfsetup/install/files/lib/acp/form/UserGroupPromoteOwnerForm.class.php
wcfsetup/install/files/lib/data/style/StyleAction.class.php
wcfsetup/install/files/lib/form/RegisterForm.class.php
wcfsetup/install/files/lib/system/ad/location/IAdLocation.class.php
wcfsetup/install/files/lib/system/bbcode/BBCodeParser.class.php
wcfsetup/install/files/lib/system/breadcrumb/Breadcrumbs.class.php
wcfsetup/install/files/lib/system/form/builder/field/TMultipleFormField.class.php
wcfsetup/install/files/lib/system/html/node/AbstractHtmlNodeProcessor.class.php
wcfsetup/install/files/lib/system/language/I18nHandler.class.php
wcfsetup/install/files/lib/system/request/ControllerMap.class.php
wcfsetup/install/files/lib/system/trophy/condition/TrophyConditionHandler.class.php

index 9ae2344294e58b20238a6f22169a1330af950105..15f6527348b490d9baaec1c525424165f138931e 100644 (file)
@@ -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 = [];
        
index 97e039d5c1b9e1f04a8139c2aac0d026d939c14d..93f035eb6f5f5b11847b3dc31e69137aa375622f 100644 (file)
@@ -1028,8 +1028,6 @@ BROWSERCONFIG;
        
        /**
         * Changes user style.
-        * 
-        * @return      string[]
         */
        public function changeStyle() {
                StyleHandler::getInstance()->changeStyle($this->style->styleID);
index 1d2d2b33455d1c6a7a4ea1d00ac0a5f9cf91dbe0..1b465a587605b6995e2a696c22ca6b5657a7dd38 100644 (file)
@@ -534,7 +534,6 @@ class RegisterForm extends UserAddForm {
        
        /**
         * @param       User $user
-        * @throws      SystemException
         * @since       5.2
         */
        protected function fireNotificationEvent(User $user) {
index dd8afabdd4a7cc346eb80ca3b7477219e61db7b9..7a48f972f418672c309637af8ca16c93e2d295f2 100644 (file)
@@ -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);
index 7851e313fd6930437340b4ca67ec9e8b18e857af..0689479aa6817d2797e812775fee935dd72cb225 100644 (file)
@@ -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) {
index 82ec36d52b01408367918c62b6ae2e334be8327b..a20c90bad98ea016a33a53862a21ddc562e45c64 100644 (file)
@@ -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) {
index 6af342deab9a863068b586e4c07d92c4a22c4887..a18365fc7cb1a8c9dec945c62775d392c7151b0d 100644 (file)
@@ -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
index 2a23cd0daa31bf582dc3c39f2a50e3015ef351b8..f3fdfe0f3c424fc92e66e97d3ffeb11e972a753f 100644 (file)
@@ -45,7 +45,7 @@ abstract class AbstractHtmlNodeProcessor implements IHtmlNodeProcessor {
        protected $xpath;
        
        /**
-        * @inheritDOc
+        * @inheritDoc
         */
        public function load(IHtmlProcessor $htmlProcessor, $html) {
                $this->htmlProcessor = $htmlProcessor;
index 4bd4dd3a80fe448266901f417f2ae33652b37da0..706fa0a7183175be448554168063ab9dbc4a32ba 100644 (file)
@@ -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) {
index da289fcb60688b5abe5f4651b050c3ed4c5f56c5..71a72f68c501ed04ff5dabff2c950a2ffe950cc6 100644 (file)
@@ -47,7 +47,6 @@ class ControllerMap extends SingletonFactory {
        
        /**
         * @inheritDoc
-        * @throws      SystemException
         */
        protected function init() {
                $this->applicationOverrides = RoutingCacheBuilder::getInstance()->getData([], 'applicationOverrides');
index bcd7655a5cf7f08c169d2ba94eb17b3beddcb545..09bc0c88c1cd0e21e73ed3d0ab9b8cc6959175d3 100644 (file)
@@ -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
         */