phpdoc_trim.rst 522 B

12345678910111213141516171819202122232425262728293031323334
  1. ====================
  2. Rule ``phpdoc_trim``
  3. ====================
  4. PHPDoc should start and end with content, excluding the very first and last line
  5. of the docblocks.
  6. Examples
  7. --------
  8. Example #1
  9. ~~~~~~~~~~
  10. .. code-block:: diff
  11. --- Original
  12. +++ New
  13. <?php
  14. /**
  15. - *
  16. * Foo must be final class.
  17. - *
  18. - *
  19. */
  20. final class Foo {}
  21. Rule sets
  22. ---------
  23. The rule is part of the following rule sets:
  24. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  25. - `@Symfony <./../../ruleSets/Symfony.rst>`_