Psalm: [question] anotations docs

Created on 14 Jul 2020  路  10Comments  路  Source: vimeo/psalm

Hi all!

Is there an updated list of all @psalm-* annotations? Couldn't find them in the docs; e.g.: @psalm-type is not documented

Most helpful comment

@douggr now there is, with a test to make sure docs are not getting worse as time passes. See Psalm\DocComment::PSALM_ANNOTATIONS for all recognized annotations and aptly named Psalm\Tests\DocumentationTest::WALL_OF_SHAME for what's still undocumented.

All 10 comments

Hey @douggr, can you reproduce the issue on https://psalm.dev ?

I did, but It's kinda outdated.

Seems like @psalm-type was added since :)

There used to be a list of all recognized annotations somewhere in the code (in DocblockParser maybe), but I can't find it anymore.

Yeah, that one (or a very similar to that). Thanks.

@douggr now there is, with a test to make sure docs are not getting worse as time passes. See Psalm\DocComment::PSALM_ANNOTATIONS for all recognized annotations and aptly named Psalm\Tests\DocumentationTest::WALL_OF_SHAME for what's still undocumented.

@weirdan , any chance to add a proper page and a test for #1155 as @return never-returns is not documented? Thanks!

It's documented.

Was this page helpful?
0 / 5 - 0 ratings