doc/MarkdownFileIterator: Nail down PHPDoc

refs #4820
This commit is contained in:
Eric Lippmann 2014-07-28 18:52:25 +02:00
parent 9af89e6ccf
commit 507ac1c4d7

View File

@ -7,12 +7,12 @@ namespace Icinga\Module\Doc;
use RecursiveFilterIterator; use RecursiveFilterIterator;
/** /**
* Iterator over Markdown files recursively * Recursive iterator over Markdown files
*/ */
class MarkdownFileIterator extends RecursiveFilterIterator class MarkdownFileIterator extends RecursiveFilterIterator
{ {
/** /**
* Accept files with .md suffix * Accept files with '.md' suffix
* *
* @return bool Whether the current element of the iterator is acceptable * @return bool Whether the current element of the iterator is acceptable
* through this filter * through this filter
@ -20,6 +20,7 @@ class MarkdownFileIterator extends RecursiveFilterIterator
public function accept() public function accept()
{ {
$current = $this->getInnerIterator()->current(); $current = $this->getInnerIterator()->current();
/* @var $current \SplFileInfo */
if (! $current->isFile()) { if (! $current->isFile()) {
return false; return false;
} }