phpdoc_line_span.rst

Rule phpdoc_line_span

Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.

Configuration

const

Whether const blocks should be single or multi line

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

Default value: 'multi'

property

Whether property doc blocks should be single or multi line

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

Default value: 'multi'

method

Whether method doc blocks should be single or multi line

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

Default value: 'multi'

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;
 }