phpdoc_line_span.rst

Rule phpdoc_line_span

Changes doc blocks from single to multi line, or reversed.

Warning

This rule is CONFIGURABLE

You can configure this rule using the following options: class, const, method, other, property, trait_import.

Configuration

class

Whether class/interface/enum/trait blocks should be single or multi line.

Allowed values: 'multi', 'single' and null

Default value: 'multi'

const

Whether const blocks should be single or multi line.

Allowed values: 'multi', 'single' and null

Default value: 'multi'

method

Whether method doc blocks should be single or multi line.

Allowed values: 'multi', 'single' and null

Default value: 'multi'

other

Whether blocks for other code lines should be single or multi line.

Allowed values: 'multi', 'single' and null

Default value: null

property

Whether property doc blocks should be single or multi line.

Allowed values: 'multi', 'single' and null

Default value: 'multi'

trait_import

Whether trait usage blocks should be single or multi line.

Allowed values: 'multi', 'single' and null

Default value: null

Examples

Example #1

Default configuration.

--- Original
+++ New
 <?php

 class Foo{
-    /** @var bool */
+    /**
+     * @var bool
+     */
     public $var;
 }

Example #2

With configuration: ['property' => 'single'].

--- Original
+++ New
 <?php

 class Foo{
-    /**
-    * @var bool
-    */
+    /** @var bool */
     public $var;
 }

Example #3

With configuration: ['other' => 'single'].

--- Original
+++ New
 <?php
-/**
- * @var string
- */
+/** @var string */
 $var = foo();

References

• Fixer class: PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer
• Test class: PhpCsFixer\Tests\Fixer\Phpdoc\PhpdocLineSpanFixerTest

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.