Skip to content

Commit 6c99a20

Browse files
xaloppxalopp
committed
fix and clean file and class doc blocks
1 parent 0ae635f commit 6c99a20

13 files changed

+54
-139
lines changed

‎MO4/Sniffs/Arrays/ArrayDoubleArrowAlignmentSniff.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510
namespace MO4\Sniffs\Arrays;
1611

@@ -23,12 +18,10 @@
2318
*
2419
* '=>' must be aligned in arrays, and the key and the '=>' must be in the same line
2520
*
26-
* @category PHP
27-
* @package PHP_CodeSniffer-MO4
2821
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
2922
* @copyright 2013 Xaver Loppenstedt, some rights reserved.
3023
* @license http://spdx.org/licenses/MIT MIT License
31-
* @link https://github.com/Mayflower/mo4-coding-standard
24+
* @link https://github.com/mayflower/mo4-coding-standard
3225
*/
3326
class ArrayDoubleArrowAlignmentSniff implements Sniff
3427
{

‎MO4/Sniffs/Arrays/MultiLineArraySniff.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510
namespace MO4\Sniffs\Arrays;
1611

@@ -20,12 +15,10 @@
2015
/**
2116
* Multi Line Array sniff.
2217
*
23-
* @category PHP
24-
* @package PHP_CodeSniffer-MO4
2518
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
2619
* @copyright 2013-2017 Xaver Loppenstedt, some rights reserved.
2720
* @license http://spdx.org/licenses/MIT MIT License
28-
* @link https://github.com/Mayflower/mo4-coding-standard
21+
* @link https://github.com/mayflower/mo4-coding-standard
2922
*/
3023
class MultiLineArraySniff implements Sniff
3124
{

‎MO4/Sniffs/Commenting/PropertyCommentSniff.php‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Sniffs\Commenting;
@@ -24,12 +19,10 @@
2419
* Doc blocks of class properties must be multiline and have exactly one '@var'
2520
* annotation.
2621
*
27-
* @category PHP
28-
* @package PHP_CodeSniffer-MO4
2922
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3023
* @copyright 2013-2014 Xaver Loppenstedt, some rights reserved.
3124
* @license http://spdx.org/licenses/MIT MIT License
32-
* @link https://github.com/Mayflower/mo4-coding-standard
25+
* @link https://github.com/mayflower/mo4-coding-standard
3326
*/
3427
class PropertyCommentSniff extends AbstractScopeSniff
3528
{
@@ -94,7 +87,7 @@ protected function processTokenWithinScope(
9487
];
9588
$tokens = $phpcsFile->getTokens();
9689

97-
// Before even checking the docblocks above the current var/const,
90+
// Before even checking the doc blocks above the current var/const,
9891
// check if we have a single line comment after it on the same line,
9992
// and if that one is OK.
10093
$postComment = $phpcsFile->findNext(

‎MO4/Sniffs/Formatting/AlphabeticalUseStatementsSniff.php‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,13 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Sniffs\Formatting;
1712

18-
use PHP_CodeSniffer\Exceptions\RuntimeException;
1913
use PHP_CodeSniffer\Files\File;
2014
use PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\UseDeclarationSniff;
2115
use PHP_CodeSniffer\Util\Common;
@@ -26,14 +20,12 @@
2620
*
2721
* Use statements must be in alphabetical order, grouped by empty lines.
2822
*
29-
* @category PHP
30-
* @package PHP_CodeSniffer-MO4
3123
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3224
* @author Steffen Ritter <steffenritter1@gmail.com>
3325
* @author Christian Albrecht <christian.albrecht@mayflower.de>
3426
* @copyright 2013-2017 Xaver Loppenstedt, some rights reserved.
3527
* @license http://spdx.org/licenses/MIT MIT License
36-
* @link https://github.com/Mayflower/mo4-coding-standard
28+
* @link https://github.com/mayflower/mo4-coding-standard
3729
*/
3830
class AlphabeticalUseStatementsSniff extends UseDeclarationSniff
3931
{

‎MO4/Sniffs/Formatting/UnnecessaryNamespaceUsageSniff.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Sniffs\Formatting;
@@ -24,14 +19,12 @@
2419
*
2520
* Full namespace declaration should be skipped in favour of the short declaration.
2621
*
27-
* @category PHP
28-
* @package PHP_CodeSniffer-MO4
2922
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3023
* @author Marco Jantke <marco.jantke@gmail.com>
3124
* @author Steffen Ritter <steffenritter1@gmail.com>
3225
* @copyright 2013 Xaver Loppenstedt, some rights reserved.
3326
* @license http://spdx.org/licenses/MIT MIT License
34-
* @link https://github.com/Mayflower/mo4-coding-standard
27+
* @link https://github.com/mayflower/mo4-coding-standard
3528
*/
3629
class UnnecessaryNamespaceUsageSniff implements Sniff
3730
{

‎MO4/Sniffs/Strings/VariableInDoubleQuotedStringSniff.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Sniffs\Strings;
@@ -23,12 +18,10 @@
2318
*
2419
* Variables in double quoted strings must be surrounded by { }
2520
*
26-
* @category PHP
27-
* @package PHP_CodeSniffer-MO4
2821
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
2922
* @copyright 2013 Xaver Loppenstedt, some rights reserved.
3023
* @license http://spdx.org/licenses/MIT MIT License
31-
* @link https://github.com/Mayflower/mo4-coding-standard
24+
* @link https://github.com/mayflower/mo4-coding-standard
3225
*/
3326
class VariableInDoubleQuotedStringSniff implements Sniff
3427
{

‎MO4/Tests/Arrays/ArrayDoubleArrowAlignmentUnitTest.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Tests\Arrays;
@@ -24,12 +19,10 @@
2419
* A sniff unit test checks a .inc file for expected violations of a single
2520
* coding standard. Expected errors and warnings are stored in this class.
2621
*
27-
* @category PHP
28-
* @package PHP_CodeSniffer-MO4
2922
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3023
* @copyright 2013-2017 Xaver Loppenstedt, some rights reserved.
3124
* @license http://spdx.org/licenses/MIT MIT License
32-
* @link https://github.com/Mayflower/mo4-coding-standard
25+
* @link https://github.com/mayflower/mo4-coding-standard
3326
*/
3427
class ArrayDoubleArrowAlignmentUnitTest extends AbstractSniffUnitTest
3528
{

‎MO4/Tests/Arrays/MultiLineArrayUnitTest.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Tests\Arrays;
@@ -24,12 +19,10 @@
2419
* A sniff unit test checks a .inc file for expected violations of a single
2520
* coding standard. Expected errors and warnings are stored in this class.
2621
*
27-
* @category PHP
28-
* @package PHP_CodeSniffer-MO4
2922
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3023
* @copyright 2013-2017 Xaver Loppenstedt, some rights reserved.
3124
* @license http://spdx.org/licenses/MIT MIT License
32-
* @link https://github.com/Mayflower/mo4-coding-standard
25+
* @link https://github.com/mayflower/mo4-coding-standard
3326
*/
3427
class MultiLineArrayUnitTest extends AbstractSniffUnitTest
3528
{

‎MO4/Tests/Commenting/PropertyCommentUnitTest.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Tests\Commenting;
@@ -24,12 +19,10 @@
2419
* A sniff unit test checks a .inc file for expected violations of a single
2520
* coding standard. Expected errors and warnings are stored in this class.
2621
*
27-
* @category PHP
28-
* @package PHP_CodeSniffer-MO4
2922
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3023
* @copyright 2014 Xaver Loppenstedt, some rights reserved.
3124
* @license http://spdx.org/licenses/MIT MIT License
32-
* @link https://github.com/Mayflower/mo4-coding-standard
25+
* @link https://github.com/mayflower/mo4-coding-standard
3326
*/
3427
class PropertyCommentUnitTest extends AbstractSniffUnitTest
3528
{

‎MO4/Tests/Formatting/AlphabeticalUseStatementsUnitTest.php‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
/**
44
* This file is part of the mo4-coding-standard (phpcs standard)
55
*
6-
* PHP version 5
7-
*
8-
* @category PHP
9-
* @package PHP_CodeSniffer-MO4
10-
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
11-
* @license http://spdx.org/licenses/MIT MIT License
12-
* @version GIT: master
13-
* @link https://github.com/Mayflower/mo4-coding-standard
6+
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
7+
* @license http://spdx.org/licenses/MIT MIT License
8+
* @link https://github.com/mayflower/mo4-coding-standard
149
*/
1510

1611
namespace MO4\Tests\Formatting;
@@ -24,12 +19,10 @@
2419
* A sniff unit test checks a .inc file for expected violations of a single
2520
* coding standard. Expected errors and warnings are stored in this class.
2621
*
27-
* @category PHP
28-
* @package PHP_CodeSniffer-MO4
2922
* @author Xaver Loppenstedt <xaver@loppenstedt.de>
3023
* @copyright 2013-2017 Xaver Loppenstedt, some rights reserved.
3124
* @license http://spdx.org/licenses/MIT MIT License
32-
* @link https://github.com/Mayflower/mo4-coding-standard
25+
* @link https://github.com/mayflower/mo4-coding-standard
3326
*/
3427
class AlphabeticalUseStatementsUnitTest extends AbstractSniffUnitTest
3528
{

0 commit comments

Comments
 (0)