no_blank_lines_after_phpdoc.rst 963 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. ====================================
  2. Rule ``no_blank_lines_after_phpdoc``
  3. ====================================
  4. There should not be blank lines between docblock and the documented element.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. <?php
  13. /**
  14. * This is the bar class.
  15. */
  16. -
  17. -
  18. class Bar {}
  19. Rule sets
  20. ---------
  21. The rule is part of the following rule sets:
  22. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  23. - `@Symfony <./../../ruleSets/Symfony.rst>`_
  24. References
  25. ----------
  26. - Fixer class: `PhpCsFixer\\Fixer\\Phpdoc\\NoBlankLinesAfterPhpdocFixer <./../../../src/Fixer/Phpdoc/NoBlankLinesAfterPhpdocFixer.php>`_
  27. - Test class: `PhpCsFixer\\Tests\\Fixer\\Phpdoc\\NoBlankLinesAfterPhpdocFixerTest <./../../../tests/Fixer/Phpdoc/NoBlankLinesAfterPhpdocFixerTest.php>`_
  28. The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.