Change some phpdocs to simple comments (#4945)

paulbalandan · web-flow · commit 36152b39b294 · 2021-07-18T22:13:55.000+08:00
diff --git a/app/Config/Routes.php b/app/Config/Routes.php
@@ -11,7 +11,7 @@
     require SYSTEMPATH . 'Config/Routes.php';
 }
 
-/**
+/*
  * --------------------------------------------------------------------
  * Router Setup
  * --------------------------------------------------------------------
diff --git a/system/Config/Routes.php b/system/Config/Routes.php
@@ -11,7 +11,7 @@
 
 use CodeIgniter\Exceptions\PageNotFoundException;
 
-/**
+/*
  * System URI Routing
  *
  * This file contains any routing to system tools, such as command-line
diff --git a/system/Helpers/array_helper.php b/system/Helpers/array_helper.php
@@ -9,9 +9,7 @@
  * file that was distributed with this source code.
  */
 
-/**
- * CodeIgniter Array Helpers
- */
+// CodeIgniter Array Helpers
 
 if (! function_exists('dot_array_search')) {
     /**
diff --git a/system/Helpers/date_helper.php b/system/Helpers/date_helper.php
@@ -9,9 +9,7 @@
  * file that was distributed with this source code.
  */
 
-/**
- * CodeIgniter Date Helpers
- */
+// CodeIgniter Date Helpers
 
 if (! function_exists('now')) {
     /**
diff --git a/system/Helpers/filesystem_helper.php b/system/Helpers/filesystem_helper.php
@@ -9,9 +9,7 @@
  * file that was distributed with this source code.
  */
 
-/**
- * CodeIgniter File System Helpers
- */
+// CodeIgniter File System Helpers
 // ------------------------------------------------------------------------
 
 if (! function_exists('directory_map')) {
diff --git a/system/Helpers/form_helper.php b/system/Helpers/form_helper.php
@@ -11,9 +11,7 @@
 
 use Config\App;
 
-/**
- * CodeIgniter Form Helpers
- */
+// CodeIgniter Form Helpers
 
 use Config\Services;
 
diff --git a/system/Helpers/html_helper.php b/system/Helpers/html_helper.php
@@ -15,9 +15,7 @@
 
 // --------------------------------------------------------------------
 
-/**
- * CodeIgniter HTML Helpers
- */
+// CodeIgniter HTML Helpers
 if (! function_exists('ul')) {
     /**
      * Unordered List
diff --git a/system/Helpers/inflector_helper.php b/system/Helpers/inflector_helper.php
@@ -11,9 +11,7 @@
 
 // --------------------------------------------------------------------
 
-/**
- * CodeIgniter Inflector Helpers
- */
+// CodeIgniter Inflector Helpers
 if (! function_exists('singular')) {
     /**
      * Singular
diff --git a/system/Helpers/number_helper.php b/system/Helpers/number_helper.php
@@ -11,9 +11,7 @@
 
 use Config\Services;
 
-/**
- * CodeIgniter Number Helpers
- */
+// CodeIgniter Number Helpers
 
 if (! function_exists('number_to_size')) {
     /**
diff --git a/system/Helpers/security_helper.php b/system/Helpers/security_helper.php
@@ -11,9 +11,7 @@
 
 use Config\Services;
 
-/**
- * CodeIgniter Security Helpers
- */
+// CodeIgniter Security Helpers
 
 if (! function_exists('sanitize_filename')) {
     /**
diff --git a/system/Helpers/test_helper.php b/system/Helpers/test_helper.php
@@ -12,9 +12,7 @@
 use CodeIgniter\Model;
 use CodeIgniter\Test\Fabricator;
 
-/**
- * CodeIgniter Test Helpers
- */
+// CodeIgniter Test Helpers
 //--------------------------------------------------------------------
 
 if (! function_exists('fake')) {
diff --git a/system/Helpers/text_helper.php b/system/Helpers/text_helper.php
@@ -11,9 +11,7 @@
 
 use Config\ForeignCharacters;
 
-/**
- * CodeIgniter Text Helpers
- */
+// CodeIgniter Text Helpers
 //--------------------------------------------------------------------
 
 if (! function_exists('word_limiter')) {
diff --git a/system/Helpers/url_helper.php b/system/Helpers/url_helper.php
@@ -15,9 +15,7 @@
 use Config\App;
 use Config\Services;
 
-/**
- * CodeIgniter URL Helpers
- */
+// CodeIgniter URL Helpers
 
 if (! function_exists('_get_uri')) {
     /**
diff --git a/system/Helpers/xml_helper.php b/system/Helpers/xml_helper.php
@@ -9,9 +9,7 @@
  * file that was distributed with this source code.
  */
 
-/**
- * CodeIgniter XML Helpers
- */
+// CodeIgniter XML Helpers
 
 if (! function_exists('xml_convert')) {
     /**
diff --git a/system/View/Parser.php b/system/View/Parser.php
@@ -465,7 +465,7 @@ protected function parseConditionals(string $template): string
     {
         $pattern = '/\{\s*(if|elseif)\s*((?:\()?(.*?)(?:\))?)\s*\}/ms';
 
-        /**
+        /*
          * For each match:
          * [0] = raw match `{if var}`
          * [1] = conditional `if`
diff --git a/tests/_support/Config/Routes.php b/tests/_support/Config/Routes.php
@@ -2,7 +2,5 @@
 
 namespace Tests\Support\Config;
 
-/**
- * This is a simple file to include for testing the RouteCollection class.
- */
+// This is a simple file to include for testing the RouteCollection class.
 $routes->add('testing', 'TestController::index', ['as' => 'testing-index']);
diff --git a/utils/PhpCsFixer/CodeIgniter4.php b/utils/PhpCsFixer/CodeIgniter4.php
@@ -384,6 +384,10 @@ public function __construct()
             'phpdoc_summary'                                => false,
             'phpdoc_tag_casing'                             => ['tags' => ['inheritDoc']],
             'phpdoc_tag_type'                               => ['tags' => ['inheritDoc' => 'inline']],
+            'phpdoc_to_comment'                             => false,
+            'phpdoc_to_param_type'                          => false,
+            'phpdoc_to_property_type'                       => false,
+            'phpdoc_to_return_type'                         => false,
             'phpdoc_trim'                                   => true,
             'phpdoc_trim_consecutive_blank_line_separation' => true,
             'phpdoc_types'                                  => ['groups' => ['simple', 'alias', 'meta']],

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`require SYSTEMPATH . 'Config/Routes.php';`
`12`	`12`	`}`
`13`	`13`
`14`		`-/**`
	`14`	`+/*`
`15`	`15`	`* --------------------------------------------------------------------`
`16`	`16`	`* Router Setup`
`17`	`17`	`* --------------------------------------------------------------------`
Original file line number	Diff line number	Diff line change
`@@ -465,7 +465,7 @@ protected function parseConditionals(string $template): string`
`465`	`465`	`{`
`466`	`466`	`$pattern = '/\{\s(if\|elseif)\s((?:\()?(.?)(?:\))?)\s\}/ms';`
`467`	`467`
`468`		`- /**`
	`468`	`+ /*`
`469`	`469`	`* For each match:`
`470`	`470`	* [0] = raw match `{if var}`
`471`	`471`	* [1] = conditional `if`