From: Matthias Schmidt <gravatronics@live.com>
Date: Wed, 7 Feb 2018 18:50:22 +0000 (+0100)
Subject: Fix method documentation issues
X-Git-Tag: 3.1.0_RC_3~5^2^2
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=7bbca526ebce86508f9cc1640f194fa1f0e1b2f4;p=GitHub%2FWoltLab%2FWCF.git

Fix method documentation issues
---

diff --git a/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php b/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
index 493e5b022d..1faf75ee18 100755
--- a/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
@@ -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') {
diff --git a/wcfsetup/install/files/lib/data/user/User.class.php b/wcfsetup/install/files/lib/data/user/User.class.php
index d06f1fe2ed..dd48cf407f 100644
--- a/wcfsetup/install/files/lib/data/user/User.class.php
+++ b/wcfsetup/install/files/lib/data/user/User.class.php
@@ -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) {
diff --git a/wcfsetup/install/files/lib/system/option/UseroptionsOptionType.class.php b/wcfsetup/install/files/lib/system/option/UseroptionsOptionType.class.php
index 0ccaa1ab94..fb00d71768 100644
--- a/wcfsetup/install/files/lib/system/option/UseroptionsOptionType.class.php
+++ b/wcfsetup/install/files/lib/system/option/UseroptionsOptionType.class.php
@@ -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) {
diff --git a/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php b/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php
index ee8f84cef1..9280292d49 100644
--- a/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php
@@ -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);
diff --git a/wcfsetup/install/files/lib/system/session/SessionHandler.class.php b/wcfsetup/install/files/lib/system/session/SessionHandler.class.php
index e38864f87a..eb7eb412a9 100644
--- a/wcfsetup/install/files/lib/system/session/SessionHandler.class.php
+++ b/wcfsetup/install/files/lib/system/session/SessionHandler.class.php
@@ -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])) {
diff --git a/wcfsetup/install/files/lib/system/template/plugin/PagesFunctionTemplatePlugin.class.php b/wcfsetup/install/files/lib/system/template/plugin/PagesFunctionTemplatePlugin.class.php
index b03e98c12b..49e8a491e8 100644
--- a/wcfsetup/install/files/lib/system/template/plugin/PagesFunctionTemplatePlugin.class.php
+++ b/wcfsetup/install/files/lib/system/template/plugin/PagesFunctionTemplatePlugin.class.php
@@ -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) {