search

johnbillion / php-docs-standards

PHPUnit tests for documentation standards of PHP functions and methods.
GNU General Public License v2.0
24 stars 4 forks source link

Anyone to exclude methods included via external traits? #4

Open ahungry opened 8 years ago

ahungry commented 8 years ago

For some things, like including the Symfony PSR logger, the setLogger method there doesn't have proper docblock syntax, and this is detected by the test as a failure.

However, short of overidding the method in the class making use of said trait (and other than updating the source of the issue) this will cause an error to be produced as a result of something the maintainer of the class has little control over.

Is there (or can there be) an optional setting to exclude certain methods from being analyzed?

ahungry commented 8 years ago

It seems like it may be that any methods inherited from traits are considered to have a blank docstring actually...

johnbillion commented 8 years ago

Yeah this is definitely something I want to fix. The lib should only test methods of the specified class and not any of its inherited methods.