Add missing method and class PHPDoc comments
authorMatthias Schmidt <gravatronics@live.com>
Sun, 22 May 2016 07:35:34 +0000 (09:35 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Sun, 22 May 2016 07:35:34 +0000 (09:35 +0200)
28 files changed:
wcfsetup/install/files/lib/system/email/EmailGrammar.class.php
wcfsetup/install/files/lib/system/html/metacode/converter/AbstractMetacodeConverter.class.php
wcfsetup/install/files/lib/system/html/metacode/converter/ColorMetacodeConverter.class.php
wcfsetup/install/files/lib/system/html/metacode/converter/IMetacodeConverter.class.php
wcfsetup/install/files/lib/system/html/metacode/converter/QuoteMetacodeConverter.class.php
wcfsetup/install/files/lib/system/html/node/AbstractHtmlNode.class.php
wcfsetup/install/files/lib/system/html/node/IHtmlNode.class.php
wcfsetup/install/files/lib/util/ArrayUtil.class.php
wcfsetup/install/files/lib/util/CLIUtil.class.php
wcfsetup/install/files/lib/util/ClassUtil.class.php
wcfsetup/install/files/lib/util/CronjobUtil.class.php
wcfsetup/install/files/lib/util/CryptoUtil.class.php
wcfsetup/install/files/lib/util/DOMUtil.class.php
wcfsetup/install/files/lib/util/DateUtil.class.php
wcfsetup/install/files/lib/util/DirectoryUtil.class.php
wcfsetup/install/files/lib/util/ExifUtil.class.php
wcfsetup/install/files/lib/util/FileUtil.class.php
wcfsetup/install/files/lib/util/HeaderUtil.class.php
wcfsetup/install/files/lib/util/ImageUtil.class.php
wcfsetup/install/files/lib/util/JSON.class.php
wcfsetup/install/files/lib/util/MathUtil.class.php
wcfsetup/install/files/lib/util/OptionUtil.class.php
wcfsetup/install/files/lib/util/PasswordUtil.class.php
wcfsetup/install/files/lib/util/StringStack.class.php
wcfsetup/install/files/lib/util/StringUtil.class.php
wcfsetup/install/files/lib/util/StyleUtil.class.php
wcfsetup/install/files/lib/util/UserRegistrationUtil.class.php
wcfsetup/install/files/lib/util/UserUtil.class.php

index 7764cc65b3f15d77248969724cd94b0c42127fcf..9f758b368e7d8618503d73f7db4de4420a751cb3 100644 (file)
@@ -109,5 +109,10 @@ final class EmailGrammar {
                return $header;
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of EmailGrammer objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index fabe3616d08a5747a43c08fe8d31759f3b7231f4..141e5793babd53fa7ceb71647c68b49de2e99415 100644 (file)
@@ -1,6 +1,10 @@
 <?php
 namespace wcf\system\html\metacode\converter;
 
+/**
+ * TOOD documentation
+ * @since      2.2
+ */
 abstract class AbstractMetacodeConverter implements IMetacodeConverter {
        /**
         * @inheritDoc
index 3ea3b0ebb45858b4f3ca5d42c1c6e46d1a18401f..7a593c94ce6f7edb01ebce1dceaa95a727acb267 100644 (file)
@@ -1,6 +1,10 @@
 <?php
 namespace wcf\system\html\metacode\converter;
 
+/**
+ * TOOD documentation
+ * @since      2.2
+ */
 class ColorMetacodeConverter extends AbstractMetacodeConverter {
        /**
         * @inheritDoc
index 5d94515178d4f89a4b827cafcf36d44b1a571188..cfe2989bfb4238dbde7f5d8329f19cdfe8ab21a2 100644 (file)
@@ -1,6 +1,10 @@
 <?php
 namespace wcf\system\html\metacode\converter;
 
+/**
+ * TOOD documentation
+ * @since      2.2
+ */
 interface IMetacodeConverter {
        /**
         * Converts a known metacode into the HTML representation normally used by the WYSIWYG
index 3e291cfe97c7d08eef4a74523c391b76ef84fcab..8a8ac1aa9b29eeff43936f853f71bb6e180ea3b5 100644 (file)
@@ -1,6 +1,10 @@
 <?php
 namespace wcf\system\html\metacode\converter;
 
+/**
+ * TOOD documentation
+ * @since      2.2
+ */
 class QuoteMetacodeConverter extends AbstractMetacodeConverter {
        /**
         * @inheritDoc
index 1367ad06802bd3dde07bb878b2a9c3c5bbbc2088..0cef89907b70f0aa4cd5e965b5db2900704f5e68 100644 (file)
@@ -1,6 +1,10 @@
 <?php
 namespace wcf\system\html\node;
 
+/**
+ * TOOD documentation
+ * @since      2.2
+ */
 abstract class AbstractHtmlNode implements IHtmlNode {
        protected $tagName = '';
        
index 2ee2be196e2508dfac34aeccd1bfbf1abd85bfb8..51c7f3889c0995afdf9300d04318b54e25d35b02 100644 (file)
@@ -1,6 +1,10 @@
 <?php
 namespace wcf\system\html\node;
 
+/**
+ * TOOD documentation
+ * @since      2.2
+ */
 interface IHtmlNode {
        public function getTagName();
        
index ea56a94a67708d2c7bf7dad561a2832026192827..e61823244401772b81f4de7b83fd732a6b36dcca 100644 (file)
@@ -219,5 +219,10 @@ final class ArrayUtil {
                return ((count(call_user_func_array($function, $params1)) === 0) && (count(call_user_func_array($function, $params2)) === 0));
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of ArrayUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index 195be313f42ca9125a0053860b41992625dfc2c3..5873df919cd4cf1e999f018ee3faad03fd32c7c6 100644 (file)
@@ -97,5 +97,10 @@ final class CLIUtil {
                return DateUtil::format(DateUtil::getDateTimeByTimestamp($timestamp), DateUtil::DATE_FORMAT);
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of CLIUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index a5edad376f855a0884cb089cf09357e93a80500f..3fe0168a908159e45cc390b3b1f9dba57c194972 100644 (file)
@@ -53,5 +53,10 @@ final class ClassUtil {
                return is_subclass_of($className, $targetClass);
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of ClassUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index 7986ae1092be6a528abb269e4c0d817e113415a7..3af6774dfca6cf080c74541161b3295a3f372754 100644 (file)
@@ -574,5 +574,10 @@ final class CronjobUtil {
                }
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of CronjobUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index aee5ea17be8b15a217a36f765f403ec3167d51bc..46a1b72ae3f9225910fb1b2e518e1cfb5404a651 100644 (file)
@@ -138,5 +138,10 @@ final class CryptoUtil {
                }
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of CryptoUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index b2c7b01fb1a8333375ec6d48ee84becf977f220b..a92ffb2c45abb2e8f206a6a2c633000af20b7cd2 100644 (file)
@@ -458,5 +458,10 @@ final class DOMUtil {
                return self::getParentBefore($node, $ancestor);
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of DOMUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index e17f8ada42fa3c1bb6bbdbb32b98a806c6fcf6e4..816359db4f3b9a7dc7a34bcd893468bd49c03ad8 100644 (file)
@@ -481,5 +481,10 @@ final class DateUtil {
                return ($date->format('W') == 53 ? 53 : 52);
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of DateUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index b9bda424840b3bcfe6f4fb38f970d66534ac93dd..2347edf6b124424f8e6e4cb0e938f1f6b929127d 100644 (file)
@@ -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.
index bc0f8390080814e3ab474e2f8312d6b1689e4388..ff602a4414a648c4d11c4042d42fb6dab80cabfe 100644 (file)
@@ -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
index 68465632a1b7e085208110bc9f97b5f750f6d342..8b5764489aadbe604e2fb88e44581fd17d4606ec 100644 (file)
@@ -696,5 +696,10 @@ final class FileUtil {
                return 'fa-file-o';
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of FileUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index dcdca1b5922aad53798a2ce87d5a4fa1041824b9..1eb16d5c6ed459bf8f25d3eb618b662145d6d4b5 100644 (file)
@@ -174,5 +174,10 @@ final class HeaderUtil {
                WCF::getTPL()->display('redirect');
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of HeaderUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index 958747c8df84dadd15248e237863b7540ce4ab71..ed400834b86b0ed05f6d85bf9e253ffc91c23e2f 100644 (file)
@@ -62,5 +62,10 @@ final class ImageUtil {
                }
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of ImageUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index e1fb31e2f819ec0dd975f9dbc9f0a1f48a816b3b..81532e71d07479f644d4cedb328b52bc04117ad2 100644 (file)
@@ -51,5 +51,10 @@ final class JSON {
                return json_last_error();
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of JSON objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index f523b48937de139d5d8efefded262ff014a963d4..7524aa131cc81d3c2daea747ac8f36e6745cf8ab 100644 (file)
@@ -43,5 +43,10 @@ final class MathUtil {
                ];
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of MathUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index f77980141d7b2cbfe783abdbf7acad0acd89acdf..ccc86b909647f82665b05d9e342a890228031c0b 100644 (file)
@@ -64,5 +64,10 @@ final class OptionUtil {
                return $result;
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of OptionUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index ba2b057238fec68ba923abae982df7485c8965f6..320c52a560fd12d2efa3bcedf8872cbf34127536 100644 (file)
@@ -699,5 +699,10 @@ final class PasswordUtil {
                return false;
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of PasswordUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index a0c52c8bf18987305fdfc0b228af071a51ba6dcb..03203cda758b0e4fdffc18329f8f1282c6a58634 100644 (file)
@@ -79,5 +79,10 @@ final class StringStack {
                return [];
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of StringStack objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index 9b8936742713d05759d4dd2f541cefecb1496f8d..648f2513e84d75d41715451ba6f9ebbd8569601e 100644 (file)
@@ -719,5 +719,10 @@ final class StringUtil {
                return $result;
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of StringUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index 4b2bc93dfbb6d207e170b7b9b1c96885646df3a8..52bb437970f7e46fa001a59d54665bd3b44b1e02 100644 (file)
@@ -132,5 +132,10 @@ final class StyleUtil {
                StyleCompiler::getInstance()->compileACP();
        }
        
-       private function __construct() { }
+       /**
+        * Forbid creation of StyleUtil objects.
+        */
+       private function __construct() {
+               // does nothing
+       }
 }
index ae51a02c0fad8b1381179e2f23050a52bdf0e058..6d626ed4f3a508ab9396e1d77c01a6bd8c11dc80 100644 (file)
@@ -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.
index 1aacff9d8f3e91aef5c2c21a16945e2509d62194..b468f0414d1b7d45fade40b1cf1da566ea2ffda2 100644 (file)
@@ -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
+       }
 }