Fix method documentation issues
authorMatthias Schmidt <gravatronics@live.com>
Wed, 7 Feb 2018 18:50:22 +0000 (19:50 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Wed, 7 Feb 2018 18:50:31 +0000 (19:50 +0100)
wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
wcfsetup/install/files/lib/data/user/User.class.php
wcfsetup/install/files/lib/system/option/UseroptionsOptionType.class.php
wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php
wcfsetup/install/files/lib/system/session/SessionHandler.class.php
wcfsetup/install/files/lib/system/template/plugin/PagesFunctionTemplatePlugin.class.php

index 493e5b022d4c21e02c52581b6e25c9d34b7f7d49..1faf75ee18c2a15a0311a9fb6c7e60e4988a1c41 100755 (executable)
@@ -95,7 +95,7 @@ class CacheListPage extends AbstractPage {
         * Reads the information of cached files
         * 
         * @param       string                  $cacheType
-        * @param       strign                  $cacheDir
+        * @param       string                  $cacheDir
         * @param       \wcf\system\Regex       $ignore
         */
        protected function readCacheFiles($cacheType, $cacheDir, Regex $ignore = null, $extension = 'php') {
index d06f1fe2ed9652b7428e4a5e74840889b8ba0964..dd48cf407fff21f298bb1659dcfc299ccd2ce536 100644 (file)
@@ -332,7 +332,7 @@ final class User extends DatabaseObject implements IRouteController, IUserConten
        /**
         * Returns the time zone of this user.
         * 
-        * @return      DateTimeZone
+        * @return      \DateTimeZone
         */
        public function getTimeZone() {
                if ($this->timezoneObj === null) {
index 0ccaa1ab949d35e1f90752d1cddaa6cb24f93ff3..fb00d71768ba710e288f69c757e0229cafc2be41 100644 (file)
@@ -59,7 +59,7 @@ class UseroptionsOptionType extends AbstractOptionType {
        /**
         * Returns the list of available user options.
         * 
-        * @return      string
+        * @return      string[]
         */
        protected static function getUserOptions() {
                if (self::$userOptions === null) {
index ee8f84cef1e4e3dc4be4055c2a4d69f9b5540aad..9280292d49aa4d804b2aa08cc20451891933b182 100644 (file)
@@ -142,7 +142,7 @@ class PackageUninstallationDispatcher extends PackageInstallationDispatcher {
         * @param       string          $targetDir
         * @param       string          $files
         * @param       boolean         $deleteEmptyDirectories
-        * @param       booelan         $deleteEmptyTargetDir
+        * @param       boolean         $deleteEmptyTargetDir
         */
        public function deleteFiles($targetDir, $files, $deleteEmptyTargetDir = false, $deleteEmptyDirectories = true) {
                new Uninstaller($targetDir, $files, $deleteEmptyTargetDir, $deleteEmptyDirectories);
index e38864f87a645a9d2daa068af88919852970b1ba..eb7eb412a90203e51e7a1b928f12977a61141a23 100644 (file)
@@ -320,7 +320,7 @@ class SessionHandler extends SingletonFactory {
         * Registers a session variable.
         * 
         * @param       string          $key
-        * @param       string          $value
+        * @param       mixed           $value
         */
        public function register($key, $value) {
                $this->variables[$key] = $value;
@@ -338,9 +338,11 @@ class SessionHandler extends SingletonFactory {
        }
        
        /**
-        * Returns the value of a session variable.
+        * Returns the value of a session variable or `null` if the session
+        * variable does not exist.
         * 
         * @param       string          $key
+        * @return      mixed
         */
        public function getVar($key) {
                if (isset($this->variables[$key])) {
index b03e98c12b9a75456817d3f44f7d1cfcf8be2981..49e8a491e822d66e73e95346e319e980845b9d27 100644 (file)
@@ -64,8 +64,8 @@ class PagesFunctionTemplatePlugin implements IFunctionTemplatePlugin {
        /**
         * Generates HTML code for 'previous' link.
         * 
-        * @param       type            $link
-        * @param       type            $pageNo
+        * @param       string          $link
+        * @param       integer         $pageNo
         * @return      string
         */
        protected function makePreviousLink($link, $pageNo) {
@@ -80,8 +80,8 @@ class PagesFunctionTemplatePlugin implements IFunctionTemplatePlugin {
        /**
         * Generates HTML code for 'next' link.
         * 
-        * @param       type            $link
-        * @param       type            $pageNo
+        * @param       string          $link
+        * @param       integer         $pageNo
         * @return      string
         */
        protected function makeNextLink($link, $pageNo, $pages) {