phpdoc_summary.rst 523 B

1234567891011121314151617181920212223242526272829303132
  1. =======================
  2. Rule ``phpdoc_summary``
  3. =======================
  4. PHPDoc summary should end in either a full stop, exclamation mark, or question
  5. mark.
  6. Examples
  7. --------
  8. Example #1
  9. ~~~~~~~~~~
  10. .. code-block:: diff
  11. --- Original
  12. +++ New
  13. <?php
  14. /**
  15. - * Foo function is great
  16. + * Foo function is great.
  17. */
  18. function foo () {}
  19. Rule sets
  20. ---------
  21. The rule is part of the following rule sets:
  22. - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
  23. - `@Symfony <./../../ruleSets/Symfony.rst>`_