From 59dc0db607831163ba432304ff58280522c9e827 Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Sun, 13 Oct 2013 19:24:29 +0200 Subject: [PATCH] Fixes comment formatting --- wcfsetup/install/files/acp/js/WCF.ACP.js | 2 +- wcfsetup/install/files/js/WCF.ACL.js | 2 +- wcfsetup/install/files/js/WCF.Message.js | 2 +- wcfsetup/install/files/js/WCF.js | 8 ++++---- .../files/lib/action/AJAXInvokeAction.class.php | 8 ++++---- .../files/lib/data/IMessageQuickReplyAction.class.php | 4 ++-- .../files/lib/data/acp/menu/item/ACPMenuItem.class.php | 4 ++-- .../session/access/log/ACPSessionAccessLog.class.php | 2 +- .../data/attachment/GroupedAttachmentList.class.php | 2 +- .../lib/data/bbcode/MessagePreviewAction.class.php | 2 +- .../comment/response/CommentResponseAction.class.php | 2 +- .../response/StructuredCommentResponse.class.php | 4 ++-- .../response/StructuredCommentResponseList.class.php | 2 +- .../lib/data/label/group/ViewableLabelGroup.class.php | 2 +- .../lib/data/object/type/ObjectTypeCache.class.php | 4 ++-- .../files/lib/data/package/PackageCache.class.php | 2 +- .../lib/data/package/update/PackageUpdate.class.php | 2 +- .../package/update/ViewablePackageUpdate.class.php | 6 +++--- .../update/server/PackageUpdateServer.class.php | 4 ++-- .../lib/data/smiley/category/SmileyCategory.class.php | 2 +- wcfsetup/install/files/lib/data/tag/Tag.class.php | 2 +- .../install/files/lib/data/user/UserAction.class.php | 2 +- .../install/files/lib/data/user/UserProfile.class.php | 2 +- .../files/lib/data/user/avatar/IUserAvatar.class.php | 2 +- .../install/files/lib/page/ITrackablePage.class.php | 10 +++++----- .../install/files/lib/system/MetaTagHandler.class.php | 2 +- wcfsetup/install/files/lib/system/WCF.class.php | 4 ++-- .../lib/system/application/IApplication.class.php | 2 +- .../lib/system/attachment/AttachmentHandler.class.php | 2 +- .../lib/system/cache/source/ICacheSource.class.php | 2 +- .../clipboard/action/UserClipboardAction.class.php | 4 ++-- .../action/UserExtendedClipboardAction.class.php | 6 +++--- .../files/lib/system/comment/CommentHandler.class.php | 2 +- .../files/lib/system/database/Database.class.php | 4 ++-- .../system/database/editor/DatabaseEditor.class.php | 2 +- .../files/lib/system/exporter/IExporter.class.php | 6 +++--- .../form/element/AbstractNamedFormElement.class.php | 4 ++-- .../lib/system/image/adapter/IImageAdapter.class.php | 2 +- .../files/lib/system/importer/ImportHandler.class.php | 4 ++-- .../install/files/lib/system/io/IArchive.class.php | 4 ++-- .../object/type/LabelObjectTypeContainer.class.php | 2 +- wcfsetup/install/files/lib/system/mail/Mail.class.php | 4 ++-- .../system/menu/user/IUserMenuItemProvider.class.php | 2 +- .../lib/system/message/quote/QuotedMessage.class.php | 4 ++-- .../moderation/IDeletedContentProvider.class.php | 6 +++--- .../lib/system/option/user/UserOptionHandler.class.php | 4 ++-- .../package/PackageInstallationDispatcher.class.php | 2 +- .../package/PackageInstallationScheduler.class.php | 4 ++-- .../package/PackageUninstallationDispatcher.class.php | 2 +- .../PackageUpdateUnauthorizedException.class.php | 6 +++--- .../ACLOptionPackageInstallationPlugin.class.php | 2 +- .../files/lib/system/request/RequestHandler.class.php | 2 +- .../lib/system/search/SearchIndexManager.class.php | 2 +- .../lib/system/session/ACPSessionFactory.class.php | 2 +- .../files/lib/system/session/SessionHandler.class.php | 6 +++--- .../files/lib/system/style/StyleHandler.class.php | 2 +- .../files/lib/system/tagging/ITaggable.class.php | 2 +- .../files/lib/system/tagging/TagCloud.class.php | 2 +- .../files/lib/system/tagging/TypedTagCloud.class.php | 2 +- .../activity/point/UserActivityPointHandler.class.php | 2 +- .../event/IUserNotificationEvent.class.php | 2 +- wcfsetup/install/files/lib/util/FileUtil.class.php | 2 +- wcfsetup/install/files/lib/util/MessageUtil.class.php | 8 ++++---- wcfsetup/install/files/lib/util/PasswordUtil.class.php | 2 +- wcfsetup/install/files/lib/util/StringStack.class.php | 2 +- 65 files changed, 105 insertions(+), 105 deletions(-) diff --git a/wcfsetup/install/files/acp/js/WCF.ACP.js b/wcfsetup/install/files/acp/js/WCF.ACP.js index 31b6809399..d648f85ade 100644 --- a/wcfsetup/install/files/acp/js/WCF.ACP.js +++ b/wcfsetup/install/files/acp/js/WCF.ACP.js @@ -1562,7 +1562,7 @@ WCF.ACP.Options = Class.extend({ /** * Enables an option. - * + * * @param string target * @param boolean enable */ diff --git a/wcfsetup/install/files/js/WCF.ACL.js b/wcfsetup/install/files/js/WCF.ACL.js index 170ccc3266..dd3dbfe2de 100644 --- a/wcfsetup/install/files/js/WCF.ACL.js +++ b/wcfsetup/install/files/js/WCF.ACL.js @@ -574,7 +574,7 @@ WCF.ACL.List = Class.extend({ /** * Inserts hidden form elements for each value. - * + * * @param string $type */ _save: function($type) { diff --git a/wcfsetup/install/files/js/WCF.Message.js b/wcfsetup/install/files/js/WCF.Message.js index 77dfd789bc..69607320d5 100644 --- a/wcfsetup/install/files/js/WCF.Message.js +++ b/wcfsetup/install/files/js/WCF.Message.js @@ -724,7 +724,7 @@ WCF.Message.QuickReply = Class.extend({ /** * Returns container element. - * + * * @return jQuery */ getContainer: function() { diff --git a/wcfsetup/install/files/js/WCF.js b/wcfsetup/install/files/js/WCF.js index 0b70177c83..0673e53cb0 100755 --- a/wcfsetup/install/files/js/WCF.js +++ b/wcfsetup/install/files/js/WCF.js @@ -168,7 +168,7 @@ $.extend(true, { /** * Escapes an ID to work with jQuery selectors. - * + * * @see http://docs.jquery.com/Frequently_Asked_Questions#How_do_I_select_an_element_by_an_ID_that_has_characters_used_in_CSS_notation.3F * @param string id * @return string @@ -555,7 +555,7 @@ $.extend(WCF, { /** * Counter for dynamic element ids - * + * * @var integer */ _idCounter: 0, @@ -3546,7 +3546,7 @@ WCF.String = { /** * Escapes a String to work with RegExp. - * + * * @see https://github.com/sstephenson/prototype/blob/master/src/prototype/lang/regexp.js#L25 * @param string string * @return string @@ -4053,7 +4053,7 @@ WCF.Template = Class.extend({ /** * Fetches the template with the given variables. - * + * * @param v variables to insert * @return parsed template */ diff --git a/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php b/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php index 08c4f4b4bb..bad60fea1b 100644 --- a/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php +++ b/wcfsetup/install/files/lib/action/AJAXInvokeAction.class.php @@ -151,7 +151,7 @@ class AJAXInvokeAction extends AbstractSecureAction { /** * Throws an previously catched exception while maintaing the propriate stacktrace. - * + * * @param \Exception $e */ protected function throwException(\Exception $e) { @@ -193,7 +193,7 @@ class AJAXInvokeAction extends AbstractSecureAction { /** * Returns action response. - * + * * @return mixed */ public function getResponse() { @@ -210,7 +210,7 @@ class AJAXInvokeAction extends AbstractSecureAction { /** * Performs a debug call to AJAXInvokeAction, allowing testing without relying on JavaScript. * The $data-array should be build like within WCF.Action.Proxy, look below for an example: - * + * * $data = array( * 'actionName' => 'foo', * 'className' => 'wcf\foo\bar\FooBarAction', @@ -222,7 +222,7 @@ class AJAXInvokeAction extends AbstractSecureAction { * ) * ) * ) - * + * * @param array $data * @param string $className * @param string $actionName diff --git a/wcfsetup/install/files/lib/data/IMessageQuickReplyAction.class.php b/wcfsetup/install/files/lib/data/IMessageQuickReplyAction.class.php index b1f059bc1b..c0e48c77c6 100644 --- a/wcfsetup/install/files/lib/data/IMessageQuickReplyAction.class.php +++ b/wcfsetup/install/files/lib/data/IMessageQuickReplyAction.class.php @@ -55,14 +55,14 @@ interface IMessageQuickReplyAction { /** * Creates a new message and returns it. - * + * * @return array */ public function quickReply(); /** * Validates the container object for quick reply. - * + * * @param wcf\data\DatabaseObject $container */ public function validateContainer(DatabaseObject $container); diff --git a/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItem.class.php b/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItem.class.php index 7192396588..29f680c04d 100644 --- a/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItem.class.php +++ b/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItem.class.php @@ -65,7 +65,7 @@ class ACPMenuItem extends DatabaseObject implements ITreeMenuItem { /** * Returns controller name. - * + * * @return string */ public function getController() { @@ -95,7 +95,7 @@ class ACPMenuItem extends DatabaseObject implements ITreeMenuItem { /** * Returns the menu item name. - * + * * @return string */ public function __toString() { diff --git a/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLog.class.php b/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLog.class.php index cdf7444ae6..9e21b59d76 100644 --- a/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLog.class.php +++ b/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLog.class.php @@ -39,7 +39,7 @@ class ACPSessionAccessLog extends DatabaseObject { /** * Returns the ip address and attempts to convert into IPv4. - * + * * @return string */ public function getIpAddress() { diff --git a/wcfsetup/install/files/lib/data/attachment/GroupedAttachmentList.class.php b/wcfsetup/install/files/lib/data/attachment/GroupedAttachmentList.class.php index 7955282820..0ebdcbcc72 100644 --- a/wcfsetup/install/files/lib/data/attachment/GroupedAttachmentList.class.php +++ b/wcfsetup/install/files/lib/data/attachment/GroupedAttachmentList.class.php @@ -65,7 +65,7 @@ class GroupedAttachmentList extends AttachmentList { /** * Sets the permissions for attachment access. - * + * * @param array $permissions */ public function setPermissions(array $permissions) { diff --git a/wcfsetup/install/files/lib/data/bbcode/MessagePreviewAction.class.php b/wcfsetup/install/files/lib/data/bbcode/MessagePreviewAction.class.php index f7b704f87f..35c858a7be 100644 --- a/wcfsetup/install/files/lib/data/bbcode/MessagePreviewAction.class.php +++ b/wcfsetup/install/files/lib/data/bbcode/MessagePreviewAction.class.php @@ -41,7 +41,7 @@ class MessagePreviewAction extends BBCodeAction { /** * Returns a rendered message preview. - * + * * @return array */ public function getMessagePreview() { diff --git a/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php b/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php index 55fa3a3ab5..9156e3bb7b 100644 --- a/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php +++ b/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php @@ -138,7 +138,7 @@ class CommentResponseAction extends AbstractDatabaseObjectAction { /** * Returns parsed responses for given comment id. - * + * * @return array */ public function loadResponses() { diff --git a/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponse.class.php b/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponse.class.php index 222fd4cdd9..2856852828 100644 --- a/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponse.class.php +++ b/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponse.class.php @@ -93,7 +93,7 @@ class StructuredCommentResponse extends DatabaseObjectDecorator { /** * Sets editable state. - * + * * @param boolean $editable */ public function setIsEditable($editable) { @@ -111,7 +111,7 @@ class StructuredCommentResponse extends DatabaseObjectDecorator { /** * Returns true if the response is editable by current user. - * + * * @return boolean */ public function isEditable() { diff --git a/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponseList.class.php b/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponseList.class.php index 4d9f3d6803..611f9a5616 100644 --- a/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponseList.class.php +++ b/wcfsetup/install/files/lib/data/comment/response/StructuredCommentResponseList.class.php @@ -88,7 +88,7 @@ class StructuredCommentResponseList extends CommentResponseList { /** * Fetches the like data. - * + * * @return array */ public function getLikeData() { diff --git a/wcfsetup/install/files/lib/data/label/group/ViewableLabelGroup.class.php b/wcfsetup/install/files/lib/data/label/group/ViewableLabelGroup.class.php index 866875067d..410cd14d2b 100644 --- a/wcfsetup/install/files/lib/data/label/group/ViewableLabelGroup.class.php +++ b/wcfsetup/install/files/lib/data/label/group/ViewableLabelGroup.class.php @@ -70,7 +70,7 @@ class ViewableLabelGroup extends DatabaseObjectDecorator implements \Countable, /** * Sets user permissions. - * + * * @param array $permissions */ public function setUserPermissions(array $permissions) { diff --git a/wcfsetup/install/files/lib/data/object/type/ObjectTypeCache.class.php b/wcfsetup/install/files/lib/data/object/type/ObjectTypeCache.class.php index b4bf125f79..48443347bb 100644 --- a/wcfsetup/install/files/lib/data/object/type/ObjectTypeCache.class.php +++ b/wcfsetup/install/files/lib/data/object/type/ObjectTypeCache.class.php @@ -163,8 +163,8 @@ class ObjectTypeCache extends SingletonFactory { } /** - * Gets the object type id with the given definition name and given name. - * + * Returns the object type id with the given definition name and given name. + * * @param string $definitionName * @param string $objectTypeName * @return integer diff --git a/wcfsetup/install/files/lib/data/package/PackageCache.class.php b/wcfsetup/install/files/lib/data/package/PackageCache.class.php index 16603432a1..be391eb4e9 100644 --- a/wcfsetup/install/files/lib/data/package/PackageCache.class.php +++ b/wcfsetup/install/files/lib/data/package/PackageCache.class.php @@ -43,7 +43,7 @@ class PackageCache extends SingletonFactory { /** * Returns the id of a specific package or 'null' if not found. - * + * * @param string $package * @return string */ diff --git a/wcfsetup/install/files/lib/data/package/update/PackageUpdate.class.php b/wcfsetup/install/files/lib/data/package/update/PackageUpdate.class.php index 8235b066d5..f240e78743 100644 --- a/wcfsetup/install/files/lib/data/package/update/PackageUpdate.class.php +++ b/wcfsetup/install/files/lib/data/package/update/PackageUpdate.class.php @@ -25,7 +25,7 @@ class PackageUpdate extends DatabaseObject { /** * Returns the name of the package the update belongs to. - * + * * @return string */ public function getName() { diff --git a/wcfsetup/install/files/lib/data/package/update/ViewablePackageUpdate.class.php b/wcfsetup/install/files/lib/data/package/update/ViewablePackageUpdate.class.php index 57d9617eb0..a383473767 100644 --- a/wcfsetup/install/files/lib/data/package/update/ViewablePackageUpdate.class.php +++ b/wcfsetup/install/files/lib/data/package/update/ViewablePackageUpdate.class.php @@ -33,7 +33,7 @@ class ViewablePackageUpdate extends DatabaseObjectDecorator { /** * Sets latest accessible package update version object. - * + * * @param wcf\data\package\update\version\PackageUpdateVersion $latestVersion */ public function setAccessibleVersion(PackageUpdateVersion $latestVersion) { @@ -51,7 +51,7 @@ class ViewablePackageUpdate extends DatabaseObjectDecorator { /** * Returns latest accessible package update version object. - * + * * @return wcf\data\package\update\version\PackageUpdateVersion */ public function getAccessibleVersion() { @@ -60,7 +60,7 @@ class ViewablePackageUpdate extends DatabaseObjectDecorator { /** * Returns latest package update version object. - * + * * @return wcf\data\package\update\version\PackageUpdateVersion */ public function getLatestVersion() { diff --git a/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServer.class.php b/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServer.class.php index 0d4d3642ba..c7d1ff7084 100644 --- a/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServer.class.php +++ b/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServer.class.php @@ -119,8 +119,8 @@ class PackageUpdateServer extends DatabaseObject { } /** - * Returns true, if update server requires license data instead of username/password. - * + * Returns true if update server requires license data instead of username/password. + * * @return integer */ public final function requiresLicense() { diff --git a/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php b/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php index 88354b9205..30a4d284ab 100644 --- a/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php +++ b/wcfsetup/install/files/lib/data/smiley/category/SmileyCategory.class.php @@ -62,7 +62,7 @@ class SmileyCategory extends AbstractDecoratedCategory implements \Countable, IT /** * CAUTION: This methods does not return the current iterator index, * rather than the object key which maps to that index. - * + * * @see \Iterator::key() */ public function key() { diff --git a/wcfsetup/install/files/lib/data/tag/Tag.class.php b/wcfsetup/install/files/lib/data/tag/Tag.class.php index c18d9a1457..5948e1decb 100644 --- a/wcfsetup/install/files/lib/data/tag/Tag.class.php +++ b/wcfsetup/install/files/lib/data/tag/Tag.class.php @@ -28,7 +28,7 @@ class Tag extends DatabaseObject implements IRouteController { /** * Return the tag with the given name or null of no such tag exists. - * + * * @param string $name * @param integer $languageID * @return mixed diff --git a/wcfsetup/install/files/lib/data/user/UserAction.class.php b/wcfsetup/install/files/lib/data/user/UserAction.class.php index 07835112d3..870074e0e5 100644 --- a/wcfsetup/install/files/lib/data/user/UserAction.class.php +++ b/wcfsetup/install/files/lib/data/user/UserAction.class.php @@ -425,7 +425,7 @@ class UserAction extends AbstractDatabaseObjectAction implements IClipboardActio /** * Unmarks users. - * + * * @param array $userIDs */ protected function unmarkItems(array $userIDs = array()) { diff --git a/wcfsetup/install/files/lib/data/user/UserProfile.class.php b/wcfsetup/install/files/lib/data/user/UserProfile.class.php index dcc8e9da82..0dc19a54f8 100644 --- a/wcfsetup/install/files/lib/data/user/UserProfile.class.php +++ b/wcfsetup/install/files/lib/data/user/UserProfile.class.php @@ -709,7 +709,7 @@ class UserProfile extends DatabaseObjectDecorator implements IBreadcrumbProvider /** * Returns the formatted value of the user option with the given name. - * + * * @param string $name * @return mixed */ diff --git a/wcfsetup/install/files/lib/data/user/avatar/IUserAvatar.class.php b/wcfsetup/install/files/lib/data/user/avatar/IUserAvatar.class.php index d17f45f85e..956fcb7a9a 100644 --- a/wcfsetup/install/files/lib/data/user/avatar/IUserAvatar.class.php +++ b/wcfsetup/install/files/lib/data/user/avatar/IUserAvatar.class.php @@ -37,7 +37,7 @@ interface IUserAvatar { /** * Returns the width of this avatar. - * + * * @return integer */ public function getWidth(); diff --git a/wcfsetup/install/files/lib/page/ITrackablePage.class.php b/wcfsetup/install/files/lib/page/ITrackablePage.class.php index 12b394e4e4..9c4219ec6c 100644 --- a/wcfsetup/install/files/lib/page/ITrackablePage.class.php +++ b/wcfsetup/install/files/lib/page/ITrackablePage.class.php @@ -21,35 +21,35 @@ interface ITrackablePage { /** * Returns the controller name. - * + * * @return string */ public function getController(); /** * Returns the parent object type. - * + * * @return string */ public function getParentObjectType(); /** * Returns the parent object id. - * + * * @return integer */ public function getParentObjectID(); /** * Returns the object type. - * + * * @return string */ public function getObjectType(); /** * Returns the object id. - * + * * @return integer */ public function getObjectID(); diff --git a/wcfsetup/install/files/lib/system/MetaTagHandler.class.php b/wcfsetup/install/files/lib/system/MetaTagHandler.class.php index 8f9a974aef..d8c775bdfd 100644 --- a/wcfsetup/install/files/lib/system/MetaTagHandler.class.php +++ b/wcfsetup/install/files/lib/system/MetaTagHandler.class.php @@ -110,7 +110,7 @@ class MetaTagHandler extends SingletonFactory implements \Countable, \Iterator { /** * CAUTION: This methods does not return the current iterator index, * rather than the object key which maps to that index. - * + * * @see \Iterator::key() */ public function key() { diff --git a/wcfsetup/install/files/lib/system/WCF.class.php b/wcfsetup/install/files/lib/system/WCF.class.php index b6542d283b..631bd46f05 100644 --- a/wcfsetup/install/files/lib/system/WCF.class.php +++ b/wcfsetup/install/files/lib/system/WCF.class.php @@ -570,7 +570,7 @@ class WCF { /** * Includes the required util or exception classes automatically. - * + * * @param string $className * @see spl_autoload_register() */ @@ -703,7 +703,7 @@ class WCF { /** * Returns the URI of the current page. - * + * * @return string */ public static function getRequestURI() { diff --git a/wcfsetup/install/files/lib/system/application/IApplication.class.php b/wcfsetup/install/files/lib/system/application/IApplication.class.php index bda46bc009..bde7c7d439 100644 --- a/wcfsetup/install/files/lib/system/application/IApplication.class.php +++ b/wcfsetup/install/files/lib/system/application/IApplication.class.php @@ -19,7 +19,7 @@ interface IApplication { /** * Returns true if current application is treated as active and was invoked directly. - * + * * @return boolean */ public function isActiveApplication(); diff --git a/wcfsetup/install/files/lib/system/attachment/AttachmentHandler.class.php b/wcfsetup/install/files/lib/system/attachment/AttachmentHandler.class.php index b617c98c0e..4e5c5f2132 100644 --- a/wcfsetup/install/files/lib/system/attachment/AttachmentHandler.class.php +++ b/wcfsetup/install/files/lib/system/attachment/AttachmentHandler.class.php @@ -200,7 +200,7 @@ class AttachmentHandler implements \Countable { /** * Returns true if the active user has the permission to upload attachments. - * + * * @return boolean */ public function canUpload() { diff --git a/wcfsetup/install/files/lib/system/cache/source/ICacheSource.class.php b/wcfsetup/install/files/lib/system/cache/source/ICacheSource.class.php index dd4b8afa1f..e8260dca86 100644 --- a/wcfsetup/install/files/lib/system/cache/source/ICacheSource.class.php +++ b/wcfsetup/install/files/lib/system/cache/source/ICacheSource.class.php @@ -14,7 +14,7 @@ namespace wcf\system\cache\source; interface ICacheSource { /** * Flushes a specific cache, optionally removing caches which share the same name. - * + * * @param string $cacheName * @param boolean $useWildcard */ diff --git a/wcfsetup/install/files/lib/system/clipboard/action/UserClipboardAction.class.php b/wcfsetup/install/files/lib/system/clipboard/action/UserClipboardAction.class.php index 61e0f3532f..89bbc05a56 100644 --- a/wcfsetup/install/files/lib/system/clipboard/action/UserClipboardAction.class.php +++ b/wcfsetup/install/files/lib/system/clipboard/action/UserClipboardAction.class.php @@ -91,7 +91,7 @@ class UserClipboardAction extends AbstractClipboardAction { /** * Returns the ids of the users which can be banned. - * + * * @return array */ protected function validateBan() { @@ -105,7 +105,7 @@ class UserClipboardAction extends AbstractClipboardAction { /** * Validates accessible groups. - * + * * @return array */ protected function __validateAccessibleGroups(array $userIDs, $ignoreOwnUser = true) { diff --git a/wcfsetup/install/files/lib/system/clipboard/action/UserExtendedClipboardAction.class.php b/wcfsetup/install/files/lib/system/clipboard/action/UserExtendedClipboardAction.class.php index 25e9a644e0..adc9dd826d 100644 --- a/wcfsetup/install/files/lib/system/clipboard/action/UserExtendedClipboardAction.class.php +++ b/wcfsetup/install/files/lib/system/clipboard/action/UserExtendedClipboardAction.class.php @@ -56,7 +56,7 @@ class UserExtendedClipboardAction extends AbstractClipboardAction { /** * Returns the ids of the users which can be enabled. - * + * * @return array */ protected function validateEnable() { @@ -64,7 +64,7 @@ class UserExtendedClipboardAction extends AbstractClipboardAction { if (!WCF::getSession()->getPermission('admin.user.canEnableUser')) { return array(); } - + $userIDs = array(); foreach ($this->objects as $user) { if ($user->activationCode) $userIDs[] = $user->userID; @@ -75,7 +75,7 @@ class UserExtendedClipboardAction extends AbstractClipboardAction { /** * Returns the ids of the users which can be merge. - * + * * @return array */ protected function validateMerge() { diff --git a/wcfsetup/install/files/lib/system/comment/CommentHandler.class.php b/wcfsetup/install/files/lib/system/comment/CommentHandler.class.php index 65b2a68d26..bf4c06453a 100644 --- a/wcfsetup/install/files/lib/system/comment/CommentHandler.class.php +++ b/wcfsetup/install/files/lib/system/comment/CommentHandler.class.php @@ -111,7 +111,7 @@ class CommentHandler extends SingletonFactory { /** * Removes all comments for given objects. - * + * * @param string $objectType * @param array $objectIDs */ diff --git a/wcfsetup/install/files/lib/system/database/Database.class.php b/wcfsetup/install/files/lib/system/database/Database.class.php index 6b295da8f7..d09922dd64 100644 --- a/wcfsetup/install/files/lib/system/database/Database.class.php +++ b/wcfsetup/install/files/lib/system/database/Database.class.php @@ -346,7 +346,7 @@ abstract class Database { /** * Returns a database editor object. - * + * * @return wcf\system\database\editor\DatabaseEditor */ public function getEditor() { @@ -359,7 +359,7 @@ abstract class Database { /** * Returns true if this database type is supported. - * + * * @return boolean */ public static function isSupported() { diff --git a/wcfsetup/install/files/lib/system/database/editor/DatabaseEditor.class.php b/wcfsetup/install/files/lib/system/database/editor/DatabaseEditor.class.php index 0d4228ed40..0c1082f1d2 100644 --- a/wcfsetup/install/files/lib/system/database/editor/DatabaseEditor.class.php +++ b/wcfsetup/install/files/lib/system/database/editor/DatabaseEditor.class.php @@ -21,7 +21,7 @@ abstract class DatabaseEditor { /** * Creates a new DatabaseEditor object. - * + * * @param wcf\system\database\Database $dbObj */ public function __construct(Database $dbObj) { diff --git a/wcfsetup/install/files/lib/system/exporter/IExporter.class.php b/wcfsetup/install/files/lib/system/exporter/IExporter.class.php index 9d6f623db6..6fe100b2a5 100644 --- a/wcfsetup/install/files/lib/system/exporter/IExporter.class.php +++ b/wcfsetup/install/files/lib/system/exporter/IExporter.class.php @@ -40,7 +40,7 @@ interface IExporter { /** * Runs the data export. - * + * * @param string $objectType * @param integer $loopCount */ @@ -48,14 +48,14 @@ interface IExporter { /** * Validates database access. - * + * * @throws wcf\system\database\DatabaseException */ public function validateDatabaseAccess(); /** * Validates given file system path. Returns false on failure. - * + * * @return boolean */ public function validateFileAccess(); diff --git a/wcfsetup/install/files/lib/system/form/element/AbstractNamedFormElement.class.php b/wcfsetup/install/files/lib/system/form/element/AbstractNamedFormElement.class.php index bd190d2823..4cd3d40b81 100644 --- a/wcfsetup/install/files/lib/system/form/element/AbstractNamedFormElement.class.php +++ b/wcfsetup/install/files/lib/system/form/element/AbstractNamedFormElement.class.php @@ -33,7 +33,7 @@ abstract class AbstractNamedFormElement extends AbstractFormElement { /** * Sets element description. - * + * * @param string $description */ public function setDescription($description) { @@ -42,7 +42,7 @@ abstract class AbstractNamedFormElement extends AbstractFormElement { /** * Returns element description. - * + * * @return string */ public function getDescription() { diff --git a/wcfsetup/install/files/lib/system/image/adapter/IImageAdapter.class.php b/wcfsetup/install/files/lib/system/image/adapter/IImageAdapter.class.php index ddb0b66176..e9f516d3fa 100644 --- a/wcfsetup/install/files/lib/system/image/adapter/IImageAdapter.class.php +++ b/wcfsetup/install/files/lib/system/image/adapter/IImageAdapter.class.php @@ -112,7 +112,7 @@ interface IImageAdapter { /** * Sets a color to be transparent with alpha 0. - * + * * @param integer $red * @param integer $green * @param integer $blue diff --git a/wcfsetup/install/files/lib/system/importer/ImportHandler.class.php b/wcfsetup/install/files/lib/system/importer/ImportHandler.class.php index 9cba3e7804..81b97b1bf5 100644 --- a/wcfsetup/install/files/lib/system/importer/ImportHandler.class.php +++ b/wcfsetup/install/files/lib/system/importer/ImportHandler.class.php @@ -81,8 +81,8 @@ class ImportHandler extends SingletonFactory implements IAJAXInvokeAction { } /** - * Gets a new id from id mapping. - * + * Returns a new id from id mapping. + * * @param string $type * @param mixed $oldID * @return integer $newID diff --git a/wcfsetup/install/files/lib/system/io/IArchive.class.php b/wcfsetup/install/files/lib/system/io/IArchive.class.php index 8eaa71cdfe..c4ae6b9323 100644 --- a/wcfsetup/install/files/lib/system/io/IArchive.class.php +++ b/wcfsetup/install/files/lib/system/io/IArchive.class.php @@ -22,7 +22,7 @@ interface IArchive { /** * Returns an associative array with information about a specific file * in the archive. - * + * * @param mixed $index index or name of the requested file * @return array */ @@ -50,7 +50,7 @@ interface IArchive { /** * Searchs a file in the archive and returns the numeric file index. * Returns false if not found. - * + * * @param string $filename * @return integer index of the requested file */ diff --git a/wcfsetup/install/files/lib/system/label/object/type/LabelObjectTypeContainer.class.php b/wcfsetup/install/files/lib/system/label/object/type/LabelObjectTypeContainer.class.php index 17f1dea53d..276efa5bbe 100644 --- a/wcfsetup/install/files/lib/system/label/object/type/LabelObjectTypeContainer.class.php +++ b/wcfsetup/install/files/lib/system/label/object/type/LabelObjectTypeContainer.class.php @@ -76,7 +76,7 @@ class LabelObjectTypeContainer implements \Countable, \Iterator { /** * Returns the object type name. - * + * * @return string */ public function getObjectTypeName() { diff --git a/wcfsetup/install/files/lib/system/mail/Mail.class.php b/wcfsetup/install/files/lib/system/mail/Mail.class.php index 7369a00a29..72abb862db 100644 --- a/wcfsetup/install/files/lib/system/mail/Mail.class.php +++ b/wcfsetup/install/files/lib/system/mail/Mail.class.php @@ -521,8 +521,8 @@ class Mail { } /** - * Gets the mail language. - * + * Returns the mail language. + * * @return wcf\data\language\Language */ public function getLanguage() { diff --git a/wcfsetup/install/files/lib/system/menu/user/IUserMenuItemProvider.class.php b/wcfsetup/install/files/lib/system/menu/user/IUserMenuItemProvider.class.php index 5e371dcc4a..0e12feb407 100644 --- a/wcfsetup/install/files/lib/system/menu/user/IUserMenuItemProvider.class.php +++ b/wcfsetup/install/files/lib/system/menu/user/IUserMenuItemProvider.class.php @@ -22,7 +22,7 @@ interface IUserMenuItemProvider extends IDatabaseObjectProcessor { /** * Returns the href of the associated menu item. - * + * * @return string */ public function getLink(); diff --git a/wcfsetup/install/files/lib/system/message/quote/QuotedMessage.class.php b/wcfsetup/install/files/lib/system/message/quote/QuotedMessage.class.php index 58d338009f..b56a72aae9 100644 --- a/wcfsetup/install/files/lib/system/message/quote/QuotedMessage.class.php +++ b/wcfsetup/install/files/lib/system/message/quote/QuotedMessage.class.php @@ -85,7 +85,7 @@ class QuotedMessage implements \Countable, \Iterator { /** * Returns the full quote by quote id. - * + * * @param string $quoteID * @return string */ @@ -115,7 +115,7 @@ class QuotedMessage implements \Countable, \Iterator { /** * CAUTION: This methods does not return the current iterator index, * rather than the object key which maps to that index. - * + * * @see \Iterator::key() */ public function key() { diff --git a/wcfsetup/install/files/lib/system/moderation/IDeletedContentProvider.class.php b/wcfsetup/install/files/lib/system/moderation/IDeletedContentProvider.class.php index 0fcba26992..a679d6b7fd 100644 --- a/wcfsetup/install/files/lib/system/moderation/IDeletedContentProvider.class.php +++ b/wcfsetup/install/files/lib/system/moderation/IDeletedContentProvider.class.php @@ -14,21 +14,21 @@ namespace wcf\system\moderation; interface IDeletedContentProvider { /** * Returns a list of deleted content. - * + * * @return wcf\data\DatabaseObjectList */ public function getObjectList(); /** * Returns the template name for the result output. - * + * * @return string */ public function getTemplateName(); /** * Returns the application of the result template. - * + * * @return string */ public function getApplication(); diff --git a/wcfsetup/install/files/lib/system/option/user/UserOptionHandler.class.php b/wcfsetup/install/files/lib/system/option/user/UserOptionHandler.class.php index 3d8761031d..3b3845f714 100644 --- a/wcfsetup/install/files/lib/system/option/user/UserOptionHandler.class.php +++ b/wcfsetup/install/files/lib/system/option/user/UserOptionHandler.class.php @@ -72,7 +72,7 @@ class UserOptionHandler extends OptionHandler { /** * Enables edit mode. - * + * * @param boolean $enable */ public function enableEditMode($enable = true) { @@ -81,7 +81,7 @@ class UserOptionHandler extends OptionHandler { /** * Enables search mode. - * + * * @param boolean $enable */ public function enableSearchMode($enable = true) { diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php index 2ebc9fcd5f..5b8bca90be 100644 --- a/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php @@ -99,7 +99,7 @@ class PackageInstallationDispatcher { /** * Creates a new instance of PackageInstallationDispatcher. - * + * * @param wcf\data\package\installation\queue\PackageInstallationQueue $queue */ public function __construct(PackageInstallationQueue $queue) { diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php index 752049d43c..488b0b811d 100644 --- a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php @@ -526,7 +526,7 @@ class PackageInstallationScheduler { /** * Determines intermediate update steps using a backtracking algorithm in case there is no direct upgrade possible. - * + * * @param string $package package identifier * @param array $fromversions list of all fromversions * @param string $currentVersion current package version @@ -579,7 +579,7 @@ class PackageInstallationScheduler { /** * Compares the length of two updates threads. - * + * * @param array $updateThreadListA * @param array $updateThreadListB * @return integer diff --git a/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php b/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php index 7842e57574..dd3bdd781b 100644 --- a/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageUninstallationDispatcher.class.php @@ -31,7 +31,7 @@ use wcf\system\WCF; class PackageUninstallationDispatcher extends PackageInstallationDispatcher { /** * Creates a new instance of PackageUninstallationDispatcher. - * + * * @param wcf\data\package\installation\queue\PackageInstallationQueue $queue */ public function __construct(PackageInstallationQueue $queue) { diff --git a/wcfsetup/install/files/lib/system/package/PackageUpdateUnauthorizedException.class.php b/wcfsetup/install/files/lib/system/package/PackageUpdateUnauthorizedException.class.php index 9d970edde7..9ae7c2d168 100644 --- a/wcfsetup/install/files/lib/system/package/PackageUpdateUnauthorizedException.class.php +++ b/wcfsetup/install/files/lib/system/package/PackageUpdateUnauthorizedException.class.php @@ -65,7 +65,7 @@ class PackageUpdateUnauthorizedException extends UserException { /** * Returns package update version. - * + * * @return array */ public function getPackageUpdateVersion() { @@ -74,7 +74,7 @@ class PackageUpdateUnauthorizedException extends UserException { /** * Returns the HTTP request object. - * + * * @return wcf\util\HTTPRequest */ public function getRequest() { @@ -83,7 +83,7 @@ class PackageUpdateUnauthorizedException extends UserException { /** * Returns package update server object. - * + * * @return wcf\data\package\update\server\PackageUpdateServer */ public function getUpdateServer() { diff --git a/wcfsetup/install/files/lib/system/package/plugin/ACLOptionPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/ACLOptionPackageInstallationPlugin.class.php index 40544f253c..a8b75b96ff 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/ACLOptionPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/ACLOptionPackageInstallationPlugin.class.php @@ -88,7 +88,7 @@ class ACLOptionPackageInstallationPlugin extends AbstractOptionPackageInstallati /** * Imports options. - * + * * @param \DOMXPath $xpath */ protected function importOptions(\DOMXPath $xpath) { diff --git a/wcfsetup/install/files/lib/system/request/RequestHandler.class.php b/wcfsetup/install/files/lib/system/request/RequestHandler.class.php index 43950bcf86..7ecf6e53ef 100644 --- a/wcfsetup/install/files/lib/system/request/RequestHandler.class.php +++ b/wcfsetup/install/files/lib/system/request/RequestHandler.class.php @@ -61,7 +61,7 @@ class RequestHandler extends SingletonFactory { /** * Handles a http request. - * + * * @param string $application * @param boolean $isACPRequest */ diff --git a/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php b/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php index 358ba5005a..f63f90a4ec 100644 --- a/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php +++ b/wcfsetup/install/files/lib/system/search/SearchIndexManager.class.php @@ -46,7 +46,7 @@ class SearchIndexManager extends SingletonFactory { /** * Adds a new entry. - * + * * @param string $objectType * @param integer $objectID * @param string $message diff --git a/wcfsetup/install/files/lib/system/session/ACPSessionFactory.class.php b/wcfsetup/install/files/lib/system/session/ACPSessionFactory.class.php index 7ceed90622..c17e9dce64 100644 --- a/wcfsetup/install/files/lib/system/session/ACPSessionFactory.class.php +++ b/wcfsetup/install/files/lib/system/session/ACPSessionFactory.class.php @@ -50,7 +50,7 @@ class ACPSessionFactory { /** * Returns the session id from request (GET/POST). Returns an empty string, * if no session id was given. - * + * * @return string */ protected function readSessionID() { diff --git a/wcfsetup/install/files/lib/system/session/SessionHandler.class.php b/wcfsetup/install/files/lib/system/session/SessionHandler.class.php index d04bb57335..75573f68ae 100644 --- a/wcfsetup/install/files/lib/system/session/SessionHandler.class.php +++ b/wcfsetup/install/files/lib/system/session/SessionHandler.class.php @@ -432,7 +432,7 @@ class SessionHandler extends SingletonFactory { /** * Returns language ids for active user. - * + * * @return array */ public function getLanguageIDs() { @@ -631,7 +631,7 @@ class SessionHandler extends SingletonFactory { /** * Returns the spider id for given user agent. - * + * * @param string $userAgent * @return mixed */ @@ -650,7 +650,7 @@ class SessionHandler extends SingletonFactory { /** * Searches for existing session of a search spider. - * + * * @param integer $spiderID * @return wcf\data\session\Session */ diff --git a/wcfsetup/install/files/lib/system/style/StyleHandler.class.php b/wcfsetup/install/files/lib/system/style/StyleHandler.class.php index 6240793d49..94b8acedc7 100644 --- a/wcfsetup/install/files/lib/system/style/StyleHandler.class.php +++ b/wcfsetup/install/files/lib/system/style/StyleHandler.class.php @@ -58,7 +58,7 @@ class StyleHandler extends SingletonFactory { /** * Returns a list of all styles. - * + * * @return array */ public function getStyles() { diff --git a/wcfsetup/install/files/lib/system/tagging/ITaggable.class.php b/wcfsetup/install/files/lib/system/tagging/ITaggable.class.php index 32b7303c61..b34f21615a 100644 --- a/wcfsetup/install/files/lib/system/tagging/ITaggable.class.php +++ b/wcfsetup/install/files/lib/system/tagging/ITaggable.class.php @@ -30,7 +30,7 @@ interface ITaggable { /** * Returns the application of the result template. - * + * * @return string */ public function getApplication(); diff --git a/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php b/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php index 84b18ff19c..6ecc25d560 100644 --- a/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php +++ b/wcfsetup/install/files/lib/system/tagging/TagCloud.class.php @@ -52,7 +52,7 @@ class TagCloud { /** * Contructs a new TagCloud object. - * + * * @param array $languageIDs */ public function __construct(array $languageIDs = array()) { diff --git a/wcfsetup/install/files/lib/system/tagging/TypedTagCloud.class.php b/wcfsetup/install/files/lib/system/tagging/TypedTagCloud.class.php index 53f3675bbf..cbbf02ac97 100644 --- a/wcfsetup/install/files/lib/system/tagging/TypedTagCloud.class.php +++ b/wcfsetup/install/files/lib/system/tagging/TypedTagCloud.class.php @@ -22,7 +22,7 @@ class TypedTagCloud extends TagCloud { /** * Contructs a new TypedTagCloud object. - * + * * @param string $objectType * @param array $languageIDs */ diff --git a/wcfsetup/install/files/lib/system/user/activity/point/UserActivityPointHandler.class.php b/wcfsetup/install/files/lib/system/user/activity/point/UserActivityPointHandler.class.php index 22dab01c05..d1a87c7c7e 100644 --- a/wcfsetup/install/files/lib/system/user/activity/point/UserActivityPointHandler.class.php +++ b/wcfsetup/install/files/lib/system/user/activity/point/UserActivityPointHandler.class.php @@ -176,7 +176,7 @@ class UserActivityPointHandler extends SingletonFactory { /** * Updates total activity points and ranks for given user ids. - * + * * @param array $userIDs */ public function updateUsers(array $userIDs) { diff --git a/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php b/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php index 5da5015c6e..3f29ed406a 100644 --- a/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php +++ b/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php @@ -47,7 +47,7 @@ interface IUserNotificationEvent extends IDatabaseObjectProcessor { /** * Returns the message for this notification event. - * + * * @param string $notificationType * @return string */ diff --git a/wcfsetup/install/files/lib/util/FileUtil.class.php b/wcfsetup/install/files/lib/util/FileUtil.class.php index 66ad302197..5fc07f5d8d 100644 --- a/wcfsetup/install/files/lib/util/FileUtil.class.php +++ b/wcfsetup/install/files/lib/util/FileUtil.class.php @@ -103,7 +103,7 @@ final class FileUtil { /** * Removes a leading slash from the given path. - * + * * @param string $path * @return string */ diff --git a/wcfsetup/install/files/lib/util/MessageUtil.class.php b/wcfsetup/install/files/lib/util/MessageUtil.class.php index d9b5d5be1c..1b3b31aea7 100644 --- a/wcfsetup/install/files/lib/util/MessageUtil.class.php +++ b/wcfsetup/install/files/lib/util/MessageUtil.class.php @@ -42,7 +42,7 @@ class MessageUtil { } /** - * Gets mentioned users. + * Returns the mentioned users in the given text. * * @param string $text * @return array @@ -80,8 +80,8 @@ class MessageUtil { } /** - * Gets quoted users. - * + * Returns the quoted users in the given text. + * * @param string $text * @return array */ @@ -108,7 +108,7 @@ class MessageUtil { /** * Truncates a formatted message and keeps the HTML syntax intact. - * + * * @param string $message string which shall be truncated * @param integer $maxLength string length after truncating * @return string truncated string diff --git a/wcfsetup/install/files/lib/util/PasswordUtil.class.php b/wcfsetup/install/files/lib/util/PasswordUtil.class.php index 1bd97c4247..453f831ee1 100644 --- a/wcfsetup/install/files/lib/util/PasswordUtil.class.php +++ b/wcfsetup/install/files/lib/util/PasswordUtil.class.php @@ -321,7 +321,7 @@ final class PasswordUtil { /** * Validates the password hash for MyBB 1.x (mybb1). - * + * * @param string $username * @param string $password * @param string $salt diff --git a/wcfsetup/install/files/lib/util/StringStack.class.php b/wcfsetup/install/files/lib/util/StringStack.class.php index cd8f34ce86..d3a880ec8f 100644 --- a/wcfsetup/install/files/lib/util/StringStack.class.php +++ b/wcfsetup/install/files/lib/util/StringStack.class.php @@ -45,7 +45,7 @@ final class StringStack { /** * Reinserts strings that have been replaced by unique hash values. - * + * * @param string $string * @param string $type * @return string -- 2.20.1