Remove unneeded and aliased phpdocs

This commit is contained in:
John Paul E. Balandan, CPA 2021-06-11 23:23:14 +08:00
parent 7635183e00
commit 7a38ce6980
No known key found for this signature in database
GPG Key ID: FB7B51499BC27610
10 changed files with 23 additions and 108 deletions

View File

@ -1,45 +1,5 @@
<?php
/**
* CodeIgniter
*
* An open source application development framework for PHP
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014-2019 British Columbia Institute of Technology
* Copyright (c) 2019-2021 CodeIgniter Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
*
* @author CodeIgniter Dev Team
* @copyright 2019-2021 CodeIgniter Foundation
* @license https://opensource.org/licenses/MIT MIT License
*
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*/
namespace Tests\Support\Libraries;
/**

View File

@ -1,45 +1,5 @@
<?php
/**
* CodeIgniter
*
* An open source application development framework for PHP
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014-2019 British Columbia Institute of Technology
* Copyright (c) 2019-2021 CodeIgniter Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
*
* @author CodeIgniter Dev Team
* @copyright 2019-2021 CodeIgniter Foundation
* @license https://opensource.org/licenses/MIT MIT License
*
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*/
namespace Tests\Support\Libraries;
/**

View File

@ -11,5 +11,5 @@
* loaded early on, and may also contain additional functions
* that you'd like to use throughout your entire application
*
* @link: https://codeigniter4.github.io/CodeIgniter4/
* @see: https://codeigniter4.github.io/CodeIgniter4/
*/

View File

@ -549,7 +549,7 @@ if (! function_exists('function_usable')) {
* that version is yet to be released. This function will therefore
* be just temporary, but would probably be kept for a few years.
*
* @link http://www.hardened-php.net/suhosin/
* @see http://www.hardened-php.net/suhosin/
*
* @param string $functionName Function to check for
*
@ -716,7 +716,7 @@ if (! function_exists('is_really_writable')) {
* the file, based on the read-only attribute. is_writable() is also unreliable
* on Unix servers if safe_mode is on.
*
* @link https://bugs.php.net/bug.php?id=54709
* @see https://bugs.php.net/bug.php?id=54709
*
* @param string $file
*

View File

@ -171,7 +171,7 @@ class Email
* Newline character sequence.
* Use "\r\n" to comply with RFC 822.
*
* @link http://www.ietf.org/rfc/rfc822.txt
* @see http://www.ietf.org/rfc/rfc822.txt
*
* @var string "\r\n" or "\n"
*/
@ -186,7 +186,7 @@ class Email
* switching to "\n", while improper, is the only solution
* that seems to work for all environments.
*
* @link http://www.ietf.org/rfc/rfc822.txt
* @see http://www.ietf.org/rfc/rfc822.txt
*
* @var string
*/
@ -2177,8 +2177,8 @@ class Email
* qualified domain name (eg: "mail.example.com") or an IP literal
* (eg: "[1.2.3.4]").
*
* @link https://tools.ietf.org/html/rfc5321#section-2.3.5
* @link http://cbl.abuseat.org/namingproblems.html
* @see https://tools.ietf.org/html/rfc5321#section-2.3.5
* @see http://cbl.abuseat.org/namingproblems.html
*
* @return string
*/

View File

@ -246,8 +246,8 @@ class Response extends Message implements MessageInterface, ResponseInterface
* listed in the IANA HTTP Status Code Registry) for the response's
* status code.
*
* @link http://tools.ietf.org/html/rfc7231#section-6
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @return string Reason phrase; must return an empty string if none present.
*/

View File

@ -14,7 +14,7 @@ namespace CodeIgniter\Modules;
/**
* Modules Class
*
* @link https://codeigniter.com/user_guide/general/modules.html
* @see https://codeigniter.com/user_guide/general/modules.html
*/
class Modules
{

View File

@ -1,19 +1,4 @@
<?php
/**
* Core language strings.
*
* @package CodeIgniter
*
* @author CodeIgniter Dev Team
* @copyright 2014-2018 British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
*
* @link https://codeigniter.com
* @since Version 4.0.0
* @filesource
*
* @codeCoverageIgnore
*/
// looking for a system message not likely to be part of unit testing
return [

View File

@ -9,8 +9,6 @@ use CodeIgniter\Entity\Entity;
*
* Simple Entity-type class for testing creating and saving entities
* in the model so we can support Entity/Repository type patterns.
*
* @package Tests\Support\Models
*/
class SimpleEntity extends Entity
{

View File

@ -123,7 +123,19 @@ final class CodeIgniter4 extends AbstractRuleset
'method' => 'multi',
'property' => 'multi',
],
'phpdoc_scalar' => [
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => [
'replacements' => [
'property-read' => 'property',
'property-write' => 'property',
'type' => 'var',
'link' => 'see',
],
],
'phpdoc_no_empty_return' => false,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_scalar' => [
'types' => [
'boolean',
'callback',