Skip to content
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

Fix doc block retrieval #687

Merged
merged 3 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1292,10 +1292,11 @@ private function parseFunctionOrClosureDeclaration()
);
}

$docComment = $this->docComment;
$callable = $this->parseFunctionDeclaration();
$this->compilationUnit->addChild($callable);

$callable->setComment($this->docComment);
$callable->setComment($docComment);
$callable->setTokens($this->tokenStack->pop());
$this->prepareCallable($callable);

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?php
/**
* This file is part of PDepend.
*
* PHP Version 5
*
* Copyright (c) 2008-2017 Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/

namespace PDepend\Bugs\Phpmd;


use PDepend\Bugs\AbstractRegressionTest;
use PDepend\Source\AST\ASTFunction;

/**
* https://github.com/phpmd/phpmd/issues/914
*/
class FunctionDocBlockBugPhpmd914Test extends AbstractRegressionTest
{
public function testFunctionDocBlockCanBeRead()
{
/** @var ASTFunction $function */
$function = $this->getFirstFunctionForTestCase();

$lines = array_map(function ($line) {
return trim($line, " \t\n\r\0\x0B/*");
}, explode("\n", trim($function->getComment(), " \t\n\r\0\x0B/*")));

$this->assertSame(array(
'@SuppressWarnings(PHPMD.CyclomaticComplexity)',
'@SuppressWarnings(PHPMD.NPathComplexity)',
), $lines);
}
}
18 changes: 18 additions & 0 deletions src/test/php/PDepend/fix-php-compatibility.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,18 @@
"#[\\ReturnTypeWillChange]\npublic function getIterator(",
),
),
__DIR__ . '/../../../../vendor/phpunit/phpunit/src/Runner/Filter/Test.php' => array(
array(
'public function accept(',
"#[\\ReturnTypeWillChange]\npublic function accept(",
),
),
__DIR__ . '/../../../../vendor/phpunit/php-file-iterator/src/Iterator.php' => array(
array(
'public function accept(',
"#[\\ReturnTypeWillChange]\npublic function accept(",
),
),
__DIR__ . '/../../../../vendor/phpunit/phpunit/src/Util/TestSuiteIterator.php' => array(
array(
'public function hasChildren(',
Expand Down Expand Up @@ -95,6 +107,12 @@
"#[\\ReturnTypeWillChange]\npublic function rewind(",
),
),
__DIR__ . '/../../../../vendor/phpunit/phpunit/src/Util/Getopt.php' => array(
array(
'strlen($opt_arg)',
'strlen((string) $opt_arg)',
),
),
__DIR__ . '/../../../../vendor/phpunit/php-code-coverage/src/CodeCoverage.php' => (PHP_VERSION >= 7) ? array(
array(
'$docblock = $token->getDocblock();',
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

/**
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
function doesNothing() {
if (true AND true AND false) return;
/** This comment breaks SuppressWarnings */
if (true AND true AND false) return;
if (true AND true AND false) return;
if (true AND true AND false) return;
}