search

code-lts / doctum

A php API documentation generator, fork of Sami
https://doctum.long-term.support/
MIT License
297 stars 32 forks source link

Parse iterable pseudo-type #49

Open dereckson opened 2 years ago

dereckson commented 2 years ago

The PHP 7.1 iterable pseudo-type is currently resolved as a reference name in the current namespace instead of the pseudo-type.

For example, in this sample, the documentation shows iterable as Acme\Foo\iterable:

namespace Acme\Foo;

public function update (iterable $iterable) : self {
    // ...
}

A link to https://www.php.net/manual/en/language.types.iterable.php would be nice instead.

phpDocumentor docblock parser uses their TypeResolver library to parse it, and it seems to support it: https://github.com/phpDocumentor/TypeResolver/pull/80 (support for iterable<key type, value type>)

williamdes commented 2 years ago

Hi @dereckson Thank you for the report, I will keep this pinned to my todo list and keep you updated