Skip to content

Change some phpdocs to simple comments #4945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/Config/Routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
require SYSTEMPATH . 'Config/Routes.php';
}

/**
/*
* --------------------------------------------------------------------
* Router Setup
* --------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion system/Config/Routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

use CodeIgniter\Exceptions\PageNotFoundException;

/**
/*
* System URI Routing
*
* This file contains any routing to system tools, such as command-line
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/array_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@
* file that was distributed with this source code.
*/

/**
* CodeIgniter Array Helpers
*/
// CodeIgniter Array Helpers

if (! function_exists('dot_array_search')) {
/**
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/date_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@
* file that was distributed with this source code.
*/

/**
* CodeIgniter Date Helpers
*/
// CodeIgniter Date Helpers

if (! function_exists('now')) {
/**
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/filesystem_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -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')) {
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/form_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

use Config\App;

/**
* CodeIgniter Form Helpers
*/
// CodeIgniter Form Helpers

use Config\Services;

Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/html_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@

// --------------------------------------------------------------------

/**
* CodeIgniter HTML Helpers
*/
// CodeIgniter HTML Helpers
if (! function_exists('ul')) {
/**
* Unordered List
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/inflector_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

// --------------------------------------------------------------------

/**
* CodeIgniter Inflector Helpers
*/
// CodeIgniter Inflector Helpers
if (! function_exists('singular')) {
/**
* Singular
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/number_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

use Config\Services;

/**
* CodeIgniter Number Helpers
*/
// CodeIgniter Number Helpers

if (! function_exists('number_to_size')) {
/**
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/security_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

use Config\Services;

/**
* CodeIgniter Security Helpers
*/
// CodeIgniter Security Helpers

if (! function_exists('sanitize_filename')) {
/**
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/test_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@
use CodeIgniter\Model;
use CodeIgniter\Test\Fabricator;

/**
* CodeIgniter Test Helpers
*/
// CodeIgniter Test Helpers
//--------------------------------------------------------------------

if (! function_exists('fake')) {
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/text_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

use Config\ForeignCharacters;

/**
* CodeIgniter Text Helpers
*/
// CodeIgniter Text Helpers
//--------------------------------------------------------------------

if (! function_exists('word_limiter')) {
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/url_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@
use Config\App;
use Config\Services;

/**
* CodeIgniter URL Helpers
*/
// CodeIgniter URL Helpers

if (! function_exists('_get_uri')) {
/**
Expand Down
4 changes: 1 addition & 3 deletions system/Helpers/xml_helper.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@
* file that was distributed with this source code.
*/

/**
* CodeIgniter XML Helpers
*/
// CodeIgniter XML Helpers

if (! function_exists('xml_convert')) {
/**
Expand Down
2 changes: 1 addition & 1 deletion system/View/Parser.php
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 1 addition & 3 deletions tests/_support/Config/Routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -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']);
4 changes: 4 additions & 0 deletions utils/PhpCsFixer/CodeIgniter4.php
Original file line number Diff line number Diff line change
Expand Up @@ -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']],
Expand Down