From 1d5f9363dba9edc1f022ba0a7bc1d530514b71f5 Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Sun, 22 May 2016 09:35:34 +0200 Subject: [PATCH] Add missing method and class PHPDoc comments --- .../install/files/lib/system/email/EmailGrammar.class.php | 7 ++++++- .../metacode/converter/AbstractMetacodeConverter.class.php | 4 ++++ .../metacode/converter/ColorMetacodeConverter.class.php | 4 ++++ .../html/metacode/converter/IMetacodeConverter.class.php | 4 ++++ .../metacode/converter/QuoteMetacodeConverter.class.php | 4 ++++ .../files/lib/system/html/node/AbstractHtmlNode.class.php | 4 ++++ .../install/files/lib/system/html/node/IHtmlNode.class.php | 4 ++++ wcfsetup/install/files/lib/util/ArrayUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/CLIUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/ClassUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/CronjobUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/CryptoUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/DOMUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/DateUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/DirectoryUtil.class.php | 4 +++- wcfsetup/install/files/lib/util/ExifUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/FileUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/HeaderUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/ImageUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/JSON.class.php | 7 ++++++- wcfsetup/install/files/lib/util/MathUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/OptionUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/PasswordUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/StringStack.class.php | 7 ++++++- wcfsetup/install/files/lib/util/StringUtil.class.php | 7 ++++++- wcfsetup/install/files/lib/util/StyleUtil.class.php | 7 ++++++- .../install/files/lib/util/UserRegistrationUtil.class.php | 6 ++++-- wcfsetup/install/files/lib/util/UserUtil.class.php | 7 ++++++- 28 files changed, 151 insertions(+), 23 deletions(-) diff --git a/wcfsetup/install/files/lib/system/email/EmailGrammar.class.php b/wcfsetup/install/files/lib/system/email/EmailGrammar.class.php index 7764cc65b3..9f758b368e 100644 --- a/wcfsetup/install/files/lib/system/email/EmailGrammar.class.php +++ b/wcfsetup/install/files/lib/system/email/EmailGrammar.class.php @@ -109,5 +109,10 @@ final class EmailGrammar { return $header; } - private function __construct() { } + /** + * Forbid creation of EmailGrammer objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/system/html/metacode/converter/AbstractMetacodeConverter.class.php b/wcfsetup/install/files/lib/system/html/metacode/converter/AbstractMetacodeConverter.class.php index fabe3616d0..141e5793ba 100644 --- a/wcfsetup/install/files/lib/system/html/metacode/converter/AbstractMetacodeConverter.class.php +++ b/wcfsetup/install/files/lib/system/html/metacode/converter/AbstractMetacodeConverter.class.php @@ -1,6 +1,10 @@ format('W') == 53 ? 53 : 52); } - private function __construct() { } + /** + * Forbid creation of DateUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/DirectoryUtil.class.php b/wcfsetup/install/files/lib/util/DirectoryUtil.class.php index b9bda42484..2347edf6b1 100644 --- a/wcfsetup/install/files/lib/util/DirectoryUtil.class.php +++ b/wcfsetup/install/files/lib/util/DirectoryUtil.class.php @@ -113,7 +113,9 @@ final class DirectoryUtil { /** * @see \wcf\util\DirectoryUtil::getInstance() */ - private final function __clone() {} + private final function __clone() { + // does nothing + } /** * Returns a sorted list of files. diff --git a/wcfsetup/install/files/lib/util/ExifUtil.class.php b/wcfsetup/install/files/lib/util/ExifUtil.class.php index bc0f839008..ff602a4414 100644 --- a/wcfsetup/install/files/lib/util/ExifUtil.class.php +++ b/wcfsetup/install/files/lib/util/ExifUtil.class.php @@ -68,7 +68,12 @@ final class ExifUtil { */ const ORIENTATION_270_ROTATE = 8; - private function __construct() { } + /** + * Forbid creation of ExifUtil objects. + */ + private function __construct() { + // does nothing + } /** * Returns the exif data of the image at the given location or an empty diff --git a/wcfsetup/install/files/lib/util/FileUtil.class.php b/wcfsetup/install/files/lib/util/FileUtil.class.php index 68465632a1..8b5764489a 100644 --- a/wcfsetup/install/files/lib/util/FileUtil.class.php +++ b/wcfsetup/install/files/lib/util/FileUtil.class.php @@ -696,5 +696,10 @@ final class FileUtil { return 'fa-file-o'; } - private function __construct() { } + /** + * Forbid creation of FileUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/HeaderUtil.class.php b/wcfsetup/install/files/lib/util/HeaderUtil.class.php index dcdca1b592..1eb16d5c6e 100644 --- a/wcfsetup/install/files/lib/util/HeaderUtil.class.php +++ b/wcfsetup/install/files/lib/util/HeaderUtil.class.php @@ -174,5 +174,10 @@ final class HeaderUtil { WCF::getTPL()->display('redirect'); } - private function __construct() { } + /** + * Forbid creation of HeaderUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/ImageUtil.class.php b/wcfsetup/install/files/lib/util/ImageUtil.class.php index 958747c8df..ed400834b8 100644 --- a/wcfsetup/install/files/lib/util/ImageUtil.class.php +++ b/wcfsetup/install/files/lib/util/ImageUtil.class.php @@ -62,5 +62,10 @@ final class ImageUtil { } } - private function __construct() { } + /** + * Forbid creation of ImageUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/JSON.class.php b/wcfsetup/install/files/lib/util/JSON.class.php index e1fb31e2f8..81532e71d0 100644 --- a/wcfsetup/install/files/lib/util/JSON.class.php +++ b/wcfsetup/install/files/lib/util/JSON.class.php @@ -51,5 +51,10 @@ final class JSON { return json_last_error(); } - private function __construct() { } + /** + * Forbid creation of JSON objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/MathUtil.class.php b/wcfsetup/install/files/lib/util/MathUtil.class.php index f523b48937..7524aa131c 100644 --- a/wcfsetup/install/files/lib/util/MathUtil.class.php +++ b/wcfsetup/install/files/lib/util/MathUtil.class.php @@ -43,5 +43,10 @@ final class MathUtil { ]; } - private function __construct() { } + /** + * Forbid creation of MathUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/OptionUtil.class.php b/wcfsetup/install/files/lib/util/OptionUtil.class.php index f77980141d..ccc86b9096 100644 --- a/wcfsetup/install/files/lib/util/OptionUtil.class.php +++ b/wcfsetup/install/files/lib/util/OptionUtil.class.php @@ -64,5 +64,10 @@ final class OptionUtil { return $result; } - private function __construct() { } + /** + * Forbid creation of OptionUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/PasswordUtil.class.php b/wcfsetup/install/files/lib/util/PasswordUtil.class.php index ba2b057238..320c52a560 100644 --- a/wcfsetup/install/files/lib/util/PasswordUtil.class.php +++ b/wcfsetup/install/files/lib/util/PasswordUtil.class.php @@ -699,5 +699,10 @@ final class PasswordUtil { return false; } - private function __construct() { } + /** + * Forbid creation of PasswordUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/StringStack.class.php b/wcfsetup/install/files/lib/util/StringStack.class.php index a0c52c8bf1..03203cda75 100644 --- a/wcfsetup/install/files/lib/util/StringStack.class.php +++ b/wcfsetup/install/files/lib/util/StringStack.class.php @@ -79,5 +79,10 @@ final class StringStack { return []; } - private function __construct() { } + /** + * Forbid creation of StringStack objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/StringUtil.class.php b/wcfsetup/install/files/lib/util/StringUtil.class.php index 9b89367427..648f2513e8 100644 --- a/wcfsetup/install/files/lib/util/StringUtil.class.php +++ b/wcfsetup/install/files/lib/util/StringUtil.class.php @@ -719,5 +719,10 @@ final class StringUtil { return $result; } - private function __construct() { } + /** + * Forbid creation of StringUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/StyleUtil.class.php b/wcfsetup/install/files/lib/util/StyleUtil.class.php index 4b2bc93dfb..52bb437970 100644 --- a/wcfsetup/install/files/lib/util/StyleUtil.class.php +++ b/wcfsetup/install/files/lib/util/StyleUtil.class.php @@ -132,5 +132,10 @@ final class StyleUtil { StyleCompiler::getInstance()->compileACP(); } - private function __construct() { } + /** + * Forbid creation of StyleUtil objects. + */ + private function __construct() { + // does nothing + } } diff --git a/wcfsetup/install/files/lib/util/UserRegistrationUtil.class.php b/wcfsetup/install/files/lib/util/UserRegistrationUtil.class.php index ae51a02c0f..6d626ed4f3 100644 --- a/wcfsetup/install/files/lib/util/UserRegistrationUtil.class.php +++ b/wcfsetup/install/files/lib/util/UserRegistrationUtil.class.php @@ -13,9 +13,11 @@ namespace wcf\util; */ final class UserRegistrationUtil { /** - * Disables creation of objects of this class. + * Forbid creation of StringUtil objects. */ - private function __construct() { } + private function __construct() { + // does nothing + } /** * Returns true if the given name is a valid username. diff --git a/wcfsetup/install/files/lib/util/UserUtil.class.php b/wcfsetup/install/files/lib/util/UserUtil.class.php index 1aacff9d8f..b468f0414d 100644 --- a/wcfsetup/install/files/lib/util/UserUtil.class.php +++ b/wcfsetup/install/files/lib/util/UserUtil.class.php @@ -270,5 +270,10 @@ final class UserUtil { return mb_substr(FileUtil::unifyDirSeparator($REQUEST_URI), 0, 255); } - private function __construct() { } + /** + * Forbid creation of UserUtil objects. + */ + private function __construct() { + // does nothing + } } -- 2.20.1