chore: update class comments for all file

php-toolkit · Feb 8, 2024 · ebcac8b · ebcac8b
1 parent 34243f5
commit ebcac8b
Show file tree

Hide file tree

Showing 53 changed files with 6 additions and 90 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,5 +7,7 @@ composer.lock
 *.log
 *.pid
 *.cache
+.phpdoc/
+phpdoc/
 *.patch
 .DS_Store
diff --git a/src/Arr.php b/src/Arr.php
@@ -12,10 +12,7 @@
 use Toolkit\Stdlib\Arr\ArrayHelper;
 
 /**
- * Class Arr
- *  - alias of the ArrayHelper
- *
- * @package Toolkit\Stdlib
+ * Class Arr - alias of the ArrayHelper
  */
 class Arr extends ArrayHelper
 {

diff --git a/src/Arr/ArrBuffer.php b/src/Arr/ArrBuffer.php
@@ -11,8 +11,6 @@
 
 /**
  * Class ArrBuffer
- *
- * @package Toolkit\Stdlib\Arr
  */
 final class ArrBuffer
 {

diff --git a/src/Arr/ArrayHelper.php b/src/Arr/ArrayHelper.php
@@ -33,8 +33,6 @@
 
 /**
  * Class ArrayHelper
- *
- * @package Toolkit\Stdlib\Arr
  */
 class ArrayHelper
 {

diff --git a/src/Arr/Traits/ArrayMergeTrait.php b/src/Arr/Traits/ArrayMergeTrait.php
@@ -17,8 +17,6 @@
 
 /**
  * Trait ArrayMergeTrait
- *
- * @package Toolkit\Stdlib\Arr\Traits
  */
 trait ArrayMergeTrait
 {

diff --git a/src/Arr/Traits/ArrayValueGetSetTrait.php b/src/Arr/Traits/ArrayValueGetSetTrait.php
@@ -23,8 +23,6 @@
 
 /**
  * Trait ArrayValueGetSetTrait
- *
- * @package Toolkit\Stdlib\Arr\Traits
  */
 trait ArrayValueGetSetTrait
 {

diff --git a/src/Helper/DataHelper.php b/src/Helper/DataHelper.php
@@ -23,8 +23,6 @@
 
 /**
  * Class DataHelper
- *
- * @package Toolkit\Stdlib\Helper
  */
 class DataHelper
 {

diff --git a/src/Helper/Format.php b/src/Helper/Format.php
@@ -24,8 +24,6 @@
 
 /**
  * Class Format
- *
- * @package Toolkit\Stdlib\Helper
  */
 class Format
 {

diff --git a/src/Helper/JsonHelper.php b/src/Helper/JsonHelper.php
@@ -31,8 +31,6 @@
 
 /**
  * Class JsonHelper
- *
- * @package Toolkit\Stdlib
  */
 class JsonHelper
 {

diff --git a/src/Helper/NetHelper.php b/src/Helper/NetHelper.php
@@ -19,8 +19,6 @@
 
 /**
  * Class NetHelper
- *
- * @package Toolkit\Stdlib\Helper
  */
 class NetHelper
 {

diff --git a/src/Helper/PhpHelper.php b/src/Helper/PhpHelper.php
@@ -49,8 +49,6 @@
 
 /**
  * Class PhpHelper
- *
- * @package Toolkit\PhpKit
  */
 class PhpHelper
 {

diff --git a/src/Json.php b/src/Json.php
@@ -13,8 +13,6 @@
 
 /**
  * Class Json
- *
- * @package Toolkit\Stdlib
  */
 final class Json extends JsonHelper
 {

diff --git a/src/Math.php b/src/Math.php
@@ -13,8 +13,6 @@
 
 /**
  * Class Math
- *
- * @package Toolkit\Stdlib
  */
 class Math extends NumHelper
 {

diff --git a/src/Num.php b/src/Num.php
@@ -13,8 +13,6 @@
 
 /**
  * Class Num
- *
- * @package Toolkit\Stdlib
  */
 class Num extends NumHelper
 {

diff --git a/src/OS.php b/src/OS.php
@@ -37,8 +37,6 @@
 
 /**
  * Class OsEnv
- *
- * @package Toolkit\PhpKit\OS
  */
 class OS
 {

diff --git a/src/Obj.php b/src/Obj.php
@@ -16,8 +16,6 @@
 /**
  * Class Obj
  *  alias of the ObjectHelper
- *
- * @package Toolkit\Stdlib\Obj
  */
 class Obj extends ObjectHelper
 {

diff --git a/src/Obj/AbstractMap.php b/src/Obj/AbstractMap.php
@@ -14,8 +14,6 @@
 
 /**
  * Class AbstractMap
- *
- * @package Toolkit\Stdlib\Obj
  */
 abstract class AbstractMap implements JsonSerializable
 {

diff --git a/src/Obj/BaseObject.php b/src/Obj/BaseObject.php
@@ -16,8 +16,6 @@
 
 /**
  * Class AbstractObj
- *
- * @package Toolkit\Stdlib\Obj
  */
 abstract class BaseObject implements JsonSerializable
 {
@@ -40,13 +38,13 @@ public function __construct(array $data = [])
         if ($data) {
             $this->load($data);
         }
-        $this->init();
+        $this->afterNew();
     }
 
     /**
-     * will call init() after constructor.
+     * will call it after constructor.
      */
-    protected function init(): void
+    protected function afterNew(): void
     {
         // do something...
     }

diff --git a/src/Obj/Configurable.php b/src/Obj/Configurable.php
@@ -13,8 +13,6 @@
 
 /**
  * Class Configurable
- *
- * @package Toolkit\Stdlib\Obj
  */
 abstract class Configurable
 {

diff --git a/src/Obj/DataObject.php b/src/Obj/DataObject.php
@@ -20,8 +20,6 @@
 
 /**
  * Class DataObject
- *
- * @package Toolkit\Stdlib\Obj
  */
 class DataObject extends ArrayObject implements JsonSerializable
 {

diff --git a/src/Obj/Exception/ContainerException.php b/src/Obj/Exception/ContainerException.php
@@ -14,8 +14,6 @@
 
 /**
  * Class ContainerException
- *
- * @package Toolkit\Stdlib\Obj\Exception
  */
 class ContainerException extends RuntimeException implements ContainerExceptionInterface
 {

diff --git a/src/Obj/Exception/GetPropertyException.php b/src/Obj/Exception/GetPropertyException.php
@@ -13,8 +13,6 @@
 
 /**
  * Class GetPropertyException
- *
- * @package Toolkit\Stdlib\Obj\Exception
  */
 class GetPropertyException extends RuntimeException
 {

diff --git a/src/Obj/Exception/NotFoundException.php b/src/Obj/Exception/NotFoundException.php
@@ -14,8 +14,6 @@
 
 /**
  * Class NotFoundException
- *
- * @package Toolkit\Stdlib\Obj\Exception
  */
 class NotFoundException extends RuntimeException implements NotFoundExceptionInterface
 {

diff --git a/src/Obj/Exception/PropertyException.php b/src/Obj/Exception/PropertyException.php
@@ -13,8 +13,6 @@
 
 /**
  * Class PropertyException
- *
- * @package Toolkit\Stdlib\Obj\Exception
  */
 class PropertyException extends RuntimeException
 {

diff --git a/src/Obj/Exception/SetPropertyException.php b/src/Obj/Exception/SetPropertyException.php
@@ -13,8 +13,6 @@
 
 /**
  * Class SetPropertyException
- *
- * @package Toolkit\Stdlib\Obj\Exception
  */
 class SetPropertyException extends RuntimeException
 {

diff --git a/src/Obj/ObjectBox.php b/src/Obj/ObjectBox.php
@@ -28,8 +28,6 @@
  * An simple object containers implements
  *
  * NOTICE: require the `psr/container` package.
- *
- * @package Toolkit\Stdlib\Obj
  */
 class ObjectBox implements ContainerInterface
 {

diff --git a/src/Obj/ObjectHelper.php b/src/Obj/ObjectHelper.php
@@ -45,8 +45,6 @@
 
 /**
  * Class ObjectHelper
- *
- * @package Toolkit\Stdlib\Obj
  */
 class ObjectHelper
 {

diff --git a/src/Obj/Traits/ArrayAccessByGetterSetterTrait.php b/src/Obj/Traits/ArrayAccessByGetterSetterTrait.php
@@ -15,7 +15,6 @@
 /**
  * Class TraitArrayAccess
  *
- * @package Toolkit\Stdlib\Obj\Traits
  * ```
  * class A implements \ArrayAccess
  * {

diff --git a/src/Obj/Traits/ArrayAccessByPropertyTrait.php b/src/Obj/Traits/ArrayAccessByPropertyTrait.php
@@ -14,7 +14,6 @@
 /**
  * Class TraitArrayAccess
  *
- * @package Toolkit\Stdlib\Obj\Traits
  * ```
  * class A implements \ArrayAccess
  * {

diff --git a/src/Obj/Traits/ObjectPoolTrait.php b/src/Obj/Traits/ObjectPoolTrait.php
@@ -20,7 +20,6 @@
 /**
  * Class ObjectPoolTrait
  *
- * @package Toolkit\Stdlib\Obj\Traits
  */
 trait ObjectPoolTrait
 {

diff --git a/src/Obj/Traits/QuickInitTrait.php b/src/Obj/Traits/QuickInitTrait.php
@@ -14,7 +14,6 @@
 /**
  * Trait QuickInitTrait
  *
- * @package Toolkit\Stdlib\Obj\Traits
  */
 trait QuickInitTrait
 {

diff --git a/src/Obj/Traits/SingletonPoolTrait.php b/src/Obj/Traits/SingletonPoolTrait.php
@@ -12,7 +12,6 @@
 /**
  * Trait SingletonPoolTrait
  *
- * @package Toolkit\Stdlib\Obj\Traits
  */
 trait SingletonPoolTrait
 {

diff --git a/src/Obj/Traits/SingletonTrait.php b/src/Obj/Traits/SingletonTrait.php
@@ -14,7 +14,6 @@
 /**
  * Trait SingletonTrait
  *
- * @package Toolkit\Stdlib\Obj\Traits
  */
 trait SingletonTrait
 {

diff --git a/src/Obj/Traits/StdObjectTrait.php b/src/Obj/Traits/StdObjectTrait.php
@@ -21,7 +21,6 @@
 /**
  * Class StdObjectTrait
  *
- * @package Toolkit\Stdlib\Obj\Traits
  */
 trait StdObjectTrait
 {

diff --git a/src/Php.php b/src/Php.php
@@ -13,8 +13,6 @@
 
 /**
  * Class PHP
- *
- * @package Toolkit\Stdlib
  */
 class Php extends PhpHelper
 {

diff --git a/src/Str/HtmlHelper.php b/src/Str/HtmlHelper.php
@@ -24,8 +24,6 @@
 
 /**
  * Class HtmlHelper
- *
- * @package Toolkit\Stdlib\Str
  */
 class HtmlHelper
 {

diff --git a/src/Str/StrBuffer.php b/src/Str/StrBuffer.php
@@ -17,8 +17,6 @@
 
 /**
  * Class StrBuffer
- *
- * @package Toolkit\Stdlib\Str
  */
 class StrBuffer implements Stringable
 {

diff --git a/src/Str/StrHelper.php b/src/Str/StrHelper.php
@@ -11,8 +11,6 @@
 
 /**
  * Class StrHelper
- *
- * @package Toolkit\Stdlib\Str
  */
 class StrHelper extends StringHelper
 {

diff --git a/src/Str/StringHelper.php b/src/Str/StringHelper.php
@@ -57,8 +57,6 @@
 
 /**
  * Class StringHelper
- *
- * @package Toolkit\Stdlib\Str
  */
 abstract class StringHelper
 {

diff --git a/src/Str/Traits/StringCaseHelperTrait.php b/src/Str/Traits/StringCaseHelperTrait.php
@@ -32,8 +32,6 @@
 
 /**
  * Trait StringCaseHelperTrait
- *
- * @package Toolkit\Stdlib\Str\Traits
  */
 trait StringCaseHelperTrait
 {

diff --git a/src/Str/Traits/StringCheckHelperTrait.php b/src/Str/Traits/StringCheckHelperTrait.php
@@ -28,7 +28,6 @@
 /**
  * Trait StringCheckHelperTrait
  *
- * @package Toolkit\Stdlib\Str\Traits
  */
 trait StringCheckHelperTrait
 {

diff --git a/src/Str/Traits/StringConvertTrait.php b/src/Str/Traits/StringConvertTrait.php
@@ -36,7 +36,6 @@
 /**
  * Trait StringSplitHelperTrait
  *
- * @package Toolkit\Stdlib\Str\Traits
  */
 trait StringConvertTrait
 {

diff --git a/src/Str/Traits/StringLengthHelperTrait.php b/src/Str/Traits/StringLengthHelperTrait.php
@@ -22,7 +22,6 @@
 /**
  * Trait StringLengthHelperTrait
  *
- * @package Toolkit\Stdlib\Str\Traits
  */
 trait StringLengthHelperTrait
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,5 +7,7 @@ composer.lock @@
     *.log
     *.pid
     *.cache
+    .phpdoc/
+    phpdoc/
     *.patch
     .DS_Store