From: Matthias Schmidt Date: Wed, 6 Apr 2016 14:52:01 +0000 (+0200) Subject: Fix parameter documentation X-Git-Tag: 3.0.0_Beta_1~1966 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=ac52543a84c4bc0d3774855293110228fb38a6b0;p=GitHub%2FWoltLab%2FWCF.git Fix parameter documentation --- diff --git a/wcfsetup/install.php b/wcfsetup/install.php index 292fa30e3d..3610436b2c 100644 --- a/wcfsetup/install.php +++ b/wcfsetup/install.php @@ -59,9 +59,9 @@ class SystemException extends \Exception implements IPrintableException { /** * Creates a new SystemException. * - * @param message string error message - * @param code integer error code - * @param description string description of the error + * @param string $message error message + * @param integer $code error code + * @param string $description description of the error */ public function __construct($message = '', $code = 0, $description = '') { parent::__construct($message, $code); @@ -174,6 +174,9 @@ spl_autoload_register(function($className) { /** * Escapes strings for execution in sql queries. + * + * @param string $string + * @return string */ function escapeString($string) { return \wcf\system\WCF::getDB()->escapeString($string); @@ -449,8 +452,8 @@ class Tar { * Returns an associative array with information * about a specific file in the archive. * - * @param mixed $fileindex index or name of the requested file - * @return array $fileInfo + * @param mixed $fileIndex index or name of the requested file + * @return array */ public function getFileInfo($fileIndex) { if (!is_int($fileIndex)) { diff --git a/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php b/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php index f7f434fd0c..5f7b4c9141 100644 --- a/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php +++ b/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php @@ -99,7 +99,6 @@ class UninstallPackageAction extends InstallPackageAction { /** * Uninstalls node components and returns next node. * - * @param string $node * @return string */ public function stepUninstall() { diff --git a/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php b/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php index 0b0ae9d8e9..e09d5f1a08 100644 --- a/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php +++ b/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php @@ -228,9 +228,7 @@ class AJAXInvokeAction extends AbstractSecureAction { * ) * * @param array $data - * @param string $className - * @param string $actionName - * @return \wcf\action\AJAXInvokeAction + * @return AJAXInvokeAction */ public static function debugCall(array $data) { // validate $data array diff --git a/wcfsetup/install/files/lib/action/PollAction.class.php b/wcfsetup/install/files/lib/action/PollAction.class.php index fb3fef9f7c..94b3ab5bc2 100644 --- a/wcfsetup/install/files/lib/action/PollAction.class.php +++ b/wcfsetup/install/files/lib/action/PollAction.class.php @@ -154,6 +154,8 @@ class PollAction extends AJAXProxyAction { /** * Renders the result template. + * + * @param array $returnValues */ public function getResult(array &$returnValues) { WCF::getTPL()->assign(array( @@ -165,6 +167,8 @@ class PollAction extends AJAXProxyAction { /** * Renders the vote template. + * + * @param array $returnValues */ public function getVote(array &$returnValues) { WCF::getTPL()->assign(array( diff --git a/wcfsetup/install/files/lib/data/comment/response/CommentResponse.class.php b/wcfsetup/install/files/lib/data/comment/response/CommentResponse.class.php index 4b307f60d8..39d371e631 100644 --- a/wcfsetup/install/files/lib/data/comment/response/CommentResponse.class.php +++ b/wcfsetup/install/files/lib/data/comment/response/CommentResponse.class.php @@ -67,7 +67,7 @@ class CommentResponse extends DatabaseObject implements IMessage { /** * Sets related comment object. * - * @param Comment + * @param Comment $comment */ public function setComment(Comment $comment) { if ($this->commentID == $comment->commentID) { diff --git a/wcfsetup/install/files/lib/data/language/LanguageEditor.class.php b/wcfsetup/install/files/lib/data/language/LanguageEditor.class.php index 512ad34b2d..de04c44442 100644 --- a/wcfsetup/install/files/lib/data/language/LanguageEditor.class.php +++ b/wcfsetup/install/files/lib/data/language/LanguageEditor.class.php @@ -494,9 +494,8 @@ class LanguageEditor extends DatabaseObjectEditor implements IEditableCachedObje * @param string $search search query * @param string $replace * @param integer $languageID - * @param boolean $useRegex - * @param boolean $caseSensitive - * @param boolean $searchVariableName + * @param integer $useRegex + * @param integer $searchVariableName * @return array */ public static function search($search, $replace = null, $languageID = null, $useRegex = 0, $searchVariableName = 0) { diff --git a/wcfsetup/install/files/lib/data/like/object/ILikeObject.class.php b/wcfsetup/install/files/lib/data/like/object/ILikeObject.class.php index 56e0e800ba..21f1cbef38 100644 --- a/wcfsetup/install/files/lib/data/like/object/ILikeObject.class.php +++ b/wcfsetup/install/files/lib/data/like/object/ILikeObject.class.php @@ -54,7 +54,7 @@ interface ILikeObject extends IDatabaseObjectProcessor, ITitledObject { /** * Sets the object type. * - * @param ObjectType + * @param ObjectType $objectType */ public function setObjectType(ObjectType $objectType); diff --git a/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php b/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php index d36935f0c9..04321f9711 100644 --- a/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php +++ b/wcfsetup/install/files/lib/data/like/object/LikeObject.class.php @@ -91,7 +91,7 @@ class LikeObject extends DatabaseObject { /** * Sets the liked object. * - * @param ILikeObject $likeObject + * @param ILikeObject $likedObject */ public function setLikedObject(ILikeObject $likedObject) { $this->likedObject = $likedObject; diff --git a/wcfsetup/install/files/lib/data/package/Package.class.php b/wcfsetup/install/files/lib/data/package/Package.class.php index 9fa893d461..ca16b9a08e 100644 --- a/wcfsetup/install/files/lib/data/package/Package.class.php +++ b/wcfsetup/install/files/lib/data/package/Package.class.php @@ -295,17 +295,17 @@ class Package extends DatabaseObject { * @param string $fromVersion * @return boolean */ - public static function checkFromversion($currentVersion, $fromversion) { - if (mb_strpos($fromversion, '*') !== false) { + public static function checkFromversion($currentVersion, $fromVersion) { + if (mb_strpos($fromVersion, '*') !== false) { // from version with wildcard // use regular expression - $fromversion = str_replace('\*', '.*', preg_quote($fromversion, '!')); - if (preg_match('!^'.$fromversion.'$!i', $currentVersion)) { + $fromVersion = str_replace('\*', '.*', preg_quote($fromVersion, '!')); + if (preg_match('!^'.$fromVersion.'$!i', $currentVersion)) { return true; } } else { - if (self::compareVersion($currentVersion, $fromversion, '=')) { + if (self::compareVersion($currentVersion, $fromVersion, '=')) { return true; } } diff --git a/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php b/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php index 81a9daca32..067f71d1c9 100644 --- a/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php +++ b/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php @@ -77,7 +77,6 @@ class PageNodeTree { * * @param integer $parentID * @param PageNode $parentNode - * @param int[] $filter * @return PageNode[] */ protected function generateNodeTree($parentID, PageNode $parentNode = null) { diff --git a/wcfsetup/install/files/lib/data/template/Template.class.php b/wcfsetup/install/files/lib/data/template/Template.class.php index e583db7f9f..92af1e47c5 100644 --- a/wcfsetup/install/files/lib/data/template/Template.class.php +++ b/wcfsetup/install/files/lib/data/template/Template.class.php @@ -100,10 +100,10 @@ class Template extends DatabaseObject { * @param string $search search query * @param string $replace * @param array $templateIDs - * @param boolean $invertTemplates - * @param boolean $useRegex - * @param boolean $caseSensitive - * @param boolean $invertSearch + * @param integer $invertTemplates + * @param integer $useRegex + * @param integer $caseSensitive + * @param integer $invertSearch * @return array */ public static function search($search, $replace = null, $templateIDs = null, $invertTemplates = 0, $useRegex = 0, $caseSensitive = 0, $invertSearch = 0) { diff --git a/wcfsetup/install/files/lib/data/user/UserEditor.class.php b/wcfsetup/install/files/lib/data/user/UserEditor.class.php index b4b7e0ad7e..65108c16d4 100644 --- a/wcfsetup/install/files/lib/data/user/UserEditor.class.php +++ b/wcfsetup/install/files/lib/data/user/UserEditor.class.php @@ -149,7 +149,7 @@ class UserEditor extends DatabaseObjectEditor implements IEditableCachedObject { /** * Adds a user to the groups he should be in. * - * @param array $groups + * @param array $groupIDs * @param boolean $deleteOldGroups * @param boolean $addDefaultGroups */ diff --git a/wcfsetup/install/files/lib/system/WCF.class.php b/wcfsetup/install/files/lib/system/WCF.class.php index ae49c3a64e..fd504c9349 100644 --- a/wcfsetup/install/files/lib/system/WCF.class.php +++ b/wcfsetup/install/files/lib/system/WCF.class.php @@ -275,10 +275,10 @@ class WCF { /** * Turns PHP errors into an ErrorException. * - * @param integer $errorNo + * @param integer $severity * @param string $message - * @param string $filename - * @param integer $lineNo + * @param string $file + * @param integer $line */ public static final function handleError($severity, $message, $file, $line) { // this is neccessary for the shut-up operator diff --git a/wcfsetup/install/files/lib/system/bbcode/AttachmentBBCode.class.php b/wcfsetup/install/files/lib/system/bbcode/AttachmentBBCode.class.php index 2323cc2840..674ce706c3 100644 --- a/wcfsetup/install/files/lib/system/bbcode/AttachmentBBCode.class.php +++ b/wcfsetup/install/files/lib/system/bbcode/AttachmentBBCode.class.php @@ -130,7 +130,7 @@ class AttachmentBBCode extends AbstractBBCode { /** * Sets the attachment list. * - * @param \wcf\data\attachment\GroupedAttachmentList $attachments + * @param \wcf\data\attachment\GroupedAttachmentList $attachmentList * @deprecated */ public static function setAttachmentList(GroupedAttachmentList $attachmentList) { diff --git a/wcfsetup/install/files/lib/system/cache/runtime/IRuntimeCache.class.php b/wcfsetup/install/files/lib/system/cache/runtime/IRuntimeCache.class.php index d81bc7e79b..c7139867a8 100644 --- a/wcfsetup/install/files/lib/system/cache/runtime/IRuntimeCache.class.php +++ b/wcfsetup/install/files/lib/system/cache/runtime/IRuntimeCache.class.php @@ -69,7 +69,7 @@ interface IRuntimeCache { /** * Removes the objects with the given ids from the runtime cache if they have already been loaded. * - * @param integer $objectID + * @param integer[] $objectIDs */ public function removeObjects(array $objectIDs); } diff --git a/wcfsetup/install/files/lib/system/condition/ICondition.class.php b/wcfsetup/install/files/lib/system/condition/ICondition.class.php index e2a0e88e27..4bc8f59c9c 100644 --- a/wcfsetup/install/files/lib/system/condition/ICondition.class.php +++ b/wcfsetup/install/files/lib/system/condition/ICondition.class.php @@ -7,7 +7,7 @@ use wcf\data\IDatabaseObjectProcessor; * Every concrete condition implementation needs to implement this interface. * * @author Matthias Schmidt - * @copyright 2001-2015 WoltLab GmbH + * @copyright 2001-2016 WoltLab GmbH * @license GNU Lesser General Public License * @package com.woltlab.wcf * @subpackage system.condition @@ -43,14 +43,12 @@ interface ICondition extends IDatabaseObjectProcessor { * Extracts all needed data from the given condition to pre-fill the output * for editing the given condition. * - * @param \wcf\data\condition\Condition $condition + * @param Condition $condition */ public function setData(Condition $condition); /** - * Validates the given data. - * - * @param string $value + * Validates the read condition data. */ public function validate(); } diff --git a/wcfsetup/install/files/lib/system/cronjob/CronjobScheduler.class.php b/wcfsetup/install/files/lib/system/cronjob/CronjobScheduler.class.php index 8ed5bc57d3..b6c8be1a6e 100644 --- a/wcfsetup/install/files/lib/system/cronjob/CronjobScheduler.class.php +++ b/wcfsetup/install/files/lib/system/cronjob/CronjobScheduler.class.php @@ -186,8 +186,8 @@ class CronjobScheduler extends SingletonFactory { /** * Logs cronjob exec success or failure. * - * @param \wcf\data\cronjob\CronjobEditor $logEditor - * @param \wcf\system\exception\SystemException $exception + * @param CronjobLogEditor $logEditor + * @param SystemException $exception */ protected function logResult(CronjobLogEditor $logEditor, SystemException $exception = null) { if ($exception !== null) { diff --git a/wcfsetup/install/files/lib/system/email/Email.class.php b/wcfsetup/install/files/lib/system/email/Email.class.php index ffd558bb91..463766867f 100644 --- a/wcfsetup/install/files/lib/system/email/Email.class.php +++ b/wcfsetup/install/files/lib/system/email/Email.class.php @@ -297,7 +297,7 @@ class Email { /** * Sets the email's 'Reply-To'. * - * @param \wcf\system\email\Mailbox $sender + * @param Mailbox $replyTo */ public function setReplyTo(Mailbox $replyTo = null) { $this->replyTo = $replyTo; diff --git a/wcfsetup/install/files/lib/system/exception/AJAXException.class.php b/wcfsetup/install/files/lib/system/exception/AJAXException.class.php index 5bb7e2922b..4099d55943 100644 --- a/wcfsetup/install/files/lib/system/exception/AJAXException.class.php +++ b/wcfsetup/install/files/lib/system/exception/AJAXException.class.php @@ -54,7 +54,7 @@ class AJAXException extends LoggedException { * Throws a JSON-encoded error message * * @param string $message - * @param boolean $isDoomsday + * @param integer $errorType * @param string $stacktrace * @param array $returnValues * @param string $exceptionID diff --git a/wcfsetup/install/files/lib/system/io/FTP.class.php b/wcfsetup/install/files/lib/system/io/FTP.class.php index 3b2301e7e4..52b0b6d53a 100644 --- a/wcfsetup/install/files/lib/system/io/FTP.class.php +++ b/wcfsetup/install/files/lib/system/io/FTP.class.php @@ -23,7 +23,7 @@ class FTP { * Opens a new ftp connection to given host. * * @param string $host - * @param string $port + * @param integer $port * @param integer $timeout */ public function __construct($host = 'localhost', $port = 21, $timeout = 30) { diff --git a/wcfsetup/install/files/lib/system/label/object/ILabelObjectHandler.class.php b/wcfsetup/install/files/lib/system/label/object/ILabelObjectHandler.class.php index a7db3ef164..095626ee90 100644 --- a/wcfsetup/install/files/lib/system/label/object/ILabelObjectHandler.class.php +++ b/wcfsetup/install/files/lib/system/label/object/ILabelObjectHandler.class.php @@ -31,8 +31,9 @@ interface ILabelObjectHandler { /** * Returns true, if all given label ids are valid and accessible. * - * @param array $labelIDs - * @param array $optionName + * @param integer[] $labelIDs + * @param string $optionName + * @param boolean $legacyReturnValue * @return mixed */ public function validateLabelIDs(array $labelIDs, $optionName = '', $legacyReturnValue = true); diff --git a/wcfsetup/install/files/lib/system/language/I18nHandler.class.php b/wcfsetup/install/files/lib/system/language/I18nHandler.class.php index 6b13da2833..7e37d5c4a1 100644 --- a/wcfsetup/install/files/lib/system/language/I18nHandler.class.php +++ b/wcfsetup/install/files/lib/system/language/I18nHandler.class.php @@ -357,7 +357,7 @@ class I18nHandler extends SingletonFactory { * Sets additional options for elements, required if updating values. * * @param integer $elementID - * @param integer $pckageID + * @param integer $packageID * @param string $value * @param string $pattern */ diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php index 5d263b1ba7..a53893f5b2 100644 --- a/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php @@ -351,8 +351,8 @@ class PackageInstallationNodeBuilder { * nodes to provide to be descendants of the new node. If you intend * to insert more than a single node, you should prefer shiftNodes(). * - * @param string $beforeNode - * @param \wcf\system\Callback $callback + * @param string $beforeNode + * @param Callback $callback */ public function insertNode($beforeNode, Callback $callback) { $newNode = $this->getToken(); diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php index 7e0e6e546e..5add17dd68 100644 --- a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php @@ -632,8 +632,8 @@ class PackageInstallationScheduler { /** * Gets stored auth data of given update server. * - * @param array $updateServer - * @return array $authData + * @param array $data + * @return array */ protected function getAuthData(array $data) { $updateServer = new PackageUpdateServer(null, $data); diff --git a/wcfsetup/install/files/lib/system/style/StyleCompiler.class.php b/wcfsetup/install/files/lib/system/style/StyleCompiler.class.php index a5d324e6f4..b3aafc78d7 100644 --- a/wcfsetup/install/files/lib/system/style/StyleCompiler.class.php +++ b/wcfsetup/install/files/lib/system/style/StyleCompiler.class.php @@ -279,11 +279,11 @@ class StyleCompiler extends SingletonFactory { * Compiles SCSS stylesheets into one CSS-stylesheet and writes them * to filesystem. Please be aware not to append '.css' within $filename! * - * @param string $filename - * @param array $files - * @param array $variables - * @param string $individualScss - * @param \wcf\system\Callback $callback + * @param string $filename + * @param string[] $files + * @param string[] $variables + * @param string $individualScss + * @param Callback $callback */ protected function compileStylesheet($filename, array $files, array $variables, $individualScss, Callback $callback) { foreach ($variables as &$value) { diff --git a/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php b/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php index 75c9df7a72..0fc530c3cc 100644 --- a/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php +++ b/wcfsetup/install/files/lib/system/upload/UploadHandler.class.php @@ -74,8 +74,7 @@ class UploadHandler { /** * Validates the uploaded files. Returns true on success, otherwise false. * - * @param integer $maxFilesize - * @param array $fileExtensions + * @param IUploadFileValidationStrategy $validationStrategy * @return boolean */ public function validateFiles(IUploadFileValidationStrategy $validationStrategy) { diff --git a/wcfsetup/install/files/lib/system/user/notification/object/type/IMultiRecipientCommentUserNotificationObjectType.class.php b/wcfsetup/install/files/lib/system/user/notification/object/type/IMultiRecipientCommentUserNotificationObjectType.class.php index 315a8def23..b6e0670322 100644 --- a/wcfsetup/install/files/lib/system/user/notification/object/type/IMultiRecipientCommentUserNotificationObjectType.class.php +++ b/wcfsetup/install/files/lib/system/user/notification/object/type/IMultiRecipientCommentUserNotificationObjectType.class.php @@ -23,7 +23,7 @@ interface IMultiRecipientCommentUserNotificationObjectType { * Returns the user ids of the notification recipients. If an empty array * is returned, no notifications should be sent. * - * @param integer $comment + * @param Comment $comment * @return integer[] */ public function getRecipientIDs(Comment $comment); diff --git a/wcfsetup/install/files/lib/system/user/object/watch/UserObjectWatchHandler.class.php b/wcfsetup/install/files/lib/system/user/object/watch/UserObjectWatchHandler.class.php index 28ce21608b..b2001506f2 100644 --- a/wcfsetup/install/files/lib/system/user/object/watch/UserObjectWatchHandler.class.php +++ b/wcfsetup/install/files/lib/system/user/object/watch/UserObjectWatchHandler.class.php @@ -97,12 +97,12 @@ class UserObjectWatchHandler extends SingletonFactory { /** * Updates a watched object for all subscriber. * - * @param string $objectType - * @param integer $objectIDs - * @param string $notificationEventName - * @param string $notificationObjectType - * @param \wcf\system\user\notification\object\IUserNotificationObject $notificationObject - * @param array $additionalData + * @param string $objectType + * @param integer $objectID + * @param string $notificationEventName + * @param string $notificationObjectType + * @param IUserNotificationObject $notificationObject + * @param array $additionalData */ public function updateObject($objectType, $objectID, $notificationEventName, $notificationObjectType, IUserNotificationObject $notificationObject, array $additionalData = array()) { // get object type id diff --git a/wcfsetup/install/files/lib/util/DirectoryUtil.class.php b/wcfsetup/install/files/lib/util/DirectoryUtil.class.php index 60fac9afbb..deafb86235 100644 --- a/wcfsetup/install/files/lib/util/DirectoryUtil.class.php +++ b/wcfsetup/install/files/lib/util/DirectoryUtil.class.php @@ -88,9 +88,9 @@ final class DirectoryUtil { /** * Returns an instance of DirectoryUtil (or child). * - * @param string $directory path + * @param string $tmpDirectory path * @param boolean $recursive walk through sub-directories too - * @return \wcf\util\DirectoryUtil + * @return DirectoryUtil */ public static function getInstance($tmpDirectory, $recursive = true) { $directory = realpath(FileUtil::unifyDirSeparator($tmpDirectory)); @@ -249,8 +249,8 @@ final class DirectoryUtil { /** * Executes a callback on each file and returns false if callback is invalid. * - * @param \wcf\system\Callback $callback - * @param \wcf\system\Regex $pattern callback is only applied to files matching the given pattern + * @param Callback $callback + * @param Regex $pattern callback is only applied to files matching the given pattern * @return boolean */ public function executeCallback(Callback $callback, Regex $pattern = null) {