no_empty_phpdoc.rst 796 B

12345678910111213141516171819202122232425262728293031323334
  1. ========================
  2. Rule ``no_empty_phpdoc``
  3. ========================
  4. There should not be empty PHPDoc blocks.
  5. Examples
  6. --------
  7. Example #1
  8. ~~~~~~~~~~
  9. .. code-block:: diff
  10. --- Original
  11. +++ New
  12. -<?php /** */
  13. +<?php
  14. Rule sets
  15. ---------
  16. The rule is part of the following rule sets:
  17. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  18. - `@Symfony <./../../ruleSets/Symfony.rst>`_
  19. References
  20. ----------
  21. - Fixer class: `PhpCsFixer\\Fixer\\Phpdoc\\NoEmptyPhpdocFixer <./../../../src/Fixer/Phpdoc/NoEmptyPhpdocFixer.php>`_
  22. - Test class: `PhpCsFixer\\Tests\\Fixer\\Phpdoc\\NoEmptyPhpdocFixerTest <./../../../tests/Fixer/Phpdoc/NoEmptyPhpdocFixerTest.php>`_
  23. The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.