PHP-CS-Fixer/doc/rules/phpdoc/phpdoc_annotation_without_dot.rst

======================================
Rule ``phpdoc_annotation_without_dot``
======================================

PHPDoc annotation descriptions should not be a sentence.

Examples
--------

Example #1
~~~~~~~~~~

.. code-block:: diff

   --- Original
   +++ New
    <?php
    /**
   - * @param string $bar Some string.
   + * @param string $bar some string
     */
    function foo ($bar) {}

Rule sets
---------

The rule is part of the following rule sets:

- `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
- `@Symfony <./../../ruleSets/Symfony.rst>`_

References
----------

- Fixer class: `PhpCsFixer\\Fixer\\Phpdoc\\PhpdocAnnotationWithoutDotFixer <./../../../src/Fixer/Phpdoc/PhpdocAnnotationWithoutDotFixer.php>`_
- Test class: `PhpCsFixer\\Tests\\Fixer\\Phpdoc\\PhpdocAnnotationWithoutDotFixerTest <./../../../tests/Fixer/Phpdoc/PhpdocAnnotationWithoutDotFixerTest.php>`_

The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.