Merge pull request #252 from simPod/single-line

Add RequireOneLineDocComment sniff

Author: ostrolucky

lib/Doctrine/ruleset.xml

@@ -419,6 +419,8 @@
  </rule>
  <!-- Forbid useless @var for constants -->
  <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint"/>
+ <!-- Require One Line Doc Comment where there's only 1 annotation present -->
+ <rule ref="SlevomatCodingStandard.Commenting.RequireOneLineDocComment"/>
  <!-- Forbid useless phpDocs for functions -->
  <rule ref="SlevomatCodingStandard.Commenting.UselessFunctionDocComment">
  <properties>

tests/expected_report.txt

@@ -12,10 +12,10 @@ tests/input/concatenation_spacing.php 49 0
 tests/input/constants-no-lsb.php 2 0
 tests/input/constants-var.php 6 0
 tests/input/ControlStructures.php 28 0
-tests/input/doc-comment-spacing.php 10 0
+tests/input/doc-comment-spacing.php 11 0
 tests/input/duplicate-assignment-variable.php 1 0
 tests/input/EarlyReturn.php 6 0
-tests/input/example-class.php 36 0
+tests/input/example-class.php 38 0
 tests/input/forbidden-comments.php 14 0
 tests/input/forbidden-functions.php 6 0
 tests/input/inline_type_hint_assertions.php 7 0
@@ -45,9 +45,9 @@ tests/input/use-ordering.php 1 0
 tests/input/useless-semicolon.php 2 0
 tests/input/UselessConditions.php 20 0
 ----------------------------------------------------------------------
-A TOTAL OF 374 ERRORS AND 0 WARNINGS WERE FOUND IN 41 FILES
+A TOTAL OF 377 ERRORS AND 0 WARNINGS WERE FOUND IN 41 FILES
 ----------------------------------------------------------------------
-PHPCBF CAN FIX 310 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
+PHPCBF CAN FIX 313 OF THESE SNIFF VIOLATIONS AUTOMATICALLY
 ----------------------------------------------------------------------
 
 

tests/fixed/ControlStructures.php

@@ -13,9 +13,7 @@ class ControlStructures
 {
  private const VERSION = PHP_VERSION;
 
- /**
- * @return iterable<int>
- */
+ /** @return iterable<int> */
  public function varAndIfNoSpaceBetween(): iterable
  {
  $var = 1;
@@ -26,9 +24,7 @@ public function varAndIfNoSpaceBetween(): iterable
  yield 0;
  }
 
- /**
- * @return iterable<int>
- */
+ /** @return iterable<int> */
  public function ifAndYieldSpaceBetween(): iterable
  {
  if (self::VERSION === 0) {
@@ -38,9 +34,7 @@ public function ifAndYieldSpaceBetween(): iterable
  yield 1;
  }
 
- /**
- * @return iterable<int>
- */
+ /** @return iterable<int> */
  public function ifAndYieldFromSpaceBetween(): iterable
  {
  if (self::VERSION === 0) {

tests/fixed/UselessConditions.php

@@ -119,9 +119,7 @@ public function uselessTernaryWithMethod(): bool
  return $this->isFalse() ? true : false;
  }
 
- /**
- * @param string[] $words
- */
+ /** @param string[] $words */
  public function uselessTernaryCheck(array $words): bool
  {
  return count($words) < 1;

tests/fixed/class-references.php

@@ -8,9 +8,7 @@ class Foo
 
 class Bar extends Foo
 {
- /**
- * @return string[]
- */
+ /** @return string[] */
  public function names(): iterable
  {
  yield self::class;

tests/fixed/doc-comment-spacing.php

@@ -71,4 +71,9 @@ public function c(iterable $foo): void
  public function d(iterable $foo, iterable $bar): iterable
  {
  }
+
+ /** @param iterable<mixed> $singleAnnotation */
+ public function e(iterable $singleAnnotation): void
+ {
+ }
 }

tests/fixed/example-class.php

@@ -53,9 +53,7 @@ public function getFoo(): ?int
  return $this->foo;
  }
 
- /**
- * @return iterable
- */
+ /** @return iterable */
  public function getIterator(): array
  {
  assert($this->bar !== null);
@@ -70,9 +68,7 @@ public function isBaz(): bool
  return $this->baz;
  }
 
- /**
- * @throws InvalidArgumentException if this example cannot baz.
- */
+ /** @throws InvalidArgumentException if this example cannot baz. */
  public function mangleBar(int $length): void
  {
  if (! $this->baz) {

tests/fixed/test-case.php

@@ -6,9 +6,7 @@
 
 use PHPUnit\Framework\TestCase as BaseTestCase;
 
-/**
- * @requires PHP 7.2
- */
+/** @requires PHP 7.2 */
 final class TestCase extends BaseTestCase
 {
  /**
@@ -19,9 +17,7 @@ public static function doStuff(): void
  {
  }
 
- /**
- * @before
- */
+ /** @before */
  public function createDependencies(): void
  {
  }

tests/input/ControlStructures.php

@@ -13,9 +13,7 @@ class ControlStructures
 {
  private const VERSION = PHP_VERSION;
 
- /**
- * @return iterable<int>
- */
+ /** @return iterable<int> */
  public function varAndIfNoSpaceBetween(): iterable
  {
  $var = 1;
@@ -24,9 +22,7 @@ public function varAndIfNoSpaceBetween(): iterable
  }
  }
 
- /**
- * @return iterable<int>
- */
+ /** @return iterable<int> */
  public function ifAndYieldSpaceBetween(): iterable
  {
  if (self::VERSION === 0) {
@@ -35,9 +31,7 @@ public function ifAndYieldSpaceBetween(): iterable
  yield 1;
  }
 
- /**
- * @return iterable<int>
- */
+ /** @return iterable<int> */
  public function ifAndYieldFromSpaceBetween(): iterable
  {
  if (self::VERSION === 0) {

tests/input/UselessConditions.php

@@ -151,9 +151,7 @@ public function uselessTernaryWithMethod(): bool
  return $this->isFalse() ? true : false;
  }
 
- /**
- * @param string[] $words
- */
+ /** @param string[] $words */
  public function uselessTernaryCheck(array $words): bool
  {
  return count($words) >= 1 ? false : true;